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:   - 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@163: You will need to have Python, git, and a C++ compiler.
piem@113: 
piem@163: Please refer to the build script corresponding for your platform for brief
piem@163: instructions on how to build this project:
piem@113: 
piem@163: ## Available OS scripts
piem@113: 
piem@163:   - `./build_linux.sh` for Linux
piem@163:   - `./build_osx.sh` for Mac OS X
piem@163:   - `./build_win32.sh` for Windows (32-bit)
piem@163:   - `./build_ming32.sh` to cross-compile using [Mingw](http://www.mingw.org/)
piem@113: 
piem@163: ## Windows
piem@113: 
piem@163: The preferred compiler on windows is Microsoft Visual 2013. Also you will want
piem@163: to use a shell environment, for instance Git Bash, and have Python installed
piem@163: and found in the PATH.
piem@113: 
piem@163: ### Clean up
piem@113: 
piem@163: Use the following command to start from scratch:
piem@113: 
piem@163:     $ rm -rf contrib/ build/
piem@113: 
piem@163: Old-school makefiles
piem@163: --------------------
piem@113: 
piem@163: This method is now considered **deprecated**.
piem@113: 
piem@163: The current build system is waf. See above, and read `wscript` and `build*.sh`
piem@163: to find out how to use it. Makefiles are kept for the record, but they might be
piem@163: out of date and will eventually disappear.
piem@113: 
piem@163:    $ make -f Makefile.<os_name> clean all
piem@163: 
piem@163: where `os_name` should be replaced by one of `linux`, `mingw32`, or `osx`.
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.