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: This file by Mark Levy and Chris Cannam, Copyright 2007-2008 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_BUFFERING_ADAPTER_H_ cannam@227: #define _VAMP_PLUGIN_BUFFERING_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 PluginBufferingAdapter PluginBufferingAdapter.h cannam@227: * cannam@227: * PluginBufferingAdapter is a Vamp plugin adapter that allows plugins cannam@227: * to be used by a host supplying an audio stream in non-overlapping cannam@227: * buffers of arbitrary size. cannam@227: * cannam@227: * A host using PluginBufferingAdapter may ignore the preferred step cannam@227: * and block size reported by the plugin, and still expect the plugin cannam@227: * to run. The value of blockSize and stepSize passed to initialise cannam@227: * should be the size of the buffer which the host will supply; the cannam@227: * stepSize should be equal to the blockSize. cannam@227: * cannam@227: * If the internal step size used for the plugin differs from that cannam@227: * supplied by the host, the adapter will modify the sample type and cannam@227: * rate specifications for the plugin outputs appropriately, and set cannam@227: * timestamps on the output features for outputs that formerly used a cannam@227: * different sample rate specification. This is necessary in order to cannam@227: * obtain correct time stamping. cannam@227: * cannam@227: * In other respects, the PluginBufferingAdapter behaves identically cannam@227: * to the plugin that it wraps. The wrapped plugin will be deleted cannam@227: * when the wrapper is deleted. cannam@227: */ cannam@227: cannam@227: class PluginBufferingAdapter : public PluginWrapper cannam@227: { cannam@227: public: cannam@227: PluginBufferingAdapter(Plugin *plugin); // I take ownership of plugin cannam@227: virtual ~PluginBufferingAdapter(); cannam@227: cannam@227: /** cannam@227: * Return the preferred step size for this adapter. cannam@227: * cannam@227: * Because of the way this adapter works, its preferred step size cannam@227: * will always be the same as its preferred block size. This may cannam@227: * or may not be the same as the preferred step size of the cannam@227: * underlying plugin, which may be obtained by calling cannam@227: * getPluginPreferredStepSize(). cannam@227: */ cannam@227: size_t getPreferredStepSize() const; cannam@227: cannam@227: /** cannam@227: * Return the preferred block size for this adapter. cannam@227: * cannam@227: * This may or may not be the same as the preferred block size of cannam@227: * the underlying plugin, which may be obtained by calling cannam@227: * getPluginPreferredBlockSize(). cannam@227: * cannam@227: * Note that this adapter may be initialised with any block size, cannam@227: * not just its supposedly preferred one. cannam@227: */ cannam@227: size_t getPreferredBlockSize() const; cannam@227: cannam@227: /** cannam@227: * Initialise the adapter (and therefore the plugin) for the given cannam@227: * number of channels. Initialise the adapter for the given step cannam@227: * and block size, which must be equal. cannam@227: * cannam@227: * The step and block size used for the underlying plugin will cannam@227: * depend on its preferences, or any values previously passed to cannam@227: * setPluginStepSize and setPluginBlockSize. cannam@227: */ cannam@227: bool initialise(size_t channels, size_t stepSize, size_t blockSize); cannam@227: cannam@227: /** cannam@227: * Return the preferred step size of the plugin wrapped by this cannam@227: * adapter. cannam@227: * cannam@227: * This is included mainly for informational purposes. This value cannam@227: * is not likely to be a valid step size for the adapter itself, cannam@227: * and it is not usually of any use in interpreting the results cannam@227: * (because the adapter re-writes OneSamplePerStep outputs to cannam@227: * FixedSampleRate so that the hop size no longer needs to be cannam@227: * known beforehand in order to interpret them). cannam@227: */ cannam@227: size_t getPluginPreferredStepSize() const; cannam@227: cannam@227: /** cannam@227: * Return the preferred block size of the plugin wrapped by this cannam@227: * adapter. cannam@227: * cannam@227: * This is included mainly for informational purposes. cannam@227: */ cannam@227: size_t getPluginPreferredBlockSize() const; cannam@227: cannam@227: /** cannam@227: * Set the step size that will be used for the underlying plugin cannam@227: * when initialise() is called. If this is not set, the plugin's cannam@227: * own preferred step size will be used. You will not usually cannam@227: * need to call this function. If you do call it, it must be cannam@227: * before the first call to initialise(). cannam@227: */ cannam@227: void setPluginStepSize(size_t stepSize); cannam@227: cannam@227: /** cannam@227: * Set the block size that will be used for the underlying plugin cannam@227: * when initialise() is called. If this is not set, the plugin's cannam@227: * own preferred block size will be used. You will not usually cannam@227: * need to call this function. If you do call it, it must be cannam@227: * before the first call to initialise(). cannam@227: */ cannam@227: void setPluginBlockSize(size_t blockSize); cannam@227: cannam@227: /** cannam@227: * Return the step and block sizes that were actually used when cannam@227: * initialising the underlying plugin. cannam@227: * cannam@227: * This is included mainly for informational purposes. You will cannam@227: * not usually need to call this function. If this is called cannam@227: * before initialise(), it will return 0 for both values. If it cannam@227: * is called after a failed call to initialise(), it will return cannam@227: * the values that were used in the failed call to the plugin's cannam@227: * initialise() function. cannam@227: */ cannam@227: void getActualStepAndBlockSizes(size_t &stepSize, size_t &blockSize); cannam@227: cannam@227: OutputList getOutputDescriptors() const; cannam@227: cannam@227: void reset(); cannam@227: cannam@227: FeatureSet process(const float *const *inputBuffers, RealTime timestamp); cannam@227: cannam@227: FeatureSet getRemainingFeatures(); 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