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