Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginChannelAdapter.html @ 50:8260c0f4e05b website

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