Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.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::PluginInputDomainAdapter Class Reference</title> 5 <title>VampPluginSDK: Vamp::HostExt::PluginInputDomainAdapter 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_1PluginInputDomainAdapter.html">PluginInputDomainAdapter</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_1PluginInputDomainAdapter.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::PluginInputDomainAdapter Class Reference</div> </div>
27 </div> 81 </div>
28 <div class="contents"> 82 <div class="contents">
29 <h1>Vamp::HostExt::PluginInputDomainAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginInputDomainAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it. 83 <!-- doxytag: class="Vamp::HostExt::PluginInputDomainAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" -->
30 <a href="#_details">More...</a> 84 <p><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> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it.
31 <p> 85 <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#details">More...</a></p>
32 <code>#include &lt;<a class="el" href="PluginInputDomainAdapter_8h-source.html">vamp-hostsdk/PluginInputDomainAdapter.h</a>&gt;</code> 86
33 <p> 87 <p><code>#include &lt;<a class="el" href="PluginInputDomainAdapter_8h_source.html">vamp-hostsdk/PluginInputDomainAdapter.h</a>&gt;</code></p>
34 <div class="dynheader"> 88 <div class="dynheader">
35 Inheritance diagram for Vamp::HostExt::PluginInputDomainAdapter:</div> 89 Inheritance diagram for Vamp::HostExt::PluginInputDomainAdapter:</div>
36 <div class="dynsection"> 90 <div class="dyncontent">
37 <p><center><img src="classVamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__map" alt="Inheritance graph"></center> 91 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginInputDomainAdapter_inherit__map" alt="Inheritance graph"/></div>
38 <map name="Vamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__map"> 92 <map name="Vamp_1_1HostExt_1_1PluginInputDomainAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginInputDomainAdapter_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="40,156,229,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="88,81,181,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="75,7,195,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="40,155,224,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="86,81,177,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="73,6,191,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_1PluginInputDomainAdapter-members.html">List of all members.</a></p>
43 <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter-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_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a> { <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577fcf39fe57ba29a908d4877c21de145dd">ShiftTimestamp</a>, 100 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a> { <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577afcf39fe57ba29a908d4877c21de145dd">ShiftTimestamp</a>,
47 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152">ShiftData</a>, 101 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577a0838ff456d829e9096b5d968e6c55152">ShiftData</a>,
48 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297">NoShift</a> 102 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577ab06e8c6824802978d0be4074a556b297">NoShift</a>
49 }</td></tr> 103 }</td></tr>
50 104 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">ProcessTimestampMethod determines how the <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> handles timestamps for the data passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function of the plugin it wraps, in the case where the plugin is expecting frequency-domain data. <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">More...</a><br/></td></tr>
51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ProcessTimestampMethod determines how the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> handles timestamps for the data passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function of the plugin it wraps, in the case where the plugin is expecting frequency-domain data. <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">More...</a><br></td></tr> 105 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">WindowType</a> { <br/>
52 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 106 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dca99b08cf7a7f4a1b52a09044ea12c6324">RectangularWindow</a> = 0,
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#878e7275acdb77efc7a802944305039d">PluginInputDomainAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> 107 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dca77fd88a7d94fcd9c6c4aef30b86f077d">BartlettWindow</a> = 1,
54 108 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dcaae5133bd639336a5c31378f4c2939d42">TriangularWindow</a> = 1,
55 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> wrapping the given plugin. <a href="#878e7275acdb77efc7a802944305039d"></a><br></td></tr> 109 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dca9d522bff8d5884a8ba57d5a8c7e113c8">HammingWindow</a> = 2,
56 <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_1PluginInputDomainAdapter.html#ba2cbfa650d8a7c9181dbdb49b10aad0">~PluginInputDomainAdapter</a> ()</td></tr> 110 <br/>
57 111 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dcacad78947b6c8db20feb5ddf208ac1108">HanningWindow</a> = 3,
58 <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_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 112 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dcadc87b20cfb5f1ddd23ebc281e3e47916">HannWindow</a> = 3,
59 113 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dca2e298b1bee28272721953b2921891da6">BlackmanWindow</a> = 4,
60 <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="#72d201eca10ec73bf16e07984f58f94c"></a><br></td></tr> 114 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dcaa6a2f46966a46cc7abdf2df74270999e">NuttallWindow</a> = 7,
61 <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_1PluginInputDomainAdapter.html#984a12b5b4cb0be1e2f7a0aa84106c4c">reset</a> ()</td></tr> 115 <br/>
62 116 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dca7cbf5d8c58f33bcfa28e3a5863d6ac94">BlackmanHarrisWindow</a> = 8
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#984a12b5b4cb0be1e2f7a0aa84106c4c"></a><br></td></tr> 117 <br/>
64 <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_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">getInputDomain</a> () const </td></tr> 118 }</td></tr>
65 119 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The set of supported window shapes. <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">More...</a><br/></td></tr>
66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#47ff1ed72889f323da63f8abc9ea581a"></a><br></td></tr> 120 <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>,
67 <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_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">getPreferredStepSize</a> () const </td></tr> 121 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
68 122 }</td></tr>
69 <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_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#d979af9f1cbf2eeb16f4eaedb4a4f565"></a><br></td></tr> 123 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
70 <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_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">getPreferredBlockSize</a> () const </td></tr> 124 &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>
71 125 <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>
72 <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_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function). <a href="#4cf40d09d02022b1962ff17bb0324ea5"></a><br></td></tr> 126 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
73 <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_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 127 <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>
74 128 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#b36a81ac9a0ded8d83c6b855263c0231"></a><br></td></tr> 129 &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>
76 <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_1PluginInputDomainAdapter.html#1d7366f8cab39abc01ebfc7bf7ca8089">setProcessTimestampMethod</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>)</td></tr> 130 <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>
77 131 <tr><td colspan="2"><h2><a name="pub-methods"></a>
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the method used for timestamp adjustment in plugins taking frequency-domain input. <a href="#1d7366f8cab39abc01ebfc7bf7ca8089"></a><br></td></tr> 132 Public Member Functions</h2></td></tr>
79 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#cfc7a9121f678fd085448f68f15c9eae">getProcessTimestampMethod</a> () const </td></tr> 133 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a878e7275acdb77efc7a802944305039d">PluginInputDomainAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
80 134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <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> wrapping the given plugin. <a href="#a878e7275acdb77efc7a802944305039d"></a><br/></td></tr>
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input. <a href="#cfc7a9121f678fd085448f68f15c9eae"></a><br></td></tr> 135 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#aba2cbfa650d8a7c9181dbdb49b10aad0">~PluginInputDomainAdapter</a> ()</td></tr>
82 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#c1ab6af0fcda0a4c3f050c54b2db4769">getTimestampAdjustment</a> () const </td></tr> 136 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
83 137 <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="#a72d201eca10ec73bf16e07984f58f94c"></a><br/></td></tr>
84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the amount by which the timestamps supplied to <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> are being incremented when they are passed to the plugin's own <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> implementation. <a href="#c1ab6af0fcda0a4c3f050c54b2db4769"></a><br></td></tr> 138 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a984a12b5b4cb0be1e2f7a0aa84106c4c">reset</a> ()</td></tr>
85 <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> 139 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a984a12b5b4cb0be1e2f7a0aa84106c4c"></a><br/></td></tr>
86 140 <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_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">getInputDomain</a> () const </td></tr>
87 <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> 141 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a47ff1ed72889f323da63f8abc9ea581a"></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#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr> 142 <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_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">getPreferredStepSize</a> () const </td></tr>
89 143 <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_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#ad979af9f1cbf2eeb16f4eaedb4a4f565"></a><br/></td></tr>
90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr> 144 <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_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">getPreferredBlockSize</a> () const </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#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr> 145 <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_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function). <a href="#a4cf40d09d02022b1962ff17bb0324ea5"></a><br/></td></tr>
92 146 <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_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
93 <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> 147 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#ab36a81ac9a0ded8d83c6b855263c0231"></a><br/></td></tr>
94 <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> 148 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a1d7366f8cab39abc01ebfc7bf7ca8089">setProcessTimestampMethod</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>)</td></tr>
95 149 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the method used for timestamp adjustment in plugins taking frequency-domain input. <a href="#a1d7366f8cab39abc01ebfc7bf7ca8089"></a><br/></td></tr>
96 <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> 150 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#acfc7a9121f678fd085448f68f15c9eae">getProcessTimestampMethod</a> () const </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#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr> 151 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input. <a href="#acfc7a9121f678fd085448f68f15c9eae"></a><br/></td></tr>
98 152 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ac1ab6af0fcda0a4c3f050c54b2db4769">getTimestampAdjustment</a> () const </td></tr>
99 <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> 153 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the amount by which the timestamps supplied to <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> are being incremented when they are passed to the plugin's own <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> implementation. <a href="#ac1ab6af0fcda0a4c3f050c54b2db4769"></a><br/></td></tr>
100 <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> 154 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">WindowType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab143065e1a65f1d860cb26b32d5a9c1e">getWindowType</a> () const </td></tr>
101 155 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current window shape. <a href="#ab143065e1a65f1d860cb26b32d5a9c1e"></a><br/></td></tr>
102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr> 156 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a652bf9f25352a4fa89dd80ff816558d4">setWindowType</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">WindowType</a> type)</td></tr>
103 <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> 157 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current window shape. <a href="#a652bf9f25352a4fa89dd80ff816558d4"></a><br/></td></tr>
104 158 <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>
105 <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> 159 <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>
106 <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> 160 <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>
107 161 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a4baa9e48f717c2b3e7f92496aa39d904"></a><br/></td></tr>
108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr> 162 <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>
109 <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> 163 <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>
110 164 <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>
111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr> 165 <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>
112 <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> 166 <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>
113 167 <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>
114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr> 168 <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>
115 <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> 169 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a47e1acf1696813008324a915c9ba59c5"></a><br/></td></tr>
116 170 <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>
117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr> 171 <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>
118 <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> 172 <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>
119 173 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9be71561265c2e6e43b7feaddaa91f36"></a><br/></td></tr>
120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr> 174 <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>
121 <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> 175 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a034920f56c8d7609a85447c42556048c"></a><br/></td></tr>
122 176 <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>
123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr> 177 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5"></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> 178 <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>
125 179 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#a131fbe1df81215020b9aa8cecef4c802"></a><br/></td></tr>
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> 180 <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>
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> 181 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr>
128 182 <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>
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> 183 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf"></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> 184 <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>
131 185 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a2b28f1cf37d46a514f1e1411a6037bf8"></a><br/></td></tr>
132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr> 186 <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>
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> 187 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a985eb21f1827bfbc3950d6871b107a58"></a><br/></td></tr>
134 188 <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>
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> 189 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a5a9411305f713b4c9827844b89acd270"></a><br/></td></tr>
136 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType &gt; </td></tr> 190 <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>
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> 191 <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>
138 192 <tr><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr>
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> 193 <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>
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> 194 <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>
141 195 <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>
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> 196 <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>
143 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 197 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
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_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">m_impl</a></td></tr> 198 Protected Attributes</h2></td></tr>
145 199 <tr><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a9fa8a6b8a4e41b6e3f2fabc0d23678cc">m_impl</a></td></tr>
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> 200 <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>
147 201 <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>
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> 202 </table>
151 <hr><a name="_details"></a><h2>Detailed Description</h2> 203 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
152 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it. 204 <div class="textblock"><p><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> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it. </p>
153 <p> 205 <p>This permits a host to use time- and frequency-domain plugins interchangeably without needing to handle the conversion itself.</p>
154 This permits a host to use time- and frequency-domain plugins interchangeably without needing to handle the conversion itself.<p> 206 <p>This adapter uses a basic windowed FFT (using Hann window by default) that supports power-of-two block sizes only. If a frequency domain plugin requests a non-power-of-two blocksize, the adapter will adjust it to a nearby power of two instead. Thus, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5" title="Get the preferred block size (window size -- the number of sample frames passed in each block to the ...">getPreferredBlockSize()</a> will always return a power of two if the wrapped plugin is a frequency domain one. If the plugin doesn't accept the adjusted power of two block size, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c" 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> will fail.</p>
155 This adapter uses a basic Hanning windowed FFT that supports power-of-two block sizes only. If a frequency domain plugin requests a non-power-of-two blocksize, the adapter will adjust it to a nearby power of two instead. Thus, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5" title="Get the preferred block size (window size -- the number of sample frames passed in...">getPreferredBlockSize()</a> will always return a power of two if the wrapped plugin is a frequency domain one. If the plugin doesn't accept the adjusted power of two block size, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> will fail.<p> 207 <p>The adapter provides no way for the host to discover whether the underlying plugin is actually a time or frequency domain plugin (except that if the preferred block size is not a power of two, it must be a time domain plugin).</p>
156 The adapter provides no way for the host to discover whether the underlying plugin is actually a time or frequency domain plugin (except that if the preferred block size is not a power of two, it must be a time domain plugin).<p> 208 <p>The FFT implementation is simple and self-contained, but unlikely to be the fastest available: a host can usually do better if it cares enough.</p>
157 The FFT implementation is simple and self-contained, but unlikely to be the fastest available: a host can usually do better if it cares enough.<p> 209 <p>The window shape for the FFT frame can be set using setWindowType and the current shape retrieved using getWindowType. (This was added in v2.3 of the SDK.)</p>
158 In every respect other than its input domain handling, the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.<p> 210 <p>In every respect other than its input domain handling, the <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> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.</p>
159 <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> 211 <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>
160 212
161 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h-source.html#l00082">82</a> of file <a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a>.</p> 213 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h_source.html#l00087">87</a> of file <a class="el" href="PluginInputDomainAdapter_8h_source.html">PluginInputDomainAdapter.h</a>.</p>
162 <hr><h2>Member Typedef Documentation</h2> 214 </div><hr/><h2>Member Typedef Documentation</h2>
163 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> 215 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
164 <div class="memitem"> 216 <div class="memitem">
165 <div class="memproto"> 217 <div class="memproto">
166 <table class="memname"> 218 <table class="memname">
167 <tr> 219 <tr>
168 <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> 220 <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>
169 </tr> 221 </tr>
170 </table> 222 </table>
171 </div> 223 </div>
172 <div class="memdoc"> 224 <div class="memdoc">
173 225
174 <p> 226 <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>
175 227
176 <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> 228 </div>
177 229 </div>
178 </div> 230 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
179 </div><p> 231 <div class="memitem">
180 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> 232 <div class="memproto">
181 <div class="memitem"> 233 <table class="memname">
182 <div class="memproto"> 234 <tr>
183 <table class="memname"> 235 <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>
184 <tr> 236 </tr>
185 <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> 237 </table>
186 </tr> 238 </div>
187 </table> 239 <div class="memdoc">
188 </div> 240
189 <div class="memdoc"> 241 <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>
190 242
191 <p> 243 </div>
192 244 </div>
193 <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> 245 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
194 246 <div class="memitem">
195 </div> 247 <div class="memproto">
196 </div><p> 248 <table class="memname">
197 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> 249 <tr>
198 <div class="memitem"> 250 <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>
199 <div class="memproto"> 251 </tr>
200 <table class="memname"> 252 </table>
201 <tr> 253 </div>
202 <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> 254 <div class="memdoc">
203 </tr> 255
204 </table> 256 <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>
205 </div> 257
206 <div class="memdoc"> 258 </div>
207 259 </div>
208 <p> 260 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
209 261 <div class="memitem">
210 <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> 262 <div class="memproto">
211 263 <table class="memname">
212 </div> 264 <tr>
213 </div><p> 265 <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>
214 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> 266 </tr>
215 <div class="memitem"> 267 </table>
216 <div class="memproto"> 268 </div>
217 <table class="memname"> 269 <div class="memdoc">
218 <tr> 270
219 <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> 271 <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>
220 </tr> 272
221 </table> 273 </div>
222 </div> 274 </div>
223 <div class="memdoc"> 275 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
224 276 <div class="memitem">
225 <p> 277 <div class="memproto">
226 278 <table class="memname">
227 <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> 279 <tr>
228 280 <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>
229 </div> 281 </tr>
230 </div><p> 282 </table>
231 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> 283 </div>
232 <div class="memitem"> 284 <div class="memdoc">
233 <div class="memproto"> 285
234 <table class="memname"> 286 <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>
235 <tr> 287
236 <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> 288 </div>
237 </tr> 289 </div>
238 </table> 290 <hr/><h2>Member Enumeration Documentation</h2>
239 </div> 291 <a class="anchor" id="a2518e4922d77bc4e514d84cec9a0b577"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod" ref="a2518e4922d77bc4e514d84cec9a0b577" args="" -->
240 <div class="memdoc"> 292 <div class="memitem">
241 293 <div class="memproto">
242 <p> 294 <table class="memname">
243 295 <tr>
244 <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> 296 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod</a></td>
245 297 </tr>
246 </div> 298 </table>
247 </div><p> 299 </div>
248 <hr><h2>Member Enumeration Documentation</h2> 300 <div class="memdoc">
249 <a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod" ref="2518e4922d77bc4e514d84cec9a0b577" args="" --> 301
250 <div class="memitem"> 302 <p>ProcessTimestampMethod determines how the <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> handles timestamps for the data passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function of the plugin it wraps, in the case where the plugin is expecting frequency-domain data. </p>
251 <div class="memproto"> 303 <p>The <a class="el" href="namespaceVamp.html">Vamp</a> specification requires that the timestamp passed to the plugin for frequency-domain input should be that of the centre of the processing block, rather than the start as is the case for time-domain input.</p>
252 <table class="memname"> 304 <p>Since <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> aims to be transparent in use, it needs to handle this timestamp adjustment itself. However, some control is available over the method used for adjustment, by means of the ProcessTimestampMethod setting.</p>
253 <tr> 305 <p>If ProcessTimestampMethod is set to ShiftTimestamp (the default), then the data passed to the wrapped plugin will be calculated from the same input data block as passed to the wrapper, but the timestamp passed to the plugin will be advanced by half of the window size.</p>
254 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod</a> </td> 306 <p>If ProcessTimestampMethod is set to ShiftData, then the timestamp passed to the wrapped plugin will be the same as that passed to the process call of the wrapper, but the data block used to calculate the input will be shifted back (earlier) by half of the window size, with half a block of zero padding at the start of the first process call. This has the advantage of preserving the first half block of audio without any deterioration from window shaping.</p>
255 </tr> 307 <p>If ProcessTimestampMethod is set to NoShift, then no adjustment will be made and the timestamps will be incorrect. </p>
256 </table> 308 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
257 </div> 309 <tr><td valign="top"><em><a class="anchor" id="a2518e4922d77bc4e514d84cec9a0b577afcf39fe57ba29a908d4877c21de145dd"></a><!-- doxytag: member="ShiftTimestamp" ref="a2518e4922d77bc4e514d84cec9a0b577afcf39fe57ba29a908d4877c21de145dd" args="" -->ShiftTimestamp</em>&nbsp;</td><td>
258 <div class="memdoc"> 310 </td></tr>
259 311 <tr><td valign="top"><em><a class="anchor" id="a2518e4922d77bc4e514d84cec9a0b577a0838ff456d829e9096b5d968e6c55152"></a><!-- doxytag: member="ShiftData" ref="a2518e4922d77bc4e514d84cec9a0b577a0838ff456d829e9096b5d968e6c55152" args="" -->ShiftData</em>&nbsp;</td><td>
260 <p> 312 </td></tr>
261 ProcessTimestampMethod determines how the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> handles timestamps for the data passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function of the plugin it wraps, in the case where the plugin is expecting frequency-domain data. 313 <tr><td valign="top"><em><a class="anchor" id="a2518e4922d77bc4e514d84cec9a0b577ab06e8c6824802978d0be4074a556b297"></a><!-- doxytag: member="NoShift" ref="a2518e4922d77bc4e514d84cec9a0b577ab06e8c6824802978d0be4074a556b297" args="" -->NoShift</em>&nbsp;</td><td>
262 <p>
263 The <a class="el" href="namespaceVamp.html">Vamp</a> specification requires that the timestamp passed to the plugin for frequency-domain input should be that of the centre of the processing block, rather than the start as is the case for time-domain input.<p>
264 Since <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> aims to be transparent in use, it needs to handle this timestamp adjustment itself. However, some control is available over the method used for adjustment, by means of the ProcessTimestampMethod setting.<p>
265 If ProcessTimestampMethod is set to ShiftTimestamp (the default), then the data passed to the wrapped plugin will be calculated from the same input data block as passed to the wrapper, but the timestamp passed to the plugin will be advanced by half of the window size.<p>
266 If ProcessTimestampMethod is set to ShiftData, then the timestamp passed to the wrapped plugin will be the same as that passed to the process call of the wrapper, but the data block used to calculate the input will be shifted back (earlier) by half of the window size, with half a block of zero padding at the start of the first process call. This has the advantage of preserving the first half block of audio without any deterioration from window shaping.<p>
267 If ProcessTimestampMethod is set to NoShift, then no adjustment will be made and the timestamps will be incorrect. <dl compact><dt><b>Enumerator: </b></dt><dd>
268 <table border="0" cellspacing="2" cellpadding="0">
269 <tr><td valign="top"><em><a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577fcf39fe57ba29a908d4877c21de145dd"></a><!-- doxytag: member="ShiftTimestamp" ref="2518e4922d77bc4e514d84cec9a0b577fcf39fe57ba29a908d4877c21de145dd" args="" -->ShiftTimestamp</em>&nbsp;</td><td>
270 </td></tr>
271 <tr><td valign="top"><em><a class="anchor" name="2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152"></a><!-- doxytag: member="ShiftData" ref="2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152" args="" -->ShiftData</em>&nbsp;</td><td>
272 </td></tr>
273 <tr><td valign="top"><em><a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297"></a><!-- doxytag: member="NoShift" ref="2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297" args="" -->NoShift</em>&nbsp;</td><td>
274 </td></tr> 314 </td></tr>
275 </table> 315 </table>
316 </dd>
276 </dl> 317 </dl>
277 318
278 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h-source.html#l00137">137</a> of file <a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a>.</p> 319 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h_source.html#l00142">142</a> of file <a class="el" href="PluginInputDomainAdapter_8h_source.html">PluginInputDomainAdapter.h</a>.</p>
279 320
280 </div> 321 </div>
281 </div><p> 322 </div>
282 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> 323 <a class="anchor" id="a27e6a7c3f93f1618836792b588b767dc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::WindowType" ref="a27e6a7c3f93f1618836792b588b767dc" args="" -->
283 <div class="memitem"> 324 <div class="memitem">
284 <div class="memproto"> 325 <div class="memproto">
285 <table class="memname"> 326 <table class="memname">
286 <tr> 327 <tr>
287 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td> 328 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">Vamp::HostExt::PluginInputDomainAdapter::WindowType</a></td>
288 </tr> 329 </tr>
289 </table> 330 </table>
290 </div> 331 </div>
291 <div class="memdoc"> 332 <div class="memdoc">
292 333
293 <p> 334 <p>The set of supported window shapes. </p>
294 <dl compact><dt><b>Enumerator: </b></dt><dd> 335 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
295 <table border="0" cellspacing="2" cellpadding="0"> 336 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dca99b08cf7a7f4a1b52a09044ea12c6324"></a><!-- doxytag: member="RectangularWindow" ref="a27e6a7c3f93f1618836792b588b767dca99b08cf7a7f4a1b52a09044ea12c6324" args="" -->RectangularWindow</em>&nbsp;</td><td>
296 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td> 337 </td></tr>
297 </td></tr> 338 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dca77fd88a7d94fcd9c6c4aef30b86f077d"></a><!-- doxytag: member="BartlettWindow" ref="a27e6a7c3f93f1618836792b588b767dca77fd88a7d94fcd9c6c4aef30b86f077d" args="" -->BartlettWindow</em>&nbsp;</td><td>
298 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td> 339 </td></tr>
340 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dcaae5133bd639336a5c31378f4c2939d42"></a><!-- doxytag: member="TriangularWindow" ref="a27e6a7c3f93f1618836792b588b767dcaae5133bd639336a5c31378f4c2939d42" args="" -->TriangularWindow</em>&nbsp;</td><td>
341 <p>synonym for RectangularWindow </p>
342 </td></tr>
343 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dca9d522bff8d5884a8ba57d5a8c7e113c8"></a><!-- doxytag: member="HammingWindow" ref="a27e6a7c3f93f1618836792b588b767dca9d522bff8d5884a8ba57d5a8c7e113c8" args="" -->HammingWindow</em>&nbsp;</td><td>
344 <p>synonym for BartlettWindow </p>
345 </td></tr>
346 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dcacad78947b6c8db20feb5ddf208ac1108"></a><!-- doxytag: member="HanningWindow" ref="a27e6a7c3f93f1618836792b588b767dcacad78947b6c8db20feb5ddf208ac1108" args="" -->HanningWindow</em>&nbsp;</td><td>
347 </td></tr>
348 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dcadc87b20cfb5f1ddd23ebc281e3e47916"></a><!-- doxytag: member="HannWindow" ref="a27e6a7c3f93f1618836792b588b767dcadc87b20cfb5f1ddd23ebc281e3e47916" args="" -->HannWindow</em>&nbsp;</td><td>
349 <p>synonym for HannWindow </p>
350 </td></tr>
351 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dca2e298b1bee28272721953b2921891da6"></a><!-- doxytag: member="BlackmanWindow" ref="a27e6a7c3f93f1618836792b588b767dca2e298b1bee28272721953b2921891da6" args="" -->BlackmanWindow</em>&nbsp;</td><td>
352 <p>synonym for HanningWindow </p>
353 </td></tr>
354 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dcaa6a2f46966a46cc7abdf2df74270999e"></a><!-- doxytag: member="NuttallWindow" ref="a27e6a7c3f93f1618836792b588b767dcaa6a2f46966a46cc7abdf2df74270999e" args="" -->NuttallWindow</em>&nbsp;</td><td>
355 </td></tr>
356 <tr><td valign="top"><em><a class="anchor" id="a27e6a7c3f93f1618836792b588b767dca7cbf5d8c58f33bcfa28e3a5863d6ac94"></a><!-- doxytag: member="BlackmanHarrisWindow" ref="a27e6a7c3f93f1618836792b588b767dca7cbf5d8c58f33bcfa28e3a5863d6ac94" args="" -->BlackmanHarrisWindow</em>&nbsp;</td><td>
299 </td></tr> 357 </td></tr>
300 </table> 358 </table>
359 </dd>
301 </dl> 360 </dl>
302 361
303 <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> 362 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h_source.html#l00195">195</a> of file <a class="el" href="PluginInputDomainAdapter_8h_source.html">PluginInputDomainAdapter.h</a>.</p>
304 363
305 </div> 364 </div>
306 </div><p> 365 </div>
307 <hr><h2>Constructor &amp; Destructor Documentation</h2> 366 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
308 <a class="anchor" name="878e7275acdb77efc7a802944305039d"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter" ref="878e7275acdb77efc7a802944305039d" args="(Plugin *plugin)" --> 367 <div class="memitem">
309 <div class="memitem"> 368 <div class="memproto">
310 <div class="memproto"> 369 <table class="memname">
311 <table class="memname"> 370 <tr>
312 <tr> 371 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
313 <td class="memname">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter </td> 372 </tr>
314 <td>(</td> 373 </table>
315 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td> 374 </div>
316 <td class="paramname"> <em>plugin</em> </td> 375 <div class="memdoc">
317 <td>&nbsp;)&nbsp;</td> 376 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
377 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
378 </td></tr>
379 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
380 </td></tr>
381 </table>
382 </dd>
383 </dl>
384
385 <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>
386
387 </div>
388 </div>
389 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
390 <a class="anchor" id="a878e7275acdb77efc7a802944305039d"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter" ref="a878e7275acdb77efc7a802944305039d" args="(Plugin *plugin)" -->
391 <div class="memitem">
392 <div class="memproto">
393 <table class="memname">
394 <tr>
395 <td class="memname">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter </td>
396 <td>(</td>
397 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td>
398 <td class="paramname"><em>plugin</em></td><td>)</td>
318 <td></td> 399 <td></td>
319 </tr> 400 </tr>
320 </table> 401 </table>
321 </div> 402 </div>
322 <div class="memdoc"> 403 <div class="memdoc">
323 404
324 <p> 405 <p>Construct a <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> wrapping the given plugin. </p>
325 Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> wrapping the given plugin. 406 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p>
326 <p> 407
327 The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. 408 </div>
328 </div> 409 </div>
329 </div><p> 410 <a class="anchor" id="aba2cbfa650d8a7c9181dbdb49b10aad0"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter" ref="aba2cbfa650d8a7c9181dbdb49b10aad0" args="()" -->
330 <a class="anchor" name="ba2cbfa650d8a7c9181dbdb49b10aad0"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter" ref="ba2cbfa650d8a7c9181dbdb49b10aad0" args="()" --> 411 <div class="memitem">
331 <div class="memitem"> 412 <div class="memproto">
332 <div class="memproto"> 413 <table class="memname">
333 <table class="memname"> 414 <tr>
334 <tr> 415 <td class="memname">virtual Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter </td>
335 <td class="memname">virtual Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter </td> 416 <td>(</td>
336 <td>(</td> 417 <td class="paramname"></td><td>)</td>
337 <td class="paramname"> </td>
338 <td>&nbsp;)&nbsp;</td>
339 <td><code> [virtual]</code></td> 418 <td><code> [virtual]</code></td>
340 </tr> 419 </tr>
341 </table> 420 </table>
342 </div> 421 </div>
343 <div class="memdoc"> 422 <div class="memdoc">
344 423
345 <p> 424 </div>
346 425 </div>
347 </div> 426 <hr/><h2>Member Function Documentation</h2>
348 </div><p> 427 <a class="anchor" id="a72d201eca10ec73bf16e07984f58f94c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::initialise" ref="a72d201eca10ec73bf16e07984f58f94c" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
349 <hr><h2>Member Function Documentation</h2> 428 <div class="memitem">
350 <a class="anchor" name="72d201eca10ec73bf16e07984f58f94c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::initialise" ref="72d201eca10ec73bf16e07984f58f94c" args="(size_t channels, size_t stepSize, size_t blockSize)" --> 429 <div class="memproto">
351 <div class="memitem"> 430 <table class="memname">
352 <div class="memproto"> 431 <tr>
353 <table class="memname"> 432 <td class="memname">bool Vamp::HostExt::PluginInputDomainAdapter::initialise </td>
354 <tr> 433 <td>(</td>
355 <td class="memname">bool Vamp::HostExt::PluginInputDomainAdapter::initialise </td> 434 <td class="paramtype">size_t&#160;</td>
356 <td>(</td> 435 <td class="paramname"><em>inputChannels</em>, </td>
357 <td class="paramtype">size_t&nbsp;</td>
358 <td class="paramname"> <em>inputChannels</em>, </td>
359 </tr> 436 </tr>
360 <tr> 437 <tr>
361 <td class="paramkey"></td> 438 <td class="paramkey"></td>
362 <td></td> 439 <td></td>
363 <td class="paramtype">size_t&nbsp;</td> 440 <td class="paramtype">size_t&#160;</td>
364 <td class="paramname"> <em>stepSize</em>, </td> 441 <td class="paramname"><em>stepSize</em>, </td>
365 </tr> 442 </tr>
366 <tr> 443 <tr>
367 <td class="paramkey"></td> 444 <td class="paramkey"></td>
368 <td></td> 445 <td></td>
369 <td class="paramtype">size_t&nbsp;</td> 446 <td class="paramtype">size_t&#160;</td>
370 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td> 447 <td class="paramname"><em>blockSize</em>&#160;</td>
371 </tr> 448 </tr>
372 <tr> 449 <tr>
373 <td></td> 450 <td></td>
374 <td>)</td> 451 <td>)</td>
375 <td></td><td></td><td><code> [virtual]</code></td> 452 <td></td><td><code> [virtual]</code></td>
376 </tr> 453 </tr>
377 </table> 454 </table>
378 </div> 455 </div>
379 <div class="memdoc"> 456 <div class="memdoc">
380 457
381 <p> 458 <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>
382 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). 459 <p>The input sample rate should have been already specified at construction time.</p>
383 <p> 460 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
384 The input sample rate should have been already specified at construction time.<p> 461
385 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. 462 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
386 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p> 463
387 464 </div>
388 </div> 465 </div>
389 </div><p> 466 <a class="anchor" id="a984a12b5b4cb0be1e2f7a0aa84106c4c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::reset" ref="a984a12b5b4cb0be1e2f7a0aa84106c4c" args="()" -->
390 <a class="anchor" name="984a12b5b4cb0be1e2f7a0aa84106c4c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::reset" ref="984a12b5b4cb0be1e2f7a0aa84106c4c" args="()" --> 467 <div class="memitem">
391 <div class="memitem"> 468 <div class="memproto">
392 <div class="memproto"> 469 <table class="memname">
393 <table class="memname"> 470 <tr>
394 <tr> 471 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::reset </td>
395 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::reset </td> 472 <td>(</td>
396 <td>(</td> 473 <td class="paramname"></td><td>)</td>
397 <td class="paramname"> </td>
398 <td>&nbsp;)&nbsp;</td>
399 <td><code> [virtual]</code></td> 474 <td><code> [virtual]</code></td>
400 </tr> 475 </tr>
401 </table> 476 </table>
402 </div> 477 </div>
403 <div class="memdoc"> 478 <div class="memdoc">
404 479
405 <p> 480 <p>Reset the plugin after use, to prepare it for another clean run. </p>
406 Reset the plugin after use, to prepare it for another clean run. 481 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
407 <p> 482
408 Not called for the first initialisation (i.e. initialise must also do a reset). 483 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
409 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p> 484
410 485 </div>
411 </div> 486 </div>
412 </div><p> 487 <a class="anchor" id="a47ff1ed72889f323da63f8abc9ea581a"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getInputDomain" ref="a47ff1ed72889f323da63f8abc9ea581a" args="() const " -->
413 <a class="anchor" name="47ff1ed72889f323da63f8abc9ea581a"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getInputDomain" ref="47ff1ed72889f323da63f8abc9ea581a" args="() const " --> 488 <div class="memitem">
414 <div class="memitem"> 489 <div class="memproto">
415 <div class="memproto"> 490 <table class="memname">
416 <table class="memname"> 491 <tr>
417 <tr> 492 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginInputDomainAdapter::getInputDomain </td>
418 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginInputDomainAdapter::getInputDomain </td> 493 <td>(</td>
419 <td>(</td> 494 <td class="paramname"></td><td>)</td>
420 <td class="paramname"> </td>
421 <td>&nbsp;)&nbsp;</td>
422 <td> const<code> [virtual]</code></td> 495 <td> const<code> [virtual]</code></td>
423 </tr> 496 </tr>
424 </table> 497 </table>
425 </div> 498 </div>
426 <div class="memdoc"> 499 <div class="memdoc">
427 500
428 <p> 501 <p>Get the plugin's required input domain. </p>
429 Get the plugin's required input domain. 502 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" 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>
430 <p> 503 <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_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" 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>
431 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" 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> 504
432 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_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" 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. 505 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">Vamp::HostExt::PluginWrapper</a>.</p>
433 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">Vamp::HostExt::PluginWrapper</a>.</p> 506
434 507 </div>
435 </div> 508 </div>
436 </div><p> 509 <a class="anchor" id="ad979af9f1cbf2eeb16f4eaedb4a4f565"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize" ref="ad979af9f1cbf2eeb16f4eaedb4a4f565" args="() const " -->
437 <a class="anchor" name="d979af9f1cbf2eeb16f4eaedb4a4f565"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize" ref="d979af9f1cbf2eeb16f4eaedb4a4f565" args="() const " --> 510 <div class="memitem">
438 <div class="memitem"> 511 <div class="memproto">
439 <div class="memproto"> 512 <table class="memname">
440 <table class="memname"> 513 <tr>
441 <tr> 514 <td class="memname">size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize </td>
442 <td class="memname">size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize </td> 515 <td>(</td>
443 <td>(</td> 516 <td class="paramname"></td><td>)</td>
444 <td class="paramname"> </td>
445 <td>&nbsp;)&nbsp;</td>
446 <td> const<code> [virtual]</code></td> 517 <td> const<code> [virtual]</code></td>
447 </tr> 518 </tr>
448 </table> 519 </table>
449 </div> 520 </div>
450 <div class="memdoc"> 521 <div class="memdoc">
451 522
452 <p> 523 <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_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function) for the plugin. </p>
453 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_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function) for the plugin. 524 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c" 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>
454 <p> 525 <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_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c" 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>
455 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> 526
456 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_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. 527 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p>
457 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p> 528
458 529 </div>
459 </div> 530 </div>
460 </div><p> 531 <a class="anchor" id="a4cf40d09d02022b1962ff17bb0324ea5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize" ref="a4cf40d09d02022b1962ff17bb0324ea5" args="() const " -->
461 <a class="anchor" name="4cf40d09d02022b1962ff17bb0324ea5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize" ref="4cf40d09d02022b1962ff17bb0324ea5" args="() const " --> 532 <div class="memitem">
462 <div class="memitem"> 533 <div class="memproto">
463 <div class="memproto"> 534 <table class="memname">
464 <table class="memname"> 535 <tr>
465 <tr> 536 <td class="memname">size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize </td>
466 <td class="memname">size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize </td> 537 <td>(</td>
467 <td>(</td> 538 <td class="paramname"></td><td>)</td>
468 <td class="paramname"> </td>
469 <td>&nbsp;)&nbsp;</td>
470 <td> const<code> [virtual]</code></td> 539 <td> const<code> [virtual]</code></td>
471 </tr> 540 </tr>
472 </table> 541 </table>
473 </div> 542 </div>
474 <div class="memdoc"> 543 <div class="memdoc">
475 544
476 <p> 545 <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_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function). </p>
477 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_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> function). 546 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c" 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>
478 <p> 547 <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_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c" 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>
479 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> 548
480 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_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. 549 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p>
481 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p> 550
482 551 </div>
483 </div> 552 </div>
484 </div><p> 553 <a class="anchor" id="ab36a81ac9a0ded8d83c6b855263c0231"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::process" ref="ab36a81ac9a0ded8d83c6b855263c0231" args="(const float *const *inputBuffers, RealTime timestamp)" -->
485 <a class="anchor" name="b36a81ac9a0ded8d83c6b855263c0231"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::process" ref="b36a81ac9a0ded8d83c6b855263c0231" args="(const float *const *inputBuffers, RealTime timestamp)" --> 554 <div class="memitem">
486 <div class="memitem"> 555 <div class="memproto">
487 <div class="memproto"> 556 <table class="memname">
488 <table class="memname"> 557 <tr>
489 <tr> 558 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginInputDomainAdapter::process </td>
490 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginInputDomainAdapter::process </td> 559 <td>(</td>
491 <td>(</td> 560 <td class="paramtype">const float *const *&#160;</td>
492 <td class="paramtype">const float *const *&nbsp;</td> 561 <td class="paramname"><em>inputBuffers</em>, </td>
493 <td class="paramname"> <em>inputBuffers</em>, </td>
494 </tr> 562 </tr>
495 <tr> 563 <tr>
496 <td class="paramkey"></td> 564 <td class="paramkey"></td>
497 <td></td> 565 <td></td>
498 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td> 566 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td>
499 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td> 567 <td class="paramname"><em>timestamp</em>&#160;</td>
500 </tr> 568 </tr>
501 <tr> 569 <tr>
502 <td></td> 570 <td></td>
503 <td>)</td> 571 <td>)</td>
504 <td></td><td></td><td><code> [virtual]</code></td> 572 <td></td><td><code> [virtual]</code></td>
505 </tr> 573 </tr>
506 </table> 574 </table>
507 </div> 575 </div>
508 <div class="memdoc"> 576 <div class="memdoc">
509 577
510 <p> 578 <p>Process a single block of input data. </p>
511 Process a single block of input data. 579 <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>
512 <p> 580 <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>
513 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> 581 <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>
514 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> 582
515 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.) 583 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p>
516 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p> 584
517 585 </div>
518 </div> 586 </div>
519 </div><p> 587 <a class="anchor" id="a1d7366f8cab39abc01ebfc7bf7ca8089"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod" ref="a1d7366f8cab39abc01ebfc7bf7ca8089" args="(ProcessTimestampMethod)" -->
520 <a class="anchor" name="1d7366f8cab39abc01ebfc7bf7ca8089"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod" ref="1d7366f8cab39abc01ebfc7bf7ca8089" args="(ProcessTimestampMethod)" --> 588 <div class="memitem">
521 <div class="memitem"> 589 <div class="memproto">
522 <div class="memproto"> 590 <table class="memname">
523 <table class="memname"> 591 <tr>
524 <tr> 592 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod </td>
525 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod </td> 593 <td>(</td>
526 <td>(</td> 594 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>&#160;</td>
527 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>&nbsp;</td> 595 <td class="paramname"></td><td>)</td>
528 <td class="paramname"> </td>
529 <td>&nbsp;)&nbsp;</td>
530 <td></td> 596 <td></td>
531 </tr> 597 </tr>
532 </table> 598 </table>
533 </div> 599 </div>
534 <div class="memdoc"> 600 <div class="memdoc">
535 601
536 <p> 602 <p>Set the method used for timestamp adjustment in plugins taking frequency-domain input. </p>
537 Set the method used for timestamp adjustment in plugins taking frequency-domain input. 603 <p>See the ProcessTimestampMethod documentation for details.</p>
538 <p> 604 <p>This function must be called before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a>. </p>
539 See the ProcessTimestampMethod documentation for details.<p> 605
540 This function must be called before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a>. 606 </div>
541 </div> 607 </div>
542 </div><p> 608 <a class="anchor" id="acfc7a9121f678fd085448f68f15c9eae"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod" ref="acfc7a9121f678fd085448f68f15c9eae" args="() const " -->
543 <a class="anchor" name="cfc7a9121f678fd085448f68f15c9eae"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod" ref="cfc7a9121f678fd085448f68f15c9eae" args="() const " --> 609 <div class="memitem">
544 <div class="memitem"> 610 <div class="memproto">
545 <div class="memproto"> 611 <table class="memname">
546 <table class="memname"> 612 <tr>
547 <tr> 613 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a> Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod </td>
548 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a> Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod </td> 614 <td>(</td>
549 <td>(</td> 615 <td class="paramname"></td><td>)</td>
550 <td class="paramname"> </td>
551 <td>&nbsp;)&nbsp;</td>
552 <td> const</td> 616 <td> const</td>
553 </tr> 617 </tr>
554 </table> 618 </table>
555 </div> 619 </div>
556 <div class="memdoc"> 620 <div class="memdoc">
557 621
558 <p> 622 <p>Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input. </p>
559 Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input. 623 <p>See the ProcessTimestampMethod documentation for details. </p>
560 <p> 624
561 See the ProcessTimestampMethod documentation for details. 625 </div>
562 </div> 626 </div>
563 </div><p> 627 <a class="anchor" id="ac1ab6af0fcda0a4c3f050c54b2db4769"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment" ref="ac1ab6af0fcda0a4c3f050c54b2db4769" args="() const " -->
564 <a class="anchor" name="c1ab6af0fcda0a4c3f050c54b2db4769"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment" ref="c1ab6af0fcda0a4c3f050c54b2db4769" args="() const " --> 628 <div class="memitem">
565 <div class="memitem"> 629 <div class="memproto">
566 <div class="memproto"> 630 <table class="memname">
567 <table class="memname"> 631 <tr>
568 <tr> 632 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment </td>
569 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment </td> 633 <td>(</td>
570 <td>(</td> 634 <td class="paramname"></td><td>)</td>
571 <td class="paramname"> </td>
572 <td>&nbsp;)&nbsp;</td>
573 <td> const</td> 635 <td> const</td>
574 </tr> 636 </tr>
575 </table> 637 </table>
576 </div> 638 </div>
577 <div class="memdoc"> 639 <div class="memdoc">
578 640
579 <p> 641 <p>Return the amount by which the timestamps supplied to <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> are being incremented when they are passed to the plugin's own <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> implementation. </p>
580 Return the amount by which the timestamps supplied to <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> are being incremented when they are passed to the plugin's own <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231" title="Process a single block of input data.">process()</a> implementation. 642 <p>The <a class="el" href="namespaceVamp.html">Vamp</a> API mandates that the timestamp passed to the plugin for time-domain input should be the time of the first sample in the block, but the timestamp passed for frequency-domain input should be the timestamp of the centre of the block.</p>
581 <p> 643 <p>The <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> adjusts its timestamps properly so that the plugin receives correct times, but in some circumstances (such as for establishing the correct timing of implicitly-timed features, i.e. features without their own timestamps) the host may need to be aware that this adjustment is taking place.</p>
582 The <a class="el" href="namespaceVamp.html">Vamp</a> API mandates that the timestamp passed to the plugin for time-domain input should be the time of the first sample in the block, but the timestamp passed for frequency-domain input should be the timestamp of the centre of the block.<p> 644 <p>If the plugin requires time-domain input or the <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> is configured with its ProcessTimestampMethod set to ShiftData instead of ShiftTimestamp, then this function will return zero.</p>
583 The <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> adjusts its timestamps properly so that the plugin receives correct times, but in some circumstances (such as for establishing the correct timing of implicitly-timed features, i.e. features without their own timestamps) the host may need to be aware that this adjustment is taking place.<p> 645 <p>The result of calling this function before <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c" 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> has been called is undefined. </p>
584 If the plugin requires time-domain input or the <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input...">PluginInputDomainAdapter</a> is configured with its ProcessTimestampMethod set to ShiftData instead of ShiftTimestamp, then this function will return zero.<p> 646
585 The result of calling this function before <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> has been called is undefined. 647 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
586 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> 648
587 649 </div>
588 </div> 650 </div>
589 </div><p> 651 <a class="anchor" id="ab143065e1a65f1d860cb26b32d5a9c1e"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getWindowType" ref="ab143065e1a65f1d860cb26b32d5a9c1e" args="() const " -->
590 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " --> 652 <div class="memitem">
591 <div class="memitem"> 653 <div class="memproto">
592 <div class="memproto"> 654 <table class="memname">
593 <table class="memname"> 655 <tr>
594 <tr> 656 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">WindowType</a> Vamp::HostExt::PluginInputDomainAdapter::getWindowType </td>
595 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td> 657 <td>(</td>
596 <td>(</td> 658 <td class="paramname"></td><td>)</td>
597 <td class="paramname"> </td> 659 <td> const</td>
598 <td>&nbsp;)&nbsp;</td> 660 </tr>
599 <td> const<code> [virtual, inherited]</code></td> 661 </table>
600 </tr> 662 </div>
601 </table> 663 <div class="memdoc">
602 </div> 664
603 <div class="memdoc"> 665 <p>Return the current window shape. </p>
604 666 <p>The default is HanningWindow. </p>
605 <p> 667
606 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. 668 </div>
607 <p> 669 </div>
608 670 <a class="anchor" id="a652bf9f25352a4fa89dd80ff816558d4"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setWindowType" ref="a652bf9f25352a4fa89dd80ff816558d4" args="(WindowType type)" -->
609 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 671 <div class="memitem">
610 672 <div class="memproto">
611 </div> 673 <table class="memname">
612 </div><p> 674 <tr>
613 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " --> 675 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::setWindowType </td>
614 <div class="memitem"> 676 <td>(</td>
615 <div class="memproto"> 677 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a27e6a7c3f93f1618836792b588b767dc">WindowType</a>&#160;</td>
616 <table class="memname"> 678 <td class="paramname"><em>type</em></td><td>)</td>
617 <tr> 679 <td></td>
618 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td> 680 </tr>
619 <td>(</td> 681 </table>
620 <td class="paramname"> </td> 682 </div>
621 <td>&nbsp;)&nbsp;</td> 683 <div class="memdoc">
622 <td> const<code> [virtual, inherited]</code></td> 684
623 </tr> 685 <p>Set the current window shape. </p>
624 </table> 686
625 </div> 687 </div>
626 <div class="memdoc"> 688 </div>
627 689 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getVampApiVersion" ref="a74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
628 <p> 690 <div class="memitem">
629 Get the computer-usable name of the plugin. 691 <div class="memproto">
630 <p> 692 <table class="memname">
631 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> 693 <tr>
632 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> 694 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
633 Example: "zero_crossings" 695 <td>(</td>
634 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 696 <td class="paramname"></td><td>)</td>
635 697 <td> const<code> [virtual, inherited]</code></td>
636 </div> 698 </tr>
637 </div><p> 699 </table>
638 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " --> 700 </div>
639 <div class="memitem"> 701 <div class="memdoc">
640 <div class="memproto"> 702
641 <table class="memname"> 703 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
642 <tr> 704
643 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td> 705 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
644 <td>(</td> 706
645 <td class="paramname"> </td> 707 </div>
646 <td>&nbsp;)&nbsp;</td> 708 </div>
647 <td> const<code> [virtual, inherited]</code></td> 709 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getIdentifier" ref="a4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
648 </tr> 710 <div class="memitem">
649 </table> 711 <div class="memproto">
650 </div> 712 <table class="memname">
651 <div class="memdoc"> 713 <tr>
652 714 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
653 <p> 715 <td>(</td>
654 Get a human-readable name or title of the plugin. 716 <td class="paramname"></td><td>)</td>
655 <p> 717 <td> const<code> [virtual, inherited]</code></td>
656 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> 718 </tr>
657 Example: "Zero Crossings" 719 </table>
658 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 720 </div>
659 721 <div class="memdoc">
660 </div> 722
661 </div><p> 723 <p>Get the computer-usable name of the plugin. </p>
662 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " --> 724 <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>
663 <div class="memitem"> 725 <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>
664 <div class="memproto"> 726 <p>Example: "zero_crossings" </p>
665 <table class="memname"> 727
666 <tr> 728 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
667 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td> 729
668 <td>(</td> 730 </div>
669 <td class="paramname"> </td> 731 </div>
670 <td>&nbsp;)&nbsp;</td> 732 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getName" ref="ac70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
671 <td> const<code> [virtual, inherited]</code></td> 733 <div class="memitem">
672 </tr> 734 <div class="memproto">
673 </table> 735 <table class="memname">
674 </div> 736 <tr>
675 <div class="memdoc"> 737 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
676 738 <td>(</td>
677 <p> 739 <td class="paramname"></td><td>)</td>
678 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". 740 <td> const<code> [virtual, inherited]</code></td>
679 <p> 741 </tr>
680 May be empty if the name has said it all already.<p> 742 </table>
681 Example: "Detect and count zero crossing points" 743 </div>
682 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 744 <div class="memdoc">
683 745
684 </div> 746 <p>Get a human-readable name or title of the plugin. </p>
685 </div><p> 747 <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>
686 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " --> 748 <p>Example: "Zero Crossings" </p>
687 <div class="memitem"> 749
688 <div class="memproto"> 750 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
689 <table class="memname"> 751
690 <tr> 752 </div>
691 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td> 753 </div>
692 <td>(</td> 754 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getDescription" ref="ac334f699c0996055942785410d8a065c" args="() const " -->
693 <td class="paramname"> </td> 755 <div class="memitem">
694 <td>&nbsp;)&nbsp;</td> 756 <div class="memproto">
695 <td> const<code> [virtual, inherited]</code></td> 757 <table class="memname">
696 </tr> 758 <tr>
697 </table> 759 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
698 </div> 760 <td>(</td>
699 <div class="memdoc"> 761 <td class="paramname"></td><td>)</td>
700 762 <td> const<code> [virtual, inherited]</code></td>
701 <p> 763 </tr>
702 Get the name of the author or vendor of the plugin in human-readable form. 764 </table>
703 <p> 765 </div>
704 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. 766 <div class="memdoc">
705 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 767
706 768 <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>
707 </div> 769 <p>May be empty if the name has said it all already.</p>
708 </div><p> 770 <p>Example: "Detect and count zero crossing points" </p>
709 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " --> 771
710 <div class="memitem"> 772 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
711 <div class="memproto"> 773
712 <table class="memname"> 774 </div>
713 <tr> 775 </div>
714 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td> 776 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMaker" ref="a59d5a2298951b317995675e664b1c7bb" args="() const " -->
715 <td>(</td> 777 <div class="memitem">
716 <td class="paramname"> </td> 778 <div class="memproto">
717 <td>&nbsp;)&nbsp;</td> 779 <table class="memname">
718 <td> const<code> [virtual, inherited]</code></td> 780 <tr>
719 </tr> 781 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
720 </table> 782 <td>(</td>
721 </div> 783 <td class="paramname"></td><td>)</td>
722 <div class="memdoc"> 784 <td> const<code> [virtual, inherited]</code></td>
723 785 </tr>
724 <p> 786 </table>
725 Get the version number of the plugin. 787 </div>
726 <p> 788 <div class="memdoc">
727 789
728 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 790 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
729 791 <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>
730 </div> 792
731 </div><p> 793 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
732 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " --> 794
733 <div class="memitem"> 795 </div>
734 <div class="memproto"> 796 </div>
735 <table class="memname"> 797 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPluginVersion" ref="a47e1acf1696813008324a915c9ba59c5" args="() const " -->
736 <tr> 798 <div class="memitem">
737 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td> 799 <div class="memproto">
738 <td>(</td> 800 <table class="memname">
739 <td class="paramname"> </td> 801 <tr>
740 <td>&nbsp;)&nbsp;</td> 802 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
741 <td> const<code> [virtual, inherited]</code></td> 803 <td>(</td>
742 </tr> 804 <td class="paramname"></td><td>)</td>
743 </table> 805 <td> const<code> [virtual, inherited]</code></td>
744 </div> 806 </tr>
745 <div class="memdoc"> 807 </table>
746 808 </div>
747 <p> 809 <div class="memdoc">
748 Get the copyright statement or licensing summary for the plugin. 810
749 <p> 811 <p>Get the version number of the plugin. </p>
750 This can be an informative text, without the same presentation constraints as mentioned for getMaker above. 812
751 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 813 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
752 814
753 </div> 815 </div>
754 </div><p> 816 </div>
755 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " --> 817 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getCopyright" ref="ae14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
756 <div class="memitem"> 818 <div class="memitem">
757 <div class="memproto"> 819 <div class="memproto">
758 <table class="memname"> 820 <table class="memname">
759 <tr> 821 <tr>
760 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td> 822 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
761 <td>(</td> 823 <td>(</td>
762 <td class="paramname"> </td> 824 <td class="paramname"></td><td>)</td>
763 <td>&nbsp;)&nbsp;</td> 825 <td> const<code> [virtual, inherited]</code></td>
764 <td> const<code> [virtual, inherited]</code></td> 826 </tr>
765 </tr> 827 </table>
766 </table> 828 </div>
767 </div> 829 <div class="memdoc">
768 <div class="memdoc"> 830
769 831 <p>Get the copyright statement or licensing summary for the plugin. </p>
770 <p> 832 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
771 Get the controllable parameters of this plugin. 833
772 <p> 834 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
773 835
774 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 836 </div>
775 837 </div>
776 </div> 838 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getParameterDescriptors" ref="a9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
777 </div><p> 839 <div class="memitem">
778 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " --> 840 <div class="memproto">
779 <div class="memitem"> 841 <table class="memname">
780 <div class="memproto"> 842 <tr>
781 <table class="memname"> 843 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
782 <tr> 844 <td>(</td>
783 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td> 845 <td class="paramname"></td><td>)</td>
784 <td>(</td> 846 <td> const<code> [virtual, inherited]</code></td>
785 <td class="paramtype">std::string&nbsp;</td> 847 </tr>
786 <td class="paramname"> </td> 848 </table>
787 <td>&nbsp;)&nbsp;</td> 849 </div>
788 <td> const<code> [virtual, inherited]</code></td> 850 <div class="memdoc">
789 </tr> 851
790 </table> 852 <p>Get the controllable parameters of this plugin. </p>
791 </div> 853
792 <div class="memdoc"> 854 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
793 855
794 <p> 856 </div>
795 Get the value of a named parameter. 857 </div>
796 <p> 858 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getParameter" ref="a034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
797 The argument is the identifier field from that parameter's descriptor. 859 <div class="memitem">
798 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 860 <div class="memproto">
799 861 <table class="memname">
800 </div> 862 <tr>
801 </div><p> 863 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
802 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" --> 864 <td>(</td>
803 <div class="memitem"> 865 <td class="paramtype">std::string&#160;</td>
804 <div class="memproto"> 866 <td class="paramname"></td><td>)</td>
805 <table class="memname"> 867 <td> const<code> [virtual, inherited]</code></td>
806 <tr> 868 </tr>
807 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td> 869 </table>
808 <td>(</td> 870 </div>
809 <td class="paramtype">std::string&nbsp;</td> 871 <div class="memdoc">
872
873 <p>Get the value of a named parameter. </p>
874 <p>The argument is the identifier field from that parameter's descriptor. </p>
875
876 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
877
878 </div>
879 </div>
880 <a class="anchor" id="a651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setParameter" ref="a651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
881 <div class="memitem">
882 <div class="memproto">
883 <table class="memname">
884 <tr>
885 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
886 <td>(</td>
887 <td class="paramtype">std::string&#160;</td>
810 <td class="paramname">, </td> 888 <td class="paramname">, </td>
811 </tr> 889 </tr>
812 <tr> 890 <tr>
813 <td class="paramkey"></td> 891 <td class="paramkey"></td>
814 <td></td> 892 <td></td>
815 <td class="paramtype">float&nbsp;</td> 893 <td class="paramtype">float&#160;</td>
816 <td class="paramname"></td><td>&nbsp;</td> 894 <td class="paramname">&#160;</td>
817 </tr> 895 </tr>
818 <tr> 896 <tr>
819 <td></td> 897 <td></td>
820 <td>)</td> 898 <td>)</td>
821 <td></td><td></td><td><code> [virtual, inherited]</code></td> 899 <td></td><td><code> [virtual, inherited]</code></td>
822 </tr> 900 </tr>
823 </table> 901 </table>
824 </div> 902 </div>
825 <div class="memdoc"> 903 <div class="memdoc">
826 904
827 <p> 905 <p>Set a named parameter. </p>
828 Set a named parameter. 906 <p>The first argument is the identifier field from that parameter's descriptor. </p>
829 <p> 907
830 The first argument is the identifier field from that parameter's descriptor. 908 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
831 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 909
832 910 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
833 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 911
834 912 </div>
835 </div> 913 </div>
836 </div><p> 914 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPrograms" ref="a131fbe1df81215020b9aa8cecef4c802" args="() const " -->
837 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " --> 915 <div class="memitem">
838 <div class="memitem"> 916 <div class="memproto">
839 <div class="memproto"> 917 <table class="memname">
840 <table class="memname"> 918 <tr>
841 <tr> 919 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
842 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td> 920 <td>(</td>
843 <td>(</td> 921 <td class="paramname"></td><td>)</td>
844 <td class="paramname"> </td> 922 <td> const<code> [virtual, inherited]</code></td>
845 <td>&nbsp;)&nbsp;</td> 923 </tr>
846 <td> const<code> [virtual, inherited]</code></td> 924 </table>
847 </tr> 925 </div>
848 </table> 926 <div class="memdoc">
849 </div> 927
850 <div class="memdoc"> 928 <p>Get the program settings available in this plugin. </p>
851 929 <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>
852 <p> 930 <p>The programs must have unique names. </p>
853 Get the program settings available in this plugin. 931
854 <p> 932 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
855 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> 933
856 The programs must have unique names. 934 </div>
857 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 935 </div>
858 936 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getCurrentProgram" ref="a7a312dd42d161064b70afd7ff24c0651" args="() const " -->
859 </div> 937 <div class="memitem">
860 </div><p> 938 <div class="memproto">
861 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " --> 939 <table class="memname">
862 <div class="memitem"> 940 <tr>
863 <div class="memproto"> 941 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
864 <table class="memname"> 942 <td>(</td>
865 <tr> 943 <td class="paramname"></td><td>)</td>
866 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td> 944 <td> const<code> [virtual, inherited]</code></td>
867 <td>(</td> 945 </tr>
868 <td class="paramname"> </td> 946 </table>
869 <td>&nbsp;)&nbsp;</td> 947 </div>
870 <td> const<code> [virtual, inherited]</code></td> 948 <div class="memdoc">
871 </tr> 949
872 </table> 950 <p>Get the current program. </p>
873 </div> 951
874 <div class="memdoc"> 952 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
875 953
876 <p> 954 </div>
877 Get the current program. 955 </div>
878 <p> 956 <a class="anchor" id="a074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::selectProgram" ref="a074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
879 957 <div class="memitem">
880 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 958 <div class="memproto">
881 959 <table class="memname">
882 </div> 960 <tr>
883 </div><p> 961 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
884 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" --> 962 <td>(</td>
885 <div class="memitem"> 963 <td class="paramtype">std::string&#160;</td>
886 <div class="memproto"> 964 <td class="paramname"></td><td>)</td>
887 <table class="memname">
888 <tr>
889 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
890 <td>(</td>
891 <td class="paramtype">std::string&nbsp;</td>
892 <td class="paramname"> </td>
893 <td>&nbsp;)&nbsp;</td>
894 <td><code> [virtual, inherited]</code></td> 965 <td><code> [virtual, inherited]</code></td>
895 </tr> 966 </tr>
896 </table> 967 </table>
897 </div> 968 </div>
898 <div class="memdoc"> 969 <div class="memdoc">
899 970
900 <p> 971 <p>Select a program. </p>
901 Select a program. 972 <p>(If the given program name is not one of the available programs, do nothing.) </p>
902 <p> 973
903 (If the given program name is not one of the available programs, do nothing.) 974 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
904 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> 975
905 976 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
906 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 977
907 978 </div>
908 </div> 979 </div>
909 </div><p> 980 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMinChannelCount" ref="a2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
910 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " --> 981 <div class="memitem">
911 <div class="memitem"> 982 <div class="memproto">
912 <div class="memproto"> 983 <table class="memname">
913 <table class="memname"> 984 <tr>
914 <tr> 985 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
915 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td> 986 <td>(</td>
916 <td>(</td> 987 <td class="paramname"></td><td>)</td>
917 <td class="paramname"> </td> 988 <td> const<code> [virtual, inherited]</code></td>
918 <td>&nbsp;)&nbsp;</td> 989 </tr>
919 <td> const<code> [virtual, inherited]</code></td> 990 </table>
920 </tr> 991 </div>
921 </table> 992 <div class="memdoc">
922 </div> 993
923 <div class="memdoc"> 994 <p>Get the minimum supported number of input channels. </p>
924 995
925 <p> 996 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
926 Get the minimum supported number of input channels. 997
927 <p> 998 </div>
928 999 </div>
929 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 1000 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMaxChannelCount" ref="a985eb21f1827bfbc3950d6871b107a58" args="() const " -->
930 1001 <div class="memitem">
931 </div> 1002 <div class="memproto">
932 </div><p> 1003 <table class="memname">
933 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " --> 1004 <tr>
934 <div class="memitem"> 1005 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
935 <div class="memproto"> 1006 <td>(</td>
936 <table class="memname"> 1007 <td class="paramname"></td><td>)</td>
937 <tr> 1008 <td> const<code> [virtual, inherited]</code></td>
938 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td> 1009 </tr>
939 <td>(</td> 1010 </table>
940 <td class="paramname"> </td> 1011 </div>
941 <td>&nbsp;)&nbsp;</td> 1012 <div class="memdoc">
942 <td> const<code> [virtual, inherited]</code></td> 1013
943 </tr> 1014 <p>Get the maximum supported number of input channels. </p>
944 </table> 1015
945 </div> 1016 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
946 <div class="memdoc"> 1017
947 1018 </div>
948 <p> 1019 </div>
949 Get the maximum supported number of input channels. 1020 <a class="anchor" id="a5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getOutputDescriptors" ref="a5a9411305f713b4c9827844b89acd270" args="() const " -->
950 <p> 1021 <div class="memitem">
951 1022 <div class="memproto">
952 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 1023 <table class="memname">
953 1024 <tr>
954 </div> 1025 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
955 </div><p> 1026 <td>(</td>
956 <a class="anchor" name="5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getOutputDescriptors" ref="5a9411305f713b4c9827844b89acd270" args="() const " --> 1027 <td class="paramname"></td><td>)</td>
957 <div class="memitem"> 1028 <td> const<code> [virtual, inherited]</code></td>
958 <div class="memproto"> 1029 </tr>
959 <table class="memname"> 1030 </table>
960 <tr> 1031 </div>
961 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td> 1032 <div class="memdoc">
962 <td>(</td> 1033
963 <td class="paramname"> </td> 1034 <p>Get the outputs of this plugin. </p>
964 <td>&nbsp;)&nbsp;</td> 1035 <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>
965 <td> const<code> [virtual, inherited]</code></td> 1036
966 </tr> 1037 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
967 </table> 1038
968 </div> 1039 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
969 <div class="memdoc"> 1040
970 1041 </div>
971 <p> 1042 </div>
972 Get the outputs of this plugin. 1043 <a class="anchor" id="a2bc8c0992e64f06991fb7cf89f99857e"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getRemainingFeatures" ref="a2bc8c0992e64f06991fb7cf89f99857e" args="()" -->
973 <p> 1044 <div class="memitem">
974 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. 1045 <div class="memproto">
975 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 1046 <table class="memname">
976 1047 <tr>
977 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 1048 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
978 1049 <td>(</td>
979 </div> 1050 <td class="paramname"></td><td>)</td>
980 </div><p>
981 <a class="anchor" name="2bc8c0992e64f06991fb7cf89f99857e"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getRemainingFeatures" ref="2bc8c0992e64f06991fb7cf89f99857e" args="()" -->
982 <div class="memitem">
983 <div class="memproto">
984 <table class="memname">
985 <tr>
986 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
987 <td>(</td>
988 <td class="paramname"> </td>
989 <td>&nbsp;)&nbsp;</td>
990 <td><code> [virtual, inherited]</code></td> 1051 <td><code> [virtual, inherited]</code></td>
991 </tr> 1052 </tr>
992 </table> 1053 </table>
993 </div> 1054 </div>
994 <div class="memdoc"> 1055 <div class="memdoc">
995 1056
996 <p> 1057 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
997 After all blocks have been processed, calculate and return any remaining features derived from the complete input. 1058
998 <p> 1059 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
999 1060
1000 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 1061 <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>
1001 1062
1002 <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> 1063 </div>
1003 1064 </div>
1004 </div> 1065 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getWrapper" ref="a653d0308e8e34881a8749b7631d00f05" args="()" -->
1005 </div><p>
1006 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
1007 <div class="memitem"> 1066 <div class="memitem">
1008 <div class="memproto"> 1067 <div class="memproto">
1009 <div class="memtemplate"> 1068 <div class="memtemplate">
1010 template&lt;typename WrapperType &gt; </div> 1069 template&lt;typename WrapperType &gt; </div>
1011 <table class="memname"> 1070 <table class="memname">
1012 <tr> 1071 <tr>
1013 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td> 1072 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
1014 <td>(</td> 1073 <td>(</td>
1015 <td class="paramname"> </td> 1074 <td class="paramname"></td><td>)</td>
1016 <td>&nbsp;)&nbsp;</td>
1017 <td><code> [inline, inherited]</code></td> 1075 <td><code> [inline, inherited]</code></td>
1018 </tr> 1076 </tr>
1019 </table> 1077 </table>
1020 </div> 1078 </div>
1021 <div class="memdoc"> 1079 <div class="memdoc">
1022 1080
1023 <p> 1081 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
1024 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. 1082 <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>
1025 <p> 1083
1026 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. 1084 <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>
1027 <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> 1085
1028 1086 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
1029 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p> 1087
1030 1088 <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>
1031 <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> 1089
1032 1090 </div>
1033 </div> 1091 </div>
1034 </div><p> 1092 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
1035 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> 1093 <div class="memitem">
1036 <div class="memitem"> 1094 <div class="memproto">
1037 <div class="memproto"> 1095 <table class="memname">
1038 <table class="memname"> 1096 <tr>
1039 <tr> 1097 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1040 <td class="memname">virtual std::string Vamp::Plugin::getType </td> 1098 <td>(</td>
1041 <td>(</td> 1099 <td class="paramname"></td><td>)</td>
1042 <td class="paramname"> </td>
1043 <td>&nbsp;)&nbsp;</td>
1044 <td> const<code> [inline, virtual, inherited]</code></td> 1100 <td> const<code> [inline, virtual, inherited]</code></td>
1045 </tr> 1101 </tr>
1046 </table> 1102 </table>
1047 </div> 1103 </div>
1048 <div class="memdoc"> 1104 <div class="memdoc">
1049 1105
1050 <p> 1106 <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>
1051 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>. 1107 <p>Do not reimplement this function in your subclass. </p>
1052 <p> 1108
1053 Do not reimplement this function in your subclass. 1109 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1054 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1110
1055 1111 <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>
1056 <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> 1112
1057 1113 </div>
1058 </div> 1114 </div>
1059 </div><p> 1115 <hr/><h2>Member Data Documentation</h2>
1060 <hr><h2>Member Data Documentation</h2> 1116 <a class="anchor" id="a9fa8a6b8a4e41b6e3f2fabc0d23678cc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_impl" ref="a9fa8a6b8a4e41b6e3f2fabc0d23678cc" args="" -->
1061 <a class="anchor" name="9fa8a6b8a4e41b6e3f2fabc0d23678cc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_impl" ref="9fa8a6b8a4e41b6e3f2fabc0d23678cc" args="" --> 1117 <div class="memitem">
1062 <div class="memitem"> 1118 <div class="memproto">
1063 <div class="memproto"> 1119 <table class="memname">
1064 <table class="memname"> 1120 <tr>
1065 <tr> 1121 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a9fa8a6b8a4e41b6e3f2fabc0d23678cc">Vamp::HostExt::PluginInputDomainAdapter::m_impl</a><code> [protected]</code></td>
1066 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">Vamp::HostExt::PluginInputDomainAdapter::m_impl</a><code> [protected]</code> </td> 1122 </tr>
1067 </tr> 1123 </table>
1068 </table> 1124 </div>
1069 </div> 1125 <div class="memdoc">
1070 <div class="memdoc"> 1126
1071 1127 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h_source.html#l00226">226</a> of file <a class="el" href="PluginInputDomainAdapter_8h_source.html">PluginInputDomainAdapter.h</a>.</p>
1072 <p> 1128
1073 1129 </div>
1074 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h-source.html#l00188">188</a> of file <a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a>.</p> 1130 </div>
1075 1131 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_plugin" ref="ab4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
1076 </div> 1132 <div class="memitem">
1077 </div><p> 1133 <div class="memproto">
1078 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" --> 1134 <table class="memname">
1079 <div class="memitem"> 1135 <tr>
1080 <div class="memproto"> 1136 <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>
1081 <table class="memname"> 1137 </tr>
1082 <tr> 1138 </table>
1083 <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> 1139 </div>
1084 </tr> 1140 <div class="memdoc">
1085 </table> 1141
1086 </div> 1142 <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>
1087 <div class="memdoc"> 1143
1088 1144 </div>
1089 <p> 1145 </div>
1090 1146 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1091 <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> 1147 <div class="memitem">
1092 1148 <div class="memproto">
1093 </div> 1149 <table class="memname">
1094 </div><p> 1150 <tr>
1095 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" --> 1151 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
1096 <div class="memitem"> 1152 </tr>
1097 <div class="memproto"> 1153 </table>
1098 <table class="memname"> 1154 </div>
1099 <tr> 1155 <div class="memdoc">
1100 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td> 1156
1101 </tr> 1157 <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>
1102 </table> 1158
1103 </div> 1159 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p>
1104 <div class="memdoc"> 1160
1105 1161 </div>
1106 <p> 1162 </div>
1107 1163 <hr/>The documentation for this class was generated from the following file:<ul>
1108 <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> 1164 <li><a class="el" href="PluginInputDomainAdapter_8h_source.html">PluginInputDomainAdapter.h</a></li>
1109 1165 </ul>
1110 <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> 1166 </div>
1111 1167 </div>
1112 </div> 1168 <div id="nav-path" class="navpath">
1113 </div><p> 1169 <ul>
1114 <hr>The documentation for this class was generated from the following file:<ul> 1170 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
1115 <li><a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a></ul> 1171 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li>
1116 </div> 1172 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">PluginInputDomainAdapter</a> </li>
1117 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp; 1173
1118 <a href="http://www.doxygen.org/index.html"> 1174 <li class="footer">Generated on Tue Oct 4 2011 14:38:53 for VampPluginSDK by
1119 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 1175 <a href="http://www.doxygen.org/index.html">
1176 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
1177 </ul>
1178 </div>
1179
1180
1120 </body> 1181 </body>
1121 </html> 1182 </html>