README.md

Lithe

Lithe was concieved as a proof of concept for a patching workflow for spatial audio.

This repository builds a static library lithe_core and contains a framework for patching and processing an object-based audio graph. It also has utilities for using parameter fields that are mapped to 2D-manifolds. It's intended use is for creating effects for object-based spatial audio.

Lithe can be installed as a static library from this repo. It doesn't have any dependencies.

Build instructions:

Note: All builds require CMake

Building and installing Lithe

Clone Lithe from the git repo

git clone git@github.com:akshay1992/Lithe

To build Lithe

cd Lithe
mkdir build
cd build
cmake ..
make

To install

make install

Note that the above command will will install in the default location (usually /usr/local/). To specify a different install location, you can manually specify install directory in the last command:

make install <path_to_install_directory>

Note: The install and uninstall scripts are provided as a shorthand. install.sh installs in the default directory /usr/local/ and uninstall.sh removes Lithe from those locations (if found).

Building and running tests

To build and run the tests run this command from within the Lithe/build/ directory created in the above build step:

make check

Note: Lithe uses GoogleTest for testing. It automatically downloads and builds it when testing. Therefore, be sure to be connected to the internet while building the test cases (at least the first time).

Documentation

To generate the documentation, from within the Lithe/build/ directory created in the above build step, run the following command:

make docs

The documentation can be found within Lithe/docs in html and latex forms.

Note: Lithe uses Doxygen for generating documentation. First make sure Doxygen is installed before running the above command.