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