comparison README.md @ 1735:db3d9ff6689e

Markdownise, add badges
author Chris Cannam
date Mon, 10 Jul 2017 17:34:06 +0100
parents README@2a53ed37351e
children fd37f59348f7
comparison
equal deleted inserted replaced
1734:7f2808142abf 1735:db3d9ff6689e
1
2 Sonic Visualiser
3 ================
4
5 A program for viewing and analysing the contents of music audio files
6 ---------------------------------------------------------------------
7
8 With Sonic Visualiser you can:
9
10 * Load audio files in various formats (WAV/AIFF, plus Ogg and mp3
11 if compiled in) and view their waveforms
12
13 * Look at audio visualisations such as spectrogram views, with
14 interactive adjustment of display parameters
15
16 * Annotate audio data by adding labelled time points and defining
17 segments, point values and curves
18
19 * Run feature-extraction plugins to calculate annotations
20 automatically, using algorithms such as beat trackers, pitch
21 detectors and so on (see http://vamp-plugins.org/)
22
23 * Import annotation data from various text formats and MIDI files
24
25 * Play back the original audio with synthesised annotations, taking
26 care to synchronise playback with the display position
27
28 * Slow down and speed up playback and loop segments of interest,
29 including seamless looping of complex non-contiguous areas
30
31 * Export annotations and audio selections to external files.
32
33 Sonic Visualiser can also be controlled remotely using the Open Sound
34 Control (OSC) protocol (if support is compiled in).
35
36
37 Credits
38 -------
39
40 Sonic Visualiser was developed at the Centre for Digital Music,
41 Queen Mary, University of London.
42
43 http://c4dm.eecs.qmul.ac.uk/
44
45 Sonic Visualiser was written by Chris Cannam with contributions from
46 Christian Landone, Mathieu Barthet, Dan Stowell, Jesus Corral Garcia,
47 Matthias Mauch, and Craig Sapp.
48
49 Code copyright 2005-2007 Chris Cannam and copyright 2006-2017 Queen
50 Mary, University of London, except where indicated in the individual
51 source files.
52
53 Russian translation provided by Alexandre Prokoudine, copyright
54 2006-2017 Alexandre Prokoudine.
55
56 Czech translation provided by Pavel Fric, copyright 2010-2017 Pavel
57 Fric.
58
59 This work was partially funded by the European Commission through the
60 SIMAC project IST-FP6-507142 and the EASAIER project IST-FP6-033902.
61
62 This work was partially funded by the Arts and Humanities Research
63 Council through its Research Centre for the History and Analysis of
64 Recorded Music (CHARM).
65
66 This work was partially funded by the Engineering and Physical
67 Sciences Research Council through the OMRAS2 project EP/E017614/1, the
68 Musicology for the Masses project EP/I001832/1, and the Sound Software
69 project EP/H043101/1.
70
71 Sonic Visualiser is free software; you can redistribute it and/or modify
72 it under the terms of the GNU General Public License as published by
73 the Free Software Foundation; either version 2 of the License, or (at
74 your option) any later version. See the file COPYING included with
75 this distribution for more information.
76
77 Sonic Visualiser may also make use of the following libraries:
78
79 * Qt5 -- Copyright The Qt Company, distributed under the LGPL
80 * JACK -- Copyright Paul Davis, Jack O'Quin et al, under the LGPL
81 * PortAudio -- Copyright Ross Bencina, Phil Burk et al, BSD license
82 * Ogg decoder -- Copyright CSIRO Australia, BSD license
83 * MAD mp3 decoder -- Copyright Underbit Technologies Inc, GPL
84 * libsamplerate -- Copyright Erik de Castro Lopo, BSD license
85 * libsndfile -- Copyright Erik de Castro Lopo, LGPL
86 * FFTW3 -- Copyright Matteo Frigo and MIT, GPL
87 * Rubber Band -- Copyright Particular Programs Ltd, GPL
88 * Vamp plugin SDK -- Copyright Chris Cannam and QMUL, BSD license
89 * LADSPA plugin SDK -- Copyright Richard Furse et al, LGPL
90 * RtMIDI -- Copyright Gary P. Scavone, BSD license
91 * Dataquay -- Copyright Particular Programs Ltd, BSD license
92 * Sord and Serd -- Copyright David Robillard, BSD license
93 * Redland -- Copyright Dave Beckett and the University of Bristol, LGPL/Apache license
94 * liblo OSC library -- Copyright Steve Harris, GPL
95 * Cap'n Proto -- Copyright Sandstorm Development Group, Inc, BSD license
96
97 (Some distributions of Sonic Visualiser may have one or more of these
98 libraries statically linked.) Many thanks to their authors.
99
100
101 Compiling Sonic Visualiser
102 --------------------------
103
104 If you are planning to compile Sonic Visualiser from source code,
105 please read the file INSTALL.txt.
106
107 | Linux and macOS CI Build Status | [![Build Status](https://travis-ci.org/sonic-visualiser/sonic-visualiser.svg?branch=master)](https://travis-ci.org/sonic-visualiser/sonic-visualiser) |
108 | Windows CI Build Status | [![Build status](https://ci.appveyor.com/api/projects/status/26pygienkigw39p7?svg=true)](https://ci.appveyor.com/project/cannam/sonic-visualiser) |
109
110
111 More information
112 ----------------
113
114 For more information about Sonic Visualiser, please go to
115
116 http://www.sonicvisualiser.org/
117