ITACoreLibs are a collection of C++ libraries with basic tools for virtual acoustics including real-time audio streaming components for synthesis and reproduction.
ITACoreLibs are a collection of C++ libraries with basic tools for virtual acoustics including real-time audio streaming components for synthesis and reproduction.
# Build guide
# Build guide
This tutorial explains how to build (most of) the C++ libraries of the *Institute for Hearing Technology and Acoustics* at *RWTH Aachen University*.
This tutorial explains how to build (most of) the C++ libraries of the *Institute for Hearing Technology and Acoustics* at *RWTH Aachen University*.
Our projects use CMake as a build system generator. To ease the build process, most external libraries are downloaded during the configuration and build with the main project. This is done using the [CMake Package Manager](https://github.com/cpm-cmake/CPM.cmake).
Our projects use CMake as a build system generator. To ease the build process, most external libraries are downloaded during the configuration and build with the main project. This is done using the [CMake Package Manager](https://github.com/cpm-cmake/CPM.cmake).
...
@@ -25,6 +26,7 @@ For exceptions, see [Special requirements](#special-requirements).
...
@@ -25,6 +26,7 @@ For exceptions, see [Special requirements](#special-requirements).
### Special requirements
### Special requirements
For certain modules, additional external libraries have to be manually included:
For certain modules, additional external libraries have to be manually included:
- For VAMatlab and ARTMatlab: Matlab (recently modern version)
- For VAMatlab and ARTMatlab: Matlab (recently modern version)
CMake option to disable VAMatlab: `ITA_VA_WITH_BINDING_MATLAB` Default: `OFF`
CMake option to disable VAMatlab: `ITA_VA_WITH_BINDING_MATLAB` Default: `OFF`
CMake option to disable ARTMatlab: `ITA_GEOMETRICAL_ACOUSTICS_WITH_APPS_MATLAB` Default: `OFF`
CMake option to disable ARTMatlab: `ITA_GEOMETRICAL_ACOUSTICS_WITH_APPS_MATLAB` Default: `OFF`
...
@@ -43,7 +45,6 @@ In case you are working at our institute, these libraries can be found on our se
...
@@ -43,7 +45,6 @@ In case you are working at our institute, these libraries can be found on our se
CMake has a character limit for its build paths. This means, that the path to some source files can be too long. In these cases CMake will issue a warning. If this happens, try to move the top-level source folder up in your directory tree. A safe place should be the main drive folder, e.g. `D:\`.
CMake has a character limit for its build paths. This means, that the path to some source files can be too long. In these cases CMake will issue a warning. If this happens, try to move the top-level source folder up in your directory tree. A safe place should be the main drive folder, e.g. `D:\`.
## General CMake
## General CMake
### Build via CMake GUI
### Build via CMake GUI
...
@@ -68,7 +69,6 @@ cmake --build
...
@@ -68,7 +69,6 @@ cmake --build
cmake --install
cmake --install
```
```
## Windows with Visual Studio
## Windows with Visual Studio
Another way to build this project on windows. Does not require a separate installation of CMake. However, CMake configuration can be tricky sometimes.
Another way to build this project on windows. Does not require a separate installation of CMake. However, CMake configuration can be tricky sometimes.
...
@@ -91,7 +91,6 @@ Another way to build this project on windows. Does not require a separate instal
...
@@ -91,7 +91,6 @@ Another way to build this project on windows. Does not require a separate instal
The build results can be found in `*project_folder*/out/build/*build_configuration*/[Debug|Release|...]`
The build results can be found in `*project_folder*/out/build/*build_configuration*/[Debug|Release|...]`
While the install results can be found in `*project_folder*/out/install/*build_configuration*`
While the install results can be found in `*project_folder*/out/install/*build_configuration*`
