annotate README @ 1315:ed3009a50f81 piper

Make SVDEBUG always write to a log file -- formerly this was disabled in NDEBUG builds. I think there's little use to that, it just means that we keep adding more cerr debug output because we aren't getting the log we need. And SVDEBUG logging is not usually used in tight loops, I don't think the performance overhead is too serious. Also update the About box.
author Chris Cannam
date Thu, 03 Nov 2016 14:57:00 +0000
parents 72daacb203a6
children 9401d021b47b
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@848 21 detectors and so on (see http://vamp-plugins.org/)
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@848 43 http://c4dm.eecs.qmul.ac.uk/
Chris@392 44
Chris@848 45 Sonic Visualiser was written by Chris Cannam with contributions from
Chris@848 46 Christian Landone, Mathieu Barthet, Dan Stowell, Jesus Corral Garcia,
Chris@848 47 Matthias Mauch, and Craig Sapp.
Chris@392 48
Chris@1255 49 Code copyright 2005-2007 Chris Cannam and copyright 2006-2016 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@848 61 Sciences Research Council through the OMRAS2 project EP/E017614/1, the
Chris@848 62 Musicology for the Masses project EP/I001832/1, and the Sound Software
Chris@848 63 project EP/H043101/1.
Chris@394 64
Chris@392 65 Sonic Visualiser is free software; you can redistribute it and/or modify
Chris@392 66 it under the terms of the GNU General Public License as published by
Chris@392 67 the Free Software Foundation; either version 2 of the License, or (at
Chris@392 68 your option) any later version. See the file COPYING included with
Chris@392 69 this distribution for more information.
Chris@392 70
Chris@392 71 Sonic Visualiser may also make use of the following libraries:
Chris@392 72
Chris@549 73 * Qt5 -- Copyright Digia Oyj, distributed under the LGPL
Chris@549 74 * JACK -- Copyright Paul Davis, Jack O'Quin et al, under the LGPL
Chris@392 75 * PortAudio -- Copyright Ross Bencina, Phil Burk et al, BSD license
Chris@392 76 * Ogg decoder -- Copyright CSIRO Australia, BSD license
Chris@392 77 * MAD mp3 decoder -- Copyright Underbit Technologies Inc, GPL
Chris@392 78 * libsamplerate -- Copyright Erik de Castro Lopo, GPL
Chris@392 79 * libsndfile -- Copyright Erik de Castro Lopo, LGPL
Chris@392 80 * FFTW3 -- Copyright Matteo Frigo and MIT, GPL
Chris@392 81 * Rubber Band -- Copyright Chris Cannam, GPL
Chris@549 82 * Vamp plugin SDK -- Copyright Chris Cannam and QMUL, BSD license
Chris@392 83 * LADSPA plugin SDK -- Copyright Richard Furse et al, LGPL
Chris@392 84 * RtMIDI -- Copyright Gary P. Scavone, BSD license
Chris@549 85 * Dataquay -- Copyright Breakfast Quay, BSD license
Chris@549 86 * Sord and Serd -- Copyright David Robillard, BSD license
Chris@549 87 * Redland -- Copyright Dave Beckett and the University of Bristol, LGPL/Apache 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
Chris@392 94 Compiling Sonic Visualiser
Chris@392 95 --------------------------
Chris@392 96
Chris@392 97 If you are planning to compile Sonic Visualiser from source code,
Chris@392 98 please read the file INSTALL.txt.
Chris@392 99
Chris@392 100
Chris@392 101 More information
Chris@392 102 ----------------
Chris@392 103
Chris@392 104 For more information about Sonic Visualiser, please go to
Chris@392 105
Chris@392 106 http://www.sonicvisualiser.org/
Chris@392 107