Build instructions for building Csound from the source packages for the following operating systems
Instructions for RPI compiled by Dominic Melville contact via dcamelville at gmail.com for amendments and updates
The following instructions will explain how to configure, compile, and install Csound 6 on Debian and Ubuntu systems.
You will need root access, primarily to allow installation of dependencies required for building Csound, as well as for installing into /usr/local.
The following instructions are written for those getting a copy of the source code from Git. You will need to adjust the steps accordingly when using the source tarball from the files section.
The first thing to do is make sure you have all of the required dependencies for building Csound. In a terminal, do the following:
-
Edit, as root,
/etc/apt/sources.listand ensure that each line beginning withdebhas another line below it that is identical except thatdebis replaced withdeb-src. Then runsudo apt-get update. -
sudo apt-get build-dep csound -
sudo apt-get install cmake -
sudo apt-get install git
The following numbered steps are to be done in a terminal for building and installing Csound:
-
cd ~ -
mkdir csound -
cd csound -
git clone https://github.com/csound/csound.git csound -
mkdir cs6make -
cd cs6make -
cmake ../csound -
make -j6 -
sudo make install -
sudo ldconfig
At this point, Csound 6 should now be compiled and installed into the /usr/local set of folders.
Homebrew is a package manager for OSX. It is able to download, build, and install applications, including their dependencies. The following sections will describe what you will need to do to use Homebrew to install Csound 6.
Note: At this time, this method of installing Csound is currently being tested. It is considered beta, and users should be aware that there may be some issues that will be required to be worked through.
-
Xcode
-
Xcode Command-Line Tools
-
Homebrew - http://www.brew.sh
Installing Homebrew You will first need to have a working Homebrew setup. This requires installing Xcode and the Xcode Command-Line tools. More information on installing Homebrew is available on the Homebrew website as well as their wiki.
In particular, you will need to be mindful to enable user read/write for three directories: "/usr/local", "/Library/Python/2.7/site-packages", and "/Library/Java/Extensions". These need to be writable by the user as Csound will need to install packages into each of those folders. Running the following commands at a Terminal prompt should allow you to do this:
sudo chmod +a 'user:YOUR_NAME_HERE allow add_subdirectory,add_file,delete_child,directory_inherit' /Library/Python/2.7/site-packages
sudo chmod +a 'user:YOUR_NAME_HERE allow add_subdirectory,add_file,delete_child,directory_inherit' /Library/Java/Extensions
where YOUR_NAME_HERE refers to your system username.
Homebrew has a central repository, but it also allows for adding "taps", which are additional repositories. A Csound tap has been setup at https://github.com/kunstmusik/homebrew-csound. You can tap into it by using the following command:
brew tap kunstmusik/csound
Once Homebrew is setup and the csound tap has been tapped, run the following command at the commandline to install Csound:
brew install --HEAD csound
There is currently a warning issued when Csound installs:
Warning: Could not fix CsoundLib64.framework/Versions/6.0/CsoundLib64 in /usr/local/Cellar/csound/HEAD/bin/srconv
Warning: Could not fix CsoundLib64.framework/Versions/6.0/CsoundLib64 in /usr/local/Cellar/csound/HEAD/bin/sndinfo
Warning: Could not fix CsoundLib64.framework/Versions/6.0/CsoundLib64 in /usr/local/Cellar/csound/HEAD/bin/scsort
Warning: Could not fix CsoundLib64.framework/Versions/6.0/CsoundLib64 in /usr/local/Cellar/csound/HEAD/bin/scope
....
This is due to how the CsoundLib64.framework is installed into ~/Library/Frameworks and bypasses Homebrew's installation path for Frameworks. This is a known issue and will be looked into.
These are generic instructions to build on any Linux system with no root access. These instructions require a full development system (compilers, flex, bison, cmake). For RT audio you need to make sure you have the alsa headers / lib installed.
This creates three directories in your HOME directory and adds your local lib directory to dynamic library path. Note that this last step needs to be performed every time you open a new terminal, otherwise the installed Csound will not find its dynamic library dependencies. If you add that line to your HOME/.profile script, it will be run automatically when you start a new terminal. $ $
-
cd -
mkdir include -
mkdir lib -
mkdir bin -
mkdir src -
export LD_LIBRARY_PATH=$HOME/lib:LD_LIBRARY_PATH
(this last command can be added to your $HOME/.profile file for convenience)
Libsndfile is the only required dependency for a basic Csound build.
Ubuntu users: it appears the libsndfile binaries come as default in your installation, so this step might not be required. However, there is no harm in doing it.
-
cd src -
wget http://www.mega-nerd.com/libsndfile/files/libsndfile-1.0.28.tar.gz -
tar xf libsndfile-1.0.28.tar.gz -
cd libsndfile-1.0.28 -
./configure --prefix=$HOME -
make install
The latest Csound sources are kept in the develop branch. For the latest released sources, you do not need to change branches.
-
cd .. -
git clone https://github.com/csound/csound.git csound -
cd csound -
git checkout develop -
mv Custom.cmake.ex Custom.cmake
Cmake needs to find your locally-installed headers in HOME/bin. You can add custom commands to Cmake by using a Custom.cmake file, which Cmake will read if it exists.
Open or create the Custom.cmake file in the top level Csound sources directory
and add the following line: include_directories("ENV{HOME}/include")
The recommended method is to create a separate build directory and run cmake there.
-
mkdir build -
cd build -
cmake -DCMAKE_INSTALL_PREFIX=$HOME .. -
make install
This builds a basic system. If you add dependencies to your HOME directories, then you can run make again to build them. The csound command-line frontend will be installed in $HOME/bin, the libraries in $HOME/lib and the include files in $HOME/include. The plugin dir is in $HOME/lib/csound/plugins64-6.0.
If the dependency you are adding uses ./configure, you can use the same parameters to it as explained in step 2. If it uses cmake, you can use the same parameters as in step 5. After adding dependencies to your $HOME directories, you can run cmake again to re-build Csound. Check the printed output to see if the added dependency has switched on the build of the desired component.
liblo - http://liblo.sourceforge.net/ NB: the build for version 0.28 seems to be broken.
Fluidsynth - http://sourceforge.net/apps/trac/fluidsynth/ NB: cmake might need to be coerced into finding the fluidsynth headers once it is built. For that, you can use the following cmake command (see step 5):
cmake -DCMAKE_INSTALL_PREFIX=$HOME -DFLUIDSYNTH_H=$HOME/include ..
FLTK - http://www.fltk.org/index.php NB: make sure you configure the FLTK build with --enable-shared, otherwise there could be problems linking to libfltk on 64bit linux.
libfaust - use faust2 branch of Faust git sources:
$ git clone git://git.code.sf.net/p/faudiostream/code faust $ cd faust $ git checkout faust2
NB: libfaust also requires LLVM 3.0, 3.1, 3.2, 3.3 or 3.4 - http://llvm.org/ LLVM can be built with CMake (as in step 5 above). To build faust, use the following make command (replacing LLVM_32 for LLVM_3* depending on the version you are using, if it is not 3.2)
$ make LLVM_VERSION=LLVM_32 LLVM_CONFIG=llvm-config LLVM_CLANG=g++ CXX=g++ ARCHFLAGS=-fPIC
To install it, you should run
$make PREFIX=$HOME
To switch the faust opcodes build on and coerce cmake into finding the faust library use:
cmake -DCMAKE_INSTALL_PREFIX=$HOME -DBUILD_FAUST_OPCODES=1 -DFAUST_LIBRARY=$HOME/lib/faust/libfaust.a ..
NB: Ubuntu users should be aware that LLVM 3.4 and 3.5 packages seem broken. It is probably recommended to build LLVM by oneself. Otherwise, LLVM 3.3 package is enough for building csound 6.05 with Faust opcodes assuming that
- LLVMConfig.cmake is correctly spelled in /usr/share/llvm-3.3/cmake (otherwise create a symbolic link with that name : ln -s /usr/share/llvm-3.3/cmake/LLVM-Config.cmake /usr/share/llvm-3.3/cmake/LLVMConfig.cmake)
- llvm-config is correctly spelled in /usr/bin
- faust2 is built with LLVM 3.3
- cmake version > 2.8.7 (version 3.3.0 builds easily for instance)
Then some additional environment variables may have to be set during the configuration step:
cmake -DLLVM_DIR=/usr/share/llvm-3.3/cmake -DCMAKE_MODULE_LINKER_FLAGS="-L/usr/lib/llvm-3.3/lib" -DBUILD_FAUST_OPCODES=1 -DFAUST_LIBRARY=pathTo/libfaust.a ../csound-develop/
portaudio - http://www.portaudio.com/
portmidi - http://portmedia.sourceforge.net/portmidi/
Jack connection kit - http://jackaudio.org/
swig - http://www.swig.org/ Python headers / library - http://www.python.org
swig - http://www.swig.org/ Java SDK - http://www.oracle.com/technetwork/java/javase/downloads/index.html
Preliminary step:
sudo apt-get build-dep csound
If you get the following error:
E: You must put some 'source' URIs in your sources.list
then add the following line to /etc/apt/sources.list:
deb-src http://mirrordirector.raspbian.org/raspbian/ wheezy main contrib non-free rpi
(This can be done with nano)
After adding that to the sources.list, you should run sudo apt-get update and retry the sudo apt-get build-dep csound command.
-
cd ~ -
mkdir csound -
cd csound -
git clone https://github.com/csound/csound.git csound -
mkdir cs6make -
cd cs6make -
cmake ../csound -DCMAKE_BUILD_TYPE="Release" -
make -j6 -
sudo make install -
sudo ldconfig
If you want to use the csnd6 Python library, add the following line to .bashrc:
export PYTHONPATH=/usr/local/lib
Enabling the Python Bindings requires swig and python-dev packages to be installed with
sudo apt-get install swig python-dev
From 6.07, Csound includes a choice of FFT libraries. One of these is PFFFT, which can avail of NEON vector operations on arm, where these exist. This can lead to a compilation error if the correct options are not set. If a build error occurs in the compilation of pffft.c, two options exist.
-
Try to add the correct flags for NEON compilation. This can be made by editing the top-level file Custom.cmake.ex, and saving it as Custom.cmake. In that file, the line
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -W -Wall -mtune=core2")
should be changed to
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mfloat-abi=hard -mfpu=neon")
-
If step 1 fails, there might be no NEON support for your arm chip, or there might be a compiler issue, in which case, you need to change the line above to
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DPFFFT_SIMD_DISABLE")
in order to disable the vectorial code and use standard C scalar operations.
There is no support for NEON on rpi 1 or zero. This is available for rpi 2 and 3, though.
This shows how to download the source code from Sourceforge, and build Csound 6 from sources.
For some steps, you'll need root access. You may need to install additional packages - the example shows installing a number of additional packages, but the exact requirements depend on your system.
You'll need to make sure Cmake, flex, bison, and libsndfile are installed. If you're logged in as a non-root user, you can execute root commands using su -c. So here's how to make sure the basic required packages for building are installed:
su -c "yum install cmake libsndfile libsndfile-devel flex bison"
You'll be prompted for your root password.
Download the latest Csound 6 sources from
https://sourceforge.net/projects/csound/files/csound6/
At the time this was written, the downloaded file was Csound6.00.1.tar.gz
First uncompress and untar the source code:
gunzip Csound6.00.1.tar.gz
tar xf Csound6.00.1.tar.gz
Change into the source directory
cd Csound6.00.1
In the source directory what gets compiled is controlled by the file CMakeLists.txt. By default lots of stuff will get built, as long as you have the required dependencies installed.
The following commands will add most required packages (but note that lua interfaces and faust opcodes may still not work):
su -
yum install ladspa ladspa-devel
yum install fluidsynth fluidsynth-devel
yum install boost boost-devel java-devel
yum install jack-audio-connection-kit-devel
yum install fltk fltk-devel
yum install swig swig-devel
yum install pulseaudio-libs-devel
yum install portaudio portmidi portaudio-devel portmidi-devel
yum install fltk-fluid
yum install stk stk-devel
yum install python-libs
yum install python-devel
yum install liblo liblo-devel
yum install lua lua-devel
yum install eigen3-devel eigen3
yum install gmm-devel
yum install wiiuse wiiuse-devel
yum install bluez-libs-devel
yum install llvm-devel
yum install faust faust-tools
exit
The building process takes two steps
-
use cmake to create a Makefile
-
use make to build Csound 6
To create the Makefile:
cmake ./
At this point you may see messages saying that something can't be built - in that case use your skill and judgement to work out which packages are missing. For instance if you get a message saying fltk cannot be built, you could install the fltk-devel package.
If you install a new package, you'll need to run cmake again:
rm CMakeCache.txt
cmake ./
When you're happy, run make
make
This builds the csound library.
By default, Csound 6 will install in /usr/local, so you'll need root permissions:
su -c "make install"
Finally you need to make sure the library can be found by the linker
su -
cd /etc/ld.so.conf.d
touch csound6.conf
gedit csound6.conf
In the editor, add one line
/usr/local/lib
and close the file.
Finally update the linker search path
ldconfig
and log out of root
exit
Testing As a basic test, just try typing csound at a command prompt, and you should get the help message.
Csound for Windows can now be built using MSYS2. This is the recommeneded way to build Csound for Windows. Please follow the instruction posted here.
A basic working knowledge of the Windows command prompt is assumed. Further instructions for Windows can be found in their own document at the following link Csound Windows Build Doc
- Download and install MSYS (http://downloads.sourceforge.net/mingw/MSYS-1.0.11.exe)
- Download and install MinGW (http://sourceforge.net/projects/mingwbuilds). -When installing choose architecture i686, or x32.
- Download and install Git(http://git-scm.com/download/win)
- Download and install libsndfile (32bit) (http://www.mega-nerd.com/libsndfile/)
- Download and install cmake (http://www.cmake.org/download/)
Open the Windows command prompt and cd to a folder you wish to create your Csound repository in. Then run:
git clone https://github.com/csound/csound.git
cd csound
mkdir build
cd build
Then run cmake-gui from the command line:
cmake-gui
To the right of 'Where is the source code:' in cmake-gui browse for the Csound source directory. Underneath it, at the "Where to build the binaries" select the newly created build directory. Now type sndfile into the search field and you should see a few cmake entries concerned with libsndfile. Browse for the correct include folder and library file; libsndfile-1.dll. With this done hit configure. At this point you may be greeted with a cmake-gui dialogue asking which generator to use. Select the "MinGW Makefiles" generator. If the configuration command fails you may need to set the CMAKE_C_COMPILER and CMAKE_CXX_COMPILER entries. Simply click the add entry button and add two new FILEPATH entries, CMAKE_C_COMPILER should point towards your installed gcc.exe, and CMAKE_CXX_COMPILER should point towards g++.exe. These files are found in your MinGW/bin directory.
Go back to the command prompt and from your build directory run:
mingw32-make
If everything went Ok, you will now have binaries for most vanilla build of Csound possible. Keep reading if you wish to extend this basic build.
- Download portaudio (http://portaudio.com/).
- Open MSYS shell and cd to portaudio directory. Then run
- './configure'
- 'make'
If you wish to build with support for ASIO run the following command, replacing the path to your ASIO SDK with your own.
'./configure --with-host_os=mingw --with-winapi=asio [--with-asiodir=/usr/local/asiosdk2]' 'make'
If make has any problems, you can try adding the following directories to your ASIOSDK folders: ASIOSDK2.3\host\pc.libs C:\SDKs\ASIOSDK2.3\host.libs ASIOSDK2.3\common.libs
-
Download and portmidi (http://portmedia.sourceforge.net.), Open command prompt and cd to portmidi directory
-
mkdir build -
cd build -
cmake ../ -G "Mingw Makefiles" -
mingw32-make -
Open up cmake once more and make sure the Csound cmake configuration is open. Then search for entries with portaudio and portmidi in them. Browse for the correct include directories for each, and select the libportaudio-2.dll, and libportmidi.dll libraries. Then run configure and generate.
-
Open the command prompt and cd to the Csound build directory. Then run
mingw32-make
Download and install cmake Run cmake from the csound dir and configure Csound to build using MinGW Makefiles. For this minimal you'll need to disable quite a few features. Run generate. cd to csound build directory and run mingw32-make
Instructions can be found here.
Requirements
- SWIG (www.swig.org)
- libsndfile sources for android (https://bitbucket.org/kunstmusik/libsndfile-android.git)
- boost (www.boost.org)
- Android NDK
- Download, build and install SWIG (or install from your distro package system)
- Clone the libsndfile sources for android repo,e.g.:
$ cd $HOME
$ mkdir android
$ cd android
$ git clone https://bitbucket.org/kunstmusik/libsndfile-android.git
- Set the NDK_MODULE_PATH variable to point to the top directory where the libsndfile sources are located,e.g.
$ export NDK_MODULE_PATH=$HOME/android
-
Download boost and install (headers only) in your include path (e.g. /usr/local/include). There is no need to build the library.
-
Download the Android NDK and place it somewhere (e.g. $HOME), set the ANDROID_NDK_ROOT to point to it
$ export ANDROID_NDK_ROOT=$HOME
- Get Csound, and go to the ./android/CsoundAndroid directory, run
$ sh build.sh
The Java files and NDK libraries will be under CsoundAndroid.