libs/vamp-sdk/vamp-sdk/PluginAdapter.h

   1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
   2
   3 /*
   4     Vamp
   5
   6     An API for audio analysis and feature extraction plugins.
   7
   8     Centre for Digital Music, Queen Mary, University of London.
   9     Copyright 2006 Chris Cannam.
  10
  11     Permission is hereby granted, free of charge, to any person
  12     obtaining a copy of this software and associated documentation
  13     files (the "Software"), to deal in the Software without
  14     restriction, including without limitation the rights to use, copy,
  15     modify, merge, publish, distribute, sublicense, and/or sell copies
  16     of the Software, and to permit persons to whom the Software is
  17     furnished to do so, subject to the following conditions:
  18
  19     The above copyright notice and this permission notice shall be
  20     included in all copies or substantial portions of the Software.
  21
  22     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  26     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  27     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30     Except as contained in this notice, the names of the Centre for
  31     Digital Music; Queen Mary, University of London; and Chris Cannam
  32     shall not be used in advertising or otherwise to promote the sale,
  33     use or other dealings in this Software without prior written
  34     authorization.
  35 */
  36
  37 #ifndef _VAMP_PLUGIN_ADAPTER_H_
  38 #define _VAMP_PLUGIN_ADAPTER_H_
  39
  40 #include <map>
  41 #include <vamp/vamp.h>
  42
  43 #include "Plugin.h"
  44
  45 #include "plugguard.h"
  46 _VAMP_SDK_PLUGSPACE_BEGIN(PluginAdapter.h)
  47
  48 namespace Vamp {
  49
  50 /**
  51  * \class PluginAdapterBase PluginAdapter.h <vamp-sdk/PluginAdapter.h>
  52  *
  53  * PluginAdapter and PluginAdapterBase provide a wrapper class that a
  54  * plugin library can use to make its C++ Vamp::Plugin objects
  55  * available through the Vamp C API.
  56  *
  57  * Almost all Vamp plugin libraries will want to make use of this.  To
  58  * do so, all they need to do is declare a PluginAdapter<T> for each
  59  * plugin class T in their library.  It's very simple, and you need to
  60  * know absolutely nothing about how it works in order to use it.
  61  * Just cut and paste from an existing plugin's discovery function.
  62  * \see vampGetPluginDescriptor
  63  */
  64
  65 class PluginAdapterBase
  66 {
  67 public:
  68     virtual ~PluginAdapterBase();
  69
  70     /**
  71      * Return a VampPluginDescriptor describing the plugin that is
  72      * wrapped by this adapter.
  73      */
  74     const VampPluginDescriptor *getDescriptor();
  75
  76 protected:
  77     PluginAdapterBase();
  78
  79     virtual Plugin *createPlugin(float inputSampleRate) = 0;
  80
  81     class Impl;
  82     Impl *m_impl;
  83 };
  84
  85 /**
  86  * \class PluginAdapter PluginAdapter.h <vamp-sdk/PluginAdapter.h>
  87  *
  88  * PluginAdapter turns a PluginAdapterBase into a specific wrapper for
  89  * a particular plugin implementation.
  90  *
  91  * See PluginAdapterBase.
  92  */
  93
  94 template <typename P>
  95 class PluginAdapter : public PluginAdapterBase
  96 {
  97 public:
  98     PluginAdapter() : PluginAdapterBase() { }
  99     virtual ~PluginAdapter() { }
 100
 101 protected:
 102     Plugin *createPlugin(float inputSampleRate) {
 103         P *p = new P(inputSampleRate);
 104         Plugin *plugin = dynamic_cast<Plugin *>(p);
 105         if (!plugin) {
 106             std::cerr << "ERROR: PluginAdapter::createPlugin: "
 107                       << "Template type is not a plugin!"
 108                       << std::endl;
 109             delete p;
 110             return 0;
 111         }
 112         return plugin;
 113     }
 114 };
 115
 116 }
 117
 118 _VAMP_SDK_PLUGSPACE_END(PluginAdapter.h)
 119
 120 #endif
 121