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