Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginWrapper.html @ 0:351c4ebce5f9 website

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