cannam@99: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@99: 
cannam@99: /*
cannam@99:     Vamp
cannam@99: 
cannam@99:     An API for audio analysis and feature extraction plugins.
cannam@99: 
cannam@99:     Centre for Digital Music, Queen Mary, University of London.
cannam@99:     Copyright 2006 Chris Cannam.
cannam@99:   
cannam@99:     Permission is hereby granted, free of charge, to any person
cannam@99:     obtaining a copy of this software and associated documentation
cannam@99:     files (the "Software"), to deal in the Software without
cannam@99:     restriction, including without limitation the rights to use, copy,
cannam@99:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@99:     of the Software, and to permit persons to whom the Software is
cannam@99:     furnished to do so, subject to the following conditions:
cannam@99: 
cannam@99:     The above copyright notice and this permission notice shall be
cannam@99:     included in all copies or substantial portions of the Software.
cannam@99: 
cannam@99:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@99:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@99:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@99:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@99:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@99:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@99:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@99: 
cannam@99:     Except as contained in this notice, the names of the Centre for
cannam@99:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@99:     shall not be used in advertising or otherwise to promote the sale,
cannam@99:     use or other dealings in this Software without prior written
cannam@99:     authorization.
cannam@99: */
cannam@99: 
cannam@99: #ifndef _VAMP_PLUGIN_ADAPTER_H_
cannam@99: #define _VAMP_PLUGIN_ADAPTER_H_
cannam@99: 
cannam@99: #include <map>
cannam@99: #include <vamp/vamp.h>
cannam@99: 
cannam@99: #include "Plugin.h"
cannam@99: 
cannam@99: #include "plugguard.h"
cannam@99: _VAMP_SDK_PLUGSPACE_BEGIN(PluginAdapter.h)
cannam@99: 
cannam@99: namespace Vamp {
cannam@99: 
cannam@99: /**
cannam@99:  * \class PluginAdapterBase PluginAdapter.h <vamp-sdk/PluginAdapter.h>
cannam@99:  * 
cannam@99:  * PluginAdapter and PluginAdapterBase provide a wrapper class that a
cannam@99:  * plugin library can use to make its C++ Vamp::Plugin objects
cannam@99:  * available through the Vamp C API.
cannam@99:  * 
cannam@99:  * Almost all Vamp plugin libraries will want to make use of this.  To
cannam@99:  * do so, all they need to do is declare a PluginAdapter<T> for each
cannam@99:  * plugin class T in their library.  It's very simple, and you need to
cannam@99:  * know absolutely nothing about how it works in order to use it.
cannam@99:  * Just cut and paste from an existing plugin's discovery function.
cannam@99:  * \see vampGetPluginDescriptor
cannam@99:  */
cannam@99: 
cannam@99: class PluginAdapterBase
cannam@99: {
cannam@99: public:
cannam@99:     virtual ~PluginAdapterBase();
cannam@99: 
cannam@99:     /**
cannam@99:      * Return a VampPluginDescriptor describing the plugin that is
cannam@99:      * wrapped by this adapter.
cannam@99:      */
cannam@99:     const VampPluginDescriptor *getDescriptor();
cannam@99: 
cannam@99: protected:
cannam@99:     PluginAdapterBase();
cannam@99: 
cannam@99:     virtual Plugin *createPlugin(float inputSampleRate) = 0;
cannam@99: 
cannam@99:     class Impl;
cannam@99:     Impl *m_impl;
cannam@99: };
cannam@99: 
cannam@99: /**
cannam@99:  * \class PluginAdapter PluginAdapter.h <vamp-sdk/PluginAdapter.h>
cannam@99:  * 
cannam@99:  * PluginAdapter turns a PluginAdapterBase into a specific wrapper for
cannam@99:  * a particular plugin implementation.
cannam@99:  *
cannam@99:  * See PluginAdapterBase.
cannam@99:  */
cannam@99: 
cannam@99: template <typename P>
cannam@99: class PluginAdapter : public PluginAdapterBase
cannam@99: {
cannam@99: public:
cannam@99:     PluginAdapter() : PluginAdapterBase() { }
cannam@99:     virtual ~PluginAdapter() { }
cannam@99: 
cannam@99: protected:
cannam@99:     Plugin *createPlugin(float inputSampleRate) {
cannam@99:         P *p = new P(inputSampleRate);
cannam@99:         Plugin *plugin = dynamic_cast<Plugin *>(p);
cannam@99:         if (!plugin) {
cannam@99:             std::cerr << "ERROR: PluginAdapter::createPlugin: "
cannam@99:                       << "Template type is not a plugin!"
cannam@99:                       << std::endl;
cannam@99:             delete p;
cannam@99:             return 0;
cannam@99:         }
cannam@99:         return plugin;
cannam@99:     }
cannam@99: };
cannam@99:     
cannam@99: }
cannam@99: 
cannam@99: _VAMP_SDK_PLUGSPACE_END(PluginAdapter.h)
cannam@99: 
cannam@99: #endif
cannam@99: