4 A set of [Vamp plugins](http://vamp-plugins.org/) for audio feature extraction
5 using the [aubio library](http://aubio.org/).
7 This set includes the following plugins:
13 - Estimate the musical tempo and track beat positions.
14 - Aubio Mel-frequency Band Energy Detector
15 - *Low Level Features*
16 - Computes Energy in each Mel-Frequency Bands.
18 - *Low Level Features*
19 - Computes Mel-Frequency Cepstrum Coefficients.
22 - Estimate note onset positions, pitches and durations.
23 - Aubio Onset Detector
25 - Estimate note onset times.
26 - Aubio Pitch Detector
28 - Track estimated note pitches.
29 - Aubio Silence Detector
30 - *Low Level Features*
31 - Detect levels below a certain threshold.
32 - Aubio Spectral Descriptor
33 - *Low Level Features*
34 - Computes spectral descriptor.
39 You will need to have Python, git, and a C++ compiler.
41 Please refer to the build script corresponding for your platform for brief
42 instructions on how to build this project:
44 ## Available OS scripts
46 - `./build_linux.sh` for Linux
47 - `./build_osx.sh` for Mac OS X
48 - `./build_win32.sh` for Windows (32-bit)
49 - `./build_ming32.sh` to cross-compile using [Mingw](http://www.mingw.org/)
53 The preferred compiler on windows is Microsoft Visual 2013. Also you will want
54 to use a shell environment, for instance Git Bash, and have Python installed
55 and found in the PATH.
59 Use the following command to start from scratch:
61 $ rm -rf contrib/ build/
66 This method is now considered **deprecated**.
68 The current build system is waf. See above, and read `wscript` and `build*.sh`
69 to find out how to use it. Makefiles are kept for the record, but they might be
70 out of date and will eventually disappear.
72 $ make -f Makefile.<os_name> clean all
74 where `os_name` should be replaced by one of `linux`, `mingw32`, or `osx`.
76 Installation Instructions
77 -------------------------
79 The Vamp plugin is defined by the following three files. Depending on your
80 platform, the extension of the binary file will vary.
84 vamp-aubio.{so,dll,dylib}
86 Follow the [Vamp installation
87 instructions](http://vamp-plugins.org/download.html#install) to copy the
88 above three files to your preferred plugin directory.
90 Copyright and License Information
91 ---------------------------------
93 Copyright (C) 2006-2012 Chris Cannam and Queen Mary University of London
94 Copyright (C) 2006-2015 Paul Brossier <piem@aubio.org>
96 vamp-aubio-plugins is free software: you can redistribute it and/or modify it
97 under the terms of the GNU General Public License as published by the Free
98 Software Foundation, either version 3 of the License, or (at your option) any