|
cannam@50
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
cannam@50
|
2 <html xmlns="http://www.w3.org/1999/xhtml">
|
|
cannam@50
|
3 <head>
|
|
cannam@50
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
cannam@0
|
5 <title>VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference</title>
|
|
cannam@50
|
6
|
|
cannam@50
|
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
cannam@50
|
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
cannam@50
|
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
cannam@50
|
10 <script type="text/javascript" src="jquery.js"></script>
|
|
cannam@50
|
11 <script type="text/javascript" src="resize.js"></script>
|
|
cannam@50
|
12 <script type="text/javascript" src="navtree.js"></script>
|
|
cannam@50
|
13 <script type="text/javascript">
|
|
cannam@50
|
14 $(document).ready(initResizable);
|
|
cannam@50
|
15 </script>
|
|
cannam@50
|
16
|
|
cannam@50
|
17
|
|
cannam@50
|
18 </head>
|
|
cannam@50
|
19 <body>
|
|
cannam@50
|
20 <div id="top"><!-- do not remove this div! -->
|
|
cannam@50
|
21
|
|
cannam@50
|
22
|
|
cannam@50
|
23 <div id="titlearea">
|
|
cannam@50
|
24 <table cellspacing="0" cellpadding="0">
|
|
cannam@50
|
25 <tbody>
|
|
cannam@50
|
26 <tr style="height: 56px;">
|
|
cannam@50
|
27
|
|
cannam@50
|
28
|
|
cannam@50
|
29 <td style="padding-left: 0.5em;">
|
|
cannam@50
|
30 <div id="projectname">VampPluginSDK
|
|
cannam@50
|
31  <span id="projectnumber">2.1</span>
|
|
cannam@50
|
32 </div>
|
|
cannam@50
|
33
|
|
cannam@50
|
34 </td>
|
|
cannam@50
|
35
|
|
cannam@50
|
36
|
|
cannam@50
|
37
|
|
cannam@50
|
38 </tr>
|
|
cannam@50
|
39 </tbody>
|
|
cannam@50
|
40 </table>
|
|
cannam@50
|
41 </div>
|
|
cannam@50
|
42
|
|
cannam@50
|
43 <!-- Generated by Doxygen 1.7.5.1 -->
|
|
cannam@50
|
44 <div id="navrow1" class="tabs">
|
|
cannam@50
|
45 <ul class="tablist">
|
|
cannam@50
|
46 <li><a href="index.html"><span>Main Page</span></a></li>
|
|
cannam@0
|
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
cannam@0
|
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
cannam@0
|
49 <li><a href="files.html"><span>Files</span></a></li>
|
|
cannam@0
|
50 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
cannam@0
|
51 </ul>
|
|
cannam@0
|
52 </div>
|
|
cannam@50
|
53 <div id="navrow2" class="tabs2">
|
|
cannam@50
|
54 <ul class="tablist">
|
|
cannam@50
|
55 <li><a href="annotated.html"><span>Class List</span></a></li>
|
|
cannam@50
|
56 <li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
cannam@50
|
57 <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
cannam@0
|
58 </ul>
|
|
cannam@0
|
59 </div>
|
|
cannam@50
|
60 </div>
|
|
cannam@50
|
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
cannam@50
|
62 <div id="nav-tree">
|
|
cannam@50
|
63 <div id="nav-tree-contents">
|
|
cannam@50
|
64 </div>
|
|
cannam@50
|
65 </div>
|
|
cannam@50
|
66 <div id="splitbar" style="-moz-user-select:none;"
|
|
cannam@50
|
67 class="ui-resizable-handle">
|
|
cannam@0
|
68 </div>
|
|
cannam@0
|
69 </div>
|
|
cannam@50
|
70 <script type="text/javascript">
|
|
cannam@50
|
71 initNavTree('classVamp_1_1HostExt_1_1PluginBufferingAdapter.html','');
|
|
cannam@50
|
72 </script>
|
|
cannam@50
|
73 <div id="doc-content">
|
|
cannam@50
|
74 <div class="header">
|
|
cannam@50
|
75 <div class="summary">
|
|
cannam@50
|
76 <a href="#pub-types">Public Types</a> |
|
|
cannam@50
|
77 <a href="#pub-methods">Public Member Functions</a> |
|
|
cannam@50
|
78 <a href="#pro-attribs">Protected Attributes</a> </div>
|
|
cannam@50
|
79 <div class="headertitle">
|
|
cannam@50
|
80 <div class="title">Vamp::HostExt::PluginBufferingAdapter Class Reference</div> </div>
|
|
cannam@50
|
81 </div>
|
|
cannam@0
|
82 <div class="contents">
|
|
cannam@50
|
83 <!-- doxytag: class="Vamp::HostExt::PluginBufferingAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" -->
|
|
cannam@50
|
84 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size.
|
|
cannam@50
|
85 <a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#details">More...</a></p>
|
|
cannam@50
|
86
|
|
cannam@50
|
87 <p><code>#include <<a class="el" href="PluginBufferingAdapter_8h_source.html">vamp-hostsdk/PluginBufferingAdapter.h</a>></code></p>
|
|
cannam@0
|
88 <div class="dynheader">
|
|
cannam@0
|
89 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div>
|
|
cannam@50
|
90 <div class="dyncontent">
|
|
cannam@50
|
91 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map" alt="Inheritance graph"/></div>
|
|
cannam@50
|
92 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map">
|
|
cannam@50
|
93 <area shape="rect" id="node2" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="28,155,212,181"/><area shape="rect" id="node4" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="74,81,165,106"/><area shape="rect" id="node6" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="61,6,179,31"/></map>
|
|
cannam@50
|
94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
cannam@0
|
95
|
|
cannam@50
|
96 <p><a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html">List of all members.</a></p>
|
|
cannam@50
|
97 <table class="memberdecls">
|
|
cannam@50
|
98 <tr><td colspan="2"><h2><a name="pub-types"></a>
|
|
cannam@50
|
99 Public Types</h2></td></tr>
|
|
cannam@50
|
100 <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
|
|
cannam@50
|
101 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
|
|
cannam@0
|
102 }</td></tr>
|
|
cannam@50
|
103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
|
|
cannam@50
|
104 < <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#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
|
|
cannam@50
|
105 <tr><td class="memItemLeft" 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#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
|
|
cannam@50
|
106 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map< int, <br class="typebreak"/>
|
|
cannam@50
|
107 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
|
|
cannam@50
|
108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
|
|
cannam@50
|
109 < <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#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
|
|
cannam@50
|
110 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
|
|
cannam@50
|
111 <tr><td colspan="2"><h2><a name="pub-methods"></a>
|
|
cannam@50
|
112 Public Member Functions</h2></td></tr>
|
|
cannam@50
|
113 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
|
|
cannam@50
|
114 <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> wrapping the given plugin. <a href="#a1276bcfcbe1414b33eeefbd7b2b702fe"></a><br/></td></tr>
|
|
cannam@50
|
115 <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a96263f7b0910a10eeae86f20db007e55">~PluginBufferingAdapter</a> ()</td></tr>
|
|
cannam@50
|
116 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">getPreferredStepSize</a> () const </td></tr>
|
|
cannam@50
|
117 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred step size for this adapter. <a href="#a2e66d009df69c951001e5d2786973d60"></a><br/></td></tr>
|
|
cannam@50
|
118 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">getPreferredBlockSize</a> () const </td></tr>
|
|
cannam@50
|
119 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred block size for this adapter. <a href="#a21e45180b19873f9ab69fe7a4e184a03"></a><br/></td></tr>
|
|
cannam@50
|
120 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
|
|
cannam@50
|
121 <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the adapter (and therefore the plugin) for the given number of channels. <a href="#a9e7798ba4d7870db46502ab541ab37a8"></a><br/></td></tr>
|
|
cannam@50
|
122 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad7fad500331808b5cdf90f5a45019b02">getPluginPreferredStepSize</a> () const </td></tr>
|
|
cannam@50
|
123 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred step size of the plugin wrapped by this adapter. <a href="#ad7fad500331808b5cdf90f5a45019b02"></a><br/></td></tr>
|
|
cannam@50
|
124 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7045be875de9dd226d2e2a222e957de0">getPluginPreferredBlockSize</a> () const </td></tr>
|
|
cannam@50
|
125 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred block size of the plugin wrapped by this adapter. <a href="#a7045be875de9dd226d2e2a222e957de0"></a><br/></td></tr>
|
|
cannam@50
|
126 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ac99898d78a01a7fad4def4d6c5fd3a7e">setPluginStepSize</a> (size_t stepSize)</td></tr>
|
|
cannam@50
|
127 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. <a href="#ac99898d78a01a7fad4def4d6c5fd3a7e"></a><br/></td></tr>
|
|
cannam@50
|
128 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa80ae1bff6f95e805811df2c3770a98c">setPluginBlockSize</a> (size_t blockSize)</td></tr>
|
|
cannam@50
|
129 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. <a href="#aa80ae1bff6f95e805811df2c3770a98c"></a><br/></td></tr>
|
|
cannam@50
|
130 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa065985fd864f6869d1bc7fea6fa2ece">getActualStepAndBlockSizes</a> (size_t &stepSize, size_t &blockSize)</td></tr>
|
|
cannam@50
|
131 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the step and block sizes that were actually used when initialising the underlying plugin. <a href="#aa065985fd864f6869d1bc7fea6fa2ece"></a><br/></td></tr>
|
|
cannam@50
|
132 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">setParameter</a> (std::string, float)</td></tr>
|
|
cannam@50
|
133 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#a7a979b20c169d37adbd7b7d8b8a077b3"></a><br/></td></tr>
|
|
cannam@50
|
134 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">selectProgram</a> (std::string)</td></tr>
|
|
cannam@50
|
135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#a3cc7000e0aff525950e0a286b87f8927"></a><br/></td></tr>
|
|
cannam@50
|
136 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">getOutputDescriptors</a> () const </td></tr>
|
|
cannam@50
|
137 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#af8cc914897a284433de220f1153f3845"></a><br/></td></tr>
|
|
cannam@50
|
138 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a">reset</a> ()</td></tr>
|
|
cannam@50
|
139 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a131fd9fe8a1795d7370d8a721176868a"></a><br/></td></tr>
|
|
cannam@50
|
140 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
|
|
cannam@50
|
141 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#a55058a20c1f8bffc0dc927350df778a0"></a><br/></td></tr>
|
|
cannam@50
|
142 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b">getRemainingFeatures</a> ()</td></tr>
|
|
cannam@50
|
143 <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="#a28423951b2eda1a1fc371485434f417b"></a><br/></td></tr>
|
|
cannam@50
|
144 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr>
|
|
cannam@50
|
145 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae203faf8384c9e1fddc381409aa8a214"></a><br/></td></tr>
|
|
cannam@50
|
146 <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
|
|
cannam@50
|
147 <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="#a74147fda6b44ff2169bd4a1eea0d46ff"></a><br/></td></tr>
|
|
cannam@50
|
148 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
|
|
cannam@50
|
149 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a4baa9e48f717c2b3e7f92496aa39d904"></a><br/></td></tr>
|
|
cannam@50
|
150 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
|
|
cannam@50
|
151 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#ac70a3265bb25aeb03f6dd8f8a0442088"></a><br/></td></tr>
|
|
cannam@50
|
152 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
|
|
cannam@50
|
153 <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="#ac334f699c0996055942785410d8a065c"></a><br/></td></tr>
|
|
cannam@50
|
154 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
|
|
cannam@50
|
155 <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="#a59d5a2298951b317995675e664b1c7bb"></a><br/></td></tr>
|
|
cannam@50
|
156 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
|
|
cannam@50
|
157 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#a47e1acf1696813008324a915c9ba59c5"></a><br/></td></tr>
|
|
cannam@50
|
158 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
|
|
cannam@50
|
159 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ae14f6ecb78be909c4cd5f0cdaed3c566"></a><br/></td></tr>
|
|
cannam@50
|
160 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr>
|
|
cannam@50
|
161 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9be71561265c2e6e43b7feaddaa91f36"></a><br/></td></tr>
|
|
cannam@50
|
162 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
|
|
cannam@50
|
163 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#a034920f56c8d7609a85447c42556048c"></a><br/></td></tr>
|
|
cannam@50
|
164 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr>
|
|
cannam@50
|
165 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#a131fbe1df81215020b9aa8cecef4c802"></a><br/></td></tr>
|
|
cannam@50
|
166 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
|
|
cannam@50
|
167 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr>
|
|
cannam@50
|
168 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
|
|
cannam@50
|
169 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a2b28f1cf37d46a514f1e1411a6037bf8"></a><br/></td></tr>
|
|
cannam@50
|
170 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
|
|
cannam@50
|
171 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a985eb21f1827bfbc3950d6871b107a58"></a><br/></td></tr>
|
|
cannam@50
|
172 <tr><td class="memTemplParams" colspan="2">template<typename WrapperType > </td></tr>
|
|
cannam@50
|
173 <tr><td class="memTemplItemLeft" align="right" valign="top">WrapperType * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">getWrapper</a> ()</td></tr>
|
|
cannam@50
|
174 <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="#a653d0308e8e34881a8749b7631d00f05"></a><br/></td></tr>
|
|
cannam@50
|
175 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
|
|
cannam@50
|
176 <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 from audio o...">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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr>
|
|
cannam@50
|
177 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
|
|
cannam@50
|
178 Protected Attributes</h2></td></tr>
|
|
cannam@50
|
179 <tr><td class="memItemLeft" align="right" valign="top">Impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">m_impl</a></td></tr>
|
|
cannam@50
|
180 <tr><td class="memItemLeft" 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#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
|
|
cannam@50
|
181 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
|
|
cannam@50
|
182 </table>
|
|
cannam@50
|
183 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
cannam@50
|
184 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. </p>
|
|
cannam@50
|
185 <p>A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.</p>
|
|
cannam@50
|
186 <p>If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.</p>
|
|
cannam@50
|
187 <p>In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted. </p>
|
|
cannam@0
|
188
|
|
cannam@50
|
189 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h_source.html#l00075">75</a> of file <a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a>.</p>
|
|
cannam@50
|
190 </div><hr/><h2>Member Typedef Documentation</h2>
|
|
cannam@50
|
191 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
|
|
cannam@0
|
192 <div class="memitem">
|
|
cannam@0
|
193 <div class="memproto">
|
|
cannam@0
|
194 <table class="memname">
|
|
cannam@0
|
195 <tr>
|
|
cannam@50
|
196 <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#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td>
|
|
cannam@0
|
197 </tr>
|
|
cannam@0
|
198 </table>
|
|
cannam@0
|
199 </div>
|
|
cannam@0
|
200 <div class="memdoc">
|
|
cannam@0
|
201
|
|
cannam@50
|
202 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
203
|
|
cannam@0
|
204 </div>
|
|
cannam@50
|
205 </div>
|
|
cannam@50
|
206 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
|
|
cannam@0
|
207 <div class="memitem">
|
|
cannam@0
|
208 <div class="memproto">
|
|
cannam@0
|
209 <table class="memname">
|
|
cannam@0
|
210 <tr>
|
|
cannam@50
|
211 <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#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td>
|
|
cannam@0
|
212 </tr>
|
|
cannam@0
|
213 </table>
|
|
cannam@0
|
214 </div>
|
|
cannam@0
|
215 <div class="memdoc">
|
|
cannam@0
|
216
|
|
cannam@50
|
217 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
218
|
|
cannam@0
|
219 </div>
|
|
cannam@50
|
220 </div>
|
|
cannam@50
|
221 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
|
|
cannam@0
|
222 <div class="memitem">
|
|
cannam@0
|
223 <div class="memproto">
|
|
cannam@0
|
224 <table class="memname">
|
|
cannam@0
|
225 <tr>
|
|
cannam@50
|
226 <td class="memname">typedef std::map<int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>> <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td>
|
|
cannam@0
|
227 </tr>
|
|
cannam@0
|
228 </table>
|
|
cannam@0
|
229 </div>
|
|
cannam@0
|
230 <div class="memdoc">
|
|
cannam@0
|
231
|
|
cannam@50
|
232 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
233
|
|
cannam@0
|
234 </div>
|
|
cannam@50
|
235 </div>
|
|
cannam@50
|
236 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
|
|
cannam@0
|
237 <div class="memitem">
|
|
cannam@0
|
238 <div class="memproto">
|
|
cannam@0
|
239 <table class="memname">
|
|
cannam@0
|
240 <tr>
|
|
cannam@50
|
241 <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#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td>
|
|
cannam@0
|
242 </tr>
|
|
cannam@0
|
243 </table>
|
|
cannam@0
|
244 </div>
|
|
cannam@0
|
245 <div class="memdoc">
|
|
cannam@0
|
246
|
|
cannam@50
|
247 <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
|
248
|
|
cannam@0
|
249 </div>
|
|
cannam@50
|
250 </div>
|
|
cannam@50
|
251 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
|
|
cannam@0
|
252 <div class="memitem">
|
|
cannam@0
|
253 <div class="memproto">
|
|
cannam@0
|
254 <table class="memname">
|
|
cannam@0
|
255 <tr>
|
|
cannam@50
|
256 <td class="memname">typedef std::vector<std::string> <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td>
|
|
cannam@0
|
257 </tr>
|
|
cannam@0
|
258 </table>
|
|
cannam@0
|
259 </div>
|
|
cannam@0
|
260 <div class="memdoc">
|
|
cannam@0
|
261
|
|
cannam@50
|
262 <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
|
263
|
|
cannam@0
|
264 </div>
|
|
cannam@50
|
265 </div>
|
|
cannam@50
|
266 <hr/><h2>Member Enumeration Documentation</h2>
|
|
cannam@50
|
267 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
|
|
cannam@0
|
268 <div class="memitem">
|
|
cannam@0
|
269 <div class="memproto">
|
|
cannam@0
|
270 <table class="memname">
|
|
cannam@0
|
271 <tr>
|
|
cannam@50
|
272 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
|
|
cannam@0
|
273 </tr>
|
|
cannam@0
|
274 </table>
|
|
cannam@0
|
275 </div>
|
|
cannam@0
|
276 <div class="memdoc">
|
|
cannam@50
|
277 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
|
|
cannam@50
|
278 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td>
|
|
cannam@0
|
279 </td></tr>
|
|
cannam@50
|
280 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td>
|
|
cannam@0
|
281 </td></tr>
|
|
cannam@0
|
282 </table>
|
|
cannam@50
|
283 </dd>
|
|
cannam@0
|
284 </dl>
|
|
cannam@0
|
285
|
|
cannam@50
|
286 <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
|
287
|
|
cannam@0
|
288 </div>
|
|
cannam@50
|
289 </div>
|
|
cannam@50
|
290 <hr/><h2>Constructor & Destructor Documentation</h2>
|
|
cannam@50
|
291 <a class="anchor" id="a1276bcfcbe1414b33eeefbd7b2b702fe"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter" ref="a1276bcfcbe1414b33eeefbd7b2b702fe" args="(Plugin *plugin)" -->
|
|
cannam@0
|
292 <div class="memitem">
|
|
cannam@0
|
293 <div class="memproto">
|
|
cannam@0
|
294 <table class="memname">
|
|
cannam@0
|
295 <tr>
|
|
cannam@50
|
296 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter </td>
|
|
cannam@0
|
297 <td>(</td>
|
|
cannam@50
|
298 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td>
|
|
cannam@50
|
299 <td class="paramname"><em>plugin</em></td><td>)</td>
|
|
cannam@21
|
300 <td></td>
|
|
cannam@21
|
301 </tr>
|
|
cannam@21
|
302 </table>
|
|
cannam@21
|
303 </div>
|
|
cannam@21
|
304 <div class="memdoc">
|
|
cannam@21
|
305
|
|
cannam@50
|
306 <p>Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> wrapping the given plugin. </p>
|
|
cannam@50
|
307 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p>
|
|
cannam@50
|
308
|
|
cannam@21
|
309 </div>
|
|
cannam@50
|
310 </div>
|
|
cannam@50
|
311 <a class="anchor" id="a96263f7b0910a10eeae86f20db007e55"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter" ref="a96263f7b0910a10eeae86f20db007e55" args="()" -->
|
|
cannam@21
|
312 <div class="memitem">
|
|
cannam@21
|
313 <div class="memproto">
|
|
cannam@21
|
314 <table class="memname">
|
|
cannam@21
|
315 <tr>
|
|
cannam@50
|
316 <td class="memname">virtual Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter </td>
|
|
cannam@21
|
317 <td>(</td>
|
|
cannam@50
|
318 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
319 <td><code> [virtual]</code></td>
|
|
cannam@0
|
320 </tr>
|
|
cannam@0
|
321 </table>
|
|
cannam@0
|
322 </div>
|
|
cannam@0
|
323 <div class="memdoc">
|
|
cannam@0
|
324
|
|
cannam@0
|
325 </div>
|
|
cannam@50
|
326 </div>
|
|
cannam@50
|
327 <hr/><h2>Member Function Documentation</h2>
|
|
cannam@50
|
328 <a class="anchor" id="a2e66d009df69c951001e5d2786973d60"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize" ref="a2e66d009df69c951001e5d2786973d60" args="() const " -->
|
|
cannam@0
|
329 <div class="memitem">
|
|
cannam@0
|
330 <div class="memproto">
|
|
cannam@0
|
331 <table class="memname">
|
|
cannam@0
|
332 <tr>
|
|
cannam@50
|
333 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize </td>
|
|
cannam@0
|
334 <td>(</td>
|
|
cannam@50
|
335 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
336 <td> const<code> [virtual]</code></td>
|
|
cannam@0
|
337 </tr>
|
|
cannam@0
|
338 </table>
|
|
cannam@0
|
339 </div>
|
|
cannam@0
|
340 <div class="memdoc">
|
|
cannam@0
|
341
|
|
cannam@50
|
342 <p>Return the preferred step size for this adapter. </p>
|
|
cannam@50
|
343 <p>Because of the way this adapter works, its preferred step size will always be the same as its preferred block size. This may or may not be the same as the preferred step size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad7fad500331808b5cdf90f5a45019b02" title="Return the preferred step size of the plugin wrapped by this adapter.">getPluginPreferredStepSize()</a>. </p>
|
|
cannam@50
|
344
|
|
cannam@50
|
345 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
346
|
|
cannam@0
|
347 </div>
|
|
cannam@50
|
348 </div>
|
|
cannam@50
|
349 <a class="anchor" id="a21e45180b19873f9ab69fe7a4e184a03"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize" ref="a21e45180b19873f9ab69fe7a4e184a03" args="() const " -->
|
|
cannam@21
|
350 <div class="memitem">
|
|
cannam@21
|
351 <div class="memproto">
|
|
cannam@21
|
352 <table class="memname">
|
|
cannam@21
|
353 <tr>
|
|
cannam@50
|
354 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize </td>
|
|
cannam@21
|
355 <td>(</td>
|
|
cannam@50
|
356 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
357 <td> const<code> [virtual]</code></td>
|
|
cannam@21
|
358 </tr>
|
|
cannam@21
|
359 </table>
|
|
cannam@21
|
360 </div>
|
|
cannam@21
|
361 <div class="memdoc">
|
|
cannam@21
|
362
|
|
cannam@50
|
363 <p>Return the preferred block size for this adapter. </p>
|
|
cannam@50
|
364 <p>This may or may not be the same as the preferred block size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7045be875de9dd226d2e2a222e957de0" title="Return the preferred block size of the plugin wrapped by this adapter.">getPluginPreferredBlockSize()</a>.</p>
|
|
cannam@50
|
365 <p>Note that this adapter may be initialised with any block size, not just its supposedly preferred one. </p>
|
|
cannam@50
|
366
|
|
cannam@50
|
367 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@21
|
368
|
|
cannam@21
|
369 </div>
|
|
cannam@50
|
370 </div>
|
|
cannam@50
|
371 <a class="anchor" id="a9e7798ba4d7870db46502ab541ab37a8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::initialise" ref="a9e7798ba4d7870db46502ab541ab37a8" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
|
|
cannam@0
|
372 <div class="memitem">
|
|
cannam@0
|
373 <div class="memproto">
|
|
cannam@0
|
374 <table class="memname">
|
|
cannam@0
|
375 <tr>
|
|
cannam@50
|
376 <td class="memname">bool Vamp::HostExt::PluginBufferingAdapter::initialise </td>
|
|
cannam@0
|
377 <td>(</td>
|
|
cannam@50
|
378 <td class="paramtype">size_t </td>
|
|
cannam@50
|
379 <td class="paramname"><em>channels</em>, </td>
|
|
cannam@0
|
380 </tr>
|
|
cannam@0
|
381 <tr>
|
|
cannam@0
|
382 <td class="paramkey"></td>
|
|
cannam@0
|
383 <td></td>
|
|
cannam@50
|
384 <td class="paramtype">size_t </td>
|
|
cannam@50
|
385 <td class="paramname"><em>stepSize</em>, </td>
|
|
cannam@0
|
386 </tr>
|
|
cannam@0
|
387 <tr>
|
|
cannam@0
|
388 <td class="paramkey"></td>
|
|
cannam@0
|
389 <td></td>
|
|
cannam@50
|
390 <td class="paramtype">size_t </td>
|
|
cannam@50
|
391 <td class="paramname"><em>blockSize</em> </td>
|
|
cannam@0
|
392 </tr>
|
|
cannam@0
|
393 <tr>
|
|
cannam@0
|
394 <td></td>
|
|
cannam@0
|
395 <td>)</td>
|
|
cannam@50
|
396 <td></td><td><code> [virtual]</code></td>
|
|
cannam@0
|
397 </tr>
|
|
cannam@0
|
398 </table>
|
|
cannam@0
|
399 </div>
|
|
cannam@0
|
400 <div class="memdoc">
|
|
cannam@0
|
401
|
|
cannam@50
|
402 <p>Initialise the adapter (and therefore the plugin) for the given number of channels. </p>
|
|
cannam@50
|
403 <p>Initialise the adapter for the given step and block size, which must be equal.</p>
|
|
cannam@50
|
404 <p>The step and block size used for the underlying plugin will depend on its preferences, or any values previously passed to setPluginStepSize and setPluginBlockSize. </p>
|
|
cannam@50
|
405
|
|
cannam@50
|
406 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
407
|
|
cannam@0
|
408 </div>
|
|
cannam@50
|
409 </div>
|
|
cannam@50
|
410 <a class="anchor" id="ad7fad500331808b5cdf90f5a45019b02"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize" ref="ad7fad500331808b5cdf90f5a45019b02" args="() const " -->
|
|
cannam@0
|
411 <div class="memitem">
|
|
cannam@0
|
412 <div class="memproto">
|
|
cannam@0
|
413 <table class="memname">
|
|
cannam@0
|
414 <tr>
|
|
cannam@50
|
415 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize </td>
|
|
cannam@0
|
416 <td>(</td>
|
|
cannam@50
|
417 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
418 <td> const</td>
|
|
cannam@0
|
419 </tr>
|
|
cannam@0
|
420 </table>
|
|
cannam@0
|
421 </div>
|
|
cannam@0
|
422 <div class="memdoc">
|
|
cannam@0
|
423
|
|
cannam@50
|
424 <p>Return the preferred step size of the plugin wrapped by this adapter. </p>
|
|
cannam@50
|
425 <p>This is included mainly for informational purposes. This value is not likely to be a valid step size for the adapter itself, and it is not usually of any use in interpreting the results (because the adapter re-writes OneSamplePerStep outputs to FixedSampleRate so that the hop size no longer needs to be known beforehand in order to interpret them). </p>
|
|
cannam@50
|
426
|
|
cannam@0
|
427 </div>
|
|
cannam@50
|
428 </div>
|
|
cannam@50
|
429 <a class="anchor" id="a7045be875de9dd226d2e2a222e957de0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize" ref="a7045be875de9dd226d2e2a222e957de0" args="() const " -->
|
|
cannam@0
|
430 <div class="memitem">
|
|
cannam@0
|
431 <div class="memproto">
|
|
cannam@0
|
432 <table class="memname">
|
|
cannam@0
|
433 <tr>
|
|
cannam@50
|
434 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize </td>
|
|
cannam@0
|
435 <td>(</td>
|
|
cannam@50
|
436 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
437 <td> const</td>
|
|
cannam@21
|
438 </tr>
|
|
cannam@21
|
439 </table>
|
|
cannam@21
|
440 </div>
|
|
cannam@21
|
441 <div class="memdoc">
|
|
cannam@21
|
442
|
|
cannam@50
|
443 <p>Return the preferred block size of the plugin wrapped by this adapter. </p>
|
|
cannam@50
|
444 <p>This is included mainly for informational purposes. </p>
|
|
cannam@50
|
445
|
|
cannam@21
|
446 </div>
|
|
cannam@50
|
447 </div>
|
|
cannam@50
|
448 <a class="anchor" id="ac99898d78a01a7fad4def4d6c5fd3a7e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize" ref="ac99898d78a01a7fad4def4d6c5fd3a7e" args="(size_t stepSize)" -->
|
|
cannam@21
|
449 <div class="memitem">
|
|
cannam@21
|
450 <div class="memproto">
|
|
cannam@21
|
451 <table class="memname">
|
|
cannam@21
|
452 <tr>
|
|
cannam@50
|
453 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize </td>
|
|
cannam@21
|
454 <td>(</td>
|
|
cannam@50
|
455 <td class="paramtype">size_t </td>
|
|
cannam@50
|
456 <td class="paramname"><em>stepSize</em></td><td>)</td>
|
|
cannam@21
|
457 <td></td>
|
|
cannam@21
|
458 </tr>
|
|
cannam@21
|
459 </table>
|
|
cannam@21
|
460 </div>
|
|
cannam@21
|
461 <div class="memdoc">
|
|
cannam@21
|
462
|
|
cannam@50
|
463 <p>Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. </p>
|
|
cannam@50
|
464 <p>If this is not set, the plugin's own preferred step size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>. </p>
|
|
cannam@50
|
465
|
|
cannam@21
|
466 </div>
|
|
cannam@50
|
467 </div>
|
|
cannam@50
|
468 <a class="anchor" id="aa80ae1bff6f95e805811df2c3770a98c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize" ref="aa80ae1bff6f95e805811df2c3770a98c" args="(size_t blockSize)" -->
|
|
cannam@21
|
469 <div class="memitem">
|
|
cannam@21
|
470 <div class="memproto">
|
|
cannam@21
|
471 <table class="memname">
|
|
cannam@21
|
472 <tr>
|
|
cannam@50
|
473 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize </td>
|
|
cannam@21
|
474 <td>(</td>
|
|
cannam@50
|
475 <td class="paramtype">size_t </td>
|
|
cannam@50
|
476 <td class="paramname"><em>blockSize</em></td><td>)</td>
|
|
cannam@21
|
477 <td></td>
|
|
cannam@21
|
478 </tr>
|
|
cannam@21
|
479 </table>
|
|
cannam@21
|
480 </div>
|
|
cannam@21
|
481 <div class="memdoc">
|
|
cannam@21
|
482
|
|
cannam@50
|
483 <p>Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. </p>
|
|
cannam@50
|
484 <p>If this is not set, the plugin's own preferred block size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>. </p>
|
|
cannam@50
|
485
|
|
cannam@21
|
486 </div>
|
|
cannam@50
|
487 </div>
|
|
cannam@50
|
488 <a class="anchor" id="aa065985fd864f6869d1bc7fea6fa2ece"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes" ref="aa065985fd864f6869d1bc7fea6fa2ece" args="(size_t &stepSize, size_t &blockSize)" -->
|
|
cannam@21
|
489 <div class="memitem">
|
|
cannam@21
|
490 <div class="memproto">
|
|
cannam@21
|
491 <table class="memname">
|
|
cannam@21
|
492 <tr>
|
|
cannam@50
|
493 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes </td>
|
|
cannam@21
|
494 <td>(</td>
|
|
cannam@50
|
495 <td class="paramtype">size_t & </td>
|
|
cannam@50
|
496 <td class="paramname"><em>stepSize</em>, </td>
|
|
cannam@21
|
497 </tr>
|
|
cannam@21
|
498 <tr>
|
|
cannam@21
|
499 <td class="paramkey"></td>
|
|
cannam@21
|
500 <td></td>
|
|
cannam@50
|
501 <td class="paramtype">size_t & </td>
|
|
cannam@50
|
502 <td class="paramname"><em>blockSize</em> </td>
|
|
cannam@21
|
503 </tr>
|
|
cannam@21
|
504 <tr>
|
|
cannam@21
|
505 <td></td>
|
|
cannam@21
|
506 <td>)</td>
|
|
cannam@50
|
507 <td></td><td></td>
|
|
cannam@21
|
508 </tr>
|
|
cannam@21
|
509 </table>
|
|
cannam@21
|
510 </div>
|
|
cannam@21
|
511 <div class="memdoc">
|
|
cannam@21
|
512
|
|
cannam@50
|
513 <p>Return the step and block sizes that were actually used when initialising the underlying plugin. </p>
|
|
cannam@50
|
514 <p>This is included mainly for informational purposes. You will not usually need to call this function. If this is called before <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>, it will return 0 for both values. If it is called after a failed call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>, it will return the values that were used in the failed call to the plugin's <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> function. </p>
|
|
cannam@50
|
515
|
|
cannam@21
|
516 </div>
|
|
cannam@50
|
517 </div>
|
|
cannam@50
|
518 <a class="anchor" id="a7a979b20c169d37adbd7b7d8b8a077b3"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setParameter" ref="a7a979b20c169d37adbd7b7d8b8a077b3" args="(std::string, float)" -->
|
|
cannam@21
|
519 <div class="memitem">
|
|
cannam@21
|
520 <div class="memproto">
|
|
cannam@21
|
521 <table class="memname">
|
|
cannam@21
|
522 <tr>
|
|
cannam@50
|
523 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setParameter </td>
|
|
cannam@21
|
524 <td>(</td>
|
|
cannam@50
|
525 <td class="paramtype">std::string </td>
|
|
cannam@21
|
526 <td class="paramname">, </td>
|
|
cannam@21
|
527 </tr>
|
|
cannam@21
|
528 <tr>
|
|
cannam@21
|
529 <td class="paramkey"></td>
|
|
cannam@21
|
530 <td></td>
|
|
cannam@50
|
531 <td class="paramtype">float </td>
|
|
cannam@50
|
532 <td class="paramname"> </td>
|
|
cannam@21
|
533 </tr>
|
|
cannam@21
|
534 <tr>
|
|
cannam@21
|
535 <td></td>
|
|
cannam@21
|
536 <td>)</td>
|
|
cannam@50
|
537 <td></td><td><code> [virtual]</code></td>
|
|
cannam@21
|
538 </tr>
|
|
cannam@21
|
539 </table>
|
|
cannam@21
|
540 </div>
|
|
cannam@21
|
541 <div class="memdoc">
|
|
cannam@21
|
542
|
|
cannam@50
|
543 <p>Set a named parameter. </p>
|
|
cannam@50
|
544 <p>The first argument is the identifier field from that parameter's descriptor. </p>
|
|
cannam@50
|
545
|
|
cannam@50
|
546 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@21
|
547
|
|
cannam@21
|
548 </div>
|
|
cannam@50
|
549 </div>
|
|
cannam@50
|
550 <a class="anchor" id="a3cc7000e0aff525950e0a286b87f8927"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::selectProgram" ref="a3cc7000e0aff525950e0a286b87f8927" args="(std::string)" -->
|
|
cannam@21
|
551 <div class="memitem">
|
|
cannam@21
|
552 <div class="memproto">
|
|
cannam@21
|
553 <table class="memname">
|
|
cannam@21
|
554 <tr>
|
|
cannam@50
|
555 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::selectProgram </td>
|
|
cannam@21
|
556 <td>(</td>
|
|
cannam@50
|
557 <td class="paramtype">std::string </td>
|
|
cannam@50
|
558 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
559 <td><code> [virtual]</code></td>
|
|
cannam@21
|
560 </tr>
|
|
cannam@21
|
561 </table>
|
|
cannam@21
|
562 </div>
|
|
cannam@21
|
563 <div class="memdoc">
|
|
cannam@21
|
564
|
|
cannam@50
|
565 <p>Select a program. </p>
|
|
cannam@50
|
566 <p>(If the given program name is not one of the available programs, do nothing.) </p>
|
|
cannam@50
|
567
|
|
cannam@50
|
568 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@21
|
569
|
|
cannam@21
|
570 </div>
|
|
cannam@50
|
571 </div>
|
|
cannam@50
|
572 <a class="anchor" id="af8cc914897a284433de220f1153f3845"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors" ref="af8cc914897a284433de220f1153f3845" args="() const " -->
|
|
cannam@21
|
573 <div class="memitem">
|
|
cannam@21
|
574 <div class="memproto">
|
|
cannam@21
|
575 <table class="memname">
|
|
cannam@21
|
576 <tr>
|
|
cannam@50
|
577 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors </td>
|
|
cannam@21
|
578 <td>(</td>
|
|
cannam@50
|
579 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
580 <td> const<code> [virtual]</code></td>
|
|
cannam@0
|
581 </tr>
|
|
cannam@0
|
582 </table>
|
|
cannam@0
|
583 </div>
|
|
cannam@0
|
584 <div class="memdoc">
|
|
cannam@0
|
585
|
|
cannam@50
|
586 <p>Get the outputs of this plugin. </p>
|
|
cannam@50
|
587 <p>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_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0" title="Process a single block of input data.">process()</a> call. </p>
|
|
cannam@50
|
588
|
|
cannam@50
|
589 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
590
|
|
cannam@0
|
591 </div>
|
|
cannam@50
|
592 </div>
|
|
cannam@50
|
593 <a class="anchor" id="a131fd9fe8a1795d7370d8a721176868a"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::reset" ref="a131fd9fe8a1795d7370d8a721176868a" args="()" -->
|
|
cannam@0
|
594 <div class="memitem">
|
|
cannam@0
|
595 <div class="memproto">
|
|
cannam@0
|
596 <table class="memname">
|
|
cannam@0
|
597 <tr>
|
|
cannam@50
|
598 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::reset </td>
|
|
cannam@0
|
599 <td>(</td>
|
|
cannam@50
|
600 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
601 <td><code> [virtual]</code></td>
|
|
cannam@0
|
602 </tr>
|
|
cannam@0
|
603 </table>
|
|
cannam@0
|
604 </div>
|
|
cannam@0
|
605 <div class="memdoc">
|
|
cannam@0
|
606
|
|
cannam@50
|
607 <p>Reset the plugin after use, to prepare it for another clean run. </p>
|
|
cannam@50
|
608 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
|
|
cannam@50
|
609
|
|
cannam@50
|
610 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
611
|
|
cannam@0
|
612 </div>
|
|
cannam@50
|
613 </div>
|
|
cannam@50
|
614 <a class="anchor" id="a55058a20c1f8bffc0dc927350df778a0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::process" ref="a55058a20c1f8bffc0dc927350df778a0" args="(const float *const *inputBuffers, RealTime timestamp)" -->
|
|
cannam@0
|
615 <div class="memitem">
|
|
cannam@0
|
616 <div class="memproto">
|
|
cannam@0
|
617 <table class="memname">
|
|
cannam@0
|
618 <tr>
|
|
cannam@50
|
619 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::process </td>
|
|
cannam@0
|
620 <td>(</td>
|
|
cannam@50
|
621 <td class="paramtype">const float *const * </td>
|
|
cannam@50
|
622 <td class="paramname"><em>inputBuffers</em>, </td>
|
|
cannam@0
|
623 </tr>
|
|
cannam@0
|
624 <tr>
|
|
cannam@0
|
625 <td class="paramkey"></td>
|
|
cannam@0
|
626 <td></td>
|
|
cannam@50
|
627 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td>
|
|
cannam@50
|
628 <td class="paramname"><em>timestamp</em> </td>
|
|
cannam@0
|
629 </tr>
|
|
cannam@0
|
630 <tr>
|
|
cannam@0
|
631 <td></td>
|
|
cannam@0
|
632 <td>)</td>
|
|
cannam@50
|
633 <td></td><td><code> [virtual]</code></td>
|
|
cannam@0
|
634 </tr>
|
|
cannam@0
|
635 </table>
|
|
cannam@0
|
636 </div>
|
|
cannam@0
|
637 <div class="memdoc">
|
|
cannam@0
|
638
|
|
cannam@50
|
639 <p>Process a single block of input data. </p>
|
|
cannam@50
|
640 <p>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@50
|
641 <p>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@50
|
642 <p>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.) </p>
|
|
cannam@50
|
643
|
|
cannam@50
|
644 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
645
|
|
cannam@0
|
646 </div>
|
|
cannam@50
|
647 </div>
|
|
cannam@50
|
648 <a class="anchor" id="a28423951b2eda1a1fc371485434f417b"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures" ref="a28423951b2eda1a1fc371485434f417b" args="()" -->
|
|
cannam@0
|
649 <div class="memitem">
|
|
cannam@0
|
650 <div class="memproto">
|
|
cannam@0
|
651 <table class="memname">
|
|
cannam@0
|
652 <tr>
|
|
cannam@50
|
653 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures </td>
|
|
cannam@0
|
654 <td>(</td>
|
|
cannam@50
|
655 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
656 <td><code> [virtual]</code></td>
|
|
cannam@0
|
657 </tr>
|
|
cannam@0
|
658 </table>
|
|
cannam@0
|
659 </div>
|
|
cannam@0
|
660 <div class="memdoc">
|
|
cannam@0
|
661
|
|
cannam@50
|
662 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
|
|
cannam@0
|
663
|
|
cannam@50
|
664 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
665
|
|
cannam@0
|
666 </div>
|
|
cannam@50
|
667 </div>
|
|
cannam@50
|
668 <a class="anchor" id="ae203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getInputDomain" ref="ae203faf8384c9e1fddc381409aa8a214" args="() const " -->
|
|
cannam@0
|
669 <div class="memitem">
|
|
cannam@0
|
670 <div class="memproto">
|
|
cannam@0
|
671 <table class="memname">
|
|
cannam@0
|
672 <tr>
|
|
cannam@50
|
673 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
|
|
cannam@0
|
674 <td>(</td>
|
|
cannam@50
|
675 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
676 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
677 </tr>
|
|
cannam@0
|
678 </table>
|
|
cannam@0
|
679 </div>
|
|
cannam@0
|
680 <div class="memdoc">
|
|
cannam@0
|
681
|
|
cannam@50
|
682 <p>Get the plugin's required input domain. </p>
|
|
cannam@50
|
683 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" 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.</p>
|
|
cannam@50
|
684 <p>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#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. 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. </p>
|
|
cannam@0
|
685
|
|
cannam@50
|
686 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
|
|
cannam@50
|
687
|
|
cannam@50
|
688 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
689
|
|
cannam@0
|
690 </div>
|
|
cannam@50
|
691 </div>
|
|
cannam@50
|
692 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getVampApiVersion" ref="a74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
|
|
cannam@0
|
693 <div class="memitem">
|
|
cannam@0
|
694 <div class="memproto">
|
|
cannam@0
|
695 <table class="memname">
|
|
cannam@0
|
696 <tr>
|
|
cannam@50
|
697 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
|
|
cannam@0
|
698 <td>(</td>
|
|
cannam@50
|
699 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
700 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
701 </tr>
|
|
cannam@0
|
702 </table>
|
|
cannam@0
|
703 </div>
|
|
cannam@0
|
704 <div class="memdoc">
|
|
cannam@0
|
705
|
|
cannam@50
|
706 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
|
|
cannam@0
|
707
|
|
cannam@50
|
708 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
709
|
|
cannam@0
|
710 </div>
|
|
cannam@50
|
711 </div>
|
|
cannam@50
|
712 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getIdentifier" ref="a4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
|
|
cannam@0
|
713 <div class="memitem">
|
|
cannam@0
|
714 <div class="memproto">
|
|
cannam@0
|
715 <table class="memname">
|
|
cannam@0
|
716 <tr>
|
|
cannam@50
|
717 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
|
|
cannam@0
|
718 <td>(</td>
|
|
cannam@50
|
719 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
720 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
721 </tr>
|
|
cannam@0
|
722 </table>
|
|
cannam@0
|
723 </div>
|
|
cannam@0
|
724 <div class="memdoc">
|
|
cannam@0
|
725
|
|
cannam@50
|
726 <p>Get the computer-usable name of the plugin. </p>
|
|
cannam@50
|
727 <p>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@50
|
728 <p>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@50
|
729 <p>Example: "zero_crossings" </p>
|
|
cannam@50
|
730
|
|
cannam@50
|
731 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
732
|
|
cannam@0
|
733 </div>
|
|
cannam@50
|
734 </div>
|
|
cannam@50
|
735 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getName" ref="ac70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
|
|
cannam@0
|
736 <div class="memitem">
|
|
cannam@0
|
737 <div class="memproto">
|
|
cannam@0
|
738 <table class="memname">
|
|
cannam@0
|
739 <tr>
|
|
cannam@50
|
740 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
|
|
cannam@0
|
741 <td>(</td>
|
|
cannam@50
|
742 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
743 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
744 </tr>
|
|
cannam@0
|
745 </table>
|
|
cannam@0
|
746 </div>
|
|
cannam@0
|
747 <div class="memdoc">
|
|
cannam@0
|
748
|
|
cannam@50
|
749 <p>Get a human-readable name or title of the plugin. </p>
|
|
cannam@50
|
750 <p>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@50
|
751 <p>Example: "Zero Crossings" </p>
|
|
cannam@50
|
752
|
|
cannam@50
|
753 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
754
|
|
cannam@0
|
755 </div>
|
|
cannam@50
|
756 </div>
|
|
cannam@50
|
757 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getDescription" ref="ac334f699c0996055942785410d8a065c" args="() const " -->
|
|
cannam@0
|
758 <div class="memitem">
|
|
cannam@0
|
759 <div class="memproto">
|
|
cannam@0
|
760 <table class="memname">
|
|
cannam@0
|
761 <tr>
|
|
cannam@50
|
762 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
|
|
cannam@0
|
763 <td>(</td>
|
|
cannam@50
|
764 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
765 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
766 </tr>
|
|
cannam@0
|
767 </table>
|
|
cannam@0
|
768 </div>
|
|
cannam@0
|
769 <div class="memdoc">
|
|
cannam@0
|
770
|
|
cannam@50
|
771 <p>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". </p>
|
|
cannam@50
|
772 <p>May be empty if the name has said it all already.</p>
|
|
cannam@50
|
773 <p>Example: "Detect and count zero crossing points" </p>
|
|
cannam@50
|
774
|
|
cannam@50
|
775 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
776
|
|
cannam@0
|
777 </div>
|
|
cannam@50
|
778 </div>
|
|
cannam@50
|
779 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaker" ref="a59d5a2298951b317995675e664b1c7bb" args="() const " -->
|
|
cannam@0
|
780 <div class="memitem">
|
|
cannam@0
|
781 <div class="memproto">
|
|
cannam@0
|
782 <table class="memname">
|
|
cannam@0
|
783 <tr>
|
|
cannam@50
|
784 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
|
|
cannam@0
|
785 <td>(</td>
|
|
cannam@50
|
786 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
787 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
788 </tr>
|
|
cannam@0
|
789 </table>
|
|
cannam@0
|
790 </div>
|
|
cannam@0
|
791 <div class="memdoc">
|
|
cannam@0
|
792
|
|
cannam@50
|
793 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
|
|
cannam@50
|
794 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
|
|
cannam@50
|
795
|
|
cannam@50
|
796 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
797
|
|
cannam@0
|
798 </div>
|
|
cannam@50
|
799 </div>
|
|
cannam@50
|
800 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginVersion" ref="a47e1acf1696813008324a915c9ba59c5" args="() const " -->
|
|
cannam@0
|
801 <div class="memitem">
|
|
cannam@0
|
802 <div class="memproto">
|
|
cannam@0
|
803 <table class="memname">
|
|
cannam@0
|
804 <tr>
|
|
cannam@50
|
805 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
|
|
cannam@0
|
806 <td>(</td>
|
|
cannam@50
|
807 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
808 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
809 </tr>
|
|
cannam@0
|
810 </table>
|
|
cannam@0
|
811 </div>
|
|
cannam@0
|
812 <div class="memdoc">
|
|
cannam@0
|
813
|
|
cannam@50
|
814 <p>Get the version number of the plugin. </p>
|
|
cannam@0
|
815
|
|
cannam@50
|
816 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
817
|
|
cannam@0
|
818 </div>
|
|
cannam@50
|
819 </div>
|
|
cannam@50
|
820 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCopyright" ref="ae14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
|
|
cannam@0
|
821 <div class="memitem">
|
|
cannam@0
|
822 <div class="memproto">
|
|
cannam@0
|
823 <table class="memname">
|
|
cannam@0
|
824 <tr>
|
|
cannam@50
|
825 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
|
|
cannam@0
|
826 <td>(</td>
|
|
cannam@50
|
827 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
828 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
829 </tr>
|
|
cannam@0
|
830 </table>
|
|
cannam@0
|
831 </div>
|
|
cannam@0
|
832 <div class="memdoc">
|
|
cannam@0
|
833
|
|
cannam@50
|
834 <p>Get the copyright statement or licensing summary for the plugin. </p>
|
|
cannam@50
|
835 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
|
|
cannam@50
|
836
|
|
cannam@50
|
837 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
838
|
|
cannam@0
|
839 </div>
|
|
cannam@50
|
840 </div>
|
|
cannam@50
|
841 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameterDescriptors" ref="a9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
|
|
cannam@0
|
842 <div class="memitem">
|
|
cannam@0
|
843 <div class="memproto">
|
|
cannam@0
|
844 <table class="memname">
|
|
cannam@0
|
845 <tr>
|
|
cannam@50
|
846 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
|
|
cannam@0
|
847 <td>(</td>
|
|
cannam@50
|
848 <td class="paramname"></td><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@50
|
855 <p>Get the controllable parameters of this plugin. </p>
|
|
cannam@0
|
856
|
|
cannam@50
|
857 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
858
|
|
cannam@0
|
859 </div>
|
|
cannam@50
|
860 </div>
|
|
cannam@50
|
861 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameter" ref="a034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
|
|
cannam@0
|
862 <div class="memitem">
|
|
cannam@0
|
863 <div class="memproto">
|
|
cannam@0
|
864 <table class="memname">
|
|
cannam@0
|
865 <tr>
|
|
cannam@50
|
866 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
|
|
cannam@0
|
867 <td>(</td>
|
|
cannam@50
|
868 <td class="paramtype">std::string </td>
|
|
cannam@50
|
869 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
870 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
871 </tr>
|
|
cannam@0
|
872 </table>
|
|
cannam@0
|
873 </div>
|
|
cannam@0
|
874 <div class="memdoc">
|
|
cannam@0
|
875
|
|
cannam@50
|
876 <p>Get the value of a named parameter. </p>
|
|
cannam@50
|
877 <p>The argument is the identifier field from that parameter's descriptor. </p>
|
|
cannam@50
|
878
|
|
cannam@50
|
879 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
880
|
|
cannam@0
|
881 </div>
|
|
cannam@50
|
882 </div>
|
|
cannam@50
|
883 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPrograms" ref="a131fbe1df81215020b9aa8cecef4c802" args="() const " -->
|
|
cannam@0
|
884 <div class="memitem">
|
|
cannam@0
|
885 <div class="memproto">
|
|
cannam@0
|
886 <table class="memname">
|
|
cannam@0
|
887 <tr>
|
|
cannam@50
|
888 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
|
|
cannam@0
|
889 <td>(</td>
|
|
cannam@50
|
890 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
891 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
892 </tr>
|
|
cannam@0
|
893 </table>
|
|
cannam@0
|
894 </div>
|
|
cannam@0
|
895 <div class="memdoc">
|
|
cannam@0
|
896
|
|
cannam@50
|
897 <p>Get the program settings available in this plugin. </p>
|
|
cannam@50
|
898 <p>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@50
|
899 <p>The programs must have unique names. </p>
|
|
cannam@50
|
900
|
|
cannam@50
|
901 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
902
|
|
cannam@0
|
903 </div>
|
|
cannam@50
|
904 </div>
|
|
cannam@50
|
905 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCurrentProgram" ref="a7a312dd42d161064b70afd7ff24c0651" args="() const " -->
|
|
cannam@0
|
906 <div class="memitem">
|
|
cannam@0
|
907 <div class="memproto">
|
|
cannam@0
|
908 <table class="memname">
|
|
cannam@0
|
909 <tr>
|
|
cannam@50
|
910 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
|
|
cannam@0
|
911 <td>(</td>
|
|
cannam@50
|
912 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
913 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
914 </tr>
|
|
cannam@0
|
915 </table>
|
|
cannam@0
|
916 </div>
|
|
cannam@0
|
917 <div class="memdoc">
|
|
cannam@0
|
918
|
|
cannam@50
|
919 <p>Get the current program. </p>
|
|
cannam@0
|
920
|
|
cannam@50
|
921 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
922
|
|
cannam@0
|
923 </div>
|
|
cannam@50
|
924 </div>
|
|
cannam@50
|
925 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMinChannelCount" ref="a2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
|
|
cannam@0
|
926 <div class="memitem">
|
|
cannam@0
|
927 <div class="memproto">
|
|
cannam@0
|
928 <table class="memname">
|
|
cannam@0
|
929 <tr>
|
|
cannam@50
|
930 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
|
|
cannam@0
|
931 <td>(</td>
|
|
cannam@50
|
932 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
933 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
934 </tr>
|
|
cannam@0
|
935 </table>
|
|
cannam@0
|
936 </div>
|
|
cannam@0
|
937 <div class="memdoc">
|
|
cannam@0
|
938
|
|
cannam@50
|
939 <p>Get the minimum supported number of input channels. </p>
|
|
cannam@0
|
940
|
|
cannam@50
|
941 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
942
|
|
cannam@0
|
943 </div>
|
|
cannam@50
|
944 </div>
|
|
cannam@50
|
945 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaxChannelCount" ref="a985eb21f1827bfbc3950d6871b107a58" args="() const " -->
|
|
cannam@0
|
946 <div class="memitem">
|
|
cannam@0
|
947 <div class="memproto">
|
|
cannam@0
|
948 <table class="memname">
|
|
cannam@0
|
949 <tr>
|
|
cannam@50
|
950 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
|
|
cannam@0
|
951 <td>(</td>
|
|
cannam@50
|
952 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
953 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
954 </tr>
|
|
cannam@0
|
955 </table>
|
|
cannam@0
|
956 </div>
|
|
cannam@0
|
957 <div class="memdoc">
|
|
cannam@0
|
958
|
|
cannam@50
|
959 <p>Get the maximum supported number of input channels. </p>
|
|
cannam@0
|
960
|
|
cannam@50
|
961 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
962
|
|
cannam@21
|
963 </div>
|
|
cannam@50
|
964 </div>
|
|
cannam@50
|
965 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getWrapper" ref="a653d0308e8e34881a8749b7631d00f05" args="()" -->
|
|
cannam@21
|
966 <div class="memitem">
|
|
cannam@21
|
967 <div class="memproto">
|
|
cannam@21
|
968 <div class="memtemplate">
|
|
cannam@35
|
969 template<typename WrapperType > </div>
|
|
cannam@21
|
970 <table class="memname">
|
|
cannam@21
|
971 <tr>
|
|
cannam@50
|
972 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
|
|
cannam@21
|
973 <td>(</td>
|
|
cannam@50
|
974 <td class="paramname"></td><td>)</td>
|
|
cannam@21
|
975 <td><code> [inline, inherited]</code></td>
|
|
cannam@21
|
976 </tr>
|
|
cannam@21
|
977 </table>
|
|
cannam@21
|
978 </div>
|
|
cannam@21
|
979 <div class="memdoc">
|
|
cannam@0
|
980
|
|
cannam@50
|
981 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
|
|
cannam@50
|
982 <p>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#a964689eb9688cd7e58e8c82ebb0d305f" 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. </p>
|
|
cannam@21
|
983
|
|
cannam@50
|
984 <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
|
985
|
|
cannam@50
|
986 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
|
|
cannam@50
|
987
|
|
cannam@50
|
988 <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
|
989
|
|
cannam@0
|
990 </div>
|
|
cannam@50
|
991 </div>
|
|
cannam@50
|
992 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
|
|
cannam@0
|
993 <div class="memitem">
|
|
cannam@0
|
994 <div class="memproto">
|
|
cannam@0
|
995 <table class="memname">
|
|
cannam@0
|
996 <tr>
|
|
cannam@50
|
997 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
|
|
cannam@0
|
998 <td>(</td>
|
|
cannam@50
|
999 <td class="paramname"></td><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@50
|
1006 <p>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 from audio o...">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>. </p>
|
|
cannam@50
|
1007 <p>Do not reimplement this function in your subclass. </p>
|
|
cannam@0
|
1008
|
|
cannam@50
|
1009 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
|
|
cannam@50
|
1010
|
|
cannam@50
|
1011 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00430">430</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
1012
|
|
cannam@0
|
1013 </div>
|
|
cannam@50
|
1014 </div>
|
|
cannam@50
|
1015 <hr/><h2>Member Data Documentation</h2>
|
|
cannam@50
|
1016 <a class="anchor" id="a51e10c9c63c0349fd74c6d604de5554e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_impl" ref="a51e10c9c63c0349fd74c6d604de5554e" args="" -->
|
|
cannam@0
|
1017 <div class="memitem">
|
|
cannam@0
|
1018 <div class="memproto">
|
|
cannam@0
|
1019 <table class="memname">
|
|
cannam@0
|
1020 <tr>
|
|
cannam@50
|
1021 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">Vamp::HostExt::PluginBufferingAdapter::m_impl</a><code> [protected]</code></td>
|
|
cannam@0
|
1022 </tr>
|
|
cannam@0
|
1023 </table>
|
|
cannam@0
|
1024 </div>
|
|
cannam@0
|
1025 <div class="memdoc">
|
|
cannam@0
|
1026
|
|
cannam@50
|
1027 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h_source.html#l00184">184</a> of file <a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a>.</p>
|
|
cannam@0
|
1028
|
|
cannam@0
|
1029 </div>
|
|
cannam@50
|
1030 </div>
|
|
cannam@50
|
1031 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_plugin" ref="ab4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
|
|
cannam@0
|
1032 <div class="memitem">
|
|
cannam@0
|
1033 <div class="memproto">
|
|
cannam@0
|
1034 <table class="memname">
|
|
cannam@0
|
1035 <tr>
|
|
cannam@50
|
1036 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code></td>
|
|
cannam@0
|
1037 </tr>
|
|
cannam@0
|
1038 </table>
|
|
cannam@0
|
1039 </div>
|
|
cannam@0
|
1040 <div class="memdoc">
|
|
cannam@0
|
1041
|
|
cannam@50
|
1042 <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
|
1043
|
|
cannam@0
|
1044 </div>
|
|
cannam@50
|
1045 </div>
|
|
cannam@50
|
1046 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
|
|
cannam@0
|
1047 <div class="memitem">
|
|
cannam@0
|
1048 <div class="memproto">
|
|
cannam@0
|
1049 <table class="memname">
|
|
cannam@0
|
1050 <tr>
|
|
cannam@50
|
1051 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
|
|
cannam@0
|
1052 </tr>
|
|
cannam@0
|
1053 </table>
|
|
cannam@0
|
1054 </div>
|
|
cannam@0
|
1055 <div class="memdoc">
|
|
cannam@0
|
1056
|
|
cannam@50
|
1057 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">436</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
|
|
cannam@0
|
1058
|
|
cannam@50
|
1059 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <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="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p>
|
|
cannam@0
|
1060
|
|
cannam@0
|
1061 </div>
|
|
cannam@0
|
1062 </div>
|
|
cannam@50
|
1063 <hr/>The documentation for this class was generated from the following file:<ul>
|
|
cannam@50
|
1064 <li><a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a></li>
|
|
cannam@50
|
1065 </ul>
|
|
cannam@50
|
1066 </div>
|
|
cannam@50
|
1067 </div>
|
|
cannam@50
|
1068 <div id="nav-path" class="navpath">
|
|
cannam@50
|
1069 <ul>
|
|
cannam@50
|
1070 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
|
|
cannam@50
|
1071 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li>
|
|
cannam@50
|
1072 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">PluginBufferingAdapter</a> </li>
|
|
cannam@50
|
1073
|
|
cannam@50
|
1074 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
|
|
cannam@50
|
1075 <a href="http://www.doxygen.org/index.html">
|
|
cannam@50
|
1076 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
|
|
cannam@50
|
1077 </ul>
|
|
cannam@50
|
1078 </div>
|
|
cannam@50
|
1079
|
|
cannam@50
|
1080
|
|
cannam@0
|
1081 </body>
|
|
cannam@0
|
1082 </html>
|
