Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html @ 21:cc0be37dc9d3 website

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