annotate README.md @ 2202:e1adac799317 bqaudiostream

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