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 
00087 class PluginInputDomainAdapter : public PluginWrapper
00088 {
00089 public:
00095     PluginInputDomainAdapter(Plugin *plugin);
00096     virtual ~PluginInputDomainAdapter();
00097     
00098     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
00099     void reset();
00100 
00101     InputDomain getInputDomain() const;
00102 
00103     size_t getPreferredStepSize() const;
00104     size_t getPreferredBlockSize() const;
00105 
00106     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
00107 
00142     enum ProcessTimestampMethod {
00143         ShiftTimestamp,
00144         ShiftData,
00145         NoShift
00146     };
00147 
00156     void setProcessTimestampMethod(ProcessTimestampMethod);
00157 
00163     ProcessTimestampMethod getProcessTimestampMethod() const;
00164 
00190     RealTime getTimestampAdjustment() const;
00191 
00195     enum WindowType {
00196 
00197         RectangularWindow    = 0,
00198 
00199         BartlettWindow       = 1, 
00200         TriangularWindow     = 1, 
00201 
00202         HammingWindow        = 2,
00203 
00204         HanningWindow        = 3, 
00205         HannWindow           = 3, 
00206 
00207         BlackmanWindow       = 4,
00208 
00209         NuttallWindow        = 7,
00210 
00211         BlackmanHarrisWindow = 8
00212     };
00213 
00217     WindowType getWindowType() const;
00218     
00222     void setWindowType(WindowType type);
00223 
00224 
00225 protected:
00226     class Impl;
00227     Impl *m_impl;
00228 };
00229 
00230 }
00231 
00232 }
00233 
00234 _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h)
00235 
00236 #endif