
To compile from source
----------------------

First, please consider getting one of the ready-to-run binary
distributions available from http://www.sonicvisualiser.org/ .

The following additional libraries are required or optional when
building Sonic Visualiser:

REQUIRED	Vamp Plugin SDK		http://www.vamp-plugins.org/

REQUIRED	Qt4 Free Edition	http://www.trolltech.com/
REQUIRED	libsndfile		http://www.mega-nerd.com/libsndfile/
REQUIRED	libsamplerate		http://www.mega-nerd.com/SRC/
REQUIRED	FFTW3			http://www.fftw.org/
REQUIRED	bzip2 library		http://www.bzip.org/

Optional	JACK			http://www.jackaudio.org/
Optional	PortAudio v18 or v19	http://www.portaudio.com/
Optional	MAD mp3 decoder		http://www.underbit.com/products/mad/
Optional	Oggz and fishsound	http://www.annodex.net/software/libraries.html
Optional        liblo OSC library	http://www.plugin.org.uk/liblo/

Although JACK and PortAudio are individually optional, you will need
to have one or the other of them in order to get any audio playback.
Usually JACK is preferred on Linux and PortAudio elsewhere.

If you happen to be using a Debian-based Linux, you probably want to
apt-get install the following packages: libqt4-dev libsndfile1-dev
libsamplerate0-dev fftw3-dev libbz2-dev libjack0.100.0-dev libmad0-dev
liboggz1-dev libfishsound1-dev liblo0-dev.

If you are building on a Unix-like system that supports pkg-config and
uses it for all appropriate libraries (such as a modern Linux
distribution) then you should be able to just run "qmake" (being
careful to ensure it is the Qt 4 version of qmake you are running, and
not a Qt 3 version).

If you do not have pkg-config, you should first edit the file sv.prf
and comment out any of the optional HAVE_* lines (in the section
starting "If you don't have pkg-config...") for library dependencies
that you aren't using.  Then run the Qt 4 "qmake" command.  This will
create the proper Makefile.

(If you're on the Mac and you have Qt3 installed as well, you must
export QMAKESPEC=macx-g++ before you do this, or Qt will get confused.)

Then type "make".  The program will then either build, or not build.
If it builds, the result will be a binary file in sv/sonic-visualiser
(on Linux) or sv/release/sonic-visualiser.exe (on Win32), or a bundle
in sv/sonic-visualiser.app.  There should be nothing to install apart
from the executable itself and any of the above listed third-party
shared libraries that are not already installed.


Qt Library Version Requirements
-------------------------------

Sonic Visualiser requires Qt version 4.x.  It can not be built with
Qt 3 or earlier.

You can build Sonic Visualiser using Qt 4.0, 4.1, or 4.2, but the
build scripts provided will only work with Qt 4.2 because of an
incompatible change in the Qt build utilities.  Please read
README.Qt41 if you want to build with Qt 4.0 or 4.1.

