annotate INSTALL.txt @ 1831:a2053d1fb6be baselib-win-build

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