changeset 392:58b7e3893963

* Update dates, add README
author Chris Cannam
date Thu, 03 Feb 2011 13:18:30 +0000
parents 00a5d0029e95
children 2ce1a4f8c4d3
files INSTALL.txt README main/MainWindow.cpp
diffstat 3 files changed, 111 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL.txt	Tue Jan 11 15:20:58 2011 +0000
+++ b/INSTALL.txt	Thu Feb 03 13:18:30 2011 +0000
@@ -2,12 +2,7 @@
 To compile from source
 ----------------------
 
-This file provides various instructions useful when compiling the SV
-libraries from source, but it doesn't have a complete recipe for any
-one platform -- there are too many variables.  However, you can find a
-recipe for one platform (Ubuntu Linux) in the file INSTALL.ubuntu.
-
-To build, run
+To build on a Unix-like system, run
 
 $ ./configure && make
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Thu Feb 03 13:18:30 2011 +0000
@@ -0,0 +1,109 @@
+
+Sonic Visualiser
+================
+
+Sonic Visualiser is a program for viewing and analysing the contents
+of music audio files.
+
+With Sonic Visualiser you can:
+
+ * Load audio files in various formats (WAV/AIFF, plus Ogg and mp3
+if compiled in) and view their waveforms
+ 
+ * Look at audio visualisations such as spectrogram views, with
+interactive adjustment of display parameters
+
+ * Annotate audio data by adding labelled time points and defining
+segments, point values and curves
+
+ * Run feature-extraction plugins to calculate annotations
+automatically, using algorithms such as beat trackers, pitch
+detectors and so on
+
+ * Import annotation data from various text formats and MIDI files
+
+ * Play back the original audio with synthesised annotations, taking
+care to synchronise playback with the display position
+
+ * Slow down and speed up playback and loop segments of interest,
+including seamless looping of complex non-contiguous areas
+
+ * Export annotations and audio selections to external files.
+
+Sonic Visualiser can also be controlled remotely using the Open Sound
+Control (OSC) protocol (if support is compiled in).
+
+
+Credits
+-------
+
+Sonic Visualiser was developed at the Centre for Digital Music,
+Queen Mary, University of London.
+
+  http://www.elec.qmul.ac.uk/digitalmusic/
+
+The main program is by Chris Cannam, with additional DSP and program
+design work by Christian Landone.  Thanks also to Craig Sapp for his
+suggestions and useful feedback.
+
+Code copyright 2005-2007 Chris Cannam and copyright 2006-2011 Queen
+Mary, University of London, except where indicated in the individual
+source files.
+
+This work was partially funded by the European Commission through the
+SIMAC project IST-FP6-507142 and the EASAIER project IST-FP6-033902.
+
+This work was partially funded by the Arts and Humanities Research
+Council through its Research Centre for the History and Analysis of
+Recorded Music (CHARM).
+
+This work was partially funded by the Engineering and Physical
+Sciences Research Council through the OMRAS2 project EP/E017614/1.
+
+Sonic Visualiser is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or (at
+your option) any later version.  See the file COPYING included with
+this distribution for more information.
+
+Sonic Visualiser may also make use of the following libraries:
+
+ * Qt4 -- Copyright Nokia Corporation, distributed under the Lesser GPL
+ * JACK -- Copyright Paul Davis, Jack O'Quin et al, under the Lesser GPL
+ * PortAudio -- Copyright Ross Bencina, Phil Burk et al, BSD license
+ * Ogg decoder -- Copyright CSIRO Australia, BSD license
+ * MAD mp3 decoder -- Copyright Underbit Technologies Inc, GPL
+ * libsamplerate -- Copyright Erik de Castro Lopo, GPL
+ * libsndfile -- Copyright Erik de Castro Lopo, LGPL
+ * FFTW3 -- Copyright Matteo Frigo and MIT, GPL
+ * Rubber Band -- Copyright Chris Cannam, GPL
+ * Vamp plugin SDK -- Copyright Chris Cannam, BSD license
+ * LADSPA plugin SDK -- Copyright Richard Furse et al, LGPL
+ * Redland RDF libraries -- Copyright Dave Beckett and the University of Bristol, LGPL/Apache license
+ * RtMIDI -- Copyright Gary P. Scavone, BSD license
+ * liblo OSC library -- Copyright Steve Harris, GPL
+
+(Some distributions of Sonic Visualiser may have one or more of these
+libraries statically linked.)  Many thanks to their authors.
+
+Sonic Visualiser can also use QuickTime for audio file import on OS/X.
+For licensing reasons, you may not distribute binaries of Sonic
+Visualiser with QuickTime support included for any platform that does
+not include QuickTime as part of the platform itself (see section 3 of
+version 2 of the GNU General Public License).
+
+
+Compiling Sonic Visualiser
+--------------------------
+
+If you are planning to compile Sonic Visualiser from source code,
+please read the file INSTALL.txt.
+
+
+More information
+----------------
+
+For more information about Sonic Visualiser, please go to
+
+  http://www.sonicvisualiser.org/
+
--- a/main/MainWindow.cpp	Tue Jan 11 15:20:58 2011 +0000
+++ b/main/MainWindow.cpp	Thu Feb 03 13:18:30 2011 +0000
@@ -4085,7 +4085,7 @@
 #endif
 
     aboutText += 
-        "<p><small>Sonic Visualiser Copyright &copy; 2005&ndash;2010 Chris Cannam and "
+        "<p><small>Sonic Visualiser Copyright &copy; 2005&ndash;2011 Chris Cannam and "
         "Queen Mary, University of London.</small></p>"
         "<p><small>This program is free software; you can redistribute it and/or "
         "modify it under the terms of the GNU General Public License as "