Mercurial > hg > vamp-website
comparison code-doc/classVamp_1_1HostExt_1_1PluginBufferingAdapter.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
author | cannam |
---|---|
date | Tue, 09 Dec 2008 11:02:57 +0000 |
parents | 351c4ebce5f9 |
children | 0976232e353b |
comparison
equal
deleted
inserted
replaced
20:34e758355884 | 21:cc0be37dc9d3 |
---|---|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> | 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 <title>VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference</title> | 3 <title>VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference</title> |
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> | 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> |
5 <link href="tabs.css" rel="stylesheet" type="text/css"> | 5 <link href="tabs.css" rel="stylesheet" type="text/css"> |
6 </head><body> | 6 </head><body> |
7 <!-- Generated by Doxygen 1.5.5 --> | 7 <!-- Generated by Doxygen 1.5.6 --> |
8 <div class="navigation" id="top"> | 8 <div class="navigation" id="top"> |
9 <div class="tabs"> | 9 <div class="tabs"> |
10 <ul> | 10 <ul> |
11 <li><a href="main.html"><span>Main Page</span></a></li> | 11 <li><a href="main.html"><span>Main Page</span></a></li> |
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> | 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
24 </div> | 24 </div> |
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">PluginBufferingAdapter</a> | 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">PluginBufferingAdapter</a> |
26 </div> | 26 </div> |
27 </div> | 27 </div> |
28 <div class="contents"> | 28 <div class="contents"> |
29 <h1>Vamp::HostExt::PluginBufferingAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginBufferingAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><code>#include <<a class="el" href="PluginBufferingAdapter_8h-source.html">vamp-sdk/hostext/PluginBufferingAdapter.h</a>></code> | 29 <h1>Vamp::HostExt::PluginBufferingAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginBufferingAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><code>#include <<a class="el" href="PluginBufferingAdapter_8h-source.html">vamp-hostsdk/PluginBufferingAdapter.h</a>></code> |
30 <p> | 30 <p> |
31 <div class="dynheader"> | 31 <div class="dynheader"> |
32 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div> | 32 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div> |
33 <div class="dynsection"> | 33 <div class="dynsection"> |
34 <p><center><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map" alt="Inheritance graph"></center> | 34 <p><center><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map" alt="Inheritance graph"></center> |
35 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map"> | 35 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map"> |
36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="31,156,231,180"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="81,81,180,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="67,6,195,30"></map> | 36 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="29,154,229,181"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="80,80,179,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="65,5,193,32"></map> |
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> | 37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> |
38 | 38 |
39 <p> | 39 <p> |
40 <a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> | 40 <a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> |
41 <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. | 41 <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. |
42 <p> | 42 <p> |
43 A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.<p> | 43 A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.<p> |
44 If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.<p> | 44 If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.<p> |
45 In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted. | 45 In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted. |
46 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h-source.html#l00072">72</a> of file <a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a>.</p> | 46 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h-source.html#l00075">75</a> of file <a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a>.</p> |
47 <table border="0" cellpadding="0" cellspacing="0"> | 47 <table border="0" cellpadding="0" cellspacing="0"> |
48 <tr><td></td></tr> | 48 <tr><td></td></tr> |
49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> | 49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </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>, | 50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </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>, |
51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> | 51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> |
65 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> | 65 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> |
66 | 66 |
67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | 67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
68 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> | 68 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> |
69 | 69 |
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#539423b54a4ede511476125f4a97d977">~PluginBufferingAdapter</a> ()</td></tr> | 70 <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> wrapping the given plugin. <a href="#1276bcfcbe1414b33eeefbd7b2b702fe"></a><br></td></tr> |
71 | 71 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#96263f7b0910a10eeae86f20db007e55">~PluginBufferingAdapter</a> ()</td></tr> |
72 | |
73 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">getPreferredStepSize</a> () const </td></tr> | |
74 | |
75 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred step size for this adapter. <a href="#2e66d009df69c951001e5d2786973d60"></a><br></td></tr> | |
76 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">getPreferredBlockSize</a> () const </td></tr> | |
77 | |
78 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred block size for this adapter. <a href="#21e45180b19873f9ab69fe7a4e184a03"></a><br></td></tr> | |
72 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> | 79 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> |
73 | 80 |
74 <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="#9e7798ba4d7870db46502ab541ab37a8"></a><br></td></tr> | 81 <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the adapter (and therefore the plugin) for the given number of channels. <a href="#9e7798ba4d7870db46502ab541ab37a8"></a><br></td></tr> |
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">getPreferredStepSize</a> () const </td></tr> | 82 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#d7fad500331808b5cdf90f5a45019b02">getPluginPreferredStepSize</a> () const </td></tr> |
76 | 83 |
77 <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_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#2e66d009df69c951001e5d2786973d60"></a><br></td></tr> | 84 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred step size of the plugin wrapped by this adapter. <a href="#d7fad500331808b5cdf90f5a45019b02"></a><br></td></tr> |
78 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#85a027f5859efb31d315205e234e94c0">getOutputDescriptors</a> () const </td></tr> | 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7045be875de9dd226d2e2a222e957de0">getPluginPreferredBlockSize</a> () const </td></tr> |
79 | 86 |
80 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#85a027f5859efb31d315205e234e94c0"></a><br></td></tr> | 87 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred block size of the plugin wrapped by this adapter. <a href="#7045be875de9dd226d2e2a222e957de0"></a><br></td></tr> |
88 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#c99898d78a01a7fad4def4d6c5fd3a7e">setPluginStepSize</a> (size_t stepSize)</td></tr> | |
89 | |
90 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a> is called. <a href="#c99898d78a01a7fad4def4d6c5fd3a7e"></a><br></td></tr> | |
91 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a80ae1bff6f95e805811df2c3770a98c">setPluginBlockSize</a> (size_t blockSize)</td></tr> | |
92 | |
93 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a> is called. <a href="#a80ae1bff6f95e805811df2c3770a98c"></a><br></td></tr> | |
94 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a065985fd864f6869d1bc7fea6fa2ece">getActualStepAndBlockSizes</a> (size_t &stepSize, size_t &blockSize)</td></tr> | |
95 | |
96 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the step and block sizes that were actually used when initialising the underlying plugin. <a href="#a065985fd864f6869d1bc7fea6fa2ece"></a><br></td></tr> | |
97 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">setParameter</a> (std::string, float)</td></tr> | |
98 | |
99 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#7a979b20c169d37adbd7b7d8b8a077b3"></a><br></td></tr> | |
100 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">selectProgram</a> (std::string)</td></tr> | |
101 | |
102 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#3cc7000e0aff525950e0a286b87f8927"></a><br></td></tr> | |
103 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">getOutputDescriptors</a> () const </td></tr> | |
104 | |
105 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#f8cc914897a284433de220f1153f3845"></a><br></td></tr> | |
81 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">reset</a> ()</td></tr> | 106 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">reset</a> ()</td></tr> |
82 | 107 |
83 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#131fd9fe8a1795d7370d8a721176868a"></a><br></td></tr> | 108 <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#131fd9fe8a1795d7370d8a721176868a"></a><br></td></tr> |
84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> | 109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#55058a20c1f8bffc0dc927350df778a0">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> |
85 | 110 |
86 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#262206b978d9de28ee4bb35f437e915e"></a><br></td></tr> | 111 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#55058a20c1f8bffc0dc927350df778a0"></a><br></td></tr> |
87 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#8771cba75552aaa1340b68de9bf1659c">getRemainingFeatures</a> ()</td></tr> | 112 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#28423951b2eda1a1fc371485434f417b">getRemainingFeatures</a> ()</td></tr> |
88 | 113 |
89 <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="#8771cba75552aaa1340b68de9bf1659c"></a><br></td></tr> | 114 <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="#28423951b2eda1a1fc371485434f417b"></a><br></td></tr> |
90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#031aa818fd48fd0f4b5e1bf80c032870">getInputDomain</a> () const </td></tr> | 115 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr> |
91 | 116 |
92 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#031aa818fd48fd0f4b5e1bf80c032870"></a><br></td></tr> | 117 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#e203faf8384c9e1fddc381409aa8a214"></a><br></td></tr> |
93 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr> | 118 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr> |
94 | 119 |
95 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr> | 120 <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="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr> |
96 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr> | 121 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr> |
97 | 122 |
98 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr> | 123 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr> |
99 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr> | 124 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr> |
100 | 125 |
109 | 134 |
110 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr> | 135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr> |
111 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr> | 136 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr> |
112 | 137 |
113 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr> | 138 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr> |
114 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#3b075b8f950b344503f0d27ac0fe332e">getParameterDescriptors</a> () const </td></tr> | 139 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr> |
115 | 140 |
116 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#3b075b8f950b344503f0d27ac0fe332e"></a><br></td></tr> | 141 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr> |
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr> | 142 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr> |
118 | 143 |
119 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr> | 144 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr> |
120 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr> | 145 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr> |
121 | 146 |
122 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr> | 147 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr> |
123 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">getPrograms</a> () const </td></tr> | |
124 | |
125 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#f3abaf717dc4b00cad5770ed6dfa01e1"></a><br></td></tr> | |
126 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr> | 148 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr> |
127 | 149 |
128 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr> | 150 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr> |
129 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr> | |
130 | |
131 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr> | |
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr> | |
133 | |
134 <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_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr> | |
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr> | 151 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr> |
136 | 152 |
137 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr> | 153 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr> |
138 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr> | 154 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr> |
139 | 155 |
140 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr> | 156 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr> |
157 <tr><td class="memTemplParams" nowrap colspan="2">template<typename WrapperType> </td></tr> | |
158 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">WrapperType * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">getWrapper</a> ()</td></tr> | |
159 | |
160 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#e9d79bed7237d55a73018a6b982a55b3"></a><br></td></tr> | |
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> | 161 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> |
142 | 162 |
143 <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...">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> | 163 <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...">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> |
144 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> | 164 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
145 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">m_impl</a></td></tr> | 165 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">m_impl</a></td></tr> |
146 | 166 |
147 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr> | 167 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr> |
148 | 168 |
149 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> | 169 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> |
150 | |
151 <tr><td colspan="2"><br><h2>Classes</h2></td></tr> | |
152 <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a></td></tr> | |
153 | 170 |
154 </table> | 171 </table> |
155 <hr><h2>Member Typedef Documentation</h2> | 172 <hr><h2>Member Typedef Documentation</h2> |
156 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> | 173 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> |
157 <div class="memitem"> | 174 <div class="memitem"> |
164 </div> | 181 </div> |
165 <div class="memdoc"> | 182 <div class="memdoc"> |
166 | 183 |
167 <p> | 184 <p> |
168 | 185 |
169 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 186 <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> |
170 | 187 |
171 </div> | 188 </div> |
172 </div><p> | 189 </div><p> |
173 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> | 190 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> |
174 <div class="memitem"> | 191 <div class="memitem"> |
181 </div> | 198 </div> |
182 <div class="memdoc"> | 199 <div class="memdoc"> |
183 | 200 |
184 <p> | 201 <p> |
185 | 202 |
186 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 203 <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> |
187 | 204 |
188 </div> | 205 </div> |
189 </div><p> | 206 </div><p> |
190 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> | 207 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> |
191 <div class="memitem"> | 208 <div class="memitem"> |
198 </div> | 215 </div> |
199 <div class="memdoc"> | 216 <div class="memdoc"> |
200 | 217 |
201 <p> | 218 <p> |
202 | 219 |
203 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 220 <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> |
204 | 221 |
205 </div> | 222 </div> |
206 </div><p> | 223 </div><p> |
207 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> | 224 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> |
208 <div class="memitem"> | 225 <div class="memitem"> |
215 </div> | 232 </div> |
216 <div class="memdoc"> | 233 <div class="memdoc"> |
217 | 234 |
218 <p> | 235 <p> |
219 | 236 |
220 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 237 <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> |
221 | 238 |
222 </div> | 239 </div> |
223 </div><p> | 240 </div><p> |
224 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> | 241 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> |
225 <div class="memitem"> | 242 <div class="memitem"> |
232 </div> | 249 </div> |
233 <div class="memdoc"> | 250 <div class="memdoc"> |
234 | 251 |
235 <p> | 252 <p> |
236 | 253 |
237 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> | 254 <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> |
238 | 255 |
239 </div> | 256 </div> |
240 </div><p> | 257 </div><p> |
241 <hr><h2>Member Enumeration Documentation</h2> | 258 <hr><h2>Member Enumeration Documentation</h2> |
242 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> | 259 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> |
258 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> | 275 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td> |
259 </td></tr> | 276 </td></tr> |
260 </table> | 277 </table> |
261 </dl> | 278 </dl> |
262 | 279 |
263 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 280 <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> |
264 | 281 |
265 </div> | 282 </div> |
266 </div><p> | 283 </div><p> |
267 <hr><h2>Constructor & Destructor Documentation</h2> | 284 <hr><h2>Constructor & Destructor Documentation</h2> |
268 <a class="anchor" name="1276bcfcbe1414b33eeefbd7b2b702fe"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter" ref="1276bcfcbe1414b33eeefbd7b2b702fe" args="(Plugin *plugin)" --> | 285 <a class="anchor" name="1276bcfcbe1414b33eeefbd7b2b702fe"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter" ref="1276bcfcbe1414b33eeefbd7b2b702fe" args="(Plugin *plugin)" --> |
273 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter </td> | 290 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter </td> |
274 <td>(</td> | 291 <td>(</td> |
275 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td> | 292 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td> |
276 <td class="paramname"> <em>plugin</em> </td> | 293 <td class="paramname"> <em>plugin</em> </td> |
277 <td> ) </td> | 294 <td> ) </td> |
278 <td width="100%"></td> | 295 <td></td> |
279 </tr> | 296 </tr> |
280 </table> | 297 </table> |
281 </div> | 298 </div> |
282 <div class="memdoc"> | 299 <div class="memdoc"> |
283 | 300 |
284 <p> | 301 <p> |
285 | 302 Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> wrapping the given plugin. |
286 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">238</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | 303 <p> |
287 | 304 The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. |
288 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>, and <a class="el" href="Plugin_8h-source.html#l00397">Vamp::Plugin::m_inputSampleRate</a>.</p> | 305 </div> |
289 | 306 </div><p> |
290 </div> | 307 <a class="anchor" name="96263f7b0910a10eeae86f20db007e55"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter" ref="96263f7b0910a10eeae86f20db007e55" args="()" --> |
291 </div><p> | 308 <div class="memitem"> |
292 <a class="anchor" name="539423b54a4ede511476125f4a97d977"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter" ref="539423b54a4ede511476125f4a97d977" args="()" --> | 309 <div class="memproto"> |
293 <div class="memitem"> | 310 <table class="memname"> |
294 <div class="memproto"> | 311 <tr> |
295 <table class="memname"> | 312 <td class="memname">virtual Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter </td> |
296 <tr> | 313 <td>(</td> |
297 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter </td> | 314 <td class="paramname"> </td> |
298 <td>(</td> | 315 <td> ) </td> |
299 <td class="paramname"> </td> | 316 <td><code> [virtual]</code></td> |
300 <td> ) </td> | 317 </tr> |
301 <td width="100%"><code> [virtual]</code></td> | 318 </table> |
302 </tr> | 319 </div> |
303 </table> | 320 <div class="memdoc"> |
304 </div> | 321 |
305 <div class="memdoc"> | 322 <p> |
306 | |
307 <p> | |
308 | |
309 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00244">244</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | |
310 | |
311 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p> | |
312 | 323 |
313 </div> | 324 </div> |
314 </div><p> | 325 </div><p> |
315 <hr><h2>Member Function Documentation</h2> | 326 <hr><h2>Member Function Documentation</h2> |
327 <a class="anchor" name="2e66d009df69c951001e5d2786973d60"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize" ref="2e66d009df69c951001e5d2786973d60" args="() const " --> | |
328 <div class="memitem"> | |
329 <div class="memproto"> | |
330 <table class="memname"> | |
331 <tr> | |
332 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize </td> | |
333 <td>(</td> | |
334 <td class="paramname"> </td> | |
335 <td> ) </td> | |
336 <td> const<code> [virtual]</code></td> | |
337 </tr> | |
338 </table> | |
339 </div> | |
340 <div class="memdoc"> | |
341 | |
342 <p> | |
343 Return the preferred step size for this adapter. | |
344 <p> | |
345 Because of the way this adapter works, its preferred step size will always be the same as its preferred block size. This may or may not be the same as the preferred step size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#d7fad500331808b5cdf90f5a45019b02" title="Return the preferred step size of the plugin wrapped by this adapter.">getPluginPreferredStepSize()</a>. | |
346 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p> | |
347 | |
348 </div> | |
349 </div><p> | |
350 <a class="anchor" name="21e45180b19873f9ab69fe7a4e184a03"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize" ref="21e45180b19873f9ab69fe7a4e184a03" args="() const " --> | |
351 <div class="memitem"> | |
352 <div class="memproto"> | |
353 <table class="memname"> | |
354 <tr> | |
355 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize </td> | |
356 <td>(</td> | |
357 <td class="paramname"> </td> | |
358 <td> ) </td> | |
359 <td> const<code> [virtual]</code></td> | |
360 </tr> | |
361 </table> | |
362 </div> | |
363 <div class="memdoc"> | |
364 | |
365 <p> | |
366 Return the preferred block size for this adapter. | |
367 <p> | |
368 This may or may not be the same as the preferred block size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7045be875de9dd226d2e2a222e957de0" title="Return the preferred block size of the plugin wrapped by this adapter.">getPluginPreferredBlockSize()</a>.<p> | |
369 Note that this adapter may be initialised with any block size, not just its supposedly preferred one. | |
370 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p> | |
371 | |
372 </div> | |
373 </div><p> | |
316 <a class="anchor" name="9e7798ba4d7870db46502ab541ab37a8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::initialise" ref="9e7798ba4d7870db46502ab541ab37a8" args="(size_t channels, size_t stepSize, size_t blockSize)" --> | 374 <a class="anchor" name="9e7798ba4d7870db46502ab541ab37a8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::initialise" ref="9e7798ba4d7870db46502ab541ab37a8" args="(size_t channels, size_t stepSize, size_t blockSize)" --> |
317 <div class="memitem"> | 375 <div class="memitem"> |
318 <div class="memproto"> | 376 <div class="memproto"> |
319 <table class="memname"> | 377 <table class="memname"> |
320 <tr> | 378 <tr> |
321 <td class="memname">bool Vamp::HostExt::PluginBufferingAdapter::initialise </td> | 379 <td class="memname">bool Vamp::HostExt::PluginBufferingAdapter::initialise </td> |
322 <td>(</td> | 380 <td>(</td> |
323 <td class="paramtype">size_t </td> | 381 <td class="paramtype">size_t </td> |
324 <td class="paramname"> <em>inputChannels</em>, </td> | 382 <td class="paramname"> <em>channels</em>, </td> |
325 </tr> | 383 </tr> |
326 <tr> | 384 <tr> |
327 <td class="paramkey"></td> | 385 <td class="paramkey"></td> |
328 <td></td> | 386 <td></td> |
329 <td class="paramtype">size_t </td> | 387 <td class="paramtype">size_t </td> |
336 <td class="paramname"> <em>blockSize</em></td><td> </td> | 394 <td class="paramname"> <em>blockSize</em></td><td> </td> |
337 </tr> | 395 </tr> |
338 <tr> | 396 <tr> |
339 <td></td> | 397 <td></td> |
340 <td>)</td> | 398 <td>)</td> |
341 <td></td><td></td><td width="100%"><code> [virtual]</code></td> | 399 <td></td><td></td><td><code> [virtual]</code></td> |
342 </tr> | 400 </tr> |
343 </table> | 401 </table> |
344 </div> | 402 </div> |
345 <div class="memdoc"> | 403 <div class="memdoc"> |
346 | 404 |
347 <p> | 405 <p> |
348 Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). | 406 Initialise the adapter (and therefore the plugin) for the given number of channels. |
349 <p> | 407 <p> |
350 The input sample rate should have been already specified at construction time.<p> | 408 Initialise the adapter for the given step and block size, which must be equal.<p> |
351 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. | 409 The step and block size used for the underlying plugin will depend on its preferences, or any values previously passed to setPluginStepSize and setPluginBlockSize. |
352 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p> | 410 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p> |
353 | 411 |
354 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00250">250</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | 412 </div> |
355 | 413 </div><p> |
356 <p>References <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00314">Vamp::HostExt::PluginBufferingAdapter::Impl::initialise()</a>, and <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p> | 414 <a class="anchor" name="d7fad500331808b5cdf90f5a45019b02"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize" ref="d7fad500331808b5cdf90f5a45019b02" args="() const " --> |
357 | 415 <div class="memitem"> |
358 </div> | 416 <div class="memproto"> |
359 </div><p> | 417 <table class="memname"> |
360 <a class="anchor" name="2e66d009df69c951001e5d2786973d60"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize" ref="2e66d009df69c951001e5d2786973d60" args="() const " --> | 418 <tr> |
361 <div class="memitem"> | 419 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize </td> |
362 <div class="memproto"> | 420 <td>(</td> |
363 <table class="memname"> | 421 <td class="paramname"> </td> |
364 <tr> | 422 <td> ) </td> |
365 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize </td> | 423 <td> const</td> |
366 <td>(</td> | 424 </tr> |
367 <td class="paramname"> </td> | 425 </table> |
368 <td> ) </td> | 426 </div> |
369 <td width="100%"> const<code> [virtual]</code></td> | 427 <div class="memdoc"> |
370 </tr> | 428 |
371 </table> | 429 <p> |
372 </div> | 430 Return the preferred step size of the plugin wrapped by this adapter. |
373 <div class="memdoc"> | 431 <p> |
374 | 432 This is included mainly for informational purposes. This value is not likely to be a valid step size for the adapter itself, and it is not usually of any use in interpreting the results (because the adapter re-writes OneSamplePerStep outputs to FixedSampleRate so that the hop size no longer needs to be known beforehand in order to interpret them). |
375 <p> | 433 </div> |
376 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" title="Process a single block of input data.">process()</a> function) for the plugin. | 434 </div><p> |
377 <p> | 435 <a class="anchor" name="7045be875de9dd226d2e2a222e957de0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize" ref="7045be875de9dd226d2e2a222e957de0" args="() const " --> |
378 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> | 436 <div class="memitem"> |
379 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. | 437 <div class="memproto"> |
380 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p> | 438 <table class="memname"> |
381 | 439 <tr> |
382 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">308</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | 440 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize </td> |
383 | 441 <td>(</td> |
384 <p>References <a class="el" href="PluginWrapper_8cpp-source.html#l00164">Vamp::HostExt::PluginWrapper::getPreferredBlockSize()</a>.</p> | 442 <td class="paramname"> </td> |
385 | 443 <td> ) </td> |
386 </div> | 444 <td> const</td> |
387 </div><p> | 445 </tr> |
388 <a class="anchor" name="85a027f5859efb31d315205e234e94c0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors" ref="85a027f5859efb31d315205e234e94c0" args="() const " --> | 446 </table> |
389 <div class="memitem"> | 447 </div> |
390 <div class="memproto"> | 448 <div class="memdoc"> |
391 <table class="memname"> | 449 |
392 <tr> | 450 <p> |
393 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PluginBufferingAdapter::OutputList</a> Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors </td> | 451 Return the preferred block size of the plugin wrapped by this adapter. |
394 <td>(</td> | 452 <p> |
395 <td class="paramname"> </td> | 453 This is included mainly for informational purposes. |
396 <td> ) </td> | 454 </div> |
397 <td width="100%"> const<code> [virtual]</code></td> | 455 </div><p> |
456 <a class="anchor" name="c99898d78a01a7fad4def4d6c5fd3a7e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize" ref="c99898d78a01a7fad4def4d6c5fd3a7e" args="(size_t stepSize)" --> | |
457 <div class="memitem"> | |
458 <div class="memproto"> | |
459 <table class="memname"> | |
460 <tr> | |
461 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize </td> | |
462 <td>(</td> | |
463 <td class="paramtype">size_t </td> | |
464 <td class="paramname"> <em>stepSize</em> </td> | |
465 <td> ) </td> | |
466 <td></td> | |
467 </tr> | |
468 </table> | |
469 </div> | |
470 <div class="memdoc"> | |
471 | |
472 <p> | |
473 Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a> is called. | |
474 <p> | |
475 If this is not set, the plugin's own preferred step size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a>. | |
476 </div> | |
477 </div><p> | |
478 <a class="anchor" name="a80ae1bff6f95e805811df2c3770a98c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize" ref="a80ae1bff6f95e805811df2c3770a98c" args="(size_t blockSize)" --> | |
479 <div class="memitem"> | |
480 <div class="memproto"> | |
481 <table class="memname"> | |
482 <tr> | |
483 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize </td> | |
484 <td>(</td> | |
485 <td class="paramtype">size_t </td> | |
486 <td class="paramname"> <em>blockSize</em> </td> | |
487 <td> ) </td> | |
488 <td></td> | |
489 </tr> | |
490 </table> | |
491 </div> | |
492 <div class="memdoc"> | |
493 | |
494 <p> | |
495 Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a> is called. | |
496 <p> | |
497 If this is not set, the plugin's own preferred block size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a>. | |
498 </div> | |
499 </div><p> | |
500 <a class="anchor" name="a065985fd864f6869d1bc7fea6fa2ece"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes" ref="a065985fd864f6869d1bc7fea6fa2ece" args="(size_t &stepSize, size_t &blockSize)" --> | |
501 <div class="memitem"> | |
502 <div class="memproto"> | |
503 <table class="memname"> | |
504 <tr> | |
505 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes </td> | |
506 <td>(</td> | |
507 <td class="paramtype">size_t & </td> | |
508 <td class="paramname"> <em>stepSize</em>, </td> | |
509 </tr> | |
510 <tr> | |
511 <td class="paramkey"></td> | |
512 <td></td> | |
513 <td class="paramtype">size_t & </td> | |
514 <td class="paramname"> <em>blockSize</em></td><td> </td> | |
515 </tr> | |
516 <tr> | |
517 <td></td> | |
518 <td>)</td> | |
519 <td></td><td></td><td></td> | |
520 </tr> | |
521 </table> | |
522 </div> | |
523 <div class="memdoc"> | |
524 | |
525 <p> | |
526 Return the step and block sizes that were actually used when initialising the underlying plugin. | |
527 <p> | |
528 This is included mainly for informational purposes. You will not usually need to call this function. If this is called before <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a>, it will return 0 for both values. If it is called after a failed call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a>, it will return the values that were used in the failed call to the plugin's <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels...">initialise()</a> function. | |
529 </div> | |
530 </div><p> | |
531 <a class="anchor" name="7a979b20c169d37adbd7b7d8b8a077b3"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setParameter" ref="7a979b20c169d37adbd7b7d8b8a077b3" args="(std::string, float)" --> | |
532 <div class="memitem"> | |
533 <div class="memproto"> | |
534 <table class="memname"> | |
535 <tr> | |
536 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setParameter </td> | |
537 <td>(</td> | |
538 <td class="paramtype">std::string </td> | |
539 <td class="paramname">, </td> | |
540 </tr> | |
541 <tr> | |
542 <td class="paramkey"></td> | |
543 <td></td> | |
544 <td class="paramtype">float </td> | |
545 <td class="paramname"></td><td> </td> | |
546 </tr> | |
547 <tr> | |
548 <td></td> | |
549 <td>)</td> | |
550 <td></td><td></td><td><code> [virtual]</code></td> | |
551 </tr> | |
552 </table> | |
553 </div> | |
554 <div class="memdoc"> | |
555 | |
556 <p> | |
557 Set a named parameter. | |
558 <p> | |
559 The first argument is the identifier field from that parameter's descriptor. | |
560 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>.</p> | |
561 | |
562 </div> | |
563 </div><p> | |
564 <a class="anchor" name="3cc7000e0aff525950e0a286b87f8927"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::selectProgram" ref="3cc7000e0aff525950e0a286b87f8927" args="(std::string)" --> | |
565 <div class="memitem"> | |
566 <div class="memproto"> | |
567 <table class="memname"> | |
568 <tr> | |
569 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::selectProgram </td> | |
570 <td>(</td> | |
571 <td class="paramtype">std::string </td> | |
572 <td class="paramname"> </td> | |
573 <td> ) </td> | |
574 <td><code> [virtual]</code></td> | |
575 </tr> | |
576 </table> | |
577 </div> | |
578 <div class="memdoc"> | |
579 | |
580 <p> | |
581 Select a program. | |
582 <p> | |
583 (If the given program name is not one of the available programs, do nothing.) | |
584 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> | |
585 | |
586 </div> | |
587 </div><p> | |
588 <a class="anchor" name="f8cc914897a284433de220f1153f3845"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors" ref="f8cc914897a284433de220f1153f3845" args="() const " --> | |
589 <div class="memitem"> | |
590 <div class="memproto"> | |
591 <table class="memname"> | |
592 <tr> | |
593 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors </td> | |
594 <td>(</td> | |
595 <td class="paramname"> </td> | |
596 <td> ) </td> | |
597 <td> const<code> [virtual]</code></td> | |
398 </tr> | 598 </tr> |
399 </table> | 599 </table> |
400 </div> | 600 </div> |
401 <div class="memdoc"> | 601 <div class="memdoc"> |
402 | 602 |
403 <p> | 603 <p> |
404 Get the outputs of this plugin. | 604 Get the outputs of this plugin. |
405 <p> | 605 <p> |
406 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e" title="Process a single block of input data.">process()</a> call. | 606 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#55058a20c1f8bffc0dc927350df778a0" title="Process a single block of input data.">process()</a> call. |
407 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#02c8c01972affeea58b091335e791ace">Vamp::HostExt::PluginWrapper</a>.</p> | 607 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">Vamp::HostExt::PluginWrapper</a>.</p> |
408 | |
409 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00256">256</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | |
410 | |
411 <p>References <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00367">Vamp::HostExt::PluginBufferingAdapter::Impl::getOutputDescriptors()</a>, and <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p> | |
412 | 608 |
413 </div> | 609 </div> |
414 </div><p> | 610 </div><p> |
415 <a class="anchor" name="131fd9fe8a1795d7370d8a721176868a"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::reset" ref="131fd9fe8a1795d7370d8a721176868a" args="()" --> | 611 <a class="anchor" name="131fd9fe8a1795d7370d8a721176868a"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::reset" ref="131fd9fe8a1795d7370d8a721176868a" args="()" --> |
416 <div class="memitem"> | 612 <div class="memitem"> |
419 <tr> | 615 <tr> |
420 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::reset </td> | 616 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::reset </td> |
421 <td>(</td> | 617 <td>(</td> |
422 <td class="paramname"> </td> | 618 <td class="paramname"> </td> |
423 <td> ) </td> | 619 <td> ) </td> |
424 <td width="100%"><code> [virtual]</code></td> | 620 <td><code> [virtual]</code></td> |
425 </tr> | 621 </tr> |
426 </table> | 622 </table> |
427 </div> | 623 </div> |
428 <div class="memdoc"> | 624 <div class="memdoc"> |
429 | 625 |
431 Reset the plugin after use, to prepare it for another clean run. | 627 Reset the plugin after use, to prepare it for another clean run. |
432 <p> | 628 <p> |
433 Not called for the first initialisation (i.e. initialise must also do a reset). | 629 Not called for the first initialisation (i.e. initialise must also do a reset). |
434 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p> | 630 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p> |
435 | 631 |
436 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00262">262</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | 632 </div> |
437 | 633 </div><p> |
438 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>, and <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00406">Vamp::HostExt::PluginBufferingAdapter::Impl::reset()</a>.</p> | 634 <a class="anchor" name="55058a20c1f8bffc0dc927350df778a0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::process" ref="55058a20c1f8bffc0dc927350df778a0" args="(const float *const *inputBuffers, RealTime timestamp)" --> |
439 | 635 <div class="memitem"> |
440 </div> | 636 <div class="memproto"> |
441 </div><p> | 637 <table class="memname"> |
442 <a class="anchor" name="262206b978d9de28ee4bb35f437e915e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::process" ref="262206b978d9de28ee4bb35f437e915e" args="(const float *const *inputBuffers, RealTime timestamp)" --> | 638 <tr> |
443 <div class="memitem"> | 639 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::process </td> |
444 <div class="memproto"> | |
445 <table class="memname"> | |
446 <tr> | |
447 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PluginBufferingAdapter::FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::process </td> | |
448 <td>(</td> | 640 <td>(</td> |
449 <td class="paramtype">const float *const * </td> | 641 <td class="paramtype">const float *const * </td> |
450 <td class="paramname"> <em>inputBuffers</em>, </td> | 642 <td class="paramname"> <em>inputBuffers</em>, </td> |
451 </tr> | 643 </tr> |
452 <tr> | 644 <tr> |
456 <td class="paramname"> <em>timestamp</em></td><td> </td> | 648 <td class="paramname"> <em>timestamp</em></td><td> </td> |
457 </tr> | 649 </tr> |
458 <tr> | 650 <tr> |
459 <td></td> | 651 <td></td> |
460 <td>)</td> | 652 <td>)</td> |
461 <td></td><td></td><td width="100%"><code> [virtual]</code></td> | 653 <td></td><td></td><td><code> [virtual]</code></td> |
462 </tr> | 654 </tr> |
463 </table> | 655 </table> |
464 </div> | 656 </div> |
465 <div class="memdoc"> | 657 <div class="memdoc"> |
466 | 658 |
467 <p> | 659 <p> |
468 Process a single block of input data. | 660 Process a single block of input data. |
469 <p> | 661 <p> |
470 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.<p> | 662 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> |
471 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p> | 663 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> |
472 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) | 664 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.) |
473 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7">Vamp::HostExt::PluginWrapper</a>.</p> | 665 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p> |
474 | 666 |
475 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00268">268</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | 667 </div> |
476 | 668 </div><p> |
477 <p>References <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>, and <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00417">Vamp::HostExt::PluginBufferingAdapter::Impl::process()</a>.</p> | 669 <a class="anchor" name="28423951b2eda1a1fc371485434f417b"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures" ref="28423951b2eda1a1fc371485434f417b" args="()" --> |
478 | 670 <div class="memitem"> |
479 </div> | 671 <div class="memproto"> |
480 </div><p> | 672 <table class="memname"> |
481 <a class="anchor" name="8771cba75552aaa1340b68de9bf1659c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures" ref="8771cba75552aaa1340b68de9bf1659c" args="()" --> | 673 <tr> |
482 <div class="memitem"> | 674 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures </td> |
483 <div class="memproto"> | 675 <td>(</td> |
484 <table class="memname"> | 676 <td class="paramname"> </td> |
485 <tr> | 677 <td> ) </td> |
486 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PluginBufferingAdapter::FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures </td> | 678 <td><code> [virtual]</code></td> |
487 <td>(</td> | |
488 <td class="paramname"> </td> | |
489 <td> ) </td> | |
490 <td width="100%"><code> [virtual]</code></td> | |
491 </tr> | 679 </tr> |
492 </table> | 680 </table> |
493 </div> | 681 </div> |
494 <div class="memdoc"> | 682 <div class="memdoc"> |
495 | 683 |
496 <p> | 684 <p> |
497 After all blocks have been processed, calculate and return any remaining features derived from the complete input. | 685 After all blocks have been processed, calculate and return any remaining features derived from the complete input. |
498 <p> | 686 <p> |
499 | 687 |
500 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#1dce55a75a32b08fc56a52a300d9fcbe">Vamp::HostExt::PluginWrapper</a>.</p> | 688 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p> |
501 | 689 |
502 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00275">275</a> of file <a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a>.</p> | 690 </div> |
503 | 691 </div><p> |
504 <p>References <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00452">Vamp::HostExt::PluginBufferingAdapter::Impl::getRemainingFeatures()</a>, and <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">m_impl</a>.</p> | 692 <a class="anchor" name="e203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getInputDomain" ref="e203faf8384c9e1fddc381409aa8a214" args="() const " --> |
505 | 693 <div class="memitem"> |
506 </div> | 694 <div class="memproto"> |
507 </div><p> | 695 <table class="memname"> |
508 <a class="anchor" name="031aa818fd48fd0f4b5e1bf80c032870"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getInputDomain" ref="031aa818fd48fd0f4b5e1bf80c032870" args="() const " --> | 696 <tr> |
509 <div class="memitem"> | 697 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td> |
510 <div class="memproto"> | 698 <td>(</td> |
511 <table class="memname"> | 699 <td class="paramname"> </td> |
512 <tr> | 700 <td> ) </td> |
513 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Plugin::InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td> | 701 <td> const<code> [virtual, inherited]</code></td> |
514 <td>(</td> | |
515 <td class="paramname"> </td> | |
516 <td> ) </td> | |
517 <td width="100%"> const<code> [virtual, inherited]</code></td> | |
518 </tr> | 702 </tr> |
519 </table> | 703 </table> |
520 </div> | 704 </div> |
521 <div class="memdoc"> | 705 <div class="memdoc"> |
522 | 706 |
523 <p> | 707 <p> |
524 Get the plugin's required input domain. | 708 Get the plugin's required input domain. |
525 <p> | 709 <p> |
526 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. | 710 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. |
527 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> | 711 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> |
528 | 712 |
529 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#376fa97a1c721255541fe35d71368976">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> | 713 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> |
530 | |
531 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00074">74</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
532 | |
533 <p>References <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin::getInputDomain()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
534 | 714 |
535 </div> | 715 </div> |
536 </div><p> | 716 </div><p> |
537 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " --> | 717 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " --> |
538 <div class="memitem"> | 718 <div class="memitem"> |
541 <tr> | 721 <tr> |
542 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td> | 722 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td> |
543 <td>(</td> | 723 <td>(</td> |
544 <td class="paramname"> </td> | 724 <td class="paramname"> </td> |
545 <td> ) </td> | 725 <td> ) </td> |
546 <td width="100%"> const<code> [virtual, inherited]</code></td> | 726 <td> const<code> [virtual, inherited]</code></td> |
547 </tr> | 727 </tr> |
548 </table> | 728 </table> |
549 </div> | 729 </div> |
550 <div class="memdoc"> | 730 <div class="memdoc"> |
551 | 731 |
552 <p> | 732 <p> |
553 Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. | 733 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. |
554 <p> | 734 <p> |
555 | 735 |
556 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> | 736 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> |
557 | 737 |
558 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00080">80</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
559 | |
560 <p>References <a class="el" href="PluginBase_8h-source.html#l00067">Vamp::PluginBase::getVampApiVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
561 | |
562 </div> | 738 </div> |
563 </div><p> | 739 </div><p> |
564 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " --> | 740 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " --> |
565 <div class="memitem"> | 741 <div class="memitem"> |
566 <div class="memproto"> | 742 <div class="memproto"> |
568 <tr> | 744 <tr> |
569 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td> | 745 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td> |
570 <td>(</td> | 746 <td>(</td> |
571 <td class="paramname"> </td> | 747 <td class="paramname"> </td> |
572 <td> ) </td> | 748 <td> ) </td> |
573 <td width="100%"> const<code> [virtual, inherited]</code></td> | 749 <td> const<code> [virtual, inherited]</code></td> |
574 </tr> | 750 </tr> |
575 </table> | 751 </table> |
576 </div> | 752 </div> |
577 <div class="memdoc"> | 753 <div class="memdoc"> |
578 | 754 |
582 This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.<p> | 758 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> |
583 This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).<p> | 759 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> |
584 Example: "zero_crossings" | 760 Example: "zero_crossings" |
585 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> | 761 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> |
586 | 762 |
587 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00086">86</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
588 | |
589 <p>References <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
590 | |
591 </div> | 763 </div> |
592 </div><p> | 764 </div><p> |
593 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " --> | 765 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " --> |
594 <div class="memitem"> | 766 <div class="memitem"> |
595 <div class="memproto"> | 767 <div class="memproto"> |
597 <tr> | 769 <tr> |
598 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td> | 770 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td> |
599 <td>(</td> | 771 <td>(</td> |
600 <td class="paramname"> </td> | 772 <td class="paramname"> </td> |
601 <td> ) </td> | 773 <td> ) </td> |
602 <td width="100%"> const<code> [virtual, inherited]</code></td> | 774 <td> const<code> [virtual, inherited]</code></td> |
603 </tr> | 775 </tr> |
604 </table> | 776 </table> |
605 </div> | 777 </div> |
606 <div class="memdoc"> | 778 <div class="memdoc"> |
607 | 779 |
610 <p> | 782 <p> |
611 This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").<p> | 783 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> |
612 Example: "Zero Crossings" | 784 Example: "Zero Crossings" |
613 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> | 785 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> |
614 | 786 |
615 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00092">92</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
616 | |
617 <p>References <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
618 | |
619 </div> | 787 </div> |
620 </div><p> | 788 </div><p> |
621 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " --> | 789 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " --> |
622 <div class="memitem"> | 790 <div class="memitem"> |
623 <div class="memproto"> | 791 <div class="memproto"> |
625 <tr> | 793 <tr> |
626 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td> | 794 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td> |
627 <td>(</td> | 795 <td>(</td> |
628 <td class="paramname"> </td> | 796 <td class="paramname"> </td> |
629 <td> ) </td> | 797 <td> ) </td> |
630 <td width="100%"> const<code> [virtual, inherited]</code></td> | 798 <td> const<code> [virtual, inherited]</code></td> |
631 </tr> | 799 </tr> |
632 </table> | 800 </table> |
633 </div> | 801 </div> |
634 <div class="memdoc"> | 802 <div class="memdoc"> |
635 | 803 |
638 <p> | 806 <p> |
639 May be empty if the name has said it all already.<p> | 807 May be empty if the name has said it all already.<p> |
640 Example: "Detect and count zero crossing points" | 808 Example: "Detect and count zero crossing points" |
641 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> | 809 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> |
642 | 810 |
643 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00098">98</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
644 | |
645 <p>References <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
646 | |
647 </div> | 811 </div> |
648 </div><p> | 812 </div><p> |
649 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " --> | 813 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " --> |
650 <div class="memitem"> | 814 <div class="memitem"> |
651 <div class="memproto"> | 815 <div class="memproto"> |
653 <tr> | 817 <tr> |
654 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td> | 818 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td> |
655 <td>(</td> | 819 <td>(</td> |
656 <td class="paramname"> </td> | 820 <td class="paramname"> </td> |
657 <td> ) </td> | 821 <td> ) </td> |
658 <td width="100%"> const<code> [virtual, inherited]</code></td> | 822 <td> const<code> [virtual, inherited]</code></td> |
659 </tr> | 823 </tr> |
660 </table> | 824 </table> |
661 </div> | 825 </div> |
662 <div class="memdoc"> | 826 <div class="memdoc"> |
663 | 827 |
665 Get the name of the author or vendor of the plugin in human-readable form. | 829 Get the name of the author or vendor of the plugin in human-readable form. |
666 <p> | 830 <p> |
667 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. | 831 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. |
668 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> | 832 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> |
669 | 833 |
670 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00104">104</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
671 | |
672 <p>References <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
673 | |
674 </div> | 834 </div> |
675 </div><p> | 835 </div><p> |
676 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " --> | 836 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " --> |
677 <div class="memitem"> | 837 <div class="memitem"> |
678 <div class="memproto"> | 838 <div class="memproto"> |
680 <tr> | 840 <tr> |
681 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td> | 841 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td> |
682 <td>(</td> | 842 <td>(</td> |
683 <td class="paramname"> </td> | 843 <td class="paramname"> </td> |
684 <td> ) </td> | 844 <td> ) </td> |
685 <td width="100%"> const<code> [virtual, inherited]</code></td> | 845 <td> const<code> [virtual, inherited]</code></td> |
686 </tr> | 846 </tr> |
687 </table> | 847 </table> |
688 </div> | 848 </div> |
689 <div class="memdoc"> | 849 <div class="memdoc"> |
690 | 850 |
692 Get the version number of the plugin. | 852 Get the version number of the plugin. |
693 <p> | 853 <p> |
694 | 854 |
695 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> | 855 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> |
696 | 856 |
697 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00110">110</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
698 | |
699 <p>References <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
700 | |
701 </div> | 857 </div> |
702 </div><p> | 858 </div><p> |
703 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " --> | 859 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " --> |
704 <div class="memitem"> | 860 <div class="memitem"> |
705 <div class="memproto"> | 861 <div class="memproto"> |
707 <tr> | 863 <tr> |
708 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td> | 864 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td> |
709 <td>(</td> | 865 <td>(</td> |
710 <td class="paramname"> </td> | 866 <td class="paramname"> </td> |
711 <td> ) </td> | 867 <td> ) </td> |
712 <td width="100%"> const<code> [virtual, inherited]</code></td> | 868 <td> const<code> [virtual, inherited]</code></td> |
713 </tr> | 869 </tr> |
714 </table> | 870 </table> |
715 </div> | 871 </div> |
716 <div class="memdoc"> | 872 <div class="memdoc"> |
717 | 873 |
719 Get the copyright statement or licensing summary for the plugin. | 875 Get the copyright statement or licensing summary for the plugin. |
720 <p> | 876 <p> |
721 This can be an informative text, without the same presentation constraints as mentioned for getMaker above. | 877 This can be an informative text, without the same presentation constraints as mentioned for getMaker above. |
722 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> | 878 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> |
723 | 879 |
724 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | 880 </div> |
725 | 881 </div><p> |
726 <p>References <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | 882 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " --> |
727 | 883 <div class="memitem"> |
728 </div> | 884 <div class="memproto"> |
729 </div><p> | 885 <table class="memname"> |
730 <a class="anchor" name="3b075b8f950b344503f0d27ac0fe332e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameterDescriptors" ref="3b075b8f950b344503f0d27ac0fe332e" args="() const " --> | 886 <tr> |
731 <div class="memitem"> | 887 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td> |
732 <div class="memproto"> | 888 <td>(</td> |
733 <table class="memname"> | 889 <td class="paramname"> </td> |
734 <tr> | 890 <td> ) </td> |
735 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PluginBase::ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td> | 891 <td> const<code> [virtual, inherited]</code></td> |
736 <td>(</td> | |
737 <td class="paramname"> </td> | |
738 <td> ) </td> | |
739 <td width="100%"> const<code> [virtual, inherited]</code></td> | |
740 </tr> | 892 </tr> |
741 </table> | 893 </table> |
742 </div> | 894 </div> |
743 <div class="memdoc"> | 895 <div class="memdoc"> |
744 | 896 |
746 Get the controllable parameters of this plugin. | 898 Get the controllable parameters of this plugin. |
747 <p> | 899 <p> |
748 | 900 |
749 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> | 901 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> |
750 | 902 |
751 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00122">122</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
752 | |
753 <p>References <a class="el" href="PluginBase_8h-source.html#l00200">Vamp::PluginBase::getParameterDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
754 | |
755 </div> | 903 </div> |
756 </div><p> | 904 </div><p> |
757 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " --> | 905 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " --> |
758 <div class="memitem"> | 906 <div class="memitem"> |
759 <div class="memproto"> | 907 <div class="memproto"> |
762 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td> | 910 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td> |
763 <td>(</td> | 911 <td>(</td> |
764 <td class="paramtype">std::string </td> | 912 <td class="paramtype">std::string </td> |
765 <td class="paramname"> </td> | 913 <td class="paramname"> </td> |
766 <td> ) </td> | 914 <td> ) </td> |
767 <td width="100%"> const<code> [virtual, inherited]</code></td> | 915 <td> const<code> [virtual, inherited]</code></td> |
768 </tr> | 916 </tr> |
769 </table> | 917 </table> |
770 </div> | 918 </div> |
771 <div class="memdoc"> | 919 <div class="memdoc"> |
772 | 920 |
774 Get the value of a named parameter. | 922 Get the value of a named parameter. |
775 <p> | 923 <p> |
776 The argument is the identifier field from that parameter's descriptor. | 924 The argument is the identifier field from that parameter's descriptor. |
777 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> | 925 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> |
778 | 926 |
779 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00128">128</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | 927 </div> |
780 | 928 </div><p> |
781 <p>References <a class="el" href="PluginBase_8h-source.html#l00208">Vamp::PluginBase::getParameter()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | 929 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " --> |
782 | 930 <div class="memitem"> |
783 </div> | 931 <div class="memproto"> |
784 </div><p> | 932 <table class="memname"> |
785 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" --> | 933 <tr> |
786 <div class="memitem"> | 934 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td> |
787 <div class="memproto"> | 935 <td>(</td> |
788 <table class="memname"> | 936 <td class="paramname"> </td> |
789 <tr> | 937 <td> ) </td> |
790 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td> | 938 <td> const<code> [virtual, inherited]</code></td> |
791 <td>(</td> | |
792 <td class="paramtype">std::string </td> | |
793 <td class="paramname">, </td> | |
794 </tr> | |
795 <tr> | |
796 <td class="paramkey"></td> | |
797 <td></td> | |
798 <td class="paramtype">float </td> | |
799 <td class="paramname"></td><td> </td> | |
800 </tr> | |
801 <tr> | |
802 <td></td> | |
803 <td>)</td> | |
804 <td></td><td></td><td width="100%"><code> [virtual, inherited]</code></td> | |
805 </tr> | |
806 </table> | |
807 </div> | |
808 <div class="memdoc"> | |
809 | |
810 <p> | |
811 Set a named parameter. | |
812 <p> | |
813 The first argument is the identifier field from that parameter's descriptor. | |
814 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> | |
815 | |
816 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00134">134</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
817 | |
818 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00214">Vamp::PluginBase::setParameter()</a>.</p> | |
819 | |
820 </div> | |
821 </div><p> | |
822 <a class="anchor" name="f3abaf717dc4b00cad5770ed6dfa01e1"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPrograms" ref="f3abaf717dc4b00cad5770ed6dfa01e1" args="() const " --> | |
823 <div class="memitem"> | |
824 <div class="memproto"> | |
825 <table class="memname"> | |
826 <tr> | |
827 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">PluginBase::ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td> | |
828 <td>(</td> | |
829 <td class="paramname"> </td> | |
830 <td> ) </td> | |
831 <td width="100%"> const<code> [virtual, inherited]</code></td> | |
832 </tr> | 939 </tr> |
833 </table> | 940 </table> |
834 </div> | 941 </div> |
835 <div class="memdoc"> | 942 <div class="memdoc"> |
836 | 943 |
839 <p> | 946 <p> |
840 A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.<p> | 947 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> |
841 The programs must have unique names. | 948 The programs must have unique names. |
842 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> | 949 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> |
843 | 950 |
844 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00140">140</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
845 | |
846 <p>References <a class="el" href="PluginBase_8h-source.html#l00229">Vamp::PluginBase::getPrograms()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
847 | |
848 </div> | 951 </div> |
849 </div><p> | 952 </div><p> |
850 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " --> | 953 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " --> |
851 <div class="memitem"> | 954 <div class="memitem"> |
852 <div class="memproto"> | 955 <div class="memproto"> |
854 <tr> | 957 <tr> |
855 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td> | 958 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td> |
856 <td>(</td> | 959 <td>(</td> |
857 <td class="paramname"> </td> | 960 <td class="paramname"> </td> |
858 <td> ) </td> | 961 <td> ) </td> |
859 <td width="100%"> const<code> [virtual, inherited]</code></td> | 962 <td> const<code> [virtual, inherited]</code></td> |
860 </tr> | 963 </tr> |
861 </table> | 964 </table> |
862 </div> | 965 </div> |
863 <div class="memdoc"> | 966 <div class="memdoc"> |
864 | 967 |
866 Get the current program. | 969 Get the current program. |
867 <p> | 970 <p> |
868 | 971 |
869 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> | 972 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> |
870 | 973 |
871 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
872 | |
873 <p>References <a class="el" href="PluginBase_8h-source.html#l00234">Vamp::PluginBase::getCurrentProgram()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
874 | |
875 </div> | |
876 </div><p> | |
877 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" --> | |
878 <div class="memitem"> | |
879 <div class="memproto"> | |
880 <table class="memname"> | |
881 <tr> | |
882 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td> | |
883 <td>(</td> | |
884 <td class="paramtype">std::string </td> | |
885 <td class="paramname"> </td> | |
886 <td> ) </td> | |
887 <td width="100%"><code> [virtual, inherited]</code></td> | |
888 </tr> | |
889 </table> | |
890 </div> | |
891 <div class="memdoc"> | |
892 | |
893 <p> | |
894 Select a program. | |
895 <p> | |
896 (If the given program name is not one of the available programs, do nothing.) | |
897 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> | |
898 | |
899 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
900 | |
901 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00240">Vamp::PluginBase::selectProgram()</a>.</p> | |
902 | |
903 </div> | |
904 </div><p> | |
905 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " --> | |
906 <div class="memitem"> | |
907 <div class="memproto"> | |
908 <table class="memname"> | |
909 <tr> | |
910 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td> | |
911 <td>(</td> | |
912 <td class="paramname"> </td> | |
913 <td> ) </td> | |
914 <td width="100%"> const<code> [virtual, inherited]</code></td> | |
915 </tr> | |
916 </table> | |
917 </div> | |
918 <div class="memdoc"> | |
919 | |
920 <p> | |
921 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). | |
922 <p> | |
923 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> | |
924 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. | |
925 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p> | |
926 | |
927 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> | |
928 | |
929 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00164">164</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
930 | |
931 <p>References <a class="el" href="Plugin_8h-source.html#l00171">Vamp::Plugin::getPreferredBlockSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
932 | |
933 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">getPreferredStepSize()</a>.</p> | |
934 | |
935 </div> | 974 </div> |
936 </div><p> | 975 </div><p> |
937 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " --> | 976 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " --> |
938 <div class="memitem"> | 977 <div class="memitem"> |
939 <div class="memproto"> | 978 <div class="memproto"> |
941 <tr> | 980 <tr> |
942 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td> | 981 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td> |
943 <td>(</td> | 982 <td>(</td> |
944 <td class="paramname"> </td> | 983 <td class="paramname"> </td> |
945 <td> ) </td> | 984 <td> ) </td> |
946 <td width="100%"> const<code> [virtual, inherited]</code></td> | 985 <td> const<code> [virtual, inherited]</code></td> |
947 </tr> | 986 </tr> |
948 </table> | 987 </table> |
949 </div> | 988 </div> |
950 <div class="memdoc"> | 989 <div class="memdoc"> |
951 | 990 |
953 Get the minimum supported number of input channels. | 992 Get the minimum supported number of input channels. |
954 <p> | 993 <p> |
955 | 994 |
956 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> | 995 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> |
957 | 996 |
958 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00170">170</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | |
959 | |
960 <p>References <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | |
961 | |
962 </div> | 997 </div> |
963 </div><p> | 998 </div><p> |
964 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " --> | 999 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " --> |
965 <div class="memitem"> | 1000 <div class="memitem"> |
966 <div class="memproto"> | 1001 <div class="memproto"> |
968 <tr> | 1003 <tr> |
969 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td> | 1004 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td> |
970 <td>(</td> | 1005 <td>(</td> |
971 <td class="paramname"> </td> | 1006 <td class="paramname"> </td> |
972 <td> ) </td> | 1007 <td> ) </td> |
973 <td width="100%"> const<code> [virtual, inherited]</code></td> | 1008 <td> const<code> [virtual, inherited]</code></td> |
974 </tr> | 1009 </tr> |
975 </table> | 1010 </table> |
976 </div> | 1011 </div> |
977 <div class="memdoc"> | 1012 <div class="memdoc"> |
978 | 1013 |
980 Get the maximum supported number of input channels. | 1015 Get the maximum supported number of input channels. |
981 <p> | 1016 <p> |
982 | 1017 |
983 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> | 1018 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> |
984 | 1019 |
985 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00175">175</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> | 1020 </div> |
986 | 1021 </div><p> |
987 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">Vamp::HostExt::PluginWrapper::m_plugin</a>.</p> | 1022 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" --> |
1023 <div class="memitem"> | |
1024 <div class="memproto"> | |
1025 <div class="memtemplate"> | |
1026 template<typename WrapperType> </div> | |
1027 <table class="memname"> | |
1028 <tr> | |
1029 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td> | |
1030 <td>(</td> | |
1031 <td class="paramname"> </td> | |
1032 <td> ) </td> | |
1033 <td><code> [inline, inherited]</code></td> | |
1034 </tr> | |
1035 </table> | |
1036 </div> | |
1037 <div class="memdoc"> | |
1038 | |
1039 <p> | |
1040 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. | |
1041 <p> | |
1042 This is useful in situations where a plugin is wrapped by multiple different wrappers (one inside another) and the host wants to call some wrapper-specific function on one of the layers without having to care about the order in which they are wrapped. For example, the plugin returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">PluginLoader::loadPlugin</a> may have more than one wrapper; if the host wanted to query or fine-tune some property of one of them, it would be hard to do so without knowing the order of the wrappers. This function therefore gives direct access to the wrapper of a particular type. | |
1043 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p> | |
1044 | |
1045 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p> | |
1046 | |
1047 <p>Referenced by <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p> | |
988 | 1048 |
989 </div> | 1049 </div> |
990 </div><p> | 1050 </div><p> |
991 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> | 1051 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> |
992 <div class="memitem"> | 1052 <div class="memitem"> |
995 <tr> | 1055 <tr> |
996 <td class="memname">virtual std::string Vamp::Plugin::getType </td> | 1056 <td class="memname">virtual std::string Vamp::Plugin::getType </td> |
997 <td>(</td> | 1057 <td>(</td> |
998 <td class="paramname"> </td> | 1058 <td class="paramname"> </td> |
999 <td> ) </td> | 1059 <td> ) </td> |
1000 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> | 1060 <td> const<code> [inline, virtual, inherited]</code></td> |
1001 </tr> | 1061 </tr> |
1002 </table> | 1062 </table> |
1003 </div> | 1063 </div> |
1004 <div class="memdoc"> | 1064 <div class="memdoc"> |
1005 | 1065 |
1007 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. | 1067 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>. |
1008 <p> | 1068 <p> |
1009 Do not reimplement this function in your subclass. | 1069 Do not reimplement this function in your subclass. |
1010 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> | 1070 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> |
1011 | 1071 |
1012 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 1072 <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> |
1013 | 1073 |
1014 </div> | 1074 </div> |
1015 </div><p> | 1075 </div><p> |
1016 <hr><h2>Member Data Documentation</h2> | 1076 <hr><h2>Member Data Documentation</h2> |
1017 <a class="anchor" name="51e10c9c63c0349fd74c6d604de5554e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_impl" ref="51e10c9c63c0349fd74c6d604de5554e" args="" --> | 1077 <a class="anchor" name="51e10c9c63c0349fd74c6d604de5554e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_impl" ref="51e10c9c63c0349fd74c6d604de5554e" args="" --> |
1018 <div class="memitem"> | 1078 <div class="memitem"> |
1019 <div class="memproto"> | 1079 <div class="memproto"> |
1020 <table class="memname"> | 1080 <table class="memname"> |
1021 <tr> | 1081 <tr> |
1022 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">Vamp::HostExt::PluginBufferingAdapter::m_impl</a><code> [protected]</code> </td> | 1082 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#51e10c9c63c0349fd74c6d604de5554e">Vamp::HostExt::PluginBufferingAdapter::m_impl</a><code> [protected]</code> </td> |
1023 </tr> | 1083 </tr> |
1024 </table> | 1084 </table> |
1025 </div> | 1085 </div> |
1026 <div class="memdoc"> | 1086 <div class="memdoc"> |
1027 | 1087 |
1028 <p> | 1088 <p> |
1029 | 1089 |
1030 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h-source.html#l00091">91</a> of file <a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a>.</p> | 1090 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h-source.html#l00184">184</a> of file <a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a>.</p> |
1031 | |
1032 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00256">getOutputDescriptors()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00275">getRemainingFeatures()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00250">initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">PluginBufferingAdapter()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00268">process()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00262">reset()</a>, and <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00244">~PluginBufferingAdapter()</a>.</p> | |
1033 | 1091 |
1034 </div> | 1092 </div> |
1035 </div><p> | 1093 </div><p> |
1036 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" --> | 1094 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" --> |
1037 <div class="memitem"> | 1095 <div class="memitem"> |
1044 </div> | 1102 </div> |
1045 <div class="memdoc"> | 1103 <div class="memdoc"> |
1046 | 1104 |
1047 <p> | 1105 <p> |
1048 | 1106 |
1049 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00099">99</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p> | 1107 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00126">126</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p> |
1050 | |
1051 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00116">Vamp::HostExt::PluginWrapper::getCopyright()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00146">Vamp::HostExt::PluginWrapper::getCurrentProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00098">Vamp::HostExt::PluginWrapper::getDescription()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00086">Vamp::HostExt::PluginWrapper::getIdentifier()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00074">Vamp::HostExt::PluginWrapper::getInputDomain()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00104">Vamp::HostExt::PluginWrapper::getMaker()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00175">Vamp::HostExt::PluginWrapper::getMaxChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00170">Vamp::HostExt::PluginWrapper::getMinChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00092">Vamp::HostExt::PluginWrapper::getName()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00181">Vamp::HostExt::PluginWrapper::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00128">Vamp::HostExt::PluginWrapper::getParameter()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00122">Vamp::HostExt::PluginWrapper::getParameterDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00110">Vamp::HostExt::PluginWrapper::getPluginVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00164">Vamp::HostExt::PluginWrapper::getPreferredBlockSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00158">Vamp::HostExt::PluginWrapper::getPreferredStepSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00140">Vamp::HostExt::PluginWrapper::getPrograms()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00193">Vamp::HostExt::PluginWrapper::getRemainingFeatures()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00080">Vamp::HostExt::PluginWrapper::getVampApiVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00062">Vamp::HostExt::PluginWrapper::initialise()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00187">Vamp::HostExt::PluginWrapper::process()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00068">Vamp::HostExt::PluginWrapper::reset()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00152">Vamp::HostExt::PluginWrapper::selectProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00134">Vamp::HostExt::PluginWrapper::setParameter()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00620">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00056">Vamp::HostExt::PluginWrapper::~PluginWrapper()</a>.</p> | |
1052 | 1108 |
1053 </div> | 1109 </div> |
1054 </div><p> | 1110 </div><p> |
1055 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" --> | 1111 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" --> |
1056 <div class="memitem"> | 1112 <div class="memitem"> |
1063 </div> | 1119 </div> |
1064 <div class="memdoc"> | 1120 <div class="memdoc"> |
1065 | 1121 |
1066 <p> | 1122 <p> |
1067 | 1123 |
1068 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> | 1124 <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> |
1069 | 1125 |
1070 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> | 1126 <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> |
1071 | 1127 |
1072 </div> | 1128 </div> |
1073 </div><p> | 1129 </div><p> |
1074 <hr>The documentation for this class was generated from the following files:<ul> | 1130 <hr>The documentation for this class was generated from the following file:<ul> |
1075 <li><a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a><li><a class="el" href="PluginBufferingAdapter_8cpp-source.html">PluginBufferingAdapter.cpp</a></ul> | 1131 <li><a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a></ul> |
1076 </div> | 1132 </div> |
1077 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by | 1133 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by |
1078 <a href="http://www.doxygen.org/index.html"> | 1134 <a href="http://www.doxygen.org/index.html"> |
1079 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> | 1135 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> |
1080 </body> | 1136 </body> |
1081 </html> | 1137 </html> |