cannam@233: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ cannam@233: cannam@233: /* cannam@233: Vamp cannam@233: cannam@233: An API for audio analysis and feature extraction plugins. cannam@233: cannam@233: Centre for Digital Music, Queen Mary, University of London. cannam@290: Copyright 2006-2009 Chris Cannam and QMUL. cannam@233: cannam@233: Permission is hereby granted, free of charge, to any person cannam@233: obtaining a copy of this software and associated documentation cannam@233: files (the "Software"), to deal in the Software without cannam@233: restriction, including without limitation the rights to use, copy, cannam@233: modify, merge, publish, distribute, sublicense, and/or sell copies cannam@233: of the Software, and to permit persons to whom the Software is cannam@233: furnished to do so, subject to the following conditions: cannam@233: cannam@233: The above copyright notice and this permission notice shall be cannam@233: included in all copies or substantial portions of the Software. cannam@233: cannam@233: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@233: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@233: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND cannam@233: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR cannam@233: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@233: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@233: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@233: cannam@233: Except as contained in this notice, the names of the Centre for cannam@233: Digital Music; Queen Mary, University of London; and Chris Cannam cannam@233: shall not be used in advertising or otherwise to promote the sale, cannam@233: use or other dealings in this Software without prior written cannam@233: authorization. cannam@233: */ cannam@233: cannam@233: #ifndef _VAMP_PLUGIN_WRAPPER_H_ cannam@233: #define _VAMP_PLUGIN_WRAPPER_H_ cannam@233: cannam@243: #include "hostguard.h" cannam@233: #include cannam@233: cannam@263: _VAMP_SDK_HOSTSPACE_BEGIN(PluginWrapper.h) cannam@263: cannam@233: namespace Vamp { cannam@233: cannam@233: namespace HostExt { cannam@233: cannam@233: /** cannam@233: * \class PluginWrapper PluginWrapper.h cannam@233: * cannam@233: * PluginWrapper is a simple base class for adapter plugins. It takes cannam@233: * a pointer to a "to be wrapped" Vamp plugin on construction, and cannam@233: * provides implementations of all the Vamp plugin methods that simply cannam@233: * delegate through to the wrapped plugin. A subclass can therefore cannam@233: * override only the methods that are meaningful for the particular cannam@233: * adapter. cannam@233: * Chris@538: * A PluginWrapper takes ownership of the plugin it wraps, and deletes Chris@538: * it when it is itself deleted. To prevent this, call disownPlugin(). Chris@538: * cannam@233: * \note This class was introduced in version 1.1 of the Vamp plugin SDK. cannam@233: */ cannam@233: cannam@233: class PluginWrapper : public Plugin cannam@233: { cannam@233: public: cannam@233: virtual ~PluginWrapper(); cannam@233: cannam@233: bool initialise(size_t channels, size_t stepSize, size_t blockSize); cannam@233: void reset(); cannam@233: cannam@233: InputDomain getInputDomain() const; cannam@233: cannam@233: unsigned int getVampApiVersion() const; cannam@233: std::string getIdentifier() const; cannam@233: std::string getName() const; cannam@233: std::string getDescription() const; cannam@233: std::string getMaker() const; cannam@233: int getPluginVersion() const; cannam@233: std::string getCopyright() const; cannam@233: cannam@233: ParameterList getParameterDescriptors() const; cannam@233: float getParameter(std::string) const; cannam@233: void setParameter(std::string, float); cannam@233: cannam@233: ProgramList getPrograms() const; cannam@233: std::string getCurrentProgram() const; cannam@233: void selectProgram(std::string); cannam@233: cannam@233: size_t getPreferredStepSize() const; cannam@233: size_t getPreferredBlockSize() const; cannam@233: cannam@233: size_t getMinChannelCount() const; cannam@233: size_t getMaxChannelCount() const; cannam@233: cannam@233: OutputList getOutputDescriptors() const; cannam@233: cannam@233: FeatureSet process(const float *const *inputBuffers, RealTime timestamp); cannam@233: cannam@233: FeatureSet getRemainingFeatures(); cannam@233: cannam@233: /** cannam@233: * Return a pointer to the plugin wrapper of type WrapperType cannam@233: * surrounding this wrapper's plugin, if present. cannam@233: * cannam@233: * This is useful in situations where a plugin is wrapped by cannam@233: * multiple different wrappers (one inside another) and the host cannam@233: * wants to call some wrapper-specific function on one of the cannam@233: * layers without having to care about the order in which they are cannam@233: * wrapped. For example, the plugin returned by cannam@233: * PluginLoader::loadPlugin may have more than one wrapper; if the cannam@233: * host wanted to query or fine-tune some property of one of them, cannam@233: * it would be hard to do so without knowing the order of the cannam@233: * wrappers. This function therefore gives direct access to the cannam@233: * wrapper of a particular type. cannam@233: */ cannam@233: template cannam@233: WrapperType *getWrapper() { cannam@233: WrapperType *w = dynamic_cast(this); cannam@233: if (w) return w; cannam@233: PluginWrapper *pw = dynamic_cast(m_plugin); cannam@233: if (pw) return pw->getWrapper(); cannam@233: return 0; cannam@233: } cannam@233: Chris@538: /** Chris@538: * Disown the wrapped plugin, so that we no longer delete it on Chris@538: * our own destruction. The identity of the wrapped plugin is Chris@538: * unchanged, but this switches the expectation about ownership so Chris@538: * that the caller is expected to handle the lifecycle of the Chris@538: * wrapped plugin and to ensure that it outlasts this wrapper. Chris@538: * Chris@538: * This is not the normal model, but could be useful in situations Chris@538: * where a plugin is already managed using a smart pointer model Chris@538: * before being adapted into this wrapper. Note that this can't be Chris@538: * reversed - if you call this, you must subsequently take charge Chris@538: * of the wrapped plugin yourself. Chris@538: */ Chris@538: void disownPlugin(); Chris@538: cannam@233: protected: cannam@233: PluginWrapper(Plugin *plugin); // I take ownership of plugin cannam@233: Plugin *m_plugin; Chris@538: bool m_pluginIsOwned; cannam@233: }; cannam@233: cannam@233: } cannam@233: cannam@233: } cannam@233: cannam@263: _VAMP_SDK_HOSTSPACE_END(PluginWrapper.h) cannam@263: cannam@233: #endif