cannam@0:
PluginInputDomainAdapter.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@35: 00009     Copyright 2006-2009 Chris Cannam and QMUL.
cannam@0: 00010   
cannam@0: 00011     Permission is hereby granted, free of charge, to any person
cannam@0: 00012     obtaining a copy of this software and associated documentation
cannam@0: 00013     files (the "Software"), to deal in the Software without
cannam@0: 00014     restriction, including without limitation the rights to use, copy,
cannam@0: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00016     of the Software, and to permit persons to whom the Software is
cannam@0: 00017     furnished to do so, subject to the following conditions:
cannam@0: 00018 
cannam@0: 00019     The above copyright notice and this permission notice shall be
cannam@0: 00020     included in all copies or substantial portions of the Software.
cannam@0: 00021 
cannam@0: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00029 
cannam@0: 00030     Except as contained in this notice, the names of the Centre for
cannam@0: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00033     use or other dealings in this Software without prior written
cannam@0: 00034     authorization.
cannam@0: 00035 */
cannam@0: 00036 
cannam@0: 00037 #ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@0: 00038 #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@0: 00039 
cannam@21: 00040 #include "hostguard.h"
cannam@21: 00041 #include "PluginWrapper.h"
cannam@21: 00042 
cannam@21: 00043 _VAMP_SDK_HOSTSPACE_BEGIN(PluginInputDomainAdapter.h)
cannam@21: 00044 
cannam@21: 00045 namespace Vamp {
cannam@21: 00046 
cannam@21: 00047 namespace HostExt {
cannam@21: 00048 
cannam@21: 00082 class PluginInputDomainAdapter : public PluginWrapper
cannam@21: 00083 {
cannam@21: 00084 public:
cannam@21: 00090     PluginInputDomainAdapter(Plugin *plugin);
cannam@21: 00091     virtual ~PluginInputDomainAdapter();
cannam@21: 00092     
cannam@21: 00093     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@35: 00094     void reset();
cannam@35: 00095 
cannam@35: 00096     InputDomain getInputDomain() const;
cannam@35: 00097 
cannam@35: 00098     size_t getPreferredStepSize() const;
cannam@35: 00099     size_t getPreferredBlockSize() const;
cannam@35: 00100 
cannam@35: 00101     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@35: 00102 
cannam@35: 00137     enum ProcessTimestampMethod {
cannam@35: 00138         ShiftTimestamp,
cannam@35: 00139         ShiftData,
cannam@35: 00140         NoShift
cannam@35: 00141     };
cannam@35: 00142 
cannam@35: 00151     void setProcessTimestampMethod(ProcessTimestampMethod);
cannam@35: 00152 
cannam@35: 00158     ProcessTimestampMethod getProcessTimestampMethod() const;
cannam@35: 00159 
cannam@35: 00185     RealTime getTimestampAdjustment() const;
cannam@35: 00186 
cannam@35: 00187 protected:
cannam@35: 00188     class Impl;
cannam@35: 00189     Impl *m_impl;
cannam@35: 00190 };
cannam@35: 00191 
cannam@35: 00192 }
cannam@35: 00193 
cannam@35: 00194 }
cannam@35: 00195 
cannam@35: 00196 _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h)
cannam@35: 00197 
cannam@35: 00198 #endif
cannam@0: