cannam@64: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@64: 
cannam@64: /*
cannam@64:     Vamp
cannam@64: 
cannam@64:     An API for audio analysis and feature extraction plugins.
cannam@64: 
cannam@64:     Centre for Digital Music, Queen Mary, University of London.
cannam@71:     Copyright 2006-2007 Chris Cannam and QMUL.
cannam@64:   
cannam@64:     Permission is hereby granted, free of charge, to any person
cannam@64:     obtaining a copy of this software and associated documentation
cannam@64:     files (the "Software"), to deal in the Software without
cannam@64:     restriction, including without limitation the rights to use, copy,
cannam@64:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@64:     of the Software, and to permit persons to whom the Software is
cannam@64:     furnished to do so, subject to the following conditions:
cannam@64: 
cannam@64:     The above copyright notice and this permission notice shall be
cannam@64:     included in all copies or substantial portions of the Software.
cannam@64: 
cannam@64:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@64:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@64:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@64:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@64:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@64:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@64:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@64: 
cannam@64:     Except as contained in this notice, the names of the Centre for
cannam@64:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@64:     shall not be used in advertising or otherwise to promote the sale,
cannam@64:     use or other dealings in this Software without prior written
cannam@64:     authorization.
cannam@64: */
cannam@64: 
cannam@64: #ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@64: #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@64: 
cannam@64: #include "PluginWrapper.h"
cannam@64: 
cannam@64: namespace Vamp {
cannam@64: 
cannam@64: namespace HostExt {
cannam@64: 
cannam@64: /**
cannam@64:  * PluginInputDomainAdapter is a Vamp plugin adapter that converts
cannam@64:  * time-domain input into frequency-domain input for plugins that need
cannam@64:  * it.  This permits a host to use time- and frequency-domain plugins
cannam@64:  * interchangeably without needing to handle the conversion itself.
cannam@64:  *
cannam@64:  * This adapter uses a basic Hanning windowed FFT that supports
cannam@64:  * power-of-two block sizes only.  If a frequency domain plugin
cannam@64:  * requests a non-power-of-two blocksize, the adapter will adjust it
cannam@64:  * to a nearby power of two instead.  Thus, getPreferredBlockSize()
cannam@64:  * will always return a power of two if the wrapped plugin is a
cannam@64:  * frequency domain one.  If the plugin doesn't accept the adjusted
cannam@64:  * power of two block size, initialise() will fail.
cannam@64:  *
cannam@64:  * The adapter provides no way for the host to discover whether the
cannam@64:  * underlying plugin is actually a time or frequency domain plugin
cannam@64:  * (except that if the preferred block size is not a power of two, it
cannam@64:  * must be a time domain plugin).
cannam@64:  *
cannam@64:  * The FFT implementation is simple and self-contained, but unlikely
cannam@64:  * to be the fastest available: a host can usually do better if it
cannam@64:  * cares enough.
cannam@64:  *
cannam@64:  * In every respect other than its input domain handling, the
cannam@64:  * PluginInputDomainAdapter behaves identically to the plugin that it
cannam@64:  * wraps.  The wrapped plugin will be deleted when the wrapper is
cannam@64:  * deleted.
cannam@64:  */
cannam@64: 
cannam@64: class PluginInputDomainAdapter : public PluginWrapper
cannam@64: {
cannam@64: public:
cannam@64:     PluginInputDomainAdapter(Plugin *plugin); // I take ownership of plugin
cannam@64:     virtual ~PluginInputDomainAdapter();
cannam@64:     
cannam@64:     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@64: 
cannam@64:     InputDomain getInputDomain() const;
cannam@64: 
cannam@64:     size_t getPreferredStepSize() const;
cannam@64:     size_t getPreferredBlockSize() const;
cannam@64: 
cannam@64:     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@64: 
cannam@64: protected:
cannam@70:     class Impl;
cannam@70:     Impl *m_impl;
cannam@64: };
cannam@64: 
cannam@64: }
cannam@64: 
cannam@64: }
cannam@64: 
cannam@64: #endif