Mercurial > hg > vamp-plugin-sdk
diff README @ 64:9d3272c7db60
* Merge from host-factory-stuff branch: this adds several helper classes in
the hostext directory that should make a host's life much easier. This
will become version 1.1 of the SDK, eventually.
author | cannam |
---|---|
date | Fri, 01 Jun 2007 15:10:17 +0000 |
parents | 2403ae53b8a5 |
children | 0f8524203677 |
line wrap: on
line diff
--- a/README Fri Mar 30 17:14:16 2007 +0000 +++ b/README Fri Jun 01 15:10:17 2007 +0000 @@ -77,6 +77,28 @@ plugin's C API back into a Vamp::Plugin object. Hosts should link with -lvamp-hostsdk. + * vamp-sdk/hostext + +Additional C++ classes to make a host's life easier. + +Vamp::HostExt::PluginLoader provides a very simple interface for a +host to discover, load, and find out category information about the +available plugins. Most "casual" Vamp hosts will probably want to use +this class. + +Vamp::HostExt::PluginInputDomainAdapter provides a simple means for +hosts to handle plugins that expect frequency-domain input, without +having to convert the input themselves. + +Vamp::HostExt::PluginChannelAdapter provides a simple means for hosts +to use plugins that do not necessarily support the same number of +audio channels as they have available, without having to apply a +channel management / mixdown policy themselves. + +The PluginLoader can use the input domain and channel adapters +automatically to make the entire conversion process transparent to the +host if required. + * examples Example plugins implemented using the C++ classes. ZeroCrossing @@ -92,7 +114,11 @@ A simple command-line Vamp host, capable of loading a plugin and using it to process a complete audio file, with its default parameters. -Requires libsndfile. +Requires libsndfile (http://www.mega-nerd.com/libsndfile/). + +If you don't have libsndfile, you may want to edit the Makefile to +change the default build target from "all" to "sdk" so as to compile +only the SDK. Plugin Lookup and Categorisation @@ -186,11 +212,14 @@ ======= Vamp and the Vamp SDK were designed and made at the Centre for Digital -Music at Queen Mary, University of London. The SDK code was written -by Chris Cannam, copyright (c) 2005-2006 Chris Cannam. Mark Sandler -and Christian Landone provided ideas and direction, and Mark Levy, Dan -Stowell, Martin Gasser and Craig Sapp provided testing and other input -for the 1.0 API and SDK. The API reuses some ideas from several prior -plugin systems, notably DSSI (http://dssi.sourceforge.net) and FEAPI -(http://feapi.sourceforge.net). +Music at Queen Mary, University of London. +The SDK was written by Chris Cannam, copyright (c) 2005-2007 +Chris Cannam and QMUL. + +Mark Sandler and Christian Landone provided ideas and direction, and +Mark Levy, Dan Stowell, Martin Gasser and Craig Sapp provided testing +and other input for the 1.0 API and SDK. The API also uses some ideas +from prior plugin systems, notably DSSI (http://dssi.sourceforge.net) +and FEAPI (http://feapi.sourceforge.net). +