Mercurial > hg > vamp-plugin-sdk
comparison README @ 44:ce61ad9b9159 1.0
...
author | cannam |
---|---|
date | Wed, 01 Nov 2006 17:48:21 +0000 |
parents | 1eb2419fc326 |
children | 2403ae53b8a5 |
comparison
equal
deleted
inserted
replaced
43:3bbe244611bb | 44:ce61ad9b9159 |
---|---|
1 | 1 |
2 Vamp | 2 Vamp |
3 ==== | 3 ==== |
4 http://www.sonicvisualiser.org/vamp.html | |
5 | 4 |
6 An API for audio analysis and feature extraction plugins. | 5 An API for audio analysis and feature extraction plugins. |
6 | |
7 http://www.vamp-plugins.org/ | |
7 | 8 |
8 Vamp is an API for C and C++ plugins that process sampled audio data | 9 Vamp is an API for C and C++ plugins that process sampled audio data |
9 to produce descriptive output (measurements or semantic observations). | 10 to produce descriptive output (measurements or semantic observations). |
10 | 11 |
11 The principal differences between Vamp and a real-time audio | 12 The principal differences between Vamp and a real-time audio |
41 time. This also means that fundamental properties such as the | 42 time. This also means that fundamental properties such as the |
42 number of values per output or the preferred processing block | 43 number of values per output or the preferred processing block |
43 size may depend on the input parameters. | 44 size may depend on the input parameters. |
44 | 45 |
45 * Vamp plugins do not have to be able to run in real time. | 46 * Vamp plugins do not have to be able to run in real time. |
46 | |
47 Vamp reuses some ideas from several existing systems, notably DSSI | |
48 (http://dssi.sourceforge.net) and FEAPI (http://feapi.sourceforge.net). | |
49 | 47 |
50 | 48 |
51 About this SDK | 49 About this SDK |
52 ============== | 50 ============== |
53 | 51 |
134 run "make". | 132 run "make". |
135 | 133 |
136 Installing the example plugins so that they can be found by other Vamp | 134 Installing the example plugins so that they can be found by other Vamp |
137 hosts depends on your platform: | 135 hosts depends on your platform: |
138 | 136 |
139 * Windows: copy examples/vamp-example-plugins.dll and | 137 * Windows: copy the files |
140 examples/vamp-example-plugins.cat to C:\Program Files\Vamp Plugins | 138 examples/vamp-example-plugins.dll |
139 examples/vamp-example-plugins.cat | |
140 to | |
141 C:\Program Files\Vamp Plugins | |
141 | 142 |
142 * Linux: copy examples/vamp-example-plugins.so and | 143 * Linux: copy the files |
143 examples/vamp-example-plugins.cat to /usr/local/lib/vamp/ | 144 examples/vamp-example-plugins.so |
145 examples/vamp-example-plugins.cat | |
146 to | |
147 /usr/local/lib/vamp/ | |
144 | 148 |
145 * OS/X: copy examples/vamp-example-plugins.dylib and | 149 * OS/X: copy the files |
146 examples/vamp-example-plugins.cat to /Library/Audio/Plug-Ins/Vamp | 150 examples/vamp-example-plugins.dylib |
151 examples/vamp-example-plugins.cat | |
152 to | |
153 /Library/Audio/Plug-Ins/Vamp | |
147 | 154 |
148 When building a plugin or host of your own using the SDK, you will | 155 When building a plugin or host of your own using the SDK, you will |
149 need to include the headers from the vamp-sdk directory. When linking | 156 need to include the headers from the vamp-sdk directory; then when |
150 your plugin or host, we suggest statically linking the SDK code in | 157 linking your plugin or host, we suggest statically linking the SDK |
151 preference to distributing it alongside your plugin or host in DLL | 158 code (in preference to distributing it alongside your program in DLL |
152 form. An easy way to do this, if using a project-based build tool | 159 form). An easy way to do this, if using a project-based build tool |
153 such as Visual Studio or XCode, is simply to add the .cpp files in the | 160 such as Visual Studio or XCode, is simply to add the .cpp files in the |
154 vamp-sdk directory to your project. | 161 vamp-sdk directory to your project. |
155 | 162 |
156 | 163 |
157 Licensing | 164 Licensing |
171 Sonic Visualiser, an interactive open-source graphical audio | 178 Sonic Visualiser, an interactive open-source graphical audio |
172 inspection, analysis and visualisation tool supporting Vamp plugins. | 179 inspection, analysis and visualisation tool supporting Vamp plugins. |
173 http://www.sonicvisualiser.org/ | 180 http://www.sonicvisualiser.org/ |
174 | 181 |
175 | 182 |
176 Chris Cannam | 183 Authors |
177 Centre for Digital Music | 184 ======= |
178 Queen Mary, University of London | 185 |
186 Vamp and the Vamp SDK were designed and made at the Centre for Digital | |
187 Music at Queen Mary, University of London. The SDK code was written | |
188 by Chris Cannam, copyright (c) 2005-2006 Chris Cannam. Mark Sandler | |
189 and Christian Landone provided ideas and direction, and Mark Levy, Dan | |
190 Stowell, Martin Gasser and Craig Sapp provided testing and other input | |
191 for the 1.0 API and SDK. The API reuses some ideas from several prior | |
192 plugin systems, notably DSSI (http://dssi.sourceforge.net) and FEAPI | |
193 (http://feapi.sourceforge.net). | |
194 |