Skip to content

Commit

Permalink
merge with develop
Browse files Browse the repository at this point in the history
  • Loading branch information
leomccormack committed Oct 20, 2020
2 parents 9663255 + 10e5585 commit 97ebe91
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

# About

The Spatial_Audio_Framework (SAF) is an open-source and cross-platform framework for developing spatial audio related applications in C/C++. While originally intended as a resource for researchers in the field, the framework has gradually grown into a comparatively large and comprehensively documented code-base comprising a number of distinct **modules**; with each module targeting a specific sub-field of spatial audio (e.g. Ambisonics encoding/decoding, spherical array processing, amplitude-panning, HRIR processing, room simulation, etc.). Several **examples** have also been included in the repository, which serve to demonstrate the functionality of the framework.
The Spatial_Audio_Framework (SAF) is an open-source and cross-platform framework for developing spatial audio related applications in C/C++. While originally intended as a resource for researchers in the field, the framework has gradually grown into a large and comprehensively-documented codebase comprising a number of distinct **modules**; with each module targeting a specific sub-field of spatial audio (e.g. Ambisonics encoding/decoding, spherical array processing, amplitude-panning, HRIR processing, room simulation, etc.). Several **examples** 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.

Owing to its modular design, expanding the framework is also relatively straightforward; with contributions from researchers and developers of spatial audio technologies being actively encouraged! :-)
Owing to its modular design, expanding the framework is also relatively straightforward, and contributions from researchers and developers of spatial audio technologies is actively encouraged! :-)

# Prerequisites

Expand Down Expand Up @@ -52,7 +52,7 @@ Note that the **saf_sofa_reader** module also requires [netCDF](https://www.unid

The framework can be configured further, with the following options:
```
SAF_USE_INTEL_IPP # To use Intel IPP for the saf_utility_fft wrapper
SAF_USE_INTEL_IPP # To use Intel IPP for the saf_utility_fft wrapper
```

# Using the framework
Expand Down Expand Up @@ -126,7 +126,7 @@ saf_test.exe # To run the unit testing program

Alternatively, you may generate the documentation yourself (e.g. for the other branches) with the following commands:
```
cd doxygen
cd docs/doxygen
doxygen doxygen_config
# (optional) to also build the pdf version:
cd latex
Expand Down
4 changes: 4 additions & 0 deletions framework/modules/saf_tracker/saf_tracker.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
extern "C" {
#endif /* __cplusplus */

#ifdef SAF_ENABLE_TRACKER_MODULE

/* ========================================================================== */
/* Public Structs */
/* ========================================================================== */
Expand Down Expand Up @@ -152,6 +154,8 @@ void tracker3d_step(void* const hT3d,
int** target_IDs,
int* nTargets);

#endif /* SAF_ENABLE_TRACKER_MODULE */


#ifdef __cplusplus
} /* extern "C" */
Expand Down
4 changes: 4 additions & 0 deletions framework/modules/saf_tracker/saf_tracker_internal.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@
extern "C" {
#endif /* __cplusplus */

#ifdef SAF_ENABLE_TRACKER_MODULE

/** Spits out tracker status info to the terminal */
//#define TRACKER_VERBOSE
#ifdef TRACKER_VERBOSE
Expand Down Expand Up @@ -432,6 +434,8 @@ float gauss_pdf3(/* Input Arguments */
int categ_rnd(float* P,
int len_P);

#endif /* SAF_ENABLE_TRACKER_MODULE */


#ifdef __cplusplus
} /* extern "C" */
Expand Down

0 comments on commit 97ebe91

Please sign in to comment.