Mercurial > hg > vamp-docs
diff code-docs/classVamp_1_1Plugin.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4
Update for 2.4
| author | Chris Cannam |
|---|---|
| date | Fri, 13 Jul 2012 13:30:27 +0100 |
| parents | 3c430ef1ed66 |
| children | 27319718b1f8 |
line wrap: on
line diff
--- a/code-docs/classVamp_1_1Plugin.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1Plugin.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>VampPluginSDK: Vamp::Plugin Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -28,7 +29,7 @@ <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK -  <span id="projectnumber">2.1</span> +  <span id="projectnumber">2.4</span> </div> </td> @@ -40,7 +41,7 @@ </table> </div> -<!-- Generated by Doxygen 1.7.5.1 --> +<!-- Generated by Doxygen 1.8.0 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> @@ -80,9 +81,9 @@ <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">Vamp::Plugin Class Reference</div> </div> -</div> +</div><!--header--> <div class="contents"> -<!-- doxytag: class="Vamp::Plugin" --><!-- doxytag: inherits="Vamp::PluginBase" --> + <p><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#details">More...</a></p> @@ -99,78 +100,78 @@ <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a></td></tr> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, +<tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> }</td></tr> -<tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> +<tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> < <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">typedef std::vector< <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">typedef std::map< int, <br class="typebreak"/> +<tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector< <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr> +<tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map< int, <br class="typebreak"/> <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> +<tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> < <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> +<tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a> ()</td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">initialise</a> (size_t inputChannels, size_t stepSize, size_t blockSize)=0</td></tr> -<tr><td class="mdescLeft"> </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="#af26212cf5fc511b603a8b48034247822"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">reset</a> ()=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#aad67dc9d0052417511070c4ebcfbf24f"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">getInputDomain</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae1d317a9702cbeda65ddf0ec500c1ff6"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr> -<tr><td class="mdescLeft"> </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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#aa529adf83f87a603954eb31407602aac"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr> -<tr><td class="mdescLeft"> </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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a514c716c22f81c055f19b56c3f882567"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">getOutputDescriptors</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#ad064d5d132b5c9bd7064f429c3309e35"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#ae4aed3bebfe80a2e2fccd3d37af26996"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">getRemainingFeatures</a> ()=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#aeca2a26e658ba0314ba90d25dd2195d6"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> -<tr><td class="mdescLeft"> </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 from audio o...">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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad1c6dfc77aa03d937a885b7f08258f4a"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">getName</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a18619d5097e444ecefee0c359da53232"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">getDescription</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </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="#a59153a02364f75fff46973b2072e9e5a"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">getMaker</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a53d9918bf9ef4d12feedf66b2b26c637"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">getCopyright</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ab7e9dedbe965f5ab9018b72920fe7661"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a> () const =0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#a63f686d77bc3d6b807e7944cdde83151"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr> +<tr class="memitem:a42d3096f9c1f58b1876024cd8d9ab80b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a> ()</td></tr> +<tr class="memitem:af26212cf5fc511b603a8b48034247822"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">initialise</a> (size_t inputChannels, size_t stepSize, size_t blockSize)=0</td></tr> +<tr class="memdesc:af26212cf5fc511b603a8b48034247822"><td class="mdescLeft"> </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="#af26212cf5fc511b603a8b48034247822"></a><br/></td></tr> +<tr class="memitem:aad67dc9d0052417511070c4ebcfbf24f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">reset</a> ()=0</td></tr> +<tr class="memdesc:aad67dc9d0052417511070c4ebcfbf24f"><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#aad67dc9d0052417511070c4ebcfbf24f"></a><br/></td></tr> +<tr class="memitem:ae1d317a9702cbeda65ddf0ec500c1ff6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">getInputDomain</a> () const =0</td></tr> +<tr class="memdesc:ae1d317a9702cbeda65ddf0ec500c1ff6"><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae1d317a9702cbeda65ddf0ec500c1ff6"></a><br/></td></tr> +<tr class="memitem:aa529adf83f87a603954eb31407602aac"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr> +<tr class="memdesc:aa529adf83f87a603954eb31407602aac"><td class="mdescLeft"> </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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#aa529adf83f87a603954eb31407602aac"></a><br/></td></tr> +<tr class="memitem:a514c716c22f81c055f19b56c3f882567"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr> +<tr class="memdesc:a514c716c22f81c055f19b56c3f882567"><td class="mdescLeft"> </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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a514c716c22f81c055f19b56c3f882567"></a><br/></td></tr> +<tr class="memitem:a267b42e866df3cf0d190893e8096f525"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr> +<tr class="memdesc:a267b42e866df3cf0d190893e8096f525"><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr> +<tr class="memitem:a2c5ab12b6fa4847cb244bd1e9cb3ae5e"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr> +<tr class="memdesc:a2c5ab12b6fa4847cb244bd1e9cb3ae5e"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr> +<tr class="memitem:ad064d5d132b5c9bd7064f429c3309e35"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">getOutputDescriptors</a> () const =0</td></tr> +<tr class="memdesc:ad064d5d132b5c9bd7064f429c3309e35"><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#ad064d5d132b5c9bd7064f429c3309e35"></a><br/></td></tr> +<tr class="memitem:ae4aed3bebfe80a2e2fccd3d37af26996"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)=0</td></tr> +<tr class="memdesc:ae4aed3bebfe80a2e2fccd3d37af26996"><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#ae4aed3bebfe80a2e2fccd3d37af26996"></a><br/></td></tr> +<tr class="memitem:aeca2a26e658ba0314ba90d25dd2195d6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">getRemainingFeatures</a> ()=0</td></tr> +<tr class="memdesc:aeca2a26e658ba0314ba90d25dd2195d6"><td class="mdescLeft"> </td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#aeca2a26e658ba0314ba90d25dd2195d6"></a><br/></td></tr> +<tr class="memitem:abe13b3997a69fbcc09e2213faa352f91"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> +<tr class="memdesc:abe13b3997a69fbcc09e2213faa352f91"><td class="mdescLeft"> </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 from audio o...">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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr> +<tr class="memitem:a8fd2c48291c64b790f0efb8948508dcf"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> +<tr class="memdesc:a8fd2c48291c64b790f0efb8948508dcf"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr> +<tr class="memitem:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a> () const =0</td></tr> +<tr class="memdesc:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad1c6dfc77aa03d937a885b7f08258f4a"></a><br/></td></tr> +<tr class="memitem:a18619d5097e444ecefee0c359da53232"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">getName</a> () const =0</td></tr> +<tr class="memdesc:a18619d5097e444ecefee0c359da53232"><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a18619d5097e444ecefee0c359da53232"></a><br/></td></tr> +<tr class="memitem:a59153a02364f75fff46973b2072e9e5a"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">getDescription</a> () const =0</td></tr> +<tr class="memdesc:a59153a02364f75fff46973b2072e9e5a"><td class="mdescLeft"> </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="#a59153a02364f75fff46973b2072e9e5a"></a><br/></td></tr> +<tr class="memitem:a53d9918bf9ef4d12feedf66b2b26c637"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">getMaker</a> () const =0</td></tr> +<tr class="memdesc:a53d9918bf9ef4d12feedf66b2b26c637"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a53d9918bf9ef4d12feedf66b2b26c637"></a><br/></td></tr> +<tr class="memitem:ab7e9dedbe965f5ab9018b72920fe7661"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">getCopyright</a> () const =0</td></tr> +<tr class="memdesc:ab7e9dedbe965f5ab9018b72920fe7661"><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ab7e9dedbe965f5ab9018b72920fe7661"></a><br/></td></tr> +<tr class="memitem:a63f686d77bc3d6b807e7944cdde83151"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a> () const =0</td></tr> +<tr class="memdesc:a63f686d77bc3d6b807e7944cdde83151"><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#a63f686d77bc3d6b807e7944cdde83151"></a><br/></td></tr> +<tr class="memitem:aac3e49b3b66cacfbb768dfdf07444f21"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr> +<tr class="memdesc:aac3e49b3b66cacfbb768dfdf07444f21"><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr> +<tr class="memitem:a97ababcd45348ceec998d0f8e0f38bf7"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr> +<tr class="memdesc:a97ababcd45348ceec998d0f8e0f38bf7"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr> +<tr class="memitem:a6c718ce822f7b73b98940d59dcaa9366"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr> +<tr class="memdesc:a6c718ce822f7b73b98940d59dcaa9366"><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr> +<tr class="memitem:abb307c60bdb981d5f5af50c3c4ae84af"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> +<tr class="memdesc:abb307c60bdb981d5f5af50c3c4ae84af"><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr> +<tr class="memitem:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> +<tr class="memdesc:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr> +<tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr> +<tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a> (float inputSampleRate)</td></tr> +<tr class="memitem:a1b78c4f46c72ef345ed27f0b9bf20ac9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a> (float inputSampleRate)</td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> +<tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data. </p> @@ -178,20 +179,38 @@ <p>Note that this class inherits several abstract methods from <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. These must be implemented by the subclass.</p> <p>PLUGIN LIFECYCLE</p> <p><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> extraction plugins are managed differently from real-time plugins (such as VST effects). The main difference is that the parameters for a feature extraction plugin are configured before the plugin is used, and do not change during use.</p> -<p>1. Host constructs the plugin, passing it the input sample rate. The plugin may do basic initialisation, but should not do anything computationally expensive at this point. You must make sure your plugin is cheap to construct, otherwise you'll seriously affect the startup performance of almost all hosts. If you have serious initialisation to do, the proper place is in <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="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).">initialise()</a> (step 5).</p> -<p>2. Host may query the plugin's available outputs.</p> -<p>3. Host queries programs and parameter descriptors, and may set some or all of them. Parameters that are not explicitly set should take their default values as specified in the parameter descriptor. When a program is set, the parameter values may change and the host will re-query them to check.</p> -<p>4. Host queries the preferred step size, block size and number of channels. These may all vary depending on the parameter values. (Note however that you cannot make the number of distinct outputs dependent on parameter values.)</p> -<p>5. <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> is properly initialised with a call to initialise. This fixes the step size, block size, and number of channels, as well as all of the parameter and program settings. If the values passed in to initialise do not match the plugin's advertised preferred values from step 4, the plugin may refuse to initialise and return false (although if possible it should accept the new values). Any computationally expensive setup code should take place here.</p> -<p>6. Host finally checks the number of values, resolution, extents etc per output (which may vary depending on the number of channels, step size and block size as well as the parameter values).</p> -<p>7. Host will repeatedly call the process method to pass in blocks of input data. This method may return features extracted from that data (if the plugin is causal).</p> -<p>8. Host will call getRemainingFeatures exactly once, after all the input data has been processed. This may return any non-causal or leftover features.</p> -<p>9. At any point after initialise was called, the host may optionally call the reset method and restart processing. (This does not mean it can change the parameters, which are fixed from initialise until destruction.)</p> +<ol type="1"> +<li>Host constructs the plugin, passing it the input sample rate. The plugin may do basic initialisation, but should not do anything computationally expensive at this point. You must make sure your plugin is cheap to construct, otherwise you'll seriously affect the startup performance of almost all hosts. If you have serious initialisation to do, the proper place is in <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" title="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).">initialise()</a> (step 5).</li> +</ol> +<ol type="1"> +<li>Host may query the plugin's available outputs.</li> +</ol> +<ol type="1"> +<li>Host queries programs and parameter descriptors, and may set some or all of them. Parameters that are not explicitly set should take their default values as specified in the parameter descriptor. When a program is set, the parameter values may change and the host will re-query them to check.</li> +</ol> +<ol type="1"> +<li>Host queries the preferred step size, block size and number of channels. These may all vary depending on the parameter values. (Note however that you cannot make the number of distinct outputs dependent on parameter values.)</li> +</ol> +<ol type="1"> +<li><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> is properly initialised with a call to initialise. This fixes the step size, block size, and number of channels, as well as all of the parameter and program settings. If the values passed in to initialise do not match the plugin's advertised preferred values from step 4, the plugin may refuse to initialise and return false (although if possible it should accept the new values). Any computationally expensive setup code should take place here.</li> +</ol> +<ol type="1"> +<li>Host finally checks the number of values, resolution, extents etc per output (which may vary depending on the number of channels, step size and block size as well as the parameter values).</li> +</ol> +<ol type="1"> +<li>Host will repeatedly call the process method to pass in blocks of input data. This method may return features extracted from that data (if the plugin is causal).</li> +</ol> +<ol type="1"> +<li>Host will call getRemainingFeatures exactly once, after all the input data has been processed. This may return any non-causal or leftover features.</li> +</ol> +<ol type="1"> +<li>At any point after initialise was called, the host may optionally call the reset method and restart processing. (This does not mean it can change the parameters, which are fixed from initialise until destruction.)</li> +</ol> <p>A plugin does not need to handle the case where setParameter or selectProgram is called after initialise has been called. It's the host's responsibility not to do that. Similarly, the plugin may safely assume that initialise is called no more than once. </p> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00124">124</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> </div><hr/><h2>Member Typedef Documentation</h2> -<a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::Plugin::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> +<a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -206,7 +225,7 @@ </div> </div> -<a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::Plugin::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" --> +<a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -221,7 +240,7 @@ </div> </div> -<a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::Plugin::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" --> +<a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -236,7 +255,7 @@ </div> </div> -<a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::Plugin::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> +<a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -247,11 +266,11 @@ </div> <div class="memdoc"> -<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> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> -<a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::Plugin::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" --> +<a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -262,12 +281,12 @@ </div> <div class="memdoc"> -<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> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00221">221</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> <hr/><h2>Member Enumeration Documentation</h2> -<a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::Plugin::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" --> +<a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -278,9 +297,9 @@ </div> <div class="memdoc"> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> -<tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td> +<tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em> </td><td> </td></tr> -<tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> +<tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em> </td><td> </td></tr> </table> </dd> @@ -291,12 +310,12 @@ </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" id="a42d3096f9c1f58b1876024cd8d9ab80b"></a><!-- doxytag: member="Vamp::Plugin::~Plugin" ref="a42d3096f9c1f58b1876024cd8d9ab80b" args="()" --> +<a class="anchor" id="a42d3096f9c1f58b1876024cd8d9ab80b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual Vamp::Plugin::~Plugin </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">Vamp::Plugin::~Plugin</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> @@ -309,12 +328,12 @@ </div> </div> -<a class="anchor" id="a1b78c4f46c72ef345ed27f0b9bf20ac9"></a><!-- doxytag: member="Vamp::Plugin::Plugin" ref="a1b78c4f46c72ef345ed27f0b9bf20ac9" args="(float inputSampleRate)" --> +<a class="anchor" id="a1b78c4f46c72ef345ed27f0b9bf20ac9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">Vamp::Plugin::Plugin </td> + <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">Vamp::Plugin::Plugin</a> </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>inputSampleRate</em></td><td>)</td> @@ -329,12 +348,12 @@ </div> </div> <hr/><h2>Member Function Documentation</h2> -<a class="anchor" id="af26212cf5fc511b603a8b48034247822"></a><!-- doxytag: member="Vamp::Plugin::initialise" ref="af26212cf5fc511b603a8b48034247822" args="(size_t inputChannels, size_t stepSize, size_t blockSize)=0" --> +<a class="anchor" id="af26212cf5fc511b603a8b48034247822"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual bool Vamp::Plugin::initialise </td> + <td class="memname">virtual bool <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin::initialise</a> </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"><em>inputChannels</em>, </td> @@ -370,12 +389,12 @@ </div> </div> -<a class="anchor" id="aad67dc9d0052417511070c4ebcfbf24f"></a><!-- doxytag: member="Vamp::Plugin::reset" ref="aad67dc9d0052417511070c4ebcfbf24f" args="()=0" --> +<a class="anchor" id="aad67dc9d0052417511070c4ebcfbf24f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual void Vamp::Plugin::reset </td> + <td class="memname">virtual void <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin::reset</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [pure virtual]</code></td> @@ -391,12 +410,12 @@ </div> </div> -<a class="anchor" id="ae1d317a9702cbeda65ddf0ec500c1ff6"></a><!-- doxytag: member="Vamp::Plugin::getInputDomain" ref="ae1d317a9702cbeda65ddf0ec500c1ff6" args="() const =0" --> +<a class="anchor" id="ae1d317a9702cbeda65ddf0ec500c1ff6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::Plugin::getInputDomain </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin::getInputDomain</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual]</code></td> @@ -407,7 +426,7 @@ <p>Get the plugin's required input domain. </p> <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin.</p> -<p>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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. </p> +<p>If this is FrequencyDomain, the host will carry out a windowed <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> 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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a>. The input data for the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. </p> <p>Implemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e9d25673367c741631a60cbb36e91d2">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#ae04e0e34847a93f3444d04c802ee56ef">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#afc07a389b5f922b944b0350fd232d2eb">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a0ec2cb74c1c5f6e57d0bd9dcf7c8f469">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#aafe2ce6ebd353a14c40db7e8e60f4051">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a055689c9b41b0945e8d3cdbc3b8c3a2e">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a4f6954267696ee5bfa7dd1c4a6cfa92a">PercussionOnsetDetector</a>.</p> @@ -415,12 +434,12 @@ </div> </div> -<a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a><!-- doxytag: member="Vamp::Plugin::getPreferredBlockSize" ref="aa529adf83f87a603954eb31407602aac" args="() const " --> +<a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td> + <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin::getPreferredBlockSize</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> @@ -441,12 +460,12 @@ </div> </div> -<a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a><!-- doxytag: member="Vamp::Plugin::getPreferredStepSize" ref="a514c716c22f81c055f19b56c3f882567" args="() const " --> +<a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td> + <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin::getPreferredStepSize</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> @@ -467,12 +486,12 @@ </div> </div> -<a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a><!-- doxytag: member="Vamp::Plugin::getMinChannelCount" ref="a267b42e866df3cf0d190893e8096f525" args="() const " --> +<a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td> + <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin::getMinChannelCount</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> @@ -491,12 +510,12 @@ </div> </div> -<a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><!-- doxytag: member="Vamp::Plugin::getMaxChannelCount" ref="a2c5ab12b6fa4847cb244bd1e9cb3ae5e" args="() const " --> +<a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td> + <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin::getMaxChannelCount</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> @@ -515,12 +534,12 @@ </div> </div> -<a class="anchor" id="ad064d5d132b5c9bd7064f429c3309e35"></a><!-- doxytag: member="Vamp::Plugin::getOutputDescriptors" ref="ad064d5d132b5c9bd7064f429c3309e35" args="() const =0" --> +<a class="anchor" id="ad064d5d132b5c9bd7064f429c3309e35"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::Plugin::getOutputDescriptors </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin::getOutputDescriptors</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual]</code></td> @@ -538,12 +557,12 @@ </div> </div> -<a class="anchor" id="ae4aed3bebfe80a2e2fccd3d37af26996"></a><!-- doxytag: member="Vamp::Plugin::process" ref="ae4aed3bebfe80a2e2fccd3d37af26996" args="(const float *const *inputBuffers, RealTime timestamp)=0" --> +<a class="anchor" id="ae4aed3bebfe80a2e2fccd3d37af26996"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::Plugin::process </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin::process</a> </td> <td>(</td> <td class="paramtype">const float *const * </td> <td class="paramname"><em>inputBuffers</em>, </td> @@ -565,7 +584,7 @@ <p>Process a single block of input data. </p> <p>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> -<p>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> +<p>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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> 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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> input window (i.e. the very first block passed to process might contain the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p> <p>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.) </p> <p>Implemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#a6ff37bf754ff8711dbcb2f020fa3902c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846">Vamp::HostExt::PluginSummarisingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a1cf76b0e55cf4ed3da095cffcdeaec3c">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#adfd989812b3e0cb8f4b498f56a5a9614">PercussionOnsetDetector</a>, <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">AmplitudeFollower</a>, <a class="el" href="classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">ZeroCrossing</a>.</p> @@ -574,12 +593,12 @@ </div> </div> -<a class="anchor" id="aeca2a26e658ba0314ba90d25dd2195d6"></a><!-- doxytag: member="Vamp::Plugin::getRemainingFeatures" ref="aeca2a26e658ba0314ba90d25dd2195d6" args="()=0" --> +<a class="anchor" id="aeca2a26e658ba0314ba90d25dd2195d6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::Plugin::getRemainingFeatures </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin::getRemainingFeatures</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [pure virtual]</code></td> @@ -596,12 +615,12 @@ </div> </div> -<a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::Plugin::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " --> +<a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::Plugin::getType </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> @@ -619,12 +638,12 @@ </div> </div> -<a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="Vamp::Plugin::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " --> +<a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td> + <td class="memname">virtual unsigned int <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase::getVampApiVersion</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual, inherited]</code></td> @@ -637,18 +656,18 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> </div> </div> -<a class="anchor" id="ad1c6dfc77aa03d937a885b7f08258f4a"></a><!-- doxytag: member="Vamp::Plugin::getIdentifier" ref="ad1c6dfc77aa03d937a885b7f08258f4a" args="() const =0" --> +<a class="anchor" id="ad1c6dfc77aa03d937a885b7f08258f4a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::PluginBase::getIdentifier </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual, inherited]</code></td> @@ -668,12 +687,12 @@ </div> </div> -<a class="anchor" id="a18619d5097e444ecefee0c359da53232"></a><!-- doxytag: member="Vamp::Plugin::getName" ref="a18619d5097e444ecefee0c359da53232" args="() const =0" --> +<a class="anchor" id="a18619d5097e444ecefee0c359da53232"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::PluginBase::getName </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual, inherited]</code></td> @@ -692,12 +711,12 @@ </div> </div> -<a class="anchor" id="a59153a02364f75fff46973b2072e9e5a"></a><!-- doxytag: member="Vamp::Plugin::getDescription" ref="a59153a02364f75fff46973b2072e9e5a" args="() const =0" --> +<a class="anchor" id="a59153a02364f75fff46973b2072e9e5a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::PluginBase::getDescription </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual, inherited]</code></td> @@ -716,12 +735,12 @@ </div> </div> -<a class="anchor" id="a53d9918bf9ef4d12feedf66b2b26c637"></a><!-- doxytag: member="Vamp::Plugin::getMaker" ref="a53d9918bf9ef4d12feedf66b2b26c637" args="() const =0" --> +<a class="anchor" id="a53d9918bf9ef4d12feedf66b2b26c637"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::PluginBase::getMaker </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual, inherited]</code></td> @@ -739,12 +758,12 @@ </div> </div> -<a class="anchor" id="ab7e9dedbe965f5ab9018b72920fe7661"></a><!-- doxytag: member="Vamp::Plugin::getCopyright" ref="ab7e9dedbe965f5ab9018b72920fe7661" args="() const =0" --> +<a class="anchor" id="ab7e9dedbe965f5ab9018b72920fe7661"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::PluginBase::getCopyright </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual, inherited]</code></td> @@ -762,12 +781,12 @@ </div> </div> -<a class="anchor" id="a63f686d77bc3d6b807e7944cdde83151"></a><!-- doxytag: member="Vamp::Plugin::getPluginVersion" ref="a63f686d77bc3d6b807e7944cdde83151" args="() const =0" --> +<a class="anchor" id="a63f686d77bc3d6b807e7944cdde83151"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual int Vamp::PluginBase::getPluginVersion </td> + <td class="memname">virtual int <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [pure virtual, inherited]</code></td> @@ -784,12 +803,12 @@ </div> </div> -<a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="Vamp::Plugin::getParameterDescriptors" ref="aac3e49b3b66cacfbb768dfdf07444f21" args="() const " --> +<a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase::getParameterDescriptors</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual, inherited]</code></td> @@ -802,18 +821,18 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00208">208</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> </div> </div> -<a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="Vamp::Plugin::getParameter" ref="a97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " --> +<a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual float Vamp::PluginBase::getParameter </td> + <td class="memname">virtual float <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase::getParameter</a> </td> <td>(</td> <td class="paramtype">std::string </td> <td class="paramname"></td><td>)</td> @@ -828,16 +847,16 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00216">216</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00212">212</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> -<a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="Vamp::Plugin::setParameter" ref="a6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" --> +<a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual void Vamp::PluginBase::setParameter </td> + <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase::setParameter</a> </td> <td>(</td> <td class="paramtype">std::string </td> <td class="paramname">, </td> @@ -862,16 +881,16 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00222">222</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00218">218</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> -<a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="Vamp::Plugin::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " --> +<a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase::getPrograms</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual, inherited]</code></td> @@ -886,16 +905,16 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00233">233</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> -<a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="Vamp::Plugin::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " --> +<a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td> + <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase::getCurrentProgram</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual, inherited]</code></td> @@ -908,16 +927,16 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00238">238</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> -<a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="Vamp::Plugin::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" --> +<a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual void Vamp::PluginBase::selectProgram </td> + <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase::selectProgram</a> </td> <td>(</td> <td class="paramtype">std::string </td> <td class="paramname"></td><td>)</td> @@ -932,12 +951,12 @@ <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00244">244</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> -<a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::Plugin::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" --> +<a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -957,16 +976,16 @@ <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li> </ul> -</div> +</div><!-- contents --> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> <li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> </li> - <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by + <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> </ul> </div>