libs/vamp-sdk/vamp-sdk/hostext/PluginInputDomainAdapter.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_INPUT_DOMAIN_ADAPTER_H_
  38 #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
  39
  40 #include "PluginWrapper.h"
  41
  42 namespace Vamp {
  43
  44 namespace HostExt {
  45
  46 /**
  47  * \class PluginInputDomainAdapter PluginInputDomainAdapter.h <vamp-sdk/hostext/PluginInputDomainAdapter.h>
  48  *
  49  * PluginInputDomainAdapter is a Vamp plugin adapter that converts
  50  * time-domain input into frequency-domain input for plugins that need
  51  * it.  This permits a host to use time- and frequency-domain plugins
  52  * interchangeably without needing to handle the conversion itself.
  53  *
  54  * This adapter uses a basic Hanning windowed FFT that supports
  55  * power-of-two block sizes only.  If a frequency domain plugin
  56  * requests a non-power-of-two blocksize, the adapter will adjust it
  57  * to a nearby power of two instead.  Thus, getPreferredBlockSize()
  58  * will always return a power of two if the wrapped plugin is a
  59  * frequency domain one.  If the plugin doesn't accept the adjusted
  60  * power of two block size, initialise() will fail.
  61  *
  62  * The adapter provides no way for the host to discover whether the
  63  * underlying plugin is actually a time or frequency domain plugin
  64  * (except that if the preferred block size is not a power of two, it
  65  * must be a time domain plugin).
  66  *
  67  * The FFT implementation is simple and self-contained, but unlikely
  68  * to be the fastest available: a host can usually do better if it
  69  * cares enough.
  70  *
  71  * In every respect other than its input domain handling, the
  72  * PluginInputDomainAdapter behaves identically to the plugin that it
  73  * wraps.  The wrapped plugin will be deleted when the wrapper is
  74  * deleted.
  75  *
  76  * \note This class was introduced in version 1.1 of the Vamp plugin SDK.
  77  */
  78
  79 class PluginInputDomainAdapter : public PluginWrapper
  80 {
  81 public:
  82     PluginInputDomainAdapter(Plugin *plugin); // I take ownership of plugin
  83     virtual ~PluginInputDomainAdapter();
  84
  85     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
  86
  87     InputDomain getInputDomain() const;
  88
  89     size_t getPreferredStepSize() const;
  90     size_t getPreferredBlockSize() const;
  91
  92     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
  93
  94 protected:
  95     class Impl;
  96     Impl *m_impl;
  97 };
  98
  99 }
 100
 101 }
 102
 103 #endif