cannam@0:
PluginBufferingAdapter.h

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 00002 
cannam@0: 00003 /*
cannam@0: 00004     Vamp
cannam@0: 00005 
cannam@0: 00006     An API for audio analysis and feature extraction plugins.
cannam@0: 00007 
cannam@0: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@0: 00009     Copyright 2006-2007 Chris Cannam and QMUL.
cannam@21: 00010     This file by Mark Levy and Chris Cannam, Copyright 2007-2008 QMUL.
cannam@0: 00011   
cannam@0: 00012     Permission is hereby granted, free of charge, to any person
cannam@0: 00013     obtaining a copy of this software and associated documentation
cannam@0: 00014     files (the "Software"), to deal in the Software without
cannam@0: 00015     restriction, including without limitation the rights to use, copy,
cannam@0: 00016     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00017     of the Software, and to permit persons to whom the Software is
cannam@0: 00018     furnished to do so, subject to the following conditions:
cannam@0: 00019 
cannam@0: 00020     The above copyright notice and this permission notice shall be
cannam@0: 00021     included in all copies or substantial portions of the Software.
cannam@0: 00022 
cannam@0: 00023     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00024     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00025     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00026     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00027     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00028     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00029     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00030 
cannam@0: 00031     Except as contained in this notice, the names of the Centre for
cannam@0: 00032     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00033     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00034     use or other dealings in this Software without prior written
cannam@0: 00035     authorization.
cannam@0: 00036 */
cannam@0: 00037 
cannam@0: 00038 #ifndef _VAMP_PLUGIN_BUFFERING_ADAPTER_H_
cannam@0: 00039 #define _VAMP_PLUGIN_BUFFERING_ADAPTER_H_
cannam@0: 00040 
cannam@21: 00041 #include "hostguard.h"
cannam@21: 00042 #include "PluginWrapper.h"
cannam@21: 00043 
cannam@21: 00044 _VAMP_SDK_HOSTSPACE_BEGIN(PluginBufferingAdapter.h)
cannam@21: 00045 
cannam@21: 00046 namespace Vamp {
cannam@21: 00047         
cannam@21: 00048 namespace HostExt {
cannam@21: 00049                 
cannam@21: 00075 class PluginBufferingAdapter : public PluginWrapper
cannam@21: 00076 {
cannam@21: 00077 public:
cannam@21: 00083     PluginBufferingAdapter(Plugin *plugin);
cannam@21: 00084     virtual ~PluginBufferingAdapter();
cannam@0: 00085 
cannam@21: 00095     size_t getPreferredStepSize() const;
cannam@0: 00096 
cannam@21: 00107     size_t getPreferredBlockSize() const;
cannam@21: 00108 
cannam@21: 00118     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@21: 00119 
cannam@21: 00131     size_t getPluginPreferredStepSize() const;
cannam@21: 00132 
cannam@21: 00139     size_t getPluginPreferredBlockSize() const;
cannam@21: 00140 
cannam@21: 00148     void setPluginStepSize(size_t stepSize);
cannam@21: 00149 
cannam@21: 00157     void setPluginBlockSize(size_t blockSize);
cannam@21: 00158 
cannam@21: 00170     void getActualStepAndBlockSizes(size_t &stepSize, size_t &blockSize);
cannam@21: 00171 
cannam@21: 00172     void setParameter(std::string, float);
cannam@21: 00173     void selectProgram(std::string);
cannam@21: 00174 
cannam@21: 00175     OutputList getOutputDescriptors() const;
cannam@21: 00176 
cannam@21: 00177     void reset();
cannam@21: 00178 
cannam@21: 00179     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@21: 00180     
cannam@21: 00181     FeatureSet getRemainingFeatures();
cannam@21: 00182     
cannam@21: 00183 protected:
cannam@21: 00184     class Impl;
cannam@21: 00185     Impl *m_impl;
cannam@21: 00186 };
cannam@21: 00187     
cannam@21: 00188 }
cannam@21: 00189 
cannam@21: 00190 }
cannam@21: 00191 
cannam@21: 00192 _VAMP_SDK_HOSTSPACE_END(PluginBufferingAdapter.h)
cannam@21: 00193 
cannam@21: 00194 #endif
cannam@0: