cannam@64: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@64: 
cannam@64: /*
cannam@64:     Vamp
cannam@64: 
cannam@64:     An API for audio analysis and feature extraction plugins.
cannam@64: 
cannam@64:     Centre for Digital Music, Queen Mary, University of London.
cannam@64:     Copyright 2006 Chris Cannam.
cannam@64:   
cannam@64:     Permission is hereby granted, free of charge, to any person
cannam@64:     obtaining a copy of this software and associated documentation
cannam@64:     files (the "Software"), to deal in the Software without
cannam@64:     restriction, including without limitation the rights to use, copy,
cannam@64:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@64:     of the Software, and to permit persons to whom the Software is
cannam@64:     furnished to do so, subject to the following conditions:
cannam@64: 
cannam@64:     The above copyright notice and this permission notice shall be
cannam@64:     included in all copies or substantial portions of the Software.
cannam@64: 
cannam@64:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@64:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@64:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@64:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@64:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@64:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@64:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@64: 
cannam@64:     Except as contained in this notice, the names of the Centre for
cannam@64:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@64:     shall not be used in advertising or otherwise to promote the sale,
cannam@64:     use or other dealings in this Software without prior written
cannam@64:     authorization.
cannam@64: */
cannam@64: 
cannam@64: #ifndef _VAMP_PLUGIN_WRAPPER_H_
cannam@64: #define _VAMP_PLUGIN_WRAPPER_H_
cannam@64: 
cannam@64: #include <vamp-sdk/Plugin.h>
cannam@64: 
cannam@64: namespace Vamp {
cannam@64: 
cannam@64: namespace HostExt {
cannam@64: 
cannam@64: /**
cannam@64:  * PluginWrapper is a simple base class for adapter plugins.  It takes
cannam@64:  * a pointer to a "to be wrapped" Vamp plugin on construction, and
cannam@64:  * provides implementations of all the Vamp plugin methods that simply
cannam@64:  * delegate through to the wrapped plugin.  A subclass can therefore
cannam@64:  * override only the methods that are meaningful for the particular
cannam@64:  * adapter.
cannam@64:  */
cannam@64: 
cannam@64: class PluginWrapper : public Plugin
cannam@64: {
cannam@64: public:
cannam@64:     virtual ~PluginWrapper();
cannam@64:     
cannam@64:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@64:     void reset();
cannam@64: 
cannam@64:     InputDomain getInputDomain() const;
cannam@64: 
cannam@64:     unsigned int getVampApiVersion() const;
cannam@64:     std::string getIdentifier() const;
cannam@64:     std::string getName() const;
cannam@64:     std::string getDescription() const;
cannam@64:     std::string getMaker() const;
cannam@64:     int getPluginVersion() const;
cannam@64:     std::string getCopyright() const;
cannam@64: 
cannam@64:     ParameterList getParameterDescriptors() const;
cannam@64:     float getParameter(std::string) const;
cannam@64:     void setParameter(std::string, float);
cannam@64: 
cannam@64:     ProgramList getPrograms() const;
cannam@64:     std::string getCurrentProgram() const;
cannam@64:     void selectProgram(std::string);
cannam@64: 
cannam@64:     size_t getPreferredStepSize() const;
cannam@64:     size_t getPreferredBlockSize() const;
cannam@64: 
cannam@64:     size_t getMinChannelCount() const;
cannam@64:     size_t getMaxChannelCount() const;
cannam@64: 
cannam@64:     OutputList getOutputDescriptors() const;
cannam@64: 
cannam@64:     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@64: 
cannam@64:     FeatureSet getRemainingFeatures();
cannam@64: 
cannam@64: protected:
cannam@64:     PluginWrapper(Plugin *plugin); // I take ownership of plugin
cannam@64:     Plugin *m_plugin;
cannam@64: };
cannam@64: 
cannam@64: }
cannam@64: 
cannam@64: }
cannam@64: 
cannam@64: #endif