annotate INSTALL @ 14:f53745e97dc5

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