annotate INSTALL @ 81:9f78c80c80f1

Merge from qt5 branch. We now require qt5 for Sonic Annotator
author Chris Cannam
date Wed, 08 May 2013 16:52:37 +0100
parents 52d71675a953
children
rev   line source
Chris@2 1
Chris@2 2 To compile from source
Chris@2 3 ----------------------
Chris@2 4
Chris@2 5 First, please consider getting one of the ready-to-run binary
Chris@56 6 distributions available from
Chris@56 7
Chris@56 8 http://code.soundsoftware.ac.uk/projects/sonic-annotator/files
Chris@2 9
Chris@2 10 The following additional libraries are required or optional when
Chris@2 11 building Sonic Annotator:
Chris@2 12
Chris@56 13 REQUIRED Sonic Visualiser Core Library, svcore
Chris@56 14 http://code.soundsoftware.ac.uk/projects/svcore
Chris@2 15
Chris@56 16 REQUIRED Vamp Plugin SDK http://www.vamp-plugins.org/
Chris@56 17 REQUIRED Qt4 Free Edition http://qt.nokia.com/
Chris@2 18 REQUIRED libsndfile http://www.mega-nerd.com/libsndfile/
Chris@2 19 REQUIRED libsamplerate http://www.mega-nerd.com/SRC/
Chris@2 20 REQUIRED FFTW3 http://www.fftw.org/
Chris@2 21 REQUIRED Redland RDF libraries http://librdf.org/
Chris@2 22
Chris@2 23 Optional MAD mp3 decoder http://www.underbit.com/products/mad/
Chris@2 24 Optional Oggz and fishsound http://www.annodex.net/software/libraries.html
Chris@2 25
Chris@2 26 The Redland RDF libraries include the Raptor RDF parser library,
Chris@2 27 Rasqal RDF query library, and librdf, the Redland RDF datastore (which
Chris@2 28 depends on both of those). Sonic Annotator uses Rasqal and Redland
Chris@2 29 directly, and so indirectly also requires Raptor. For best
Chris@2 30 performance it's strongly recommended that you build with Redland
Chris@2 31 1.0.8 or newer.
Chris@2 32
Chris@2 33 If you happen to be using a Debian-based Linux, you probably want to
Chris@24 34 apt-get install the following packages: libqt4-dev libsndfile1-dev \
Chris@24 35 libsamplerate0-dev fftw3-dev libmad0-dev liboggz1-dev \
Chris@24 36 libfishsound1-dev liblrdf0-dev librdf0-dev libbz2-dev libasound2-dev .
Chris@2 37
Chris@2 38 If you are building on a Unix-like system that supports pkg-config and
Chris@2 39 uses it for all appropriate libraries (such as a modern Linux
Chris@2 40 distribution) then you should be able to just run "qmake" (being
Chris@2 41 careful to ensure it is the Qt 4 version of qmake you are running, and
Chris@2 42 not a Qt 3 version).
Chris@2 43
Chris@2 44 If you do not have pkg-config, you should first edit the file sv.prf
Chris@2 45 and comment out any of the optional HAVE_* lines (in the section
Chris@2 46 starting "If you don't have pkg-config...") for library dependencies
Chris@2 47 that you aren't using. Then run the Qt 4 "qmake" command. This will
Chris@2 48 create the proper Makefile.
Chris@2 49
Chris@2 50 (If you're on the Mac and you have Qt3 installed as well, you must
Chris@2 51 export QMAKESPEC=macx-g++ before you do this, or Qt will get confused.)
Chris@2 52
Chris@2 53 Then type "make". The program will then either build, or not build.
Chris@47 54 If it builds, the result will be a binary file in sonic-annotator (on
Chris@47 55 Linux) or release/Sonic Annotator.exe (on Win32), or a bundle in
Chris@47 56 sonic-annotator.app. There should be nothing to install apart from
Chris@47 57 the executable itself and any of the above listed third-party shared
Chris@47 58 libraries that are not already installed.
Chris@2 59
Chris@2 60
Chris@2 61 Qt Library Version Requirements
Chris@2 62 -------------------------------
Chris@2 63
Chris@2 64 Sonic Annotator requires Qt version 4.3 or newer. It can not be
Chris@2 65 built with Qt3 or with Qt 4.0.x, 4.1.x, or 4.2.x.
Chris@2 66
Chris@2 67