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 Chris Cannam.
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_ADAPTER_H_
Chris@23: #define _VAMP_PLUGIN_ADAPTER_H_
Chris@23: 
Chris@23: #include <map>
Chris@23: #include <vamp/vamp.h>
Chris@23: 
Chris@23: #include "Plugin.h"
Chris@23: 
Chris@23: #include "plugguard.h"
Chris@23: _VAMP_SDK_PLUGSPACE_BEGIN(PluginAdapter.h)
Chris@23: 
Chris@23: namespace Vamp {
Chris@23: 
Chris@23: /**
Chris@23:  * \class PluginAdapterBase PluginAdapter.h <vamp-sdk/PluginAdapter.h>
Chris@23:  * 
Chris@23:  * PluginAdapter and PluginAdapterBase provide a wrapper class that a
Chris@23:  * plugin library can use to make its C++ Vamp::Plugin objects
Chris@23:  * available through the Vamp C API.
Chris@23:  * 
Chris@23:  * Almost all Vamp plugin libraries will want to make use of this.  To
Chris@23:  * do so, all they need to do is declare a PluginAdapter<T> for each
Chris@23:  * plugin class T in their library.  It's very simple, and you need to
Chris@23:  * know absolutely nothing about how it works in order to use it.
Chris@23:  * Just cut and paste from an existing plugin's discovery function.
Chris@23:  * \see vampGetPluginDescriptor
Chris@23:  */
Chris@23: 
Chris@23: class PluginAdapterBase
Chris@23: {
Chris@23: public:
Chris@23:     virtual ~PluginAdapterBase();
Chris@23: 
Chris@23:     /**
Chris@23:      * Return a VampPluginDescriptor describing the plugin that is
Chris@23:      * wrapped by this adapter.
Chris@23:      */
Chris@23:     const VampPluginDescriptor *getDescriptor();
Chris@23: 
Chris@23: protected:
Chris@23:     PluginAdapterBase();
Chris@23: 
Chris@23:     virtual Plugin *createPlugin(float inputSampleRate) = 0;
Chris@23: 
Chris@23:     class Impl;
Chris@23:     Impl *m_impl;
Chris@23: };
Chris@23: 
Chris@23: /**
Chris@23:  * \class PluginAdapter PluginAdapter.h <vamp-sdk/PluginAdapter.h>
Chris@23:  * 
Chris@23:  * PluginAdapter turns a PluginAdapterBase into a specific wrapper for
Chris@23:  * a particular plugin implementation.
Chris@23:  *
Chris@23:  * See PluginAdapterBase.
Chris@23:  */
Chris@23: 
Chris@23: template <typename P>
Chris@23: class PluginAdapter : public PluginAdapterBase
Chris@23: {
Chris@23: public:
Chris@23:     PluginAdapter() : PluginAdapterBase() { }
Chris@23:     virtual ~PluginAdapter() { }
Chris@23: 
Chris@23: protected:
Chris@23:     Plugin *createPlugin(float inputSampleRate) {
Chris@23:         P *p = new P(inputSampleRate);
Chris@23:         Plugin *plugin = dynamic_cast<Plugin *>(p);
Chris@23:         if (!plugin) {
Chris@23:             std::cerr << "ERROR: PluginAdapter::createPlugin: "
Chris@23:                       << "Template type is not a plugin!"
Chris@23:                       << std::endl;
Chris@23:             delete p;
Chris@23:             return 0;
Chris@23:         }
Chris@23:         return plugin;
Chris@23:     }
Chris@23: };
Chris@23:     
Chris@23: }
Chris@23: 
Chris@23: _VAMP_SDK_PLUGSPACE_END(PluginAdapter.h)
Chris@23: 
Chris@23: #endif
Chris@23: