comparison vamp-sdk/PluginHostAdapter.h @ 58:0284955e31e5 host-factory-stuff

* reshuffle
author cannam
date Thu, 24 May 2007 10:05:00 +0000
parents vamp-hostsdk/PluginHostAdapter.h@4ab6224110ef
children
comparison
equal deleted inserted replaced
57:09a1aac6c362 58:0284955e31e5
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 <vamp/vamp.h>
41 #include <vamp-sdk/Plugin.h>
42
43 #include <vector>
44
45 namespace Vamp {
46
47 /**
48 * PluginHostAdapter is a wrapper class that a Vamp host can use to
49 * make the C-language VampPluginDescriptor object appear as a C++
50 * Vamp::Plugin object.
51 *
52 * The Vamp API is defined in vamp/vamp.h as a C API. The C++ objects
53 * used for convenience by plugins and hosts actually communicate
54 * using the C low-level API, but the details of this communication
55 * are handled seamlessly by the Vamp SDK implementation provided the
56 * plugin and host use the proper C++ wrapper objects.
57 *
58 * See also PluginAdapter, the plugin-side wrapper that makes a C++
59 * plugin object available using the C query API.
60 */
61
62 class PluginHostAdapter : public Plugin
63 {
64 public:
65 PluginHostAdapter(const VampPluginDescriptor *descriptor,
66 float inputSampleRate);
67 virtual ~PluginHostAdapter();
68
69 static std::vector<std::string> getPluginPath();
70
71 bool initialise(size_t channels, size_t stepSize, size_t blockSize);
72 void reset();
73
74 InputDomain getInputDomain() const;
75
76 unsigned int getVampApiVersion() const;
77 std::string getIdentifier() const;
78 std::string getName() const;
79 std::string getDescription() const;
80 std::string getMaker() const;
81 int getPluginVersion() const;
82 std::string getCopyright() const;
83
84 ParameterList getParameterDescriptors() const;
85 float getParameter(std::string) const;
86 void setParameter(std::string, float);
87
88 ProgramList getPrograms() const;
89 std::string getCurrentProgram() const;
90 void selectProgram(std::string);
91
92 size_t getPreferredStepSize() const;
93 size_t getPreferredBlockSize() const;
94
95 size_t getMinChannelCount() const;
96 size_t getMaxChannelCount() const;
97
98 OutputList getOutputDescriptors() const;
99
100 FeatureSet process(const float *const *inputBuffers, RealTime timestamp);
101
102 FeatureSet getRemainingFeatures();
103
104 protected:
105 void convertFeatures(VampFeatureList *, FeatureSet &);
106
107 const VampPluginDescriptor *m_descriptor;
108 VampPluginHandle m_handle;
109 };
110
111 }
112
113 #endif
114
115