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