VampPluginSDK  2.10
PluginInputDomainAdapter.h
Go to the documentation of this file.
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
2 
3 /*
4  Vamp
5 
6  An API for audio analysis and feature extraction plugins.
7 
8  Centre for Digital Music, Queen Mary, University of London.
9  Copyright 2006-2009 Chris Cannam and QMUL.
10 
11  Permission is hereby granted, free of charge, to any person
12  obtaining a copy of this software and associated documentation
13  files (the "Software"), to deal in the Software without
14  restriction, including without limitation the rights to use, copy,
15  modify, merge, publish, distribute, sublicense, and/or sell copies
16  of the Software, and to permit persons to whom the Software is
17  furnished to do so, subject to the following conditions:
18 
19  The above copyright notice and this permission notice shall be
20  included in all copies or substantial portions of the Software.
21 
22  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
26  ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 
30  Except as contained in this notice, the names of the Centre for
31  Digital Music; Queen Mary, University of London; and Chris Cannam
32  shall not be used in advertising or otherwise to promote the sale,
33  use or other dealings in this Software without prior written
34  authorization.
35 */
36 
37 #ifndef _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
38 #define _VAMP_PLUGIN_INPUT_DOMAIN_ADAPTER_H_
39 
40 #include "hostguard.h"
41 #include "PluginWrapper.h"
42 
43 _VAMP_SDK_HOSTSPACE_BEGIN(PluginInputDomainAdapter.h)
44 
45 namespace Vamp {
46 
47 namespace HostExt {
48 
88 {
89 public:
97  virtual ~PluginInputDomainAdapter();
98 
99  bool initialise(size_t channels, size_t stepSize, size_t blockSize);
100  void reset();
101 
102  InputDomain getInputDomain() const;
103 
104  size_t getPreferredStepSize() const;
105  size_t getPreferredBlockSize() const;
106 
107  FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
108 
146  NoShift
147  };
148 
157  void setProcessTimestampMethod(ProcessTimestampMethod);
158 
164  ProcessTimestampMethod getProcessTimestampMethod() const;
165 
191  RealTime getTimestampAdjustment() const;
192 
196  enum WindowType {
197 
198  RectangularWindow = 0,
199 
200  BartlettWindow = 1,
201  TriangularWindow = 1,
202 
203  HammingWindow = 2,
204 
205  HanningWindow = 3,
206  HannWindow = 3,
207 
208  BlackmanWindow = 4,
209 
210  NuttallWindow = 7,
211 
212  BlackmanHarrisWindow = 8
213  };
214 
218  WindowType getWindowType() const;
219 
223  void setWindowType(WindowType type);
224 
225 
226 protected:
227  class Impl;
228  Impl *m_impl;
229 };
230 
231 }
232 
233 }
234 
235 _VAMP_SDK_HOSTSPACE_END(PluginInputDomainAdapter.h)
236 
237 #endif
Vamp::HostExt::PluginWrapper
Definition: PluginWrapper.h:65
Vamp::HostExt::PluginInputDomainAdapter
Definition: PluginInputDomainAdapter.h:87
Vamp::HostExt::PluginInputDomainAdapter::WindowType
WindowType
The set of supported window shapes.
Definition: PluginInputDomainAdapter.h:196
Vamp::HostExt::PluginInputDomainAdapter::m_impl
Impl * m_impl
Definition: PluginInputDomainAdapter.h:227
Vamp::Plugin::InputDomain
InputDomain
Definition: vamp-sdk/Plugin.h:152
_VAMP_SDK_HOSTSPACE_BEGIN
#define _VAMP_SDK_HOSTSPACE_BEGIN(h)
Definition: hostguard.h:56
Vamp::HostExt::PluginInputDomainAdapter::ShiftTimestamp
@ ShiftTimestamp
Definition: PluginInputDomainAdapter.h:144
Vamp::Plugin
Definition: vamp-sdk/Plugin.h:124
Vamp::HostExt::PluginInputDomainAdapter::ShiftData
@ ShiftData
Definition: PluginInputDomainAdapter.h:145
hostguard.h
_VAMP_SDK_HOSTSPACE_END
#define _VAMP_SDK_HOSTSPACE_END(h)
Definition: hostguard.h:59
Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod
ProcessTimestampMethod
ProcessTimestampMethod determines how the PluginInputDomainAdapter handles timestamps for the data pa...
Definition: PluginInputDomainAdapter.h:143
Vamp::RealTime
Definition: vamp-sdk/RealTime.h:66
Vamp
Definition: FFT.h:43
PluginWrapper.h
Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:395