Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1PluginHostAdapter.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@1 5 <title>VampPluginSDK: Vamp::PluginHostAdapter Class Reference</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('classVamp_1_1PluginHostAdapter.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="summary">
Chris@1 76 <a href="#pub-types">Public Types</a> &#124;
Chris@1 77 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 78 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
Chris@1 79 <a href="#pro-methods">Protected Member Functions</a> &#124;
Chris@1 80 <a href="#pro-attribs">Protected Attributes</a> </div>
Chris@1 81 <div class="headertitle">
Chris@1 82 <div class="title">Vamp::PluginHostAdapter Class Reference</div> </div>
Chris@1 83 </div>
Chris@1 84 <div class="contents">
Chris@1 85 <!-- doxytag: class="Vamp::PluginHostAdapter" --><!-- doxytag: inherits="Vamp::Plugin" -->
Chris@1 86 <p><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 VampPluginDescri...">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 from audio o...">Vamp::Plugin</a> object.
Chris@1 87 <a href="classVamp_1_1PluginHostAdapter.html#details">More...</a></p>
Chris@1 88
Chris@1 89 <p><code>#include &lt;<a class="el" href="PluginHostAdapter_8h_source.html">vamp-hostsdk/PluginHostAdapter.h</a>&gt;</code></p>
Chris@1 90 <div class="dynheader">
Chris@1 91 Inheritance diagram for Vamp::PluginHostAdapter:</div>
Chris@1 92 <div class="dyncontent">
Chris@1 93 <div class="center"><img src="classVamp_1_1PluginHostAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginHostAdapter_inherit__map" alt="Inheritance graph"/></div>
Chris@1 94 <map name="Vamp_1_1PluginHostAdapter_inherit__map" id="Vamp_1_1PluginHostAdapter_inherit__map">
Chris@1 95 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="38,81,129,106"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="25,6,143,31"/></map>
Chris@1 96 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 97
Chris@1 98 <p><a href="classVamp_1_1PluginHostAdapter-members.html">List of all members.</a></p>
Chris@1 99 <table class="memberdecls">
Chris@1 100 <tr><td colspan="2"><h2><a name="pub-types"></a>
Chris@1 101 Public Types</h2></td></tr>
Chris@1 102 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
Chris@1 103 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
Chris@1 104 }</td></tr>
Chris@1 105 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
Chris@1 106 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
Chris@1 107 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
Chris@1 108 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
Chris@1 109 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
Chris@1 110 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
Chris@1 111 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
Chris@1 112 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
Chris@1 113 <tr><td colspan="2"><h2><a name="pub-methods"></a>
Chris@1 114 Public Member Functions</h2></td></tr>
Chris@1 115 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6535abd551acfbbaab381bbe1268cd49">PluginHostAdapter</a> (const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *descriptor, float inputSampleRate)</td></tr>
Chris@1 116 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aed66c091340aa668d3be89c4b4c24474">~PluginHostAdapter</a> ()</td></tr>
Chris@1 117 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
Chris@1 118 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#add6a2f1ee7e47bd97fa599cead14b738"></a><br/></td></tr>
Chris@1 119 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a5d54c5bbd76bc27b7a243827148afeaa">reset</a> ()</td></tr>
Chris@1 120 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a5d54c5bbd76bc27b7a243827148afeaa"></a><br/></td></tr>
Chris@1 121 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e9d25673367c741631a60cbb36e91d2">getInputDomain</a> () const </td></tr>
Chris@1 122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a8e9d25673367c741631a60cbb36e91d2"></a><br/></td></tr>
Chris@1 123 <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">getVampApiVersion</a> () const </td></tr>
Chris@1 124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a98aadddc8403eb46c9d8c5a9d1fdd19e"></a><br/></td></tr>
Chris@1 125 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ab27423a656f878d97d2ad2eba4e76c7a">getIdentifier</a> () const </td></tr>
Chris@1 126 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ab27423a656f878d97d2ad2eba4e76c7a"></a><br/></td></tr>
Chris@1 127 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a45f1d0377e233eeddd1b7cefb48be62a">getName</a> () const </td></tr>
Chris@1 128 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a45f1d0377e233eeddd1b7cefb48be62a"></a><br/></td></tr>
Chris@1 129 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a5eaafcef030e81b90a3e77cf16cf8ae1">getDescription</a> () const </td></tr>
Chris@1 130 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a5eaafcef030e81b90a3e77cf16cf8ae1"></a><br/></td></tr>
Chris@1 131 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#af572be0b175f5661559006a380a0f3db">getMaker</a> () const </td></tr>
Chris@1 132 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#af572be0b175f5661559006a380a0f3db"></a><br/></td></tr>
Chris@1 133 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6fbd94781867ca46a20368c2a3593c77">getPluginVersion</a> () const </td></tr>
Chris@1 134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a6fbd94781867ca46a20368c2a3593c77"></a><br/></td></tr>
Chris@1 135 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ac73c9d6baad04369beee695e99584815">getCopyright</a> () const </td></tr>
Chris@1 136 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ac73c9d6baad04369beee695e99584815"></a><br/></td></tr>
Chris@1 137 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">getParameterDescriptors</a> () const </td></tr>
Chris@1 138 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a602faa0bfaae83e2ca53b36292271a76"></a><br/></td></tr>
Chris@1 139 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">getParameter</a> (std::string) const </td></tr>
Chris@1 140 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#af0c46d4f67ca93be7c76f3ea2e6c8efb"></a><br/></td></tr>
Chris@1 141 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">setParameter</a> (std::string, float)</td></tr>
Chris@1 142 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a29f75395aa75b9de0228aa11edf9c6d6"></a><br/></td></tr>
Chris@1 143 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">getPrograms</a> () const </td></tr>
Chris@1 144 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#ae0cde5cd625418c1bc470b91f75daafc"></a><br/></td></tr>
Chris@1 145 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">getCurrentProgram</a> () const </td></tr>
Chris@1 146 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a34859eff8ca8d862af39be9636ec1867"></a><br/></td></tr>
Chris@1 147 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">selectProgram</a> (std::string)</td></tr>
Chris@1 148 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a8f5515ab34cc13d9403ccc6b4b788683"></a><br/></td></tr>
Chris@1 149 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">getPreferredStepSize</a> () const </td></tr>
Chris@1 150 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a859ad5d59402691daed3cf1af1899ebe"></a><br/></td></tr>
Chris@1 151 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">getPreferredBlockSize</a> () const </td></tr>
Chris@1 152 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function). <a href="#ad5e0ea8042bdec4dd18428991117e07a"></a><br/></td></tr>
Chris@1 153 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">getMinChannelCount</a> () const </td></tr>
Chris@1 154 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a67d1198c0e58d3f0076d0eda599ff28d"></a><br/></td></tr>
Chris@1 155 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">getMaxChannelCount</a> () const </td></tr>
Chris@1 156 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a25091905e97e39d515d8ffc1a9f2b9e0"></a><br/></td></tr>
Chris@1 157 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a9649a113da0252fe8bd9fc731b047ae0">getOutputDescriptors</a> () const </td></tr>
Chris@1 158 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a9649a113da0252fe8bd9fc731b047ae0"></a><br/></td></tr>
Chris@1 159 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
Chris@1 160 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a38fe1080b343ba10e5d8a4b30c87cbdd"></a><br/></td></tr>
Chris@1 161 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a984a4c11f3fbdcfd90e4837b1619a5ab">getRemainingFeatures</a> ()</td></tr>
Chris@1 162 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#a984a4c11f3fbdcfd90e4837b1619a5ab"></a><br/></td></tr>
Chris@1 163 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
Chris@1 164 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr>
Chris@1 165 <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Chris@1 166 Static Public Member Functions</h2></td></tr>
Chris@1 167 <tr><td class="memItemLeft" align="right" valign="top">static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a09cbfb7903d28f10d6d556c6cb81c5f6">getPluginPath</a> ()</td></tr>
Chris@1 168 <tr><td colspan="2"><h2><a name="pro-methods"></a>
Chris@1 169 Protected Member Functions</h2></td></tr>
Chris@1 170 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aee417a4c9ba9dbb63777c963d5f9452a">convertFeatures</a> (<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *, <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;)</td></tr>
Chris@1 171 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
Chris@1 172 Protected Attributes</h2></td></tr>
Chris@1 173 <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a0c9f252aca8ac298e30cadd0de032ec2">m_descriptor</a></td></tr>
Chris@1 174 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a02ebd03b226b4a467cad747ce77e79ee">m_handle</a></td></tr>
Chris@1 175 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
Chris@1 176 </table>
Chris@1 177 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 178 <div class="textblock"><p><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 VampPluginDescri...">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 from audio o...">Vamp::Plugin</a> object. </p>
Chris@1 179 <p>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>
Chris@1 180 <p>See also <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a>, the plugin-side wrapper that makes a C++ plugin object available using the C query API. </p>
Chris@1 181
Chris@1 182 <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>
Chris@1 183 </div><hr/><h2>Member Typedef Documentation</h2>
Chris@1 184 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::PluginHostAdapter::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
Chris@1 185 <div class="memitem">
Chris@1 186 <div class="memproto">
Chris@1 187 <table class="memname">
Chris@1 188 <tr>
Chris@1 189 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td>
Chris@1 190 </tr>
Chris@1 191 </table>
Chris@1 192 </div>
Chris@1 193 <div class="memdoc">
Chris@1 194
Chris@1 195 <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>
Chris@1 196
Chris@1 197 </div>
Chris@1 198 </div>
Chris@1 199 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::PluginHostAdapter::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
Chris@1 200 <div class="memitem">
Chris@1 201 <div class="memproto">
Chris@1 202 <table class="memname">
Chris@1 203 <tr>
Chris@1 204 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td>
Chris@1 205 </tr>
Chris@1 206 </table>
Chris@1 207 </div>
Chris@1 208 <div class="memdoc">
Chris@1 209
Chris@1 210 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 211
Chris@1 212 </div>
Chris@1 213 </div>
Chris@1 214 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::PluginHostAdapter::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
Chris@1 215 <div class="memitem">
Chris@1 216 <div class="memproto">
Chris@1 217 <table class="memname">
Chris@1 218 <tr>
Chris@1 219 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td>
Chris@1 220 </tr>
Chris@1 221 </table>
Chris@1 222 </div>
Chris@1 223 <div class="memdoc">
Chris@1 224
Chris@1 225 <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>
Chris@1 226
Chris@1 227 </div>
Chris@1 228 </div>
Chris@1 229 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::PluginHostAdapter::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
Chris@1 230 <div class="memitem">
Chris@1 231 <div class="memproto">
Chris@1 232 <table class="memname">
Chris@1 233 <tr>
Chris@1 234 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td>
Chris@1 235 </tr>
Chris@1 236 </table>
Chris@1 237 </div>
Chris@1 238 <div class="memdoc">
Chris@1 239
Chris@1 240 <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>
Chris@1 241
Chris@1 242 </div>
Chris@1 243 </div>
Chris@1 244 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::PluginHostAdapter::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
Chris@1 245 <div class="memitem">
Chris@1 246 <div class="memproto">
Chris@1 247 <table class="memname">
Chris@1 248 <tr>
Chris@1 249 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td>
Chris@1 250 </tr>
Chris@1 251 </table>
Chris@1 252 </div>
Chris@1 253 <div class="memdoc">
Chris@1 254
Chris@1 255 <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>
Chris@1 256
Chris@1 257 </div>
Chris@1 258 </div>
Chris@1 259 <hr/><h2>Member Enumeration Documentation</h2>
Chris@1 260 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::PluginHostAdapter::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
Chris@1 261 <div class="memitem">
Chris@1 262 <div class="memproto">
Chris@1 263 <table class="memname">
Chris@1 264 <tr>
Chris@1 265 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
Chris@1 266 </tr>
Chris@1 267 </table>
Chris@1 268 </div>
Chris@1 269 <div class="memdoc">
Chris@1 270 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
Chris@1 271 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
Chris@1 272 </td></tr>
Chris@1 273 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
Chris@1 274 </td></tr>
Chris@1 275 </table>
Chris@1 276 </dd>
Chris@1 277 </dl>
Chris@1 278
Chris@1 279 <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>
Chris@1 280
Chris@1 281 </div>
Chris@1 282 </div>
Chris@1 283 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@1 284 <a class="anchor" id="a6535abd551acfbbaab381bbe1268cd49"></a><!-- doxytag: member="Vamp::PluginHostAdapter::PluginHostAdapter" ref="a6535abd551acfbbaab381bbe1268cd49" args="(const VampPluginDescriptor *descriptor, float inputSampleRate)" -->
Chris@1 285 <div class="memitem">
Chris@1 286 <div class="memproto">
Chris@1 287 <table class="memname">
Chris@1 288 <tr>
Chris@1 289 <td class="memname">Vamp::PluginHostAdapter::PluginHostAdapter </td>
Chris@1 290 <td>(</td>
Chris@1 291 <td class="paramtype">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td>
Chris@1 292 <td class="paramname"><em>descriptor</em>, </td>
Chris@1 293 </tr>
Chris@1 294 <tr>
Chris@1 295 <td class="paramkey"></td>
Chris@1 296 <td></td>
Chris@1 297 <td class="paramtype">float&#160;</td>
Chris@1 298 <td class="paramname"><em>inputSampleRate</em>&#160;</td>
Chris@1 299 </tr>
Chris@1 300 <tr>
Chris@1 301 <td></td>
Chris@1 302 <td>)</td>
Chris@1 303 <td></td><td></td>
Chris@1 304 </tr>
Chris@1 305 </table>
Chris@1 306 </div>
Chris@1 307 <div class="memdoc">
Chris@1 308
Chris@1 309 </div>
Chris@1 310 </div>
Chris@1 311 <a class="anchor" id="aed66c091340aa668d3be89c4b4c24474"></a><!-- doxytag: member="Vamp::PluginHostAdapter::~PluginHostAdapter" ref="aed66c091340aa668d3be89c4b4c24474" args="()" -->
Chris@1 312 <div class="memitem">
Chris@1 313 <div class="memproto">
Chris@1 314 <table class="memname">
Chris@1 315 <tr>
Chris@1 316 <td class="memname">virtual Vamp::PluginHostAdapter::~PluginHostAdapter </td>
Chris@1 317 <td>(</td>
Chris@1 318 <td class="paramname"></td><td>)</td>
Chris@1 319 <td><code> [virtual]</code></td>
Chris@1 320 </tr>
Chris@1 321 </table>
Chris@1 322 </div>
Chris@1 323 <div class="memdoc">
Chris@1 324
Chris@1 325 </div>
Chris@1 326 </div>
Chris@1 327 <hr/><h2>Member Function Documentation</h2>
Chris@1 328 <a class="anchor" id="a09cbfb7903d28f10d6d556c6cb81c5f6"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPluginPath" ref="a09cbfb7903d28f10d6d556c6cb81c5f6" args="()" -->
Chris@1 329 <div class="memitem">
Chris@1 330 <div class="memproto">
Chris@1 331 <table class="memname">
Chris@1 332 <tr>
Chris@1 333 <td class="memname">static std::vector&lt;std::string&gt; Vamp::PluginHostAdapter::getPluginPath </td>
Chris@1 334 <td>(</td>
Chris@1 335 <td class="paramname"></td><td>)</td>
Chris@1 336 <td><code> [static]</code></td>
Chris@1 337 </tr>
Chris@1 338 </table>
Chris@1 339 </div>
Chris@1 340 <div class="memdoc">
Chris@1 341
Chris@1 342 </div>
Chris@1 343 </div>
Chris@1 344 <a class="anchor" id="add6a2f1ee7e47bd97fa599cead14b738"></a><!-- doxytag: member="Vamp::PluginHostAdapter::initialise" ref="add6a2f1ee7e47bd97fa599cead14b738" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
Chris@1 345 <div class="memitem">
Chris@1 346 <div class="memproto">
Chris@1 347 <table class="memname">
Chris@1 348 <tr>
Chris@1 349 <td class="memname">bool Vamp::PluginHostAdapter::initialise </td>
Chris@1 350 <td>(</td>
Chris@1 351 <td class="paramtype">size_t&#160;</td>
Chris@1 352 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 353 </tr>
Chris@1 354 <tr>
Chris@1 355 <td class="paramkey"></td>
Chris@1 356 <td></td>
Chris@1 357 <td class="paramtype">size_t&#160;</td>
Chris@1 358 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 359 </tr>
Chris@1 360 <tr>
Chris@1 361 <td class="paramkey"></td>
Chris@1 362 <td></td>
Chris@1 363 <td class="paramtype">size_t&#160;</td>
Chris@1 364 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 365 </tr>
Chris@1 366 <tr>
Chris@1 367 <td></td>
Chris@1 368 <td>)</td>
Chris@1 369 <td></td><td><code> [virtual]</code></td>
Chris@1 370 </tr>
Chris@1 371 </table>
Chris@1 372 </div>
Chris@1 373 <div class="memdoc">
Chris@1 374
Chris@1 375 <p>Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). </p>
Chris@1 376 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 377 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
Chris@1 378
Chris@1 379 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 380
Chris@1 381 </div>
Chris@1 382 </div>
Chris@1 383 <a class="anchor" id="a5d54c5bbd76bc27b7a243827148afeaa"></a><!-- doxytag: member="Vamp::PluginHostAdapter::reset" ref="a5d54c5bbd76bc27b7a243827148afeaa" args="()" -->
Chris@1 384 <div class="memitem">
Chris@1 385 <div class="memproto">
Chris@1 386 <table class="memname">
Chris@1 387 <tr>
Chris@1 388 <td class="memname">void Vamp::PluginHostAdapter::reset </td>
Chris@1 389 <td>(</td>
Chris@1 390 <td class="paramname"></td><td>)</td>
Chris@1 391 <td><code> [virtual]</code></td>
Chris@1 392 </tr>
Chris@1 393 </table>
Chris@1 394 </div>
Chris@1 395 <div class="memdoc">
Chris@1 396
Chris@1 397 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 398 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 399
Chris@1 400 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 401
Chris@1 402 </div>
Chris@1 403 </div>
Chris@1 404 <a class="anchor" id="a8e9d25673367c741631a60cbb36e91d2"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getInputDomain" ref="a8e9d25673367c741631a60cbb36e91d2" args="() const " -->
Chris@1 405 <div class="memitem">
Chris@1 406 <div class="memproto">
Chris@1 407 <table class="memname">
Chris@1 408 <tr>
Chris@1 409 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::PluginHostAdapter::getInputDomain </td>
Chris@1 410 <td>(</td>
Chris@1 411 <td class="paramname"></td><td>)</td>
Chris@1 412 <td> const<code> [virtual]</code></td>
Chris@1 413 </tr>
Chris@1 414 </table>
Chris@1 415 </div>
Chris@1 416 <div class="memdoc">
Chris@1 417
Chris@1 418 <p>Get the plugin's required input domain. </p>
Chris@1 419 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" 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>
Chris@1 420 <p>If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. </p>
Chris@1 421
Chris@1 422 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 423
Chris@1 424 </div>
Chris@1 425 </div>
Chris@1 426 <a class="anchor" id="a98aadddc8403eb46c9d8c5a9d1fdd19e"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getVampApiVersion" ref="a98aadddc8403eb46c9d8c5a9d1fdd19e" args="() const " -->
Chris@1 427 <div class="memitem">
Chris@1 428 <div class="memproto">
Chris@1 429 <table class="memname">
Chris@1 430 <tr>
Chris@1 431 <td class="memname">unsigned int Vamp::PluginHostAdapter::getVampApiVersion </td>
Chris@1 432 <td>(</td>
Chris@1 433 <td class="paramname"></td><td>)</td>
Chris@1 434 <td> const<code> [virtual]</code></td>
Chris@1 435 </tr>
Chris@1 436 </table>
Chris@1 437 </div>
Chris@1 438 <div class="memdoc">
Chris@1 439
Chris@1 440 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 441
Chris@1 442 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
Chris@1 443
Chris@1 444 </div>
Chris@1 445 </div>
Chris@1 446 <a class="anchor" id="ab27423a656f878d97d2ad2eba4e76c7a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getIdentifier" ref="ab27423a656f878d97d2ad2eba4e76c7a" args="() const " -->
Chris@1 447 <div class="memitem">
Chris@1 448 <div class="memproto">
Chris@1 449 <table class="memname">
Chris@1 450 <tr>
Chris@1 451 <td class="memname">std::string Vamp::PluginHostAdapter::getIdentifier </td>
Chris@1 452 <td>(</td>
Chris@1 453 <td class="paramname"></td><td>)</td>
Chris@1 454 <td> const<code> [virtual]</code></td>
Chris@1 455 </tr>
Chris@1 456 </table>
Chris@1 457 </div>
Chris@1 458 <div class="memdoc">
Chris@1 459
Chris@1 460 <p>Get the computer-usable name of the plugin. </p>
Chris@1 461 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
Chris@1 462 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
Chris@1 463 <p>Example: "zero_crossings" </p>
Chris@1 464
Chris@1 465 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 466
Chris@1 467 </div>
Chris@1 468 </div>
Chris@1 469 <a class="anchor" id="a45f1d0377e233eeddd1b7cefb48be62a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getName" ref="a45f1d0377e233eeddd1b7cefb48be62a" args="() const " -->
Chris@1 470 <div class="memitem">
Chris@1 471 <div class="memproto">
Chris@1 472 <table class="memname">
Chris@1 473 <tr>
Chris@1 474 <td class="memname">std::string Vamp::PluginHostAdapter::getName </td>
Chris@1 475 <td>(</td>
Chris@1 476 <td class="paramname"></td><td>)</td>
Chris@1 477 <td> const<code> [virtual]</code></td>
Chris@1 478 </tr>
Chris@1 479 </table>
Chris@1 480 </div>
Chris@1 481 <div class="memdoc">
Chris@1 482
Chris@1 483 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 484 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
Chris@1 485 <p>Example: "Zero Crossings" </p>
Chris@1 486
Chris@1 487 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 488
Chris@1 489 </div>
Chris@1 490 </div>
Chris@1 491 <a class="anchor" id="a5eaafcef030e81b90a3e77cf16cf8ae1"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getDescription" ref="a5eaafcef030e81b90a3e77cf16cf8ae1" args="() const " -->
Chris@1 492 <div class="memitem">
Chris@1 493 <div class="memproto">
Chris@1 494 <table class="memname">
Chris@1 495 <tr>
Chris@1 496 <td class="memname">std::string Vamp::PluginHostAdapter::getDescription </td>
Chris@1 497 <td>(</td>
Chris@1 498 <td class="paramname"></td><td>)</td>
Chris@1 499 <td> const<code> [virtual]</code></td>
Chris@1 500 </tr>
Chris@1 501 </table>
Chris@1 502 </div>
Chris@1 503 <div class="memdoc">
Chris@1 504
Chris@1 505 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
Chris@1 506 <p>May be empty if the name has said it all already.</p>
Chris@1 507 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 508
Chris@1 509 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 510
Chris@1 511 </div>
Chris@1 512 </div>
Chris@1 513 <a class="anchor" id="af572be0b175f5661559006a380a0f3db"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMaker" ref="af572be0b175f5661559006a380a0f3db" args="() const " -->
Chris@1 514 <div class="memitem">
Chris@1 515 <div class="memproto">
Chris@1 516 <table class="memname">
Chris@1 517 <tr>
Chris@1 518 <td class="memname">std::string Vamp::PluginHostAdapter::getMaker </td>
Chris@1 519 <td>(</td>
Chris@1 520 <td class="paramname"></td><td>)</td>
Chris@1 521 <td> const<code> [virtual]</code></td>
Chris@1 522 </tr>
Chris@1 523 </table>
Chris@1 524 </div>
Chris@1 525 <div class="memdoc">
Chris@1 526
Chris@1 527 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 528 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
Chris@1 529
Chris@1 530 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 531
Chris@1 532 </div>
Chris@1 533 </div>
Chris@1 534 <a class="anchor" id="a6fbd94781867ca46a20368c2a3593c77"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPluginVersion" ref="a6fbd94781867ca46a20368c2a3593c77" args="() const " -->
Chris@1 535 <div class="memitem">
Chris@1 536 <div class="memproto">
Chris@1 537 <table class="memname">
Chris@1 538 <tr>
Chris@1 539 <td class="memname">int Vamp::PluginHostAdapter::getPluginVersion </td>
Chris@1 540 <td>(</td>
Chris@1 541 <td class="paramname"></td><td>)</td>
Chris@1 542 <td> const<code> [virtual]</code></td>
Chris@1 543 </tr>
Chris@1 544 </table>
Chris@1 545 </div>
Chris@1 546 <div class="memdoc">
Chris@1 547
Chris@1 548 <p>Get the version number of the plugin. </p>
Chris@1 549
Chris@1 550 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 551
Chris@1 552 </div>
Chris@1 553 </div>
Chris@1 554 <a class="anchor" id="ac73c9d6baad04369beee695e99584815"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getCopyright" ref="ac73c9d6baad04369beee695e99584815" args="() const " -->
Chris@1 555 <div class="memitem">
Chris@1 556 <div class="memproto">
Chris@1 557 <table class="memname">
Chris@1 558 <tr>
Chris@1 559 <td class="memname">std::string Vamp::PluginHostAdapter::getCopyright </td>
Chris@1 560 <td>(</td>
Chris@1 561 <td class="paramname"></td><td>)</td>
Chris@1 562 <td> const<code> [virtual]</code></td>
Chris@1 563 </tr>
Chris@1 564 </table>
Chris@1 565 </div>
Chris@1 566 <div class="memdoc">
Chris@1 567
Chris@1 568 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 569 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 570
Chris@1 571 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 572
Chris@1 573 </div>
Chris@1 574 </div>
Chris@1 575 <a class="anchor" id="a602faa0bfaae83e2ca53b36292271a76"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getParameterDescriptors" ref="a602faa0bfaae83e2ca53b36292271a76" args="() const " -->
Chris@1 576 <div class="memitem">
Chris@1 577 <div class="memproto">
Chris@1 578 <table class="memname">
Chris@1 579 <tr>
Chris@1 580 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginHostAdapter::getParameterDescriptors </td>
Chris@1 581 <td>(</td>
Chris@1 582 <td class="paramname"></td><td>)</td>
Chris@1 583 <td> const<code> [virtual]</code></td>
Chris@1 584 </tr>
Chris@1 585 </table>
Chris@1 586 </div>
Chris@1 587 <div class="memdoc">
Chris@1 588
Chris@1 589 <p>Get the controllable parameters of this plugin. </p>
Chris@1 590
Chris@1 591 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
Chris@1 592
Chris@1 593 </div>
Chris@1 594 </div>
Chris@1 595 <a class="anchor" id="af0c46d4f67ca93be7c76f3ea2e6c8efb"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getParameter" ref="af0c46d4f67ca93be7c76f3ea2e6c8efb" args="(std::string) const " -->
Chris@1 596 <div class="memitem">
Chris@1 597 <div class="memproto">
Chris@1 598 <table class="memname">
Chris@1 599 <tr>
Chris@1 600 <td class="memname">float Vamp::PluginHostAdapter::getParameter </td>
Chris@1 601 <td>(</td>
Chris@1 602 <td class="paramtype">std::string&#160;</td>
Chris@1 603 <td class="paramname"></td><td>)</td>
Chris@1 604 <td> const<code> [virtual]</code></td>
Chris@1 605 </tr>
Chris@1 606 </table>
Chris@1 607 </div>
Chris@1 608 <div class="memdoc">
Chris@1 609
Chris@1 610 <p>Get the value of a named parameter. </p>
Chris@1 611 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 612
Chris@1 613 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
Chris@1 614
Chris@1 615 </div>
Chris@1 616 </div>
Chris@1 617 <a class="anchor" id="a29f75395aa75b9de0228aa11edf9c6d6"></a><!-- doxytag: member="Vamp::PluginHostAdapter::setParameter" ref="a29f75395aa75b9de0228aa11edf9c6d6" args="(std::string, float)" -->
Chris@1 618 <div class="memitem">
Chris@1 619 <div class="memproto">
Chris@1 620 <table class="memname">
Chris@1 621 <tr>
Chris@1 622 <td class="memname">void Vamp::PluginHostAdapter::setParameter </td>
Chris@1 623 <td>(</td>
Chris@1 624 <td class="paramtype">std::string&#160;</td>
Chris@1 625 <td class="paramname">, </td>
Chris@1 626 </tr>
Chris@1 627 <tr>
Chris@1 628 <td class="paramkey"></td>
Chris@1 629 <td></td>
Chris@1 630 <td class="paramtype">float&#160;</td>
Chris@1 631 <td class="paramname">&#160;</td>
Chris@1 632 </tr>
Chris@1 633 <tr>
Chris@1 634 <td></td>
Chris@1 635 <td>)</td>
Chris@1 636 <td></td><td><code> [virtual]</code></td>
Chris@1 637 </tr>
Chris@1 638 </table>
Chris@1 639 </div>
Chris@1 640 <div class="memdoc">
Chris@1 641
Chris@1 642 <p>Set a named parameter. </p>
Chris@1 643 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 644
Chris@1 645 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
Chris@1 646
Chris@1 647 </div>
Chris@1 648 </div>
Chris@1 649 <a class="anchor" id="ae0cde5cd625418c1bc470b91f75daafc"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPrograms" ref="ae0cde5cd625418c1bc470b91f75daafc" args="() const " -->
Chris@1 650 <div class="memitem">
Chris@1 651 <div class="memproto">
Chris@1 652 <table class="memname">
Chris@1 653 <tr>
Chris@1 654 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginHostAdapter::getPrograms </td>
Chris@1 655 <td>(</td>
Chris@1 656 <td class="paramname"></td><td>)</td>
Chris@1 657 <td> const<code> [virtual]</code></td>
Chris@1 658 </tr>
Chris@1 659 </table>
Chris@1 660 </div>
Chris@1 661 <div class="memdoc">
Chris@1 662
Chris@1 663 <p>Get the program settings available in this plugin. </p>
Chris@1 664 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p>
Chris@1 665 <p>The programs must have unique names. </p>
Chris@1 666
Chris@1 667 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
Chris@1 668
Chris@1 669 </div>
Chris@1 670 </div>
Chris@1 671 <a class="anchor" id="a34859eff8ca8d862af39be9636ec1867"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getCurrentProgram" ref="a34859eff8ca8d862af39be9636ec1867" args="() const " -->
Chris@1 672 <div class="memitem">
Chris@1 673 <div class="memproto">
Chris@1 674 <table class="memname">
Chris@1 675 <tr>
Chris@1 676 <td class="memname">std::string Vamp::PluginHostAdapter::getCurrentProgram </td>
Chris@1 677 <td>(</td>
Chris@1 678 <td class="paramname"></td><td>)</td>
Chris@1 679 <td> const<code> [virtual]</code></td>
Chris@1 680 </tr>
Chris@1 681 </table>
Chris@1 682 </div>
Chris@1 683 <div class="memdoc">
Chris@1 684
Chris@1 685 <p>Get the current program. </p>
Chris@1 686
Chris@1 687 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
Chris@1 688
Chris@1 689 </div>
Chris@1 690 </div>
Chris@1 691 <a class="anchor" id="a8f5515ab34cc13d9403ccc6b4b788683"></a><!-- doxytag: member="Vamp::PluginHostAdapter::selectProgram" ref="a8f5515ab34cc13d9403ccc6b4b788683" args="(std::string)" -->
Chris@1 692 <div class="memitem">
Chris@1 693 <div class="memproto">
Chris@1 694 <table class="memname">
Chris@1 695 <tr>
Chris@1 696 <td class="memname">void Vamp::PluginHostAdapter::selectProgram </td>
Chris@1 697 <td>(</td>
Chris@1 698 <td class="paramtype">std::string&#160;</td>
Chris@1 699 <td class="paramname"></td><td>)</td>
Chris@1 700 <td><code> [virtual]</code></td>
Chris@1 701 </tr>
Chris@1 702 </table>
Chris@1 703 </div>
Chris@1 704 <div class="memdoc">
Chris@1 705
Chris@1 706 <p>Select a program. </p>
Chris@1 707 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 708
Chris@1 709 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
Chris@1 710
Chris@1 711 </div>
Chris@1 712 </div>
Chris@1 713 <a class="anchor" id="a859ad5d59402691daed3cf1af1899ebe"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPreferredStepSize" ref="a859ad5d59402691daed3cf1af1899ebe" args="() const " -->
Chris@1 714 <div class="memitem">
Chris@1 715 <div class="memproto">
Chris@1 716 <table class="memname">
Chris@1 717 <tr>
Chris@1 718 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredStepSize </td>
Chris@1 719 <td>(</td>
Chris@1 720 <td class="paramname"></td><td>)</td>
Chris@1 721 <td> const<code> [virtual]</code></td>
Chris@1 722 </tr>
Chris@1 723 </table>
Chris@1 724 </div>
Chris@1 725 <div class="memdoc">
Chris@1 726
Chris@1 727 <p>Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function) for the plugin. </p>
Chris@1 728 <p>This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p>
Chris@1 729 <p>A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p>
Chris@1 730
Chris@1 731 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
Chris@1 732
Chris@1 733 </div>
Chris@1 734 </div>
Chris@1 735 <a class="anchor" id="ad5e0ea8042bdec4dd18428991117e07a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPreferredBlockSize" ref="ad5e0ea8042bdec4dd18428991117e07a" args="() const " -->
Chris@1 736 <div class="memitem">
Chris@1 737 <div class="memproto">
Chris@1 738 <table class="memname">
Chris@1 739 <tr>
Chris@1 740 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredBlockSize </td>
Chris@1 741 <td>(</td>
Chris@1 742 <td class="paramname"></td><td>)</td>
Chris@1 743 <td> const<code> [virtual]</code></td>
Chris@1 744 </tr>
Chris@1 745 </table>
Chris@1 746 </div>
Chris@1 747 <div class="memdoc">
Chris@1 748
Chris@1 749 <p>Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function). </p>
Chris@1 750 <p>This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p>
Chris@1 751 <p>A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p>
Chris@1 752
Chris@1 753 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
Chris@1 754
Chris@1 755 </div>
Chris@1 756 </div>
Chris@1 757 <a class="anchor" id="a67d1198c0e58d3f0076d0eda599ff28d"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMinChannelCount" ref="a67d1198c0e58d3f0076d0eda599ff28d" args="() const " -->
Chris@1 758 <div class="memitem">
Chris@1 759 <div class="memproto">
Chris@1 760 <table class="memname">
Chris@1 761 <tr>
Chris@1 762 <td class="memname">size_t Vamp::PluginHostAdapter::getMinChannelCount </td>
Chris@1 763 <td>(</td>
Chris@1 764 <td class="paramname"></td><td>)</td>
Chris@1 765 <td> const<code> [virtual]</code></td>
Chris@1 766 </tr>
Chris@1 767 </table>
Chris@1 768 </div>
Chris@1 769 <div class="memdoc">
Chris@1 770
Chris@1 771 <p>Get the minimum supported number of input channels. </p>
Chris@1 772
Chris@1 773 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
Chris@1 774
Chris@1 775 </div>
Chris@1 776 </div>
Chris@1 777 <a class="anchor" id="a25091905e97e39d515d8ffc1a9f2b9e0"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMaxChannelCount" ref="a25091905e97e39d515d8ffc1a9f2b9e0" args="() const " -->
Chris@1 778 <div class="memitem">
Chris@1 779 <div class="memproto">
Chris@1 780 <table class="memname">
Chris@1 781 <tr>
Chris@1 782 <td class="memname">size_t Vamp::PluginHostAdapter::getMaxChannelCount </td>
Chris@1 783 <td>(</td>
Chris@1 784 <td class="paramname"></td><td>)</td>
Chris@1 785 <td> const<code> [virtual]</code></td>
Chris@1 786 </tr>
Chris@1 787 </table>
Chris@1 788 </div>
Chris@1 789 <div class="memdoc">
Chris@1 790
Chris@1 791 <p>Get the maximum supported number of input channels. </p>
Chris@1 792
Chris@1 793 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
Chris@1 794
Chris@1 795 </div>
Chris@1 796 </div>
Chris@1 797 <a class="anchor" id="a9649a113da0252fe8bd9fc731b047ae0"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getOutputDescriptors" ref="a9649a113da0252fe8bd9fc731b047ae0" args="() const " -->
Chris@1 798 <div class="memitem">
Chris@1 799 <div class="memproto">
Chris@1 800 <table class="memname">
Chris@1 801 <tr>
Chris@1 802 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::PluginHostAdapter::getOutputDescriptors </td>
Chris@1 803 <td>(</td>
Chris@1 804 <td class="paramname"></td><td>)</td>
Chris@1 805 <td> const<code> [virtual]</code></td>
Chris@1 806 </tr>
Chris@1 807 </table>
Chris@1 808 </div>
Chris@1 809 <div class="memdoc">
Chris@1 810
Chris@1 811 <p>Get the outputs of this plugin. </p>
Chris@1 812 <p>An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> call. </p>
Chris@1 813
Chris@1 814 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 815
Chris@1 816 </div>
Chris@1 817 </div>
Chris@1 818 <a class="anchor" id="a38fe1080b343ba10e5d8a4b30c87cbdd"></a><!-- doxytag: member="Vamp::PluginHostAdapter::process" ref="a38fe1080b343ba10e5d8a4b30c87cbdd" args="(const float *const *inputBuffers, RealTime timestamp)" -->
Chris@1 819 <div class="memitem">
Chris@1 820 <div class="memproto">
Chris@1 821 <table class="memname">
Chris@1 822 <tr>
Chris@1 823 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::PluginHostAdapter::process </td>
Chris@1 824 <td>(</td>
Chris@1 825 <td class="paramtype">const float *const *&#160;</td>
Chris@1 826 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 827 </tr>
Chris@1 828 <tr>
Chris@1 829 <td class="paramkey"></td>
Chris@1 830 <td></td>
Chris@1 831 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td>
Chris@1 832 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 833 </tr>
Chris@1 834 <tr>
Chris@1 835 <td></td>
Chris@1 836 <td>)</td>
Chris@1 837 <td></td><td><code> [virtual]</code></td>
Chris@1 838 </tr>
Chris@1 839 </table>
Chris@1 840 </div>
Chris@1 841 <div class="memdoc">
Chris@1 842
Chris@1 843 <p>Process a single block of input data. </p>
Chris@1 844 <p>If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.</p>
Chris@1 845 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
Chris@1 846 <p>Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) </p>
Chris@1 847
Chris@1 848 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 849
Chris@1 850 </div>
Chris@1 851 </div>
Chris@1 852 <a class="anchor" id="a984a4c11f3fbdcfd90e4837b1619a5ab"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getRemainingFeatures" ref="a984a4c11f3fbdcfd90e4837b1619a5ab" args="()" -->
Chris@1 853 <div class="memitem">
Chris@1 854 <div class="memproto">
Chris@1 855 <table class="memname">
Chris@1 856 <tr>
Chris@1 857 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::PluginHostAdapter::getRemainingFeatures </td>
Chris@1 858 <td>(</td>
Chris@1 859 <td class="paramname"></td><td>)</td>
Chris@1 860 <td><code> [virtual]</code></td>
Chris@1 861 </tr>
Chris@1 862 </table>
Chris@1 863 </div>
Chris@1 864 <div class="memdoc">
Chris@1 865
Chris@1 866 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 867
Chris@1 868 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 869
Chris@1 870 </div>
Chris@1 871 </div>
Chris@1 872 <a class="anchor" id="aee417a4c9ba9dbb63777c963d5f9452a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::convertFeatures" ref="aee417a4c9ba9dbb63777c963d5f9452a" args="(VampFeatureList *, FeatureSet &amp;)" -->
Chris@1 873 <div class="memitem">
Chris@1 874 <div class="memproto">
Chris@1 875 <table class="memname">
Chris@1 876 <tr>
Chris@1 877 <td class="memname">void Vamp::PluginHostAdapter::convertFeatures </td>
Chris@1 878 <td>(</td>
Chris@1 879 <td class="paramtype"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *&#160;</td>
Chris@1 880 <td class="paramname">, </td>
Chris@1 881 </tr>
Chris@1 882 <tr>
Chris@1 883 <td class="paramkey"></td>
Chris@1 884 <td></td>
Chris@1 885 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;&#160;</td>
Chris@1 886 <td class="paramname">&#160;</td>
Chris@1 887 </tr>
Chris@1 888 <tr>
Chris@1 889 <td></td>
Chris@1 890 <td>)</td>
Chris@1 891 <td></td><td><code> [protected]</code></td>
Chris@1 892 </tr>
Chris@1 893 </table>
Chris@1 894 </div>
Chris@1 895 <div class="memdoc">
Chris@1 896
Chris@1 897 </div>
Chris@1 898 </div>
Chris@1 899 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
Chris@1 900 <div class="memitem">
Chris@1 901 <div class="memproto">
Chris@1 902 <table class="memname">
Chris@1 903 <tr>
Chris@1 904 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
Chris@1 905 <td>(</td>
Chris@1 906 <td class="paramname"></td><td>)</td>
Chris@1 907 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 908 </tr>
Chris@1 909 </table>
Chris@1 910 </div>
Chris@1 911 <div class="memdoc">
Chris@1 912
Chris@1 913 <p>Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. </p>
Chris@1 914 <p>Do not reimplement this function in your subclass. </p>
Chris@1 915
Chris@1 916 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 917
Chris@1 918 <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>
Chris@1 919
Chris@1 920 </div>
Chris@1 921 </div>
Chris@1 922 <hr/><h2>Member Data Documentation</h2>
Chris@1 923 <a class="anchor" id="a0c9f252aca8ac298e30cadd0de032ec2"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_descriptor" ref="a0c9f252aca8ac298e30cadd0de032ec2" args="" -->
Chris@1 924 <div class="memitem">
Chris@1 925 <div class="memproto">
Chris@1 926 <table class="memname">
Chris@1 927 <tr>
Chris@1 928 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="classVamp_1_1PluginHostAdapter.html#a0c9f252aca8ac298e30cadd0de032ec2">Vamp::PluginHostAdapter::m_descriptor</a><code> [protected]</code></td>
Chris@1 929 </tr>
Chris@1 930 </table>
Chris@1 931 </div>
Chris@1 932 <div class="memdoc">
Chris@1 933
Chris@1 934 <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>
Chris@1 935
Chris@1 936 </div>
Chris@1 937 </div>
Chris@1 938 <a class="anchor" id="a02ebd03b226b4a467cad747ce77e79ee"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_handle" ref="a02ebd03b226b4a467cad747ce77e79ee" args="" -->
Chris@1 939 <div class="memitem">
Chris@1 940 <div class="memproto">
Chris@1 941 <table class="memname">
Chris@1 942 <tr>
Chris@1 943 <td class="memname"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a02ebd03b226b4a467cad747ce77e79ee">Vamp::PluginHostAdapter::m_handle</a><code> [protected]</code></td>
Chris@1 944 </tr>
Chris@1 945 </table>
Chris@1 946 </div>
Chris@1 947 <div class="memdoc">
Chris@1 948
Chris@1 949 <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>
Chris@1 950
Chris@1 951 </div>
Chris@1 952 </div>
Chris@1 953 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
Chris@1 954 <div class="memitem">
Chris@1 955 <div class="memproto">
Chris@1 956 <table class="memname">
Chris@1 957 <tr>
Chris@1 958 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
Chris@1 959 </tr>
Chris@1 960 </table>
Chris@1 961 </div>
Chris@1 962 <div class="memdoc">
Chris@1 963
Chris@1 964 <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>
Chris@1 965
Chris@1 966 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p>
Chris@1 967
Chris@1 968 </div>
Chris@1 969 </div>
Chris@1 970 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@1 971 <li><a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a></li>
Chris@1 972 </ul>
Chris@1 973 </div>
Chris@1 974 </div>
Chris@1 975 <div id="nav-path" class="navpath">
Chris@1 976 <ul>
Chris@1 977 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
Chris@1 978 <li class="navelem"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a> </li>
Chris@1 979
Chris@1 980 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
Chris@1 981 <a href="http://www.doxygen.org/index.html">
Chris@1 982 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 983 </ul>
Chris@1 984 </div>
Chris@1 985
Chris@1 986
Chris@1 987 </body>
Chris@1 988 </html>