Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginHostAdapter.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::PluginHostAdapter 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="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::PluginHostAdapter Class Reference</h1><!-- doxytag: class="Vamp::PluginHostAdapter" --><!-- doxytag: inherits="Vamp::Plugin" --><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <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> object.
cannam@35 30 <a href="#_details">More...</a>
cannam@35 31 <p>
cannam@35 32 <code>#include &lt;<a class="el" href="PluginHostAdapter_8h-source.html">vamp-hostsdk/PluginHostAdapter.h</a>&gt;</code>
cannam@0 33 <p>
cannam@0 34 <div class="dynheader">
cannam@0 35 Inheritance diagram for Vamp::PluginHostAdapter:</div>
cannam@0 36 <div class="dynsection">
cannam@0 37 <p><center><img src="classVamp_1_1PluginHostAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginHostAdapter__inherit__map" alt="Inheritance graph"></center>
cannam@0 38 <map name="Vamp_1_1PluginHostAdapter__inherit__map">
cannam@35 39 <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="40,81,133,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="27,7,147,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_1PluginHostAdapter-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@0 46 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
cannam@0 47 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
cannam@0 48 }</td></tr>
cannam@0 49
cannam@35 50 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br class="typebreak">
cannam@0 51 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
cannam@0 52
cannam@0 53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
cannam@0 54
cannam@35 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br class="typebreak">
cannam@0 56 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
cannam@0 57
cannam@0 58 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@0 59 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#6535abd551acfbbaab381bbe1268cd49">PluginHostAdapter</a> (const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *descriptor, float inputSampleRate)</td></tr>
cannam@0 60
cannam@21 61 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ed66c091340aa668d3be89c4b4c24474">~PluginHostAdapter</a> ()</td></tr>
cannam@0 62
cannam@0 63 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
cannam@0 64
cannam@0 65 <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="#dd6a2f1ee7e47bd97fa599cead14b738"></a><br></td></tr>
cannam@0 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#5d54c5bbd76bc27b7a243827148afeaa">reset</a> ()</td></tr>
cannam@0 67
cannam@0 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#5d54c5bbd76bc27b7a243827148afeaa"></a><br></td></tr>
cannam@21 69 <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_1PluginHostAdapter.html#8e9d25673367c741631a60cbb36e91d2">getInputDomain</a> () const </td></tr>
cannam@0 70
cannam@21 71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#8e9d25673367c741631a60cbb36e91d2"></a><br></td></tr>
cannam@0 72 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">getVampApiVersion</a> () const </td></tr>
cannam@0 73
cannam@21 74 <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="#98aadddc8403eb46c9d8c5a9d1fdd19e"></a><br></td></tr>
cannam@0 75 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#b27423a656f878d97d2ad2eba4e76c7a">getIdentifier</a> () const </td></tr>
cannam@0 76
cannam@0 77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#b27423a656f878d97d2ad2eba4e76c7a"></a><br></td></tr>
cannam@0 78 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#45f1d0377e233eeddd1b7cefb48be62a">getName</a> () const </td></tr>
cannam@0 79
cannam@0 80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#45f1d0377e233eeddd1b7cefb48be62a"></a><br></td></tr>
cannam@0 81 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#5eaafcef030e81b90a3e77cf16cf8ae1">getDescription</a> () const </td></tr>
cannam@0 82
cannam@0 83 <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="#5eaafcef030e81b90a3e77cf16cf8ae1"></a><br></td></tr>
cannam@0 84 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#f572be0b175f5661559006a380a0f3db">getMaker</a> () const </td></tr>
cannam@0 85
cannam@0 86 <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="#f572be0b175f5661559006a380a0f3db"></a><br></td></tr>
cannam@0 87 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#6fbd94781867ca46a20368c2a3593c77">getPluginVersion</a> () const </td></tr>
cannam@0 88
cannam@0 89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#6fbd94781867ca46a20368c2a3593c77"></a><br></td></tr>
cannam@0 90 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#c73c9d6baad04369beee695e99584815">getCopyright</a> () const </td></tr>
cannam@0 91
cannam@0 92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#c73c9d6baad04369beee695e99584815"></a><br></td></tr>
cannam@21 93 <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_1PluginHostAdapter.html#602faa0bfaae83e2ca53b36292271a76">getParameterDescriptors</a> () const </td></tr>
cannam@0 94
cannam@21 95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#602faa0bfaae83e2ca53b36292271a76"></a><br></td></tr>
cannam@0 96 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#f0c46d4f67ca93be7c76f3ea2e6c8efb">getParameter</a> (std::string) const </td></tr>
cannam@0 97
cannam@0 98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#f0c46d4f67ca93be7c76f3ea2e6c8efb"></a><br></td></tr>
cannam@0 99 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#29f75395aa75b9de0228aa11edf9c6d6">setParameter</a> (std::string, float)</td></tr>
cannam@0 100
cannam@0 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#29f75395aa75b9de0228aa11edf9c6d6"></a><br></td></tr>
cannam@21 102 <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_1PluginHostAdapter.html#e0cde5cd625418c1bc470b91f75daafc">getPrograms</a> () const </td></tr>
cannam@0 103
cannam@21 104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#e0cde5cd625418c1bc470b91f75daafc"></a><br></td></tr>
cannam@0 105 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">getCurrentProgram</a> () const </td></tr>
cannam@0 106
cannam@0 107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#34859eff8ca8d862af39be9636ec1867"></a><br></td></tr>
cannam@0 108 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">selectProgram</a> (std::string)</td></tr>
cannam@0 109
cannam@0 110 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#8f5515ab34cc13d9403ccc6b4b788683"></a><br></td></tr>
cannam@0 111 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#859ad5d59402691daed3cf1af1899ebe">getPreferredStepSize</a> () const </td></tr>
cannam@0 112
cannam@21 113 <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_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#859ad5d59402691daed3cf1af1899ebe"></a><br></td></tr>
cannam@0 114 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#d5e0ea8042bdec4dd18428991117e07a">getPreferredBlockSize</a> () const </td></tr>
cannam@0 115
cannam@21 116 <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_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function). <a href="#d5e0ea8042bdec4dd18428991117e07a"></a><br></td></tr>
cannam@0 117 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">getMinChannelCount</a> () const </td></tr>
cannam@0 118
cannam@0 119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#67d1198c0e58d3f0076d0eda599ff28d"></a><br></td></tr>
cannam@0 120 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">getMaxChannelCount</a> () const </td></tr>
cannam@0 121
cannam@0 122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#25091905e97e39d515d8ffc1a9f2b9e0"></a><br></td></tr>
cannam@21 123 <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_1PluginHostAdapter.html#9649a113da0252fe8bd9fc731b047ae0">getOutputDescriptors</a> () const </td></tr>
cannam@0 124
cannam@21 125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#9649a113da0252fe8bd9fc731b047ae0"></a><br></td></tr>
cannam@21 126 <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_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
cannam@0 127
cannam@21 128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#38fe1080b343ba10e5d8a4b30c87cbdd"></a><br></td></tr>
cannam@21 129 <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_1PluginHostAdapter.html#984a4c11f3fbdcfd90e4837b1619a5ab">getRemainingFeatures</a> ()</td></tr>
cannam@0 130
cannam@21 131 <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="#984a4c11f3fbdcfd90e4837b1619a5ab"></a><br></td></tr>
cannam@0 132 <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 133
cannam@0 134 <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 135 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
cannam@21 136 <tr><td class="memItemLeft" nowrap align="right" valign="top">static std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#09cbfb7903d28f10d6d556c6cb81c5f6">getPluginPath</a> ()</td></tr>
cannam@0 137
cannam@0 138 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
cannam@0 139 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ee417a4c9ba9dbb63777c963d5f9452a">convertFeatures</a> (<a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *, <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;)</td></tr>
cannam@0 140
cannam@0 141 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@0 142 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#0c9f252aca8ac298e30cadd0de032ec2">m_descriptor</a></td></tr>
cannam@0 143
cannam@0 144 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#02ebd03b226b4a467cad747ce77e79ee">m_handle</a></td></tr>
cannam@0 145
cannam@0 146 <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 147
cannam@0 148 </table>
cannam@35 149 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 150 <a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <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> object.
cannam@35 151 <p>
cannam@35 152 The <a class="el" href="namespaceVamp.html">Vamp</a> API is defined in <a class="el" href="vamp_8h.html">vamp/vamp.h</a> as a C API. The C++ objects used for convenience by plugins and hosts actually communicate using the C low-level API, but the details of this communication are handled seamlessly by the <a class="el" href="namespaceVamp.html">Vamp</a> SDK implementation provided the plugin and host use the proper C++ wrapper objects.<p>
cannam@35 153 See also <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a>, the plugin-side wrapper that makes a C++ plugin object available using the C query API.
cannam@35 154 <p>Definition at line <a class="el" href="PluginHostAdapter_8h-source.html#l00068">68</a> of file <a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a>.</p>
cannam@0 155 <hr><h2>Member Typedef Documentation</h2>
cannam@0 156 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::PluginHostAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
cannam@0 157 <div class="memitem">
cannam@0 158 <div class="memproto">
cannam@0 159 <table class="memname">
cannam@0 160 <tr>
cannam@0 161 <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 162 </tr>
cannam@0 163 </table>
cannam@0 164 </div>
cannam@0 165 <div class="memdoc">
cannam@0 166
cannam@0 167 <p>
cannam@0 168
cannam@35 169 <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 170
cannam@0 171 </div>
cannam@0 172 </div><p>
cannam@0 173 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::PluginHostAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
cannam@0 174 <div class="memitem">
cannam@0 175 <div class="memproto">
cannam@0 176 <table class="memname">
cannam@0 177 <tr>
cannam@0 178 <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 179 </tr>
cannam@0 180 </table>
cannam@0 181 </div>
cannam@0 182 <div class="memdoc">
cannam@0 183
cannam@0 184 <p>
cannam@0 185
cannam@35 186 <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 187
cannam@0 188 </div>
cannam@0 189 </div><p>
cannam@0 190 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::PluginHostAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
cannam@0 191 <div class="memitem">
cannam@0 192 <div class="memproto">
cannam@0 193 <table class="memname">
cannam@0 194 <tr>
cannam@0 195 <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 196 </tr>
cannam@0 197 </table>
cannam@0 198 </div>
cannam@0 199 <div class="memdoc">
cannam@0 200
cannam@0 201 <p>
cannam@0 202
cannam@35 203 <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 204
cannam@0 205 </div>
cannam@0 206 </div><p>
cannam@0 207 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::PluginHostAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 208 <div class="memitem">
cannam@0 209 <div class="memproto">
cannam@0 210 <table class="memname">
cannam@0 211 <tr>
cannam@0 212 <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 213 </tr>
cannam@0 214 </table>
cannam@0 215 </div>
cannam@0 216 <div class="memdoc">
cannam@0 217
cannam@0 218 <p>
cannam@0 219
cannam@21 220 <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 221
cannam@0 222 </div>
cannam@0 223 </div><p>
cannam@0 224 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::PluginHostAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 225 <div class="memitem">
cannam@0 226 <div class="memproto">
cannam@0 227 <table class="memname">
cannam@0 228 <tr>
cannam@0 229 <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 230 </tr>
cannam@0 231 </table>
cannam@0 232 </div>
cannam@0 233 <div class="memdoc">
cannam@0 234
cannam@0 235 <p>
cannam@0 236
cannam@21 237 <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 238
cannam@0 239 </div>
cannam@0 240 </div><p>
cannam@0 241 <hr><h2>Member Enumeration Documentation</h2>
cannam@0 242 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::PluginHostAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
cannam@0 243 <div class="memitem">
cannam@0 244 <div class="memproto">
cannam@0 245 <table class="memname">
cannam@0 246 <tr>
cannam@0 247 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
cannam@0 248 </tr>
cannam@0 249 </table>
cannam@0 250 </div>
cannam@0 251 <div class="memdoc">
cannam@0 252
cannam@0 253 <p>
cannam@0 254 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 255 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 256 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
cannam@0 257 </td></tr>
cannam@0 258 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
cannam@0 259 </td></tr>
cannam@0 260 </table>
cannam@0 261 </dl>
cannam@0 262
cannam@21 263 <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 264
cannam@0 265 </div>
cannam@0 266 </div><p>
cannam@0 267 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 268 <a class="anchor" name="6535abd551acfbbaab381bbe1268cd49"></a><!-- doxytag: member="Vamp::PluginHostAdapter::PluginHostAdapter" ref="6535abd551acfbbaab381bbe1268cd49" args="(const VampPluginDescriptor *descriptor, float inputSampleRate)" -->
cannam@0 269 <div class="memitem">
cannam@0 270 <div class="memproto">
cannam@0 271 <table class="memname">
cannam@0 272 <tr>
cannam@0 273 <td class="memname">Vamp::PluginHostAdapter::PluginHostAdapter </td>
cannam@0 274 <td>(</td>
cannam@0 275 <td class="paramtype">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *&nbsp;</td>
cannam@0 276 <td class="paramname"> <em>descriptor</em>, </td>
cannam@0 277 </tr>
cannam@0 278 <tr>
cannam@0 279 <td class="paramkey"></td>
cannam@0 280 <td></td>
cannam@0 281 <td class="paramtype">float&nbsp;</td>
cannam@0 282 <td class="paramname"> <em>inputSampleRate</em></td><td>&nbsp;</td>
cannam@0 283 </tr>
cannam@0 284 <tr>
cannam@0 285 <td></td>
cannam@0 286 <td>)</td>
cannam@21 287 <td></td><td></td><td></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
cannam@0 295 </div>
cannam@0 296 </div><p>
cannam@21 297 <a class="anchor" name="ed66c091340aa668d3be89c4b4c24474"></a><!-- doxytag: member="Vamp::PluginHostAdapter::~PluginHostAdapter" ref="ed66c091340aa668d3be89c4b4c24474" args="()" -->
cannam@0 298 <div class="memitem">
cannam@0 299 <div class="memproto">
cannam@0 300 <table class="memname">
cannam@0 301 <tr>
cannam@21 302 <td class="memname">virtual Vamp::PluginHostAdapter::~PluginHostAdapter </td>
cannam@0 303 <td>(</td>
cannam@0 304 <td class="paramname"> </td>
cannam@0 305 <td>&nbsp;)&nbsp;</td>
cannam@21 306 <td><code> [virtual]</code></td>
cannam@0 307 </tr>
cannam@0 308 </table>
cannam@0 309 </div>
cannam@0 310 <div class="memdoc">
cannam@0 311
cannam@0 312 <p>
cannam@0 313
cannam@0 314 </div>
cannam@0 315 </div><p>
cannam@0 316 <hr><h2>Member Function Documentation</h2>
cannam@21 317 <a class="anchor" name="09cbfb7903d28f10d6d556c6cb81c5f6"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPluginPath" ref="09cbfb7903d28f10d6d556c6cb81c5f6" args="()" -->
cannam@0 318 <div class="memitem">
cannam@0 319 <div class="memproto">
cannam@0 320 <table class="memname">
cannam@0 321 <tr>
cannam@21 322 <td class="memname">static std::vector&lt;std::string&gt; Vamp::PluginHostAdapter::getPluginPath </td>
cannam@0 323 <td>(</td>
cannam@0 324 <td class="paramname"> </td>
cannam@0 325 <td>&nbsp;)&nbsp;</td>
cannam@21 326 <td><code> [static]</code></td>
cannam@0 327 </tr>
cannam@0 328 </table>
cannam@0 329 </div>
cannam@0 330 <div class="memdoc">
cannam@0 331
cannam@0 332 <p>
cannam@0 333
cannam@0 334 </div>
cannam@0 335 </div><p>
cannam@0 336 <a class="anchor" name="dd6a2f1ee7e47bd97fa599cead14b738"></a><!-- doxytag: member="Vamp::PluginHostAdapter::initialise" ref="dd6a2f1ee7e47bd97fa599cead14b738" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
cannam@0 337 <div class="memitem">
cannam@0 338 <div class="memproto">
cannam@0 339 <table class="memname">
cannam@0 340 <tr>
cannam@0 341 <td class="memname">bool Vamp::PluginHostAdapter::initialise </td>
cannam@0 342 <td>(</td>
cannam@0 343 <td class="paramtype">size_t&nbsp;</td>
cannam@0 344 <td class="paramname"> <em>inputChannels</em>, </td>
cannam@0 345 </tr>
cannam@0 346 <tr>
cannam@0 347 <td class="paramkey"></td>
cannam@0 348 <td></td>
cannam@0 349 <td class="paramtype">size_t&nbsp;</td>
cannam@0 350 <td class="paramname"> <em>stepSize</em>, </td>
cannam@0 351 </tr>
cannam@0 352 <tr>
cannam@0 353 <td class="paramkey"></td>
cannam@0 354 <td></td>
cannam@0 355 <td class="paramtype">size_t&nbsp;</td>
cannam@0 356 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
cannam@0 357 </tr>
cannam@0 358 <tr>
cannam@0 359 <td></td>
cannam@0 360 <td>)</td>
cannam@21 361 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 362 </tr>
cannam@0 363 </table>
cannam@0 364 </div>
cannam@0 365 <div class="memdoc">
cannam@0 366
cannam@0 367 <p>
cannam@0 368 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 369 <p>
cannam@0 370 The input sample rate should have been already specified at construction time.<p>
cannam@0 371 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
cannam@0 372 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
cannam@0 373
cannam@0 374 </div>
cannam@0 375 </div><p>
cannam@0 376 <a class="anchor" name="5d54c5bbd76bc27b7a243827148afeaa"></a><!-- doxytag: member="Vamp::PluginHostAdapter::reset" ref="5d54c5bbd76bc27b7a243827148afeaa" args="()" -->
cannam@0 377 <div class="memitem">
cannam@0 378 <div class="memproto">
cannam@0 379 <table class="memname">
cannam@0 380 <tr>
cannam@0 381 <td class="memname">void Vamp::PluginHostAdapter::reset </td>
cannam@0 382 <td>(</td>
cannam@0 383 <td class="paramname"> </td>
cannam@0 384 <td>&nbsp;)&nbsp;</td>
cannam@21 385 <td><code> [virtual]</code></td>
cannam@0 386 </tr>
cannam@0 387 </table>
cannam@0 388 </div>
cannam@0 389 <div class="memdoc">
cannam@0 390
cannam@0 391 <p>
cannam@0 392 Reset the plugin after use, to prepare it for another clean run.
cannam@0 393 <p>
cannam@0 394 Not called for the first initialisation (i.e. initialise must also do a reset).
cannam@0 395 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
cannam@0 396
cannam@0 397 </div>
cannam@0 398 </div><p>
cannam@21 399 <a class="anchor" name="8e9d25673367c741631a60cbb36e91d2"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getInputDomain" ref="8e9d25673367c741631a60cbb36e91d2" args="() const " -->
cannam@0 400 <div class="memitem">
cannam@0 401 <div class="memproto">
cannam@0 402 <table class="memname">
cannam@0 403 <tr>
cannam@21 404 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::PluginHostAdapter::getInputDomain </td>
cannam@0 405 <td>(</td>
cannam@0 406 <td class="paramname"> </td>
cannam@0 407 <td>&nbsp;)&nbsp;</td>
cannam@21 408 <td> const<code> [virtual]</code></td>
cannam@0 409 </tr>
cannam@0 410 </table>
cannam@0 411 </div>
cannam@0 412 <div class="memdoc">
cannam@0 413
cannam@0 414 <p>
cannam@0 415 Get the plugin's required input domain.
cannam@0 416 <p>
cannam@35 417 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" 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 418 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_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" 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@0 419 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
cannam@0 420
cannam@0 421 </div>
cannam@0 422 </div><p>
cannam@0 423 <a class="anchor" name="98aadddc8403eb46c9d8c5a9d1fdd19e"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getVampApiVersion" ref="98aadddc8403eb46c9d8c5a9d1fdd19e" args="() const " -->
cannam@0 424 <div class="memitem">
cannam@0 425 <div class="memproto">
cannam@0 426 <table class="memname">
cannam@0 427 <tr>
cannam@0 428 <td class="memname">unsigned int Vamp::PluginHostAdapter::getVampApiVersion </td>
cannam@0 429 <td>(</td>
cannam@0 430 <td class="paramname"> </td>
cannam@0 431 <td>&nbsp;)&nbsp;</td>
cannam@21 432 <td> const<code> [virtual]</code></td>
cannam@0 433 </tr>
cannam@0 434 </table>
cannam@0 435 </div>
cannam@0 436 <div class="memdoc">
cannam@0 437
cannam@0 438 <p>
cannam@21 439 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
cannam@0 440 <p>
cannam@0 441
cannam@0 442 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
cannam@0 443
cannam@0 444 </div>
cannam@0 445 </div><p>
cannam@0 446 <a class="anchor" name="b27423a656f878d97d2ad2eba4e76c7a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getIdentifier" ref="b27423a656f878d97d2ad2eba4e76c7a" args="() const " -->
cannam@0 447 <div class="memitem">
cannam@0 448 <div class="memproto">
cannam@0 449 <table class="memname">
cannam@0 450 <tr>
cannam@0 451 <td class="memname">std::string Vamp::PluginHostAdapter::getIdentifier </td>
cannam@0 452 <td>(</td>
cannam@0 453 <td class="paramname"> </td>
cannam@0 454 <td>&nbsp;)&nbsp;</td>
cannam@21 455 <td> const<code> [virtual]</code></td>
cannam@0 456 </tr>
cannam@0 457 </table>
cannam@0 458 </div>
cannam@0 459 <div class="memdoc">
cannam@0 460
cannam@0 461 <p>
cannam@0 462 Get the computer-usable name of the plugin.
cannam@0 463 <p>
cannam@0 464 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 465 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 466 Example: "zero_crossings"
cannam@0 467 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@0 468
cannam@0 469 </div>
cannam@0 470 </div><p>
cannam@0 471 <a class="anchor" name="45f1d0377e233eeddd1b7cefb48be62a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getName" ref="45f1d0377e233eeddd1b7cefb48be62a" args="() const " -->
cannam@0 472 <div class="memitem">
cannam@0 473 <div class="memproto">
cannam@0 474 <table class="memname">
cannam@0 475 <tr>
cannam@0 476 <td class="memname">std::string Vamp::PluginHostAdapter::getName </td>
cannam@0 477 <td>(</td>
cannam@0 478 <td class="paramname"> </td>
cannam@0 479 <td>&nbsp;)&nbsp;</td>
cannam@21 480 <td> const<code> [virtual]</code></td>
cannam@0 481 </tr>
cannam@0 482 </table>
cannam@0 483 </div>
cannam@0 484 <div class="memdoc">
cannam@0 485
cannam@0 486 <p>
cannam@0 487 Get a human-readable name or title of the plugin.
cannam@0 488 <p>
cannam@0 489 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 490 Example: "Zero Crossings"
cannam@0 491 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@0 492
cannam@0 493 </div>
cannam@0 494 </div><p>
cannam@0 495 <a class="anchor" name="5eaafcef030e81b90a3e77cf16cf8ae1"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getDescription" ref="5eaafcef030e81b90a3e77cf16cf8ae1" args="() const " -->
cannam@0 496 <div class="memitem">
cannam@0 497 <div class="memproto">
cannam@0 498 <table class="memname">
cannam@0 499 <tr>
cannam@0 500 <td class="memname">std::string Vamp::PluginHostAdapter::getDescription </td>
cannam@0 501 <td>(</td>
cannam@0 502 <td class="paramname"> </td>
cannam@0 503 <td>&nbsp;)&nbsp;</td>
cannam@21 504 <td> const<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 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 512 <p>
cannam@0 513 May be empty if the name has said it all already.<p>
cannam@0 514 Example: "Detect and count zero crossing points"
cannam@0 515 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@0 516
cannam@0 517 </div>
cannam@0 518 </div><p>
cannam@0 519 <a class="anchor" name="f572be0b175f5661559006a380a0f3db"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMaker" ref="f572be0b175f5661559006a380a0f3db" args="() const " -->
cannam@0 520 <div class="memitem">
cannam@0 521 <div class="memproto">
cannam@0 522 <table class="memname">
cannam@0 523 <tr>
cannam@0 524 <td class="memname">std::string Vamp::PluginHostAdapter::getMaker </td>
cannam@0 525 <td>(</td>
cannam@0 526 <td class="paramname"> </td>
cannam@0 527 <td>&nbsp;)&nbsp;</td>
cannam@21 528 <td> const<code> [virtual]</code></td>
cannam@0 529 </tr>
cannam@0 530 </table>
cannam@0 531 </div>
cannam@0 532 <div class="memdoc">
cannam@0 533
cannam@0 534 <p>
cannam@0 535 Get the name of the author or vendor of the plugin in human-readable form.
cannam@0 536 <p>
cannam@0 537 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 538 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@0 539
cannam@0 540 </div>
cannam@0 541 </div><p>
cannam@0 542 <a class="anchor" name="6fbd94781867ca46a20368c2a3593c77"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPluginVersion" ref="6fbd94781867ca46a20368c2a3593c77" args="() const " -->
cannam@0 543 <div class="memitem">
cannam@0 544 <div class="memproto">
cannam@0 545 <table class="memname">
cannam@0 546 <tr>
cannam@0 547 <td class="memname">int Vamp::PluginHostAdapter::getPluginVersion </td>
cannam@0 548 <td>(</td>
cannam@0 549 <td class="paramname"> </td>
cannam@0 550 <td>&nbsp;)&nbsp;</td>
cannam@21 551 <td> const<code> [virtual]</code></td>
cannam@0 552 </tr>
cannam@0 553 </table>
cannam@0 554 </div>
cannam@0 555 <div class="memdoc">
cannam@0 556
cannam@0 557 <p>
cannam@0 558 Get the version number of the plugin.
cannam@0 559 <p>
cannam@0 560
cannam@0 561 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 562
cannam@0 563 </div>
cannam@0 564 </div><p>
cannam@0 565 <a class="anchor" name="c73c9d6baad04369beee695e99584815"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getCopyright" ref="c73c9d6baad04369beee695e99584815" args="() const " -->
cannam@0 566 <div class="memitem">
cannam@0 567 <div class="memproto">
cannam@0 568 <table class="memname">
cannam@0 569 <tr>
cannam@0 570 <td class="memname">std::string Vamp::PluginHostAdapter::getCopyright </td>
cannam@0 571 <td>(</td>
cannam@0 572 <td class="paramname"> </td>
cannam@0 573 <td>&nbsp;)&nbsp;</td>
cannam@21 574 <td> const<code> [virtual]</code></td>
cannam@0 575 </tr>
cannam@0 576 </table>
cannam@0 577 </div>
cannam@0 578 <div class="memdoc">
cannam@0 579
cannam@0 580 <p>
cannam@0 581 Get the copyright statement or licensing summary for the plugin.
cannam@0 582 <p>
cannam@0 583 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
cannam@0 584 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@0 585
cannam@0 586 </div>
cannam@0 587 </div><p>
cannam@21 588 <a class="anchor" name="602faa0bfaae83e2ca53b36292271a76"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getParameterDescriptors" ref="602faa0bfaae83e2ca53b36292271a76" args="() const " -->
cannam@0 589 <div class="memitem">
cannam@0 590 <div class="memproto">
cannam@0 591 <table class="memname">
cannam@0 592 <tr>
cannam@21 593 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginHostAdapter::getParameterDescriptors </td>
cannam@0 594 <td>(</td>
cannam@0 595 <td class="paramname"> </td>
cannam@0 596 <td>&nbsp;)&nbsp;</td>
cannam@21 597 <td> const<code> [virtual]</code></td>
cannam@0 598 </tr>
cannam@0 599 </table>
cannam@0 600 </div>
cannam@0 601 <div class="memdoc">
cannam@0 602
cannam@0 603 <p>
cannam@0 604 Get the controllable parameters of this plugin.
cannam@0 605 <p>
cannam@0 606
cannam@0 607 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
cannam@0 608
cannam@0 609 </div>
cannam@0 610 </div><p>
cannam@0 611 <a class="anchor" name="f0c46d4f67ca93be7c76f3ea2e6c8efb"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getParameter" ref="f0c46d4f67ca93be7c76f3ea2e6c8efb" args="(std::string) const " -->
cannam@0 612 <div class="memitem">
cannam@0 613 <div class="memproto">
cannam@0 614 <table class="memname">
cannam@0 615 <tr>
cannam@0 616 <td class="memname">float Vamp::PluginHostAdapter::getParameter </td>
cannam@0 617 <td>(</td>
cannam@0 618 <td class="paramtype">std::string&nbsp;</td>
cannam@0 619 <td class="paramname"> </td>
cannam@0 620 <td>&nbsp;)&nbsp;</td>
cannam@21 621 <td> const<code> [virtual]</code></td>
cannam@0 622 </tr>
cannam@0 623 </table>
cannam@0 624 </div>
cannam@0 625 <div class="memdoc">
cannam@0 626
cannam@0 627 <p>
cannam@0 628 Get the value of a named parameter.
cannam@0 629 <p>
cannam@0 630 The argument is the identifier field from that parameter's descriptor.
cannam@0 631 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
cannam@0 632
cannam@0 633 </div>
cannam@0 634 </div><p>
cannam@0 635 <a class="anchor" name="29f75395aa75b9de0228aa11edf9c6d6"></a><!-- doxytag: member="Vamp::PluginHostAdapter::setParameter" ref="29f75395aa75b9de0228aa11edf9c6d6" args="(std::string, float)" -->
cannam@0 636 <div class="memitem">
cannam@0 637 <div class="memproto">
cannam@0 638 <table class="memname">
cannam@0 639 <tr>
cannam@0 640 <td class="memname">void Vamp::PluginHostAdapter::setParameter </td>
cannam@0 641 <td>(</td>
cannam@0 642 <td class="paramtype">std::string&nbsp;</td>
cannam@0 643 <td class="paramname">, </td>
cannam@0 644 </tr>
cannam@0 645 <tr>
cannam@0 646 <td class="paramkey"></td>
cannam@0 647 <td></td>
cannam@0 648 <td class="paramtype">float&nbsp;</td>
cannam@0 649 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 650 </tr>
cannam@0 651 <tr>
cannam@0 652 <td></td>
cannam@0 653 <td>)</td>
cannam@21 654 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 655 </tr>
cannam@0 656 </table>
cannam@0 657 </div>
cannam@0 658 <div class="memdoc">
cannam@0 659
cannam@0 660 <p>
cannam@0 661 Set a named parameter.
cannam@0 662 <p>
cannam@0 663 The first argument is the identifier field from that parameter's descriptor.
cannam@0 664 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
cannam@0 665
cannam@0 666 </div>
cannam@0 667 </div><p>
cannam@21 668 <a class="anchor" name="e0cde5cd625418c1bc470b91f75daafc"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPrograms" ref="e0cde5cd625418c1bc470b91f75daafc" args="() const " -->
cannam@0 669 <div class="memitem">
cannam@0 670 <div class="memproto">
cannam@0 671 <table class="memname">
cannam@0 672 <tr>
cannam@21 673 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginHostAdapter::getPrograms </td>
cannam@0 674 <td>(</td>
cannam@0 675 <td class="paramname"> </td>
cannam@0 676 <td>&nbsp;)&nbsp;</td>
cannam@21 677 <td> const<code> [virtual]</code></td>
cannam@0 678 </tr>
cannam@0 679 </table>
cannam@0 680 </div>
cannam@0 681 <div class="memdoc">
cannam@0 682
cannam@0 683 <p>
cannam@0 684 Get the program settings available in this plugin.
cannam@0 685 <p>
cannam@0 686 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 687 The programs must have unique names.
cannam@0 688 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
cannam@0 689
cannam@0 690 </div>
cannam@0 691 </div><p>
cannam@0 692 <a class="anchor" name="34859eff8ca8d862af39be9636ec1867"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getCurrentProgram" ref="34859eff8ca8d862af39be9636ec1867" args="() const " -->
cannam@0 693 <div class="memitem">
cannam@0 694 <div class="memproto">
cannam@0 695 <table class="memname">
cannam@0 696 <tr>
cannam@0 697 <td class="memname">std::string Vamp::PluginHostAdapter::getCurrentProgram </td>
cannam@0 698 <td>(</td>
cannam@0 699 <td class="paramname"> </td>
cannam@0 700 <td>&nbsp;)&nbsp;</td>
cannam@21 701 <td> const<code> [virtual]</code></td>
cannam@0 702 </tr>
cannam@0 703 </table>
cannam@0 704 </div>
cannam@0 705 <div class="memdoc">
cannam@0 706
cannam@0 707 <p>
cannam@0 708 Get the current program.
cannam@0 709 <p>
cannam@0 710
cannam@0 711 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
cannam@0 712
cannam@0 713 </div>
cannam@0 714 </div><p>
cannam@0 715 <a class="anchor" name="8f5515ab34cc13d9403ccc6b4b788683"></a><!-- doxytag: member="Vamp::PluginHostAdapter::selectProgram" ref="8f5515ab34cc13d9403ccc6b4b788683" args="(std::string)" -->
cannam@0 716 <div class="memitem">
cannam@0 717 <div class="memproto">
cannam@0 718 <table class="memname">
cannam@0 719 <tr>
cannam@0 720 <td class="memname">void Vamp::PluginHostAdapter::selectProgram </td>
cannam@0 721 <td>(</td>
cannam@0 722 <td class="paramtype">std::string&nbsp;</td>
cannam@0 723 <td class="paramname"> </td>
cannam@0 724 <td>&nbsp;)&nbsp;</td>
cannam@21 725 <td><code> [virtual]</code></td>
cannam@0 726 </tr>
cannam@0 727 </table>
cannam@0 728 </div>
cannam@0 729 <div class="memdoc">
cannam@0 730
cannam@0 731 <p>
cannam@0 732 Select a program.
cannam@0 733 <p>
cannam@0 734 (If the given program name is not one of the available programs, do nothing.)
cannam@0 735 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
cannam@0 736
cannam@0 737 </div>
cannam@0 738 </div><p>
cannam@0 739 <a class="anchor" name="859ad5d59402691daed3cf1af1899ebe"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPreferredStepSize" ref="859ad5d59402691daed3cf1af1899ebe" args="() const " -->
cannam@0 740 <div class="memitem">
cannam@0 741 <div class="memproto">
cannam@0 742 <table class="memname">
cannam@0 743 <tr>
cannam@0 744 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredStepSize </td>
cannam@0 745 <td>(</td>
cannam@0 746 <td class="paramname"> </td>
cannam@0 747 <td>&nbsp;)&nbsp;</td>
cannam@21 748 <td> const<code> [virtual]</code></td>
cannam@0 749 </tr>
cannam@0 750 </table>
cannam@0 751 </div>
cannam@0 752 <div class="memdoc">
cannam@0 753
cannam@0 754 <p>
cannam@21 755 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_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function) for the plugin.
cannam@0 756 <p>
cannam@0 757 This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
cannam@0 758 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_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
cannam@0 759 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
cannam@0 760
cannam@0 761 </div>
cannam@0 762 </div><p>
cannam@0 763 <a class="anchor" name="d5e0ea8042bdec4dd18428991117e07a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPreferredBlockSize" ref="d5e0ea8042bdec4dd18428991117e07a" args="() const " -->
cannam@0 764 <div class="memitem">
cannam@0 765 <div class="memproto">
cannam@0 766 <table class="memname">
cannam@0 767 <tr>
cannam@0 768 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredBlockSize </td>
cannam@0 769 <td>(</td>
cannam@0 770 <td class="paramname"> </td>
cannam@0 771 <td>&nbsp;)&nbsp;</td>
cannam@21 772 <td> const<code> [virtual]</code></td>
cannam@0 773 </tr>
cannam@0 774 </table>
cannam@0 775 </div>
cannam@0 776 <div class="memdoc">
cannam@0 777
cannam@0 778 <p>
cannam@21 779 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function).
cannam@0 780 <p>
cannam@0 781 This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
cannam@0 782 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_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
cannam@0 783 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
cannam@0 784
cannam@0 785 </div>
cannam@0 786 </div><p>
cannam@0 787 <a class="anchor" name="67d1198c0e58d3f0076d0eda599ff28d"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMinChannelCount" ref="67d1198c0e58d3f0076d0eda599ff28d" args="() const " -->
cannam@0 788 <div class="memitem">
cannam@0 789 <div class="memproto">
cannam@0 790 <table class="memname">
cannam@0 791 <tr>
cannam@0 792 <td class="memname">size_t Vamp::PluginHostAdapter::getMinChannelCount </td>
cannam@0 793 <td>(</td>
cannam@0 794 <td class="paramname"> </td>
cannam@0 795 <td>&nbsp;)&nbsp;</td>
cannam@21 796 <td> const<code> [virtual]</code></td>
cannam@0 797 </tr>
cannam@0 798 </table>
cannam@0 799 </div>
cannam@0 800 <div class="memdoc">
cannam@0 801
cannam@0 802 <p>
cannam@0 803 Get the minimum supported number of input channels.
cannam@0 804 <p>
cannam@0 805
cannam@0 806 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
cannam@0 807
cannam@0 808 </div>
cannam@0 809 </div><p>
cannam@0 810 <a class="anchor" name="25091905e97e39d515d8ffc1a9f2b9e0"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMaxChannelCount" ref="25091905e97e39d515d8ffc1a9f2b9e0" args="() const " -->
cannam@0 811 <div class="memitem">
cannam@0 812 <div class="memproto">
cannam@0 813 <table class="memname">
cannam@0 814 <tr>
cannam@0 815 <td class="memname">size_t Vamp::PluginHostAdapter::getMaxChannelCount </td>
cannam@0 816 <td>(</td>
cannam@0 817 <td class="paramname"> </td>
cannam@0 818 <td>&nbsp;)&nbsp;</td>
cannam@21 819 <td> const<code> [virtual]</code></td>
cannam@0 820 </tr>
cannam@0 821 </table>
cannam@0 822 </div>
cannam@0 823 <div class="memdoc">
cannam@0 824
cannam@0 825 <p>
cannam@0 826 Get the maximum supported number of input channels.
cannam@0 827 <p>
cannam@0 828
cannam@0 829 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
cannam@0 830
cannam@0 831 </div>
cannam@0 832 </div><p>
cannam@21 833 <a class="anchor" name="9649a113da0252fe8bd9fc731b047ae0"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getOutputDescriptors" ref="9649a113da0252fe8bd9fc731b047ae0" args="() const " -->
cannam@0 834 <div class="memitem">
cannam@0 835 <div class="memproto">
cannam@0 836 <table class="memname">
cannam@0 837 <tr>
cannam@21 838 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::PluginHostAdapter::getOutputDescriptors </td>
cannam@0 839 <td>(</td>
cannam@0 840 <td class="paramname"> </td>
cannam@0 841 <td>&nbsp;)&nbsp;</td>
cannam@21 842 <td> const<code> [virtual]</code></td>
cannam@0 843 </tr>
cannam@0 844 </table>
cannam@0 845 </div>
cannam@0 846 <div class="memdoc">
cannam@0 847
cannam@0 848 <p>
cannam@0 849 Get the outputs of this plugin.
cannam@0 850 <p>
cannam@21 851 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_1PluginHostAdapter.html#38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> call.
cannam@0 852 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
cannam@0 853
cannam@0 854 </div>
cannam@0 855 </div><p>
cannam@21 856 <a class="anchor" name="38fe1080b343ba10e5d8a4b30c87cbdd"></a><!-- doxytag: member="Vamp::PluginHostAdapter::process" ref="38fe1080b343ba10e5d8a4b30c87cbdd" args="(const float *const *inputBuffers, RealTime timestamp)" -->
cannam@0 857 <div class="memitem">
cannam@0 858 <div class="memproto">
cannam@0 859 <table class="memname">
cannam@0 860 <tr>
cannam@21 861 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::PluginHostAdapter::process </td>
cannam@0 862 <td>(</td>
cannam@0 863 <td class="paramtype">const float *const *&nbsp;</td>
cannam@0 864 <td class="paramname"> <em>inputBuffers</em>, </td>
cannam@0 865 </tr>
cannam@0 866 <tr>
cannam@0 867 <td class="paramkey"></td>
cannam@0 868 <td></td>
cannam@0 869 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td>
cannam@0 870 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
cannam@0 871 </tr>
cannam@0 872 <tr>
cannam@0 873 <td></td>
cannam@0 874 <td>)</td>
cannam@21 875 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 876 </tr>
cannam@0 877 </table>
cannam@0 878 </div>
cannam@0 879 <div class="memdoc">
cannam@0 880
cannam@0 881 <p>
cannam@0 882 Process a single block of input data.
cannam@0 883 <p>
cannam@21 884 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 885 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 886 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@0 887 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
cannam@0 888
cannam@0 889 </div>
cannam@0 890 </div><p>
cannam@21 891 <a class="anchor" name="984a4c11f3fbdcfd90e4837b1619a5ab"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getRemainingFeatures" ref="984a4c11f3fbdcfd90e4837b1619a5ab" args="()" -->
cannam@0 892 <div class="memitem">
cannam@0 893 <div class="memproto">
cannam@0 894 <table class="memname">
cannam@0 895 <tr>
cannam@21 896 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::PluginHostAdapter::getRemainingFeatures </td>
cannam@0 897 <td>(</td>
cannam@0 898 <td class="paramname"> </td>
cannam@0 899 <td>&nbsp;)&nbsp;</td>
cannam@21 900 <td><code> [virtual]</code></td>
cannam@0 901 </tr>
cannam@0 902 </table>
cannam@0 903 </div>
cannam@0 904 <div class="memdoc">
cannam@0 905
cannam@0 906 <p>
cannam@0 907 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
cannam@0 908 <p>
cannam@0 909
cannam@0 910 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
cannam@0 911
cannam@0 912 </div>
cannam@0 913 </div><p>
cannam@0 914 <a class="anchor" name="ee417a4c9ba9dbb63777c963d5f9452a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::convertFeatures" ref="ee417a4c9ba9dbb63777c963d5f9452a" args="(VampFeatureList *, FeatureSet &amp;)" -->
cannam@0 915 <div class="memitem">
cannam@0 916 <div class="memproto">
cannam@0 917 <table class="memname">
cannam@0 918 <tr>
cannam@0 919 <td class="memname">void Vamp::PluginHostAdapter::convertFeatures </td>
cannam@0 920 <td>(</td>
cannam@0 921 <td class="paramtype"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *&nbsp;</td>
cannam@21 922 <td class="paramname">, </td>
cannam@0 923 </tr>
cannam@0 924 <tr>
cannam@0 925 <td class="paramkey"></td>
cannam@0 926 <td></td>
cannam@0 927 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;&nbsp;</td>
cannam@21 928 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 929 </tr>
cannam@0 930 <tr>
cannam@0 931 <td></td>
cannam@0 932 <td>)</td>
cannam@21 933 <td></td><td></td><td><code> [protected]</code></td>
cannam@0 934 </tr>
cannam@0 935 </table>
cannam@0 936 </div>
cannam@0 937 <div class="memdoc">
cannam@0 938
cannam@0 939 <p>
cannam@0 940
cannam@0 941 </div>
cannam@0 942 </div><p>
cannam@0 943 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 944 <div class="memitem">
cannam@0 945 <div class="memproto">
cannam@0 946 <table class="memname">
cannam@0 947 <tr>
cannam@0 948 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 949 <td>(</td>
cannam@0 950 <td class="paramname"> </td>
cannam@0 951 <td>&nbsp;)&nbsp;</td>
cannam@21 952 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 953 </tr>
cannam@0 954 </table>
cannam@0 955 </div>
cannam@0 956 <div class="memdoc">
cannam@0 957
cannam@0 958 <p>
cannam@0 959 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 960 <p>
cannam@0 961 Do not reimplement this function in your subclass.
cannam@0 962 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@0 963
cannam@35 964 <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 965
cannam@0 966 </div>
cannam@0 967 </div><p>
cannam@0 968 <hr><h2>Member Data Documentation</h2>
cannam@0 969 <a class="anchor" name="0c9f252aca8ac298e30cadd0de032ec2"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_descriptor" ref="0c9f252aca8ac298e30cadd0de032ec2" args="" -->
cannam@0 970 <div class="memitem">
cannam@0 971 <div class="memproto">
cannam@0 972 <table class="memname">
cannam@0 973 <tr>
cannam@0 974 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* <a class="el" href="classVamp_1_1PluginHostAdapter.html#0c9f252aca8ac298e30cadd0de032ec2">Vamp::PluginHostAdapter::m_descriptor</a><code> [protected]</code> </td>
cannam@0 975 </tr>
cannam@0 976 </table>
cannam@0 977 </div>
cannam@0 978 <div class="memdoc">
cannam@0 979
cannam@0 980 <p>
cannam@0 981
cannam@21 982 <p>Definition at line <a class="el" href="PluginHostAdapter_8h-source.html#l00113">113</a> of file <a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a>.</p>
cannam@0 983
cannam@0 984 </div>
cannam@0 985 </div><p>
cannam@0 986 <a class="anchor" name="02ebd03b226b4a467cad747ce77e79ee"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_handle" ref="02ebd03b226b4a467cad747ce77e79ee" args="" -->
cannam@0 987 <div class="memitem">
cannam@0 988 <div class="memproto">
cannam@0 989 <table class="memname">
cannam@0 990 <tr>
cannam@0 991 <td class="memname"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#02ebd03b226b4a467cad747ce77e79ee">Vamp::PluginHostAdapter::m_handle</a><code> [protected]</code> </td>
cannam@0 992 </tr>
cannam@0 993 </table>
cannam@0 994 </div>
cannam@0 995 <div class="memdoc">
cannam@0 996
cannam@0 997 <p>
cannam@0 998
cannam@21 999 <p>Definition at line <a class="el" href="PluginHostAdapter_8h-source.html#l00114">114</a> of file <a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a>.</p>
cannam@0 1000
cannam@0 1001 </div>
cannam@0 1002 </div><p>
cannam@0 1003 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 1004 <div class="memitem">
cannam@0 1005 <div class="memproto">
cannam@0 1006 <table class="memname">
cannam@0 1007 <tr>
cannam@0 1008 <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 1009 </tr>
cannam@0 1010 </table>
cannam@0 1011 </div>
cannam@0 1012 <div class="memdoc">
cannam@0 1013
cannam@0 1014 <p>
cannam@0 1015
cannam@35 1016 <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 1017
cannam@35 1018 <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 1019
cannam@0 1020 </div>
cannam@0 1021 </div><p>
cannam@21 1022 <hr>The documentation for this class was generated from the following file:<ul>
cannam@21 1023 <li><a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a></ul>
cannam@0 1024 </div>
cannam@35 1025 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 1026 <a href="http://www.doxygen.org/index.html">
cannam@35 1027 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 1028 </body>
cannam@0 1029 </html>