cannam@112: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ cannam@112: cannam@112: /* cannam@112: Vamp cannam@112: cannam@112: An API for audio analysis and feature extraction plugins. cannam@112: cannam@112: Centre for Digital Music, Queen Mary, University of London. cannam@112: Copyright 2006-2009 Chris Cannam and QMUL. cannam@112: cannam@112: Permission is hereby granted, free of charge, to any person cannam@112: obtaining a copy of this software and associated documentation cannam@112: files (the "Software"), to deal in the Software without cannam@112: restriction, including without limitation the rights to use, copy, cannam@112: modify, merge, publish, distribute, sublicense, and/or sell copies cannam@112: of the Software, and to permit persons to whom the Software is cannam@112: furnished to do so, subject to the following conditions: cannam@112: cannam@112: The above copyright notice and this permission notice shall be cannam@112: included in all copies or substantial portions of the Software. cannam@112: cannam@112: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@112: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@112: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND cannam@112: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR cannam@112: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@112: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@112: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@112: cannam@112: Except as contained in this notice, the names of the Centre for cannam@112: Digital Music; Queen Mary, University of London; and Chris Cannam cannam@112: shall not be used in advertising or otherwise to promote the sale, cannam@112: use or other dealings in this Software without prior written cannam@112: authorization. cannam@112: */ cannam@112: cannam@112: #ifndef _VAMP_PLUGIN_LOADER_H_ cannam@112: #define _VAMP_PLUGIN_LOADER_H_ cannam@112: cannam@112: #include cannam@112: #include cannam@112: #include cannam@112: cannam@112: #include "hostguard.h" cannam@112: #include "PluginWrapper.h" cannam@112: cannam@112: _VAMP_SDK_HOSTSPACE_BEGIN(PluginLoader.h) cannam@112: cannam@112: namespace Vamp { cannam@112: cannam@112: class Plugin; cannam@112: cannam@112: namespace HostExt { cannam@112: cannam@112: /** cannam@112: * \class PluginLoader PluginLoader.h cannam@112: * cannam@112: * Vamp::HostExt::PluginLoader is a convenience class for discovering cannam@112: * and loading Vamp plugins using the typical plugin-path, library cannam@112: * naming, and categorisation conventions described in the Vamp SDK cannam@112: * documentation. This class is intended to greatly simplify the task cannam@112: * of becoming a Vamp plugin host for any C++ application. cannam@112: * cannam@112: * Hosts are not required by the Vamp specification to use the same cannam@112: * plugin search path and naming conventions as implemented by this cannam@112: * class, and are certainly not required to use this actual class. cannam@112: * But we do strongly recommend it. cannam@112: * cannam@112: * \note This class was introduced in version 1.1 of the Vamp plugin SDK. cannam@112: */ cannam@112: cannam@112: class PluginLoader cannam@112: { cannam@112: public: cannam@112: /** cannam@112: * Obtain a pointer to the singleton instance of PluginLoader. cannam@112: * Use this to obtain your loader object. cannam@112: */ cannam@112: static PluginLoader *getInstance(); cannam@112: cannam@112: /** cannam@112: * PluginKey is a string type that is used to identify a plugin cannam@112: * uniquely within the scope of "the current system". It consists cannam@112: * of the lower-cased base name of the plugin library, a colon cannam@112: * separator, and the identifier string for the plugin. It is cannam@112: * only meaningful in the context of a given plugin path (the one cannam@112: * returned by PluginHostAdapter::getPluginPath()). cannam@112: * cannam@112: * Use composePluginKey() to construct a plugin key from a known cannam@112: * plugin library name and identifier. cannam@112: * cannam@112: * Note: the fact that the library component of the key is cannam@112: * lower-cased implies that library names are matched cannam@112: * case-insensitively by the PluginLoader class, regardless of the cannam@112: * case sensitivity of the underlying filesystem. (Plugin cannam@112: * identifiers _are_ case sensitive, however.) Also, it is not cannam@112: * possible to portably extract a working library name from a cannam@112: * plugin key, as the result may fail on case-sensitive cannam@112: * filesystems. Use getLibraryPathForPlugin() instead. cannam@112: */ cannam@112: typedef std::string PluginKey; cannam@112: cannam@112: /** cannam@112: * PluginKeyList is a sequence of plugin keys, such as returned by cannam@112: * listPlugins(). cannam@112: */ cannam@112: typedef std::vector PluginKeyList; cannam@112: cannam@112: /** cannam@112: * PluginCategoryHierarchy is a sequence of general->specific cannam@112: * category names, as may be associated with a single plugin. cannam@112: * This sequence describes the location of a plugin within a cannam@112: * category forest, containing the human-readable names of the cannam@112: * plugin's category tree root, followed by each of the nodes down cannam@112: * to the leaf containing the plugin. cannam@112: * cannam@112: * \see getPluginCategory() cannam@112: */ cannam@112: typedef std::vector PluginCategoryHierarchy; cannam@112: cannam@112: /** cannam@112: * Search for all available Vamp plugins, and return a list of cannam@112: * them in the order in which they were found. cannam@112: */ cannam@112: PluginKeyList listPlugins(); cannam@112: cannam@112: /** cannam@112: * AdapterFlags contains a set of values that may be OR'd together cannam@112: * to indicate in which circumstances PluginLoader should use a cannam@112: * plugin adapter to make a plugin easier to use for a host that cannam@112: * does not want to cater for complex features. cannam@112: * cannam@112: * The available flags are: cannam@112: * cannam@112: * ADAPT_INPUT_DOMAIN - If the plugin expects frequency domain cannam@112: * input, wrap it in a PluginInputDomainAdapter that automatically cannam@112: * converts the plugin to one that expects time-domain input. cannam@112: * This enables a host to accommodate time- and frequency-domain cannam@112: * plugins without needing to do any conversion itself. cannam@112: * cannam@112: * ADAPT_CHANNEL_COUNT - Wrap the plugin in a PluginChannelAdapter cannam@112: * to handle any mismatch between the number of channels of audio cannam@112: * the plugin can handle and the number available in the host. cannam@112: * This enables a host to use plugins that may require the input cannam@112: * to be mixed down to mono, etc., without having to worry about cannam@112: * doing that itself. cannam@112: * cannam@112: * ADAPT_BUFFER_SIZE - Wrap the plugin in a PluginBufferingAdapter cannam@112: * permitting the host to provide audio input using any block cannam@112: * size, with no overlap, regardless of the plugin's preferred cannam@112: * block size (suitable for hosts that read from non-seekable cannam@112: * streaming media, for example). This adapter introduces some cannam@112: * run-time overhead and also changes the semantics of the plugin cannam@112: * slightly (see the PluginBufferingAdapter header documentation cannam@112: * for details). cannam@112: * cannam@112: * ADAPT_ALL_SAFE - Perform all available adaptations that are cannam@112: * meaningful for the plugin and "safe". Currently this means to cannam@112: * ADAPT_INPUT_DOMAIN if the plugin wants FrequencyDomain input; cannam@112: * ADAPT_CHANNEL_COUNT always; and ADAPT_BUFFER_SIZE never. cannam@112: * cannam@112: * ADAPT_ALL - Perform all available adaptations that are cannam@112: * meaningful for the plugin. cannam@112: * cannam@112: * See PluginInputDomainAdapter, PluginChannelAdapter and cannam@112: * PluginBufferingAdapter for more details of the classes that the cannam@112: * loader may use if these flags are set. cannam@112: */ cannam@112: enum AdapterFlags { cannam@112: cannam@112: ADAPT_INPUT_DOMAIN = 0x01, cannam@112: ADAPT_CHANNEL_COUNT = 0x02, cannam@112: ADAPT_BUFFER_SIZE = 0x04, cannam@112: cannam@112: ADAPT_ALL_SAFE = 0x03, cannam@112: cannam@112: ADAPT_ALL = 0xff cannam@112: }; cannam@112: cannam@112: /** cannam@112: * Load a Vamp plugin, given its identifying key. If the plugin cannam@112: * could not be loaded, returns 0. cannam@112: * cannam@112: * The returned plugin should be deleted (using the standard C++ cannam@112: * delete keyword) after use. cannam@112: * cannam@112: * \param adapterFlags a bitwise OR of the values in the AdapterFlags cannam@112: * enumeration, indicating under which circumstances an adapter should be cannam@112: * used to wrap the original plugin. If adapterFlags is 0, no cannam@112: * optional adapters will be used. Otherwise, the returned plugin cannam@112: * may be of an adapter class type which will behave identically cannam@112: * to the original plugin, apart from any particular features cannam@112: * implemented by the adapter itself. cannam@112: * cannam@112: * \see AdapterFlags, PluginInputDomainAdapter, PluginChannelAdapter cannam@112: */ cannam@112: Plugin *loadPlugin(PluginKey key, cannam@112: float inputSampleRate, cannam@112: int adapterFlags = 0); cannam@112: cannam@112: /** cannam@112: * Given a Vamp plugin library name and plugin identifier, return cannam@112: * the corresponding plugin key in a form suitable for passing in to cannam@112: * loadPlugin(). cannam@112: */ cannam@112: PluginKey composePluginKey(std::string libraryName, cannam@112: std::string identifier); cannam@112: cannam@112: /** cannam@112: * Return the category hierarchy for a Vamp plugin, given its cannam@112: * identifying key. cannam@112: * cannam@112: * If the plugin has no category information, return an empty cannam@112: * hierarchy. cannam@112: * cannam@112: * \see PluginCategoryHierarchy cannam@112: */ cannam@112: PluginCategoryHierarchy getPluginCategory(PluginKey plugin); cannam@112: cannam@112: /** cannam@112: * Return the file path of the dynamic library from which the cannam@112: * given plugin will be loaded (if available). cannam@112: */ cannam@112: std::string getLibraryPathForPlugin(PluginKey plugin); cannam@112: cannam@112: protected: cannam@112: PluginLoader(); cannam@112: virtual ~PluginLoader(); cannam@112: cannam@112: class Impl; cannam@112: Impl *m_impl; cannam@112: cannam@112: static PluginLoader *m_instance; cannam@112: }; cannam@112: cannam@112: } cannam@112: cannam@112: } cannam@112: cannam@112: _VAMP_SDK_HOSTSPACE_END(PluginLoader.h) cannam@112: cannam@112: #endif cannam@112: