comparison INSTALL.txt @ 2008:55d9bbf1fe45 zoom

Merge from default branch
author Chris Cannam
date Mon, 17 Sep 2018 14:05:41 +0100
parents adc8a48f4e4c
children ac587ccb08bd
comparison
equal deleted inserted replaced
2007:246bdf94ef7b 2008:55d9bbf1fe45
1 1
2 To compile from source 2 To compile Sonic Visualiser from source
3 ---------------------- 3 =======================================
4 4
5 To build on a Unix-like system, run 5 Windows
6 -------
6 7
7 $ ./configure && make 8 Use the Qt Creator IDE with either the MinGW compiler (for 32-bit
9 builds) or Visual C++ (for 64-bit builds).
8 10
9 The following additional libraries are required or optional when 11 For details, see the wiki page at
10 building the SV core libraries:
11 12
12 REQUIRED Qt v5 http://qt-project.org/ 13 https://code.soundsoftware.ac.uk/projects/sonic-visualiser/wiki/WindowsBuild30
13 REQUIRED Vamp Plugin SDK v2.x http://www.vamp-plugins.org/
14 REQUIRED Rubber Band Library http://www.breakfastquay.com/rubberband/
15 REQUIRED libsndfile http://www.mega-nerd.com/libsndfile/
16 REQUIRED libsamplerate http://www.mega-nerd.com/SRC/
17 REQUIRED FFTW3 http://www.fftw.org/
18 REQUIRED bzip2 library http://www.bzip.org/
19 REQUIRED Sord and Serd libraries http://drobilla.net/software/
20 14
21 Optional MAD mp3 decoder http://www.underbit.com/products/mad/
22 Optional Oggz and fishsound http://xiph.org/oggz/
23 Optional liblo OSC library http://www.plugin.org.uk/liblo/
24 15
25 If you are going to build the rest of the SV libraries and the Sonic 16 MacOS
26 Visualiser application, you will also need one or more of: 17 -----
27 18
28 Optional JACK http://www.jackaudio.org/ 19 Build from the command line, but don't use the configure script.
29 Optional PortAudio v19 http://www.portaudio.com/ 20 Instead install Qt v5.x and run
30 Optional PulseAudio http://www.pulseaudio.org/ 21
22 $ ./repoint install
23 $ qmake -r # you may need to use the full path to your Qt qmake here
24 $ make
25
26
27 Linux
28 -----
29
30 $ ./configure && make && make install
31
32 The following additional libraries are required or optional:
33
34 REQUIRED Qt v5 http://qt-project.org/
35 REQUIRED Vamp Plugin SDK v2.x http://www.vamp-plugins.org/
36 REQUIRED Rubber Band Library http://www.breakfastquay.com/rubberband/
37 REQUIRED libsndfile http://www.mega-nerd.com/libsndfile/
38 REQUIRED libsamplerate http://www.mega-nerd.com/SRC/
39 REQUIRED FFTW3 http://www.fftw.org/
40 REQUIRED bzip2 library http://www.bzip.org/
41 REQUIRED Sord and Serd libraries http://drobilla.net/software/
42 REQUIRED Cap'n Proto http://capnproto.org/
43
44 Optional MAD mp3 decoder http://www.underbit.com/products/mad/
45 Optional Oggz and fishsound http://xiph.org/oggz/
46 Optional liblo OSC library http://www.plugin.org.uk/liblo/
47 Optional JACK http://www.jackaudio.org/
48 Optional PortAudio v19 http://www.portaudio.com/
49 Optional PulseAudio http://www.pulseaudio.org/
31 50
32 Although JACK, PortAudio, and PulseAudio are individually optional, 51 Although JACK, PortAudio, and PulseAudio are individually optional,
33 you will need to have one or the other of them in order to get any 52 you will need to have at least one of them in order to get any audio
34 audio playback. Usually JACK is preferred on Linux, with PulseAudio 53 playback. Usually JACK is preferred on Linux, with PulseAudio as a
35 as a backup, and PortAudio is used elsewhere. 54 backup, and PortAudio is used elsewhere.
36 55
37 On Linux, you will need the ALSA libraries (used for MIDI). 56 On Linux, you will need the ALSA libraries (used for MIDI).
38 57
39 If you happen to be using a Debian-based Linux, you probably want to 58 For Cap'n Proto, currently you will need the v0.6 release which (if
40 apt-get install something like the following packages: qtbase5-dev 59 not available as a package) can be obtained from the releases page on
41 qt5-default libsndfile1-dev libsamplerate0-dev libfftw3-dev libbz2-dev 60 Github. To build it, you might do something like
42 libjack-dev libjack0 libpulse-dev libmad0-dev libid3tag0-dev
43 liboggz2-dev libfishsound1-dev libasound2-dev liblo-dev liblrdf0-dev
44 libsord-dev libserd-dev vamp-plugin-sdk librubberband-dev.
45 61
62 $ curl -L -o capnproto-v0.6.0.tar.gz https://github.com/sandstorm-io/capnproto/archive/v0.6.0.tar.gz
63 $ tar xf capnproto-v0.6.0.tar.gz
64 $ cd capnproto-0.6.0/c++
65 $ autoreconf -i
66 $ ./configure --enable-static --disable-shared
67 $ make && make install
68
69 For the rest, if you happen to be using a Debian-based Linux, you
70 probably want to apt install something like the following packages:
71
72 build-essential libbz2-dev libfftw3-dev libfishsound1-dev
73 libid3tag0-dev liblo-dev liblrdf0-dev libmad0-dev liboggz2-dev
74 libpulse-dev libsamplerate-dev libsndfile-dev libsord-dev
75 libxml2-utils portaudio19-dev qt5-default libqt5svg5-dev raptor-utils
76 librubberband-dev git mercurial autoconf automake libtool
77