annotate README @ 437:9de86c1b980e

Merge from debug-output branch
author Chris Cannam
date Tue, 14 Jun 2011 14:50:08 +0100
parents 53d5e31770b4
children 209c442fdb34
rev   line source
Chris@392 1
Chris@392 2 Sonic Visualiser
Chris@392 3 ================
Chris@392 4
Chris@392 5 Sonic Visualiser is a program for viewing and analysing the contents
Chris@392 6 of music audio files.
Chris@392 7
Chris@392 8 With Sonic Visualiser you can:
Chris@392 9
Chris@392 10 * Load audio files in various formats (WAV/AIFF, plus Ogg and mp3
Chris@392 11 if compiled in) and view their waveforms
Chris@392 12
Chris@392 13 * Look at audio visualisations such as spectrogram views, with
Chris@392 14 interactive adjustment of display parameters
Chris@392 15
Chris@392 16 * Annotate audio data by adding labelled time points and defining
Chris@392 17 segments, point values and curves
Chris@392 18
Chris@392 19 * Run feature-extraction plugins to calculate annotations
Chris@392 20 automatically, using algorithms such as beat trackers, pitch
Chris@392 21 detectors and so on
Chris@392 22
Chris@392 23 * Import annotation data from various text formats and MIDI files
Chris@392 24
Chris@392 25 * Play back the original audio with synthesised annotations, taking
Chris@392 26 care to synchronise playback with the display position
Chris@392 27
Chris@392 28 * Slow down and speed up playback and loop segments of interest,
Chris@392 29 including seamless looping of complex non-contiguous areas
Chris@392 30
Chris@392 31 * Export annotations and audio selections to external files.
Chris@392 32
Chris@392 33 Sonic Visualiser can also be controlled remotely using the Open Sound
Chris@392 34 Control (OSC) protocol (if support is compiled in).
Chris@392 35
Chris@392 36
Chris@392 37 Credits
Chris@392 38 -------
Chris@392 39
Chris@392 40 Sonic Visualiser was developed at the Centre for Digital Music,
Chris@392 41 Queen Mary, University of London.
Chris@392 42
Chris@392 43 http://www.elec.qmul.ac.uk/digitalmusic/
Chris@392 44
Chris@392 45 The main program is by Chris Cannam, with additional DSP and program
Chris@392 46 design work by Christian Landone. Thanks also to Craig Sapp for his
Chris@392 47 suggestions and useful feedback.
Chris@392 48
Chris@392 49 Code copyright 2005-2007 Chris Cannam and copyright 2006-2011 Queen
Chris@392 50 Mary, University of London, except where indicated in the individual
Chris@392 51 source files.
Chris@392 52
Chris@392 53 This work was partially funded by the European Commission through the
Chris@392 54 SIMAC project IST-FP6-507142 and the EASAIER project IST-FP6-033902.
Chris@392 55
Chris@392 56 This work was partially funded by the Arts and Humanities Research
Chris@392 57 Council through its Research Centre for the History and Analysis of
Chris@392 58 Recorded Music (CHARM).
Chris@392 59
Chris@392 60 This work was partially funded by the Engineering and Physical
Chris@392 61 Sciences Research Council through the OMRAS2 project EP/E017614/1.
Chris@392 62
Chris@394 63 This work was partially funded by the Engineering and Physical
Chris@394 64 Sciences Research Council through the Musicology for the Masses
Chris@394 65 project EP/I001832/1.
Chris@394 66
Chris@392 67 Sonic Visualiser is free software; you can redistribute it and/or modify
Chris@392 68 it under the terms of the GNU General Public License as published by
Chris@392 69 the Free Software Foundation; either version 2 of the License, or (at
Chris@392 70 your option) any later version. See the file COPYING included with
Chris@392 71 this distribution for more information.
Chris@392 72
Chris@392 73 Sonic Visualiser may also make use of the following libraries:
Chris@392 74
Chris@392 75 * Qt4 -- Copyright Nokia Corporation, distributed under the Lesser GPL
Chris@392 76 * JACK -- Copyright Paul Davis, Jack O'Quin et al, under the Lesser GPL
Chris@392 77 * PortAudio -- Copyright Ross Bencina, Phil Burk et al, BSD license
Chris@392 78 * Ogg decoder -- Copyright CSIRO Australia, BSD license
Chris@392 79 * MAD mp3 decoder -- Copyright Underbit Technologies Inc, GPL
Chris@392 80 * libsamplerate -- Copyright Erik de Castro Lopo, GPL
Chris@392 81 * libsndfile -- Copyright Erik de Castro Lopo, LGPL
Chris@392 82 * FFTW3 -- Copyright Matteo Frigo and MIT, GPL
Chris@392 83 * Rubber Band -- Copyright Chris Cannam, GPL
Chris@392 84 * Vamp plugin SDK -- Copyright Chris Cannam, BSD license
Chris@392 85 * LADSPA plugin SDK -- Copyright Richard Furse et al, LGPL
Chris@392 86 * Redland RDF libraries -- Copyright Dave Beckett and the University of Bristol, LGPL/Apache license
Chris@392 87 * RtMIDI -- Copyright Gary P. Scavone, BSD license
Chris@392 88 * liblo OSC library -- Copyright Steve Harris, GPL
Chris@392 89
Chris@392 90 (Some distributions of Sonic Visualiser may have one or more of these
Chris@392 91 libraries statically linked.) Many thanks to their authors.
Chris@392 92
Chris@392 93 Sonic Visualiser can also use QuickTime for audio file import on OS/X.
Chris@392 94 For licensing reasons, you may not distribute binaries of Sonic
Chris@392 95 Visualiser with QuickTime support included for any platform that does
Chris@392 96 not include QuickTime as part of the platform itself (see section 3 of
Chris@392 97 version 2 of the GNU General Public License).
Chris@392 98
Chris@392 99
Chris@392 100 Compiling Sonic Visualiser
Chris@392 101 --------------------------
Chris@392 102
Chris@392 103 If you are planning to compile Sonic Visualiser from source code,
Chris@392 104 please read the file INSTALL.txt.
Chris@392 105
Chris@392 106
Chris@392 107 More information
Chris@392 108 ----------------
Chris@392 109
Chris@392 110 For more information about Sonic Visualiser, please go to
Chris@392 111
Chris@392 112 http://www.sonicvisualiser.org/
Chris@392 113