comparison README @ 2:475f4623feba

* build update for runner with "incorporated" SV libraries
author Chris Cannam
date Thu, 11 Dec 2008 11:01:37 +0000
parents 581b1b150a4d
children 9a4e410bda7a
comparison
equal deleted inserted replaced
1:92911f967a16 2:475f4623feba
4 4
5 Sonic Annotator is a utility program for batch feature extraction from 5 Sonic Annotator is a utility program for batch feature extraction from
6 audio files. It runs Vamp audio analysis plugins on audio files, and 6 audio files. It runs Vamp audio analysis plugins on audio files, and
7 can write the result features in a selection of formats. 7 can write the result features in a selection of formats.
8 8
9 For more information, see
10
11 http://www.omras2.org/SonicAnnotator
12
13 More documentation follows further down this README file, after the
14 credits.
15
16
17 Credits
18 -------
19
20 Sonic Annotator was developed at the Centre for Digital Music,
21 Queen Mary, University of London.
22
23 http://www.elec.qmul.ac.uk/digitalmusic/
24
25 The main program is by Mark Levy, Chris Cannam, and Chris Sutton.
26 Sonic Annotator incorporates library code from the Sonic Visualiser
27 application by Chris Cannam. Code copyright 2005-2007 Chris Cannam,
28 copyright 2006-2008 Queen Mary, University of London, except where
29 indicated in the individual source files.
30
31 This work was funded by the Engineering and Physical Sciences Research
32 Council through the OMRAS2 project EP/E017614/1.
33
34 Sonic Annotator is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License as
36 published by the Free Software Foundation; either version 2 of the
37 License, or (at your option) any later version. See the file COPYING
38 included with this distribution for more information.
39
40 Sonic Annotator may also make use of the following libraries:
41
42 * Qt4 -- Copyright Nokia Corporation, distributed under the GPL
43 * Ogg decoder -- Copyright CSIRO Australia, BSD license
44 * MAD mp3 decoder -- Copyright Underbit Technologies Inc, GPL
45 * libsamplerate -- Copyright Erik de Castro Lopo, GPL
46 * libsndfile -- Copyright Erik de Castro Lopo, LGPL
47 * FFTW3 -- Copyright Matteo Frigo and MIT, GPL
48 * Vamp plugin SDK -- Copyright Chris Cannam, BSD license
49 * Redland RDF libraries -- Copyright Dave Beckett and the University of Bristol, LGPL/Apache license
50
51 (Some distributions of Sonic Annotator may have one or more of these
52 libraries statically linked.) Many thanks to their authors.
53
54 Sonic Annotator can also use QuickTime for audio file import on OS/X.
55 For licensing reasons, you may not distribute binaries of Sonic
56 Annotator with QuickTime support included for any platform that does
57 not include QuickTime as part of the platform itself (see section 3 of
58 version 2 of the GNU General Public License).
59
60
61 Compiling Sonic Annotator
62 --------------------------
63
64 If you are planning to compile Sonic Annotator from source code,
65 please read the file INSTALL.
66
9 67
10 A Quick Tutorial 68 A Quick Tutorial
11 ---------------- 69 ================
12 70
13 To use Sonic Annotator, you need to tell it three things: what audio 71 To use Sonic Annotator, you need to tell it three things: what audio
14 files to extract features from; what features to extract; and how and 72 files to extract features from; what features to extract; and how and
15 where to write the results. You can also optionally tell it to 73 where to write the results. You can also optionally tell it to
16 summarise the features. 74 summarise the features.