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