Setup documentation and example scripts

[mengyu-yang]

I'm pretty new to all this and was wondering if there's any documentation for setup and perhaps example scripts? I'm mainly interested in using the CLI to render binaural audio given a sequence of 3D coordinates of a sound object's trajectory. Any help is appreciated!

[trsonic]

Hi @mengyu-yang

Regarding the setup. The library can be compiled using either Bazel or CMake build systems. The CLI can be compiled using Bazel only at the moment. We will look into extending the CMake configuration to include CLI and unit tests.

Rendering of sound objects using CLI is possible, however, their position data needs to be static and predefined in the .textproto file (see example here).

For rendering of moving objects, you could write a wrapper around the library that would call it in the following steps:

• initialize it by calling obr = std::make_unique<obr::ObrImpl>(samplesPerBlock, sampleRate)
• then add audio objects by calling obr->AddAudioElement(AudioElementType::kObjectMono) for each one of them,
• control position of each audio object by calling obr->UpdateObjectPosition(size_t audio_element_index, float azimuth, float elevation, float distance),
• render audio on a frame-by-frame basis using obr->Process(const AudioBuffer& input_buffer, AudioBuffer* output_buffer) and update object positions accordingly.

We will try to extend the documentation to include different rendering scenarios. For now, if you're familiar with JUCE and VSTs you can look also at this repository as an example. It wraps obr into a VST plugin.