annotate code-doc/classVamp_1_1HostExt_1_1PluginBufferingAdapter.html @ 1:632b1ffb5fb2 website

* Add some more provisional RDFs plus index
author cannam
date Fri, 17 Oct 2008 14:53:59 +0000
parents 351c4ebce5f9
children cc0be37dc9d3
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::PluginBufferingAdapter 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@0 7 <!-- Generated by Doxygen 1.5.5 -->
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_1PluginBufferingAdapter.html">PluginBufferingAdapter</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@0 29 <h1>Vamp::HostExt::PluginBufferingAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginBufferingAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><code>#include &lt;<a class="el" href="PluginBufferingAdapter_8h-source.html">vamp-sdk/hostext/PluginBufferingAdapter.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31 <div class="dynheader">
cannam@0 32 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div>
cannam@0 33 <div class="dynsection">
cannam@0 34 <p><center><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map" alt="Inheritance graph"></center>
cannam@0 35 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map">
cannam@0 36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="31,156,231,180"><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="81,81,180,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="67,6,195,30"></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_1PluginBufferingAdapter-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_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size.
cannam@0 42 <p>
cannam@0 43 A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.<p>
cannam@0 44 If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.<p>
cannam@0 45 In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.
cannam@0 46 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h-source.html#l00072">72</a> of file <a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.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@0 68 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
cannam@0 69
cannam@0 70 <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_1PluginBufferingAdapter.html#539423b54a4ede511476125f4a97d977">~PluginBufferingAdapter</a> ()</td></tr>
cannam@0 71
cannam@0 72 <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_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
cannam@0 73
cannam@0 74 <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="#9e7798ba4d7870db46502ab541ab37a8"></a><br></td></tr>
cannam@0 75 <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_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">getPreferredStepSize</a> () const </td></tr>
cannam@0 76
cannam@0 77 <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_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#2e66d009df69c951001e5d2786973d60"></a><br></td></tr>
cannam@0 78 <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_1PluginBufferingAdapter.html#85a027f5859efb31d315205e234e94c0">getOutputDescriptors</a> () const </td></tr>
cannam@0 79
cannam@0 80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#85a027f5859efb31d315205e234e94c0"></a><br></td></tr>
cannam@0 81 <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_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">reset</a> ()</td></tr>
cannam@0 82
cannam@0 83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#131fd9fe8a1795d7370d8a721176868a"></a><br></td></tr>
cannam@0 84 <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_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
cannam@0 85
cannam@0 86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#262206b978d9de28ee4bb35f437e915e"></a><br></td></tr>
cannam@0 87 <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_1PluginBufferingAdapter.html#8771cba75552aaa1340b68de9bf1659c">getRemainingFeatures</a> ()</td></tr>
cannam@0 88
cannam@0 89 <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="#8771cba75552aaa1340b68de9bf1659c"></a><br></td></tr>
cannam@0 90 <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#031aa818fd48fd0f4b5e1bf80c032870">getInputDomain</a> () const </td></tr>
cannam@0 91
cannam@0 92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#031aa818fd48fd0f4b5e1bf80c032870"></a><br></td></tr>
cannam@0 93 <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 94
cannam@0 95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr>
cannam@0 96 <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 97
cannam@0 98 <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 99 <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 100
cannam@0 101 <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 102 <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 103
cannam@0 104 <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 105 <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 106
cannam@0 107 <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 108 <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 109
cannam@0 110 <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 111 <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 112
cannam@0 113 <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@0 114 <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#3b075b8f950b344503f0d27ac0fe332e">getParameterDescriptors</a> () const </td></tr>
cannam@0 115
cannam@0 116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#3b075b8f950b344503f0d27ac0fe332e"></a><br></td></tr>
cannam@0 117 <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 118
cannam@0 119 <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 120 <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 121
cannam@0 122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
cannam@0 123 <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#f3abaf717dc4b00cad5770ed6dfa01e1">getPrograms</a> () const </td></tr>
cannam@0 124
cannam@0 125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#f3abaf717dc4b00cad5770ed6dfa01e1"></a><br></td></tr>
cannam@0 126 <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 127
cannam@0 128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
cannam@0 129 <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 130
cannam@0 131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
cannam@0 132 <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 133
cannam@0 134 <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#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr>
cannam@0 135 <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 136
cannam@0 137 <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 138 <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 139
cannam@0 140 <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@0 141 <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 142
cannam@0 143 <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 144 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@0 145 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">m_impl</a></td></tr>
cannam@0 146
cannam@0 147 <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 148
cannam@0 149 <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 150
cannam@0 151 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
cannam@0 152 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</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::PluginBufferingAdapter::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@0 169 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">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::PluginBufferingAdapter::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@0 186 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">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::PluginBufferingAdapter::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@0 203 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">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::PluginBufferingAdapter::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@0 220 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">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::PluginBufferingAdapter::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@0 237 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">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::PluginBufferingAdapter::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@0 263 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">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@0 268 <a class="anchor" name="1276bcfcbe1414b33eeefbd7b2b702fe"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter" ref="1276bcfcbe1414b33eeefbd7b2b702fe" args="(Plugin *plugin)" -->
cannam@0 269 <div class="memitem">
cannam@0 270 <div class="memproto">
cannam@0 271 <table class="memname">
cannam@0 272 <tr>
cannam@0 273 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter </td>
cannam@0 274 <td>(</td>
cannam@0 275 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td>
cannam@0 276 <td class="paramname"> <em>plugin</em> </td>
cannam@0 277 <td>&nbsp;)&nbsp;</td>
cannam@0 278 <td width="100%"></td>
cannam@0 279 </tr>
cannam@0 280 </table>
cannam@0 281 </div>
cannam@0 282 <div class="memdoc">
cannam@0 283
cannam@0 284 <p>
cannam@0 285
cannam@0 286 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">238</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 287
cannam@0 288 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>, and <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>.</p>
cannam@0 289
cannam@0 290 </div>
cannam@0 291 </div><p>
cannam@0 292 <a class="anchor" name="539423b54a4ede511476125f4a97d977"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter" ref="539423b54a4ede511476125f4a97d977" args="()" -->
cannam@0 293 <div class="memitem">
cannam@0 294 <div class="memproto">
cannam@0 295 <table class="memname">
cannam@0 296 <tr>
cannam@0 297 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter </td>
cannam@0 298 <td>(</td>
cannam@0 299 <td class="paramname"> </td>
cannam@0 300 <td>&nbsp;)&nbsp;</td>
cannam@0 301 <td width="100%"><code> [virtual]</code></td>
cannam@0 302 </tr>
cannam@0 303 </table>
cannam@0 304 </div>
cannam@0 305 <div class="memdoc">
cannam@0 306
cannam@0 307 <p>
cannam@0 308
cannam@0 309 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00244">244</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 310
cannam@0 311 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p>
cannam@0 312
cannam@0 313 </div>
cannam@0 314 </div><p>
cannam@0 315 <hr><h2>Member Function Documentation</h2>
cannam@0 316 <a class="anchor" name="9e7798ba4d7870db46502ab541ab37a8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::initialise" ref="9e7798ba4d7870db46502ab541ab37a8" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
cannam@0 317 <div class="memitem">
cannam@0 318 <div class="memproto">
cannam@0 319 <table class="memname">
cannam@0 320 <tr>
cannam@0 321 <td class="memname">bool Vamp::HostExt::PluginBufferingAdapter::initialise </td>
cannam@0 322 <td>(</td>
cannam@0 323 <td class="paramtype">size_t&nbsp;</td>
cannam@0 324 <td class="paramname"> <em>inputChannels</em>, </td>
cannam@0 325 </tr>
cannam@0 326 <tr>
cannam@0 327 <td class="paramkey"></td>
cannam@0 328 <td></td>
cannam@0 329 <td class="paramtype">size_t&nbsp;</td>
cannam@0 330 <td class="paramname"> <em>stepSize</em>, </td>
cannam@0 331 </tr>
cannam@0 332 <tr>
cannam@0 333 <td class="paramkey"></td>
cannam@0 334 <td></td>
cannam@0 335 <td class="paramtype">size_t&nbsp;</td>
cannam@0 336 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
cannam@0 337 </tr>
cannam@0 338 <tr>
cannam@0 339 <td></td>
cannam@0 340 <td>)</td>
cannam@0 341 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
cannam@0 342 </tr>
cannam@0 343 </table>
cannam@0 344 </div>
cannam@0 345 <div class="memdoc">
cannam@0 346
cannam@0 347 <p>
cannam@0 348 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 349 <p>
cannam@0 350 The input sample rate should have been already specified at construction time.<p>
cannam@0 351 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
cannam@0 352 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 353
cannam@0 354 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00250">250</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 355
cannam@0 356 <p>References <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00314">Vamp::HostExt::PluginBufferingAdapter::Impl::initialise()</a>, and <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p>
cannam@0 357
cannam@0 358 </div>
cannam@0 359 </div><p>
cannam@0 360 <a class="anchor" name="2e66d009df69c951001e5d2786973d60"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize" ref="2e66d009df69c951001e5d2786973d60" args="() const " -->
cannam@0 361 <div class="memitem">
cannam@0 362 <div class="memproto">
cannam@0 363 <table class="memname">
cannam@0 364 <tr>
cannam@0 365 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize </td>
cannam@0 366 <td>(</td>
cannam@0 367 <td class="paramname"> </td>
cannam@0 368 <td>&nbsp;)&nbsp;</td>
cannam@0 369 <td width="100%"> const<code> [virtual]</code></td>
cannam@0 370 </tr>
cannam@0 371 </table>
cannam@0 372 </div>
cannam@0 373 <div class="memdoc">
cannam@0 374
cannam@0 375 <p>
cannam@0 376 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_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" title="Process a single block of input data.">process()</a> function) for the plugin.
cannam@0 377 <p>
cannam@0 378 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
cannam@0 379 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_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
cannam@0 380 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 381
cannam@0 382 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">308</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 383
cannam@0 384 <p>References <a class="el" href="PluginWrapper_8cpp-source.html#l00164">Vamp::HostExt::PluginWrapper::getPreferredBlockSize()</a>.</p>
cannam@0 385
cannam@0 386 </div>
cannam@0 387 </div><p>
cannam@0 388 <a class="anchor" name="85a027f5859efb31d315205e234e94c0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors" ref="85a027f5859efb31d315205e234e94c0" args="() const " -->
cannam@0 389 <div class="memitem">
cannam@0 390 <div class="memproto">
cannam@0 391 <table class="memname">
cannam@0 392 <tr>
cannam@0 393 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PluginBufferingAdapter::OutputList</a> Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors </td>
cannam@0 394 <td>(</td>
cannam@0 395 <td class="paramname"> </td>
cannam@0 396 <td>&nbsp;)&nbsp;</td>
cannam@0 397 <td width="100%"> const<code> [virtual]</code></td>
cannam@0 398 </tr>
cannam@0 399 </table>
cannam@0 400 </div>
cannam@0 401 <div class="memdoc">
cannam@0 402
cannam@0 403 <p>
cannam@0 404 Get the outputs of this plugin.
cannam@0 405 <p>
cannam@0 406 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_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" title="Process a single block of input data.">process()</a> call.
cannam@0 407 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#02c8c01972affeea58b091335e791ace">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 408
cannam@0 409 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00256">256</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 410
cannam@0 411 <p>References <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00367">Vamp::HostExt::PluginBufferingAdapter::Impl::getOutputDescriptors()</a>, and <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p>
cannam@0 412
cannam@0 413 </div>
cannam@0 414 </div><p>
cannam@0 415 <a class="anchor" name="131fd9fe8a1795d7370d8a721176868a"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::reset" ref="131fd9fe8a1795d7370d8a721176868a" args="()" -->
cannam@0 416 <div class="memitem">
cannam@0 417 <div class="memproto">
cannam@0 418 <table class="memname">
cannam@0 419 <tr>
cannam@0 420 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::reset </td>
cannam@0 421 <td>(</td>
cannam@0 422 <td class="paramname"> </td>
cannam@0 423 <td>&nbsp;)&nbsp;</td>
cannam@0 424 <td width="100%"><code> [virtual]</code></td>
cannam@0 425 </tr>
cannam@0 426 </table>
cannam@0 427 </div>
cannam@0 428 <div class="memdoc">
cannam@0 429
cannam@0 430 <p>
cannam@0 431 Reset the plugin after use, to prepare it for another clean run.
cannam@0 432 <p>
cannam@0 433 Not called for the first initialisation (i.e. initialise must also do a reset).
cannam@0 434 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 435
cannam@0 436 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00262">262</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 437
cannam@0 438 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>, and <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00406">Vamp::HostExt::PluginBufferingAdapter::Impl::reset()</a>.</p>
cannam@0 439
cannam@0 440 </div>
cannam@0 441 </div><p>
cannam@0 442 <a class="anchor" name="262206b978d9de28ee4bb35f437e915e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::process" ref="262206b978d9de28ee4bb35f437e915e" args="(const float *const *inputBuffers, RealTime timestamp)" -->
cannam@0 443 <div class="memitem">
cannam@0 444 <div class="memproto">
cannam@0 445 <table class="memname">
cannam@0 446 <tr>
cannam@0 447 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PluginBufferingAdapter::FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::process </td>
cannam@0 448 <td>(</td>
cannam@0 449 <td class="paramtype">const float *const *&nbsp;</td>
cannam@0 450 <td class="paramname"> <em>inputBuffers</em>, </td>
cannam@0 451 </tr>
cannam@0 452 <tr>
cannam@0 453 <td class="paramkey"></td>
cannam@0 454 <td></td>
cannam@0 455 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td>
cannam@0 456 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
cannam@0 457 </tr>
cannam@0 458 <tr>
cannam@0 459 <td></td>
cannam@0 460 <td>)</td>
cannam@0 461 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
cannam@0 462 </tr>
cannam@0 463 </table>
cannam@0 464 </div>
cannam@0 465 <div class="memdoc">
cannam@0 466
cannam@0 467 <p>
cannam@0 468 Process a single block of input data.
cannam@0 469 <p>
cannam@0 470 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 will be the real time in seconds of the start of the supplied block of samples.<p>
cannam@0 471 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 472 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 473 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 474
cannam@0 475 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00268">268</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 476
cannam@0 477 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>, and <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00417">Vamp::HostExt::PluginBufferingAdapter::Impl::process()</a>.</p>
cannam@0 478
cannam@0 479 </div>
cannam@0 480 </div><p>
cannam@0 481 <a class="anchor" name="8771cba75552aaa1340b68de9bf1659c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures" ref="8771cba75552aaa1340b68de9bf1659c" args="()" -->
cannam@0 482 <div class="memitem">
cannam@0 483 <div class="memproto">
cannam@0 484 <table class="memname">
cannam@0 485 <tr>
cannam@0 486 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PluginBufferingAdapter::FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures </td>
cannam@0 487 <td>(</td>
cannam@0 488 <td class="paramname"> </td>
cannam@0 489 <td>&nbsp;)&nbsp;</td>
cannam@0 490 <td width="100%"><code> [virtual]</code></td>
cannam@0 491 </tr>
cannam@0 492 </table>
cannam@0 493 </div>
cannam@0 494 <div class="memdoc">
cannam@0 495
cannam@0 496 <p>
cannam@0 497 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
cannam@0 498 <p>
cannam@0 499
cannam@0 500 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#1dce55a75a32b08fc56a52a300d9fcbe">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 501
cannam@0 502 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00275">275</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p>
cannam@0 503
cannam@0 504 <p>References <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00452">Vamp::HostExt::PluginBufferingAdapter::Impl::getRemainingFeatures()</a>, and <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p>
cannam@0 505
cannam@0 506 </div>
cannam@0 507 </div><p>
cannam@0 508 <a class="anchor" name="031aa818fd48fd0f4b5e1bf80c032870"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getInputDomain" ref="031aa818fd48fd0f4b5e1bf80c032870" args="() const " -->
cannam@0 509 <div class="memitem">
cannam@0 510 <div class="memproto">
cannam@0 511 <table class="memname">
cannam@0 512 <tr>
cannam@0 513 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Plugin::InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
cannam@0 514 <td>(</td>
cannam@0 515 <td class="paramname"> </td>
cannam@0 516 <td>&nbsp;)&nbsp;</td>
cannam@0 517 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 518 </tr>
cannam@0 519 </table>
cannam@0 520 </div>
cannam@0 521 <div class="memdoc">
cannam@0 522
cannam@0 523 <p>
cannam@0 524 Get the plugin's required input domain.
cannam@0 525 <p>
cannam@0 526 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" 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#fca78043c2843c1d45019983515e23f7" 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 527 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
cannam@0 528
cannam@0 529 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#376fa97a1c721255541fe35d71368976">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
cannam@0 530
cannam@0 531 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00074">74</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 532
cannam@0 533 <p>References <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin::getInputDomain()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 534
cannam@0 535 </div>
cannam@0 536 </div><p>
cannam@0 537 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
cannam@0 538 <div class="memitem">
cannam@0 539 <div class="memproto">
cannam@0 540 <table class="memname">
cannam@0 541 <tr>
cannam@0 542 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
cannam@0 543 <td>(</td>
cannam@0 544 <td class="paramname"> </td>
cannam@0 545 <td>&nbsp;)&nbsp;</td>
cannam@0 546 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 547 </tr>
cannam@0 548 </table>
cannam@0 549 </div>
cannam@0 550 <div class="memdoc">
cannam@0 551
cannam@0 552 <p>
cannam@0 553 Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin.
cannam@0 554 <p>
cannam@0 555
cannam@0 556 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
cannam@0 557
cannam@0 558 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00080">80</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 559
cannam@0 560 <p>References <a class="el" href="PluginBase_8h-source.html#l00067">Vamp::PluginBase::getVampApiVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 561
cannam@0 562 </div>
cannam@0 563 </div><p>
cannam@0 564 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" 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@0 569 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
cannam@0 570 <td>(</td>
cannam@0 571 <td class="paramname"> </td>
cannam@0 572 <td>&nbsp;)&nbsp;</td>
cannam@0 573 <td width="100%"> const<code> [virtual, inherited]</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 computer-usable name of the plugin.
cannam@0 581 <p>
cannam@0 582 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 583 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 584 Example: "zero_crossings"
cannam@0 585 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
cannam@0 586
cannam@0 587 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00086">86</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 588
cannam@0 589 <p>References <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 590
cannam@0 591 </div>
cannam@0 592 </div><p>
cannam@0 593 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
cannam@0 594 <div class="memitem">
cannam@0 595 <div class="memproto">
cannam@0 596 <table class="memname">
cannam@0 597 <tr>
cannam@0 598 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
cannam@0 599 <td>(</td>
cannam@0 600 <td class="paramname"> </td>
cannam@0 601 <td>&nbsp;)&nbsp;</td>
cannam@0 602 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 603 </tr>
cannam@0 604 </table>
cannam@0 605 </div>
cannam@0 606 <div class="memdoc">
cannam@0 607
cannam@0 608 <p>
cannam@0 609 Get a human-readable name or title of the plugin.
cannam@0 610 <p>
cannam@0 611 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 612 Example: "Zero Crossings"
cannam@0 613 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
cannam@0 614
cannam@0 615 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00092">92</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 616
cannam@0 617 <p>References <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 618
cannam@0 619 </div>
cannam@0 620 </div><p>
cannam@0 621 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
cannam@0 622 <div class="memitem">
cannam@0 623 <div class="memproto">
cannam@0 624 <table class="memname">
cannam@0 625 <tr>
cannam@0 626 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
cannam@0 627 <td>(</td>
cannam@0 628 <td class="paramname"> </td>
cannam@0 629 <td>&nbsp;)&nbsp;</td>
cannam@0 630 <td width="100%"> const<code> [virtual, inherited]</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 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 638 <p>
cannam@0 639 May be empty if the name has said it all already.<p>
cannam@0 640 Example: "Detect and count zero crossing points"
cannam@0 641 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
cannam@0 642
cannam@0 643 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00098">98</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 644
cannam@0 645 <p>References <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 646
cannam@0 647 </div>
cannam@0 648 </div><p>
cannam@0 649 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
cannam@0 650 <div class="memitem">
cannam@0 651 <div class="memproto">
cannam@0 652 <table class="memname">
cannam@0 653 <tr>
cannam@0 654 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
cannam@0 655 <td>(</td>
cannam@0 656 <td class="paramname"> </td>
cannam@0 657 <td>&nbsp;)&nbsp;</td>
cannam@0 658 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 659 </tr>
cannam@0 660 </table>
cannam@0 661 </div>
cannam@0 662 <div class="memdoc">
cannam@0 663
cannam@0 664 <p>
cannam@0 665 Get the name of the author or vendor of the plugin in human-readable form.
cannam@0 666 <p>
cannam@0 667 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 668 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
cannam@0 669
cannam@0 670 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00104">104</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 671
cannam@0 672 <p>References <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 673
cannam@0 674 </div>
cannam@0 675 </div><p>
cannam@0 676 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
cannam@0 677 <div class="memitem">
cannam@0 678 <div class="memproto">
cannam@0 679 <table class="memname">
cannam@0 680 <tr>
cannam@0 681 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
cannam@0 682 <td>(</td>
cannam@0 683 <td class="paramname"> </td>
cannam@0 684 <td>&nbsp;)&nbsp;</td>
cannam@0 685 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 686 </tr>
cannam@0 687 </table>
cannam@0 688 </div>
cannam@0 689 <div class="memdoc">
cannam@0 690
cannam@0 691 <p>
cannam@0 692 Get the version number of the plugin.
cannam@0 693 <p>
cannam@0 694
cannam@0 695 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
cannam@0 696
cannam@0 697 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00110">110</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 698
cannam@0 699 <p>References <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 700
cannam@0 701 </div>
cannam@0 702 </div><p>
cannam@0 703 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
cannam@0 704 <div class="memitem">
cannam@0 705 <div class="memproto">
cannam@0 706 <table class="memname">
cannam@0 707 <tr>
cannam@0 708 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
cannam@0 709 <td>(</td>
cannam@0 710 <td class="paramname"> </td>
cannam@0 711 <td>&nbsp;)&nbsp;</td>
cannam@0 712 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 713 </tr>
cannam@0 714 </table>
cannam@0 715 </div>
cannam@0 716 <div class="memdoc">
cannam@0 717
cannam@0 718 <p>
cannam@0 719 Get the copyright statement or licensing summary for the plugin.
cannam@0 720 <p>
cannam@0 721 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
cannam@0 722 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
cannam@0 723
cannam@0 724 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 725
cannam@0 726 <p>References <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 727
cannam@0 728 </div>
cannam@0 729 </div><p>
cannam@0 730 <a class="anchor" name="3b075b8f950b344503f0d27ac0fe332e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameterDescriptors" ref="3b075b8f950b344503f0d27ac0fe332e" args="() const " -->
cannam@0 731 <div class="memitem">
cannam@0 732 <div class="memproto">
cannam@0 733 <table class="memname">
cannam@0 734 <tr>
cannam@0 735 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PluginBase::ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
cannam@0 736 <td>(</td>
cannam@0 737 <td class="paramname"> </td>
cannam@0 738 <td>&nbsp;)&nbsp;</td>
cannam@0 739 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 740 </tr>
cannam@0 741 </table>
cannam@0 742 </div>
cannam@0 743 <div class="memdoc">
cannam@0 744
cannam@0 745 <p>
cannam@0 746 Get the controllable parameters of this plugin.
cannam@0 747 <p>
cannam@0 748
cannam@0 749 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
cannam@0 750
cannam@0 751 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00122">122</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 752
cannam@0 753 <p>References <a class="el" href="PluginBase_8h-source.html#l00200">Vamp::PluginBase::getParameterDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 754
cannam@0 755 </div>
cannam@0 756 </div><p>
cannam@0 757 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
cannam@0 758 <div class="memitem">
cannam@0 759 <div class="memproto">
cannam@0 760 <table class="memname">
cannam@0 761 <tr>
cannam@0 762 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
cannam@0 763 <td>(</td>
cannam@0 764 <td class="paramtype">std::string&nbsp;</td>
cannam@0 765 <td class="paramname"> </td>
cannam@0 766 <td>&nbsp;)&nbsp;</td>
cannam@0 767 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 768 </tr>
cannam@0 769 </table>
cannam@0 770 </div>
cannam@0 771 <div class="memdoc">
cannam@0 772
cannam@0 773 <p>
cannam@0 774 Get the value of a named parameter.
cannam@0 775 <p>
cannam@0 776 The argument is the identifier field from that parameter's descriptor.
cannam@0 777 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
cannam@0 778
cannam@0 779 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00128">128</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 780
cannam@0 781 <p>References <a class="el" href="PluginBase_8h-source.html#l00208">Vamp::PluginBase::getParameter()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 782
cannam@0 783 </div>
cannam@0 784 </div><p>
cannam@0 785 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
cannam@0 786 <div class="memitem">
cannam@0 787 <div class="memproto">
cannam@0 788 <table class="memname">
cannam@0 789 <tr>
cannam@0 790 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
cannam@0 791 <td>(</td>
cannam@0 792 <td class="paramtype">std::string&nbsp;</td>
cannam@0 793 <td class="paramname">, </td>
cannam@0 794 </tr>
cannam@0 795 <tr>
cannam@0 796 <td class="paramkey"></td>
cannam@0 797 <td></td>
cannam@0 798 <td class="paramtype">float&nbsp;</td>
cannam@0 799 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 800 </tr>
cannam@0 801 <tr>
cannam@0 802 <td></td>
cannam@0 803 <td>)</td>
cannam@0 804 <td></td><td></td><td width="100%"><code> [virtual, inherited]</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 Set a named parameter.
cannam@0 812 <p>
cannam@0 813 The first argument is the identifier field from that parameter's descriptor.
cannam@0 814 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
cannam@0 815
cannam@0 816 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00134">134</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 817
cannam@0 818 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00214">Vamp::PluginBase::setParameter()</a>.</p>
cannam@0 819
cannam@0 820 </div>
cannam@0 821 </div><p>
cannam@0 822 <a class="anchor" name="f3abaf717dc4b00cad5770ed6dfa01e1"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPrograms" ref="f3abaf717dc4b00cad5770ed6dfa01e1" args="() const " -->
cannam@0 823 <div class="memitem">
cannam@0 824 <div class="memproto">
cannam@0 825 <table class="memname">
cannam@0 826 <tr>
cannam@0 827 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">PluginBase::ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
cannam@0 828 <td>(</td>
cannam@0 829 <td class="paramname"> </td>
cannam@0 830 <td>&nbsp;)&nbsp;</td>
cannam@0 831 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 832 </tr>
cannam@0 833 </table>
cannam@0 834 </div>
cannam@0 835 <div class="memdoc">
cannam@0 836
cannam@0 837 <p>
cannam@0 838 Get the program settings available in this plugin.
cannam@0 839 <p>
cannam@0 840 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 841 The programs must have unique names.
cannam@0 842 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
cannam@0 843
cannam@0 844 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00140">140</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 845
cannam@0 846 <p>References <a class="el" href="PluginBase_8h-source.html#l00229">Vamp::PluginBase::getPrograms()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 847
cannam@0 848 </div>
cannam@0 849 </div><p>
cannam@0 850 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
cannam@0 851 <div class="memitem">
cannam@0 852 <div class="memproto">
cannam@0 853 <table class="memname">
cannam@0 854 <tr>
cannam@0 855 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
cannam@0 856 <td>(</td>
cannam@0 857 <td class="paramname"> </td>
cannam@0 858 <td>&nbsp;)&nbsp;</td>
cannam@0 859 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 860 </tr>
cannam@0 861 </table>
cannam@0 862 </div>
cannam@0 863 <div class="memdoc">
cannam@0 864
cannam@0 865 <p>
cannam@0 866 Get the current program.
cannam@0 867 <p>
cannam@0 868
cannam@0 869 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
cannam@0 870
cannam@0 871 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 872
cannam@0 873 <p>References <a class="el" href="PluginBase_8h-source.html#l00234">Vamp::PluginBase::getCurrentProgram()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 874
cannam@0 875 </div>
cannam@0 876 </div><p>
cannam@0 877 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
cannam@0 878 <div class="memitem">
cannam@0 879 <div class="memproto">
cannam@0 880 <table class="memname">
cannam@0 881 <tr>
cannam@0 882 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
cannam@0 883 <td>(</td>
cannam@0 884 <td class="paramtype">std::string&nbsp;</td>
cannam@0 885 <td class="paramname"> </td>
cannam@0 886 <td>&nbsp;)&nbsp;</td>
cannam@0 887 <td width="100%"><code> [virtual, inherited]</code></td>
cannam@0 888 </tr>
cannam@0 889 </table>
cannam@0 890 </div>
cannam@0 891 <div class="memdoc">
cannam@0 892
cannam@0 893 <p>
cannam@0 894 Select a program.
cannam@0 895 <p>
cannam@0 896 (If the given program name is not one of the available programs, do nothing.)
cannam@0 897 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
cannam@0 898
cannam@0 899 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 900
cannam@0 901 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00240">Vamp::PluginBase::selectProgram()</a>.</p>
cannam@0 902
cannam@0 903 </div>
cannam@0 904 </div><p>
cannam@0 905 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " -->
cannam@0 906 <div class="memitem">
cannam@0 907 <div class="memproto">
cannam@0 908 <table class="memname">
cannam@0 909 <tr>
cannam@0 910 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
cannam@0 911 <td>(</td>
cannam@0 912 <td class="paramname"> </td>
cannam@0 913 <td>&nbsp;)&nbsp;</td>
cannam@0 914 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 915 </tr>
cannam@0 916 </table>
cannam@0 917 </div>
cannam@0 918 <div class="memdoc">
cannam@0 919
cannam@0 920 <p>
cannam@0 921 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#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function).
cannam@0 922 <p>
cannam@0 923 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 924 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 925 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
cannam@0 926
cannam@0 927 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
cannam@0 928
cannam@0 929 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00164">164</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 930
cannam@0 931 <p>References <a class="el" href="Plugin_8h-source.html#l00171">Vamp::Plugin::getPreferredBlockSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 932
cannam@0 933 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">getPreferredStepSize()</a>.</p>
cannam@0 934
cannam@0 935 </div>
cannam@0 936 </div><p>
cannam@0 937 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
cannam@0 938 <div class="memitem">
cannam@0 939 <div class="memproto">
cannam@0 940 <table class="memname">
cannam@0 941 <tr>
cannam@0 942 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
cannam@0 943 <td>(</td>
cannam@0 944 <td class="paramname"> </td>
cannam@0 945 <td>&nbsp;)&nbsp;</td>
cannam@0 946 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 947 </tr>
cannam@0 948 </table>
cannam@0 949 </div>
cannam@0 950 <div class="memdoc">
cannam@0 951
cannam@0 952 <p>
cannam@0 953 Get the minimum supported number of input channels.
cannam@0 954 <p>
cannam@0 955
cannam@0 956 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
cannam@0 957
cannam@0 958 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00170">170</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 959
cannam@0 960 <p>References <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 961
cannam@0 962 </div>
cannam@0 963 </div><p>
cannam@0 964 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
cannam@0 965 <div class="memitem">
cannam@0 966 <div class="memproto">
cannam@0 967 <table class="memname">
cannam@0 968 <tr>
cannam@0 969 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
cannam@0 970 <td>(</td>
cannam@0 971 <td class="paramname"> </td>
cannam@0 972 <td>&nbsp;)&nbsp;</td>
cannam@0 973 <td width="100%"> const<code> [virtual, inherited]</code></td>
cannam@0 974 </tr>
cannam@0 975 </table>
cannam@0 976 </div>
cannam@0 977 <div class="memdoc">
cannam@0 978
cannam@0 979 <p>
cannam@0 980 Get the maximum supported number of input channels.
cannam@0 981 <p>
cannam@0 982
cannam@0 983 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
cannam@0 984
cannam@0 985 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00175">175</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
cannam@0 986
cannam@0 987 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p>
cannam@0 988
cannam@0 989 </div>
cannam@0 990 </div><p>
cannam@0 991 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
cannam@0 992 <div class="memitem">
cannam@0 993 <div class="memproto">
cannam@0 994 <table class="memname">
cannam@0 995 <tr>
cannam@0 996 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
cannam@0 997 <td>(</td>
cannam@0 998 <td class="paramname"> </td>
cannam@0 999 <td>&nbsp;)&nbsp;</td>
cannam@0 1000 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
cannam@0 1001 </tr>
cannam@0 1002 </table>
cannam@0 1003 </div>
cannam@0 1004 <div class="memdoc">
cannam@0 1005
cannam@0 1006 <p>
cannam@0 1007 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 1008 <p>
cannam@0 1009 Do not reimplement this function in your subclass.
cannam@0 1010 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
cannam@0 1011
cannam@0 1012 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 1013
cannam@0 1014 </div>
cannam@0 1015 </div><p>
cannam@0 1016 <hr><h2>Member Data Documentation</h2>
cannam@0 1017 <a class="anchor" name="51e10c9c63c0349fd74c6d604de5554e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_impl" ref="51e10c9c63c0349fd74c6d604de5554e" args="" -->
cannam@0 1018 <div class="memitem">
cannam@0 1019 <div class="memproto">
cannam@0 1020 <table class="memname">
cannam@0 1021 <tr>
cannam@0 1022 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">Vamp::HostExt::PluginBufferingAdapter::m_impl</a><code> [protected]</code> </td>
cannam@0 1023 </tr>
cannam@0 1024 </table>
cannam@0 1025 </div>
cannam@0 1026 <div class="memdoc">
cannam@0 1027
cannam@0 1028 <p>
cannam@0 1029
cannam@0 1030 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">91</a> of file <a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a>.</p>
cannam@0 1031
cannam@0 1032 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00256">getOutputDescriptors()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00275">getRemainingFeatures()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00250">initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">PluginBufferingAdapter()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00268">process()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00262">reset()</a>, and <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00244">~PluginBufferingAdapter()</a>.</p>
cannam@0 1033
cannam@0 1034 </div>
cannam@0 1035 </div><p>
cannam@0 1036 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
cannam@0 1037 <div class="memitem">
cannam@0 1038 <div class="memproto">
cannam@0 1039 <table class="memname">
cannam@0 1040 <tr>
cannam@0 1041 <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, inherited]</code> </td>
cannam@0 1042 </tr>
cannam@0 1043 </table>
cannam@0 1044 </div>
cannam@0 1045 <div class="memdoc">
cannam@0 1046
cannam@0 1047 <p>
cannam@0 1048
cannam@0 1049 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00099">99</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
cannam@0 1050
cannam@0 1051 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00116">Vamp::HostExt::PluginWrapper::getCopyright()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00146">Vamp::HostExt::PluginWrapper::getCurrentProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00098">Vamp::HostExt::PluginWrapper::getDescription()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00086">Vamp::HostExt::PluginWrapper::getIdentifier()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00074">Vamp::HostExt::PluginWrapper::getInputDomain()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00104">Vamp::HostExt::PluginWrapper::getMaker()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00175">Vamp::HostExt::PluginWrapper::getMaxChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00170">Vamp::HostExt::PluginWrapper::getMinChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00092">Vamp::HostExt::PluginWrapper::getName()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00181">Vamp::HostExt::PluginWrapper::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00128">Vamp::HostExt::PluginWrapper::getParameter()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00122">Vamp::HostExt::PluginWrapper::getParameterDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00110">Vamp::HostExt::PluginWrapper::getPluginVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00164">Vamp::HostExt::PluginWrapper::getPreferredBlockSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00158">Vamp::HostExt::PluginWrapper::getPreferredStepSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00140">Vamp::HostExt::PluginWrapper::getPrograms()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00193">Vamp::HostExt::PluginWrapper::getRemainingFeatures()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00080">Vamp::HostExt::PluginWrapper::getVampApiVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00062">Vamp::HostExt::PluginWrapper::initialise()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00187">Vamp::HostExt::PluginWrapper::process()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00068">Vamp::HostExt::PluginWrapper::reset()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00152">Vamp::HostExt::PluginWrapper::selectProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00134">Vamp::HostExt::PluginWrapper::setParameter()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00620">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00056">Vamp::HostExt::PluginWrapper::~PluginWrapper()</a>.</p>
cannam@0 1052
cannam@0 1053 </div>
cannam@0 1054 </div><p>
cannam@0 1055 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
cannam@0 1056 <div class="memitem">
cannam@0 1057 <div class="memproto">
cannam@0 1058 <table class="memname">
cannam@0 1059 <tr>
cannam@0 1060 <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 1061 </tr>
cannam@0 1062 </table>
cannam@0 1063 </div>
cannam@0 1064 <div class="memdoc">
cannam@0 1065
cannam@0 1066 <p>
cannam@0 1067
cannam@0 1068 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 1069
cannam@0 1070 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
cannam@0 1071
cannam@0 1072 </div>
cannam@0 1073 </div><p>
cannam@0 1074 <hr>The documentation for this class was generated from the following files:<ul>
cannam@0 1075 <li><a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a><li><a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a></ul>
cannam@0 1076 </div>
cannam@0 1077 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp;
cannam@0 1078 <a href="http://www.doxygen.org/index.html">
cannam@0 1079 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 1080 </body>
cannam@0 1081 </html>