libs/vamp-sdk/vamp-sdk/hostext/PluginWrapper.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-2007 Chris Cannam and QMUL.
  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_WRAPPER_H_
  38 #define _VAMP_PLUGIN_WRAPPER_H_
  39
  40 #include <vamp-sdk/Plugin.h>
  41
  42 namespace Vamp {
  43
  44 namespace HostExt {
  45
  46 /**
  47  * \class PluginWrapper PluginWrapper.h <vamp-sdk/hostext/PluginWrapper.h>
  48  *
  49  * PluginWrapper is a simple base class for adapter plugins.  It takes
  50  * a pointer to a "to be wrapped" Vamp plugin on construction, and
  51  * provides implementations of all the Vamp plugin methods that simply
  52  * delegate through to the wrapped plugin.  A subclass can therefore
  53  * override only the methods that are meaningful for the particular
  54  * adapter.
  55  *
  56  * \note This class was introduced in version 1.1 of the Vamp plugin SDK.
  57  */
  58
  59 class PluginWrapper : public Plugin
  60 {
  61 public:
  62     virtual ~PluginWrapper();
  63
  64     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
  65     void reset();
  66
  67     InputDomain getInputDomain() const;
  68
  69     unsigned int getVampApiVersion() const;
  70     std::string getIdentifier() const;
  71     std::string getName() const;
  72     std::string getDescription() const;
  73     std::string getMaker() const;
  74     int getPluginVersion() const;
  75     std::string getCopyright() const;
  76
  77     ParameterList getParameterDescriptors() const;
  78     float getParameter(std::string) const;
  79     void setParameter(std::string, float);
  80
  81     ProgramList getPrograms() const;
  82     std::string getCurrentProgram() const;
  83     void selectProgram(std::string);
  84
  85     size_t getPreferredStepSize() const;
  86     size_t getPreferredBlockSize() const;
  87
  88     size_t getMinChannelCount() const;
  89     size_t getMaxChannelCount() const;
  90
  91     OutputList getOutputDescriptors() const;
  92
  93     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
  94
  95     FeatureSet getRemainingFeatures();
  96
  97 protected:
  98     PluginWrapper(Plugin *plugin); // I take ownership of plugin
  99     Plugin *m_plugin;
 100 };
 101
 102 }
 103
 104 }
 105
 106 #endif