You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
# About
9
9
10
-
The Spatial_Audio_Framework (SAF) is an open-source and cross-platform framework for developing spatial audio related algorithms and software in C/C++. Originally intended as a resource for researchers in the field, the framework has gradually grown into a large codebase comprising a number of distinct [**modules**](framework/modules); with each module targeting a specific sub-field of spatial audio, such as: Ambisonics encoding/decoding, spherical array processing, amplitude-panning, HRIR processing, room simulation, etc.. The framework also makes use of highly optimised linear algebra libraries (such as: Intel MKL, Apple Accelerate, OpenBLAS) as well as x86 SIMD intrinsics (SSE, AVX, AVX-512).
10
+
The Spatial_Audio_Framework (SAF) is an open-source and cross-platform framework for developing spatial audio related algorithms and software in C/C++. Originally intended as a resource for researchers in the field, the framework has gradually grown into a large codebase comprising a number of distinct [**modules**](framework/modules). Each module targets a specific sub-field of spatial audio, such as: Ambisonics encoding/decoding, spherical array processing, amplitude-panning (VBAP), HRIR processing, room simulation, etc. The framework also makes use of highly optimised linear algebra libraries (such as: Intel MKL, Apple Accelerate, OpenBLAS) as well as x86 SIMD intrinsics (SSE, AVX, AVX-512).
11
11
12
12
Several [**examples**](examples/include) are also included in the repository, which serve to demonstrate the functionality of the framework and may also act as a starting point for new projects. These examples have also been realised as VST/LV2 audio plug-ins under the [**SPARTA**](https://github.com/leomccormack/SPARTA) banner.
13
13
@@ -46,7 +46,7 @@ The [framework](docs/FRAMEWORK_STRUCTURE.md) comprises the following core module
46
46
The framework also includes the following optional modules:
47
47
***saf_sofa_reader** - a simple SOFA file reader (**ISC** License).
48
48
***saf_tracker** - a particle-filtering based tracker (**GPLv2** License).
49
-
***saf_hades** - for binaural rendering of Hearing-Assistive/Augmented-reality Devices (HADES) (**GPLv2** License).
49
+
***saf_hades** - for binaural rendering of Hearing-Assistive/Augmented-reality Devices (HADES) (**GPLv2** License).
50
50
51
51
To enable optional framework modules, simply add the relevant pre-processor definition:
52
52
```
@@ -57,10 +57,10 @@ SAF_ENABLE_HADES_MODULE # to enable saf_hades
57
57
58
58
### Additional options
59
59
60
-
The framework can be configured further, with the following options:
60
+
The framework can be configured further with the following options:
61
61
```
62
-
SAF_USE_INTEL_IPP # To use Intel IPP for performing the DFT/FFT and resampling
63
-
SAF_USE_FFTW # To use the FFTW library for performing the DFT/FFT
62
+
SAF_USE_INTEL_IPP # To use Intel IPP for performing the DFT/FFTs and resampling
63
+
SAF_USE_FFTW # To use the FFTW library for performing the DFT/FFTs
64
64
SAF_ENABLE_SIMD # To enable SIMD (SSE3, AVX2 and/or AVX512) intrinsics for certain vector operations
0 commit comments