User Tools

Site Tools


compiling_on_linux

Compiling on Linux

Compiling software is the process of turning human-readable source code into machine code a computer can execute. Compiling Mixxx is fairly straightforward on Linux. The steps below outline what to do.

Install build dependencies

Mixxx relies on several external libraries for various features.

SCons 2.x

The Mixxx build scripts still rely on SCons 2 and don't work with SCons 3 and Python 3. If your distribution (Fedora 27, Arch linux…) already comes with SCons 3 the build will fail when following the instructions.

As a workaround you can simply install SCons 2 side by side::

  1. Download a standalone version of SCons 2.5.1 from here
  2. Extract the archive into any directory, e.g. /opt or somewhere into your home directory
  3. Execute python2 <your-installation-dir>/scons-2.5.1/script/scons instead of scons

Debian / Ubuntu

If your distribution is Debian based (such as Ubuntu), you can install them by running:

sudo apt-get install g++ git scons libportmidi-dev libopusfile-dev \
  libshout-dev libtag1-dev libprotobuf-dev protobuf-compiler \
  libusb-1.0-0-dev libfftw3-dev libmad0-dev portaudio19-dev \
  libchromaprint-dev librubberband-dev libsqlite3-dev \
  libid3tag0-dev libflac-dev libsndfile-dev libupower-glib-dev \
  libavcodec-dev libavformat-dev libgl-dev liblilv-dev \
  libjack-dev libjack0 portaudio19-dev \  # because of Bug #1464120
  libfaad-dev libmp4v2-dev \  # required for M4A support

If you are building the master Git branch, run:

sudo apt-get install qt5-default libqt5opengl5-dev qtscript5-dev libqt5svg5-dev

If you are building Mixxx 2.1, run:

sudo apt-get install libqt4-dev libqt4-sql-sqlite libqt4-opengl-dev libqt4-svg libqt4-xmlpatterns libqt4-sql

Raspberry Pi (Raspian)

If your distribution is Raspian, you can install them by running:

sudo apt-get remove libtag1-vanilla
sudo apt-get install g++ git scons libqt4-dev libqt4-sql-sqlite libportmidi-dev \
  libopusfile-dev libshout3-dev libtag1-dev libprotobuf-dev protobuf-compiler \
  libusb-1.0-0-dev libfftw3-dev libmad0-dev \
  portaudio19-dev libchromaprint-dev librubberband-dev libsqlite3-dev \
  libid3tag0-dev libflac-dev libsndfile1-dev libupower-glib-dev liblilv-dev
sudo apt-get install libjack-dev libjack0 portaudio19-dev # because of Bug #1464120
sudo apt-get install libfaad-dev libmp4v2-dev # required for M4A support
sudo apt-get install libmp3lame-dev

If the libopusfile-dev is not avaliable for you, download, build and install:

opus-1.2.1

opusfile-0.9

sudo apt-get remove g++ g++-4.7
sudo apt-get autoremove
sudo apt-get install g++-5
ln  /usr/bin/g++-5  /usr/bin/g++
scons -c && scons -j 2 opengles=1 staticlibs=1 optimize=portable

Important

You must build in Raspberry pi 3.

Raspberry pi 2 i had the error:

Error: open CFI at the end of file; missing .cfi_endproc directive

It seems a memory limitation.

Tested on: 2017-11-29-raspbian-stretch.img

Fedora

On Fedora, enable the RPMFusion package repository. You only need to enable the free repository; the nonfree repository is not necessary for Mixxx. Then run:

su
[Enter the password for the user "root" at the prompt]
dnf groupinstall "Development Tools"
dnf install gcc-c++ upower-devel lilv-devel
dnf builddep mixxx

If you are building the master Git branch, also run:

dnf install qt5-devel

Arch & Derivatives

If you are developing in Arch, you should have the base-devel group installed.

The tools you are going to need for working with Mixxx are:

pacman -S git gcc

Alternatively, you can substitute gcc with clang.

You will also need SCons-2.* to build the project. Arch no longer provides scons-2.* in the repos and since mixxx's build system doesn't work with python3 you must use a standalone version.

The workaround is quite easy, as mentioned at the top of this page:

Download a standalone version of SCons 2.5.1 from here and then do the following:

tar xzvf /path/to/scons-2.5.1.tar.gz scons-2.5.1/
mv scons-2.5.1 /path/to/where-you-want-it-to-live
 
# and then inside the cloned mixxx directory use it as such
python2 /path/to/where-you-want-it-to-live/scripts/scons ...

Then you just need the dependencies:

# install the dependencies
sudo pacman -S libid3tag libmad portaudio qt libogg \
libvorbis libsndfile portmidi libmp4v2 faad2 libshout \
taglib protobuf vamp-plugin-sdk rubberband \
chromaprint sqlite upower lilv

Other

For other distributions, you will need to install the following through your distribution's package manager. On most distributions, you will also need the corresponding -dev or -devel packages for each package. If you cannot find a package listed here that starts with “lib”, try searching for the package name without the “lib” prefix.

Get Mixxx

If you are still running as root from installing packages, return to using your normal unprivileged user account (press Ctrl + D or run exit).

If you want to compile Mixxx, you'll need to download the source code. Either grab the source for the latest release from our downloads page, or checkout a snapshot from our git repository:

To update to the latest version of a git branch, enter (cd into) the directory you cloned the git repository into and run git pull. Refer to Using Git for more details.

Compile and install

Once you have the source code, change to the newly created “mixxx” directory (run cd mixxx). Mixxx uses the SCons build system rather than the more common GNU autotools and GNU make. Running scons -h in the “mixxx” directory shows a complete list of build flags if you'd like to customize. To compile without any special options, as a regular user, run:

scons prefix=INSTALLATION_DIRECTORY -j NUMBER_OF_CPU_CORES optimize=native

Change INSTALLATION_DIRECTORY to the location you want to install Mixxx to. If you want to install Mixxx for all users of the OS, you do not need to specify a prefix and can leave it as the default, which is /usr/local. If you only want to install Mixxx for your user, you can specify a location in your home directory such as ~/local

Running scons will take some time, depending on the speed of your computer. Specifying NUMBER_OF_CPU_CORES will tell scons to run that many threads at a time while compiling. This speeds up compilation on multi-core CPUs. You can check how many threads your CPU can run simultaneously with the lscpu command (look for the CPU(s) field in the output). Setting more threads than your CPU can handle will decrease performance.

Once Mixxx has compiled, if you set the prefix options for scons to a directory that your normal user does not have write access to, run

sudo scons prefix=INSTALLATION_DIRECTORY install

to install it. If you set the prefix to a directory your user does have write access to, then you do not need sudo before scons. The prefix option must be the same as before or scons will recompile Mixxx before installing it.

If you want to be able to run Mixxx on different types of CPUs, change optimize=native to optimize=portable. If you want to contribute code to Mixxx and use a debugger, use optimize=off.

To compile on a Raspberry Pi, use the arguments: optimize=native opengles=1 machine=armhf with scons.

Optional: Build with m4a/AAC file support

If you want to play m4a files, add faad=1 to your scons commands above. This requires the libraries faad2 and libmp4v2 (or libmp4) to be installed.

Optional: Compile with Clang

Clang is a C/C++ compiler based on LLVM. Using Clang has various benefits:

On Debian, Clang is provided as a package with a version number attached. Using 3.6 as an example, install it like this:

sudo apt-get install clang-3.6

To compile Mixxx using Clang 3.6, before running scons:

export CC=clang-3.6
export CXX=clang++-3.6

You can now use clang-specific SCons options.

  • To enable colorized output, use the color=1 scons flag.
  • To enable Address Sanitizer, use the asan=1 scons flag.

Troubleshooting scons

If scons can't find installed dependencies, try

scons --config=force

Uninstall

To uninstall a copy of Mixxx that you compiled, cd into the directory where you ran scons before, then run:

scons -c prefix=INSTALLATION_DIRECTORY install

INSTALLATION_DIRECTORY must be the same as that used when compiling and installing. If you needed to use sudo to install, also use sudo to uninstall.

Clean up

If scons fails with mysterious errors about not finding dependencies that you know are installed, it may be using outdated cached information to look for the dependencies. This can happen after upgrading your GNU/Linux distribution. To resolve this, try running scons -c and recompiling Mixxx.

Run without installing

If you want to just run this copy without installing, from the same directory, run: (WARNING this uses and may overwrite user-wide configs)

./mixxx --resourcePath res/

To also run from a different settings folder use:

./mixxx --resourcePath res/ --settingsPath /*the folder you like*/
Translations of this page:
compiling_on_linux.txt · Last modified: 2018/06/23 12:46 by be.ing