diff README @ 0:fc9323a41f5a

start base : Sonic Visualiser sv1-1.0rc1
author lbajardsilogic
date Fri, 11 May 2007 09:08:14 +0000
parents
children 84d1d2076bf7
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri May 11 09:08:14 2007 +0000
@@ -0,0 +1,125 @@
+
+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 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.
+
+
+To compile from source
+----------------------
+
+First, please consider getting one of the ready-to-run binary
+distributions available from http://www.sonicvisualiser.org/ .
+
+The following additional libraries are required or optional when
+building Sonic Visualiser:
+
+REQUIRED	Vamp Plugin SDK		http://www.sonicvisualiser.org/
+
+REQUIRED	Qt4 Free Edition	http://www.trolltech.com/
+REQUIRED	libsndfile		http://www.mega-nerd.com/libsndfile/
+REQUIRED	libsamplerate		http://www.mega-nerd.com/SRC/
+REQUIRED	FFTW3			http://www.fftw.org/
+REQUIRED	bzip2 library		http://www.bzip.org/
+
+Optional	JACK			http://www.jackaudio.org/
+Optional	PortAudio v18 or v19	http://www.portaudio.com/
+Optional	MAD mp3 decoder		http://www.underbit.com/products/mad/
+Optional	Oggz and fishsound	http://www.annodex.net/software/libraries.html
+Optional        liblo OSC library	http://www.plugin.org.uk/liblo/
+
+Although JACK and PortAudio are individually optional, you will need
+to have one or the other of them in order to get any audio playback.
+Usually JACK is preferred on Linux and PortAudio elsewhere.
+
+If you happen to be using a Debian-based Linux, you probably want to
+apt-get install the following packages: libqt4-dev libsndfile1-dev
+libsamplerate0-dev fftw3-dev libbz2-dev libjack0.100.0-dev libmad0-dev
+liboggz1-dev libfishsound1-dev liblo0-dev.
+
+If you are building on a Unix-like system that supports pkg-config and
+uses it for all appropriate libraries (such as a modern Linux
+distribution) then you should be able to just run "qmake" (being
+careful to ensure it is the Qt 4 version of qmake you are running, and
+not a Qt 3 version).
+
+If you do not have pkg-config, you should first edit the file sv.prf
+and comment out any of the optional HAVE_* lines (in the section
+starting "If you don't have pkg-config...") for library dependencies
+that you aren't using.  Then run the Qt 4 "qmake" command.  This will
+create the proper Makefile.
+
+(If you're on the Mac and you have Qt3 installed as well, you must
+export QMAKESPEC=macx-g++ before you do this, or Qt will get confused.)
+
+Then type "make".  The program will then either build, or not build.
+
+
+Qt Library Version Requirements
+-------------------------------
+
+Sonic Visualiser requires Qt version 4.x.  It can not be built with
+Qt 3 or earlier.
+
+You can build Sonic Visualiser using Qt 4.0, 4.1, or 4.2, but the
+build scripts provided will only work with Qt 4.2 because of an
+incompatible change in the Qt build utilities.  Please read
+README.Qt41 if you want to build with Qt 4.0 or 4.1.
+
+
+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.  Code copyright 2005-2007 Chris
+Cannam with parts copyright 2006-2007 Queen Mary, University of
+London, except where indicated in the individual source files.
+
+This project was partially funded by the European Commission through
+the SIMAC project IST-FP6-507142 and the EASAIER project IST-FP6-033902.
+
+This program 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.
+
+
+More information
+----------------
+
+http://www.sonicvisualiser.org/
+