annotate code-doc/classVamp_1_1PluginHostAdapter.html @ 128:817c3988afc7 website tip

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