plugins/{MelEnergy,Mfcc,SpecDesc}.{cpp,h}: change package name to vamp-aubio-plugins
[vamp-aubio-plugins.git] / README
1
2 vamp-aubio-plugins
3 ==================
4
5 A set of Vamp plugins (http://www.sonicvisualiser.org/vamp.html) for audio
6 feature extraction using the aubio library (http://aubio.org/).
7
8 This set includes five plugins: Onset for onset detection, Pitch for
9 pitch tracking, Notes for combined onset and pitch, Tempo to estimate
10 and track beats based on onset locations, and Silence to find sections
11 of audio that are quieter than a given RMS signal level.  These
12 plugins compile into a single plugin library called vamp-aubio.so (the
13 file extension may vary depending on your platform).
14
15 To build: Make sure you have the Vamp plugin SDK and aubio
16 installed. (A version of aubio dating from at least July 2012 is
17 required.) These are available at the URLs given at the top.  Edit the
18 Makefile appropriately, and type "make".  If the build succeeds, copy
19 the vamp-aubio library file into your personal or system Vamp plugin
20 location.
21
22 These plugins are Copyright 2007-2012 Chris Cannam, distributed under the
23 GNU General Public License.  (Of course, the real work is done by the
24 aubio library.)
25