Linux Distribution and Build/Runtime Environment

The recommended Linux distribution for the VISR is Ubuntu Studio 14.04 LTS. It can be obtained from the download site.

Installation of Required Software and Libraries

Additional software packages (applications and libraries) are installed using the apt packet management tools (e.g., https://wiki.debian.org/Apt or http://en.wikipedia.org/wiki/Advanced_Packaging_Tool). Search for package using a part of the name or the description: apt-cache search searchstring Show information about a package apt-cache show package Install a software package sudo apt-get install package

Required Software Libraries

The following software libraries must be installed to build and run the VISR libboost-all-dev portaudio19-dev libsndfile1-dev

NB: If compilation is not required, then the standard packages (without "dev") should be sufficient. However, this has not been tested yet. Moreover, there is no equivalent to boost-all-dev, so the required libraries would need to be specified manually together with their version. At the moment, these package names are libboost-system1.54.0, libboost-thread1.54.0, libboost-filesystem1.54.0.

For development and compilation of the project, the following packages are required: git cmake cmake-gui (recommended) g++ doxygen graphviz A decent editor or development environment. Choose your weapon: vi, vim, gvim, emacs, eclipse ...

The following tools are recommended for audio development and testing: audacity qjackctl jaaa meterbridge

To build the soundscape renderer, the following development libraries need to be installed: libfftw3-dev libqt4-dev libecasoundc-dev libjack-jack2-dev (probably)

The SoundScapeRenderer must be downloaded from the SSR download page and installed accoording to the User manual. This possibly requires additional software (automake, gmake).

Handling of Third-Party Libraries

In general, it is preferable to use the platforms package installation mechanisms to provide additional software components/libraries

Building and Finding Boost on Windows platforms (Visual Studio)

Download the Boost source distribution, e.g., boost_1_57_0.zip or boost_1_57_0.tar.bz2 Unpack the boost distribution The top-level directory within the unpacked archive is referred to as boost_root in the following Open the command prompt for the Visual Studio version you are targeting Execute VC\vcvarsall amd64 to switch the compiler toolchain to 64-bit mode (if necessary, do cd VC; ..\vcvarsall.sh amd64) Go to the boost_root directory Execute the bootstrap build function to build the build tools .\bootstrap.bat Build boost: .\b2 address-model=64 –build-type=complete stage (this takes a while and consumes about 10 GB disk space). Alternatively, precompiled boost libraries can be used: Download the correct version from http://sourceforge.net/projects/boost/files/boost-binaries/. Install and rename the directory lib-msvc-VVVV to lib Add the following environment variable to Windows (Control Center->System->Advanced System settings->Environment Variables): BOOST_ROOT=boost_root. A subsequent configure run in CMake should yield "Boost version: 1.xx.x Found the following Boost libraries: ..." Note: Because Python bindings are created using the header-only pybind11 library, no Python support is needed in Boost.

External Libraries on Windows

The following libraries must be provided externally

FFT

Due to the GPL licence of the FFTW, this library it is not included in the source tree. In order to use this library, activate the 'BUILD_USE_FFTW' option in CMake. Download a binary distribution for Windows http://www.fftw.org/install/windows.html Create the .lib files (stubs for linking the DLL) according to the instructions on the download page. Create an environment variable FFTW_ROOT pointing to the base directory of the binary distribution. TODO: Remove all code (and build support) for public releases.

MacOS X

Setup Xcode and import git project from repository. Install cmake (download from http://www.cmake.org/download/) Install brew following the instructions on http://brew.sh (Paste command line at the bottom of web page to terminal window) Initialise brew: $ brew doctor Note: To support the build of VISR binaries as universal binaries, all installations via brew must be done with the –universal.

If a package has already been istalled, uninstall it first and then reinstall with the option set.
install with brew install [package options] –universal [package name]
To avoid building universal binaries, deselect the CMake option BUILD_MACOS_UNIVERSAL_BINARIES Install doxygen (download from http://www.stack.nl/~dimitri/doxygen/download.html) Install boost and portaudio –universal
brew install pkgconfig (PkgConfig is not strictly required, but reduces the likelihood of problems while searching for other libraries).
brew install boost –universal
brew install portaudio –universal
brew install libsndfile –universal When the python bindings are going to be used, install boost as follows (taken from http://www.pyimagesearch.com/2015/04/27/installing-boost-and-boost-python-on-osx-with-homebrew/)
If necessary, uninstall a previously installed boost beforehand: brew uninstall boost
brew install python –universal
brew install boost –universal –with-python
brew install boost-python –universal

Table of Contents