Mercurial > hg > vamp-docs

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

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