From 83358d09caf55df1b16e7a0cf08d425221eac92b Mon Sep 17 00:00:00 2001 From: Valentin Ackva <74772523+vackva@users.noreply.github.com> Date: Wed, 19 Jun 2024 20:34:50 +0200 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 14e1823..1f8c325 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ # Orbe ![interface](assets/images/orbe-github-header.png) -## Build instruction +## Overview +Orbe is a real-time audio plugin designed as a binaural spatializer -Dependencies on Linux -```bash -# on Linux install -sudo apt-get update && sudo apt-get install libhdf5-dev libnetcdf-dev libnetcdff-dev liblapack3 liblapack-dev libopenblas-base libopenblas-dev liblapacke-dev -``` +**Features:** +- **Realistic Binaural Panning:** Experience true-to-life binaural sound panning in an open field using sophisticated SOFA data handling +- **Flexible Source Positioning:** Control the audio source with precision using both Cartesian and spherical coordinates +- **3D Auto-Pan Functionality:** Simplify spatial manipulation with an auto-pan feature controlled by sinusoidal oscillators +- **3D Visualization:** Orbe provides a comprehensive visual representation of the sound field, enhancing the understanding of spatial dynamics +## Build instruction Build with CMake ```bash # clone the repository -git clone https://github.com/vackva/SpatialPanner/ -cd SpatialPanner/ +git clone https://github.com/vackva/Orbe/ +cd Orbe/ # initialize and set up submodules git submodule update --init --recursive @@ -32,6 +34,5 @@ cmake --build cmake-build-release --config Release The primary license for the code of this project is the MIT license, but be aware of the licenses of the submodules: - The *JUCE* library is licensed under the [JUCE License](https://github.com/juce-framework/JUCE/blob/master/LICENSE.md) - - The *Spatial_Audio_Framework* library is licensed under the [ISC License](https://github.com/leomccormack/Spatial_Audio_Framework/blob/master/LICENSE.md) - - The *OpenBlas* library (Windows & Linux only) is licensed under the [BSD3](https://github.com/OpenMathLib/OpenBLAS/blob/develop/LICENSE) + - The *libmysofa* library is licensed under the [Custom License](https://github.com/hoene/libmysofa/blob/main/LICENSE) - The HRTF used in this project belong to the *HUTUBS* dataset and is licensed under the [CC BY 4.0 Deed](https://depositonce.tu-berlin.de/items/dc2a3076-a291-417e-97f0-7697e332c960)