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:
96  virtual ~PluginInputDomainAdapter();
97 
98  bool initialise(size_t channels, size_t stepSize, size_t blockSize);
99  void reset();
100 
101  InputDomain getInputDomain() const;
102 
103  size_t getPreferredStepSize() const;
104  size_t getPreferredBlockSize() const;
105 
106  FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
107 
145  NoShift
146  };
147 
156  void setProcessTimestampMethod(ProcessTimestampMethod);
157 
163  ProcessTimestampMethod getProcessTimestampMethod() const;
164 
190  RealTime getTimestampAdjustment() const;
191 
195  enum WindowType {
196 
197  RectangularWindow = 0,
198 
199  BartlettWindow = 1,
200  TriangularWindow = 1,
201 
202  HammingWindow = 2,
203 
204  HanningWindow = 3,
205  HannWindow = 3,
206 
207  BlackmanWindow = 4,
208 
209  NuttallWindow = 7,
210 
211  BlackmanHarrisWindow = 8
212  };
213 
217  WindowType getWindowType() const;
218 
222  void setWindowType(WindowType type);
223 
224 
225 protected:
226  class Impl;
227  Impl *m_impl;
228 };
229 
230 }
231 
232 }
233 
235 
236 #endif
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
#define _VAMP_SDK_HOSTSPACE_BEGIN(h)
Definition: hostguard.h:56
std::map< int, FeatureList > FeatureSet
Definition: FFT.h:43
PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma...
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
WindowType
The set of supported window shapes.
PluginWrapper is a simple base class for adapter plugins.
Definition: PluginWrapper.h:62
#define _VAMP_SDK_HOSTSPACE_END(h)
Definition: hostguard.h:59
ProcessTimestampMethod
ProcessTimestampMethod determines how the PluginInputDomainAdapter handles timestamps for the data pa...