Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vackva authored Jun 19, 2024
1 parent d10c71f commit 83358d0
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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)

0 comments on commit 83358d0

Please sign in to comment.