piem@113: vamp-aubio-plugins
piem@113: ==================
piem@113: 
piem@113: A set of [Vamp plugins](http://vamp-plugins.org/) for audio feature extraction
piem@113: using the [aubio library](http://aubio.org/).
piem@113: 
piem@113: This set includes the following plugins:
piem@113: 
piem@113:  - Spectral Descriptors
piem@113: 
piem@113:   - Aubio Beat Tracker
piem@113:     - *Time → Tempo*
piem@113:     - Estimate the musical tempo and track beat positions.
piem@113:   - Aubio Mel-frequency Band Energy Detector
piem@113:     - *Low Level Features*
piem@113:     - Computes Energy in each Mel-Frequency Bands.
piem@113:   - Aubio Mfcc Detector
piem@113:     - *Low Level Features*
piem@113:     - Computes Mel-Frequency Cepstrum Coefficients.
piem@113:   - Aubio Note Tracker
piem@113:     - *Notes*
piem@113:     - Estimate note onset positions, pitches and durations.
piem@113:   - Aubio Onset Detector
piem@113:     - *Time → Onsets*
piem@113:     - Estimate note onset times.
piem@113:   - Aubio Pitch Detector
piem@113:     - *Pitch*
piem@113:     - Track estimated note pitches.
piem@113:   - Aubio Silence Detector
piem@113:     - *Low Level Features*
piem@113:     - Detect levels below a certain threshold.
piem@113:   - Aubio Spectral Descriptor
piem@113:     - *Low Level Features*
piem@113:     - Computes spectral descriptor.
piem@113: 
piem@113: Build Instructions
piem@113: ------------------
piem@113: 
piem@113: Please refer to the detailed instructions to build vamp-aubio-plugins for your
piem@113: platform in the following files:
piem@113: 
piem@113:   - `INSTALL.osx` for Mac OS X
piem@113:   - `INSTALL.linux64` for Linux amd64
piem@113:   - `INSTALL.linux32` for Linux i686
piem@113:   - `INSTALL.mingw32` to cross-compile using [Mingw](http://www.mingw.org/)
piem@113: 
piem@113: You can try running the corresponding file directly from the current directory.
piem@113: For instance, on a `Linux x86_64` host:
piem@113: 
piem@113:     $ sh INSTALL.osx
piem@113: 
piem@113: ### Linux
piem@113: 
piem@113: Use Makefile.linux to compile vamp-aubio-plugins:
piem@113: 
piem@113:     $ make -f Makefile.linux clean all
piem@113: 
piem@113: ### Mac OS X
piem@113: 
piem@113: Use Makefile.osx to compile vamp-aubio-plugins:
piem@113: 
piem@113:     $ make -f Makefile.linux clean all
piem@113: 
piem@113: ### Windows
piem@113: 
piem@113: Use Makefile.mingw32 to compile vamp-aubio-plugins:
piem@113: 
piem@113:     $ make -f Makefile.mingw32 clean all
piem@113: 
piem@113: Installation Instructions
piem@113: -------------------------
piem@113: 
piem@113: The Vamp plugin is defined by the following three files. Depending on your
piem@113: platform, the extension of the binary file will vary.
piem@113: 
piem@113:     vamp-aubio.cat
piem@113:     vamp-aubio.n3
piem@113:     vamp-aubio.{so,dll,dylib}
piem@113: 
piem@113: Follow the [Vamp installation
piem@113: instructions](http://vamp-plugins.org/download.html#install) to copy the
piem@113: above three files to your preferred plugin directory.
piem@113: 
piem@113: Copyright and License Information
piem@113: ---------------------------------
piem@113: 
piem@113:     Copyright (C) 2006-2012 Chris Cannam and Queen Mary University of London
piem@113:     Copyright (C) 2006-2015 Paul Brossier <piem@aubio.org>
piem@113: 
piem@113: vamp-aubio-plugins is free software: you can redistribute it and/or modify it
piem@113: under the terms of the GNU General Public License as published by the Free
piem@113: Software Foundation, either version 3 of the License, or (at your option) any
piem@113: later version.