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