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