Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@6: Chris@6: Chris@1: VampPluginSDK: PluginHostAdapter.h Source File Chris@1: Chris@6: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@6:  2.7 Chris@1:
Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1:
PluginHostAdapter.h
Chris@3:
Chris@1:
Chris@6: 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_PLUGIN_HOST_ADAPTER_H_
38 #define _VAMP_PLUGIN_HOST_ADAPTER_H_
39 
40 #include "hostguard.h"
41 #include "Plugin.h"
42 
43 #include <vamp/vamp.h>
44 
45 #include <vector>
46 
47 _VAMP_SDK_HOSTSPACE_BEGIN(PluginHostAdapter.h)
48 
49 namespace Vamp {
50 
68 class PluginHostAdapter : public Plugin
69 {
70 public:
71  PluginHostAdapter(const VampPluginDescriptor *descriptor,
72  float inputSampleRate);
73  virtual ~PluginHostAdapter();
74 
75  static std::vector<std::string> getPluginPath();
76 
77  bool initialise(size_t channels, size_t stepSize, size_t blockSize);
78  void reset();
79 
80  InputDomain getInputDomain() const;
81 
82  unsigned int getVampApiVersion() const;
83  std::string getIdentifier() const;
84  std::string getName() const;
85  std::string getDescription() const;
86  std::string getMaker() const;
87  int getPluginVersion() const;
88  std::string getCopyright() const;
89 
90  ParameterList getParameterDescriptors() const;
91  float getParameter(std::string) const;
92  void setParameter(std::string, float);
93 
94  ProgramList getPrograms() const;
95  std::string getCurrentProgram() const;
96  void selectProgram(std::string);
97 
98  size_t getPreferredStepSize() const;
99  size_t getPreferredBlockSize() const;
100 
101  size_t getMinChannelCount() const;
102  size_t getMaxChannelCount() const;
103 
104  OutputList getOutputDescriptors() const;
105 
106  FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
107 
108  FeatureSet getRemainingFeatures();
109 
110 protected:
111  void convertFeatures(VampFeatureList *, FeatureSet &);
112 
113  const VampPluginDescriptor *m_descriptor;
114  VampPluginHandle m_handle;
115 };
116 
117 }
118 
119 _VAMP_SDK_HOSTSPACE_END(PluginHostAdapter.h)
120 
121 #endif
122 
123 
Vamp::Plugin::OutputList
std::vector< OutputDescriptor > OutputList
Definition: vamp-sdk/Plugin.h:335
Chris@6:
Vamp::Plugin
Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...
Definition: vamp-sdk/Plugin.h:124
Chris@6: Chris@6:
_VAMP_SDK_HOSTSPACE_BEGIN
#define _VAMP_SDK_HOSTSPACE_BEGIN(h)
Definition: hostguard.h:56
Chris@6:
Vamp::Plugin::FeatureSet
std::map< int, FeatureList > FeatureSet
Definition: vamp-sdk/Plugin.h:395
Chris@6:
Vamp
Definition: FFT.h:43
Chris@6:
_VampFeatureList
Definition: vamp.h:217
Chris@6:
_VampPluginDescriptor
Definition: vamp.h:248
Chris@6: Chris@6:
Vamp::RealTime
RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...
Definition: vamp-sdk/RealTime.h:66
Chris@6:
Vamp::PluginHostAdapter
PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...
Definition: PluginHostAdapter.h:68
Chris@6: Chris@6:
Vamp::PluginBase::ProgramList
std::vector< std::string > ProgramList
Definition: vamp-sdk/PluginBase.h:225
Chris@6: Chris@6:
VampPluginHandle
void * VampPluginHandle
Definition: vamp.h:246
Chris@6:
_VAMP_SDK_HOSTSPACE_END
#define _VAMP_SDK_HOSTSPACE_END(h)
Definition: hostguard.h:59
Chris@6:
Vamp::PluginHostAdapter::m_descriptor
const VampPluginDescriptor * m_descriptor
Definition: PluginHostAdapter.h:113
Chris@6: Chris@6:
Vamp::PluginBase::ParameterList
std::vector< ParameterDescriptor > ParameterList
Definition: vamp-sdk/PluginBase.h:203
Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@1: Chris@1: