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