VampPluginSDK  2.5
vamp-sdk/Plugin.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 Chris Cannam.
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_SDK_PLUGIN_H_
38 #define _VAMP_SDK_PLUGIN_H_
39 
40 #include <string>
41 #include <vector>
42 #include <map>
43 
44 #include "PluginBase.h"
45 #include "RealTime.h"
46 
47 #include "plugguard.h"
49 
50 namespace Vamp {
51 
124 class Plugin : public PluginBase
125 {
126 public:
127  virtual ~Plugin() { }
128 
141  virtual bool initialise(size_t inputChannels,
142  size_t stepSize,
143  size_t blockSize) = 0;
144 
150  virtual void reset() = 0;
151 
152  enum InputDomain { TimeDomain, FrequencyDomain };
153 
169  virtual InputDomain getInputDomain() const = 0;
170 
179  virtual size_t getPreferredBlockSize() const { return 0; }
180 
194  virtual size_t getPreferredStepSize() const { return 0; }
195 
199  virtual size_t getMinChannelCount() const { return 1; }
200 
204  virtual size_t getMaxChannelCount() const { return 1; }
205 
207  {
214  std::string identifier;
215 
220  std::string name;
221 
227  std::string description;
228 
232  std::string unit;
233 
240 
247  size_t binCount;
248 
253  std::vector<std::string> binNames;
254 
261 
266  float minValue;
267 
272  float maxValue;
273 
279 
286 
287  enum SampleType {
288 
291 
294 
296  VariableSampleRate
297  };
298 
303 
314  float sampleRate;
315 
321 
322  OutputDescriptor() : // defaults for mandatory non-class-type members
323  hasFixedBinCount(false), hasKnownExtents(false), isQuantized(false),
324  sampleType(OneSamplePerStep), sampleRate(0), hasDuration(false) { }
325  };
326 
327  typedef std::vector<OutputDescriptor> OutputList;
328 
334  virtual OutputList getOutputDescriptors() const = 0;
335 
336  struct Feature
337  {
345 
353 
361 
368 
374  std::vector<float> values;
375 
379  std::string label;
380 
381  Feature() : // defaults for mandatory non-class-type members
382  hasTimestamp(false), hasDuration(false) { }
383  };
384 
385  typedef std::vector<Feature> FeatureList;
386 
387  typedef std::map<int, FeatureList> FeatureSet; // key is output no
388 
416  virtual FeatureSet process(const float *const *inputBuffers,
417  RealTime timestamp) = 0;
418 
423  virtual FeatureSet getRemainingFeatures() = 0;
424 
430  virtual std::string getType() const { return "Feature Extraction Plugin"; }
431 
432 protected:
433  Plugin(float inputSampleRate) :
434  m_inputSampleRate(inputSampleRate) { }
435 
437 };
438 
439 }
440 
441 _VAMP_SDK_PLUGSPACE_END(Plugin.h)
442 
443 #endif
444 
445 
446