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