Mercurial > hg > vamp-aubio-plugins

annotate README.md @ 113:3aee7fc5c39c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README.md: rewrite readme
author Paul Brossier <piem@piem.org>
date Sat, 31 Jan 2015 17:35:07 +0100
parents
children f1cda26b578c
rev   line source
piem@113 1 vamp-aubio-plugins
piem@113 2 ==================
piem@113 3
piem@113 4 A set of [Vamp plugins](http://vamp-plugins.org/) for audio feature extraction
piem@113 5 using the [aubio library](http://aubio.org/).
piem@113 6
piem@113 7 This set includes the following plugins:
piem@113 8
piem@113 9 - Spectral Descriptors
piem@113 10
piem@113 11 - Aubio Beat Tracker
piem@113 12 - *Time → Tempo*
piem@113 13 - Estimate the musical tempo and track beat positions.
piem@113 14 - Aubio Mel-frequency Band Energy Detector
piem@113 15 - *Low Level Features*
piem@113 16 - Computes Energy in each Mel-Frequency Bands.
piem@113 17 - Aubio Mfcc Detector
piem@113 18 - *Low Level Features*
piem@113 19 - Computes Mel-Frequency Cepstrum Coefficients.
piem@113 20 - Aubio Note Tracker
piem@113 21 - *Notes*
piem@113 22 - Estimate note onset positions, pitches and durations.
piem@113 23 - Aubio Onset Detector
piem@113 24 - *Time → Onsets*
piem@113 25 - Estimate note onset times.
piem@113 26 - Aubio Pitch Detector
piem@113 27 - *Pitch*
piem@113 28 - Track estimated note pitches.
piem@113 29 - Aubio Silence Detector
piem@113 30 - *Low Level Features*
piem@113 31 - Detect levels below a certain threshold.
piem@113 32 - Aubio Spectral Descriptor
piem@113 33 - *Low Level Features*
piem@113 34 - Computes spectral descriptor.
piem@113 35
piem@113 36 Build Instructions
piem@113 37 ------------------
piem@113 38
piem@113 39 Please refer to the detailed instructions to build vamp-aubio-plugins for your
piem@113 40 platform in the following files:
piem@113 41
piem@113 42 - `INSTALL.osx` for Mac OS X
piem@113 43 - `INSTALL.linux64` for Linux amd64
piem@113 44 - `INSTALL.linux32` for Linux i686
piem@113 45 - `INSTALL.mingw32` to cross-compile using [Mingw](http://www.mingw.org/)
piem@113 46
piem@113 47 You can try running the corresponding file directly from the current directory.
piem@113 48 For instance, on a `Linux x86_64` host:
piem@113 49
piem@113 50 $ sh INSTALL.osx
piem@113 51
piem@113 52 ### Linux
piem@113 53
piem@113 54 Use Makefile.linux to compile vamp-aubio-plugins:
piem@113 55
piem@113 56 $ make -f Makefile.linux clean all
piem@113 57
piem@113 58 ### Mac OS X
piem@113 59
piem@113 60 Use Makefile.osx to compile vamp-aubio-plugins:
piem@113 61
piem@113 62 $ make -f Makefile.linux clean all
piem@113 63
piem@113 64 ### Windows
piem@113 65
piem@113 66 Use Makefile.mingw32 to compile vamp-aubio-plugins:
piem@113 67
piem@113 68 $ make -f Makefile.mingw32 clean all
piem@113 69
piem@113 70 Installation Instructions
piem@113 71 -------------------------
piem@113 72
piem@113 73 The Vamp plugin is defined by the following three files. Depending on your
piem@113 74 platform, the extension of the binary file will vary.
piem@113 75
piem@113 76 vamp-aubio.cat
piem@113 77 vamp-aubio.n3
piem@113 78 vamp-aubio.{so,dll,dylib}
piem@113 79
piem@113 80 Follow the [Vamp installation
piem@113 81 instructions](http://vamp-plugins.org/download.html#install) to copy the
piem@113 82 above three files to your preferred plugin directory.
piem@113 83
piem@113 84 Copyright and License Information
piem@113 85 ---------------------------------
piem@113 86
piem@113 87 Copyright (C) 2006-2012 Chris Cannam and Queen Mary University of London
piem@113 88 Copyright (C) 2006-2015 Paul Brossier <piem@aubio.org>
piem@113 89
piem@113 90 vamp-aubio-plugins is free software: you can redistribute it and/or modify it
piem@113 91 under the terms of the GNU General Public License as published by the Free
piem@113 92 Software Foundation, either version 3 of the License, or (at your option) any
piem@113 93 later version.