Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html @ 40:9391fbda5ad2 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update site for v2.2 release
author cannam
date Thu, 26 Aug 2010 11:36:19 +0000
parents 0976232e353b
children 8260c0f4e05b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::HostExt::PluginInputDomainAdapter Class Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">PluginInputDomainAdapter</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 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.
cannam@35 30 <a href="#_details">More...</a>
cannam@35 31 <p>
cannam@35 32 <code>#include &lt;<a class="el" href="PluginInputDomainAdapter_8h-source.html">vamp-hostsdk/PluginInputDomainAdapter.h</a>&gt;</code>
cannam@0 33 <p>
cannam@0 34 <div class="dynheader">
cannam@0 35 Inheritance diagram for Vamp::HostExt::PluginInputDomainAdapter:</div>
cannam@0 36 <div class="dynsection">
cannam@0 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>
cannam@0 38 <map name="Vamp_1_1HostExt_1_1PluginInputDomainAdapter__inherit__map">
cannam@35 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>
cannam@0 40 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
cannam@0 41
cannam@0 42 <p>
cannam@35 43 <a href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 44 <tr><td></td></tr>
cannam@0 45 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@35 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>,
cannam@35 47 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152">ShiftData</a>,
cannam@35 48 <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297">NoShift</a>
cannam@0 49 }</td></tr>
cannam@0 50
cannam@35 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>
cannam@0 52 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@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>
cannam@0 54
cannam@21 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>
cannam@21 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>
cannam@0 57
cannam@0 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>
cannam@0 59
cannam@0 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>
cannam@35 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>
cannam@35 62
cannam@35 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>
cannam@21 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>
cannam@0 65
cannam@21 66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#47ff1ed72889f323da63f8abc9ea581a"></a><br></td></tr>
cannam@0 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>
cannam@0 68
cannam@21 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>
cannam@0 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>
cannam@0 71
cannam@21 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>
cannam@21 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>
cannam@0 74
cannam@21 75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#b36a81ac9a0ded8d83c6b855263c0231"></a><br></td></tr>
cannam@35 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>
cannam@35 77
cannam@35 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>
cannam@35 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>
cannam@35 80
cannam@35 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>
cannam@21 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>
cannam@21 83
cannam@21 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>
cannam@0 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>
cannam@0 86
cannam@21 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>
cannam@0 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>
cannam@0 89
cannam@0 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>
cannam@0 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>
cannam@0 92
cannam@0 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>
cannam@0 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>
cannam@0 95
cannam@0 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>
cannam@0 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>
cannam@0 98
cannam@0 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>
cannam@0 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>
cannam@0 101
cannam@0 102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
cannam@0 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>
cannam@0 104
cannam@0 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>
cannam@21 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>
cannam@0 107
cannam@21 108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr>
cannam@0 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>
cannam@0 110
cannam@0 111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
cannam@0 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>
cannam@0 113
cannam@0 114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
cannam@21 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>
cannam@0 116
cannam@21 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>
cannam@0 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>
cannam@0 119
cannam@0 120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
cannam@0 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>
cannam@0 122
cannam@0 123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
cannam@0 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>
cannam@0 125
cannam@0 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>
cannam@0 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>
cannam@0 128
cannam@0 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>
cannam@21 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>
cannam@0 131
cannam@21 132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
cannam@21 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>
cannam@0 134
cannam@21 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>
cannam@35 136 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType &gt; </td></tr>
cannam@21 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>
cannam@21 138
cannam@21 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>
cannam@0 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>
cannam@0 141
cannam@0 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>
cannam@0 143 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@21 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>
cannam@0 145
cannam@0 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>
cannam@0 147
cannam@0 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>
cannam@0 149
cannam@0 150 </table>
cannam@35 151 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 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.
cannam@35 153 <p>
cannam@35 154 This permits a host to use time- and frequency-domain plugins interchangeably without needing to handle the conversion itself.<p>
cannam@35 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>
cannam@35 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>
cannam@35 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>
cannam@35 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>
cannam@35 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>
cannam@35 160
cannam@35 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>
cannam@0 162 <hr><h2>Member Typedef Documentation</h2>
cannam@0 163 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
cannam@0 164 <div class="memitem">
cannam@0 165 <div class="memproto">
cannam@0 166 <table class="memname">
cannam@0 167 <tr>
cannam@0 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>
cannam@0 169 </tr>
cannam@0 170 </table>
cannam@0 171 </div>
cannam@0 172 <div class="memdoc">
cannam@0 173
cannam@0 174 <p>
cannam@0 175
cannam@35 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>
cannam@0 177
cannam@0 178 </div>
cannam@0 179 </div><p>
cannam@0 180 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
cannam@0 181 <div class="memitem">
cannam@0 182 <div class="memproto">
cannam@0 183 <table class="memname">
cannam@0 184 <tr>
cannam@0 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>
cannam@0 186 </tr>
cannam@0 187 </table>
cannam@0 188 </div>
cannam@0 189 <div class="memdoc">
cannam@0 190
cannam@0 191 <p>
cannam@0 192
cannam@35 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>
cannam@0 194
cannam@0 195 </div>
cannam@0 196 </div><p>
cannam@0 197 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
cannam@0 198 <div class="memitem">
cannam@0 199 <div class="memproto">
cannam@0 200 <table class="memname">
cannam@0 201 <tr>
cannam@0 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>
cannam@0 203 </tr>
cannam@0 204 </table>
cannam@0 205 </div>
cannam@0 206 <div class="memdoc">
cannam@0 207
cannam@0 208 <p>
cannam@0 209
cannam@35 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>
cannam@0 211
cannam@0 212 </div>
cannam@0 213 </div><p>
cannam@0 214 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 215 <div class="memitem">
cannam@0 216 <div class="memproto">
cannam@0 217 <table class="memname">
cannam@0 218 <tr>
cannam@0 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>
cannam@0 220 </tr>
cannam@0 221 </table>
cannam@0 222 </div>
cannam@0 223 <div class="memdoc">
cannam@0 224
cannam@0 225 <p>
cannam@0 226
cannam@21 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>
cannam@0 228
cannam@0 229 </div>
cannam@0 230 </div><p>
cannam@0 231 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 232 <div class="memitem">
cannam@0 233 <div class="memproto">
cannam@0 234 <table class="memname">
cannam@0 235 <tr>
cannam@0 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>
cannam@0 237 </tr>
cannam@0 238 </table>
cannam@0 239 </div>
cannam@0 240 <div class="memdoc">
cannam@0 241
cannam@0 242 <p>
cannam@0 243
cannam@21 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>
cannam@0 245
cannam@0 246 </div>
cannam@0 247 </div><p>
cannam@0 248 <hr><h2>Member Enumeration Documentation</h2>
cannam@35 249 <a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod" ref="2518e4922d77bc4e514d84cec9a0b577" args="" -->
cannam@35 250 <div class="memitem">
cannam@35 251 <div class="memproto">
cannam@35 252 <table class="memname">
cannam@35 253 <tr>
cannam@35 254 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">Vamp::HostExt::PluginInputDomainAdapter::ProcessTimestampMethod</a> </td>
cannam@35 255 </tr>
cannam@35 256 </table>
cannam@35 257 </div>
cannam@35 258 <div class="memdoc">
cannam@35 259
cannam@35 260 <p>
cannam@35 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.
cannam@35 262 <p>
cannam@35 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>
cannam@35 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>
cannam@35 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>
cannam@35 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>
cannam@35 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>
cannam@35 268 <table border="0" cellspacing="2" cellpadding="0">
cannam@35 269 <tr><td valign="top"><em><a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577fcf39fe57ba29a908d4877c21de145dd"></a><!-- doxytag: member="ShiftTimestamp" ref="2518e4922d77bc4e514d84cec9a0b577fcf39fe57ba29a908d4877c21de145dd" args="" -->ShiftTimestamp</em>&nbsp;</td><td>
cannam@35 270 </td></tr>
cannam@35 271 <tr><td valign="top"><em><a class="anchor" name="2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152"></a><!-- doxytag: member="ShiftData" ref="2518e4922d77bc4e514d84cec9a0b5770838ff456d829e9096b5d968e6c55152" args="" -->ShiftData</em>&nbsp;</td><td>
cannam@35 272 </td></tr>
cannam@35 273 <tr><td valign="top"><em><a class="anchor" name="2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297"></a><!-- doxytag: member="NoShift" ref="2518e4922d77bc4e514d84cec9a0b577b06e8c6824802978d0be4074a556b297" args="" -->NoShift</em>&nbsp;</td><td>
cannam@35 274 </td></tr>
cannam@35 275 </table>
cannam@35 276 </dl>
cannam@35 277
cannam@35 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>
cannam@35 279
cannam@35 280 </div>
cannam@35 281 </div><p>
cannam@0 282 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
cannam@0 283 <div class="memitem">
cannam@0 284 <div class="memproto">
cannam@0 285 <table class="memname">
cannam@0 286 <tr>
cannam@0 287 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
cannam@0 288 </tr>
cannam@0 289 </table>
cannam@0 290 </div>
cannam@0 291 <div class="memdoc">
cannam@0 292
cannam@0 293 <p>
cannam@0 294 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 295 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 296 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
cannam@0 297 </td></tr>
cannam@0 298 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
cannam@0 299 </td></tr>
cannam@0 300 </table>
cannam@0 301 </dl>
cannam@0 302
cannam@21 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>
cannam@0 304
cannam@0 305 </div>
cannam@0 306 </div><p>
cannam@0 307 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 308 <a class="anchor" name="878e7275acdb77efc7a802944305039d"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter" ref="878e7275acdb77efc7a802944305039d" args="(Plugin *plugin)" -->
cannam@0 309 <div class="memitem">
cannam@0 310 <div class="memproto">
cannam@0 311 <table class="memname">
cannam@0 312 <tr>
cannam@0 313 <td class="memname">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter </td>
cannam@0 314 <td>(</td>
cannam@0 315 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td>
cannam@0 316 <td class="paramname"> <em>plugin</em> </td>
cannam@0 317 <td>&nbsp;)&nbsp;</td>
cannam@21 318 <td></td>
cannam@0 319 </tr>
cannam@0 320 </table>
cannam@0 321 </div>
cannam@0 322 <div class="memdoc">
cannam@0 323
cannam@0 324 <p>
cannam@21 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.
cannam@21 326 <p>
cannam@21 327 The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted.
cannam@0 328 </div>
cannam@0 329 </div><p>
cannam@21 330 <a class="anchor" name="ba2cbfa650d8a7c9181dbdb49b10aad0"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter" ref="ba2cbfa650d8a7c9181dbdb49b10aad0" args="()" -->
cannam@0 331 <div class="memitem">
cannam@0 332 <div class="memproto">
cannam@0 333 <table class="memname">
cannam@0 334 <tr>
cannam@21 335 <td class="memname">virtual Vamp::HostExt::PluginInputDomainAdapter::~PluginInputDomainAdapter </td>
cannam@0 336 <td>(</td>
cannam@0 337 <td class="paramname"> </td>
cannam@0 338 <td>&nbsp;)&nbsp;</td>
cannam@21 339 <td><code> [virtual]</code></td>
cannam@0 340 </tr>
cannam@0 341 </table>
cannam@0 342 </div>
cannam@0 343 <div class="memdoc">
cannam@0 344
cannam@0 345 <p>
cannam@0 346
cannam@0 347 </div>
cannam@0 348 </div><p>
cannam@0 349 <hr><h2>Member Function Documentation</h2>
cannam@0 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)" -->
cannam@0 351 <div class="memitem">
cannam@0 352 <div class="memproto">
cannam@0 353 <table class="memname">
cannam@0 354 <tr>
cannam@0 355 <td class="memname">bool Vamp::HostExt::PluginInputDomainAdapter::initialise </td>
cannam@0 356 <td>(</td>
cannam@0 357 <td class="paramtype">size_t&nbsp;</td>
cannam@0 358 <td class="paramname"> <em>inputChannels</em>, </td>
cannam@0 359 </tr>
cannam@0 360 <tr>
cannam@0 361 <td class="paramkey"></td>
cannam@0 362 <td></td>
cannam@0 363 <td class="paramtype">size_t&nbsp;</td>
cannam@0 364 <td class="paramname"> <em>stepSize</em>, </td>
cannam@0 365 </tr>
cannam@0 366 <tr>
cannam@0 367 <td class="paramkey"></td>
cannam@0 368 <td></td>
cannam@0 369 <td class="paramtype">size_t&nbsp;</td>
cannam@0 370 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
cannam@0 371 </tr>
cannam@0 372 <tr>
cannam@0 373 <td></td>
cannam@0 374 <td>)</td>
cannam@21 375 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 376 </tr>
cannam@0 377 </table>
cannam@0 378 </div>
cannam@0 379 <div class="memdoc">
cannam@0 380
cannam@0 381 <p>
cannam@0 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).
cannam@0 383 <p>
cannam@0 384 The input sample rate should have been already specified at construction time.<p>
cannam@0 385 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
cannam@0 386 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 387
cannam@0 388 </div>
cannam@0 389 </div><p>
cannam@35 390 <a class="anchor" name="984a12b5b4cb0be1e2f7a0aa84106c4c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::reset" ref="984a12b5b4cb0be1e2f7a0aa84106c4c" args="()" -->
cannam@35 391 <div class="memitem">
cannam@35 392 <div class="memproto">
cannam@35 393 <table class="memname">
cannam@35 394 <tr>
cannam@35 395 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::reset </td>
cannam@35 396 <td>(</td>
cannam@35 397 <td class="paramname"> </td>
cannam@35 398 <td>&nbsp;)&nbsp;</td>
cannam@35 399 <td><code> [virtual]</code></td>
cannam@35 400 </tr>
cannam@35 401 </table>
cannam@35 402 </div>
cannam@35 403 <div class="memdoc">
cannam@35 404
cannam@35 405 <p>
cannam@35 406 Reset the plugin after use, to prepare it for another clean run.
cannam@35 407 <p>
cannam@35 408 Not called for the first initialisation (i.e. initialise must also do a reset).
cannam@35 409 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@35 410
cannam@35 411 </div>
cannam@35 412 </div><p>
cannam@21 413 <a class="anchor" name="47ff1ed72889f323da63f8abc9ea581a"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getInputDomain" ref="47ff1ed72889f323da63f8abc9ea581a" args="() const " -->
cannam@0 414 <div class="memitem">
cannam@0 415 <div class="memproto">
cannam@0 416 <table class="memname">
cannam@0 417 <tr>
cannam@21 418 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginInputDomainAdapter::getInputDomain </td>
cannam@0 419 <td>(</td>
cannam@0 420 <td class="paramname"> </td>
cannam@0 421 <td>&nbsp;)&nbsp;</td>
cannam@21 422 <td> const<code> [virtual]</code></td>
cannam@0 423 </tr>
cannam@0 424 </table>
cannam@0 425 </div>
cannam@0 426 <div class="memdoc">
cannam@0 427
cannam@0 428 <p>
cannam@0 429 Get the plugin's required input domain.
cannam@0 430 <p>
cannam@35 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>
cannam@35 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.
cannam@21 433 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 434
cannam@0 435 </div>
cannam@0 436 </div><p>
cannam@0 437 <a class="anchor" name="d979af9f1cbf2eeb16f4eaedb4a4f565"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize" ref="d979af9f1cbf2eeb16f4eaedb4a4f565" args="() const " -->
cannam@0 438 <div class="memitem">
cannam@0 439 <div class="memproto">
cannam@0 440 <table class="memname">
cannam@0 441 <tr>
cannam@0 442 <td class="memname">size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredStepSize </td>
cannam@0 443 <td>(</td>
cannam@0 444 <td class="paramname"> </td>
cannam@0 445 <td>&nbsp;)&nbsp;</td>
cannam@21 446 <td> const<code> [virtual]</code></td>
cannam@0 447 </tr>
cannam@0 448 </table>
cannam@0 449 </div>
cannam@0 450 <div class="memdoc">
cannam@0 451
cannam@0 452 <p>
cannam@21 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.
cannam@0 454 <p>
cannam@0 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>
cannam@0 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.
cannam@0 457 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 458
cannam@0 459 </div>
cannam@0 460 </div><p>
cannam@0 461 <a class="anchor" name="4cf40d09d02022b1962ff17bb0324ea5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize" ref="4cf40d09d02022b1962ff17bb0324ea5" args="() const " -->
cannam@0 462 <div class="memitem">
cannam@0 463 <div class="memproto">
cannam@0 464 <table class="memname">
cannam@0 465 <tr>
cannam@0 466 <td class="memname">size_t Vamp::HostExt::PluginInputDomainAdapter::getPreferredBlockSize </td>
cannam@0 467 <td>(</td>
cannam@0 468 <td class="paramname"> </td>
cannam@0 469 <td>&nbsp;)&nbsp;</td>
cannam@21 470 <td> const<code> [virtual]</code></td>
cannam@0 471 </tr>
cannam@0 472 </table>
cannam@0 473 </div>
cannam@0 474 <div class="memdoc">
cannam@0 475
cannam@0 476 <p>
cannam@21 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).
cannam@0 478 <p>
cannam@0 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>
cannam@0 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.
cannam@0 481 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 482
cannam@0 483 </div>
cannam@0 484 </div><p>
cannam@21 485 <a class="anchor" name="b36a81ac9a0ded8d83c6b855263c0231"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::process" ref="b36a81ac9a0ded8d83c6b855263c0231" args="(const float *const *inputBuffers, RealTime timestamp)" -->
cannam@0 486 <div class="memitem">
cannam@0 487 <div class="memproto">
cannam@0 488 <table class="memname">
cannam@0 489 <tr>
cannam@21 490 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginInputDomainAdapter::process </td>
cannam@0 491 <td>(</td>
cannam@0 492 <td class="paramtype">const float *const *&nbsp;</td>
cannam@0 493 <td class="paramname"> <em>inputBuffers</em>, </td>
cannam@0 494 </tr>
cannam@0 495 <tr>
cannam@0 496 <td class="paramkey"></td>
cannam@0 497 <td></td>
cannam@0 498 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td>
cannam@0 499 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
cannam@0 500 </tr>
cannam@0 501 <tr>
cannam@0 502 <td></td>
cannam@0 503 <td>)</td>
cannam@21 504 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 505 </tr>
cannam@0 506 </table>
cannam@0 507 </div>
cannam@0 508 <div class="memdoc">
cannam@0 509
cannam@0 510 <p>
cannam@0 511 Process a single block of input data.
cannam@0 512 <p>
cannam@21 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>
cannam@0 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>
cannam@0 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.)
cannam@21 516 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 517
cannam@21 518 </div>
cannam@21 519 </div><p>
cannam@35 520 <a class="anchor" name="1d7366f8cab39abc01ebfc7bf7ca8089"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod" ref="1d7366f8cab39abc01ebfc7bf7ca8089" args="(ProcessTimestampMethod)" -->
cannam@35 521 <div class="memitem">
cannam@35 522 <div class="memproto">
cannam@35 523 <table class="memname">
cannam@35 524 <tr>
cannam@35 525 <td class="memname">void Vamp::HostExt::PluginInputDomainAdapter::setProcessTimestampMethod </td>
cannam@35 526 <td>(</td>
cannam@35 527 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a>&nbsp;</td>
cannam@35 528 <td class="paramname"> </td>
cannam@35 529 <td>&nbsp;)&nbsp;</td>
cannam@35 530 <td></td>
cannam@35 531 </tr>
cannam@35 532 </table>
cannam@35 533 </div>
cannam@35 534 <div class="memdoc">
cannam@35 535
cannam@35 536 <p>
cannam@35 537 Set the method used for timestamp adjustment in plugins taking frequency-domain input.
cannam@35 538 <p>
cannam@35 539 See the ProcessTimestampMethod documentation for details.<p>
cannam@35 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>.
cannam@35 541 </div>
cannam@35 542 </div><p>
cannam@35 543 <a class="anchor" name="cfc7a9121f678fd085448f68f15c9eae"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod" ref="cfc7a9121f678fd085448f68f15c9eae" args="() const " -->
cannam@35 544 <div class="memitem">
cannam@35 545 <div class="memproto">
cannam@35 546 <table class="memname">
cannam@35 547 <tr>
cannam@35 548 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#2518e4922d77bc4e514d84cec9a0b577">ProcessTimestampMethod</a> Vamp::HostExt::PluginInputDomainAdapter::getProcessTimestampMethod </td>
cannam@35 549 <td>(</td>
cannam@35 550 <td class="paramname"> </td>
cannam@35 551 <td>&nbsp;)&nbsp;</td>
cannam@35 552 <td> const</td>
cannam@35 553 </tr>
cannam@35 554 </table>
cannam@35 555 </div>
cannam@35 556 <div class="memdoc">
cannam@35 557
cannam@35 558 <p>
cannam@35 559 Retrieve the method used for timestamp adjustment in plugins taking frequency-domain input.
cannam@35 560 <p>
cannam@35 561 See the ProcessTimestampMethod documentation for details.
cannam@35 562 </div>
cannam@35 563 </div><p>
cannam@21 564 <a class="anchor" name="c1ab6af0fcda0a4c3f050c54b2db4769"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment" ref="c1ab6af0fcda0a4c3f050c54b2db4769" args="() const " -->
cannam@21 565 <div class="memitem">
cannam@21 566 <div class="memproto">
cannam@21 567 <table class="memname">
cannam@21 568 <tr>
cannam@21 569 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::HostExt::PluginInputDomainAdapter::getTimestampAdjustment </td>
cannam@21 570 <td>(</td>
cannam@21 571 <td class="paramname"> </td>
cannam@21 572 <td>&nbsp;)&nbsp;</td>
cannam@21 573 <td> const</td>
cannam@21 574 </tr>
cannam@21 575 </table>
cannam@21 576 </div>
cannam@21 577 <div class="memdoc">
cannam@0 578
cannam@21 579 <p>
cannam@21 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.
cannam@21 581 <p>
cannam@21 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>
cannam@21 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>
cannam@35 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>
cannam@35 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.
cannam@21 586 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
cannam@0 587
cannam@0 588 </div>
cannam@0 589 </div><p>
cannam@0 590 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
cannam@0 591 <div class="memitem">
cannam@0 592 <div class="memproto">
cannam@0 593 <table class="memname">
cannam@0 594 <tr>
cannam@0 595 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
cannam@0 596 <td>(</td>
cannam@0 597 <td class="paramname"> </td>
cannam@0 598 <td>&nbsp;)&nbsp;</td>
cannam@21 599 <td> const<code> [virtual, inherited]</code></td>
cannam@0 600 </tr>
cannam@0 601 </table>
cannam@0 602 </div>
cannam@0 603 <div class="memdoc">
cannam@0 604
cannam@0 605 <p>
cannam@21 606 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
cannam@0 607 <p>
cannam@0 608
cannam@0 609 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
cannam@0 610
cannam@0 611 </div>
cannam@0 612 </div><p>
cannam@0 613 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
cannam@0 614 <div class="memitem">
cannam@0 615 <div class="memproto">
cannam@0 616 <table class="memname">
cannam@0 617 <tr>
cannam@0 618 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
cannam@0 619 <td>(</td>
cannam@0 620 <td class="paramname"> </td>
cannam@0 621 <td>&nbsp;)&nbsp;</td>
cannam@21 622 <td> const<code> [virtual, inherited]</code></td>
cannam@0 623 </tr>
cannam@0 624 </table>
cannam@0 625 </div>
cannam@0 626 <div class="memdoc">
cannam@0 627
cannam@0 628 <p>
cannam@0 629 Get the computer-usable name of the plugin.
cannam@0 630 <p>
cannam@0 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>
cannam@0 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>
cannam@0 633 Example: "zero_crossings"
cannam@0 634 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@0 635
cannam@0 636 </div>
cannam@0 637 </div><p>
cannam@0 638 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
cannam@0 639 <div class="memitem">
cannam@0 640 <div class="memproto">
cannam@0 641 <table class="memname">
cannam@0 642 <tr>
cannam@0 643 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
cannam@0 644 <td>(</td>
cannam@0 645 <td class="paramname"> </td>
cannam@0 646 <td>&nbsp;)&nbsp;</td>
cannam@21 647 <td> const<code> [virtual, inherited]</code></td>
cannam@0 648 </tr>
cannam@0 649 </table>
cannam@0 650 </div>
cannam@0 651 <div class="memdoc">
cannam@0 652
cannam@0 653 <p>
cannam@0 654 Get a human-readable name or title of the plugin.
cannam@0 655 <p>
cannam@0 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>
cannam@0 657 Example: "Zero Crossings"
cannam@0 658 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@0 659
cannam@0 660 </div>
cannam@0 661 </div><p>
cannam@0 662 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
cannam@0 663 <div class="memitem">
cannam@0 664 <div class="memproto">
cannam@0 665 <table class="memname">
cannam@0 666 <tr>
cannam@0 667 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
cannam@0 668 <td>(</td>
cannam@0 669 <td class="paramname"> </td>
cannam@0 670 <td>&nbsp;)&nbsp;</td>
cannam@21 671 <td> const<code> [virtual, inherited]</code></td>
cannam@0 672 </tr>
cannam@0 673 </table>
cannam@0 674 </div>
cannam@0 675 <div class="memdoc">
cannam@0 676
cannam@0 677 <p>
cannam@0 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".
cannam@0 679 <p>
cannam@0 680 May be empty if the name has said it all already.<p>
cannam@0 681 Example: "Detect and count zero crossing points"
cannam@0 682 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@0 683
cannam@0 684 </div>
cannam@0 685 </div><p>
cannam@0 686 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
cannam@0 687 <div class="memitem">
cannam@0 688 <div class="memproto">
cannam@0 689 <table class="memname">
cannam@0 690 <tr>
cannam@0 691 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
cannam@0 692 <td>(</td>
cannam@0 693 <td class="paramname"> </td>
cannam@0 694 <td>&nbsp;)&nbsp;</td>
cannam@21 695 <td> const<code> [virtual, inherited]</code></td>
cannam@0 696 </tr>
cannam@0 697 </table>
cannam@0 698 </div>
cannam@0 699 <div class="memdoc">
cannam@0 700
cannam@0 701 <p>
cannam@0 702 Get the name of the author or vendor of the plugin in human-readable form.
cannam@0 703 <p>
cannam@0 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.
cannam@0 705 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@0 706
cannam@0 707 </div>
cannam@0 708 </div><p>
cannam@0 709 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
cannam@0 710 <div class="memitem">
cannam@0 711 <div class="memproto">
cannam@0 712 <table class="memname">
cannam@0 713 <tr>
cannam@0 714 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
cannam@0 715 <td>(</td>
cannam@0 716 <td class="paramname"> </td>
cannam@0 717 <td>&nbsp;)&nbsp;</td>
cannam@21 718 <td> const<code> [virtual, inherited]</code></td>
cannam@0 719 </tr>
cannam@0 720 </table>
cannam@0 721 </div>
cannam@0 722 <div class="memdoc">
cannam@0 723
cannam@0 724 <p>
cannam@0 725 Get the version number of the plugin.
cannam@0 726 <p>
cannam@0 727
cannam@0 728 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 729
cannam@0 730 </div>
cannam@0 731 </div><p>
cannam@0 732 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
cannam@0 733 <div class="memitem">
cannam@0 734 <div class="memproto">
cannam@0 735 <table class="memname">
cannam@0 736 <tr>
cannam@0 737 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
cannam@0 738 <td>(</td>
cannam@0 739 <td class="paramname"> </td>
cannam@0 740 <td>&nbsp;)&nbsp;</td>
cannam@21 741 <td> const<code> [virtual, inherited]</code></td>
cannam@0 742 </tr>
cannam@0 743 </table>
cannam@0 744 </div>
cannam@0 745 <div class="memdoc">
cannam@0 746
cannam@0 747 <p>
cannam@0 748 Get the copyright statement or licensing summary for the plugin.
cannam@0 749 <p>
cannam@0 750 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
cannam@0 751 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@0 752
cannam@0 753 </div>
cannam@0 754 </div><p>
cannam@21 755 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
cannam@0 756 <div class="memitem">
cannam@0 757 <div class="memproto">
cannam@0 758 <table class="memname">
cannam@0 759 <tr>
cannam@21 760 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
cannam@0 761 <td>(</td>
cannam@0 762 <td class="paramname"> </td>
cannam@0 763 <td>&nbsp;)&nbsp;</td>
cannam@21 764 <td> const<code> [virtual, inherited]</code></td>
cannam@0 765 </tr>
cannam@0 766 </table>
cannam@0 767 </div>
cannam@0 768 <div class="memdoc">
cannam@0 769
cannam@0 770 <p>
cannam@0 771 Get the controllable parameters of this plugin.
cannam@0 772 <p>
cannam@0 773
cannam@0 774 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
cannam@0 775
cannam@0 776 </div>
cannam@0 777 </div><p>
cannam@0 778 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
cannam@0 779 <div class="memitem">
cannam@0 780 <div class="memproto">
cannam@0 781 <table class="memname">
cannam@0 782 <tr>
cannam@0 783 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
cannam@0 784 <td>(</td>
cannam@0 785 <td class="paramtype">std::string&nbsp;</td>
cannam@0 786 <td class="paramname"> </td>
cannam@0 787 <td>&nbsp;)&nbsp;</td>
cannam@21 788 <td> const<code> [virtual, inherited]</code></td>
cannam@0 789 </tr>
cannam@0 790 </table>
cannam@0 791 </div>
cannam@0 792 <div class="memdoc">
cannam@0 793
cannam@0 794 <p>
cannam@0 795 Get the value of a named parameter.
cannam@0 796 <p>
cannam@0 797 The argument is the identifier field from that parameter's descriptor.
cannam@0 798 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
cannam@0 799
cannam@0 800 </div>
cannam@0 801 </div><p>
cannam@0 802 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
cannam@0 803 <div class="memitem">
cannam@0 804 <div class="memproto">
cannam@0 805 <table class="memname">
cannam@0 806 <tr>
cannam@0 807 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
cannam@0 808 <td>(</td>
cannam@0 809 <td class="paramtype">std::string&nbsp;</td>
cannam@0 810 <td class="paramname">, </td>
cannam@0 811 </tr>
cannam@0 812 <tr>
cannam@0 813 <td class="paramkey"></td>
cannam@0 814 <td></td>
cannam@0 815 <td class="paramtype">float&nbsp;</td>
cannam@0 816 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 817 </tr>
cannam@0 818 <tr>
cannam@0 819 <td></td>
cannam@0 820 <td>)</td>
cannam@21 821 <td></td><td></td><td><code> [virtual, inherited]</code></td>
cannam@0 822 </tr>
cannam@0 823 </table>
cannam@0 824 </div>
cannam@0 825 <div class="memdoc">
cannam@0 826
cannam@0 827 <p>
cannam@0 828 Set a named parameter.
cannam@0 829 <p>
cannam@0 830 The first argument is the identifier field from that parameter's descriptor.
cannam@0 831 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
cannam@0 832
cannam@21 833 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 834
cannam@0 835 </div>
cannam@0 836 </div><p>
cannam@21 837 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " -->
cannam@0 838 <div class="memitem">
cannam@0 839 <div class="memproto">
cannam@0 840 <table class="memname">
cannam@0 841 <tr>
cannam@21 842 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
cannam@0 843 <td>(</td>
cannam@0 844 <td class="paramname"> </td>
cannam@0 845 <td>&nbsp;)&nbsp;</td>
cannam@21 846 <td> const<code> [virtual, inherited]</code></td>
cannam@0 847 </tr>
cannam@0 848 </table>
cannam@0 849 </div>
cannam@0 850 <div class="memdoc">
cannam@0 851
cannam@0 852 <p>
cannam@0 853 Get the program settings available in this plugin.
cannam@0 854 <p>
cannam@0 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>
cannam@0 856 The programs must have unique names.
cannam@0 857 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
cannam@0 858
cannam@0 859 </div>
cannam@0 860 </div><p>
cannam@0 861 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
cannam@0 862 <div class="memitem">
cannam@0 863 <div class="memproto">
cannam@0 864 <table class="memname">
cannam@0 865 <tr>
cannam@0 866 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
cannam@0 867 <td>(</td>
cannam@0 868 <td class="paramname"> </td>
cannam@0 869 <td>&nbsp;)&nbsp;</td>
cannam@21 870 <td> const<code> [virtual, inherited]</code></td>
cannam@0 871 </tr>
cannam@0 872 </table>
cannam@0 873 </div>
cannam@0 874 <div class="memdoc">
cannam@0 875
cannam@0 876 <p>
cannam@0 877 Get the current program.
cannam@0 878 <p>
cannam@0 879
cannam@0 880 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
cannam@0 881
cannam@0 882 </div>
cannam@0 883 </div><p>
cannam@0 884 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
cannam@0 885 <div class="memitem">
cannam@0 886 <div class="memproto">
cannam@0 887 <table class="memname">
cannam@0 888 <tr>
cannam@0 889 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
cannam@0 890 <td>(</td>
cannam@0 891 <td class="paramtype">std::string&nbsp;</td>
cannam@0 892 <td class="paramname"> </td>
cannam@0 893 <td>&nbsp;)&nbsp;</td>
cannam@21 894 <td><code> [virtual, inherited]</code></td>
cannam@0 895 </tr>
cannam@0 896 </table>
cannam@0 897 </div>
cannam@0 898 <div class="memdoc">
cannam@0 899
cannam@0 900 <p>
cannam@0 901 Select a program.
cannam@0 902 <p>
cannam@0 903 (If the given program name is not one of the available programs, do nothing.)
cannam@0 904 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
cannam@0 905
cannam@21 906 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 907
cannam@0 908 </div>
cannam@0 909 </div><p>
cannam@0 910 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
cannam@0 911 <div class="memitem">
cannam@0 912 <div class="memproto">
cannam@0 913 <table class="memname">
cannam@0 914 <tr>
cannam@0 915 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
cannam@0 916 <td>(</td>
cannam@0 917 <td class="paramname"> </td>
cannam@0 918 <td>&nbsp;)&nbsp;</td>
cannam@21 919 <td> const<code> [virtual, inherited]</code></td>
cannam@0 920 </tr>
cannam@0 921 </table>
cannam@0 922 </div>
cannam@0 923 <div class="memdoc">
cannam@0 924
cannam@0 925 <p>
cannam@0 926 Get the minimum supported number of input channels.
cannam@0 927 <p>
cannam@0 928
cannam@0 929 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
cannam@0 930
cannam@0 931 </div>
cannam@0 932 </div><p>
cannam@0 933 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
cannam@0 934 <div class="memitem">
cannam@0 935 <div class="memproto">
cannam@0 936 <table class="memname">
cannam@0 937 <tr>
cannam@0 938 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
cannam@0 939 <td>(</td>
cannam@0 940 <td class="paramname"> </td>
cannam@0 941 <td>&nbsp;)&nbsp;</td>
cannam@21 942 <td> const<code> [virtual, inherited]</code></td>
cannam@0 943 </tr>
cannam@0 944 </table>
cannam@0 945 </div>
cannam@0 946 <div class="memdoc">
cannam@0 947
cannam@0 948 <p>
cannam@0 949 Get the maximum supported number of input channels.
cannam@0 950 <p>
cannam@0 951
cannam@0 952 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
cannam@0 953
cannam@0 954 </div>
cannam@0 955 </div><p>
cannam@21 956 <a class="anchor" name="5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getOutputDescriptors" ref="5a9411305f713b4c9827844b89acd270" args="() const " -->
cannam@0 957 <div class="memitem">
cannam@0 958 <div class="memproto">
cannam@0 959 <table class="memname">
cannam@0 960 <tr>
cannam@21 961 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
cannam@0 962 <td>(</td>
cannam@0 963 <td class="paramname"> </td>
cannam@0 964 <td>&nbsp;)&nbsp;</td>
cannam@21 965 <td> const<code> [virtual, inherited]</code></td>
cannam@0 966 </tr>
cannam@0 967 </table>
cannam@0 968 </div>
cannam@0 969 <div class="memdoc">
cannam@0 970
cannam@0 971 <p>
cannam@0 972 Get the outputs of this plugin.
cannam@0 973 <p>
cannam@21 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.
cannam@0 975 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
cannam@0 976
cannam@21 977 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 978
cannam@0 979 </div>
cannam@0 980 </div><p>
cannam@21 981 <a class="anchor" name="2bc8c0992e64f06991fb7cf89f99857e"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getRemainingFeatures" ref="2bc8c0992e64f06991fb7cf89f99857e" args="()" -->
cannam@0 982 <div class="memitem">
cannam@0 983 <div class="memproto">
cannam@0 984 <table class="memname">
cannam@0 985 <tr>
cannam@21 986 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
cannam@0 987 <td>(</td>
cannam@0 988 <td class="paramname"> </td>
cannam@0 989 <td>&nbsp;)&nbsp;</td>
cannam@21 990 <td><code> [virtual, inherited]</code></td>
cannam@0 991 </tr>
cannam@0 992 </table>
cannam@0 993 </div>
cannam@0 994 <div class="memdoc">
cannam@0 995
cannam@0 996 <p>
cannam@0 997 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
cannam@0 998 <p>
cannam@0 999
cannam@0 1000 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
cannam@0 1001
cannam@21 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>
cannam@0 1003
cannam@21 1004 </div>
cannam@21 1005 </div><p>
cannam@21 1006 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
cannam@21 1007 <div class="memitem">
cannam@21 1008 <div class="memproto">
cannam@21 1009 <div class="memtemplate">
cannam@35 1010 template&lt;typename WrapperType &gt; </div>
cannam@21 1011 <table class="memname">
cannam@21 1012 <tr>
cannam@21 1013 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
cannam@21 1014 <td>(</td>
cannam@21 1015 <td class="paramname"> </td>
cannam@21 1016 <td>&nbsp;)&nbsp;</td>
cannam@21 1017 <td><code> [inline, inherited]</code></td>
cannam@21 1018 </tr>
cannam@21 1019 </table>
cannam@21 1020 </div>
cannam@21 1021 <div class="memdoc">
cannam@0 1022
cannam@21 1023 <p>
cannam@21 1024 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
cannam@21 1025 <p>
cannam@21 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.
cannam@21 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>
cannam@21 1028
cannam@21 1029 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
cannam@21 1030
cannam@21 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>
cannam@0 1032
cannam@0 1033 </div>
cannam@0 1034 </div><p>
cannam@0 1035 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 1036 <div class="memitem">
cannam@0 1037 <div class="memproto">
cannam@0 1038 <table class="memname">
cannam@0 1039 <tr>
cannam@0 1040 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 1041 <td>(</td>
cannam@0 1042 <td class="paramname"> </td>
cannam@0 1043 <td>&nbsp;)&nbsp;</td>
cannam@21 1044 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 1045 </tr>
cannam@0 1046 </table>
cannam@0 1047 </div>
cannam@0 1048 <div class="memdoc">
cannam@0 1049
cannam@0 1050 <p>
cannam@0 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>.
cannam@0 1052 <p>
cannam@0 1053 Do not reimplement this function in your subclass.
cannam@0 1054 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@0 1055
cannam@35 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>
cannam@0 1057
cannam@0 1058 </div>
cannam@0 1059 </div><p>
cannam@0 1060 <hr><h2>Member Data Documentation</h2>
cannam@0 1061 <a class="anchor" name="9fa8a6b8a4e41b6e3f2fabc0d23678cc"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_impl" ref="9fa8a6b8a4e41b6e3f2fabc0d23678cc" args="" -->
cannam@0 1062 <div class="memitem">
cannam@0 1063 <div class="memproto">
cannam@0 1064 <table class="memname">
cannam@0 1065 <tr>
cannam@21 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>
cannam@0 1067 </tr>
cannam@0 1068 </table>
cannam@0 1069 </div>
cannam@0 1070 <div class="memdoc">
cannam@0 1071
cannam@0 1072 <p>
cannam@0 1073
cannam@35 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>
cannam@0 1075
cannam@0 1076 </div>
cannam@0 1077 </div><p>
cannam@0 1078 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
cannam@0 1079 <div class="memitem">
cannam@0 1080 <div class="memproto">
cannam@0 1081 <table class="memname">
cannam@0 1082 <tr>
cannam@0 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>
cannam@0 1084 </tr>
cannam@0 1085 </table>
cannam@0 1086 </div>
cannam@0 1087 <div class="memdoc">
cannam@0 1088
cannam@0 1089 <p>
cannam@0 1090
cannam@21 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>
cannam@0 1092
cannam@0 1093 </div>
cannam@0 1094 </div><p>
cannam@0 1095 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginInputDomainAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 1096 <div class="memitem">
cannam@0 1097 <div class="memproto">
cannam@0 1098 <table class="memname">
cannam@0 1099 <tr>
cannam@0 1100 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
cannam@0 1101 </tr>
cannam@0 1102 </table>
cannam@0 1103 </div>
cannam@0 1104 <div class="memdoc">
cannam@0 1105
cannam@0 1106 <p>
cannam@0 1107
cannam@35 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>
cannam@0 1109
cannam@35 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>
cannam@0 1111
cannam@0 1112 </div>
cannam@0 1113 </div><p>
cannam@21 1114 <hr>The documentation for this class was generated from the following file:<ul>
cannam@21 1115 <li><a class="el" href="PluginInputDomainAdapter_8h-source.html">PluginInputDomainAdapter.h</a></ul>
cannam@0 1116 </div>
cannam@35 1117 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 1118 <a href="http://www.doxygen.org/index.html">
cannam@35 1119 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 1120 </body>
cannam@0 1121 </html>