Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1HostExt_1_1PluginWrapper.html @ 35:0976232e353b website

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