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