|
cannam@0
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
cannam@0
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
cannam@0
|
3 <title>VampPluginSDK: Vamp::HostExt::PluginChannelAdapter Class Reference</title>
|
|
cannam@0
|
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
cannam@0
|
5 <link href="tabs.css" rel="stylesheet" type="text/css">
|
|
cannam@0
|
6 </head><body>
|
|
cannam@21
|
7 <!-- Generated by Doxygen 1.5.6 -->
|
|
cannam@0
|
8 <div class="navigation" id="top">
|
|
cannam@0
|
9 <div class="tabs">
|
|
cannam@0
|
10 <ul>
|
|
cannam@0
|
11 <li><a href="main.html"><span>Main Page</span></a></li>
|
|
cannam@0
|
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
cannam@0
|
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
cannam@0
|
14 <li><a href="files.html"><span>Files</span></a></li>
|
|
cannam@0
|
15 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
cannam@0
|
16 </ul>
|
|
cannam@0
|
17 </div>
|
|
cannam@0
|
18 <div class="tabs">
|
|
cannam@0
|
19 <ul>
|
|
cannam@0
|
20 <li><a href="annotated.html"><span>Class List</span></a></li>
|
|
cannam@0
|
21 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
cannam@0
|
22 <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
cannam@0
|
23 </ul>
|
|
cannam@0
|
24 </div>
|
|
cannam@0
|
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html">PluginChannelAdapter</a>
|
|
cannam@0
|
26 </div>
|
|
cannam@0
|
27 </div>
|
|
cannam@0
|
28 <div class="contents">
|
|
cannam@21
|
29 <h1>Vamp::HostExt::PluginChannelAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginChannelAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><code>#include <<a class="el" href="PluginChannelAdapter_8h-source.html">vamp-hostsdk/PluginChannelAdapter.h</a>></code>
|
|
cannam@0
|
30 <p>
|
|
cannam@0
|
31 <div class="dynheader">
|
|
cannam@0
|
32 Inheritance diagram for Vamp::HostExt::PluginChannelAdapter:</div>
|
|
cannam@0
|
33 <div class="dynsection">
|
|
cannam@0
|
34 <p><center><img src="classVamp_1_1HostExt_1_1PluginChannelAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginChannelAdapter__inherit__map" alt="Inheritance graph"></center>
|
|
cannam@0
|
35 <map name="Vamp_1_1HostExt_1_1PluginChannelAdapter__inherit__map">
|
|
cannam@21
|
36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="28,154,228,181"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="79,80,177,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="64,5,192,32"></map>
|
|
cannam@0
|
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
|
|
cannam@0
|
38
|
|
cannam@0
|
39 <p>
|
|
cannam@0
|
40 <a href="classVamp_1_1HostExt_1_1PluginChannelAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
cannam@21
|
41 <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data.
|
|
cannam@0
|
42 <p>
|
|
cannam@0
|
43 A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> may ignore the getMinChannelCount and getMaxChannelCount reported by the plugin, and still expect the plugin to run.<p>
|
|
cannam@0
|
44 <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> implements the following policy:<p>
|
|
cannam@0
|
45 <ul>
|
|
cannam@0
|
46 <li>If the plugin supports the provided number of channels directly, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> will just run the plugin as normal.</li></ul>
|
|
cannam@0
|
47 <p>
|
|
cannam@0
|
48 <ul>
|
|
cannam@0
|
49 <li>If the plugin only supports exactly one channel but more than one channel is provided, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> will use the mean of the channels. This ensures that the resulting values remain within the same magnitude range as expected for mono data.</li></ul>
|
|
cannam@0
|
50 <p>
|
|
cannam@0
|
51 <ul>
|
|
cannam@0
|
52 <li>If the plugin requires more than one channel but exactly one is provided, the provided channel will be duplicated across all the plugin input channels.</li></ul>
|
|
cannam@0
|
53 <p>
|
|
cannam@0
|
54 If none of the above apply:<p>
|
|
cannam@0
|
55 <ul>
|
|
cannam@0
|
56 <li>If the plugin requires more channels than are provided, the minimum acceptable number of channels will be produced by adding empty (zero valued) channels to those provided.</li></ul>
|
|
cannam@0
|
57 <p>
|
|
cannam@0
|
58 <ul>
|
|
cannam@0
|
59 <li>If the plugin requires fewer channels than are provided, the maximum acceptable number of channels will be produced by discarding the excess channels.</li></ul>
|
|
cannam@0
|
60 <p>
|
|
cannam@0
|
61 Hosts requiring a different channel policy from the above will need to implement it themselves, instead of using <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a>.<p>
|
|
cannam@0
|
62 Note that <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> does not override the minimum and maximum channel counts returned by the wrapped plugin. The host will need to be aware that it is using a <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a>, and be prepared to ignore these counts as necessary. (This contrasts with the approach used in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a>, which aims to make the host completely unaware of which underlying input domain is in fact in use.)<p>
|
|
cannam@0
|
63 (The rationale for this is that a host may wish to use the <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> but still discriminate in some way on the basis of the number of channels actually supported. For example, a simple stereo audio host may prefer to reject plugins that require more than two channels on the grounds that doesn't actually understand what they are for, rather than allow the channel adapter to make a potentially meaningless channel conversion for them.)<p>
|
|
cannam@0
|
64 In every respect other than its management of channels, the <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.<p>
|
|
cannam@21
|
65 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
|
|
cannam@0
|
66
|
|
cannam@21
|
67 <p>Definition at line <a class="el" href="PluginChannelAdapter_8h-source.html#l00112">112</a> of file <a class="el" href="PluginChannelAdapter_8h-source.html">PluginChannelAdapter.h</a>.</p>
|
|
cannam@0
|
68 <table border="0" cellpadding="0" cellspacing="0">
|
|
cannam@0
|
69 <tr><td></td></tr>
|
|
cannam@0
|
70 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
|
|
cannam@0
|
71 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
|
|
cannam@0
|
72 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
|
|
cannam@0
|
73 }</td></tr>
|
|
cannam@0
|
74
|
|
cannam@0
|
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
|
|
cannam@0
|
76 < <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
|
|
cannam@0
|
77
|
|
cannam@0
|
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
|
|
cannam@0
|
79
|
|
cannam@0
|
80 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map< int, <br>
|
|
cannam@0
|
81 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
|
|
cannam@0
|
82
|
|
cannam@0
|
83 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
|
|
cannam@0
|
84 < <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
|
|
cannam@0
|
85
|
|
cannam@0
|
86 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
|
|
cannam@0
|
87
|
|
cannam@0
|
88 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
cannam@0
|
89 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#2cda2b672708264f9a33c43bad3acdd8">PluginChannelAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
|
|
cannam@0
|
90
|
|
cannam@21
|
91 <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> wrapping the given plugin. <a href="#2cda2b672708264f9a33c43bad3acdd8"></a><br></td></tr>
|
|
cannam@21
|
92 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#cb9a20fefd130e323b1eb2ced43e521c">~PluginChannelAdapter</a> ()</td></tr>
|
|
cannam@0
|
93
|
|
cannam@0
|
94 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
|
|
cannam@0
|
95
|
|
cannam@0
|
96 <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#de0473c8fc54636431967cbf41649c1c"></a><br></td></tr>
|
|
cannam@21
|
97 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#6ff37bf754ff8711dbcb2f020fa3902c">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
|
|
cannam@0
|
98
|
|
cannam@21
|
99 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#6ff37bf754ff8711dbcb2f020fa3902c"></a><br></td></tr>
|
|
cannam@21
|
100 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#5c94c3eb1dbc8899fe58527bbb7bb61f">processInterleaved</a> (const float *inputBuffer, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
|
|
cannam@21
|
101
|
|
cannam@21
|
102 <tr><td class="mdescLeft"> </td><td class="mdescRight">Call <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#6ff37bf754ff8711dbcb2f020fa3902c" title="Process a single block of input data.">process()</a>, providing interleaved audio data with the number of channels passed to <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>. <a href="#5c94c3eb1dbc8899fe58527bbb7bb61f"></a><br></td></tr>
|
|
cannam@0
|
103 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
|
|
cannam@0
|
104
|
|
cannam@0
|
105 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr>
|
|
cannam@21
|
106 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr>
|
|
cannam@0
|
107
|
|
cannam@21
|
108 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#e203faf8384c9e1fddc381409aa8a214"></a><br></td></tr>
|
|
cannam@0
|
109 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
|
|
cannam@0
|
110
|
|
cannam@21
|
111 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr>
|
|
cannam@0
|
112 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
|
|
cannam@0
|
113
|
|
cannam@0
|
114 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
|
|
cannam@0
|
115 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
|
|
cannam@0
|
116
|
|
cannam@0
|
117 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c70a3265bb25aeb03f6dd8f8a0442088"></a><br></td></tr>
|
|
cannam@0
|
118 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
|
|
cannam@0
|
119
|
|
cannam@0
|
120 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#c334f699c0996055942785410d8a065c"></a><br></td></tr>
|
|
cannam@0
|
121 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
|
|
cannam@0
|
122
|
|
cannam@0
|
123 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#59d5a2298951b317995675e664b1c7bb"></a><br></td></tr>
|
|
cannam@0
|
124 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
|
|
cannam@0
|
125
|
|
cannam@0
|
126 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
|
|
cannam@0
|
127 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
|
|
cannam@0
|
128
|
|
cannam@0
|
129 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr>
|
|
cannam@21
|
130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr>
|
|
cannam@0
|
131
|
|
cannam@21
|
132 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr>
|
|
cannam@0
|
133 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
|
|
cannam@0
|
134
|
|
cannam@0
|
135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
|
|
cannam@0
|
136 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
|
|
cannam@0
|
137
|
|
cannam@0
|
138 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
|
|
cannam@21
|
139 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr>
|
|
cannam@0
|
140
|
|
cannam@21
|
141 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr>
|
|
cannam@0
|
142 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
|
|
cannam@0
|
143
|
|
cannam@0
|
144 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
|
|
cannam@0
|
145 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
|
|
cannam@0
|
146
|
|
cannam@0
|
147 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
|
|
cannam@0
|
148 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr>
|
|
cannam@0
|
149
|
|
cannam@21
|
150 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr>
|
|
cannam@0
|
151 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr>
|
|
cannam@0
|
152
|
|
cannam@21
|
153 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr>
|
|
cannam@0
|
154 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
|
|
cannam@0
|
155
|
|
cannam@0
|
156 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
|
|
cannam@0
|
157 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
|
|
cannam@0
|
158
|
|
cannam@0
|
159 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
|
|
cannam@21
|
160 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr>
|
|
cannam@0
|
161
|
|
cannam@21
|
162 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
|
|
cannam@21
|
163 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr>
|
|
cannam@0
|
164
|
|
cannam@21
|
165 <tr><td class="mdescLeft"> </td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#2bc8c0992e64f06991fb7cf89f99857e"></a><br></td></tr>
|
|
cannam@21
|
166 <tr><td class="memTemplParams" nowrap colspan="2">template<typename WrapperType> </td></tr>
|
|
cannam@21
|
167 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">WrapperType * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">getWrapper</a> ()</td></tr>
|
|
cannam@21
|
168
|
|
cannam@21
|
169 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#e9d79bed7237d55a73018a6b982a55b3"></a><br></td></tr>
|
|
cannam@0
|
170 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
|
|
cannam@0
|
171
|
|
cannam@0
|
172 <tr><td class="mdescLeft"> </td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
|
|
cannam@0
|
173 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
|
|
cannam@21
|
174 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#e3a74a2e6c4cd33dce9f4248e73c6701">m_impl</a></td></tr>
|
|
cannam@0
|
175
|
|
cannam@0
|
176 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
|
|
cannam@0
|
177
|
|
cannam@0
|
178 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
|
|
cannam@0
|
179
|
|
cannam@0
|
180 </table>
|
|
cannam@0
|
181 <hr><h2>Member Typedef Documentation</h2>
|
|
cannam@0
|
182 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
|
|
cannam@0
|
183 <div class="memitem">
|
|
cannam@0
|
184 <div class="memproto">
|
|
cannam@0
|
185 <table class="memname">
|
|
cannam@0
|
186 <tr>
|
|
cannam@0
|
187 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>> <a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
188 </tr>
|
|
cannam@0
|
189 </table>
|
|
cannam@0
|
190 </div>
|
|
cannam@0
|
191 <div class="memdoc">
|
|
cannam@0
|
192
|
|
cannam@0
|
193 <p>
|
|
cannam@0
|
194
|
|
cannam@21
|
195 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
196
|
|
cannam@0
|
197 </div>
|
|
cannam@0
|
198 </div><p>
|
|
cannam@0
|
199 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
|
|
cannam@0
|
200 <div class="memitem">
|
|
cannam@0
|
201 <div class="memproto">
|
|
cannam@0
|
202 <table class="memname">
|
|
cannam@0
|
203 <tr>
|
|
cannam@0
|
204 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>> <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
205 </tr>
|
|
cannam@0
|
206 </table>
|
|
cannam@0
|
207 </div>
|
|
cannam@0
|
208 <div class="memdoc">
|
|
cannam@0
|
209
|
|
cannam@0
|
210 <p>
|
|
cannam@0
|
211
|
|
cannam@21
|
212 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00380">380</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
213
|
|
cannam@0
|
214 </div>
|
|
cannam@0
|
215 </div><p>
|
|
cannam@0
|
216 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
|
|
cannam@0
|
217 <div class="memitem">
|
|
cannam@0
|
218 <div class="memproto">
|
|
cannam@0
|
219 <table class="memname">
|
|
cannam@0
|
220 <tr>
|
|
cannam@0
|
221 <td class="memname">typedef std::map<int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>> <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
|
|
cannam@0
|
222 </tr>
|
|
cannam@0
|
223 </table>
|
|
cannam@0
|
224 </div>
|
|
cannam@0
|
225 <div class="memdoc">
|
|
cannam@0
|
226
|
|
cannam@0
|
227 <p>
|
|
cannam@0
|
228
|
|
cannam@21
|
229 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
230
|
|
cannam@0
|
231 </div>
|
|
cannam@0
|
232 </div><p>
|
|
cannam@0
|
233 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
|
|
cannam@0
|
234 <div class="memitem">
|
|
cannam@0
|
235 <div class="memproto">
|
|
cannam@0
|
236 <table class="memname">
|
|
cannam@0
|
237 <tr>
|
|
cannam@0
|
238 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>> <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
239 </tr>
|
|
cannam@0
|
240 </table>
|
|
cannam@0
|
241 </div>
|
|
cannam@0
|
242 <div class="memdoc">
|
|
cannam@0
|
243
|
|
cannam@0
|
244 <p>
|
|
cannam@0
|
245
|
|
cannam@21
|
246 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
cannam@0
|
247
|
|
cannam@0
|
248 </div>
|
|
cannam@0
|
249 </div><p>
|
|
cannam@0
|
250 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
|
|
cannam@0
|
251 <div class="memitem">
|
|
cannam@0
|
252 <div class="memproto">
|
|
cannam@0
|
253 <table class="memname">
|
|
cannam@0
|
254 <tr>
|
|
cannam@0
|
255 <td class="memname">typedef std::vector<std::string> <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
256 </tr>
|
|
cannam@0
|
257 </table>
|
|
cannam@0
|
258 </div>
|
|
cannam@0
|
259 <div class="memdoc">
|
|
cannam@0
|
260
|
|
cannam@0
|
261 <p>
|
|
cannam@0
|
262
|
|
cannam@21
|
263 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
cannam@0
|
264
|
|
cannam@0
|
265 </div>
|
|
cannam@0
|
266 </div><p>
|
|
cannam@0
|
267 <hr><h2>Member Enumeration Documentation</h2>
|
|
cannam@0
|
268 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
|
|
cannam@0
|
269 <div class="memitem">
|
|
cannam@0
|
270 <div class="memproto">
|
|
cannam@0
|
271 <table class="memname">
|
|
cannam@0
|
272 <tr>
|
|
cannam@0
|
273 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
|
|
cannam@0
|
274 </tr>
|
|
cannam@0
|
275 </table>
|
|
cannam@0
|
276 </div>
|
|
cannam@0
|
277 <div class="memdoc">
|
|
cannam@0
|
278
|
|
cannam@0
|
279 <p>
|
|
cannam@0
|
280 <dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
cannam@0
|
281 <table border="0" cellspacing="2" cellpadding="0">
|
|
cannam@0
|
282 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td>
|
|
cannam@0
|
283 </td></tr>
|
|
cannam@0
|
284 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td>
|
|
cannam@0
|
285 </td></tr>
|
|
cannam@0
|
286 </table>
|
|
cannam@0
|
287 </dl>
|
|
cannam@0
|
288
|
|
cannam@21
|
289 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
290
|
|
cannam@0
|
291 </div>
|
|
cannam@0
|
292 </div><p>
|
|
cannam@0
|
293 <hr><h2>Constructor & Destructor Documentation</h2>
|
|
cannam@0
|
294 <a class="anchor" name="2cda2b672708264f9a33c43bad3acdd8"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::PluginChannelAdapter" ref="2cda2b672708264f9a33c43bad3acdd8" args="(Plugin *plugin)" -->
|
|
cannam@0
|
295 <div class="memitem">
|
|
cannam@0
|
296 <div class="memproto">
|
|
cannam@0
|
297 <table class="memname">
|
|
cannam@0
|
298 <tr>
|
|
cannam@0
|
299 <td class="memname">Vamp::HostExt::PluginChannelAdapter::PluginChannelAdapter </td>
|
|
cannam@0
|
300 <td>(</td>
|
|
cannam@0
|
301 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td>
|
|
cannam@0
|
302 <td class="paramname"> <em>plugin</em> </td>
|
|
cannam@0
|
303 <td> ) </td>
|
|
cannam@21
|
304 <td></td>
|
|
cannam@0
|
305 </tr>
|
|
cannam@0
|
306 </table>
|
|
cannam@0
|
307 </div>
|
|
cannam@0
|
308 <div class="memdoc">
|
|
cannam@0
|
309
|
|
cannam@0
|
310 <p>
|
|
cannam@21
|
311 Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management...">PluginChannelAdapter</a> wrapping the given plugin.
|
|
cannam@21
|
312 <p>
|
|
cannam@21
|
313 The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted.
|
|
cannam@0
|
314 </div>
|
|
cannam@0
|
315 </div><p>
|
|
cannam@21
|
316 <a class="anchor" name="cb9a20fefd130e323b1eb2ced43e521c"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::~PluginChannelAdapter" ref="cb9a20fefd130e323b1eb2ced43e521c" args="()" -->
|
|
cannam@0
|
317 <div class="memitem">
|
|
cannam@0
|
318 <div class="memproto">
|
|
cannam@0
|
319 <table class="memname">
|
|
cannam@0
|
320 <tr>
|
|
cannam@21
|
321 <td class="memname">virtual Vamp::HostExt::PluginChannelAdapter::~PluginChannelAdapter </td>
|
|
cannam@0
|
322 <td>(</td>
|
|
cannam@0
|
323 <td class="paramname"> </td>
|
|
cannam@0
|
324 <td> ) </td>
|
|
cannam@21
|
325 <td><code> [virtual]</code></td>
|
|
cannam@0
|
326 </tr>
|
|
cannam@0
|
327 </table>
|
|
cannam@0
|
328 </div>
|
|
cannam@0
|
329 <div class="memdoc">
|
|
cannam@0
|
330
|
|
cannam@0
|
331 <p>
|
|
cannam@0
|
332
|
|
cannam@0
|
333 </div>
|
|
cannam@0
|
334 </div><p>
|
|
cannam@0
|
335 <hr><h2>Member Function Documentation</h2>
|
|
cannam@0
|
336 <a class="anchor" name="de0473c8fc54636431967cbf41649c1c"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::initialise" ref="de0473c8fc54636431967cbf41649c1c" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
|
|
cannam@0
|
337 <div class="memitem">
|
|
cannam@0
|
338 <div class="memproto">
|
|
cannam@0
|
339 <table class="memname">
|
|
cannam@0
|
340 <tr>
|
|
cannam@0
|
341 <td class="memname">bool Vamp::HostExt::PluginChannelAdapter::initialise </td>
|
|
cannam@0
|
342 <td>(</td>
|
|
cannam@0
|
343 <td class="paramtype">size_t </td>
|
|
cannam@0
|
344 <td class="paramname"> <em>inputChannels</em>, </td>
|
|
cannam@0
|
345 </tr>
|
|
cannam@0
|
346 <tr>
|
|
cannam@0
|
347 <td class="paramkey"></td>
|
|
cannam@0
|
348 <td></td>
|
|
cannam@0
|
349 <td class="paramtype">size_t </td>
|
|
cannam@0
|
350 <td class="paramname"> <em>stepSize</em>, </td>
|
|
cannam@0
|
351 </tr>
|
|
cannam@0
|
352 <tr>
|
|
cannam@0
|
353 <td class="paramkey"></td>
|
|
cannam@0
|
354 <td></td>
|
|
cannam@0
|
355 <td class="paramtype">size_t </td>
|
|
cannam@0
|
356 <td class="paramname"> <em>blockSize</em></td><td> </td>
|
|
cannam@0
|
357 </tr>
|
|
cannam@0
|
358 <tr>
|
|
cannam@0
|
359 <td></td>
|
|
cannam@0
|
360 <td>)</td>
|
|
cannam@21
|
361 <td></td><td></td><td><code> [virtual]</code></td>
|
|
cannam@0
|
362 </tr>
|
|
cannam@0
|
363 </table>
|
|
cannam@0
|
364 </div>
|
|
cannam@0
|
365 <div class="memdoc">
|
|
cannam@0
|
366
|
|
cannam@0
|
367 <p>
|
|
cannam@0
|
368 Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).
|
|
cannam@0
|
369 <p>
|
|
cannam@0
|
370 The input sample rate should have been already specified at construction time.<p>
|
|
cannam@0
|
371 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
|
|
cannam@0
|
372 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
373
|
|
cannam@0
|
374 </div>
|
|
cannam@0
|
375 </div><p>
|
|
cannam@21
|
376 <a class="anchor" name="6ff37bf754ff8711dbcb2f020fa3902c"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::process" ref="6ff37bf754ff8711dbcb2f020fa3902c" args="(const float *const *inputBuffers, RealTime timestamp)" -->
|
|
cannam@0
|
377 <div class="memitem">
|
|
cannam@0
|
378 <div class="memproto">
|
|
cannam@0
|
379 <table class="memname">
|
|
cannam@0
|
380 <tr>
|
|
cannam@21
|
381 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginChannelAdapter::process </td>
|
|
cannam@0
|
382 <td>(</td>
|
|
cannam@0
|
383 <td class="paramtype">const float *const * </td>
|
|
cannam@0
|
384 <td class="paramname"> <em>inputBuffers</em>, </td>
|
|
cannam@0
|
385 </tr>
|
|
cannam@0
|
386 <tr>
|
|
cannam@0
|
387 <td class="paramkey"></td>
|
|
cannam@0
|
388 <td></td>
|
|
cannam@0
|
389 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td>
|
|
cannam@0
|
390 <td class="paramname"> <em>timestamp</em></td><td> </td>
|
|
cannam@0
|
391 </tr>
|
|
cannam@0
|
392 <tr>
|
|
cannam@0
|
393 <td></td>
|
|
cannam@0
|
394 <td>)</td>
|
|
cannam@21
|
395 <td></td><td></td><td><code> [virtual]</code></td>
|
|
cannam@0
|
396 </tr>
|
|
cannam@0
|
397 </table>
|
|
cannam@0
|
398 </div>
|
|
cannam@0
|
399 <div class="memdoc">
|
|
cannam@0
|
400
|
|
cannam@0
|
401 <p>
|
|
cannam@0
|
402 Process a single block of input data.
|
|
cannam@0
|
403 <p>
|
|
cannam@21
|
404 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.<p>
|
|
cannam@0
|
405 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p>
|
|
cannam@0
|
406 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)
|
|
cannam@21
|
407 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
408
|
|
cannam@21
|
409 </div>
|
|
cannam@21
|
410 </div><p>
|
|
cannam@21
|
411 <a class="anchor" name="5c94c3eb1dbc8899fe58527bbb7bb61f"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::processInterleaved" ref="5c94c3eb1dbc8899fe58527bbb7bb61f" args="(const float *inputBuffer, RealTime timestamp)" -->
|
|
cannam@21
|
412 <div class="memitem">
|
|
cannam@21
|
413 <div class="memproto">
|
|
cannam@21
|
414 <table class="memname">
|
|
cannam@21
|
415 <tr>
|
|
cannam@21
|
416 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginChannelAdapter::processInterleaved </td>
|
|
cannam@21
|
417 <td>(</td>
|
|
cannam@21
|
418 <td class="paramtype">const float * </td>
|
|
cannam@21
|
419 <td class="paramname"> <em>inputBuffer</em>, </td>
|
|
cannam@21
|
420 </tr>
|
|
cannam@21
|
421 <tr>
|
|
cannam@21
|
422 <td class="paramkey"></td>
|
|
cannam@21
|
423 <td></td>
|
|
cannam@21
|
424 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td>
|
|
cannam@21
|
425 <td class="paramname"> <em>timestamp</em></td><td> </td>
|
|
cannam@21
|
426 </tr>
|
|
cannam@21
|
427 <tr>
|
|
cannam@21
|
428 <td></td>
|
|
cannam@21
|
429 <td>)</td>
|
|
cannam@21
|
430 <td></td><td></td><td></td>
|
|
cannam@21
|
431 </tr>
|
|
cannam@21
|
432 </table>
|
|
cannam@21
|
433 </div>
|
|
cannam@21
|
434 <div class="memdoc">
|
|
cannam@0
|
435
|
|
cannam@21
|
436 <p>
|
|
cannam@21
|
437 Call <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#6ff37bf754ff8711dbcb2f020fa3902c" title="Process a single block of input data.">process()</a>, providing interleaved audio data with the number of channels passed to <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.
|
|
cannam@21
|
438 <p>
|
|
cannam@21
|
439 The adapter will de-interleave into temporary buffers as appropriate before calling <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#6ff37bf754ff8711dbcb2f020fa3902c" title="Process a single block of input data.">process()</a>.<p>
|
|
cannam@21
|
440 <dl class="note" compact><dt><b>Note:</b></dt><dd>This function was introduced in version 1.4 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
|
|
cannam@0
|
441
|
|
cannam@0
|
442 </div>
|
|
cannam@0
|
443 </div><p>
|
|
cannam@0
|
444 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" -->
|
|
cannam@0
|
445 <div class="memitem">
|
|
cannam@0
|
446 <div class="memproto">
|
|
cannam@0
|
447 <table class="memname">
|
|
cannam@0
|
448 <tr>
|
|
cannam@0
|
449 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
|
|
cannam@0
|
450 <td>(</td>
|
|
cannam@0
|
451 <td class="paramname"> </td>
|
|
cannam@0
|
452 <td> ) </td>
|
|
cannam@21
|
453 <td><code> [virtual, inherited]</code></td>
|
|
cannam@0
|
454 </tr>
|
|
cannam@0
|
455 </table>
|
|
cannam@0
|
456 </div>
|
|
cannam@0
|
457 <div class="memdoc">
|
|
cannam@0
|
458
|
|
cannam@0
|
459 <p>
|
|
cannam@0
|
460 Reset the plugin after use, to prepare it for another clean run.
|
|
cannam@0
|
461 <p>
|
|
cannam@0
|
462 Not called for the first initialisation (i.e. initialise must also do a reset).
|
|
cannam@0
|
463 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
464
|
|
cannam@0
|
465 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
466
|
|
cannam@0
|
467 </div>
|
|
cannam@0
|
468 </div><p>
|
|
cannam@21
|
469 <a class="anchor" name="e203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getInputDomain" ref="e203faf8384c9e1fddc381409aa8a214" args="() const " -->
|
|
cannam@0
|
470 <div class="memitem">
|
|
cannam@0
|
471 <div class="memproto">
|
|
cannam@0
|
472 <table class="memname">
|
|
cannam@0
|
473 <tr>
|
|
cannam@21
|
474 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
|
|
cannam@0
|
475 <td>(</td>
|
|
cannam@0
|
476 <td class="paramname"> </td>
|
|
cannam@0
|
477 <td> ) </td>
|
|
cannam@21
|
478 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
479 </tr>
|
|
cannam@0
|
480 </table>
|
|
cannam@0
|
481 </div>
|
|
cannam@0
|
482 <div class="memdoc">
|
|
cannam@0
|
483
|
|
cannam@0
|
484 <p>
|
|
cannam@0
|
485 Get the plugin's required input domain.
|
|
cannam@0
|
486 <p>
|
|
cannam@21
|
487 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
|
|
cannam@0
|
488 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
489
|
|
cannam@21
|
490 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
491
|
|
cannam@0
|
492 </div>
|
|
cannam@0
|
493 </div><p>
|
|
cannam@0
|
494 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
|
|
cannam@0
|
495 <div class="memitem">
|
|
cannam@0
|
496 <div class="memproto">
|
|
cannam@0
|
497 <table class="memname">
|
|
cannam@0
|
498 <tr>
|
|
cannam@0
|
499 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
|
|
cannam@0
|
500 <td>(</td>
|
|
cannam@0
|
501 <td class="paramname"> </td>
|
|
cannam@0
|
502 <td> ) </td>
|
|
cannam@21
|
503 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
504 </tr>
|
|
cannam@0
|
505 </table>
|
|
cannam@0
|
506 </div>
|
|
cannam@0
|
507 <div class="memdoc">
|
|
cannam@0
|
508
|
|
cannam@0
|
509 <p>
|
|
cannam@21
|
510 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
|
|
cannam@0
|
511 <p>
|
|
cannam@0
|
512
|
|
cannam@0
|
513 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
514
|
|
cannam@0
|
515 </div>
|
|
cannam@0
|
516 </div><p>
|
|
cannam@0
|
517 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
|
|
cannam@0
|
518 <div class="memitem">
|
|
cannam@0
|
519 <div class="memproto">
|
|
cannam@0
|
520 <table class="memname">
|
|
cannam@0
|
521 <tr>
|
|
cannam@0
|
522 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
|
|
cannam@0
|
523 <td>(</td>
|
|
cannam@0
|
524 <td class="paramname"> </td>
|
|
cannam@0
|
525 <td> ) </td>
|
|
cannam@21
|
526 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
527 </tr>
|
|
cannam@0
|
528 </table>
|
|
cannam@0
|
529 </div>
|
|
cannam@0
|
530 <div class="memdoc">
|
|
cannam@0
|
531
|
|
cannam@0
|
532 <p>
|
|
cannam@0
|
533 Get the computer-usable name of the plugin.
|
|
cannam@0
|
534 <p>
|
|
cannam@0
|
535 This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.<p>
|
|
cannam@0
|
536 This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).<p>
|
|
cannam@0
|
537 Example: "zero_crossings"
|
|
cannam@0
|
538 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
539
|
|
cannam@0
|
540 </div>
|
|
cannam@0
|
541 </div><p>
|
|
cannam@0
|
542 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
|
|
cannam@0
|
543 <div class="memitem">
|
|
cannam@0
|
544 <div class="memproto">
|
|
cannam@0
|
545 <table class="memname">
|
|
cannam@0
|
546 <tr>
|
|
cannam@0
|
547 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
|
|
cannam@0
|
548 <td>(</td>
|
|
cannam@0
|
549 <td class="paramname"> </td>
|
|
cannam@0
|
550 <td> ) </td>
|
|
cannam@21
|
551 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
552 </tr>
|
|
cannam@0
|
553 </table>
|
|
cannam@0
|
554 </div>
|
|
cannam@0
|
555 <div class="memdoc">
|
|
cannam@0
|
556
|
|
cannam@0
|
557 <p>
|
|
cannam@0
|
558 Get a human-readable name or title of the plugin.
|
|
cannam@0
|
559 <p>
|
|
cannam@0
|
560 This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").<p>
|
|
cannam@0
|
561 Example: "Zero Crossings"
|
|
cannam@0
|
562 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
563
|
|
cannam@0
|
564 </div>
|
|
cannam@0
|
565 </div><p>
|
|
cannam@0
|
566 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
|
|
cannam@0
|
567 <div class="memitem">
|
|
cannam@0
|
568 <div class="memproto">
|
|
cannam@0
|
569 <table class="memname">
|
|
cannam@0
|
570 <tr>
|
|
cannam@0
|
571 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
|
|
cannam@0
|
572 <td>(</td>
|
|
cannam@0
|
573 <td class="paramname"> </td>
|
|
cannam@0
|
574 <td> ) </td>
|
|
cannam@21
|
575 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
576 </tr>
|
|
cannam@0
|
577 </table>
|
|
cannam@0
|
578 </div>
|
|
cannam@0
|
579 <div class="memdoc">
|
|
cannam@0
|
580
|
|
cannam@0
|
581 <p>
|
|
cannam@0
|
582 Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".
|
|
cannam@0
|
583 <p>
|
|
cannam@0
|
584 May be empty if the name has said it all already.<p>
|
|
cannam@0
|
585 Example: "Detect and count zero crossing points"
|
|
cannam@0
|
586 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
587
|
|
cannam@0
|
588 </div>
|
|
cannam@0
|
589 </div><p>
|
|
cannam@0
|
590 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
|
|
cannam@0
|
591 <div class="memitem">
|
|
cannam@0
|
592 <div class="memproto">
|
|
cannam@0
|
593 <table class="memname">
|
|
cannam@0
|
594 <tr>
|
|
cannam@0
|
595 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
|
|
cannam@0
|
596 <td>(</td>
|
|
cannam@0
|
597 <td class="paramname"> </td>
|
|
cannam@0
|
598 <td> ) </td>
|
|
cannam@21
|
599 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
600 </tr>
|
|
cannam@0
|
601 </table>
|
|
cannam@0
|
602 </div>
|
|
cannam@0
|
603 <div class="memdoc">
|
|
cannam@0
|
604
|
|
cannam@0
|
605 <p>
|
|
cannam@0
|
606 Get the name of the author or vendor of the plugin in human-readable form.
|
|
cannam@0
|
607 <p>
|
|
cannam@0
|
608 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
|
|
cannam@0
|
609 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
610
|
|
cannam@0
|
611 </div>
|
|
cannam@0
|
612 </div><p>
|
|
cannam@0
|
613 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
|
|
cannam@0
|
614 <div class="memitem">
|
|
cannam@0
|
615 <div class="memproto">
|
|
cannam@0
|
616 <table class="memname">
|
|
cannam@0
|
617 <tr>
|
|
cannam@0
|
618 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
|
|
cannam@0
|
619 <td>(</td>
|
|
cannam@0
|
620 <td class="paramname"> </td>
|
|
cannam@0
|
621 <td> ) </td>
|
|
cannam@21
|
622 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
623 </tr>
|
|
cannam@0
|
624 </table>
|
|
cannam@0
|
625 </div>
|
|
cannam@0
|
626 <div class="memdoc">
|
|
cannam@0
|
627
|
|
cannam@0
|
628 <p>
|
|
cannam@0
|
629 Get the version number of the plugin.
|
|
cannam@0
|
630 <p>
|
|
cannam@0
|
631
|
|
cannam@0
|
632 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
633
|
|
cannam@0
|
634 </div>
|
|
cannam@0
|
635 </div><p>
|
|
cannam@0
|
636 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
|
|
cannam@0
|
637 <div class="memitem">
|
|
cannam@0
|
638 <div class="memproto">
|
|
cannam@0
|
639 <table class="memname">
|
|
cannam@0
|
640 <tr>
|
|
cannam@0
|
641 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
|
|
cannam@0
|
642 <td>(</td>
|
|
cannam@0
|
643 <td class="paramname"> </td>
|
|
cannam@0
|
644 <td> ) </td>
|
|
cannam@21
|
645 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
646 </tr>
|
|
cannam@0
|
647 </table>
|
|
cannam@0
|
648 </div>
|
|
cannam@0
|
649 <div class="memdoc">
|
|
cannam@0
|
650
|
|
cannam@0
|
651 <p>
|
|
cannam@0
|
652 Get the copyright statement or licensing summary for the plugin.
|
|
cannam@0
|
653 <p>
|
|
cannam@0
|
654 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
|
|
cannam@0
|
655 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
656
|
|
cannam@0
|
657 </div>
|
|
cannam@0
|
658 </div><p>
|
|
cannam@21
|
659 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
|
|
cannam@0
|
660 <div class="memitem">
|
|
cannam@0
|
661 <div class="memproto">
|
|
cannam@0
|
662 <table class="memname">
|
|
cannam@0
|
663 <tr>
|
|
cannam@21
|
664 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
|
|
cannam@0
|
665 <td>(</td>
|
|
cannam@0
|
666 <td class="paramname"> </td>
|
|
cannam@0
|
667 <td> ) </td>
|
|
cannam@21
|
668 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
669 </tr>
|
|
cannam@0
|
670 </table>
|
|
cannam@0
|
671 </div>
|
|
cannam@0
|
672 <div class="memdoc">
|
|
cannam@0
|
673
|
|
cannam@0
|
674 <p>
|
|
cannam@0
|
675 Get the controllable parameters of this plugin.
|
|
cannam@0
|
676 <p>
|
|
cannam@0
|
677
|
|
cannam@0
|
678 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
679
|
|
cannam@0
|
680 </div>
|
|
cannam@0
|
681 </div><p>
|
|
cannam@0
|
682 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
|
|
cannam@0
|
683 <div class="memitem">
|
|
cannam@0
|
684 <div class="memproto">
|
|
cannam@0
|
685 <table class="memname">
|
|
cannam@0
|
686 <tr>
|
|
cannam@0
|
687 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
|
|
cannam@0
|
688 <td>(</td>
|
|
cannam@0
|
689 <td class="paramtype">std::string </td>
|
|
cannam@0
|
690 <td class="paramname"> </td>
|
|
cannam@0
|
691 <td> ) </td>
|
|
cannam@21
|
692 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
693 </tr>
|
|
cannam@0
|
694 </table>
|
|
cannam@0
|
695 </div>
|
|
cannam@0
|
696 <div class="memdoc">
|
|
cannam@0
|
697
|
|
cannam@0
|
698 <p>
|
|
cannam@0
|
699 Get the value of a named parameter.
|
|
cannam@0
|
700 <p>
|
|
cannam@0
|
701 The argument is the identifier field from that parameter's descriptor.
|
|
cannam@0
|
702 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
703
|
|
cannam@0
|
704 </div>
|
|
cannam@0
|
705 </div><p>
|
|
cannam@0
|
706 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
|
|
cannam@0
|
707 <div class="memitem">
|
|
cannam@0
|
708 <div class="memproto">
|
|
cannam@0
|
709 <table class="memname">
|
|
cannam@0
|
710 <tr>
|
|
cannam@0
|
711 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
|
|
cannam@0
|
712 <td>(</td>
|
|
cannam@0
|
713 <td class="paramtype">std::string </td>
|
|
cannam@0
|
714 <td class="paramname">, </td>
|
|
cannam@0
|
715 </tr>
|
|
cannam@0
|
716 <tr>
|
|
cannam@0
|
717 <td class="paramkey"></td>
|
|
cannam@0
|
718 <td></td>
|
|
cannam@0
|
719 <td class="paramtype">float </td>
|
|
cannam@0
|
720 <td class="paramname"></td><td> </td>
|
|
cannam@0
|
721 </tr>
|
|
cannam@0
|
722 <tr>
|
|
cannam@0
|
723 <td></td>
|
|
cannam@0
|
724 <td>)</td>
|
|
cannam@21
|
725 <td></td><td></td><td><code> [virtual, inherited]</code></td>
|
|
cannam@0
|
726 </tr>
|
|
cannam@0
|
727 </table>
|
|
cannam@0
|
728 </div>
|
|
cannam@0
|
729 <div class="memdoc">
|
|
cannam@0
|
730
|
|
cannam@0
|
731 <p>
|
|
cannam@0
|
732 Set a named parameter.
|
|
cannam@0
|
733 <p>
|
|
cannam@0
|
734 The first argument is the identifier field from that parameter's descriptor.
|
|
cannam@0
|
735 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
736
|
|
cannam@21
|
737 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
738
|
|
cannam@0
|
739 </div>
|
|
cannam@0
|
740 </div><p>
|
|
cannam@21
|
741 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " -->
|
|
cannam@0
|
742 <div class="memitem">
|
|
cannam@0
|
743 <div class="memproto">
|
|
cannam@0
|
744 <table class="memname">
|
|
cannam@0
|
745 <tr>
|
|
cannam@21
|
746 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
|
|
cannam@0
|
747 <td>(</td>
|
|
cannam@0
|
748 <td class="paramname"> </td>
|
|
cannam@0
|
749 <td> ) </td>
|
|
cannam@21
|
750 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
751 </tr>
|
|
cannam@0
|
752 </table>
|
|
cannam@0
|
753 </div>
|
|
cannam@0
|
754 <div class="memdoc">
|
|
cannam@0
|
755
|
|
cannam@0
|
756 <p>
|
|
cannam@0
|
757 Get the program settings available in this plugin.
|
|
cannam@0
|
758 <p>
|
|
cannam@0
|
759 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p>
|
|
cannam@0
|
760 The programs must have unique names.
|
|
cannam@0
|
761 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
762
|
|
cannam@0
|
763 </div>
|
|
cannam@0
|
764 </div><p>
|
|
cannam@0
|
765 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
|
|
cannam@0
|
766 <div class="memitem">
|
|
cannam@0
|
767 <div class="memproto">
|
|
cannam@0
|
768 <table class="memname">
|
|
cannam@0
|
769 <tr>
|
|
cannam@0
|
770 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
|
|
cannam@0
|
771 <td>(</td>
|
|
cannam@0
|
772 <td class="paramname"> </td>
|
|
cannam@0
|
773 <td> ) </td>
|
|
cannam@21
|
774 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
775 </tr>
|
|
cannam@0
|
776 </table>
|
|
cannam@0
|
777 </div>
|
|
cannam@0
|
778 <div class="memdoc">
|
|
cannam@0
|
779
|
|
cannam@0
|
780 <p>
|
|
cannam@0
|
781 Get the current program.
|
|
cannam@0
|
782 <p>
|
|
cannam@0
|
783
|
|
cannam@0
|
784 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
785
|
|
cannam@0
|
786 </div>
|
|
cannam@0
|
787 </div><p>
|
|
cannam@0
|
788 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
|
|
cannam@0
|
789 <div class="memitem">
|
|
cannam@0
|
790 <div class="memproto">
|
|
cannam@0
|
791 <table class="memname">
|
|
cannam@0
|
792 <tr>
|
|
cannam@0
|
793 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
|
|
cannam@0
|
794 <td>(</td>
|
|
cannam@0
|
795 <td class="paramtype">std::string </td>
|
|
cannam@0
|
796 <td class="paramname"> </td>
|
|
cannam@0
|
797 <td> ) </td>
|
|
cannam@21
|
798 <td><code> [virtual, inherited]</code></td>
|
|
cannam@0
|
799 </tr>
|
|
cannam@0
|
800 </table>
|
|
cannam@0
|
801 </div>
|
|
cannam@0
|
802 <div class="memdoc">
|
|
cannam@0
|
803
|
|
cannam@0
|
804 <p>
|
|
cannam@0
|
805 Select a program.
|
|
cannam@0
|
806 <p>
|
|
cannam@0
|
807 (If the given program name is not one of the available programs, do nothing.)
|
|
cannam@0
|
808 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
809
|
|
cannam@21
|
810 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
811
|
|
cannam@0
|
812 </div>
|
|
cannam@0
|
813 </div><p>
|
|
cannam@0
|
814 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " -->
|
|
cannam@0
|
815 <div class="memitem">
|
|
cannam@0
|
816 <div class="memproto">
|
|
cannam@0
|
817 <table class="memname">
|
|
cannam@0
|
818 <tr>
|
|
cannam@0
|
819 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
|
|
cannam@0
|
820 <td>(</td>
|
|
cannam@0
|
821 <td class="paramname"> </td>
|
|
cannam@0
|
822 <td> ) </td>
|
|
cannam@21
|
823 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
824 </tr>
|
|
cannam@0
|
825 </table>
|
|
cannam@0
|
826 </div>
|
|
cannam@0
|
827 <div class="memdoc">
|
|
cannam@0
|
828
|
|
cannam@0
|
829 <p>
|
|
cannam@21
|
830 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin.
|
|
cannam@0
|
831 <p>
|
|
cannam@0
|
832 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
|
|
cannam@0
|
833 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
|
|
cannam@0
|
834 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
835
|
|
cannam@0
|
836 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
837
|
|
cannam@0
|
838 </div>
|
|
cannam@0
|
839 </div><p>
|
|
cannam@0
|
840 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " -->
|
|
cannam@0
|
841 <div class="memitem">
|
|
cannam@0
|
842 <div class="memproto">
|
|
cannam@0
|
843 <table class="memname">
|
|
cannam@0
|
844 <tr>
|
|
cannam@0
|
845 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
|
|
cannam@0
|
846 <td>(</td>
|
|
cannam@0
|
847 <td class="paramname"> </td>
|
|
cannam@0
|
848 <td> ) </td>
|
|
cannam@21
|
849 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
850 </tr>
|
|
cannam@0
|
851 </table>
|
|
cannam@0
|
852 </div>
|
|
cannam@0
|
853 <div class="memdoc">
|
|
cannam@0
|
854
|
|
cannam@0
|
855 <p>
|
|
cannam@21
|
856 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function).
|
|
cannam@0
|
857 <p>
|
|
cannam@0
|
858 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
|
|
cannam@0
|
859 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
|
|
cannam@0
|
860 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
861
|
|
cannam@21
|
862 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
863
|
|
cannam@0
|
864 </div>
|
|
cannam@0
|
865 </div><p>
|
|
cannam@0
|
866 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
|
|
cannam@0
|
867 <div class="memitem">
|
|
cannam@0
|
868 <div class="memproto">
|
|
cannam@0
|
869 <table class="memname">
|
|
cannam@0
|
870 <tr>
|
|
cannam@0
|
871 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
|
|
cannam@0
|
872 <td>(</td>
|
|
cannam@0
|
873 <td class="paramname"> </td>
|
|
cannam@0
|
874 <td> ) </td>
|
|
cannam@21
|
875 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
876 </tr>
|
|
cannam@0
|
877 </table>
|
|
cannam@0
|
878 </div>
|
|
cannam@0
|
879 <div class="memdoc">
|
|
cannam@0
|
880
|
|
cannam@0
|
881 <p>
|
|
cannam@0
|
882 Get the minimum supported number of input channels.
|
|
cannam@0
|
883 <p>
|
|
cannam@0
|
884
|
|
cannam@0
|
885 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
886
|
|
cannam@0
|
887 </div>
|
|
cannam@0
|
888 </div><p>
|
|
cannam@0
|
889 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
|
|
cannam@0
|
890 <div class="memitem">
|
|
cannam@0
|
891 <div class="memproto">
|
|
cannam@0
|
892 <table class="memname">
|
|
cannam@0
|
893 <tr>
|
|
cannam@0
|
894 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
|
|
cannam@0
|
895 <td>(</td>
|
|
cannam@0
|
896 <td class="paramname"> </td>
|
|
cannam@0
|
897 <td> ) </td>
|
|
cannam@21
|
898 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
899 </tr>
|
|
cannam@0
|
900 </table>
|
|
cannam@0
|
901 </div>
|
|
cannam@0
|
902 <div class="memdoc">
|
|
cannam@0
|
903
|
|
cannam@0
|
904 <p>
|
|
cannam@0
|
905 Get the maximum supported number of input channels.
|
|
cannam@0
|
906 <p>
|
|
cannam@0
|
907
|
|
cannam@0
|
908 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
909
|
|
cannam@0
|
910 </div>
|
|
cannam@0
|
911 </div><p>
|
|
cannam@21
|
912 <a class="anchor" name="5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getOutputDescriptors" ref="5a9411305f713b4c9827844b89acd270" args="() const " -->
|
|
cannam@0
|
913 <div class="memitem">
|
|
cannam@0
|
914 <div class="memproto">
|
|
cannam@0
|
915 <table class="memname">
|
|
cannam@0
|
916 <tr>
|
|
cannam@21
|
917 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
|
|
cannam@0
|
918 <td>(</td>
|
|
cannam@0
|
919 <td class="paramname"> </td>
|
|
cannam@0
|
920 <td> ) </td>
|
|
cannam@21
|
921 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
922 </tr>
|
|
cannam@0
|
923 </table>
|
|
cannam@0
|
924 </div>
|
|
cannam@0
|
925 <div class="memdoc">
|
|
cannam@0
|
926
|
|
cannam@0
|
927 <p>
|
|
cannam@0
|
928 Get the outputs of this plugin.
|
|
cannam@0
|
929 <p>
|
|
cannam@21
|
930 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> call.
|
|
cannam@0
|
931 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
932
|
|
cannam@21
|
933 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
|
|
cannam@0
|
934
|
|
cannam@0
|
935 </div>
|
|
cannam@0
|
936 </div><p>
|
|
cannam@21
|
937 <a class="anchor" name="2bc8c0992e64f06991fb7cf89f99857e"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getRemainingFeatures" ref="2bc8c0992e64f06991fb7cf89f99857e" args="()" -->
|
|
cannam@0
|
938 <div class="memitem">
|
|
cannam@0
|
939 <div class="memproto">
|
|
cannam@0
|
940 <table class="memname">
|
|
cannam@0
|
941 <tr>
|
|
cannam@21
|
942 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
|
|
cannam@0
|
943 <td>(</td>
|
|
cannam@0
|
944 <td class="paramname"> </td>
|
|
cannam@0
|
945 <td> ) </td>
|
|
cannam@21
|
946 <td><code> [virtual, inherited]</code></td>
|
|
cannam@0
|
947 </tr>
|
|
cannam@0
|
948 </table>
|
|
cannam@0
|
949 </div>
|
|
cannam@0
|
950 <div class="memdoc">
|
|
cannam@0
|
951
|
|
cannam@0
|
952 <p>
|
|
cannam@0
|
953 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
|
|
cannam@0
|
954 <p>
|
|
cannam@0
|
955
|
|
cannam@0
|
956 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
957
|
|
cannam@21
|
958 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#28423951b2eda1a1fc371485434f417b">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#e9dcbd1ba8197ff90b4fc6bf7ade7688">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
|
|
cannam@0
|
959
|
|
cannam@21
|
960 </div>
|
|
cannam@21
|
961 </div><p>
|
|
cannam@21
|
962 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
|
|
cannam@21
|
963 <div class="memitem">
|
|
cannam@21
|
964 <div class="memproto">
|
|
cannam@21
|
965 <div class="memtemplate">
|
|
cannam@21
|
966 template<typename WrapperType> </div>
|
|
cannam@21
|
967 <table class="memname">
|
|
cannam@21
|
968 <tr>
|
|
cannam@21
|
969 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
|
|
cannam@21
|
970 <td>(</td>
|
|
cannam@21
|
971 <td class="paramname"> </td>
|
|
cannam@21
|
972 <td> ) </td>
|
|
cannam@21
|
973 <td><code> [inline, inherited]</code></td>
|
|
cannam@21
|
974 </tr>
|
|
cannam@21
|
975 </table>
|
|
cannam@21
|
976 </div>
|
|
cannam@21
|
977 <div class="memdoc">
|
|
cannam@0
|
978
|
|
cannam@21
|
979 <p>
|
|
cannam@21
|
980 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
|
|
cannam@21
|
981 <p>
|
|
cannam@21
|
982 This is useful in situations where a plugin is wrapped by multiple different wrappers (one inside another) and the host wants to call some wrapper-specific function on one of the layers without having to care about the order in which they are wrapped. For example, the plugin returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">PluginLoader::loadPlugin</a> may have more than one wrapper; if the host wanted to query or fine-tune some property of one of them, it would be hard to do so without knowing the order of the wrappers. This function therefore gives direct access to the wrapper of a particular type.
|
|
cannam@21
|
983 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
|
|
cannam@21
|
984
|
|
cannam@21
|
985 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
|
|
cannam@21
|
986
|
|
cannam@21
|
987 <p>Referenced by <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
|
|
cannam@0
|
988
|
|
cannam@0
|
989 </div>
|
|
cannam@0
|
990 </div><p>
|
|
cannam@0
|
991 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
|
|
cannam@0
|
992 <div class="memitem">
|
|
cannam@0
|
993 <div class="memproto">
|
|
cannam@0
|
994 <table class="memname">
|
|
cannam@0
|
995 <tr>
|
|
cannam@0
|
996 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
|
|
cannam@0
|
997 <td>(</td>
|
|
cannam@0
|
998 <td class="paramname"> </td>
|
|
cannam@0
|
999 <td> ) </td>
|
|
cannam@21
|
1000 <td> const<code> [inline, virtual, inherited]</code></td>
|
|
cannam@0
|
1001 </tr>
|
|
cannam@0
|
1002 </table>
|
|
cannam@0
|
1003 </div>
|
|
cannam@0
|
1004 <div class="memdoc">
|
|
cannam@0
|
1005
|
|
cannam@0
|
1006 <p>
|
|
cannam@0
|
1007 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
|
|
cannam@0
|
1008 <p>
|
|
cannam@0
|
1009 Do not reimplement this function in your subclass.
|
|
cannam@0
|
1010 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
1011
|
|
cannam@21
|
1012 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00425">425</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
1013
|
|
cannam@0
|
1014 </div>
|
|
cannam@0
|
1015 </div><p>
|
|
cannam@0
|
1016 <hr><h2>Member Data Documentation</h2>
|
|
cannam@0
|
1017 <a class="anchor" name="e3a74a2e6c4cd33dce9f4248e73c6701"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::m_impl" ref="e3a74a2e6c4cd33dce9f4248e73c6701" args="" -->
|
|
cannam@0
|
1018 <div class="memitem">
|
|
cannam@0
|
1019 <div class="memproto">
|
|
cannam@0
|
1020 <table class="memname">
|
|
cannam@0
|
1021 <tr>
|
|
cannam@21
|
1022 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#e3a74a2e6c4cd33dce9f4248e73c6701">Vamp::HostExt::PluginChannelAdapter::m_impl</a><code> [protected]</code> </td>
|
|
cannam@0
|
1023 </tr>
|
|
cannam@0
|
1024 </table>
|
|
cannam@0
|
1025 </div>
|
|
cannam@0
|
1026 <div class="memdoc">
|
|
cannam@0
|
1027
|
|
cannam@0
|
1028 <p>
|
|
cannam@0
|
1029
|
|
cannam@21
|
1030 <p>Definition at line <a class="el" href="PluginChannelAdapter_8h-source.html#l00139">139</a> of file <a class="el" href="PluginChannelAdapter_8h-source.html">PluginChannelAdapter.h</a>.</p>
|
|
cannam@0
|
1031
|
|
cannam@0
|
1032 </div>
|
|
cannam@0
|
1033 </div><p>
|
|
cannam@0
|
1034 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
|
|
cannam@0
|
1035 <div class="memitem">
|
|
cannam@0
|
1036 <div class="memproto">
|
|
cannam@0
|
1037 <table class="memname">
|
|
cannam@0
|
1038 <tr>
|
|
cannam@0
|
1039 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code> </td>
|
|
cannam@0
|
1040 </tr>
|
|
cannam@0
|
1041 </table>
|
|
cannam@0
|
1042 </div>
|
|
cannam@0
|
1043 <div class="memdoc">
|
|
cannam@0
|
1044
|
|
cannam@0
|
1045 <p>
|
|
cannam@0
|
1046
|
|
cannam@21
|
1047 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00126">126</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
|
|
cannam@0
|
1048
|
|
cannam@0
|
1049 </div>
|
|
cannam@0
|
1050 </div><p>
|
|
cannam@0
|
1051 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginChannelAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
|
|
cannam@0
|
1052 <div class="memitem">
|
|
cannam@0
|
1053 <div class="memproto">
|
|
cannam@0
|
1054 <table class="memname">
|
|
cannam@0
|
1055 <tr>
|
|
cannam@0
|
1056 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
|
|
cannam@0
|
1057 </tr>
|
|
cannam@0
|
1058 </table>
|
|
cannam@0
|
1059 </div>
|
|
cannam@0
|
1060 <div class="memdoc">
|
|
cannam@0
|
1061
|
|
cannam@0
|
1062 <p>
|
|
cannam@0
|
1063
|
|
cannam@21
|
1064 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">431</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
1065
|
|
cannam@21
|
1066 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
|
|
cannam@0
|
1067
|
|
cannam@0
|
1068 </div>
|
|
cannam@0
|
1069 </div><p>
|
|
cannam@21
|
1070 <hr>The documentation for this class was generated from the following file:<ul>
|
|
cannam@21
|
1071 <li><a class="el" href="PluginChannelAdapter_8h-source.html">PluginChannelAdapter.h</a></ul>
|
|
cannam@0
|
1072 </div>
|
|
cannam@21
|
1073 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by
|
|
cannam@0
|
1074 <a href="http://www.doxygen.org/index.html">
|
|
cannam@21
|
1075 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
|
|
cannam@0
|
1076 </body>
|
|
cannam@0
|
1077 </html>
|
