Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1HostExt_1_1PluginWrapper.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
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@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@1 6 <title>VampPluginSDK: Vamp::HostExt::PluginWrapper Class Reference</title>
Chris@1 7
Chris@1 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 11 <script type="text/javascript" src="jquery.js"></script>
Chris@1 12 <script type="text/javascript" src="resize.js"></script>
Chris@1 13 <script type="text/javascript" src="navtree.js"></script>
Chris@1 14 <script type="text/javascript">
Chris@1 15 $(document).ready(initResizable);
Chris@1 16 </script>
Chris@1 17
Chris@1 18
Chris@1 19 </head>
Chris@1 20 <body>
Chris@1 21 <div id="top"><!-- do not remove this div! -->
Chris@1 22
Chris@1 23
Chris@1 24 <div id="titlearea">
Chris@1 25 <table cellspacing="0" cellpadding="0">
Chris@1 26 <tbody>
Chris@1 27 <tr style="height: 56px;">
Chris@1 28
Chris@1 29
Chris@1 30 <td style="padding-left: 0.5em;">
Chris@1 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@1 33 </div>
Chris@1 34
Chris@1 35 </td>
Chris@1 36
Chris@1 37
Chris@1 38
Chris@1 39 </tr>
Chris@1 40 </tbody>
Chris@1 41 </table>
Chris@1 42 </div>
Chris@1 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@1 45 <div id="navrow1" class="tabs">
Chris@1 46 <ul class="tablist">
Chris@1 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 52 </ul>
Chris@1 53 </div>
Chris@1 54 <div id="navrow2" class="tabs2">
Chris@1 55 <ul class="tablist">
Chris@1 56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 59 </ul>
Chris@1 60 </div>
Chris@1 61 </div>
Chris@1 62 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 63 <div id="nav-tree">
Chris@1 64 <div id="nav-tree-contents">
Chris@1 65 </div>
Chris@1 66 </div>
Chris@1 67 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 68 class="ui-resizable-handle">
Chris@1 69 </div>
Chris@1 70 </div>
Chris@1 71 <script type="text/javascript">
Chris@1 72 initNavTree('classVamp_1_1HostExt_1_1PluginWrapper.html','');
Chris@1 73 </script>
Chris@1 74 <div id="doc-content">
Chris@1 75 <div class="header">
Chris@1 76 <div class="summary">
Chris@1 77 <a href="#pub-types">Public Types</a> &#124;
Chris@1 78 <a href="#pub-methods">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::HostExt::PluginWrapper Class Reference</div> </div>
Chris@3 83 </div><!--header-->
Chris@1 84 <div class="contents">
Chris@3 85
Chris@1 86 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins.
Chris@1 87 <a href="classVamp_1_1HostExt_1_1PluginWrapper.html#details">More...</a></p>
Chris@1 88
Chris@1 89 <p><code>#include &lt;<a class="el" href="PluginWrapper_8h_source.html">vamp-hostsdk/PluginWrapper.h</a>&gt;</code></p>
Chris@1 90 <div class="dynheader">
Chris@1 91 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div>
Chris@1 92 <div class="dyncontent">
Chris@1 93 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper_inherit__map" alt="Inheritance graph"/></div>
Chris@1 94 <map name="Vamp_1_1HostExt_1_1PluginWrapper_inherit__map" id="Vamp_1_1HostExt_1_1PluginWrapper_inherit__map">
Chris@1 95 <area shape="rect" id="node7" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="558,5,789,30"/><area shape="rect" id="node9" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="560,54,787,79"/><area shape="rect" id="node11" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time&#45;domain input into frequency&#45;doma..." alt="" coords="547,103,800,129"/><area shape="rect" id="node13" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="547,153,800,178"/><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="174,79,266,105"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="6,79,125,105"/></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_1HostExt_1_1PluginWrapper-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@3 102 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><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@3 105 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><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@3 107 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><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@3 108 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><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@3 110 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><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@3 112 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><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@3 115 <tr class="memitem:ac4fb6cfd7c0d3b2c8576a4e9dc61f518"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac4fb6cfd7c0d3b2c8576a4e9dc61f518">~PluginWrapper</a> ()</td></tr>
Chris@3 116 <tr class="memitem:aa5a1f8290d8e9a315695584dcb3ad137"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
Chris@3 117 <tr class="memdesc:aa5a1f8290d8e9a315695584dcb3ad137"><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="#aa5a1f8290d8e9a315695584dcb3ad137"></a><br/></td></tr>
Chris@3 118 <tr class="memitem:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
Chris@3 119 <tr class="memdesc:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#ad19cc0614ba41cdc26ef3394c5146fe6"></a><br/></td></tr>
Chris@3 120 <tr class="memitem:ae203faf8384c9e1fddc381409aa8a214"><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_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr>
Chris@3 121 <tr class="memdesc:ae203faf8384c9e1fddc381409aa8a214"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae203faf8384c9e1fddc381409aa8a214"></a><br/></td></tr>
Chris@3 122 <tr class="memitem:a74147fda6b44ff2169bd4a1eea0d46ff"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
Chris@3 123 <tr class="memdesc:a74147fda6b44ff2169bd4a1eea0d46ff"><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="#a74147fda6b44ff2169bd4a1eea0d46ff"></a><br/></td></tr>
Chris@3 124 <tr class="memitem:a4baa9e48f717c2b3e7f92496aa39d904"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
Chris@3 125 <tr class="memdesc:a4baa9e48f717c2b3e7f92496aa39d904"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a4baa9e48f717c2b3e7f92496aa39d904"></a><br/></td></tr>
Chris@3 126 <tr class="memitem:ac70a3265bb25aeb03f6dd8f8a0442088"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
Chris@3 127 <tr class="memdesc:ac70a3265bb25aeb03f6dd8f8a0442088"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#ac70a3265bb25aeb03f6dd8f8a0442088"></a><br/></td></tr>
Chris@3 128 <tr class="memitem:ac334f699c0996055942785410d8a065c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
Chris@3 129 <tr class="memdesc:ac334f699c0996055942785410d8a065c"><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="#ac334f699c0996055942785410d8a065c"></a><br/></td></tr>
Chris@3 130 <tr class="memitem:a59d5a2298951b317995675e664b1c7bb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
Chris@3 131 <tr class="memdesc:a59d5a2298951b317995675e664b1c7bb"><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="#a59d5a2298951b317995675e664b1c7bb"></a><br/></td></tr>
Chris@3 132 <tr class="memitem:a47e1acf1696813008324a915c9ba59c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
Chris@3 133 <tr class="memdesc:a47e1acf1696813008324a915c9ba59c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a47e1acf1696813008324a915c9ba59c5"></a><br/></td></tr>
Chris@3 134 <tr class="memitem:ae14f6ecb78be909c4cd5f0cdaed3c566"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
Chris@3 135 <tr class="memdesc:ae14f6ecb78be909c4cd5f0cdaed3c566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ae14f6ecb78be909c4cd5f0cdaed3c566"></a><br/></td></tr>
Chris@3 136 <tr class="memitem:a9be71561265c2e6e43b7feaddaa91f36"><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_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr>
Chris@3 137 <tr class="memdesc:a9be71561265c2e6e43b7feaddaa91f36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9be71561265c2e6e43b7feaddaa91f36"></a><br/></td></tr>
Chris@3 138 <tr class="memitem:a034920f56c8d7609a85447c42556048c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
Chris@3 139 <tr class="memdesc:a034920f56c8d7609a85447c42556048c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a034920f56c8d7609a85447c42556048c"></a><br/></td></tr>
Chris@3 140 <tr class="memitem:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
Chris@3 141 <tr class="memdesc:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5"></a><br/></td></tr>
Chris@3 142 <tr class="memitem:a131fbe1df81215020b9aa8cecef4c802"><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_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr>
Chris@3 143 <tr class="memdesc:a131fbe1df81215020b9aa8cecef4c802"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#a131fbe1df81215020b9aa8cecef4c802"></a><br/></td></tr>
Chris@3 144 <tr class="memitem:a7a312dd42d161064b70afd7ff24c0651"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
Chris@3 145 <tr class="memdesc:a7a312dd42d161064b70afd7ff24c0651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr>
Chris@3 146 <tr class="memitem:a074978333a74fdcf336a8a1d8ea20abf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
Chris@3 147 <tr class="memdesc:a074978333a74fdcf336a8a1d8ea20abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf"></a><br/></td></tr>
Chris@3 148 <tr class="memitem:a0137d93d7019bacc31104836fb4d352e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr>
Chris@3 149 <tr class="memdesc:a0137d93d7019bacc31104836fb4d352e"><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_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a0137d93d7019bacc31104836fb4d352e"></a><br/></td></tr>
Chris@3 150 <tr class="memitem:a2c62a656313a819650656643a867ad01"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr>
Chris@3 151 <tr class="memdesc:a2c62a656313a819650656643a867ad01"><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_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). <a href="#a2c62a656313a819650656643a867ad01"></a><br/></td></tr>
Chris@3 152 <tr class="memitem:a2b28f1cf37d46a514f1e1411a6037bf8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
Chris@3 153 <tr class="memdesc:a2b28f1cf37d46a514f1e1411a6037bf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a2b28f1cf37d46a514f1e1411a6037bf8"></a><br/></td></tr>
Chris@3 154 <tr class="memitem:a985eb21f1827bfbc3950d6871b107a58"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
Chris@3 155 <tr class="memdesc:a985eb21f1827bfbc3950d6871b107a58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a985eb21f1827bfbc3950d6871b107a58"></a><br/></td></tr>
Chris@3 156 <tr class="memitem:a5a9411305f713b4c9827844b89acd270"><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_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr>
Chris@3 157 <tr class="memdesc:a5a9411305f713b4c9827844b89acd270"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a5a9411305f713b4c9827844b89acd270"></a><br/></td></tr>
Chris@3 158 <tr class="memitem:a6bd72d6dfb3047524dbe8ae3294527cf"><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_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
Chris@3 159 <tr class="memdesc:a6bd72d6dfb3047524dbe8ae3294527cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a6bd72d6dfb3047524dbe8ae3294527cf"></a><br/></td></tr>
Chris@3 160 <tr class="memitem:a2bc8c0992e64f06991fb7cf89f99857e"><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_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr>
Chris@3 161 <tr class="memdesc:a2bc8c0992e64f06991fb7cf89f99857e"><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="#a2bc8c0992e64f06991fb7cf89f99857e"></a><br/></td></tr>
Chris@3 162 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr>
Chris@3 163 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplItemLeft" align="right" valign="top">WrapperType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">getWrapper</a> ()</td></tr>
Chris@3 164 <tr class="memdesc:a653d0308e8e34881a8749b7631d00f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#a653d0308e8e34881a8749b7631d00f05"></a><br/></td></tr>
Chris@3 165 <tr class="memitem:abe13b3997a69fbcc09e2213faa352f91"><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@3 166 <tr class="memdesc:abe13b3997a69fbcc09e2213faa352f91"><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 167 <tr><td colspan="2"><h2><a name="pro-methods"></a>
Chris@1 168 Protected Member Functions</h2></td></tr>
Chris@3 169 <tr class="memitem:a35cc2d42f8322f5022e89859a79c97be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
Chris@1 170 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
Chris@1 171 Protected Attributes</h2></td></tr>
Chris@3 172 <tr class="memitem:ab4e40ecd98b445e1a2aa9e7baa280ea2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
Chris@3 173 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><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 174 </table>
Chris@1 175 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 176 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins. </p>
Chris@1 177 <p>It takes a pointer to a "to be wrapped" <a class="el" href="namespaceVamp.html">Vamp</a> plugin on construction, and provides implementations of all the <a class="el" href="namespaceVamp.html">Vamp</a> plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.</p>
Chris@3 178 <dl class="section note"><dt>Note:</dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
Chris@1 179
Chris@1 180 <p>Definition at line <a class="el" href="PluginWrapper_8h_source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a>.</p>
Chris@1 181 </div><hr/><h2>Member Typedef Documentation</h2>
Chris@3 182 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
Chris@1 183 <div class="memitem">
Chris@1 184 <div class="memproto">
Chris@1 185 <table class="memname">
Chris@1 186 <tr>
Chris@1 187 <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 188 </tr>
Chris@1 189 </table>
Chris@1 190 </div>
Chris@1 191 <div class="memdoc">
Chris@1 192
Chris@1 193 <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 194
Chris@1 195 </div>
Chris@1 196 </div>
Chris@3 197 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
Chris@1 198 <div class="memitem">
Chris@1 199 <div class="memproto">
Chris@1 200 <table class="memname">
Chris@1 201 <tr>
Chris@1 202 <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 203 </tr>
Chris@1 204 </table>
Chris@1 205 </div>
Chris@1 206 <div class="memdoc">
Chris@1 207
Chris@1 208 <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 209
Chris@1 210 </div>
Chris@1 211 </div>
Chris@3 212 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
Chris@1 213 <div class="memitem">
Chris@1 214 <div class="memproto">
Chris@1 215 <table class="memname">
Chris@1 216 <tr>
Chris@1 217 <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 218 </tr>
Chris@1 219 </table>
Chris@1 220 </div>
Chris@1 221 <div class="memdoc">
Chris@1 222
Chris@1 223 <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 224
Chris@1 225 </div>
Chris@1 226 </div>
Chris@3 227 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
Chris@1 228 <div class="memitem">
Chris@1 229 <div class="memproto">
Chris@1 230 <table class="memname">
Chris@1 231 <tr>
Chris@1 232 <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 233 </tr>
Chris@1 234 </table>
Chris@1 235 </div>
Chris@1 236 <div class="memdoc">
Chris@1 237
Chris@3 238 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 239
Chris@1 240 </div>
Chris@1 241 </div>
Chris@3 242 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a>
Chris@1 243 <div class="memitem">
Chris@1 244 <div class="memproto">
Chris@1 245 <table class="memname">
Chris@1 246 <tr>
Chris@1 247 <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 248 </tr>
Chris@1 249 </table>
Chris@1 250 </div>
Chris@1 251 <div class="memdoc">
Chris@1 252
Chris@3 253 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00221">221</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 254
Chris@1 255 </div>
Chris@1 256 </div>
Chris@1 257 <hr/><h2>Member Enumeration Documentation</h2>
Chris@3 258 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
Chris@1 259 <div class="memitem">
Chris@1 260 <div class="memproto">
Chris@1 261 <table class="memname">
Chris@1 262 <tr>
Chris@1 263 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
Chris@1 264 </tr>
Chris@1 265 </table>
Chris@1 266 </div>
Chris@1 267 <div class="memdoc">
Chris@1 268 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
Chris@3 269 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td>
Chris@1 270 </td></tr>
Chris@3 271 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td>
Chris@1 272 </td></tr>
Chris@1 273 </table>
Chris@1 274 </dd>
Chris@1 275 </dl>
Chris@1 276
Chris@1 277 <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 278
Chris@1 279 </div>
Chris@1 280 </div>
Chris@1 281 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@3 282 <a class="anchor" id="ac4fb6cfd7c0d3b2c8576a4e9dc61f518"></a>
Chris@1 283 <div class="memitem">
Chris@1 284 <div class="memproto">
Chris@1 285 <table class="memname">
Chris@1 286 <tr>
Chris@3 287 <td class="memname">virtual <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac4fb6cfd7c0d3b2c8576a4e9dc61f518">Vamp::HostExt::PluginWrapper::~PluginWrapper</a> </td>
Chris@1 288 <td>(</td>
Chris@1 289 <td class="paramname"></td><td>)</td>
Chris@1 290 <td><code> [virtual]</code></td>
Chris@1 291 </tr>
Chris@1 292 </table>
Chris@1 293 </div>
Chris@1 294 <div class="memdoc">
Chris@1 295
Chris@1 296 </div>
Chris@1 297 </div>
Chris@3 298 <a class="anchor" id="a35cc2d42f8322f5022e89859a79c97be"></a>
Chris@1 299 <div class="memitem">
Chris@1 300 <div class="memproto">
Chris@1 301 <table class="memname">
Chris@1 302 <tr>
Chris@3 303 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a35cc2d42f8322f5022e89859a79c97be">Vamp::HostExt::PluginWrapper::PluginWrapper</a> </td>
Chris@1 304 <td>(</td>
Chris@1 305 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td>
Chris@1 306 <td class="paramname"><em>plugin</em></td><td>)</td>
Chris@1 307 <td><code> [protected]</code></td>
Chris@1 308 </tr>
Chris@1 309 </table>
Chris@1 310 </div>
Chris@1 311 <div class="memdoc">
Chris@1 312
Chris@1 313 </div>
Chris@1 314 </div>
Chris@1 315 <hr/><h2>Member Function Documentation</h2>
Chris@3 316 <a class="anchor" id="aa5a1f8290d8e9a315695584dcb3ad137"></a>
Chris@1 317 <div class="memitem">
Chris@1 318 <div class="memproto">
Chris@1 319 <table class="memname">
Chris@1 320 <tr>
Chris@3 321 <td class="memname">bool <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper::initialise</a> </td>
Chris@1 322 <td>(</td>
Chris@1 323 <td class="paramtype">size_t&#160;</td>
Chris@1 324 <td class="paramname"><em>inputChannels</em>, </td>
Chris@1 325 </tr>
Chris@1 326 <tr>
Chris@1 327 <td class="paramkey"></td>
Chris@1 328 <td></td>
Chris@1 329 <td class="paramtype">size_t&#160;</td>
Chris@1 330 <td class="paramname"><em>stepSize</em>, </td>
Chris@1 331 </tr>
Chris@1 332 <tr>
Chris@1 333 <td class="paramkey"></td>
Chris@1 334 <td></td>
Chris@1 335 <td class="paramtype">size_t&#160;</td>
Chris@1 336 <td class="paramname"><em>blockSize</em>&#160;</td>
Chris@1 337 </tr>
Chris@1 338 <tr>
Chris@1 339 <td></td>
Chris@1 340 <td>)</td>
Chris@1 341 <td></td><td><code> [virtual]</code></td>
Chris@1 342 </tr>
Chris@1 343 </table>
Chris@1 344 </div>
Chris@1 345 <div class="memdoc">
Chris@1 346
Chris@1 347 <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 348 <p>The input sample rate should have been already specified at construction time.</p>
Chris@1 349 <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 350
Chris@1 351 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
Chris@1 352
Chris@1 353 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#ade0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
Chris@1 354
Chris@1 355 </div>
Chris@1 356 </div>
Chris@3 357 <a class="anchor" id="ad19cc0614ba41cdc26ef3394c5146fe6"></a>
Chris@1 358 <div class="memitem">
Chris@1 359 <div class="memproto">
Chris@1 360 <table class="memname">
Chris@1 361 <tr>
Chris@3 362 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper::reset</a> </td>
Chris@1 363 <td>(</td>
Chris@1 364 <td class="paramname"></td><td>)</td>
Chris@1 365 <td><code> [virtual]</code></td>
Chris@1 366 </tr>
Chris@1 367 </table>
Chris@1 368 </div>
Chris@1 369 <div class="memdoc">
Chris@1 370
Chris@1 371 <p>Reset the plugin after use, to prepare it for another clean run. </p>
Chris@1 372 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
Chris@1 373
Chris@1 374 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
Chris@1 375
Chris@1 376 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a984a12b5b4cb0be1e2f7a0aa84106c4c">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3402381d145d507bd26d1a67e3616911">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
Chris@1 377
Chris@1 378 </div>
Chris@1 379 </div>
Chris@3 380 <a class="anchor" id="ae203faf8384c9e1fddc381409aa8a214"></a>
Chris@1 381 <div class="memitem">
Chris@1 382 <div class="memproto">
Chris@1 383 <table class="memname">
Chris@1 384 <tr>
Chris@3 385 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">Vamp::HostExt::PluginWrapper::getInputDomain</a> </td>
Chris@1 386 <td>(</td>
Chris@1 387 <td class="paramname"></td><td>)</td>
Chris@1 388 <td> const<code> [virtual]</code></td>
Chris@1 389 </tr>
Chris@1 390 </table>
Chris@1 391 </div>
Chris@1 392 <div class="memdoc">
Chris@1 393
Chris@1 394 <p>Get the plugin's required input domain. </p>
Chris@1 395 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" 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@3 396 <p>If this is FrequencyDomain, the host will carry out a windowed <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The input data for the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> 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 397
Chris@1 398 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
Chris@1 399
Chris@1 400 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
Chris@1 401
Chris@1 402 </div>
Chris@1 403 </div>
Chris@3 404 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a>
Chris@1 405 <div class="memitem">
Chris@1 406 <div class="memproto">
Chris@1 407 <table class="memname">
Chris@1 408 <tr>
Chris@3 409 <td class="memname">unsigned int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper::getVampApiVersion</a> </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 <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
Chris@1 419
Chris@1 420 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
Chris@1 421
Chris@1 422 </div>
Chris@1 423 </div>
Chris@3 424 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a>
Chris@1 425 <div class="memitem">
Chris@1 426 <div class="memproto">
Chris@1 427 <table class="memname">
Chris@1 428 <tr>
Chris@3 429 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">Vamp::HostExt::PluginWrapper::getIdentifier</a> </td>
Chris@1 430 <td>(</td>
Chris@1 431 <td class="paramname"></td><td>)</td>
Chris@1 432 <td> const<code> [virtual]</code></td>
Chris@1 433 </tr>
Chris@1 434 </table>
Chris@1 435 </div>
Chris@1 436 <div class="memdoc">
Chris@1 437
Chris@1 438 <p>Get the computer-usable name of the plugin. </p>
Chris@1 439 <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 440 <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 441 <p>Example: "zero_crossings" </p>
Chris@1 442
Chris@1 443 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
Chris@1 444
Chris@1 445 </div>
Chris@1 446 </div>
Chris@3 447 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a>
Chris@1 448 <div class="memitem">
Chris@1 449 <div class="memproto">
Chris@1 450 <table class="memname">
Chris@1 451 <tr>
Chris@3 452 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">Vamp::HostExt::PluginWrapper::getName</a> </td>
Chris@1 453 <td>(</td>
Chris@1 454 <td class="paramname"></td><td>)</td>
Chris@1 455 <td> const<code> [virtual]</code></td>
Chris@1 456 </tr>
Chris@1 457 </table>
Chris@1 458 </div>
Chris@1 459 <div class="memdoc">
Chris@1 460
Chris@1 461 <p>Get a human-readable name or title of the plugin. </p>
Chris@1 462 <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 463 <p>Example: "Zero Crossings" </p>
Chris@1 464
Chris@1 465 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
Chris@1 466
Chris@1 467 </div>
Chris@1 468 </div>
Chris@3 469 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a>
Chris@1 470 <div class="memitem">
Chris@1 471 <div class="memproto">
Chris@1 472 <table class="memname">
Chris@1 473 <tr>
Chris@3 474 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">Vamp::HostExt::PluginWrapper::getDescription</a> </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 description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
Chris@1 484 <p>May be empty if the name has said it all already.</p>
Chris@1 485 <p>Example: "Detect and count zero crossing points" </p>
Chris@1 486
Chris@1 487 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
Chris@1 488
Chris@1 489 </div>
Chris@1 490 </div>
Chris@3 491 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a>
Chris@1 492 <div class="memitem">
Chris@1 493 <div class="memproto">
Chris@1 494 <table class="memname">
Chris@1 495 <tr>
Chris@3 496 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">Vamp::HostExt::PluginWrapper::getMaker</a> </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 the name of the author or vendor of the plugin in human-readable form. </p>
Chris@1 506 <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 507
Chris@1 508 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
Chris@1 509
Chris@1 510 </div>
Chris@1 511 </div>
Chris@3 512 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a>
Chris@1 513 <div class="memitem">
Chris@1 514 <div class="memproto">
Chris@1 515 <table class="memname">
Chris@1 516 <tr>
Chris@3 517 <td class="memname">int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">Vamp::HostExt::PluginWrapper::getPluginVersion</a> </td>
Chris@1 518 <td>(</td>
Chris@1 519 <td class="paramname"></td><td>)</td>
Chris@1 520 <td> const<code> [virtual]</code></td>
Chris@1 521 </tr>
Chris@1 522 </table>
Chris@1 523 </div>
Chris@1 524 <div class="memdoc">
Chris@1 525
Chris@1 526 <p>Get the version number of the plugin. </p>
Chris@1 527
Chris@1 528 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
Chris@1 529
Chris@1 530 </div>
Chris@1 531 </div>
Chris@3 532 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a>
Chris@1 533 <div class="memitem">
Chris@1 534 <div class="memproto">
Chris@1 535 <table class="memname">
Chris@1 536 <tr>
Chris@3 537 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">Vamp::HostExt::PluginWrapper::getCopyright</a> </td>
Chris@1 538 <td>(</td>
Chris@1 539 <td class="paramname"></td><td>)</td>
Chris@1 540 <td> const<code> [virtual]</code></td>
Chris@1 541 </tr>
Chris@1 542 </table>
Chris@1 543 </div>
Chris@1 544 <div class="memdoc">
Chris@1 545
Chris@1 546 <p>Get the copyright statement or licensing summary for the plugin. </p>
Chris@1 547 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
Chris@1 548
Chris@1 549 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
Chris@1 550
Chris@1 551 </div>
Chris@1 552 </div>
Chris@3 553 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a>
Chris@1 554 <div class="memitem">
Chris@1 555 <div class="memproto">
Chris@1 556 <table class="memname">
Chris@1 557 <tr>
Chris@3 558 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper::getParameterDescriptors</a> </td>
Chris@1 559 <td>(</td>
Chris@1 560 <td class="paramname"></td><td>)</td>
Chris@1 561 <td> const<code> [virtual]</code></td>
Chris@1 562 </tr>
Chris@1 563 </table>
Chris@1 564 </div>
Chris@1 565 <div class="memdoc">
Chris@1 566
Chris@1 567 <p>Get the controllable parameters of this plugin. </p>
Chris@1 568
Chris@1 569 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
Chris@1 570
Chris@1 571 </div>
Chris@1 572 </div>
Chris@3 573 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a>
Chris@1 574 <div class="memitem">
Chris@1 575 <div class="memproto">
Chris@1 576 <table class="memname">
Chris@1 577 <tr>
Chris@3 578 <td class="memname">float <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper::getParameter</a> </td>
Chris@1 579 <td>(</td>
Chris@1 580 <td class="paramtype">std::string&#160;</td>
Chris@1 581 <td class="paramname"></td><td>)</td>
Chris@1 582 <td> const<code> [virtual]</code></td>
Chris@1 583 </tr>
Chris@1 584 </table>
Chris@1 585 </div>
Chris@1 586 <div class="memdoc">
Chris@1 587
Chris@1 588 <p>Get the value of a named parameter. </p>
Chris@1 589 <p>The argument is the identifier field from that parameter's descriptor. </p>
Chris@1 590
Chris@1 591 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
Chris@1 592
Chris@1 593 </div>
Chris@1 594 </div>
Chris@3 595 <a class="anchor" id="a651b15a5dc4c27942ac0c87c6092bfe5"></a>
Chris@1 596 <div class="memitem">
Chris@1 597 <div class="memproto">
Chris@1 598 <table class="memname">
Chris@1 599 <tr>
Chris@3 600 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper::setParameter</a> </td>
Chris@1 601 <td>(</td>
Chris@1 602 <td class="paramtype">std::string&#160;</td>
Chris@1 603 <td class="paramname">, </td>
Chris@1 604 </tr>
Chris@1 605 <tr>
Chris@1 606 <td class="paramkey"></td>
Chris@1 607 <td></td>
Chris@1 608 <td class="paramtype">float&#160;</td>
Chris@1 609 <td class="paramname">&#160;</td>
Chris@1 610 </tr>
Chris@1 611 <tr>
Chris@1 612 <td></td>
Chris@1 613 <td>)</td>
Chris@1 614 <td></td><td><code> [virtual]</code></td>
Chris@1 615 </tr>
Chris@1 616 </table>
Chris@1 617 </div>
Chris@1 618 <div class="memdoc">
Chris@1 619
Chris@1 620 <p>Set a named parameter. </p>
Chris@1 621 <p>The first argument is the identifier field from that parameter's descriptor. </p>
Chris@1 622
Chris@1 623 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
Chris@1 624
Chris@1 625 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
Chris@1 626
Chris@1 627 </div>
Chris@1 628 </div>
Chris@3 629 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a>
Chris@1 630 <div class="memitem">
Chris@1 631 <div class="memproto">
Chris@1 632 <table class="memname">
Chris@1 633 <tr>
Chris@3 634 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper::getPrograms</a> </td>
Chris@1 635 <td>(</td>
Chris@1 636 <td class="paramname"></td><td>)</td>
Chris@1 637 <td> const<code> [virtual]</code></td>
Chris@1 638 </tr>
Chris@1 639 </table>
Chris@1 640 </div>
Chris@1 641 <div class="memdoc">
Chris@1 642
Chris@1 643 <p>Get the program settings available in this plugin. </p>
Chris@1 644 <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 645 <p>The programs must have unique names. </p>
Chris@1 646
Chris@1 647 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
Chris@1 648
Chris@1 649 </div>
Chris@1 650 </div>
Chris@3 651 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a>
Chris@1 652 <div class="memitem">
Chris@1 653 <div class="memproto">
Chris@1 654 <table class="memname">
Chris@1 655 <tr>
Chris@3 656 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper::getCurrentProgram</a> </td>
Chris@1 657 <td>(</td>
Chris@1 658 <td class="paramname"></td><td>)</td>
Chris@1 659 <td> const<code> [virtual]</code></td>
Chris@1 660 </tr>
Chris@1 661 </table>
Chris@1 662 </div>
Chris@1 663 <div class="memdoc">
Chris@1 664
Chris@1 665 <p>Get the current program. </p>
Chris@1 666
Chris@1 667 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
Chris@1 668
Chris@1 669 </div>
Chris@1 670 </div>
Chris@3 671 <a class="anchor" id="a074978333a74fdcf336a8a1d8ea20abf"></a>
Chris@1 672 <div class="memitem">
Chris@1 673 <div class="memproto">
Chris@1 674 <table class="memname">
Chris@1 675 <tr>
Chris@3 676 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper::selectProgram</a> </td>
Chris@1 677 <td>(</td>
Chris@1 678 <td class="paramtype">std::string&#160;</td>
Chris@1 679 <td class="paramname"></td><td>)</td>
Chris@1 680 <td><code> [virtual]</code></td>
Chris@1 681 </tr>
Chris@1 682 </table>
Chris@1 683 </div>
Chris@1 684 <div class="memdoc">
Chris@1 685
Chris@1 686 <p>Select a program. </p>
Chris@1 687 <p>(If the given program name is not one of the available programs, do nothing.) </p>
Chris@1 688
Chris@1 689 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
Chris@1 690
Chris@1 691 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
Chris@1 692
Chris@1 693 </div>
Chris@1 694 </div>
Chris@3 695 <a class="anchor" id="a0137d93d7019bacc31104836fb4d352e"></a>
Chris@1 696 <div class="memitem">
Chris@1 697 <div class="memproto">
Chris@1 698 <table class="memname">
Chris@1 699 <tr>
Chris@3 700 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper::getPreferredStepSize</a> </td>
Chris@1 701 <td>(</td>
Chris@1 702 <td class="paramname"></td><td>)</td>
Chris@1 703 <td> const<code> [virtual]</code></td>
Chris@1 704 </tr>
Chris@1 705 </table>
Chris@1 706 </div>
Chris@1 707 <div class="memdoc">
Chris@1 708
Chris@1 709 <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_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. </p>
Chris@1 710 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" 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 711 <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_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" 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 712
Chris@1 713 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
Chris@1 714
Chris@1 715 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
Chris@1 716
Chris@1 717 </div>
Chris@1 718 </div>
Chris@3 719 <a class="anchor" id="a2c62a656313a819650656643a867ad01"></a>
Chris@1 720 <div class="memitem">
Chris@1 721 <div class="memproto">
Chris@1 722 <table class="memname">
Chris@1 723 <tr>
Chris@3 724 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper::getPreferredBlockSize</a> </td>
Chris@1 725 <td>(</td>
Chris@1 726 <td class="paramname"></td><td>)</td>
Chris@1 727 <td> const<code> [virtual]</code></td>
Chris@1 728 </tr>
Chris@1 729 </table>
Chris@1 730 </div>
Chris@1 731 <div class="memdoc">
Chris@1 732
Chris@1 733 <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_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). </p>
Chris@1 734 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" 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 735 <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_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" 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 736
Chris@1 737 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
Chris@1 738
Chris@1 739 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
Chris@1 740
Chris@1 741 </div>
Chris@1 742 </div>
Chris@3 743 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a>
Chris@1 744 <div class="memitem">
Chris@1 745 <div class="memproto">
Chris@1 746 <table class="memname">
Chris@1 747 <tr>
Chris@3 748 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper::getMinChannelCount</a> </td>
Chris@1 749 <td>(</td>
Chris@1 750 <td class="paramname"></td><td>)</td>
Chris@1 751 <td> const<code> [virtual]</code></td>
Chris@1 752 </tr>
Chris@1 753 </table>
Chris@1 754 </div>
Chris@1 755 <div class="memdoc">
Chris@1 756
Chris@1 757 <p>Get the minimum supported number of input channels. </p>
Chris@1 758
Chris@1 759 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
Chris@1 760
Chris@1 761 </div>
Chris@1 762 </div>
Chris@3 763 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a>
Chris@1 764 <div class="memitem">
Chris@1 765 <div class="memproto">
Chris@1 766 <table class="memname">
Chris@1 767 <tr>
Chris@3 768 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper::getMaxChannelCount</a> </td>
Chris@1 769 <td>(</td>
Chris@1 770 <td class="paramname"></td><td>)</td>
Chris@1 771 <td> const<code> [virtual]</code></td>
Chris@1 772 </tr>
Chris@1 773 </table>
Chris@1 774 </div>
Chris@1 775 <div class="memdoc">
Chris@1 776
Chris@1 777 <p>Get the maximum supported number of input channels. </p>
Chris@1 778
Chris@1 779 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
Chris@1 780
Chris@1 781 </div>
Chris@1 782 </div>
Chris@3 783 <a class="anchor" id="a5a9411305f713b4c9827844b89acd270"></a>
Chris@1 784 <div class="memitem">
Chris@1 785 <div class="memproto">
Chris@1 786 <table class="memname">
Chris@1 787 <tr>
Chris@3 788 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270">Vamp::HostExt::PluginWrapper::getOutputDescriptors</a> </td>
Chris@1 789 <td>(</td>
Chris@1 790 <td class="paramname"></td><td>)</td>
Chris@1 791 <td> const<code> [virtual]</code></td>
Chris@1 792 </tr>
Chris@1 793 </table>
Chris@1 794 </div>
Chris@1 795 <div class="memdoc">
Chris@1 796
Chris@1 797 <p>Get the outputs of this plugin. </p>
Chris@1 798 <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_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> call. </p>
Chris@1 799
Chris@1 800 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
Chris@1 801
Chris@1 802 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
Chris@1 803
Chris@1 804 </div>
Chris@1 805 </div>
Chris@3 806 <a class="anchor" id="a6bd72d6dfb3047524dbe8ae3294527cf"></a>
Chris@1 807 <div class="memitem">
Chris@1 808 <div class="memproto">
Chris@1 809 <table class="memname">
Chris@1 810 <tr>
Chris@3 811 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper::process</a> </td>
Chris@1 812 <td>(</td>
Chris@1 813 <td class="paramtype">const float *const *&#160;</td>
Chris@1 814 <td class="paramname"><em>inputBuffers</em>, </td>
Chris@1 815 </tr>
Chris@1 816 <tr>
Chris@1 817 <td class="paramkey"></td>
Chris@1 818 <td></td>
Chris@1 819 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td>
Chris@1 820 <td class="paramname"><em>timestamp</em>&#160;</td>
Chris@1 821 </tr>
Chris@1 822 <tr>
Chris@1 823 <td></td>
Chris@1 824 <td>)</td>
Chris@1 825 <td></td><td><code> [virtual]</code></td>
Chris@1 826 </tr>
Chris@1 827 </table>
Chris@1 828 </div>
Chris@1 829 <div class="memdoc">
Chris@1 830
Chris@1 831 <p>Process a single block of input data. </p>
Chris@1 832 <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@3 833 <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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> 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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> input window (i.e. the very first block passed to process might contain the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
Chris@1 834 <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 835
Chris@1 836 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
Chris@1 837
Chris@1 838 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#a6ff37bf754ff8711dbcb2f020fa3902c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
Chris@1 839
Chris@1 840 </div>
Chris@1 841 </div>
Chris@3 842 <a class="anchor" id="a2bc8c0992e64f06991fb7cf89f99857e"></a>
Chris@1 843 <div class="memitem">
Chris@1 844 <div class="memproto">
Chris@1 845 <table class="memname">
Chris@1 846 <tr>
Chris@3 847 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper::getRemainingFeatures</a> </td>
Chris@1 848 <td>(</td>
Chris@1 849 <td class="paramname"></td><td>)</td>
Chris@1 850 <td><code> [virtual]</code></td>
Chris@1 851 </tr>
Chris@1 852 </table>
Chris@1 853 </div>
Chris@1 854 <div class="memdoc">
Chris@1 855
Chris@1 856 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
Chris@1 857
Chris@1 858 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
Chris@1 859
Chris@1 860 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
Chris@1 861
Chris@1 862 </div>
Chris@1 863 </div>
Chris@3 864 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a>
Chris@1 865 <div class="memitem">
Chris@1 866 <div class="memproto">
Chris@1 867 <div class="memtemplate">
Chris@1 868 template&lt;typename WrapperType &gt; </div>
Chris@1 869 <table class="memname">
Chris@1 870 <tr>
Chris@3 871 <td class="memname">WrapperType* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">Vamp::HostExt::PluginWrapper::getWrapper</a> </td>
Chris@1 872 <td>(</td>
Chris@1 873 <td class="paramname"></td><td>)</td>
Chris@1 874 <td><code> [inline]</code></td>
Chris@1 875 </tr>
Chris@1 876 </table>
Chris@1 877 </div>
Chris@1 878 <div class="memdoc">
Chris@1 879
Chris@1 880 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
Chris@1 881 <p>This is useful in situations where a plugin is wrapped by multiple different wrappers (one inside another) and the host wants to call some wrapper-specific function on one of the layers without having to care about the order in which they are wrapped. For example, the plugin returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#a964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">PluginLoader::loadPlugin</a> may have more than one wrapper; if the host wanted to query or fine-tune some property of one of them, it would be hard to do so without knowing the order of the wrappers. This function therefore gives direct access to the wrapper of a particular type. </p>
Chris@1 882
Chris@1 883 <p>Definition at line <a class="el" href="PluginWrapper_8h_source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a>.</p>
Chris@1 884
Chris@1 885 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">getWrapper()</a>.</p>
Chris@1 886
Chris@1 887 <p>Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
Chris@1 888
Chris@1 889 </div>
Chris@1 890 </div>
Chris@3 891 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a>
Chris@1 892 <div class="memitem">
Chris@1 893 <div class="memproto">
Chris@1 894 <table class="memname">
Chris@1 895 <tr>
Chris@3 896 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td>
Chris@1 897 <td>(</td>
Chris@1 898 <td class="paramname"></td><td>)</td>
Chris@1 899 <td> const<code> [inline, virtual, inherited]</code></td>
Chris@1 900 </tr>
Chris@1 901 </table>
Chris@1 902 </div>
Chris@1 903 <div class="memdoc">
Chris@1 904
Chris@1 905 <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 906 <p>Do not reimplement this function in your subclass. </p>
Chris@1 907
Chris@1 908 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
Chris@1 909
Chris@1 910 <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 911
Chris@1 912 </div>
Chris@1 913 </div>
Chris@1 914 <hr/><h2>Member Data Documentation</h2>
Chris@3 915 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a>
Chris@1 916 <div class="memitem">
Chris@1 917 <div class="memproto">
Chris@1 918 <table class="memname">
Chris@1 919 <tr>
Chris@1 920 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected]</code></td>
Chris@1 921 </tr>
Chris@1 922 </table>
Chris@1 923 </div>
Chris@1 924 <div class="memdoc">
Chris@1 925
Chris@1 926 <p>Definition at line <a class="el" href="PluginWrapper_8h_source.html#l00126">126</a> of file <a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a>.</p>
Chris@1 927
Chris@1 928 </div>
Chris@1 929 </div>
Chris@3 930 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
Chris@1 931 <div class="memitem">
Chris@1 932 <div class="memproto">
Chris@1 933 <table class="memname">
Chris@1 934 <tr>
Chris@1 935 <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 936 </tr>
Chris@1 937 </table>
Chris@1 938 </div>
Chris@1 939 <div class="memdoc">
Chris@1 940
Chris@1 941 <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 942
Chris@1 943 <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="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::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 944
Chris@1 945 </div>
Chris@1 946 </div>
Chris@1 947 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@1 948 <li><a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a></li>
Chris@1 949 </ul>
Chris@3 950 </div><!-- contents -->
Chris@1 951 </div>
Chris@1 952 <div id="nav-path" class="navpath">
Chris@1 953 <ul>
Chris@1 954 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
Chris@1 955 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li>
Chris@1 956 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a> </li>
Chris@1 957
Chris@3 958 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
Chris@1 959 <a href="http://www.doxygen.org/index.html">
Chris@3 960 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 961 </ul>
Chris@1 962 </div>
Chris@1 963
Chris@1 964
Chris@1 965 </body>
Chris@1 966 </html>