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