cannam@92: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ cannam@92: cannam@92: /* cannam@92: Vamp cannam@92: cannam@92: An API for audio analysis and feature extraction plugins. cannam@92: cannam@92: Centre for Digital Music, Queen Mary, University of London. cannam@92: Copyright 2006-2007 Chris Cannam and QMUL. cannam@171: This file by Mark Levy and Chris Cannam, Copyright 2007-2008 QMUL. cannam@92: cannam@92: Permission is hereby granted, free of charge, to any person cannam@92: obtaining a copy of this software and associated documentation cannam@92: files (the "Software"), to deal in the Software without cannam@92: restriction, including without limitation the rights to use, copy, cannam@92: modify, merge, publish, distribute, sublicense, and/or sell copies cannam@92: of the Software, and to permit persons to whom the Software is cannam@92: furnished to do so, subject to the following conditions: cannam@92: cannam@92: The above copyright notice and this permission notice shall be cannam@92: included in all copies or substantial portions of the Software. cannam@92: cannam@92: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@92: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@92: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND cannam@92: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR cannam@92: ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@92: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@92: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@92: cannam@92: Except as contained in this notice, the names of the Centre for cannam@92: Digital Music; Queen Mary, University of London; and Chris Cannam cannam@92: shall not be used in advertising or otherwise to promote the sale, cannam@92: use or other dealings in this Software without prior written cannam@92: authorization. cannam@92: */ cannam@92: cannam@92: #ifndef _VAMP_PLUGIN_BUFFERING_ADAPTER_H_ cannam@92: #define _VAMP_PLUGIN_BUFFERING_ADAPTER_H_ cannam@92: cannam@92: #include "PluginWrapper.h" cannam@92: cannam@92: namespace Vamp { cannam@92: cannam@92: namespace HostExt { cannam@92: cannam@92: /** cannam@92: * \class PluginBufferingAdapter PluginBufferingAdapter.h cannam@92: * cannam@92: * PluginBufferingAdapter is a Vamp plugin adapter that allows plugins cannam@92: * to be used by a host supplying an audio stream in non-overlapping cannam@92: * buffers of arbitrary size. cannam@92: * cannam@92: * A host using PluginBufferingAdapter may ignore the preferred step cannam@92: * and block size reported by the plugin, and still expect the plugin cannam@92: * to run. The value of blockSize and stepSize passed to initialise cannam@92: * should be the size of the buffer which the host will supply; the cannam@92: * stepSize should be equal to the blockSize. cannam@92: * cannam@92: * If the internal step size used for the plugin differs from that cannam@133: * supplied by the host, the adapter will modify the sample type and cannam@133: * rate specifications for the plugin outputs appropriately, and set cannam@133: * timestamps on the output features for outputs that formerly used a cannam@133: * different sample rate specification. This is necessary in order to cannam@133: * obtain correct time stamping. cannam@92: * cannam@92: * In other respects, the PluginBufferingAdapter behaves identically cannam@92: * to the plugin that it wraps. The wrapped plugin will be deleted cannam@92: * when the wrapper is deleted. cannam@92: */ cannam@92: cannam@92: class PluginBufferingAdapter : public PluginWrapper cannam@92: { cannam@92: public: cannam@92: PluginBufferingAdapter(Plugin *plugin); // I take ownership of plugin cannam@92: virtual ~PluginBufferingAdapter(); cannam@169: cannam@169: /** cannam@169: * Return the preferred step size for this adapter. cannam@169: * cannam@169: * Because of the way this adapter works, its preferred step size cannam@169: * will always be the same as its preferred block size. This may cannam@169: * or may not be the same as the preferred step size of the cannam@169: * underlying plugin, which may be obtained by calling cannam@169: * getPluginPreferredStepSize(). cannam@169: */ cannam@169: size_t getPreferredStepSize() const; cannam@169: cannam@169: /** cannam@169: * Return the preferred block size for this adapter. cannam@169: * cannam@169: * This may or may not be the same as the preferred block size of cannam@169: * the underlying plugin, which may be obtained by calling cannam@169: * getPluginPreferredBlockSize(). cannam@169: * cannam@169: * Note that this adapter may be initialised with any block size, cannam@169: * not just its supposedly preferred one. cannam@169: */ cannam@169: size_t getPreferredBlockSize() const; cannam@169: cannam@169: /** cannam@170: * Initialise the adapter (and therefore the plugin) for the given cannam@170: * number of channels. Initialise the adapter for the given step cannam@170: * and block size, which must be equal. cannam@170: * cannam@170: * The step and block size used for the underlying plugin will cannam@170: * depend on its preferences, or any values previously passed to cannam@170: * setPluginStepSize and setPluginBlockSize. cannam@170: */ cannam@170: bool initialise(size_t channels, size_t stepSize, size_t blockSize); cannam@170: cannam@170: /** cannam@169: * Return the preferred step size of the plugin wrapped by this cannam@169: * adapter. cannam@169: * cannam@169: * This is included mainly for informational purposes. This value cannam@169: * is not likely to be a valid step size for the adapter itself, cannam@169: * and it is not usually of any use in interpreting the results cannam@169: * (because the adapter re-writes OneSamplePerStep outputs to cannam@169: * FixedSampleRate so that the hop size no longer needs to be cannam@169: * known beforehand in order to interpret them). cannam@169: */ cannam@169: size_t getPluginPreferredStepSize() const; cannam@169: cannam@169: /** cannam@169: * Return the preferred block size of the plugin wrapped by this cannam@169: * adapter. cannam@169: * cannam@169: * This is included mainly for informational purposes. cannam@169: */ cannam@169: size_t getPluginPreferredBlockSize() const; cannam@169: cannam@169: /** cannam@169: * Set the step size that will be used for the underlying plugin cannam@169: * when initialise() is called. If this is not set, the plugin's cannam@169: * own preferred step size will be used. You will not usually cannam@169: * need to call this function. If you do call it, it must be cannam@169: * before the first call to initialise(). cannam@169: */ cannam@169: void setPluginStepSize(size_t stepSize); cannam@169: cannam@169: /** cannam@169: * Set the block size that will be used for the underlying plugin cannam@169: * when initialise() is called. If this is not set, the plugin's cannam@169: * own preferred block size will be used. You will not usually cannam@169: * need to call this function. If you do call it, it must be cannam@169: * before the first call to initialise(). cannam@169: */ cannam@169: void setPluginBlockSize(size_t blockSize); cannam@169: cannam@169: /** cannam@170: * Return the step and block sizes that were actually used when cannam@170: * initialising the underlying plugin. cannam@169: * cannam@170: * This is included mainly for informational purposes. You will cannam@170: * not usually need to call this function. If this is called cannam@170: * before initialise(), it will return 0 for both values. If it cannam@170: * is called after a failed call to initialise(), it will return cannam@170: * the values that were used in the failed call to the plugin's cannam@170: * initialise() function. cannam@169: */ cannam@170: void getActualStepAndBlockSizes(size_t &stepSize, size_t &blockSize); cannam@92: cannam@92: OutputList getOutputDescriptors() const; cannam@92: cannam@104: void reset(); cannam@104: cannam@92: FeatureSet process(const float *const *inputBuffers, RealTime timestamp); cannam@92: cannam@92: FeatureSet getRemainingFeatures(); cannam@92: cannam@92: protected: cannam@92: class Impl; cannam@92: Impl *m_impl; cannam@92: }; cannam@92: cannam@92: } cannam@92: cannam@92: } cannam@92: cannam@92: #endif