annotate README @ 0:fc9323a41f5a

start base : Sonic Visualiser sv1-1.0rc1
author lbajardsilogic
date Fri, 11 May 2007 09:08:14 +0000
parents
children 84d1d2076bf7
rev   line source
lbajardsilogic@0 1
lbajardsilogic@0 2 Sonic Visualiser
lbajardsilogic@0 3 ================
lbajardsilogic@0 4
lbajardsilogic@0 5 Sonic Visualiser is a program for viewing and analysing the contents
lbajardsilogic@0 6 of music audio files.
lbajardsilogic@0 7
lbajardsilogic@0 8 With Sonic Visualiser you can:
lbajardsilogic@0 9
lbajardsilogic@0 10 * Load audio files in various formats and view their waveforms
lbajardsilogic@0 11
lbajardsilogic@0 12 * Look at audio visualisations such as spectrogram views, with
lbajardsilogic@0 13 interactive adjustment of display parameters
lbajardsilogic@0 14
lbajardsilogic@0 15 * Annotate audio data by adding labelled time points and defining
lbajardsilogic@0 16 segments, point values and curves
lbajardsilogic@0 17
lbajardsilogic@0 18 * Run feature-extraction plugins to calculate annotations
lbajardsilogic@0 19 automatically, using algorithms such as beat trackers, pitch
lbajardsilogic@0 20 detectors and so on
lbajardsilogic@0 21
lbajardsilogic@0 22 * Import annotation data from various text formats and MIDI files
lbajardsilogic@0 23
lbajardsilogic@0 24 * Play back the original audio with synthesised annotations, taking
lbajardsilogic@0 25 care to synchronise playback with the display position
lbajardsilogic@0 26
lbajardsilogic@0 27 * Slow down and speed up playback and loop segments of interest,
lbajardsilogic@0 28 including seamless looping of complex non-contiguous areas
lbajardsilogic@0 29
lbajardsilogic@0 30 * Export annotations and audio selections to external files.
lbajardsilogic@0 31
lbajardsilogic@0 32 Sonic Visualiser can also be controlled remotely using the Open Sound
lbajardsilogic@0 33 Control (OSC) protocol.
lbajardsilogic@0 34
lbajardsilogic@0 35
lbajardsilogic@0 36 To compile from source
lbajardsilogic@0 37 ----------------------
lbajardsilogic@0 38
lbajardsilogic@0 39 First, please consider getting one of the ready-to-run binary
lbajardsilogic@0 40 distributions available from http://www.sonicvisualiser.org/ .
lbajardsilogic@0 41
lbajardsilogic@0 42 The following additional libraries are required or optional when
lbajardsilogic@0 43 building Sonic Visualiser:
lbajardsilogic@0 44
lbajardsilogic@0 45 REQUIRED Vamp Plugin SDK http://www.sonicvisualiser.org/
lbajardsilogic@0 46
lbajardsilogic@0 47 REQUIRED Qt4 Free Edition http://www.trolltech.com/
lbajardsilogic@0 48 REQUIRED libsndfile http://www.mega-nerd.com/libsndfile/
lbajardsilogic@0 49 REQUIRED libsamplerate http://www.mega-nerd.com/SRC/
lbajardsilogic@0 50 REQUIRED FFTW3 http://www.fftw.org/
lbajardsilogic@0 51 REQUIRED bzip2 library http://www.bzip.org/
lbajardsilogic@0 52
lbajardsilogic@0 53 Optional JACK http://www.jackaudio.org/
lbajardsilogic@0 54 Optional PortAudio v18 or v19 http://www.portaudio.com/
lbajardsilogic@0 55 Optional MAD mp3 decoder http://www.underbit.com/products/mad/
lbajardsilogic@0 56 Optional Oggz and fishsound http://www.annodex.net/software/libraries.html
lbajardsilogic@0 57 Optional liblo OSC library http://www.plugin.org.uk/liblo/
lbajardsilogic@0 58
lbajardsilogic@0 59 Although JACK and PortAudio are individually optional, you will need
lbajardsilogic@0 60 to have one or the other of them in order to get any audio playback.
lbajardsilogic@0 61 Usually JACK is preferred on Linux and PortAudio elsewhere.
lbajardsilogic@0 62
lbajardsilogic@0 63 If you happen to be using a Debian-based Linux, you probably want to
lbajardsilogic@0 64 apt-get install the following packages: libqt4-dev libsndfile1-dev
lbajardsilogic@0 65 libsamplerate0-dev fftw3-dev libbz2-dev libjack0.100.0-dev libmad0-dev
lbajardsilogic@0 66 liboggz1-dev libfishsound1-dev liblo0-dev.
lbajardsilogic@0 67
lbajardsilogic@0 68 If you are building on a Unix-like system that supports pkg-config and
lbajardsilogic@0 69 uses it for all appropriate libraries (such as a modern Linux
lbajardsilogic@0 70 distribution) then you should be able to just run "qmake" (being
lbajardsilogic@0 71 careful to ensure it is the Qt 4 version of qmake you are running, and
lbajardsilogic@0 72 not a Qt 3 version).
lbajardsilogic@0 73
lbajardsilogic@0 74 If you do not have pkg-config, you should first edit the file sv.prf
lbajardsilogic@0 75 and comment out any of the optional HAVE_* lines (in the section
lbajardsilogic@0 76 starting "If you don't have pkg-config...") for library dependencies
lbajardsilogic@0 77 that you aren't using. Then run the Qt 4 "qmake" command. This will
lbajardsilogic@0 78 create the proper Makefile.
lbajardsilogic@0 79
lbajardsilogic@0 80 (If you're on the Mac and you have Qt3 installed as well, you must
lbajardsilogic@0 81 export QMAKESPEC=macx-g++ before you do this, or Qt will get confused.)
lbajardsilogic@0 82
lbajardsilogic@0 83 Then type "make". The program will then either build, or not build.
lbajardsilogic@0 84
lbajardsilogic@0 85
lbajardsilogic@0 86 Qt Library Version Requirements
lbajardsilogic@0 87 -------------------------------
lbajardsilogic@0 88
lbajardsilogic@0 89 Sonic Visualiser requires Qt version 4.x. It can not be built with
lbajardsilogic@0 90 Qt 3 or earlier.
lbajardsilogic@0 91
lbajardsilogic@0 92 You can build Sonic Visualiser using Qt 4.0, 4.1, or 4.2, but the
lbajardsilogic@0 93 build scripts provided will only work with Qt 4.2 because of an
lbajardsilogic@0 94 incompatible change in the Qt build utilities. Please read
lbajardsilogic@0 95 README.Qt41 if you want to build with Qt 4.0 or 4.1.
lbajardsilogic@0 96
lbajardsilogic@0 97
lbajardsilogic@0 98 Credits
lbajardsilogic@0 99 -------
lbajardsilogic@0 100
lbajardsilogic@0 101 Sonic Visualiser was developed at the Centre for Digital Music,
lbajardsilogic@0 102 Queen Mary, University of London.
lbajardsilogic@0 103
lbajardsilogic@0 104 http://www.elec.qmul.ac.uk/digitalmusic/
lbajardsilogic@0 105
lbajardsilogic@0 106 The main program is by Chris Cannam, with additional DSP and program
lbajardsilogic@0 107 design work by Christian Landone. Code copyright 2005-2007 Chris
lbajardsilogic@0 108 Cannam with parts copyright 2006-2007 Queen Mary, University of
lbajardsilogic@0 109 London, except where indicated in the individual source files.
lbajardsilogic@0 110
lbajardsilogic@0 111 This project was partially funded by the European Commission through
lbajardsilogic@0 112 the SIMAC project IST-FP6-507142 and the EASAIER project IST-FP6-033902.
lbajardsilogic@0 113
lbajardsilogic@0 114 This program is free software; you can redistribute it and/or modify
lbajardsilogic@0 115 it under the terms of the GNU General Public License as published by
lbajardsilogic@0 116 the Free Software Foundation; either version 2 of the License, or (at
lbajardsilogic@0 117 your option) any later version. See the file COPYING included with
lbajardsilogic@0 118 this distribution for more information.
lbajardsilogic@0 119
lbajardsilogic@0 120
lbajardsilogic@0 121 More information
lbajardsilogic@0 122 ----------------
lbajardsilogic@0 123
lbajardsilogic@0 124 http://www.sonicvisualiser.org/
lbajardsilogic@0 125