cannam@99: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ cannam@99: cannam@99: /* cannam@99: Vamp cannam@99: cannam@99: An API for audio analysis and feature extraction plugins. cannam@99: cannam@99: Centre for Digital Music, Queen Mary, University of London. cannam@99: Copyright 2006-2009 Chris Cannam and QMUL. cannam@99: cannam@99: Permission is hereby granted, free of charge, to any person cannam@99: obtaining a copy of this software and associated documentation cannam@99: files (the "Software"), to deal in the Software without cannam@99: restriction, including without limitation the rights to use, copy, cannam@99: modify, merge, publish, distribute, sublicense, and/or sell copies cannam@99: of the Software, and to permit persons to whom the Software is cannam@99: furnished to do so, subject to the following conditions: cannam@99: cannam@99: The above copyright notice and this permission notice shall be cannam@99: included in all copies or substantial portions of the Software. cannam@99: cannam@99: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@99: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@99: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND cannam@99: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR cannam@99: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@99: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@99: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@99: cannam@99: Except as contained in this notice, the names of the Centre for cannam@99: Digital Music; Queen Mary, University of London; and Chris Cannam cannam@99: shall not be used in advertising or otherwise to promote the sale, cannam@99: use or other dealings in this Software without prior written cannam@99: authorization. cannam@99: */ cannam@99: cannam@99: #ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_ cannam@99: #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_ cannam@99: cannam@99: #include "hostguard.h" cannam@99: #include "PluginWrapper.h" cannam@99: cannam@99: _VAMP_SDK_HOSTSPACE_BEGIN(PluginInputDomainAdapter.h) cannam@99: cannam@99: namespace Vamp { cannam@99: cannam@99: namespace HostExt { cannam@99: cannam@99: /** cannam@99: * \class PluginInputDomainAdapter PluginInputDomainAdapter.h cannam@99: * cannam@99: * PluginInputDomainAdapter is a Vamp plugin adapter that converts cannam@99: * time-domain input into frequency-domain input for plugins that need cannam@99: * it. This permits a host to use time- and frequency-domain plugins cannam@99: * interchangeably without needing to handle the conversion itself. cannam@99: * cannam@99: * This adapter uses a basic windowed FFT (using Hann window by cannam@99: * default) that supports power-of-two block sizes only. If a cannam@99: * frequency domain plugin requests a non-power-of-two blocksize, the cannam@99: * adapter will adjust it to a nearby power of two instead. Thus, cannam@99: * getPreferredBlockSize() will always return a power of two if the cannam@99: * wrapped plugin is a frequency domain one. If the plugin doesn't cannam@99: * accept the adjusted power of two block size, initialise() will cannam@99: * fail. cannam@99: * cannam@99: * The adapter provides no way for the host to discover whether the cannam@99: * underlying plugin is actually a time or frequency domain plugin cannam@99: * (except that if the preferred block size is not a power of two, it cannam@99: * must be a time domain plugin). cannam@99: * cannam@99: * The FFT implementation is simple and self-contained, but unlikely cannam@99: * to be the fastest available: a host can usually do better if it cannam@99: * cares enough. cannam@99: * cannam@99: * The window shape for the FFT frame can be set using setWindowType cannam@99: * and the current shape retrieved using getWindowType. (This was cannam@99: * added in v2.3 of the SDK.) cannam@99: * cannam@99: * In every respect other than its input domain handling, the cannam@99: * PluginInputDomainAdapter behaves identically to the plugin that it cannam@99: * wraps. The wrapped plugin will be deleted when the wrapper is cannam@99: * deleted. cannam@99: * cannam@99: * \note This class was introduced in version 1.1 of the Vamp plugin SDK. cannam@99: */ cannam@99: cannam@99: class PluginInputDomainAdapter : public PluginWrapper cannam@99: { cannam@99: public: cannam@99: /** cannam@99: * Construct a PluginInputDomainAdapter wrapping the given plugin. cannam@99: * The adapter takes ownership of the plugin, which will be cannam@99: * deleted when the adapter is deleted. cannam@99: */ cannam@99: PluginInputDomainAdapter(Plugin *plugin); cannam@99: virtual ~PluginInputDomainAdapter(); cannam@99: cannam@99: bool initialise(size_t channels, size_t stepSize, size_t blockSize); cannam@99: void reset(); cannam@99: cannam@99: InputDomain getInputDomain() const; cannam@99: cannam@99: size_t getPreferredStepSize() const; cannam@99: size_t getPreferredBlockSize() const; cannam@99: cannam@99: FeatureSet process(const float *const *inputBuffers, RealTime timestamp); cannam@99: cannam@99: /** cannam@99: * ProcessTimestampMethod determines how the cannam@99: * PluginInputDomainAdapter handles timestamps for the data passed cannam@99: * to the process() function of the plugin it wraps, in the case cannam@99: * where the plugin is expecting frequency-domain data. cannam@99: * cannam@99: * The Vamp specification requires that the timestamp passed to cannam@99: * the plugin for frequency-domain input should be that of the cannam@99: * centre of the processing block, rather than the start as is the cannam@99: * case for time-domain input. cannam@99: * cannam@99: * Since PluginInputDomainAdapter aims to be transparent in use, cannam@99: * it needs to handle this timestamp adjustment itself. However, cannam@99: * some control is available over the method used for adjustment, cannam@99: * by means of the ProcessTimestampMethod setting. cannam@99: * cannam@99: * If ProcessTimestampMethod is set to ShiftTimestamp (the cannam@99: * default), then the data passed to the wrapped plugin will be cannam@99: * calculated from the same input data block as passed to the cannam@99: * wrapper, but the timestamp passed to the plugin will be cannam@99: * advanced by half of the window size. cannam@99: * cannam@99: * If ProcessTimestampMethod is set to ShiftData, then the cannam@99: * timestamp passed to the wrapped plugin will be the same as that cannam@99: * passed to the process call of the wrapper, but the data block cannam@99: * used to calculate the input will be shifted back (earlier) by cannam@99: * half of the window size, with half a block of zero padding at cannam@99: * the start of the first process call. This has the advantage of cannam@99: * preserving the first half block of audio without any cannam@99: * deterioration from window shaping. cannam@99: * cannam@99: * If ProcessTimestampMethod is set to NoShift, then no adjustment cannam@99: * will be made and the timestamps will be incorrect. cannam@99: */ cannam@99: enum ProcessTimestampMethod { cannam@99: ShiftTimestamp, cannam@99: ShiftData, cannam@99: NoShift cannam@99: }; cannam@99: cannam@99: /** cannam@99: * Set the method used for timestamp adjustment in plugins taking cannam@99: * frequency-domain input. See the ProcessTimestampMethod cannam@99: * documentation for details. cannam@99: * cannam@99: * This function must be called before the first call to cannam@99: * process(). cannam@99: */ cannam@99: void setProcessTimestampMethod(ProcessTimestampMethod); cannam@99: cannam@99: /** cannam@99: * Retrieve the method used for timestamp adjustment in plugins cannam@99: * taking frequency-domain input. See the ProcessTimestampMethod cannam@99: * documentation for details. cannam@99: */ cannam@99: ProcessTimestampMethod getProcessTimestampMethod() const; cannam@99: cannam@99: /** cannam@99: * Return the amount by which the timestamps supplied to process() cannam@99: * are being incremented when they are passed to the plugin's own cannam@99: * process() implementation. cannam@99: * cannam@99: * The Vamp API mandates that the timestamp passed to the plugin cannam@99: * for time-domain input should be the time of the first sample in cannam@99: * the block, but the timestamp passed for frequency-domain input cannam@99: * should be the timestamp of the centre of the block. cannam@99: * cannam@99: * The PluginInputDomainAdapter adjusts its timestamps properly so cannam@99: * that the plugin receives correct times, but in some cannam@99: * circumstances (such as for establishing the correct timing of cannam@99: * implicitly-timed features, i.e. features without their own cannam@99: * timestamps) the host may need to be aware that this adjustment cannam@99: * is taking place. cannam@99: * cannam@99: * If the plugin requires time-domain input or the cannam@99: * PluginInputDomainAdapter is configured with its cannam@99: * ProcessTimestampMethod set to ShiftData instead of cannam@99: * ShiftTimestamp, then this function will return zero. cannam@99: * cannam@99: * The result of calling this function before initialise() has cannam@99: * been called is undefined. cannam@99: */ cannam@99: RealTime getTimestampAdjustment() const; cannam@99: cannam@99: /** cannam@99: * The set of supported window shapes. cannam@99: */ cannam@99: enum WindowType { cannam@99: cannam@99: RectangularWindow = 0, cannam@99: cannam@99: BartlettWindow = 1, /// synonym for RectangularWindow cannam@99: TriangularWindow = 1, /// synonym for BartlettWindow cannam@99: cannam@99: HammingWindow = 2, cannam@99: cannam@99: HanningWindow = 3, /// synonym for HannWindow cannam@99: HannWindow = 3, /// synonym for HanningWindow cannam@99: cannam@99: BlackmanWindow = 4, cannam@99: cannam@99: NuttallWindow = 7, cannam@99: cannam@99: BlackmanHarrisWindow = 8 cannam@99: }; cannam@99: cannam@99: /** cannam@99: * Return the current window shape. The default is HanningWindow. cannam@99: */ cannam@99: WindowType getWindowType() const; cannam@99: cannam@99: /** cannam@99: * Set the current window shape. cannam@99: */ cannam@99: void setWindowType(WindowType type); cannam@99: cannam@99: cannam@99: protected: cannam@99: class Impl; cannam@99: Impl *m_impl; cannam@99: }; cannam@99: cannam@99: } cannam@99: cannam@99: } cannam@99: cannam@99: _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h) cannam@99: cannam@99: #endif