Mercurial > hg > vamp-plugin-sdk
comparison README @ 42:1eb2419fc326
* fix to step size for frequency domain plugins
* textual updates
| author | cannam | 
|---|---|
| date | Mon, 30 Oct 2006 10:20:21 +0000 | 
| parents | ae3e47e76d2d | 
| children | ce61ad9b9159 | 
   comparison
  equal
  deleted
  inserted
  replaced
| 41:31cd55174467 | 42:1eb2419fc326 | 
|---|---|
| 124 advanced users may also choose to set up their own preferred category | 124 advanced users may also choose to set up their own preferred category | 
| 125 trees, which is why this information is not queried as part of the | 125 trees, which is why this information is not queried as part of the | 
| 126 Vamp API itself. | 126 Vamp API itself. | 
| 127 | 127 | 
| 128 | 128 | 
| 129 Building the SDK | 129 Building and Installing the SDK and Examples | 
| 130 ================ | 130 ============================================ | 
| 131 | 131 | 
| 132 Edit the Makefile to suit your platform according to the comments in | 132 To build the SDK, the simple host, and the example plugins, edit the | 
| 133 it. Type "make". | 133 Makefile to suit your platform according to the comments in it, then | 
| 134 run "make". | |
| 135 | |
| 136 Installing the example plugins so that they can be found by other Vamp | |
| 137 hosts depends on your platform: | |
| 138 | |
| 139 * Windows: copy examples/vamp-example-plugins.dll and | |
| 140 examples/vamp-example-plugins.cat to C:\Program Files\Vamp Plugins | |
| 141 | |
| 142 * Linux: copy examples/vamp-example-plugins.so and | |
| 143 examples/vamp-example-plugins.cat to /usr/local/lib/vamp/ | |
| 144 | |
| 145 * OS/X: copy examples/vamp-example-plugins.dylib and | |
| 146 examples/vamp-example-plugins.cat to /Library/Audio/Plug-Ins/Vamp | |
| 147 | |
| 148 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 | |
| 150 your plugin or host, we suggest statically linking the SDK code in | |
| 151 preference to distributing it alongside your plugin or host in DLL | |
| 152 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 | |
| 154 vamp-sdk directory to your project. | |
| 134 | 155 | 
| 135 | 156 | 
| 136 Licensing | 157 Licensing | 
| 137 ========= | 158 ========= | 
| 138 | 159 | 
| 139 This plugin SDK is freely redistributable under a "new-style BSD" | 160 This plugin SDK is freely redistributable under a "new-style BSD" | 
| 140 licence. See the file COPYING for more details. In short, you are | 161 licence. See the file COPYING for more details. In short, you may | 
| 141 permitted to reuse the SDK and example plugins in any commercial or | 162 modify and redistribute the SDK and example plugins within any | 
| 142 non-commercial, proprietary or open-source application or plugin under | 163 commercial or non-commercial, proprietary or open-source plugin or | 
| 143 almost any conditions provided you retain the original copyright note. | 164 application under almost any conditions, with no obligation to provide | 
| 165 source code, provided you retain the original copyright note. | |
| 144 | 166 | 
| 145 | 167 | 
| 146 See Also | 168 See Also | 
| 147 ======== | 169 ======== | 
| 148 | 170 | 
