Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children 8260c0f4e05b
comparison
equal deleted inserted replaced
34:4b4db9230e94 35:0976232e353b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::HostExt::PluginInputDomainAdapter Class Reference</title> 3 <title>VampPluginSDK: Vamp::HostExt::PluginInputDomainAdapter Class Reference</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css">
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 --> 7 <!-- Generated by Doxygen 1.5.8 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
24 </div> 24 </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> 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>
26 </div> 26 </div>
27 </div> 27 </div>
28 <div class="contents"> 28 <div class="contents">
29 <h1>Vamp::HostExt::PluginInputDomainAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginInputDomainAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><code>#include &lt;<a class="el" href="PluginInputDomainAdapter_8h-source.html">vamp-hostsdk/PluginInputDomainAdapter.h</a>&gt;</code> 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.
30 <a href="#_details">More...</a>
31 <p>
32 <code>#include &lt;<a class="el" href="PluginInputDomainAdapter_8h-source.html">vamp-hostsdk/PluginInputDomainAdapter.h</a>&gt;</code>
30 <p> 33 <p>
31 <div class="dynheader"> 34 <div class="dynheader">
32 Inheritance diagram for Vamp::HostExt::PluginInputDomainAdapter:</div> 35 Inheritance diagram for Vamp::HostExt::PluginInputDomainAdapter:</div>
33 <div class="dynsection"> 36 <div class="dynsection">
34 <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> 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>
35 <map name="Vamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__map"> 38 <map name="Vamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__map">
36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="41,154,241,181"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="92,80,191,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="77,5,205,32"></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>
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> 40 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
38 41
39 <p> 42 <p>
40 <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 43 <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
44 <tr><td></td></tr>
45 <tr><td colspan="2"><br><h2>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>,
47 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152">ShiftData</a>,
48 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297">NoShift</a>
49 }</td></tr>
50
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>
52 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
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>
54
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>
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>
57
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>
59
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>
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>
62
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>
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>
65
66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#47ff1ed72889f323da63f8abc9ea581a"></a><br></td></tr>
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>
68
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>
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>
71
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>
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>
74
75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#b36a81ac9a0ded8d83c6b855263c0231"></a><br></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>
77
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>
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>
80
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>
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>
83
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>
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>
86
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>
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>
89
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>
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>
92
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>
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>
95
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>
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>
98
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>
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>
101
102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></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>
104
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>
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>
107
108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></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>
110
111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></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>
113
114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></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>
116
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>
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>
119
120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></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>
122
123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
124 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
125
126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
127 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
128
129 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr>
131
132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
133 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr>
134
135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#2bc8c0992e64f06991fb7cf89f99857e"></a><br></td></tr>
136 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType &gt; </td></tr>
137 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">WrapperType *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">getWrapper</a> ()</td></tr>
138
139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#e9d79bed7237d55a73018a6b982a55b3"></a><br></td></tr>
140 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
141
142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
143 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
144 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#9fa8a6b8a4e41b6e3f2fabc0d23678cc">m_impl</a></td></tr>
145
146 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
147
148 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
149
150 </table>
151 <hr><a name="_details"></a><h2>Detailed Description</h2>
41 <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. 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.
42 <p> 153 <p>
43 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>
44 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> 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>
45 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>
46 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>
47 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> 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>
48 <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> 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>
49 160
50 <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> 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>
51 <table border="0" cellpadding="0" cellspacing="0">
52 <tr><td></td></tr>
53 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
55 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
56 }</td></tr>
57
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
59 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
60
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
62
63 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
64 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
67 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
68
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
70
71 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
72 <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>
73
74 <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>
75 <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>
76
77 <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>
78
79 <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>
80 <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>
81
82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#47ff1ed72889f323da63f8abc9ea581a"></a><br></td></tr>
83 <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>
84
85 <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>
86 <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>
87
88 <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>
89 <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>
90
91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#b36a81ac9a0ded8d83c6b855263c0231"></a><br></td></tr>
92 <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>
93
94 <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>
95 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
96
97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr>
98 <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>
99
100 <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>
101 <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>
102
103 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
104 <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>
105
106 <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>
107 <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>
108
109 <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>
110 <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>
111
112 <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>
113 <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>
114
115 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
116 <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>
117
118 <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>
119 <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>
120
121 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr>
122 <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>
123
124 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
125 <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>
126
127 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
128 <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>
129
130 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr>
131 <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>
132
133 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
134 <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>
135
136 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
137 <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>
138
139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
140 <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>
141
142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
143 <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>
144
145 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
146 <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>
147
148 <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>
149 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType&gt; </td></tr>
150 <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>
151
152 <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>
153 <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>
154
155 <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>
156 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
157 <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>
158
159 <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>
160
161 <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>
162
163 </table>
164 <hr><h2>Member Typedef Documentation</h2> 162 <hr><h2>Member Typedef Documentation</h2>
165 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> 163 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
166 <div class="memitem"> 164 <div class="memitem">
167 <div class="memproto"> 165 <div class="memproto">
168 <table class="memname"> 166 <table class="memname">
173 </div> 171 </div>
174 <div class="memdoc"> 172 <div class="memdoc">
175 173
176 <p> 174 <p>
177 175
178 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> 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>
179 177
180 </div> 178 </div>
181 </div><p> 179 </div><p>
182 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> 180 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
183 <div class="memitem"> 181 <div class="memitem">
190 </div> 188 </div>
191 <div class="memdoc"> 189 <div class="memdoc">
192 190
193 <p> 191 <p>
194 192
195 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00380">380</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> 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>
196 194
197 </div> 195 </div>
198 </div><p> 196 </div><p>
199 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> 197 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
200 <div class="memitem"> 198 <div class="memitem">
207 </div> 205 </div>
208 <div class="memdoc"> 206 <div class="memdoc">
209 207
210 <p> 208 <p>
211 209
212 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> 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>
213 211
214 </div> 212 </div>
215 </div><p> 213 </div><p>
216 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> 214 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
217 <div class="memitem"> 215 <div class="memitem">
246 <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> 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>
247 245
248 </div> 246 </div>
249 </div><p> 247 </div><p>
250 <hr><h2>Member Enumeration Documentation</h2> 248 <hr><h2>Member Enumeration Documentation</h2>
249 <a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod" ref="2518e4922d77bc4e514d84cec9a0b577" args="" -->
250 <div class="memitem">
251 <div class="memproto">
252 <table class="memname">
253 <tr>
254 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod</a> </td>
255 </tr>
256 </table>
257 </div>
258 <div class="memdoc">
259
260 <p>
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.
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>
275 </table>
276 </dl>
277
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>
279
280 </div>
281 </div><p>
251 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> 282 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
252 <div class="memitem"> 283 <div class="memitem">
253 <div class="memproto"> 284 <div class="memproto">
254 <table class="memname"> 285 <table class="memname">
255 <tr> 286 <tr>
354 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. 385 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
355 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">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>
356 387
357 </div> 388 </div>
358 </div><p> 389 </div><p>
390 <a class="anchor" name="984a12b5b4cb0be1e2f7a0aa84106c4c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::reset" ref="984a12b5b4cb0be1e2f7a0aa84106c4c" args="()" -->
391 <div class="memitem">
392 <div class="memproto">
393 <table class="memname">
394 <tr>
395 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::reset </td>
396 <td>(</td>
397 <td class="paramname"> </td>
398 <td>&nbsp;)&nbsp;</td>
399 <td><code> [virtual]</code></td>
400 </tr>
401 </table>
402 </div>
403 <div class="memdoc">
404
405 <p>
406 Reset the plugin after use, to prepare it for another clean run.
407 <p>
408 Not called for the first initialisation (i.e. initialise must also do a reset).
409 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
410
411 </div>
412 </div><p>
359 <a class="anchor" name="47ff1ed72889f323da63f8abc9ea581a"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getInputDomain" ref="47ff1ed72889f323da63f8abc9ea581a" args="() const " --> 413 <a class="anchor" name="47ff1ed72889f323da63f8abc9ea581a"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getInputDomain" ref="47ff1ed72889f323da63f8abc9ea581a" args="() const " -->
360 <div class="memitem"> 414 <div class="memitem">
361 <div class="memproto"> 415 <div class="memproto">
362 <table class="memname"> 416 <table class="memname">
363 <tr> 417 <tr>
372 <div class="memdoc"> 426 <div class="memdoc">
373 427
374 <p> 428 <p>
375 Get the plugin's required input domain. 429 Get the plugin's required input domain.
376 <p> 430 <p>
377 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. 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 plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. 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>
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.
378 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">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>
379 434
380 </div> 435 </div>
381 </div><p> 436 </div><p>
382 <a class="anchor" name="d979af9f1cbf2eeb16f4eaedb4a4f565"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize" ref="d979af9f1cbf2eeb16f4eaedb4a4f565" args="() const " --> 437 <a class="anchor" name="d979af9f1cbf2eeb16f4eaedb4a4f565"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize" ref="d979af9f1cbf2eeb16f4eaedb4a4f565" args="() const " -->
460 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.) 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.)
461 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">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>
462 517
463 </div> 518 </div>
464 </div><p> 519 </div><p>
520 <a class="anchor" name="1d7366f8cab39abc01ebfc7bf7ca8089"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod" ref="1d7366f8cab39abc01ebfc7bf7ca8089" args="(ProcessTimestampMethod)" -->
521 <div class="memitem">
522 <div class="memproto">
523 <table class="memname">
524 <tr>
525 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod </td>
526 <td>(</td>
527 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>&nbsp;</td>
528 <td class="paramname"> </td>
529 <td>&nbsp;)&nbsp;</td>
530 <td></td>
531 </tr>
532 </table>
533 </div>
534 <div class="memdoc">
535
536 <p>
537 Set the method used for timestamp adjustment in plugins taking frequency-domain input.
538 <p>
539 See the ProcessTimestampMethod documentation for details.<p>
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>.
541 </div>
542 </div><p>
543 <a class="anchor" name="cfc7a9121f678fd085448f68f15c9eae"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod" ref="cfc7a9121f678fd085448f68f15c9eae" args="() const " -->
544 <div class="memitem">
545 <div class="memproto">
546 <table class="memname">
547 <tr>
548 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a> Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod </td>
549 <td>(</td>
550 <td class="paramname"> </td>
551 <td>&nbsp;)&nbsp;</td>
552 <td> const</td>
553 </tr>
554 </table>
555 </div>
556 <div class="memdoc">
557
558 <p>
559 Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input.
560 <p>
561 See the ProcessTimestampMethod documentation for details.
562 </div>
563 </div><p>
465 <a class="anchor" name="c1ab6af0fcda0a4c3f050c54b2db4769"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment" ref="c1ab6af0fcda0a4c3f050c54b2db4769" args="() const " --> 564 <a class="anchor" name="c1ab6af0fcda0a4c3f050c54b2db4769"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment" ref="c1ab6af0fcda0a4c3f050c54b2db4769" args="() const " -->
466 <div class="memitem"> 565 <div class="memitem">
467 <div class="memproto"> 566 <div class="memproto">
468 <table class="memname"> 567 <table class="memname">
469 <tr> 568 <tr>
480 <p> 579 <p>
481 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. 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.
482 <p> 581 <p>
483 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> 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>
484 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> 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>
485 If the plugin requires time-domain input, this function will return zero. 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. 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>
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.
486 <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>
487
488 </div>
489 </div><p>
490 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" -->
491 <div class="memitem">
492 <div class="memproto">
493 <table class="memname">
494 <tr>
495 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
496 <td>(</td>
497 <td class="paramname"> </td>
498 <td>&nbsp;)&nbsp;</td>
499 <td><code> [virtual, inherited]</code></td>
500 </tr>
501 </table>
502 </div>
503 <div class="memdoc">
504
505 <p>
506 Reset the plugin after use, to prepare it for another clean run.
507 <p>
508 Not called for the first initialisation (i.e. initialise must also do a reset).
509 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
510
511 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
512 587
513 </div> 588 </div>
514 </div><p> 589 </div><p>
515 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " --> 590 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
516 <div class="memitem"> 591 <div class="memitem">
930 </div><p> 1005 </div><p>
931 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" --> 1006 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
932 <div class="memitem"> 1007 <div class="memitem">
933 <div class="memproto"> 1008 <div class="memproto">
934 <div class="memtemplate"> 1009 <div class="memtemplate">
935 template&lt;typename WrapperType&gt; </div> 1010 template&lt;typename WrapperType &gt; </div>
936 <table class="memname"> 1011 <table class="memname">
937 <tr> 1012 <tr>
938 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td> 1013 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
939 <td>(</td> 1014 <td>(</td>
940 <td class="paramname"> </td> 1015 <td class="paramname"> </td>
976 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>. 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>.
977 <p> 1052 <p>
978 Do not reimplement this function in your subclass. 1053 Do not reimplement this function in your subclass.
979 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1054 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
980 1055
981 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00425">425</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> 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>
982 1057
983 </div> 1058 </div>
984 </div><p> 1059 </div><p>
985 <hr><h2>Member Data Documentation</h2> 1060 <hr><h2>Member Data Documentation</h2>
986 <a class="anchor" name="9fa8a6b8a4e41b6e3f2fabc0d23678cc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_impl" ref="9fa8a6b8a4e41b6e3f2fabc0d23678cc" args="" --> 1061 <a class="anchor" name="9fa8a6b8a4e41b6e3f2fabc0d23678cc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_impl" ref="9fa8a6b8a4e41b6e3f2fabc0d23678cc" args="" -->
994 </div> 1069 </div>
995 <div class="memdoc"> 1070 <div class="memdoc">
996 1071
997 <p> 1072 <p>
998 1073
999 <p>Definition at line <a class="el" href="PluginInputDomainAdapter_8h-source.html#l00126">126</a> of file <a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a>.</p> 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>
1000 1075
1001 </div> 1076 </div>
1002 </div><p> 1077 </div><p>
1003 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" --> 1078 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
1004 <div class="memitem"> 1079 <div class="memitem">
1028 </div> 1103 </div>
1029 <div class="memdoc"> 1104 <div class="memdoc">
1030 1105
1031 <p> 1106 <p>
1032 1107
1033 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">431</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> 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>
1034 1109
1035 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> 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>
1036 1111
1037 </div> 1112 </div>
1038 </div><p> 1113 </div><p>
1039 <hr>The documentation for this class was generated from the following file:<ul> 1114 <hr>The documentation for this class was generated from the following file:<ul>
1040 <li><a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a></ul> 1115 <li><a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a></ul>
1041 </div> 1116 </div>
1042 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by&nbsp; 1117 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
1043 <a href="http://www.doxygen.org/index.html"> 1118 <a href="http://www.doxygen.org/index.html">
1044 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 1119 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
1045 </body> 1120 </body>
1046 </html> 1121 </html>