14bb7f4824f3271f0c2b662633ef27ae176c4f00
[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
6 audio feature extraction using Paul Brossier's aubio (http://aubio.piem.org/).
7
8 This set includes four plugins: Onset for onset detection, Pitch for
9 pitch tracking, Notes for combined onset and pitch, and Tempo to
10 estimate and track beats based on onset locations.  These plugins
11 compile into a single plugin library called vamp-aubio.so (the file
12 extension may vary depending on your platform).
13
14 To build: Make sure you have aubio-0.3.0 or newer installed, and the
15 Vamp plugin SDK.  These are available at the URLs given at the top.
16 Edit the Makefile appropriately, and type "make".  If the build
17 succeeds, copy the vamp-aubio library file into your personal or
18 system Vamp plugin location.
19
20 These plugins are Copyright 2007 Chris Cannam, distributed under the
21 GNU General Public License.  (Of course, the real work is done by the
22 aubio library.)
23