|
cannam@0
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
cannam@0
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
cannam@0
|
3 <title>VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference</title>
|
|
cannam@0
|
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
cannam@0
|
5 <link href="tabs.css" rel="stylesheet" type="text/css">
|
|
cannam@0
|
6 </head><body>
|
|
cannam@21
|
7 <!-- Generated by Doxygen 1.5.6 -->
|
|
cannam@0
|
8 <div class="navigation" id="top">
|
|
cannam@0
|
9 <div class="tabs">
|
|
cannam@0
|
10 <ul>
|
|
cannam@0
|
11 <li><a href="main.html"><span>Main Page</span></a></li>
|
|
cannam@0
|
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
cannam@0
|
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
cannam@0
|
14 <li><a href="files.html"><span>Files</span></a></li>
|
|
cannam@0
|
15 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
cannam@0
|
16 </ul>
|
|
cannam@0
|
17 </div>
|
|
cannam@0
|
18 <div class="tabs">
|
|
cannam@0
|
19 <ul>
|
|
cannam@0
|
20 <li><a href="annotated.html"><span>Class List</span></a></li>
|
|
cannam@0
|
21 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
cannam@0
|
22 <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
cannam@0
|
23 </ul>
|
|
cannam@0
|
24 </div>
|
|
cannam@0
|
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">PluginBufferingAdapter</a>
|
|
cannam@0
|
26 </div>
|
|
cannam@0
|
27 </div>
|
|
cannam@0
|
28 <div class="contents">
|
|
cannam@21
|
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>
|
|
cannam@0
|
30 <p>
|
|
cannam@0
|
31 <div class="dynheader">
|
|
cannam@0
|
32 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div>
|
|
cannam@0
|
33 <div class="dynsection">
|
|
cannam@0
|
34 <p><center><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map" alt="Inheritance graph"></center>
|
|
cannam@0
|
35 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__map">
|
|
cannam@21
|
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>
|
|
cannam@0
|
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
|
|
cannam@0
|
38
|
|
cannam@0
|
39 <p>
|
|
cannam@0
|
40 <a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
cannam@21
|
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.
|
|
cannam@0
|
42 <p>
|
|
cannam@0
|
43 A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.<p>
|
|
cannam@0
|
44 If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.<p>
|
|
cannam@0
|
45 In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted.
|
|
cannam@21
|
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>
|
|
cannam@0
|
47 <table border="0" cellpadding="0" cellspacing="0">
|
|
cannam@0
|
48 <tr><td></td></tr>
|
|
cannam@0
|
49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
|
|
cannam@0
|
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
|
|
cannam@0
|
51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
|
|
cannam@0
|
52 }</td></tr>
|
|
cannam@0
|
53
|
|
cannam@0
|
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
|
|
cannam@0
|
55 < <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
|
|
cannam@0
|
56
|
|
cannam@0
|
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
|
|
cannam@0
|
58
|
|
cannam@0
|
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map< int, <br>
|
|
cannam@0
|
60 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
|
|
cannam@0
|
61
|
|
cannam@0
|
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
|
|
cannam@0
|
63 < <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
|
|
cannam@0
|
64
|
|
cannam@0
|
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>
|
|
cannam@0
|
66
|
|
cannam@0
|
67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
cannam@0
|
68 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
|
|
cannam@0
|
69
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@0
|
72
|
|
cannam@21
|
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>
|
|
cannam@21
|
74
|
|
cannam@21
|
75 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred step size for this adapter. <a href="#2e66d009df69c951001e5d2786973d60"></a><br></td></tr>
|
|
cannam@21
|
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>
|
|
cannam@21
|
77
|
|
cannam@21
|
78 <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the preferred block size for this adapter. <a href="#21e45180b19873f9ab69fe7a4e184a03"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
80
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@0
|
83
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@0
|
86
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@21
|
89
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@21
|
92
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@21
|
95
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@21
|
98
|
|
cannam@21
|
99 <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#7a979b20c169d37adbd7b7d8b8a077b3"></a><br></td></tr>
|
|
cannam@21
|
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>
|
|
cannam@21
|
101
|
|
cannam@21
|
102 <tr><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#3cc7000e0aff525950e0a286b87f8927"></a><br></td></tr>
|
|
cannam@21
|
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>
|
|
cannam@21
|
104
|
|
cannam@21
|
105 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the outputs of this plugin. <a href="#f8cc914897a284433de220f1153f3845"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
107
|
|
cannam@0
|
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>
|
|
cannam@21
|
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>
|
|
cannam@0
|
110
|
|
cannam@21
|
111 <tr><td class="mdescLeft"> </td><td class="mdescRight">Process a single block of input data. <a href="#55058a20c1f8bffc0dc927350df778a0"></a><br></td></tr>
|
|
cannam@21
|
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>
|
|
cannam@0
|
113
|
|
cannam@21
|
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>
|
|
cannam@21
|
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>
|
|
cannam@0
|
116
|
|
cannam@21
|
117 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's required input domain. <a href="#e203faf8384c9e1fddc381409aa8a214"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
119
|
|
cannam@21
|
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>
|
|
cannam@0
|
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>
|
|
cannam@0
|
122
|
|
cannam@0
|
123 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
125
|
|
cannam@0
|
126 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c70a3265bb25aeb03f6dd8f8a0442088"></a><br></td></tr>
|
|
cannam@0
|
127 <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#c334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr>
|
|
cannam@0
|
128
|
|
cannam@0
|
129 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#c334f699c0996055942785410d8a065c"></a><br></td></tr>
|
|
cannam@0
|
130 <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#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr>
|
|
cannam@0
|
131
|
|
cannam@0
|
132 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#59d5a2298951b317995675e664b1c7bb"></a><br></td></tr>
|
|
cannam@0
|
133 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr>
|
|
cannam@0
|
134
|
|
cannam@0
|
135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
137
|
|
cannam@0
|
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>
|
|
cannam@21
|
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>
|
|
cannam@0
|
140
|
|
cannam@21
|
141 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
143
|
|
cannam@0
|
144 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
|
|
cannam@21
|
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>
|
|
cannam@0
|
146
|
|
cannam@21
|
147 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
149
|
|
cannam@0
|
150 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
152
|
|
cannam@0
|
153 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
|
|
cannam@0
|
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>
|
|
cannam@0
|
155
|
|
cannam@0
|
156 <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
|
|
cannam@21
|
157 <tr><td class="memTemplParams" nowrap colspan="2">template<typename WrapperType> </td></tr>
|
|
cannam@21
|
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>
|
|
cannam@21
|
159
|
|
cannam@21
|
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>
|
|
cannam@0
|
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>
|
|
cannam@0
|
162
|
|
cannam@0
|
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>
|
|
cannam@0
|
164 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
|
|
cannam@21
|
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>
|
|
cannam@0
|
166
|
|
cannam@0
|
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>
|
|
cannam@0
|
168
|
|
cannam@0
|
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>
|
|
cannam@0
|
170
|
|
cannam@0
|
171 </table>
|
|
cannam@0
|
172 <hr><h2>Member Typedef Documentation</h2>
|
|
cannam@0
|
173 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
|
|
cannam@0
|
174 <div class="memitem">
|
|
cannam@0
|
175 <div class="memproto">
|
|
cannam@0
|
176 <table class="memname">
|
|
cannam@0
|
177 <tr>
|
|
cannam@0
|
178 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>> <a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
179 </tr>
|
|
cannam@0
|
180 </table>
|
|
cannam@0
|
181 </div>
|
|
cannam@0
|
182 <div class="memdoc">
|
|
cannam@0
|
183
|
|
cannam@0
|
184 <p>
|
|
cannam@0
|
185
|
|
cannam@21
|
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>
|
|
cannam@0
|
187
|
|
cannam@0
|
188 </div>
|
|
cannam@0
|
189 </div><p>
|
|
cannam@0
|
190 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
|
|
cannam@0
|
191 <div class="memitem">
|
|
cannam@0
|
192 <div class="memproto">
|
|
cannam@0
|
193 <table class="memname">
|
|
cannam@0
|
194 <tr>
|
|
cannam@0
|
195 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>> <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
196 </tr>
|
|
cannam@0
|
197 </table>
|
|
cannam@0
|
198 </div>
|
|
cannam@0
|
199 <div class="memdoc">
|
|
cannam@0
|
200
|
|
cannam@0
|
201 <p>
|
|
cannam@0
|
202
|
|
cannam@21
|
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>
|
|
cannam@0
|
204
|
|
cannam@0
|
205 </div>
|
|
cannam@0
|
206 </div><p>
|
|
cannam@0
|
207 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
|
|
cannam@0
|
208 <div class="memitem">
|
|
cannam@0
|
209 <div class="memproto">
|
|
cannam@0
|
210 <table class="memname">
|
|
cannam@0
|
211 <tr>
|
|
cannam@0
|
212 <td class="memname">typedef std::map<int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>> <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
|
|
cannam@0
|
213 </tr>
|
|
cannam@0
|
214 </table>
|
|
cannam@0
|
215 </div>
|
|
cannam@0
|
216 <div class="memdoc">
|
|
cannam@0
|
217
|
|
cannam@0
|
218 <p>
|
|
cannam@0
|
219
|
|
cannam@21
|
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>
|
|
cannam@0
|
221
|
|
cannam@0
|
222 </div>
|
|
cannam@0
|
223 </div><p>
|
|
cannam@0
|
224 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
|
|
cannam@0
|
225 <div class="memitem">
|
|
cannam@0
|
226 <div class="memproto">
|
|
cannam@0
|
227 <table class="memname">
|
|
cannam@0
|
228 <tr>
|
|
cannam@0
|
229 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>> <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
230 </tr>
|
|
cannam@0
|
231 </table>
|
|
cannam@0
|
232 </div>
|
|
cannam@0
|
233 <div class="memdoc">
|
|
cannam@0
|
234
|
|
cannam@0
|
235 <p>
|
|
cannam@0
|
236
|
|
cannam@21
|
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>
|
|
cannam@0
|
238
|
|
cannam@0
|
239 </div>
|
|
cannam@0
|
240 </div><p>
|
|
cannam@0
|
241 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
|
|
cannam@0
|
242 <div class="memitem">
|
|
cannam@0
|
243 <div class="memproto">
|
|
cannam@0
|
244 <table class="memname">
|
|
cannam@0
|
245 <tr>
|
|
cannam@0
|
246 <td class="memname">typedef std::vector<std::string> <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
|
|
cannam@0
|
247 </tr>
|
|
cannam@0
|
248 </table>
|
|
cannam@0
|
249 </div>
|
|
cannam@0
|
250 <div class="memdoc">
|
|
cannam@0
|
251
|
|
cannam@0
|
252 <p>
|
|
cannam@0
|
253
|
|
cannam@21
|
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>
|
|
cannam@0
|
255
|
|
cannam@0
|
256 </div>
|
|
cannam@0
|
257 </div><p>
|
|
cannam@0
|
258 <hr><h2>Member Enumeration Documentation</h2>
|
|
cannam@0
|
259 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
|
|
cannam@0
|
260 <div class="memitem">
|
|
cannam@0
|
261 <div class="memproto">
|
|
cannam@0
|
262 <table class="memname">
|
|
cannam@0
|
263 <tr>
|
|
cannam@0
|
264 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
|
|
cannam@0
|
265 </tr>
|
|
cannam@0
|
266 </table>
|
|
cannam@0
|
267 </div>
|
|
cannam@0
|
268 <div class="memdoc">
|
|
cannam@0
|
269
|
|
cannam@0
|
270 <p>
|
|
cannam@0
|
271 <dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
cannam@0
|
272 <table border="0" cellspacing="2" cellpadding="0">
|
|
cannam@0
|
273 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em> </td><td>
|
|
cannam@0
|
274 </td></tr>
|
|
cannam@0
|
275 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em> </td><td>
|
|
cannam@0
|
276 </td></tr>
|
|
cannam@0
|
277 </table>
|
|
cannam@0
|
278 </dl>
|
|
cannam@0
|
279
|
|
cannam@21
|
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>
|
|
cannam@0
|
281
|
|
cannam@0
|
282 </div>
|
|
cannam@0
|
283 </div><p>
|
|
cannam@0
|
284 <hr><h2>Constructor & Destructor Documentation</h2>
|
|
cannam@0
|
285 <a class="anchor" name="1276bcfcbe1414b33eeefbd7b2b702fe"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter" ref="1276bcfcbe1414b33eeefbd7b2b702fe" args="(Plugin *plugin)" -->
|
|
cannam@0
|
286 <div class="memitem">
|
|
cannam@0
|
287 <div class="memproto">
|
|
cannam@0
|
288 <table class="memname">
|
|
cannam@0
|
289 <tr>
|
|
cannam@0
|
290 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter </td>
|
|
cannam@0
|
291 <td>(</td>
|
|
cannam@0
|
292 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td>
|
|
cannam@0
|
293 <td class="paramname"> <em>plugin</em> </td>
|
|
cannam@0
|
294 <td> ) </td>
|
|
cannam@21
|
295 <td></td>
|
|
cannam@21
|
296 </tr>
|
|
cannam@21
|
297 </table>
|
|
cannam@21
|
298 </div>
|
|
cannam@21
|
299 <div class="memdoc">
|
|
cannam@21
|
300
|
|
cannam@21
|
301 <p>
|
|
cannam@21
|
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.
|
|
cannam@21
|
303 <p>
|
|
cannam@21
|
304 The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted.
|
|
cannam@21
|
305 </div>
|
|
cannam@21
|
306 </div><p>
|
|
cannam@21
|
307 <a class="anchor" name="96263f7b0910a10eeae86f20db007e55"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter" ref="96263f7b0910a10eeae86f20db007e55" args="()" -->
|
|
cannam@21
|
308 <div class="memitem">
|
|
cannam@21
|
309 <div class="memproto">
|
|
cannam@21
|
310 <table class="memname">
|
|
cannam@21
|
311 <tr>
|
|
cannam@21
|
312 <td class="memname">virtual Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter </td>
|
|
cannam@21
|
313 <td>(</td>
|
|
cannam@21
|
314 <td class="paramname"> </td>
|
|
cannam@21
|
315 <td> ) </td>
|
|
cannam@21
|
316 <td><code> [virtual]</code></td>
|
|
cannam@0
|
317 </tr>
|
|
cannam@0
|
318 </table>
|
|
cannam@0
|
319 </div>
|
|
cannam@0
|
320 <div class="memdoc">
|
|
cannam@0
|
321
|
|
cannam@0
|
322 <p>
|
|
cannam@0
|
323
|
|
cannam@0
|
324 </div>
|
|
cannam@0
|
325 </div><p>
|
|
cannam@21
|
326 <hr><h2>Member Function Documentation</h2>
|
|
cannam@21
|
327 <a class="anchor" name="2e66d009df69c951001e5d2786973d60"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize" ref="2e66d009df69c951001e5d2786973d60" args="() const " -->
|
|
cannam@0
|
328 <div class="memitem">
|
|
cannam@0
|
329 <div class="memproto">
|
|
cannam@0
|
330 <table class="memname">
|
|
cannam@0
|
331 <tr>
|
|
cannam@21
|
332 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize </td>
|
|
cannam@0
|
333 <td>(</td>
|
|
cannam@0
|
334 <td class="paramname"> </td>
|
|
cannam@0
|
335 <td> ) </td>
|
|
cannam@21
|
336 <td> const<code> [virtual]</code></td>
|
|
cannam@0
|
337 </tr>
|
|
cannam@0
|
338 </table>
|
|
cannam@0
|
339 </div>
|
|
cannam@0
|
340 <div class="memdoc">
|
|
cannam@0
|
341
|
|
cannam@0
|
342 <p>
|
|
cannam@21
|
343 Return the preferred step size for this adapter.
|
|
cannam@21
|
344 <p>
|
|
cannam@21
|
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>.
|
|
cannam@21
|
346 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
347
|
|
cannam@0
|
348 </div>
|
|
cannam@0
|
349 </div><p>
|
|
cannam@21
|
350 <a class="anchor" name="21e45180b19873f9ab69fe7a4e184a03"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize" ref="21e45180b19873f9ab69fe7a4e184a03" args="() const " -->
|
|
cannam@21
|
351 <div class="memitem">
|
|
cannam@21
|
352 <div class="memproto">
|
|
cannam@21
|
353 <table class="memname">
|
|
cannam@21
|
354 <tr>
|
|
cannam@21
|
355 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize </td>
|
|
cannam@21
|
356 <td>(</td>
|
|
cannam@21
|
357 <td class="paramname"> </td>
|
|
cannam@21
|
358 <td> ) </td>
|
|
cannam@21
|
359 <td> const<code> [virtual]</code></td>
|
|
cannam@21
|
360 </tr>
|
|
cannam@21
|
361 </table>
|
|
cannam@21
|
362 </div>
|
|
cannam@21
|
363 <div class="memdoc">
|
|
cannam@21
|
364
|
|
cannam@21
|
365 <p>
|
|
cannam@21
|
366 Return the preferred block size for this adapter.
|
|
cannam@21
|
367 <p>
|
|
cannam@21
|
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>
|
|
cannam@21
|
369 Note that this adapter may be initialised with any block size, not just its supposedly preferred one.
|
|
cannam@21
|
370 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@21
|
371
|
|
cannam@21
|
372 </div>
|
|
cannam@21
|
373 </div><p>
|
|
cannam@0
|
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)" -->
|
|
cannam@0
|
375 <div class="memitem">
|
|
cannam@0
|
376 <div class="memproto">
|
|
cannam@0
|
377 <table class="memname">
|
|
cannam@0
|
378 <tr>
|
|
cannam@0
|
379 <td class="memname">bool Vamp::HostExt::PluginBufferingAdapter::initialise </td>
|
|
cannam@0
|
380 <td>(</td>
|
|
cannam@0
|
381 <td class="paramtype">size_t </td>
|
|
cannam@21
|
382 <td class="paramname"> <em>channels</em>, </td>
|
|
cannam@0
|
383 </tr>
|
|
cannam@0
|
384 <tr>
|
|
cannam@0
|
385 <td class="paramkey"></td>
|
|
cannam@0
|
386 <td></td>
|
|
cannam@0
|
387 <td class="paramtype">size_t </td>
|
|
cannam@0
|
388 <td class="paramname"> <em>stepSize</em>, </td>
|
|
cannam@0
|
389 </tr>
|
|
cannam@0
|
390 <tr>
|
|
cannam@0
|
391 <td class="paramkey"></td>
|
|
cannam@0
|
392 <td></td>
|
|
cannam@0
|
393 <td class="paramtype">size_t </td>
|
|
cannam@0
|
394 <td class="paramname"> <em>blockSize</em></td><td> </td>
|
|
cannam@0
|
395 </tr>
|
|
cannam@0
|
396 <tr>
|
|
cannam@0
|
397 <td></td>
|
|
cannam@0
|
398 <td>)</td>
|
|
cannam@21
|
399 <td></td><td></td><td><code> [virtual]</code></td>
|
|
cannam@0
|
400 </tr>
|
|
cannam@0
|
401 </table>
|
|
cannam@0
|
402 </div>
|
|
cannam@0
|
403 <div class="memdoc">
|
|
cannam@0
|
404
|
|
cannam@0
|
405 <p>
|
|
cannam@21
|
406 Initialise the adapter (and therefore the plugin) for the given number of channels.
|
|
cannam@0
|
407 <p>
|
|
cannam@21
|
408 Initialise the adapter for the given step and block size, which must be equal.<p>
|
|
cannam@21
|
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.
|
|
cannam@0
|
410 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
411
|
|
cannam@0
|
412 </div>
|
|
cannam@0
|
413 </div><p>
|
|
cannam@21
|
414 <a class="anchor" name="d7fad500331808b5cdf90f5a45019b02"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize" ref="d7fad500331808b5cdf90f5a45019b02" args="() const " -->
|
|
cannam@0
|
415 <div class="memitem">
|
|
cannam@0
|
416 <div class="memproto">
|
|
cannam@0
|
417 <table class="memname">
|
|
cannam@0
|
418 <tr>
|
|
cannam@21
|
419 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize </td>
|
|
cannam@0
|
420 <td>(</td>
|
|
cannam@0
|
421 <td class="paramname"> </td>
|
|
cannam@0
|
422 <td> ) </td>
|
|
cannam@21
|
423 <td> const</td>
|
|
cannam@0
|
424 </tr>
|
|
cannam@0
|
425 </table>
|
|
cannam@0
|
426 </div>
|
|
cannam@0
|
427 <div class="memdoc">
|
|
cannam@0
|
428
|
|
cannam@0
|
429 <p>
|
|
cannam@21
|
430 Return the preferred step size of the plugin wrapped by this adapter.
|
|
cannam@0
|
431 <p>
|
|
cannam@21
|
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).
|
|
cannam@0
|
433 </div>
|
|
cannam@0
|
434 </div><p>
|
|
cannam@21
|
435 <a class="anchor" name="7045be875de9dd226d2e2a222e957de0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize" ref="7045be875de9dd226d2e2a222e957de0" args="() const " -->
|
|
cannam@0
|
436 <div class="memitem">
|
|
cannam@0
|
437 <div class="memproto">
|
|
cannam@0
|
438 <table class="memname">
|
|
cannam@0
|
439 <tr>
|
|
cannam@21
|
440 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize </td>
|
|
cannam@0
|
441 <td>(</td>
|
|
cannam@0
|
442 <td class="paramname"> </td>
|
|
cannam@0
|
443 <td> ) </td>
|
|
cannam@21
|
444 <td> const</td>
|
|
cannam@21
|
445 </tr>
|
|
cannam@21
|
446 </table>
|
|
cannam@21
|
447 </div>
|
|
cannam@21
|
448 <div class="memdoc">
|
|
cannam@21
|
449
|
|
cannam@21
|
450 <p>
|
|
cannam@21
|
451 Return the preferred block size of the plugin wrapped by this adapter.
|
|
cannam@21
|
452 <p>
|
|
cannam@21
|
453 This is included mainly for informational purposes.
|
|
cannam@21
|
454 </div>
|
|
cannam@21
|
455 </div><p>
|
|
cannam@21
|
456 <a class="anchor" name="c99898d78a01a7fad4def4d6c5fd3a7e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize" ref="c99898d78a01a7fad4def4d6c5fd3a7e" args="(size_t stepSize)" -->
|
|
cannam@21
|
457 <div class="memitem">
|
|
cannam@21
|
458 <div class="memproto">
|
|
cannam@21
|
459 <table class="memname">
|
|
cannam@21
|
460 <tr>
|
|
cannam@21
|
461 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize </td>
|
|
cannam@21
|
462 <td>(</td>
|
|
cannam@21
|
463 <td class="paramtype">size_t </td>
|
|
cannam@21
|
464 <td class="paramname"> <em>stepSize</em> </td>
|
|
cannam@21
|
465 <td> ) </td>
|
|
cannam@21
|
466 <td></td>
|
|
cannam@21
|
467 </tr>
|
|
cannam@21
|
468 </table>
|
|
cannam@21
|
469 </div>
|
|
cannam@21
|
470 <div class="memdoc">
|
|
cannam@21
|
471
|
|
cannam@21
|
472 <p>
|
|
cannam@21
|
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.
|
|
cannam@21
|
474 <p>
|
|
cannam@21
|
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>.
|
|
cannam@21
|
476 </div>
|
|
cannam@21
|
477 </div><p>
|
|
cannam@21
|
478 <a class="anchor" name="a80ae1bff6f95e805811df2c3770a98c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize" ref="a80ae1bff6f95e805811df2c3770a98c" args="(size_t blockSize)" -->
|
|
cannam@21
|
479 <div class="memitem">
|
|
cannam@21
|
480 <div class="memproto">
|
|
cannam@21
|
481 <table class="memname">
|
|
cannam@21
|
482 <tr>
|
|
cannam@21
|
483 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize </td>
|
|
cannam@21
|
484 <td>(</td>
|
|
cannam@21
|
485 <td class="paramtype">size_t </td>
|
|
cannam@21
|
486 <td class="paramname"> <em>blockSize</em> </td>
|
|
cannam@21
|
487 <td> ) </td>
|
|
cannam@21
|
488 <td></td>
|
|
cannam@21
|
489 </tr>
|
|
cannam@21
|
490 </table>
|
|
cannam@21
|
491 </div>
|
|
cannam@21
|
492 <div class="memdoc">
|
|
cannam@21
|
493
|
|
cannam@21
|
494 <p>
|
|
cannam@21
|
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.
|
|
cannam@21
|
496 <p>
|
|
cannam@21
|
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>.
|
|
cannam@21
|
498 </div>
|
|
cannam@21
|
499 </div><p>
|
|
cannam@21
|
500 <a class="anchor" name="a065985fd864f6869d1bc7fea6fa2ece"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes" ref="a065985fd864f6869d1bc7fea6fa2ece" args="(size_t &stepSize, size_t &blockSize)" -->
|
|
cannam@21
|
501 <div class="memitem">
|
|
cannam@21
|
502 <div class="memproto">
|
|
cannam@21
|
503 <table class="memname">
|
|
cannam@21
|
504 <tr>
|
|
cannam@21
|
505 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes </td>
|
|
cannam@21
|
506 <td>(</td>
|
|
cannam@21
|
507 <td class="paramtype">size_t & </td>
|
|
cannam@21
|
508 <td class="paramname"> <em>stepSize</em>, </td>
|
|
cannam@21
|
509 </tr>
|
|
cannam@21
|
510 <tr>
|
|
cannam@21
|
511 <td class="paramkey"></td>
|
|
cannam@21
|
512 <td></td>
|
|
cannam@21
|
513 <td class="paramtype">size_t & </td>
|
|
cannam@21
|
514 <td class="paramname"> <em>blockSize</em></td><td> </td>
|
|
cannam@21
|
515 </tr>
|
|
cannam@21
|
516 <tr>
|
|
cannam@21
|
517 <td></td>
|
|
cannam@21
|
518 <td>)</td>
|
|
cannam@21
|
519 <td></td><td></td><td></td>
|
|
cannam@21
|
520 </tr>
|
|
cannam@21
|
521 </table>
|
|
cannam@21
|
522 </div>
|
|
cannam@21
|
523 <div class="memdoc">
|
|
cannam@21
|
524
|
|
cannam@21
|
525 <p>
|
|
cannam@21
|
526 Return the step and block sizes that were actually used when initialising the underlying plugin.
|
|
cannam@21
|
527 <p>
|
|
cannam@21
|
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.
|
|
cannam@21
|
529 </div>
|
|
cannam@21
|
530 </div><p>
|
|
cannam@21
|
531 <a class="anchor" name="7a979b20c169d37adbd7b7d8b8a077b3"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::setParameter" ref="7a979b20c169d37adbd7b7d8b8a077b3" args="(std::string, float)" -->
|
|
cannam@21
|
532 <div class="memitem">
|
|
cannam@21
|
533 <div class="memproto">
|
|
cannam@21
|
534 <table class="memname">
|
|
cannam@21
|
535 <tr>
|
|
cannam@21
|
536 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setParameter </td>
|
|
cannam@21
|
537 <td>(</td>
|
|
cannam@21
|
538 <td class="paramtype">std::string </td>
|
|
cannam@21
|
539 <td class="paramname">, </td>
|
|
cannam@21
|
540 </tr>
|
|
cannam@21
|
541 <tr>
|
|
cannam@21
|
542 <td class="paramkey"></td>
|
|
cannam@21
|
543 <td></td>
|
|
cannam@21
|
544 <td class="paramtype">float </td>
|
|
cannam@21
|
545 <td class="paramname"></td><td> </td>
|
|
cannam@21
|
546 </tr>
|
|
cannam@21
|
547 <tr>
|
|
cannam@21
|
548 <td></td>
|
|
cannam@21
|
549 <td>)</td>
|
|
cannam@21
|
550 <td></td><td></td><td><code> [virtual]</code></td>
|
|
cannam@21
|
551 </tr>
|
|
cannam@21
|
552 </table>
|
|
cannam@21
|
553 </div>
|
|
cannam@21
|
554 <div class="memdoc">
|
|
cannam@21
|
555
|
|
cannam@21
|
556 <p>
|
|
cannam@21
|
557 Set a named parameter.
|
|
cannam@21
|
558 <p>
|
|
cannam@21
|
559 The first argument is the identifier field from that parameter's descriptor.
|
|
cannam@21
|
560 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@21
|
561
|
|
cannam@21
|
562 </div>
|
|
cannam@21
|
563 </div><p>
|
|
cannam@21
|
564 <a class="anchor" name="3cc7000e0aff525950e0a286b87f8927"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::selectProgram" ref="3cc7000e0aff525950e0a286b87f8927" args="(std::string)" -->
|
|
cannam@21
|
565 <div class="memitem">
|
|
cannam@21
|
566 <div class="memproto">
|
|
cannam@21
|
567 <table class="memname">
|
|
cannam@21
|
568 <tr>
|
|
cannam@21
|
569 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::selectProgram </td>
|
|
cannam@21
|
570 <td>(</td>
|
|
cannam@21
|
571 <td class="paramtype">std::string </td>
|
|
cannam@21
|
572 <td class="paramname"> </td>
|
|
cannam@21
|
573 <td> ) </td>
|
|
cannam@21
|
574 <td><code> [virtual]</code></td>
|
|
cannam@21
|
575 </tr>
|
|
cannam@21
|
576 </table>
|
|
cannam@21
|
577 </div>
|
|
cannam@21
|
578 <div class="memdoc">
|
|
cannam@21
|
579
|
|
cannam@21
|
580 <p>
|
|
cannam@21
|
581 Select a program.
|
|
cannam@21
|
582 <p>
|
|
cannam@21
|
583 (If the given program name is not one of the available programs, do nothing.)
|
|
cannam@21
|
584 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@21
|
585
|
|
cannam@21
|
586 </div>
|
|
cannam@21
|
587 </div><p>
|
|
cannam@21
|
588 <a class="anchor" name="f8cc914897a284433de220f1153f3845"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors" ref="f8cc914897a284433de220f1153f3845" args="() const " -->
|
|
cannam@21
|
589 <div class="memitem">
|
|
cannam@21
|
590 <div class="memproto">
|
|
cannam@21
|
591 <table class="memname">
|
|
cannam@21
|
592 <tr>
|
|
cannam@21
|
593 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors </td>
|
|
cannam@21
|
594 <td>(</td>
|
|
cannam@21
|
595 <td class="paramname"> </td>
|
|
cannam@21
|
596 <td> ) </td>
|
|
cannam@21
|
597 <td> const<code> [virtual]</code></td>
|
|
cannam@0
|
598 </tr>
|
|
cannam@0
|
599 </table>
|
|
cannam@0
|
600 </div>
|
|
cannam@0
|
601 <div class="memdoc">
|
|
cannam@0
|
602
|
|
cannam@0
|
603 <p>
|
|
cannam@0
|
604 Get the outputs of this plugin.
|
|
cannam@0
|
605 <p>
|
|
cannam@21
|
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.
|
|
cannam@21
|
607 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
608
|
|
cannam@0
|
609 </div>
|
|
cannam@0
|
610 </div><p>
|
|
cannam@0
|
611 <a class="anchor" name="131fd9fe8a1795d7370d8a721176868a"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::reset" ref="131fd9fe8a1795d7370d8a721176868a" args="()" -->
|
|
cannam@0
|
612 <div class="memitem">
|
|
cannam@0
|
613 <div class="memproto">
|
|
cannam@0
|
614 <table class="memname">
|
|
cannam@0
|
615 <tr>
|
|
cannam@0
|
616 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::reset </td>
|
|
cannam@0
|
617 <td>(</td>
|
|
cannam@0
|
618 <td class="paramname"> </td>
|
|
cannam@0
|
619 <td> ) </td>
|
|
cannam@21
|
620 <td><code> [virtual]</code></td>
|
|
cannam@0
|
621 </tr>
|
|
cannam@0
|
622 </table>
|
|
cannam@0
|
623 </div>
|
|
cannam@0
|
624 <div class="memdoc">
|
|
cannam@0
|
625
|
|
cannam@0
|
626 <p>
|
|
cannam@0
|
627 Reset the plugin after use, to prepare it for another clean run.
|
|
cannam@0
|
628 <p>
|
|
cannam@0
|
629 Not called for the first initialisation (i.e. initialise must also do a reset).
|
|
cannam@0
|
630 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
631
|
|
cannam@0
|
632 </div>
|
|
cannam@0
|
633 </div><p>
|
|
cannam@21
|
634 <a class="anchor" name="55058a20c1f8bffc0dc927350df778a0"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::process" ref="55058a20c1f8bffc0dc927350df778a0" args="(const float *const *inputBuffers, RealTime timestamp)" -->
|
|
cannam@0
|
635 <div class="memitem">
|
|
cannam@0
|
636 <div class="memproto">
|
|
cannam@0
|
637 <table class="memname">
|
|
cannam@0
|
638 <tr>
|
|
cannam@21
|
639 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::process </td>
|
|
cannam@0
|
640 <td>(</td>
|
|
cannam@0
|
641 <td class="paramtype">const float *const * </td>
|
|
cannam@0
|
642 <td class="paramname"> <em>inputBuffers</em>, </td>
|
|
cannam@0
|
643 </tr>
|
|
cannam@0
|
644 <tr>
|
|
cannam@0
|
645 <td class="paramkey"></td>
|
|
cannam@0
|
646 <td></td>
|
|
cannam@0
|
647 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td>
|
|
cannam@0
|
648 <td class="paramname"> <em>timestamp</em></td><td> </td>
|
|
cannam@0
|
649 </tr>
|
|
cannam@0
|
650 <tr>
|
|
cannam@0
|
651 <td></td>
|
|
cannam@0
|
652 <td>)</td>
|
|
cannam@21
|
653 <td></td><td></td><td><code> [virtual]</code></td>
|
|
cannam@0
|
654 </tr>
|
|
cannam@0
|
655 </table>
|
|
cannam@0
|
656 </div>
|
|
cannam@0
|
657 <div class="memdoc">
|
|
cannam@0
|
658
|
|
cannam@0
|
659 <p>
|
|
cannam@0
|
660 Process a single block of input data.
|
|
cannam@0
|
661 <p>
|
|
cannam@21
|
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>
|
|
cannam@0
|
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>
|
|
cannam@0
|
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.)
|
|
cannam@21
|
665 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
666
|
|
cannam@0
|
667 </div>
|
|
cannam@0
|
668 </div><p>
|
|
cannam@21
|
669 <a class="anchor" name="28423951b2eda1a1fc371485434f417b"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures" ref="28423951b2eda1a1fc371485434f417b" args="()" -->
|
|
cannam@0
|
670 <div class="memitem">
|
|
cannam@0
|
671 <div class="memproto">
|
|
cannam@0
|
672 <table class="memname">
|
|
cannam@0
|
673 <tr>
|
|
cannam@21
|
674 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures </td>
|
|
cannam@0
|
675 <td>(</td>
|
|
cannam@0
|
676 <td class="paramname"> </td>
|
|
cannam@0
|
677 <td> ) </td>
|
|
cannam@21
|
678 <td><code> [virtual]</code></td>
|
|
cannam@0
|
679 </tr>
|
|
cannam@0
|
680 </table>
|
|
cannam@0
|
681 </div>
|
|
cannam@0
|
682 <div class="memdoc">
|
|
cannam@0
|
683
|
|
cannam@0
|
684 <p>
|
|
cannam@0
|
685 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
|
|
cannam@0
|
686 <p>
|
|
cannam@0
|
687
|
|
cannam@21
|
688 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
cannam@0
|
689
|
|
cannam@0
|
690 </div>
|
|
cannam@0
|
691 </div><p>
|
|
cannam@21
|
692 <a class="anchor" name="e203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getInputDomain" ref="e203faf8384c9e1fddc381409aa8a214" args="() const " -->
|
|
cannam@0
|
693 <div class="memitem">
|
|
cannam@0
|
694 <div class="memproto">
|
|
cannam@0
|
695 <table class="memname">
|
|
cannam@0
|
696 <tr>
|
|
cannam@21
|
697 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
|
|
cannam@0
|
698 <td>(</td>
|
|
cannam@0
|
699 <td class="paramname"> </td>
|
|
cannam@0
|
700 <td> ) </td>
|
|
cannam@21
|
701 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
702 </tr>
|
|
cannam@0
|
703 </table>
|
|
cannam@0
|
704 </div>
|
|
cannam@0
|
705 <div class="memdoc">
|
|
cannam@0
|
706
|
|
cannam@0
|
707 <p>
|
|
cannam@0
|
708 Get the plugin's required input domain.
|
|
cannam@0
|
709 <p>
|
|
cannam@21
|
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.
|
|
cannam@0
|
711 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
712
|
|
cannam@21
|
713 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
|
|
cannam@0
|
714
|
|
cannam@0
|
715 </div>
|
|
cannam@0
|
716 </div><p>
|
|
cannam@0
|
717 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
|
|
cannam@0
|
718 <div class="memitem">
|
|
cannam@0
|
719 <div class="memproto">
|
|
cannam@0
|
720 <table class="memname">
|
|
cannam@0
|
721 <tr>
|
|
cannam@0
|
722 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
|
|
cannam@0
|
723 <td>(</td>
|
|
cannam@0
|
724 <td class="paramname"> </td>
|
|
cannam@0
|
725 <td> ) </td>
|
|
cannam@21
|
726 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
727 </tr>
|
|
cannam@0
|
728 </table>
|
|
cannam@0
|
729 </div>
|
|
cannam@0
|
730 <div class="memdoc">
|
|
cannam@0
|
731
|
|
cannam@0
|
732 <p>
|
|
cannam@21
|
733 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
|
|
cannam@0
|
734 <p>
|
|
cannam@0
|
735
|
|
cannam@0
|
736 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
737
|
|
cannam@0
|
738 </div>
|
|
cannam@0
|
739 </div><p>
|
|
cannam@0
|
740 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
|
|
cannam@0
|
741 <div class="memitem">
|
|
cannam@0
|
742 <div class="memproto">
|
|
cannam@0
|
743 <table class="memname">
|
|
cannam@0
|
744 <tr>
|
|
cannam@0
|
745 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
|
|
cannam@0
|
746 <td>(</td>
|
|
cannam@0
|
747 <td class="paramname"> </td>
|
|
cannam@0
|
748 <td> ) </td>
|
|
cannam@21
|
749 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
750 </tr>
|
|
cannam@0
|
751 </table>
|
|
cannam@0
|
752 </div>
|
|
cannam@0
|
753 <div class="memdoc">
|
|
cannam@0
|
754
|
|
cannam@0
|
755 <p>
|
|
cannam@0
|
756 Get the computer-usable name of the plugin.
|
|
cannam@0
|
757 <p>
|
|
cannam@0
|
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>
|
|
cannam@0
|
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>
|
|
cannam@0
|
760 Example: "zero_crossings"
|
|
cannam@0
|
761 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
762
|
|
cannam@0
|
763 </div>
|
|
cannam@0
|
764 </div><p>
|
|
cannam@0
|
765 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
|
|
cannam@0
|
766 <div class="memitem">
|
|
cannam@0
|
767 <div class="memproto">
|
|
cannam@0
|
768 <table class="memname">
|
|
cannam@0
|
769 <tr>
|
|
cannam@0
|
770 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
|
|
cannam@0
|
771 <td>(</td>
|
|
cannam@0
|
772 <td class="paramname"> </td>
|
|
cannam@0
|
773 <td> ) </td>
|
|
cannam@21
|
774 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
775 </tr>
|
|
cannam@0
|
776 </table>
|
|
cannam@0
|
777 </div>
|
|
cannam@0
|
778 <div class="memdoc">
|
|
cannam@0
|
779
|
|
cannam@0
|
780 <p>
|
|
cannam@0
|
781 Get a human-readable name or title of the plugin.
|
|
cannam@0
|
782 <p>
|
|
cannam@0
|
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>
|
|
cannam@0
|
784 Example: "Zero Crossings"
|
|
cannam@0
|
785 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
786
|
|
cannam@0
|
787 </div>
|
|
cannam@0
|
788 </div><p>
|
|
cannam@0
|
789 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
|
|
cannam@0
|
790 <div class="memitem">
|
|
cannam@0
|
791 <div class="memproto">
|
|
cannam@0
|
792 <table class="memname">
|
|
cannam@0
|
793 <tr>
|
|
cannam@0
|
794 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
|
|
cannam@0
|
795 <td>(</td>
|
|
cannam@0
|
796 <td class="paramname"> </td>
|
|
cannam@0
|
797 <td> ) </td>
|
|
cannam@21
|
798 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
799 </tr>
|
|
cannam@0
|
800 </table>
|
|
cannam@0
|
801 </div>
|
|
cannam@0
|
802 <div class="memdoc">
|
|
cannam@0
|
803
|
|
cannam@0
|
804 <p>
|
|
cannam@0
|
805 Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name".
|
|
cannam@0
|
806 <p>
|
|
cannam@0
|
807 May be empty if the name has said it all already.<p>
|
|
cannam@0
|
808 Example: "Detect and count zero crossing points"
|
|
cannam@0
|
809 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
810
|
|
cannam@0
|
811 </div>
|
|
cannam@0
|
812 </div><p>
|
|
cannam@0
|
813 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
|
|
cannam@0
|
814 <div class="memitem">
|
|
cannam@0
|
815 <div class="memproto">
|
|
cannam@0
|
816 <table class="memname">
|
|
cannam@0
|
817 <tr>
|
|
cannam@0
|
818 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
|
|
cannam@0
|
819 <td>(</td>
|
|
cannam@0
|
820 <td class="paramname"> </td>
|
|
cannam@0
|
821 <td> ) </td>
|
|
cannam@21
|
822 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
823 </tr>
|
|
cannam@0
|
824 </table>
|
|
cannam@0
|
825 </div>
|
|
cannam@0
|
826 <div class="memdoc">
|
|
cannam@0
|
827
|
|
cannam@0
|
828 <p>
|
|
cannam@0
|
829 Get the name of the author or vendor of the plugin in human-readable form.
|
|
cannam@0
|
830 <p>
|
|
cannam@0
|
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.
|
|
cannam@0
|
832 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
833
|
|
cannam@0
|
834 </div>
|
|
cannam@0
|
835 </div><p>
|
|
cannam@0
|
836 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
|
|
cannam@0
|
837 <div class="memitem">
|
|
cannam@0
|
838 <div class="memproto">
|
|
cannam@0
|
839 <table class="memname">
|
|
cannam@0
|
840 <tr>
|
|
cannam@0
|
841 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
|
|
cannam@0
|
842 <td>(</td>
|
|
cannam@0
|
843 <td class="paramname"> </td>
|
|
cannam@0
|
844 <td> ) </td>
|
|
cannam@21
|
845 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
846 </tr>
|
|
cannam@0
|
847 </table>
|
|
cannam@0
|
848 </div>
|
|
cannam@0
|
849 <div class="memdoc">
|
|
cannam@0
|
850
|
|
cannam@0
|
851 <p>
|
|
cannam@0
|
852 Get the version number of the plugin.
|
|
cannam@0
|
853 <p>
|
|
cannam@0
|
854
|
|
cannam@0
|
855 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
856
|
|
cannam@0
|
857 </div>
|
|
cannam@0
|
858 </div><p>
|
|
cannam@0
|
859 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
|
|
cannam@0
|
860 <div class="memitem">
|
|
cannam@0
|
861 <div class="memproto">
|
|
cannam@0
|
862 <table class="memname">
|
|
cannam@0
|
863 <tr>
|
|
cannam@0
|
864 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
|
|
cannam@0
|
865 <td>(</td>
|
|
cannam@0
|
866 <td class="paramname"> </td>
|
|
cannam@0
|
867 <td> ) </td>
|
|
cannam@21
|
868 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
869 </tr>
|
|
cannam@0
|
870 </table>
|
|
cannam@0
|
871 </div>
|
|
cannam@0
|
872 <div class="memdoc">
|
|
cannam@0
|
873
|
|
cannam@0
|
874 <p>
|
|
cannam@0
|
875 Get the copyright statement or licensing summary for the plugin.
|
|
cannam@0
|
876 <p>
|
|
cannam@0
|
877 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
|
|
cannam@0
|
878 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
879
|
|
cannam@0
|
880 </div>
|
|
cannam@0
|
881 </div><p>
|
|
cannam@21
|
882 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
|
|
cannam@0
|
883 <div class="memitem">
|
|
cannam@0
|
884 <div class="memproto">
|
|
cannam@0
|
885 <table class="memname">
|
|
cannam@0
|
886 <tr>
|
|
cannam@21
|
887 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
|
|
cannam@0
|
888 <td>(</td>
|
|
cannam@0
|
889 <td class="paramname"> </td>
|
|
cannam@0
|
890 <td> ) </td>
|
|
cannam@21
|
891 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
892 </tr>
|
|
cannam@0
|
893 </table>
|
|
cannam@0
|
894 </div>
|
|
cannam@0
|
895 <div class="memdoc">
|
|
cannam@0
|
896
|
|
cannam@0
|
897 <p>
|
|
cannam@0
|
898 Get the controllable parameters of this plugin.
|
|
cannam@0
|
899 <p>
|
|
cannam@0
|
900
|
|
cannam@0
|
901 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
902
|
|
cannam@0
|
903 </div>
|
|
cannam@0
|
904 </div><p>
|
|
cannam@0
|
905 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
|
|
cannam@0
|
906 <div class="memitem">
|
|
cannam@0
|
907 <div class="memproto">
|
|
cannam@0
|
908 <table class="memname">
|
|
cannam@0
|
909 <tr>
|
|
cannam@0
|
910 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
|
|
cannam@0
|
911 <td>(</td>
|
|
cannam@0
|
912 <td class="paramtype">std::string </td>
|
|
cannam@0
|
913 <td class="paramname"> </td>
|
|
cannam@0
|
914 <td> ) </td>
|
|
cannam@21
|
915 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
916 </tr>
|
|
cannam@0
|
917 </table>
|
|
cannam@0
|
918 </div>
|
|
cannam@0
|
919 <div class="memdoc">
|
|
cannam@0
|
920
|
|
cannam@0
|
921 <p>
|
|
cannam@0
|
922 Get the value of a named parameter.
|
|
cannam@0
|
923 <p>
|
|
cannam@0
|
924 The argument is the identifier field from that parameter's descriptor.
|
|
cannam@0
|
925 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
926
|
|
cannam@0
|
927 </div>
|
|
cannam@0
|
928 </div><p>
|
|
cannam@21
|
929 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " -->
|
|
cannam@0
|
930 <div class="memitem">
|
|
cannam@0
|
931 <div class="memproto">
|
|
cannam@0
|
932 <table class="memname">
|
|
cannam@0
|
933 <tr>
|
|
cannam@21
|
934 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
|
|
cannam@0
|
935 <td>(</td>
|
|
cannam@0
|
936 <td class="paramname"> </td>
|
|
cannam@0
|
937 <td> ) </td>
|
|
cannam@21
|
938 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
939 </tr>
|
|
cannam@0
|
940 </table>
|
|
cannam@0
|
941 </div>
|
|
cannam@0
|
942 <div class="memdoc">
|
|
cannam@0
|
943
|
|
cannam@0
|
944 <p>
|
|
cannam@0
|
945 Get the program settings available in this plugin.
|
|
cannam@0
|
946 <p>
|
|
cannam@0
|
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>
|
|
cannam@0
|
948 The programs must have unique names.
|
|
cannam@0
|
949 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
950
|
|
cannam@0
|
951 </div>
|
|
cannam@0
|
952 </div><p>
|
|
cannam@0
|
953 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
|
|
cannam@0
|
954 <div class="memitem">
|
|
cannam@0
|
955 <div class="memproto">
|
|
cannam@0
|
956 <table class="memname">
|
|
cannam@0
|
957 <tr>
|
|
cannam@0
|
958 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
|
|
cannam@0
|
959 <td>(</td>
|
|
cannam@0
|
960 <td class="paramname"> </td>
|
|
cannam@0
|
961 <td> ) </td>
|
|
cannam@21
|
962 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
963 </tr>
|
|
cannam@0
|
964 </table>
|
|
cannam@0
|
965 </div>
|
|
cannam@0
|
966 <div class="memdoc">
|
|
cannam@0
|
967
|
|
cannam@0
|
968 <p>
|
|
cannam@0
|
969 Get the current program.
|
|
cannam@0
|
970 <p>
|
|
cannam@0
|
971
|
|
cannam@0
|
972 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
973
|
|
cannam@0
|
974 </div>
|
|
cannam@0
|
975 </div><p>
|
|
cannam@0
|
976 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
|
|
cannam@0
|
977 <div class="memitem">
|
|
cannam@0
|
978 <div class="memproto">
|
|
cannam@0
|
979 <table class="memname">
|
|
cannam@0
|
980 <tr>
|
|
cannam@0
|
981 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
|
|
cannam@0
|
982 <td>(</td>
|
|
cannam@0
|
983 <td class="paramname"> </td>
|
|
cannam@0
|
984 <td> ) </td>
|
|
cannam@21
|
985 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
986 </tr>
|
|
cannam@0
|
987 </table>
|
|
cannam@0
|
988 </div>
|
|
cannam@0
|
989 <div class="memdoc">
|
|
cannam@0
|
990
|
|
cannam@0
|
991 <p>
|
|
cannam@0
|
992 Get the minimum supported number of input channels.
|
|
cannam@0
|
993 <p>
|
|
cannam@0
|
994
|
|
cannam@0
|
995 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
996
|
|
cannam@0
|
997 </div>
|
|
cannam@0
|
998 </div><p>
|
|
cannam@0
|
999 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
|
|
cannam@0
|
1000 <div class="memitem">
|
|
cannam@0
|
1001 <div class="memproto">
|
|
cannam@0
|
1002 <table class="memname">
|
|
cannam@0
|
1003 <tr>
|
|
cannam@0
|
1004 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
|
|
cannam@0
|
1005 <td>(</td>
|
|
cannam@0
|
1006 <td class="paramname"> </td>
|
|
cannam@0
|
1007 <td> ) </td>
|
|
cannam@21
|
1008 <td> const<code> [virtual, inherited]</code></td>
|
|
cannam@0
|
1009 </tr>
|
|
cannam@0
|
1010 </table>
|
|
cannam@0
|
1011 </div>
|
|
cannam@0
|
1012 <div class="memdoc">
|
|
cannam@0
|
1013
|
|
cannam@0
|
1014 <p>
|
|
cannam@0
|
1015 Get the maximum supported number of input channels.
|
|
cannam@0
|
1016 <p>
|
|
cannam@0
|
1017
|
|
cannam@0
|
1018 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
|
|
cannam@0
|
1019
|
|
cannam@21
|
1020 </div>
|
|
cannam@21
|
1021 </div><p>
|
|
cannam@21
|
1022 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
|
|
cannam@21
|
1023 <div class="memitem">
|
|
cannam@21
|
1024 <div class="memproto">
|
|
cannam@21
|
1025 <div class="memtemplate">
|
|
cannam@21
|
1026 template<typename WrapperType> </div>
|
|
cannam@21
|
1027 <table class="memname">
|
|
cannam@21
|
1028 <tr>
|
|
cannam@21
|
1029 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
|
|
cannam@21
|
1030 <td>(</td>
|
|
cannam@21
|
1031 <td class="paramname"> </td>
|
|
cannam@21
|
1032 <td> ) </td>
|
|
cannam@21
|
1033 <td><code> [inline, inherited]</code></td>
|
|
cannam@21
|
1034 </tr>
|
|
cannam@21
|
1035 </table>
|
|
cannam@21
|
1036 </div>
|
|
cannam@21
|
1037 <div class="memdoc">
|
|
cannam@0
|
1038
|
|
cannam@21
|
1039 <p>
|
|
cannam@21
|
1040 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
|
|
cannam@21
|
1041 <p>
|
|
cannam@21
|
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.
|
|
cannam@21
|
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>
|
|
cannam@21
|
1044
|
|
cannam@21
|
1045 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
|
|
cannam@21
|
1046
|
|
cannam@21
|
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>
|
|
cannam@0
|
1048
|
|
cannam@0
|
1049 </div>
|
|
cannam@0
|
1050 </div><p>
|
|
cannam@0
|
1051 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
|
|
cannam@0
|
1052 <div class="memitem">
|
|
cannam@0
|
1053 <div class="memproto">
|
|
cannam@0
|
1054 <table class="memname">
|
|
cannam@0
|
1055 <tr>
|
|
cannam@0
|
1056 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
|
|
cannam@0
|
1057 <td>(</td>
|
|
cannam@0
|
1058 <td class="paramname"> </td>
|
|
cannam@0
|
1059 <td> ) </td>
|
|
cannam@21
|
1060 <td> const<code> [inline, virtual, inherited]</code></td>
|
|
cannam@0
|
1061 </tr>
|
|
cannam@0
|
1062 </table>
|
|
cannam@0
|
1063 </div>
|
|
cannam@0
|
1064 <div class="memdoc">
|
|
cannam@0
|
1065
|
|
cannam@0
|
1066 <p>
|
|
cannam@0
|
1067 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
|
|
cannam@0
|
1068 <p>
|
|
cannam@0
|
1069 Do not reimplement this function in your subclass.
|
|
cannam@0
|
1070 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
|
|
cannam@0
|
1071
|
|
cannam@21
|
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>
|
|
cannam@0
|
1073
|
|
cannam@0
|
1074 </div>
|
|
cannam@0
|
1075 </div><p>
|
|
cannam@0
|
1076 <hr><h2>Member Data Documentation</h2>
|
|
cannam@0
|
1077 <a class="anchor" name="51e10c9c63c0349fd74c6d604de5554e"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_impl" ref="51e10c9c63c0349fd74c6d604de5554e" args="" -->
|
|
cannam@0
|
1078 <div class="memitem">
|
|
cannam@0
|
1079 <div class="memproto">
|
|
cannam@0
|
1080 <table class="memname">
|
|
cannam@0
|
1081 <tr>
|
|
cannam@21
|
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>
|
|
cannam@0
|
1083 </tr>
|
|
cannam@0
|
1084 </table>
|
|
cannam@0
|
1085 </div>
|
|
cannam@0
|
1086 <div class="memdoc">
|
|
cannam@0
|
1087
|
|
cannam@0
|
1088 <p>
|
|
cannam@0
|
1089
|
|
cannam@21
|
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>
|
|
cannam@0
|
1091
|
|
cannam@0
|
1092 </div>
|
|
cannam@0
|
1093 </div><p>
|
|
cannam@0
|
1094 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
|
|
cannam@0
|
1095 <div class="memitem">
|
|
cannam@0
|
1096 <div class="memproto">
|
|
cannam@0
|
1097 <table class="memname">
|
|
cannam@0
|
1098 <tr>
|
|
cannam@0
|
1099 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code> </td>
|
|
cannam@0
|
1100 </tr>
|
|
cannam@0
|
1101 </table>
|
|
cannam@0
|
1102 </div>
|
|
cannam@0
|
1103 <div class="memdoc">
|
|
cannam@0
|
1104
|
|
cannam@0
|
1105 <p>
|
|
cannam@0
|
1106
|
|
cannam@21
|
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>
|
|
cannam@0
|
1108
|
|
cannam@0
|
1109 </div>
|
|
cannam@0
|
1110 </div><p>
|
|
cannam@0
|
1111 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginBufferingAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
|
|
cannam@0
|
1112 <div class="memitem">
|
|
cannam@0
|
1113 <div class="memproto">
|
|
cannam@0
|
1114 <table class="memname">
|
|
cannam@0
|
1115 <tr>
|
|
cannam@0
|
1116 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
|
|
cannam@0
|
1117 </tr>
|
|
cannam@0
|
1118 </table>
|
|
cannam@0
|
1119 </div>
|
|
cannam@0
|
1120 <div class="memdoc">
|
|
cannam@0
|
1121
|
|
cannam@0
|
1122 <p>
|
|
cannam@0
|
1123
|
|
cannam@21
|
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>
|
|
cannam@0
|
1125
|
|
cannam@21
|
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>
|
|
cannam@0
|
1127
|
|
cannam@0
|
1128 </div>
|
|
cannam@0
|
1129 </div><p>
|
|
cannam@21
|
1130 <hr>The documentation for this class was generated from the following file:<ul>
|
|
cannam@21
|
1131 <li><a class="el" href="PluginBufferingAdapter_8h-source.html">PluginBufferingAdapter.h</a></ul>
|
|
cannam@0
|
1132 </div>
|
|
cannam@21
|
1133 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by
|
|
cannam@0
|
1134 <a href="http://www.doxygen.org/index.html">
|
|
cannam@21
|
1135 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
|
|
cannam@0
|
1136 </body>
|
|
cannam@0
|
1137 </html>
|
