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