Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginHostAdapter.html @ 28:68ef31b9dc44 website

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