libs/vamp-sdk/vamp-hostsdk/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-2009 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 "hostguard.h"
  41 #include "vamp-hostsdk/Plugin.h"
  42
  43 _VAMP_SDK_HOSTSPACE_BEGIN(PluginWrapper.h)
  44
  45 namespace Vamp {
  46
  47 namespace HostExt {
  48
  49 /**
  50  * \class PluginWrapper PluginWrapper.h <vamp-hostsdk/PluginWrapper.h>
  51  *
  52  * PluginWrapper is a simple base class for adapter plugins.  It takes
  53  * a pointer to a "to be wrapped" Vamp plugin on construction, and
  54  * provides implementations of all the Vamp plugin methods that simply
  55  * delegate through to the wrapped plugin.  A subclass can therefore
  56  * override only the methods that are meaningful for the particular
  57  * adapter.
  58  *
  59  * \note This class was introduced in version 1.1 of the Vamp plugin SDK.
  60  */
  61
  62 class PluginWrapper : public Plugin
  63 {
  64 public:
  65     virtual ~PluginWrapper();
  66
  67     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
  68     void reset();
  69
  70     InputDomain getInputDomain() const;
  71
  72     unsigned int getVampApiVersion() const;
  73     std::string getIdentifier() const;
  74     std::string getName() const;
  75     std::string getDescription() const;
  76     std::string getMaker() const;
  77     int getPluginVersion() const;
  78     std::string getCopyright() const;
  79
  80     ParameterList getParameterDescriptors() const;
  81     float getParameter(std::string) const;
  82     void setParameter(std::string, float);
  83
  84     ProgramList getPrograms() const;
  85     std::string getCurrentProgram() const;
  86     void selectProgram(std::string);
  87
  88     size_t getPreferredStepSize() const;
  89     size_t getPreferredBlockSize() const;
  90
  91     size_t getMinChannelCount() const;
  92     size_t getMaxChannelCount() const;
  93
  94     OutputList getOutputDescriptors() const;
  95
  96     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
  97
  98     FeatureSet getRemainingFeatures();
  99
 100     /**
 101      * Return a pointer to the plugin wrapper of type WrapperType
 102      * surrounding this wrapper's plugin, if present.
 103      *
 104      * This is useful in situations where a plugin is wrapped by
 105      * multiple different wrappers (one inside another) and the host
 106      * wants to call some wrapper-specific function on one of the
 107      * layers without having to care about the order in which they are
 108      * wrapped.  For example, the plugin returned by
 109      * PluginLoader::loadPlugin may have more than one wrapper; if the
 110      * host wanted to query or fine-tune some property of one of them,
 111      * it would be hard to do so without knowing the order of the
 112      * wrappers.  This function therefore gives direct access to the
 113      * wrapper of a particular type.
 114      */
 115     template <typename WrapperType>
 116     WrapperType *getWrapper() {
 117         WrapperType *w = dynamic_cast<WrapperType *>(this);
 118         if (w) return w;
 119         PluginWrapper *pw = dynamic_cast<PluginWrapper *>(m_plugin);
 120         if (pw) return pw->getWrapper<WrapperType>();
 121         return 0;
 122     }
 123
 124 protected:
 125     PluginWrapper(Plugin *plugin); // I take ownership of plugin
 126     Plugin *m_plugin;
 127 };
 128
 129 }
 130
 131 }
 132
 133 _VAMP_SDK_HOSTSPACE_END(PluginWrapper.h)
 134
 135 #endif