Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1HostExt_1_1PluginWrapper.html @ 34:4b4db9230e94 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* wiki configuration and pages in svn
author cannam
date Wed, 23 Sep 2009 15:09:53 +0000
parents cc0be37dc9d3
children 0976232e353b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::HostExt::PluginWrapper Class Reference</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@21 7 <!-- Generated by Doxygen 1.5.6 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@21 29 <h1>Vamp::HostExt::PluginWrapper Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginWrapper" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="PluginWrapper_8h-source.html">vamp-hostsdk/PluginWrapper.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31 <div class="dynheader">
cannam@0 32 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div>
cannam@0 33 <div class="dynsection">
cannam@0 34 <p><center><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper__inherit__map" alt="Inheritance graph"></center>
cannam@0 35 <map name="Vamp_1_1HostExt_1_1PluginWrapper__inherit__map">
cannam@21 36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by..." alt="" coords="592,5,840,32"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management..." alt="" coords="593,56,839,82"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time&#45;domain input..." alt="" coords="580,106,852,133"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods..." alt="" coords="579,157,853,184"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="181,81,280,108"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,81,133,108"></map>
cannam@0 37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
cannam@0 38
cannam@0 39 <p>
cannam@0 40 <a href="classVamp_1_1HostExt_1_1PluginWrapper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 41 <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.
cannam@0 42 <p>
cannam@21 43 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>
cannam@21 44 <dl class="note" compact><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>
cannam@0 45
cannam@21 46 <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>
cannam@0 47 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 48 <tr><td></td></tr>
cannam@0 49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@0 50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
cannam@0 51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
cannam@0 52 }</td></tr>
cannam@0 53
cannam@0 54 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
cannam@0 55 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
cannam@0 56
cannam@0 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
cannam@0 58
cannam@0 59 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
cannam@0 60 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
cannam@0 61
cannam@0 62 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
cannam@0 63 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
cannam@0 64
cannam@0 65 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
cannam@0 66
cannam@0 67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@21 68 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c4fb6cfd7c0d3b2c8576a4e9dc61f518">~PluginWrapper</a> ()</td></tr>
cannam@0 69
cannam@0 70 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
cannam@0 71
cannam@0 72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#a5a1f8290d8e9a315695584dcb3ad137"></a><br></td></tr>
cannam@0 73 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
cannam@0 74
cannam@0 75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr>
cannam@21 76 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr>
cannam@0 77
cannam@21 78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#e203faf8384c9e1fddc381409aa8a214"></a><br></td></tr>
cannam@0 79 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
cannam@0 80
cannam@21 81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr>
cannam@0 82 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
cannam@0 83
cannam@0 84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
cannam@0 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
cannam@0 86
cannam@0 87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c70a3265bb25aeb03f6dd8f8a0442088"></a><br></td></tr>
cannam@0 88 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
cannam@0 89
cannam@0 90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#c334f699c0996055942785410d8a065c"></a><br></td></tr>
cannam@0 91 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
cannam@0 92
cannam@0 93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#59d5a2298951b317995675e664b1c7bb"></a><br></td></tr>
cannam@0 94 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
cannam@0 95
cannam@0 96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
cannam@0 97 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
cannam@0 98
cannam@0 99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr>
cannam@21 100 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr>
cannam@0 101
cannam@21 102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr>
cannam@0 103 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
cannam@0 104
cannam@0 105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
cannam@0 106 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
cannam@0 107
cannam@0 108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
cannam@21 109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr>
cannam@0 110
cannam@21 111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr>
cannam@0 112 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
cannam@0 113
cannam@0 114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
cannam@0 115 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
cannam@0 116
cannam@0 117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
cannam@0 118 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr>
cannam@0 119
cannam@21 120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr>
cannam@0 121 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr>
cannam@0 122
cannam@21 123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr>
cannam@0 124 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
cannam@0 125
cannam@0 126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
cannam@0 127 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
cannam@0 128
cannam@0 129 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
cannam@21 130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr>
cannam@0 131
cannam@21 132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
cannam@21 133 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
cannam@0 134
cannam@21 135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#6bd72d6dfb3047524dbe8ae3294527cf"></a><br></td></tr>
cannam@21 136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr>
cannam@0 137
cannam@21 138 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#2bc8c0992e64f06991fb7cf89f99857e"></a><br></td></tr>
cannam@21 139 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType&gt; </td></tr>
cannam@21 140 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">WrapperType *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">getWrapper</a> ()</td></tr>
cannam@21 141
cannam@21 142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#e9d79bed7237d55a73018a6b982a55b3"></a><br></td></tr>
cannam@0 143 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
cannam@0 144
cannam@0 145 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
cannam@0 146 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
cannam@0 147 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
cannam@0 148
cannam@0 149 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@0 150 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
cannam@0 151
cannam@0 152 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
cannam@0 153
cannam@0 154 </table>
cannam@0 155 <hr><h2>Member Typedef Documentation</h2>
cannam@0 156 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
cannam@0 157 <div class="memitem">
cannam@0 158 <div class="memproto">
cannam@0 159 <table class="memname">
cannam@0 160 <tr>
cannam@0 161 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
cannam@0 162 </tr>
cannam@0 163 </table>
cannam@0 164 </div>
cannam@0 165 <div class="memdoc">
cannam@0 166
cannam@0 167 <p>
cannam@0 168
cannam@21 169 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 170
cannam@0 171 </div>
cannam@0 172 </div><p>
cannam@0 173 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
cannam@0 174 <div class="memitem">
cannam@0 175 <div class="memproto">
cannam@0 176 <table class="memname">
cannam@0 177 <tr>
cannam@0 178 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
cannam@0 179 </tr>
cannam@0 180 </table>
cannam@0 181 </div>
cannam@0 182 <div class="memdoc">
cannam@0 183
cannam@0 184 <p>
cannam@0 185
cannam@21 186 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00380">380</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 187
cannam@0 188 </div>
cannam@0 189 </div><p>
cannam@0 190 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
cannam@0 191 <div class="memitem">
cannam@0 192 <div class="memproto">
cannam@0 193 <table class="memname">
cannam@0 194 <tr>
cannam@0 195 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
cannam@0 196 </tr>
cannam@0 197 </table>
cannam@0 198 </div>
cannam@0 199 <div class="memdoc">
cannam@0 200
cannam@0 201 <p>
cannam@0 202
cannam@21 203 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 204
cannam@0 205 </div>
cannam@0 206 </div><p>
cannam@0 207 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 208 <div class="memitem">
cannam@0 209 <div class="memproto">
cannam@0 210 <table class="memname">
cannam@0 211 <tr>
cannam@0 212 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
cannam@0 213 </tr>
cannam@0 214 </table>
cannam@0 215 </div>
cannam@0 216 <div class="memdoc">
cannam@0 217
cannam@0 218 <p>
cannam@0 219
cannam@21 220 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 221
cannam@0 222 </div>
cannam@0 223 </div><p>
cannam@0 224 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 225 <div class="memitem">
cannam@0 226 <div class="memproto">
cannam@0 227 <table class="memname">
cannam@0 228 <tr>
cannam@0 229 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
cannam@0 230 </tr>
cannam@0 231 </table>
cannam@0 232 </div>
cannam@0 233 <div class="memdoc">
cannam@0 234
cannam@0 235 <p>
cannam@0 236
cannam@21 237 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 238
cannam@0 239 </div>
cannam@0 240 </div><p>
cannam@0 241 <hr><h2>Member Enumeration Documentation</h2>
cannam@0 242 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
cannam@0 243 <div class="memitem">
cannam@0 244 <div class="memproto">
cannam@0 245 <table class="memname">
cannam@0 246 <tr>
cannam@0 247 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
cannam@0 248 </tr>
cannam@0 249 </table>
cannam@0 250 </div>
cannam@0 251 <div class="memdoc">
cannam@0 252
cannam@0 253 <p>
cannam@0 254 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 255 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 256 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
cannam@0 257 </td></tr>
cannam@0 258 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
cannam@0 259 </td></tr>
cannam@0 260 </table>
cannam@0 261 </dl>
cannam@0 262
cannam@21 263 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 264
cannam@0 265 </div>
cannam@0 266 </div><p>
cannam@0 267 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@21 268 <a class="anchor" name="c4fb6cfd7c0d3b2c8576a4e9dc61f518"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::~PluginWrapper" ref="c4fb6cfd7c0d3b2c8576a4e9dc61f518" args="()" -->
cannam@0 269 <div class="memitem">
cannam@0 270 <div class="memproto">
cannam@0 271 <table class="memname">
cannam@0 272 <tr>
cannam@21 273 <td class="memname">virtual Vamp::HostExt::PluginWrapper::~PluginWrapper </td>
cannam@0 274 <td>(</td>
cannam@0 275 <td class="paramname"> </td>
cannam@0 276 <td>&nbsp;)&nbsp;</td>
cannam@21 277 <td><code> [virtual]</code></td>
cannam@0 278 </tr>
cannam@0 279 </table>
cannam@0 280 </div>
cannam@0 281 <div class="memdoc">
cannam@0 282
cannam@0 283 <p>
cannam@0 284
cannam@0 285 </div>
cannam@0 286 </div><p>
cannam@0 287 <a class="anchor" name="35cc2d42f8322f5022e89859a79c97be"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::PluginWrapper" ref="35cc2d42f8322f5022e89859a79c97be" args="(Plugin *plugin)" -->
cannam@0 288 <div class="memitem">
cannam@0 289 <div class="memproto">
cannam@0 290 <table class="memname">
cannam@0 291 <tr>
cannam@0 292 <td class="memname">Vamp::HostExt::PluginWrapper::PluginWrapper </td>
cannam@0 293 <td>(</td>
cannam@0 294 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td>
cannam@0 295 <td class="paramname"> <em>plugin</em> </td>
cannam@0 296 <td>&nbsp;)&nbsp;</td>
cannam@21 297 <td><code> [protected]</code></td>
cannam@0 298 </tr>
cannam@0 299 </table>
cannam@0 300 </div>
cannam@0 301 <div class="memdoc">
cannam@0 302
cannam@0 303 <p>
cannam@0 304
cannam@0 305 </div>
cannam@0 306 </div><p>
cannam@0 307 <hr><h2>Member Function Documentation</h2>
cannam@0 308 <a class="anchor" name="a5a1f8290d8e9a315695584dcb3ad137"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::initialise" ref="a5a1f8290d8e9a315695584dcb3ad137" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
cannam@0 309 <div class="memitem">
cannam@0 310 <div class="memproto">
cannam@0 311 <table class="memname">
cannam@0 312 <tr>
cannam@0 313 <td class="memname">bool Vamp::HostExt::PluginWrapper::initialise </td>
cannam@0 314 <td>(</td>
cannam@0 315 <td class="paramtype">size_t&nbsp;</td>
cannam@0 316 <td class="paramname"> <em>inputChannels</em>, </td>
cannam@0 317 </tr>
cannam@0 318 <tr>
cannam@0 319 <td class="paramkey"></td>
cannam@0 320 <td></td>
cannam@0 321 <td class="paramtype">size_t&nbsp;</td>
cannam@0 322 <td class="paramname"> <em>stepSize</em>, </td>
cannam@0 323 </tr>
cannam@0 324 <tr>
cannam@0 325 <td class="paramkey"></td>
cannam@0 326 <td></td>
cannam@0 327 <td class="paramtype">size_t&nbsp;</td>
cannam@0 328 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
cannam@0 329 </tr>
cannam@0 330 <tr>
cannam@0 331 <td></td>
cannam@0 332 <td>)</td>
cannam@21 333 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 334 </tr>
cannam@0 335 </table>
cannam@0 336 </div>
cannam@0 337 <div class="memdoc">
cannam@0 338
cannam@0 339 <p>
cannam@0 340 Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).
cannam@0 341 <p>
cannam@0 342 The input sample rate should have been already specified at construction time.<p>
cannam@0 343 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
cannam@0 344 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
cannam@0 345
cannam@21 346 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#1e994576d43efe103bf8f83b69716745">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
cannam@0 347
cannam@0 348 </div>
cannam@0 349 </div><p>
cannam@0 350 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" -->
cannam@0 351 <div class="memitem">
cannam@0 352 <div class="memproto">
cannam@0 353 <table class="memname">
cannam@0 354 <tr>
cannam@0 355 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
cannam@0 356 <td>(</td>
cannam@0 357 <td class="paramname"> </td>
cannam@0 358 <td>&nbsp;)&nbsp;</td>
cannam@21 359 <td><code> [virtual]</code></td>
cannam@0 360 </tr>
cannam@0 361 </table>
cannam@0 362 </div>
cannam@0 363 <div class="memdoc">
cannam@0 364
cannam@0 365 <p>
cannam@0 366 Reset the plugin after use, to prepare it for another clean run.
cannam@0 367 <p>
cannam@0 368 Not called for the first initialisation (i.e. initialise must also do a reset).
cannam@0 369 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
cannam@0 370
cannam@0 371 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 372
cannam@0 373 </div>
cannam@0 374 </div><p>
cannam@21 375 <a class="anchor" name="e203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getInputDomain" ref="e203faf8384c9e1fddc381409aa8a214" args="() const " -->
cannam@0 376 <div class="memitem">
cannam@0 377 <div class="memproto">
cannam@0 378 <table class="memname">
cannam@0 379 <tr>
cannam@21 380 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
cannam@0 381 <td>(</td>
cannam@0 382 <td class="paramname"> </td>
cannam@0 383 <td>&nbsp;)&nbsp;</td>
cannam@21 384 <td> const<code> [virtual]</code></td>
cannam@0 385 </tr>
cannam@0 386 </table>
cannam@0 387 </div>
cannam@0 388 <div class="memdoc">
cannam@0 389
cannam@0 390 <p>
cannam@0 391 Get the plugin's required input domain.
cannam@0 392 <p>
cannam@21 393 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" 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. 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#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
cannam@0 394 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
cannam@0 395
cannam@21 396 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
cannam@0 397
cannam@0 398 </div>
cannam@0 399 </div><p>
cannam@0 400 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
cannam@0 401 <div class="memitem">
cannam@0 402 <div class="memproto">
cannam@0 403 <table class="memname">
cannam@0 404 <tr>
cannam@0 405 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
cannam@0 406 <td>(</td>
cannam@0 407 <td class="paramname"> </td>
cannam@0 408 <td>&nbsp;)&nbsp;</td>
cannam@21 409 <td> const<code> [virtual]</code></td>
cannam@0 410 </tr>
cannam@0 411 </table>
cannam@0 412 </div>
cannam@0 413 <div class="memdoc">
cannam@0 414
cannam@0 415 <p>
cannam@21 416 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
cannam@0 417 <p>
cannam@0 418
cannam@0 419 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
cannam@0 420
cannam@0 421 </div>
cannam@0 422 </div><p>
cannam@0 423 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
cannam@0 424 <div class="memitem">
cannam@0 425 <div class="memproto">
cannam@0 426 <table class="memname">
cannam@0 427 <tr>
cannam@0 428 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
cannam@0 429 <td>(</td>
cannam@0 430 <td class="paramname"> </td>
cannam@0 431 <td>&nbsp;)&nbsp;</td>
cannam@21 432 <td> const<code> [virtual]</code></td>
cannam@0 433 </tr>
cannam@0 434 </table>
cannam@0 435 </div>
cannam@0 436 <div class="memdoc">
cannam@0 437
cannam@0 438 <p>
cannam@0 439 Get the computer-usable name of the plugin.
cannam@0 440 <p>
cannam@0 441 This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.<p>
cannam@0 442 This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).<p>
cannam@0 443 Example: "zero_crossings"
cannam@0 444 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@0 445
cannam@0 446 </div>
cannam@0 447 </div><p>
cannam@0 448 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
cannam@0 449 <div class="memitem">
cannam@0 450 <div class="memproto">
cannam@0 451 <table class="memname">
cannam@0 452 <tr>
cannam@0 453 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
cannam@0 454 <td>(</td>
cannam@0 455 <td class="paramname"> </td>
cannam@0 456 <td>&nbsp;)&nbsp;</td>
cannam@21 457 <td> const<code> [virtual]</code></td>
cannam@0 458 </tr>
cannam@0 459 </table>
cannam@0 460 </div>
cannam@0 461 <div class="memdoc">
cannam@0 462
cannam@0 463 <p>
cannam@0 464 Get a human-readable name or title of the plugin.
cannam@0 465 <p>
cannam@0 466 This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").<p>
cannam@0 467 Example: "Zero Crossings"
cannam@0 468 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@0 469
cannam@0 470 </div>
cannam@0 471 </div><p>
cannam@0 472 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
cannam@0 473 <div class="memitem">
cannam@0 474 <div class="memproto">
cannam@0 475 <table class="memname">
cannam@0 476 <tr>
cannam@0 477 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
cannam@0 478 <td>(</td>
cannam@0 479 <td class="paramname"> </td>
cannam@0 480 <td>&nbsp;)&nbsp;</td>
cannam@21 481 <td> const<code> [virtual]</code></td>
cannam@0 482 </tr>
cannam@0 483 </table>
cannam@0 484 </div>
cannam@0 485 <div class="memdoc">
cannam@0 486
cannam@0 487 <p>
cannam@0 488 Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".
cannam@0 489 <p>
cannam@0 490 May be empty if the name has said it all already.<p>
cannam@0 491 Example: "Detect and count zero crossing points"
cannam@0 492 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@0 493
cannam@0 494 </div>
cannam@0 495 </div><p>
cannam@0 496 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
cannam@0 497 <div class="memitem">
cannam@0 498 <div class="memproto">
cannam@0 499 <table class="memname">
cannam@0 500 <tr>
cannam@0 501 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
cannam@0 502 <td>(</td>
cannam@0 503 <td class="paramname"> </td>
cannam@0 504 <td>&nbsp;)&nbsp;</td>
cannam@21 505 <td> const<code> [virtual]</code></td>
cannam@0 506 </tr>
cannam@0 507 </table>
cannam@0 508 </div>
cannam@0 509 <div class="memdoc">
cannam@0 510
cannam@0 511 <p>
cannam@0 512 Get the name of the author or vendor of the plugin in human-readable form.
cannam@0 513 <p>
cannam@0 514 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
cannam@0 515 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@0 516
cannam@0 517 </div>
cannam@0 518 </div><p>
cannam@0 519 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
cannam@0 520 <div class="memitem">
cannam@0 521 <div class="memproto">
cannam@0 522 <table class="memname">
cannam@0 523 <tr>
cannam@0 524 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
cannam@0 525 <td>(</td>
cannam@0 526 <td class="paramname"> </td>
cannam@0 527 <td>&nbsp;)&nbsp;</td>
cannam@21 528 <td> const<code> [virtual]</code></td>
cannam@0 529 </tr>
cannam@0 530 </table>
cannam@0 531 </div>
cannam@0 532 <div class="memdoc">
cannam@0 533
cannam@0 534 <p>
cannam@0 535 Get the version number of the plugin.
cannam@0 536 <p>
cannam@0 537
cannam@0 538 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 539
cannam@0 540 </div>
cannam@0 541 </div><p>
cannam@0 542 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
cannam@0 543 <div class="memitem">
cannam@0 544 <div class="memproto">
cannam@0 545 <table class="memname">
cannam@0 546 <tr>
cannam@0 547 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
cannam@0 548 <td>(</td>
cannam@0 549 <td class="paramname"> </td>
cannam@0 550 <td>&nbsp;)&nbsp;</td>
cannam@21 551 <td> const<code> [virtual]</code></td>
cannam@0 552 </tr>
cannam@0 553 </table>
cannam@0 554 </div>
cannam@0 555 <div class="memdoc">
cannam@0 556
cannam@0 557 <p>
cannam@0 558 Get the copyright statement or licensing summary for the plugin.
cannam@0 559 <p>
cannam@0 560 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
cannam@0 561 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@0 562
cannam@0 563 </div>
cannam@0 564 </div><p>
cannam@21 565 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
cannam@0 566 <div class="memitem">
cannam@0 567 <div class="memproto">
cannam@0 568 <table class="memname">
cannam@0 569 <tr>
cannam@21 570 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
cannam@0 571 <td>(</td>
cannam@0 572 <td class="paramname"> </td>
cannam@0 573 <td>&nbsp;)&nbsp;</td>
cannam@21 574 <td> const<code> [virtual]</code></td>
cannam@0 575 </tr>
cannam@0 576 </table>
cannam@0 577 </div>
cannam@0 578 <div class="memdoc">
cannam@0 579
cannam@0 580 <p>
cannam@0 581 Get the controllable parameters of this plugin.
cannam@0 582 <p>
cannam@0 583
cannam@0 584 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
cannam@0 585
cannam@0 586 </div>
cannam@0 587 </div><p>
cannam@0 588 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
cannam@0 589 <div class="memitem">
cannam@0 590 <div class="memproto">
cannam@0 591 <table class="memname">
cannam@0 592 <tr>
cannam@0 593 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
cannam@0 594 <td>(</td>
cannam@0 595 <td class="paramtype">std::string&nbsp;</td>
cannam@0 596 <td class="paramname"> </td>
cannam@0 597 <td>&nbsp;)&nbsp;</td>
cannam@21 598 <td> const<code> [virtual]</code></td>
cannam@0 599 </tr>
cannam@0 600 </table>
cannam@0 601 </div>
cannam@0 602 <div class="memdoc">
cannam@0 603
cannam@0 604 <p>
cannam@0 605 Get the value of a named parameter.
cannam@0 606 <p>
cannam@0 607 The argument is the identifier field from that parameter's descriptor.
cannam@0 608 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
cannam@0 609
cannam@0 610 </div>
cannam@0 611 </div><p>
cannam@0 612 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
cannam@0 613 <div class="memitem">
cannam@0 614 <div class="memproto">
cannam@0 615 <table class="memname">
cannam@0 616 <tr>
cannam@0 617 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
cannam@0 618 <td>(</td>
cannam@0 619 <td class="paramtype">std::string&nbsp;</td>
cannam@0 620 <td class="paramname">, </td>
cannam@0 621 </tr>
cannam@0 622 <tr>
cannam@0 623 <td class="paramkey"></td>
cannam@0 624 <td></td>
cannam@0 625 <td class="paramtype">float&nbsp;</td>
cannam@0 626 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 627 </tr>
cannam@0 628 <tr>
cannam@0 629 <td></td>
cannam@0 630 <td>)</td>
cannam@21 631 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 632 </tr>
cannam@0 633 </table>
cannam@0 634 </div>
cannam@0 635 <div class="memdoc">
cannam@0 636
cannam@0 637 <p>
cannam@0 638 Set a named parameter.
cannam@0 639 <p>
cannam@0 640 The first argument is the identifier field from that parameter's descriptor.
cannam@0 641 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
cannam@0 642
cannam@21 643 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 644
cannam@0 645 </div>
cannam@0 646 </div><p>
cannam@21 647 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " -->
cannam@0 648 <div class="memitem">
cannam@0 649 <div class="memproto">
cannam@0 650 <table class="memname">
cannam@0 651 <tr>
cannam@21 652 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
cannam@0 653 <td>(</td>
cannam@0 654 <td class="paramname"> </td>
cannam@0 655 <td>&nbsp;)&nbsp;</td>
cannam@21 656 <td> const<code> [virtual]</code></td>
cannam@0 657 </tr>
cannam@0 658 </table>
cannam@0 659 </div>
cannam@0 660 <div class="memdoc">
cannam@0 661
cannam@0 662 <p>
cannam@0 663 Get the program settings available in this plugin.
cannam@0 664 <p>
cannam@0 665 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p>
cannam@0 666 The programs must have unique names.
cannam@0 667 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
cannam@0 668
cannam@0 669 </div>
cannam@0 670 </div><p>
cannam@0 671 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
cannam@0 672 <div class="memitem">
cannam@0 673 <div class="memproto">
cannam@0 674 <table class="memname">
cannam@0 675 <tr>
cannam@0 676 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
cannam@0 677 <td>(</td>
cannam@0 678 <td class="paramname"> </td>
cannam@0 679 <td>&nbsp;)&nbsp;</td>
cannam@21 680 <td> const<code> [virtual]</code></td>
cannam@0 681 </tr>
cannam@0 682 </table>
cannam@0 683 </div>
cannam@0 684 <div class="memdoc">
cannam@0 685
cannam@0 686 <p>
cannam@0 687 Get the current program.
cannam@0 688 <p>
cannam@0 689
cannam@0 690 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
cannam@0 691
cannam@0 692 </div>
cannam@0 693 </div><p>
cannam@0 694 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
cannam@0 695 <div class="memitem">
cannam@0 696 <div class="memproto">
cannam@0 697 <table class="memname">
cannam@0 698 <tr>
cannam@0 699 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
cannam@0 700 <td>(</td>
cannam@0 701 <td class="paramtype">std::string&nbsp;</td>
cannam@0 702 <td class="paramname"> </td>
cannam@0 703 <td>&nbsp;)&nbsp;</td>
cannam@21 704 <td><code> [virtual]</code></td>
cannam@0 705 </tr>
cannam@0 706 </table>
cannam@0 707 </div>
cannam@0 708 <div class="memdoc">
cannam@0 709
cannam@0 710 <p>
cannam@0 711 Select a program.
cannam@0 712 <p>
cannam@0 713 (If the given program name is not one of the available programs, do nothing.)
cannam@0 714 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
cannam@0 715
cannam@21 716 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 717
cannam@0 718 </div>
cannam@0 719 </div><p>
cannam@0 720 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " -->
cannam@0 721 <div class="memitem">
cannam@0 722 <div class="memproto">
cannam@0 723 <table class="memname">
cannam@0 724 <tr>
cannam@0 725 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
cannam@0 726 <td>(</td>
cannam@0 727 <td class="paramname"> </td>
cannam@0 728 <td>&nbsp;)&nbsp;</td>
cannam@21 729 <td> const<code> [virtual]</code></td>
cannam@0 730 </tr>
cannam@0 731 </table>
cannam@0 732 </div>
cannam@0 733 <div class="memdoc">
cannam@0 734
cannam@0 735 <p>
cannam@21 736 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#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin.
cannam@0 737 <p>
cannam@0 738 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
cannam@0 739 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#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
cannam@0 740 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
cannam@0 741
cannam@0 742 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
cannam@0 743
cannam@0 744 </div>
cannam@0 745 </div><p>
cannam@0 746 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " -->
cannam@0 747 <div class="memitem">
cannam@0 748 <div class="memproto">
cannam@0 749 <table class="memname">
cannam@0 750 <tr>
cannam@0 751 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
cannam@0 752 <td>(</td>
cannam@0 753 <td class="paramname"> </td>
cannam@0 754 <td>&nbsp;)&nbsp;</td>
cannam@21 755 <td> const<code> [virtual]</code></td>
cannam@0 756 </tr>
cannam@0 757 </table>
cannam@0 758 </div>
cannam@0 759 <div class="memdoc">
cannam@0 760
cannam@0 761 <p>
cannam@21 762 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#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function).
cannam@0 763 <p>
cannam@0 764 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
cannam@0 765 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#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
cannam@0 766 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
cannam@0 767
cannam@21 768 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
cannam@0 769
cannam@0 770 </div>
cannam@0 771 </div><p>
cannam@0 772 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
cannam@0 773 <div class="memitem">
cannam@0 774 <div class="memproto">
cannam@0 775 <table class="memname">
cannam@0 776 <tr>
cannam@0 777 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
cannam@0 778 <td>(</td>
cannam@0 779 <td class="paramname"> </td>
cannam@0 780 <td>&nbsp;)&nbsp;</td>
cannam@21 781 <td> const<code> [virtual]</code></td>
cannam@0 782 </tr>
cannam@0 783 </table>
cannam@0 784 </div>
cannam@0 785 <div class="memdoc">
cannam@0 786
cannam@0 787 <p>
cannam@0 788 Get the minimum supported number of input channels.
cannam@0 789 <p>
cannam@0 790
cannam@0 791 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
cannam@0 792
cannam@0 793 </div>
cannam@0 794 </div><p>
cannam@0 795 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
cannam@0 796 <div class="memitem">
cannam@0 797 <div class="memproto">
cannam@0 798 <table class="memname">
cannam@0 799 <tr>
cannam@0 800 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
cannam@0 801 <td>(</td>
cannam@0 802 <td class="paramname"> </td>
cannam@0 803 <td>&nbsp;)&nbsp;</td>
cannam@21 804 <td> const<code> [virtual]</code></td>
cannam@0 805 </tr>
cannam@0 806 </table>
cannam@0 807 </div>
cannam@0 808 <div class="memdoc">
cannam@0 809
cannam@0 810 <p>
cannam@0 811 Get the maximum supported number of input channels.
cannam@0 812 <p>
cannam@0 813
cannam@0 814 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
cannam@0 815
cannam@0 816 </div>
cannam@0 817 </div><p>
cannam@21 818 <a class="anchor" name="5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getOutputDescriptors" ref="5a9411305f713b4c9827844b89acd270" args="() const " -->
cannam@0 819 <div class="memitem">
cannam@0 820 <div class="memproto">
cannam@0 821 <table class="memname">
cannam@0 822 <tr>
cannam@21 823 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
cannam@0 824 <td>(</td>
cannam@0 825 <td class="paramname"> </td>
cannam@0 826 <td>&nbsp;)&nbsp;</td>
cannam@21 827 <td> const<code> [virtual]</code></td>
cannam@0 828 </tr>
cannam@0 829 </table>
cannam@0 830 </div>
cannam@0 831 <div class="memdoc">
cannam@0 832
cannam@0 833 <p>
cannam@0 834 Get the outputs of this plugin.
cannam@0 835 <p>
cannam@21 836 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#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> call.
cannam@0 837 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
cannam@0 838
cannam@21 839 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
cannam@0 840
cannam@0 841 </div>
cannam@0 842 </div><p>
cannam@21 843 <a class="anchor" name="6bd72d6dfb3047524dbe8ae3294527cf"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::process" ref="6bd72d6dfb3047524dbe8ae3294527cf" args="(const float *const *inputBuffers, RealTime timestamp)" -->
cannam@0 844 <div class="memitem">
cannam@0 845 <div class="memproto">
cannam@0 846 <table class="memname">
cannam@0 847 <tr>
cannam@21 848 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::process </td>
cannam@0 849 <td>(</td>
cannam@0 850 <td class="paramtype">const float *const *&nbsp;</td>
cannam@0 851 <td class="paramname"> <em>inputBuffers</em>, </td>
cannam@0 852 </tr>
cannam@0 853 <tr>
cannam@0 854 <td class="paramkey"></td>
cannam@0 855 <td></td>
cannam@0 856 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td>
cannam@0 857 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
cannam@0 858 </tr>
cannam@0 859 <tr>
cannam@0 860 <td></td>
cannam@0 861 <td>)</td>
cannam@21 862 <td></td><td></td><td><code> [virtual]</code></td>
cannam@0 863 </tr>
cannam@0 864 </table>
cannam@0 865 </div>
cannam@0 866 <div class="memdoc">
cannam@0 867
cannam@0 868 <p>
cannam@0 869 Process a single block of input data.
cannam@0 870 <p>
cannam@21 871 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.<p>
cannam@0 872 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p>
cannam@0 873 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)
cannam@0 874 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
cannam@0 875
cannam@21 876 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#55058a20c1f8bffc0dc927350df778a0">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#6ff37bf754ff8711dbcb2f020fa3902c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#3314b456a4780601c021dac25b478846">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
cannam@0 877
cannam@0 878 </div>
cannam@0 879 </div><p>
cannam@21 880 <a class="anchor" name="2bc8c0992e64f06991fb7cf89f99857e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getRemainingFeatures" ref="2bc8c0992e64f06991fb7cf89f99857e" args="()" -->
cannam@0 881 <div class="memitem">
cannam@0 882 <div class="memproto">
cannam@0 883 <table class="memname">
cannam@0 884 <tr>
cannam@21 885 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
cannam@0 886 <td>(</td>
cannam@0 887 <td class="paramname"> </td>
cannam@0 888 <td>&nbsp;)&nbsp;</td>
cannam@21 889 <td><code> [virtual]</code></td>
cannam@0 890 </tr>
cannam@0 891 </table>
cannam@0 892 </div>
cannam@0 893 <div class="memdoc">
cannam@0 894
cannam@0 895 <p>
cannam@0 896 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
cannam@0 897 <p>
cannam@0 898
cannam@0 899 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
cannam@0 900
cannam@21 901 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#28423951b2eda1a1fc371485434f417b">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#e9dcbd1ba8197ff90b4fc6bf7ade7688">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
cannam@0 902
cannam@21 903 </div>
cannam@21 904 </div><p>
cannam@21 905 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
cannam@21 906 <div class="memitem">
cannam@21 907 <div class="memproto">
cannam@21 908 <div class="memtemplate">
cannam@21 909 template&lt;typename WrapperType&gt; </div>
cannam@21 910 <table class="memname">
cannam@21 911 <tr>
cannam@21 912 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
cannam@21 913 <td>(</td>
cannam@21 914 <td class="paramname"> </td>
cannam@21 915 <td>&nbsp;)&nbsp;</td>
cannam@21 916 <td><code> [inline]</code></td>
cannam@21 917 </tr>
cannam@21 918 </table>
cannam@21 919 </div>
cannam@21 920 <div class="memdoc">
cannam@0 921
cannam@21 922 <p>
cannam@21 923 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
cannam@21 924 <p>
cannam@21 925 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#964689eb9688cd7e58e8c82ebb0d305f" 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.
cannam@21 926 <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>
cannam@21 927
cannam@21 928 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">getWrapper()</a>.</p>
cannam@21 929
cannam@21 930 <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>
cannam@0 931
cannam@0 932 </div>
cannam@0 933 </div><p>
cannam@0 934 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 935 <div class="memitem">
cannam@0 936 <div class="memproto">
cannam@0 937 <table class="memname">
cannam@0 938 <tr>
cannam@0 939 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 940 <td>(</td>
cannam@0 941 <td class="paramname"> </td>
cannam@0 942 <td>&nbsp;)&nbsp;</td>
cannam@21 943 <td> const<code> [inline, virtual, inherited]</code></td>
cannam@0 944 </tr>
cannam@0 945 </table>
cannam@0 946 </div>
cannam@0 947 <div class="memdoc">
cannam@0 948
cannam@0 949 <p>
cannam@0 950 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
cannam@0 951 <p>
cannam@0 952 Do not reimplement this function in your subclass.
cannam@0 953 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@0 954
cannam@21 955 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00425">425</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 956
cannam@0 957 </div>
cannam@0 958 </div><p>
cannam@0 959 <hr><h2>Member Data Documentation</h2>
cannam@0 960 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
cannam@0 961 <div class="memitem">
cannam@0 962 <div class="memproto">
cannam@0 963 <table class="memname">
cannam@0 964 <tr>
cannam@0 965 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected]</code> </td>
cannam@0 966 </tr>
cannam@0 967 </table>
cannam@0 968 </div>
cannam@0 969 <div class="memdoc">
cannam@0 970
cannam@0 971 <p>
cannam@0 972
cannam@21 973 <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>
cannam@0 974
cannam@0 975 </div>
cannam@0 976 </div><p>
cannam@0 977 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 978 <div class="memitem">
cannam@0 979 <div class="memproto">
cannam@0 980 <table class="memname">
cannam@0 981 <tr>
cannam@0 982 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
cannam@0 983 </tr>
cannam@0 984 </table>
cannam@0 985 </div>
cannam@0 986 <div class="memdoc">
cannam@0 987
cannam@0 988 <p>
cannam@0 989
cannam@21 990 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">431</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
cannam@0 991
cannam@21 992 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
cannam@0 993
cannam@0 994 </div>
cannam@0 995 </div><p>
cannam@21 996 <hr>The documentation for this class was generated from the following file:<ul>
cannam@21 997 <li><a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a></ul>
cannam@0 998 </div>
cannam@21 999 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:22 2008 for VampPluginSDK by&nbsp;
cannam@0 1000 <a href="http://www.doxygen.org/index.html">
cannam@21 1001 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
cannam@0 1002 </body>
cannam@0 1003 </html>