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