cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: VampPluginSDK: PluginInputDomainAdapter.h Source File cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
VampPluginSDK cannam@50:  2.1 cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50:
PluginInputDomainAdapter.h
cannam@50:
cannam@50:
cannam@50: Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@50: 00002 
cannam@50: 00003 /*
cannam@50: 00004     Vamp
cannam@50: 00005 
cannam@50: 00006     An API for audio analysis and feature extraction plugins.
cannam@50: 00007 
cannam@50: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@50: 00009     Copyright 2006-2009 Chris Cannam and QMUL.
cannam@50: 00010   
cannam@50: 00011     Permission is hereby granted, free of charge, to any person
cannam@50: 00012     obtaining a copy of this software and associated documentation
cannam@50: 00013     files (the "Software"), to deal in the Software without
cannam@50: 00014     restriction, including without limitation the rights to use, copy,
cannam@50: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@50: 00016     of the Software, and to permit persons to whom the Software is
cannam@50: 00017     furnished to do so, subject to the following conditions:
cannam@50: 00018 
cannam@50: 00019     The above copyright notice and this permission notice shall be
cannam@50: 00020     included in all copies or substantial portions of the Software.
cannam@50: 00021 
cannam@50: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@50: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@50: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@50: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@50: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@50: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@50: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@50: 00029 
cannam@50: 00030     Except as contained in this notice, the names of the Centre for
cannam@50: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@50: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@50: 00033     use or other dealings in this Software without prior written
cannam@50: 00034     authorization.
cannam@50: 00035 */
cannam@50: 00036 
cannam@50: 00037 #ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@50: 00038 #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
cannam@50: 00039 
cannam@50: 00040 #include "hostguard.h"
cannam@50: 00041 #include "PluginWrapper.h"
cannam@50: 00042 
cannam@50: 00043 _VAMP_SDK_HOSTSPACE_BEGIN(PluginInputDomainAdapter.h)
cannam@50: 00044 
cannam@50: 00045 namespace Vamp {
cannam@50: 00046 
cannam@50: 00047 namespace HostExt {
cannam@50: 00048 
cannam@50: 00087 class PluginInputDomainAdapter : public PluginWrapper
cannam@50: 00088 {
cannam@50: 00089 public:
cannam@50: 00095     PluginInputDomainAdapter(Plugin *plugin);
cannam@50: 00096     virtual ~PluginInputDomainAdapter();
cannam@50: 00097     
cannam@50: 00098     bool initialise(size_t channels, size_t stepSize, size_t blockSize);
cannam@50: 00099     void reset();
cannam@50: 00100 
cannam@50: 00101     InputDomain getInputDomain() const;
cannam@50: 00102 
cannam@50: 00103     size_t getPreferredStepSize() const;
cannam@50: 00104     size_t getPreferredBlockSize() const;
cannam@50: 00105 
cannam@50: 00106     FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
cannam@50: 00107 
cannam@50: 00142     enum ProcessTimestampMethod {
cannam@50: 00143         ShiftTimestamp,
cannam@50: 00144         ShiftData,
cannam@50: 00145         NoShift
cannam@50: 00146     };
cannam@50: 00147 
cannam@50: 00156     void setProcessTimestampMethod(ProcessTimestampMethod);
cannam@50: 00157 
cannam@50: 00163     ProcessTimestampMethod getProcessTimestampMethod() const;
cannam@50: 00164 
cannam@50: 00190     RealTime getTimestampAdjustment() const;
cannam@50: 00191 
cannam@50: 00195     enum WindowType {
cannam@50: 00196 
cannam@50: 00197         RectangularWindow    = 0,
cannam@50: 00198 
cannam@50: 00199         BartlettWindow       = 1, 
cannam@50: 00200         TriangularWindow     = 1, 
cannam@50: 00201 
cannam@50: 00202         HammingWindow        = 2,
cannam@50: 00203 
cannam@50: 00204         HanningWindow        = 3, 
cannam@50: 00205         HannWindow           = 3, 
cannam@50: 00206 
cannam@50: 00207         BlackmanWindow       = 4,
cannam@50: 00208 
cannam@50: 00209         NuttallWindow        = 7,
cannam@50: 00210 
cannam@50: 00211         BlackmanHarrisWindow = 8
cannam@50: 00212     };
cannam@50: 00213 
cannam@50: 00217     WindowType getWindowType() const;
cannam@50: 00218     
cannam@50: 00222     void setWindowType(WindowType type);
cannam@50: 00223 
cannam@50: 00224 
cannam@50: 00225 protected:
cannam@50: 00226     class Impl;
cannam@50: 00227     Impl *m_impl;
cannam@50: 00228 };
cannam@50: 00229 
cannam@50: 00230 }
cannam@50: 00231 
cannam@50: 00232 }
cannam@50: 00233 
cannam@50: 00234 _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h)
cannam@50: 00235 
cannam@50: 00236 #endif
cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: