Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1PluginHostAdapter.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::PluginHostAdapter 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="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a>
26 </div>
27 </div>
28 <div class="contents">
29 <h1>Vamp::PluginHostAdapter Class Reference</h1><!-- doxytag: class="Vamp::PluginHostAdapter" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="PluginHostAdapter_8h-source.html">vamp-sdk/PluginHostAdapter.h</a>&gt;</code>
30 <p>
31 <div class="dynheader">
32 Inheritance diagram for Vamp::PluginHostAdapter:</div>
33 <div class="dynsection">
34 <p><center><img src="classVamp_1_1PluginHostAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginHostAdapter__inherit__map" alt="Inheritance graph"></center>
35 <map name="Vamp_1_1PluginHostAdapter__inherit__map">
36 <area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="41,82,140,106"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="27,7,155,31"></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_1PluginHostAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
41 <a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> object.
42 <p>
43 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 is defined in <a class="el" href="vamp_8h.html">vamp/vamp.h</a> as a C API. The C++ objects used for convenience by plugins and hosts actually communicate using the C low-level API, but the details of this communication are handled seamlessly by the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> SDK implementation provided the plugin and host use the proper C++ wrapper objects.<p>
44 See also <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a>, the plugin-side wrapper that makes a C++ plugin object available using the C query API.
45 <p>Definition at line <a class="el" href="PluginHostAdapter_8h-source.html#l00064">64</a> of file <a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a>.</p>
46 <table border="0" cellpadding="0" cellspacing="0">
47 <tr><td></td></tr>
48 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
50 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
51 }</td></tr>
52
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
54 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
55
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
57
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; int, <br>
59 <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
60
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br>
62 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
63
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
65
66 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
67 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#6535abd551acfbbaab381bbe1268cd49">PluginHostAdapter</a> (const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *descriptor, float inputSampleRate)</td></tr>
68
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#b0f354cb332852ab1892488f6b8e8c0e">~PluginHostAdapter</a> ()</td></tr>
70
71 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
72
73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#dd6a2f1ee7e47bd97fa599cead14b738"></a><br></td></tr>
74 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#5d54c5bbd76bc27b7a243827148afeaa">reset</a> ()</td></tr>
75
76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#5d54c5bbd76bc27b7a243827148afeaa"></a><br></td></tr>
77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#9c5239a4da67f1a426cd059e1a2856eb">getInputDomain</a> () const </td></tr>
78
79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#9c5239a4da67f1a426cd059e1a2856eb"></a><br></td></tr>
80 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">getVampApiVersion</a> () const </td></tr>
81
82 <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="#98aadddc8403eb46c9d8c5a9d1fdd19e"></a><br></td></tr>
83 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#b27423a656f878d97d2ad2eba4e76c7a">getIdentifier</a> () const </td></tr>
84
85 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#b27423a656f878d97d2ad2eba4e76c7a"></a><br></td></tr>
86 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#45f1d0377e233eeddd1b7cefb48be62a">getName</a> () const </td></tr>
87
88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#45f1d0377e233eeddd1b7cefb48be62a"></a><br></td></tr>
89 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#5eaafcef030e81b90a3e77cf16cf8ae1">getDescription</a> () const </td></tr>
90
91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#5eaafcef030e81b90a3e77cf16cf8ae1"></a><br></td></tr>
92 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#f572be0b175f5661559006a380a0f3db">getMaker</a> () const </td></tr>
93
94 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#f572be0b175f5661559006a380a0f3db"></a><br></td></tr>
95 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#6fbd94781867ca46a20368c2a3593c77">getPluginVersion</a> () const </td></tr>
96
97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#6fbd94781867ca46a20368c2a3593c77"></a><br></td></tr>
98 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#c73c9d6baad04369beee695e99584815">getCopyright</a> () const </td></tr>
99
100 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#c73c9d6baad04369beee695e99584815"></a><br></td></tr>
101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#bfa93b20d9b5651a32042a9bb7c8df13">getParameterDescriptors</a> () const </td></tr>
102
103 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#bfa93b20d9b5651a32042a9bb7c8df13"></a><br></td></tr>
104 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#f0c46d4f67ca93be7c76f3ea2e6c8efb">getParameter</a> (std::string) const </td></tr>
105
106 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#f0c46d4f67ca93be7c76f3ea2e6c8efb"></a><br></td></tr>
107 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#29f75395aa75b9de0228aa11edf9c6d6">setParameter</a> (std::string, float)</td></tr>
108
109 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#29f75395aa75b9de0228aa11edf9c6d6"></a><br></td></tr>
110 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#7ac5681dcfe08b7b8a796bffc0aff3e3">getPrograms</a> () const </td></tr>
111
112 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#7ac5681dcfe08b7b8a796bffc0aff3e3"></a><br></td></tr>
113 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">getCurrentProgram</a> () const </td></tr>
114
115 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#34859eff8ca8d862af39be9636ec1867"></a><br></td></tr>
116 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">selectProgram</a> (std::string)</td></tr>
117
118 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#8f5515ab34cc13d9403ccc6b4b788683"></a><br></td></tr>
119 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#859ad5d59402691daed3cf1af1899ebe">getPreferredStepSize</a> () const </td></tr>
120
121 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#859ad5d59402691daed3cf1af1899ebe"></a><br></td></tr>
122 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#d5e0ea8042bdec4dd18428991117e07a">getPreferredBlockSize</a> () const </td></tr>
123
124 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" title="Process a single block of input data.">process()</a> function). <a href="#d5e0ea8042bdec4dd18428991117e07a"></a><br></td></tr>
125 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#67d1198c0e58d3f0076d0eda599ff28d">getMinChannelCount</a> () const </td></tr>
126
127 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#67d1198c0e58d3f0076d0eda599ff28d"></a><br></td></tr>
128 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#25091905e97e39d515d8ffc1a9f2b9e0">getMaxChannelCount</a> () const </td></tr>
129
130 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#25091905e97e39d515d8ffc1a9f2b9e0"></a><br></td></tr>
131 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#e02670cca9d25cdc4100cbe7a12e3e68">getOutputDescriptors</a> () const </td></tr>
132
133 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#e02670cca9d25cdc4100cbe7a12e3e68"></a><br></td></tr>
134 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
135
136 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#82c29a512c0587ea0121eee4b0c2a684"></a><br></td></tr>
137 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#d3f5f16a89a821da2ec1186fd2062e83">getRemainingFeatures</a> ()</td></tr>
138
139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#d3f5f16a89a821da2ec1186fd2062e83"></a><br></td></tr>
140 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
141
142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
143 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
144 <tr><td class="memItemLeft" nowrap align="right" valign="top">static std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#08d7ed3a11bf4a3c30fa0f9b41a0fed6">getPluginPath</a> ()</td></tr>
145
146 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
147 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ee417a4c9ba9dbb63777c963d5f9452a">convertFeatures</a> (<a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *, <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;)</td></tr>
148
149 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
150 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#0c9f252aca8ac298e30cadd0de032ec2">m_descriptor</a></td></tr>
151
152 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#02ebd03b226b4a467cad747ce77e79ee">m_handle</a></td></tr>
153
154 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
155
156 </table>
157 <hr><h2>Member Typedef Documentation</h2>
158 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::PluginHostAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
159 <div class="memitem">
160 <div class="memproto">
161 <table class="memname">
162 <tr>
163 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td>
164 </tr>
165 </table>
166 </div>
167 <div class="memdoc">
168
169 <p>
170
171 <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>
172
173 </div>
174 </div><p>
175 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::PluginHostAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
176 <div class="memitem">
177 <div class="memproto">
178 <table class="memname">
179 <tr>
180 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td>
181 </tr>
182 </table>
183 </div>
184 <div class="memdoc">
185
186 <p>
187
188 <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>
189
190 </div>
191 </div><p>
192 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::PluginHostAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
196 <tr>
197 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td>
198 </tr>
199 </table>
200 </div>
201 <div class="memdoc">
202
203 <p>
204
205 <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>
206
207 </div>
208 </div><p>
209 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::PluginHostAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
210 <div class="memitem">
211 <div class="memproto">
212 <table class="memname">
213 <tr>
214 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td>
215 </tr>
216 </table>
217 </div>
218 <div class="memdoc">
219
220 <p>
221
222 <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>
223
224 </div>
225 </div><p>
226 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::PluginHostAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
227 <div class="memitem">
228 <div class="memproto">
229 <table class="memname">
230 <tr>
231 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td>
232 </tr>
233 </table>
234 </div>
235 <div class="memdoc">
236
237 <p>
238
239 <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>
240
241 </div>
242 </div><p>
243 <hr><h2>Member Enumeration Documentation</h2>
244 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::PluginHostAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
245 <div class="memitem">
246 <div class="memproto">
247 <table class="memname">
248 <tr>
249 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td>
250 </tr>
251 </table>
252 </div>
253 <div class="memdoc">
254
255 <p>
256 <dl compact><dt><b>Enumerator: </b></dt><dd>
257 <table border="0" cellspacing="2" cellpadding="0">
258 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
259 </td></tr>
260 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
261 </td></tr>
262 </table>
263 </dl>
264
265 <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>
266
267 </div>
268 </div><p>
269 <hr><h2>Constructor &amp; Destructor Documentation</h2>
270 <a class="anchor" name="6535abd551acfbbaab381bbe1268cd49"></a><!-- doxytag: member="Vamp::PluginHostAdapter::PluginHostAdapter" ref="6535abd551acfbbaab381bbe1268cd49" args="(const VampPluginDescriptor *descriptor, float inputSampleRate)" -->
271 <div class="memitem">
272 <div class="memproto">
273 <table class="memname">
274 <tr>
275 <td class="memname">Vamp::PluginHostAdapter::PluginHostAdapter </td>
276 <td>(</td>
277 <td class="paramtype">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *&nbsp;</td>
278 <td class="paramname"> <em>descriptor</em>, </td>
279 </tr>
280 <tr>
281 <td class="paramkey"></td>
282 <td></td>
283 <td class="paramtype">float&nbsp;</td>
284 <td class="paramname"> <em>inputSampleRate</em></td><td>&nbsp;</td>
285 </tr>
286 <tr>
287 <td></td>
288 <td>)</td>
289 <td></td><td></td><td width="100%"></td>
290 </tr>
291 </table>
292 </div>
293 <div class="memdoc">
294
295 <p>
296
297 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00043">43</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
298
299 <p>References <a class="el" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee">_VampPluginDescriptor::instantiate</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
300
301 </div>
302 </div><p>
303 <a class="anchor" name="b0f354cb332852ab1892488f6b8e8c0e"></a><!-- doxytag: member="Vamp::PluginHostAdapter::~PluginHostAdapter" ref="b0f354cb332852ab1892488f6b8e8c0e" args="()" -->
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
307 <tr>
308 <td class="memname">Vamp::PluginHostAdapter::~PluginHostAdapter </td>
309 <td>(</td>
310 <td class="paramname"> </td>
311 <td>&nbsp;)&nbsp;</td>
312 <td width="100%"><code> [virtual]</code></td>
313 </tr>
314 </table>
315 </div>
316 <div class="memdoc">
317
318 <p>
319
320 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00055">55</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
321
322 <p>References <a class="el" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27">_VampPluginDescriptor::cleanup</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
323
324 </div>
325 </div><p>
326 <hr><h2>Member Function Documentation</h2>
327 <a class="anchor" name="08d7ed3a11bf4a3c30fa0f9b41a0fed6"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPluginPath" ref="08d7ed3a11bf4a3c30fa0f9b41a0fed6" args="()" -->
328 <div class="memitem">
329 <div class="memproto">
330 <table class="memname">
331 <tr>
332 <td class="memname">std::vector&lt; std::string &gt; Vamp::PluginHostAdapter::getPluginPath </td>
333 <td>(</td>
334 <td class="paramname"> </td>
335 <td>&nbsp;)&nbsp;</td>
336 <td width="100%"><code> [static]</code></td>
337 </tr>
338 </table>
339 </div>
340 <div class="memdoc">
341
342 <p>
343
344 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00062">62</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
345
346 <p>References <a class="el" href="PluginHostAdapter_8cpp.html#a7a9ce1e832e4f26cd5197ed38d4a58d">DEFAULT_VAMP_PATH</a>, and <a class="el" href="PluginHostAdapter_8cpp.html#256a5721249aa3309437212cc21a9fe4">PATH_SEPARATOR</a>.</p>
347
348 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00226">Vamp::HostExt::PluginLoader::Impl::enumeratePlugins()</a>, and <a class="el" href="PluginLoader_8cpp-source.html#l00422">Vamp::HostExt::PluginLoader::Impl::generateTaxonomy()</a>.</p>
349
350 </div>
351 </div><p>
352 <a class="anchor" name="dd6a2f1ee7e47bd97fa599cead14b738"></a><!-- doxytag: member="Vamp::PluginHostAdapter::initialise" ref="dd6a2f1ee7e47bd97fa599cead14b738" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
353 <div class="memitem">
354 <div class="memproto">
355 <table class="memname">
356 <tr>
357 <td class="memname">bool Vamp::PluginHostAdapter::initialise </td>
358 <td>(</td>
359 <td class="paramtype">size_t&nbsp;</td>
360 <td class="paramname"> <em>inputChannels</em>, </td>
361 </tr>
362 <tr>
363 <td class="paramkey"></td>
364 <td></td>
365 <td class="paramtype">size_t&nbsp;</td>
366 <td class="paramname"> <em>stepSize</em>, </td>
367 </tr>
368 <tr>
369 <td class="paramkey"></td>
370 <td></td>
371 <td class="paramtype">size_t&nbsp;</td>
372 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
373 </tr>
374 <tr>
375 <td></td>
376 <td>)</td>
377 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
378 </tr>
379 </table>
380 </div>
381 <div class="memdoc">
382
383 <p>
384 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).
385 <p>
386 The input sample rate should have been already specified at construction time.<p>
387 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
388 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
389
390 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00118">118</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
391
392 <p>References <a class="el" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22">_VampPluginDescriptor::initialise</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
393
394 </div>
395 </div><p>
396 <a class="anchor" name="5d54c5bbd76bc27b7a243827148afeaa"></a><!-- doxytag: member="Vamp::PluginHostAdapter::reset" ref="5d54c5bbd76bc27b7a243827148afeaa" args="()" -->
397 <div class="memitem">
398 <div class="memproto">
399 <table class="memname">
400 <tr>
401 <td class="memname">void Vamp::PluginHostAdapter::reset </td>
402 <td>(</td>
403 <td class="paramname"> </td>
404 <td>&nbsp;)&nbsp;</td>
405 <td width="100%"><code> [virtual]</code></td>
406 </tr>
407 </table>
408 </div>
409 <div class="memdoc">
410
411 <p>
412 Reset the plugin after use, to prepare it for another clean run.
413 <p>
414 Not called for the first initialisation (i.e. initialise must also do a reset).
415 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
416
417 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00128">128</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
418
419 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, and <a class="el" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336">_VampPluginDescriptor::reset</a>.</p>
420
421 </div>
422 </div><p>
423 <a class="anchor" name="9c5239a4da67f1a426cd059e1a2856eb"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getInputDomain" ref="9c5239a4da67f1a426cd059e1a2856eb" args="() const " -->
424 <div class="memitem">
425 <div class="memproto">
426 <table class="memname">
427 <tr>
428 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">PluginHostAdapter::InputDomain</a> Vamp::PluginHostAdapter::getInputDomain </td>
429 <td>(</td>
430 <td class="paramname"> </td>
431 <td>&nbsp;)&nbsp;</td>
432 <td width="100%"> const<code> [virtual]</code></td>
433 </tr>
434 </table>
435 </div>
436 <div class="memdoc">
437
438 <p>
439 Get the plugin's required input domain.
440 <p>
441 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" 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.
442 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
443
444 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00135">135</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
445
446 <p>References <a class="el" href="Plugin_8h-source.html#l00149">Vamp::Plugin::FrequencyDomain</a>, <a class="el" href="vamp_8h-source.html#l00242">_VampPluginDescriptor::inputDomain</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="Plugin_8h-source.html#l00149">Vamp::Plugin::TimeDomain</a>, and <a class="el" href="vamp_8h-source.html#l00200">vampFrequencyDomain</a>.</p>
447
448 </div>
449 </div><p>
450 <a class="anchor" name="98aadddc8403eb46c9d8c5a9d1fdd19e"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getVampApiVersion" ref="98aadddc8403eb46c9d8c5a9d1fdd19e" args="() const " -->
451 <div class="memitem">
452 <div class="memproto">
453 <table class="memname">
454 <tr>
455 <td class="memname">unsigned int Vamp::PluginHostAdapter::getVampApiVersion </td>
456 <td>(</td>
457 <td class="paramname"> </td>
458 <td>&nbsp;)&nbsp;</td>
459 <td width="100%"> const<code> [virtual]</code></td>
460 </tr>
461 </table>
462 </div>
463 <div class="memdoc">
464
465 <p>
466 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.
467 <p>
468
469 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
470
471 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00145">145</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
472
473 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="vamp_8h-source.html#l00209">_VampPluginDescriptor::vampApiVersion</a>.</p>
474
475 </div>
476 </div><p>
477 <a class="anchor" name="b27423a656f878d97d2ad2eba4e76c7a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getIdentifier" ref="b27423a656f878d97d2ad2eba4e76c7a" args="() const " -->
478 <div class="memitem">
479 <div class="memproto">
480 <table class="memname">
481 <tr>
482 <td class="memname">std::string Vamp::PluginHostAdapter::getIdentifier </td>
483 <td>(</td>
484 <td class="paramname"> </td>
485 <td>&nbsp;)&nbsp;</td>
486 <td width="100%"> const<code> [virtual]</code></td>
487 </tr>
488 </table>
489 </div>
490 <div class="memdoc">
491
492 <p>
493 Get the computer-usable name of the plugin.
494 <p>
495 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>
496 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>
497 Example: "zero_crossings"
498 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
499
500 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00151">151</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
501
502 <p>References <a class="el" href="vamp_8h-source.html#l00212">_VampPluginDescriptor::identifier</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>.</p>
503
504 </div>
505 </div><p>
506 <a class="anchor" name="45f1d0377e233eeddd1b7cefb48be62a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getName" ref="45f1d0377e233eeddd1b7cefb48be62a" args="() const " -->
507 <div class="memitem">
508 <div class="memproto">
509 <table class="memname">
510 <tr>
511 <td class="memname">std::string Vamp::PluginHostAdapter::getName </td>
512 <td>(</td>
513 <td class="paramname"> </td>
514 <td>&nbsp;)&nbsp;</td>
515 <td width="100%"> const<code> [virtual]</code></td>
516 </tr>
517 </table>
518 </div>
519 <div class="memdoc">
520
521 <p>
522 Get a human-readable name or title of the plugin.
523 <p>
524 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>
525 Example: "Zero Crossings"
526 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
527
528 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00157">157</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
529
530 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="vamp_8h-source.html#l00215">_VampPluginDescriptor::name</a>.</p>
531
532 </div>
533 </div><p>
534 <a class="anchor" name="5eaafcef030e81b90a3e77cf16cf8ae1"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getDescription" ref="5eaafcef030e81b90a3e77cf16cf8ae1" args="() const " -->
535 <div class="memitem">
536 <div class="memproto">
537 <table class="memname">
538 <tr>
539 <td class="memname">std::string Vamp::PluginHostAdapter::getDescription </td>
540 <td>(</td>
541 <td class="paramname"> </td>
542 <td>&nbsp;)&nbsp;</td>
543 <td width="100%"> const<code> [virtual]</code></td>
544 </tr>
545 </table>
546 </div>
547 <div class="memdoc">
548
549 <p>
550 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".
551 <p>
552 May be empty if the name has said it all already.<p>
553 Example: "Detect and count zero crossing points"
554 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
555
556 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00163">163</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
557
558 <p>References <a class="el" href="vamp_8h-source.html#l00218">_VampPluginDescriptor::description</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>.</p>
559
560 </div>
561 </div><p>
562 <a class="anchor" name="f572be0b175f5661559006a380a0f3db"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMaker" ref="f572be0b175f5661559006a380a0f3db" args="() const " -->
563 <div class="memitem">
564 <div class="memproto">
565 <table class="memname">
566 <tr>
567 <td class="memname">std::string Vamp::PluginHostAdapter::getMaker </td>
568 <td>(</td>
569 <td class="paramname"> </td>
570 <td>&nbsp;)&nbsp;</td>
571 <td width="100%"> const<code> [virtual]</code></td>
572 </tr>
573 </table>
574 </div>
575 <div class="memdoc">
576
577 <p>
578 Get the name of the author or vendor of the plugin in human-readable form.
579 <p>
580 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
581 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
582
583 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00169">169</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
584
585 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="vamp_8h-source.html#l00221">_VampPluginDescriptor::maker</a>.</p>
586
587 </div>
588 </div><p>
589 <a class="anchor" name="6fbd94781867ca46a20368c2a3593c77"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPluginVersion" ref="6fbd94781867ca46a20368c2a3593c77" args="() const " -->
590 <div class="memitem">
591 <div class="memproto">
592 <table class="memname">
593 <tr>
594 <td class="memname">int Vamp::PluginHostAdapter::getPluginVersion </td>
595 <td>(</td>
596 <td class="paramname"> </td>
597 <td>&nbsp;)&nbsp;</td>
598 <td width="100%"> const<code> [virtual]</code></td>
599 </tr>
600 </table>
601 </div>
602 <div class="memdoc">
603
604 <p>
605 Get the version number of the plugin.
606 <p>
607
608 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
609
610 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00175">175</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
611
612 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="vamp_8h-source.html#l00224">_VampPluginDescriptor::pluginVersion</a>.</p>
613
614 </div>
615 </div><p>
616 <a class="anchor" name="c73c9d6baad04369beee695e99584815"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getCopyright" ref="c73c9d6baad04369beee695e99584815" args="() const " -->
617 <div class="memitem">
618 <div class="memproto">
619 <table class="memname">
620 <tr>
621 <td class="memname">std::string Vamp::PluginHostAdapter::getCopyright </td>
622 <td>(</td>
623 <td class="paramname"> </td>
624 <td>&nbsp;)&nbsp;</td>
625 <td width="100%"> const<code> [virtual]</code></td>
626 </tr>
627 </table>
628 </div>
629 <div class="memdoc">
630
631 <p>
632 Get the copyright statement or licensing summary for the plugin.
633 <p>
634 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
635 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
636
637 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00181">181</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
638
639 <p>References <a class="el" href="vamp_8h-source.html#l00227">_VampPluginDescriptor::copyright</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>.</p>
640
641 </div>
642 </div><p>
643 <a class="anchor" name="bfa93b20d9b5651a32042a9bb7c8df13"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getParameterDescriptors" ref="bfa93b20d9b5651a32042a9bb7c8df13" args="() const " -->
644 <div class="memitem">
645 <div class="memproto">
646 <table class="memname">
647 <tr>
648 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PluginHostAdapter::ParameterList</a> Vamp::PluginHostAdapter::getParameterDescriptors </td>
649 <td>(</td>
650 <td class="paramname"> </td>
651 <td>&nbsp;)&nbsp;</td>
652 <td width="100%"> const<code> [virtual]</code></td>
653 </tr>
654 </table>
655 </div>
656 <div class="memdoc">
657
658 <p>
659 Get the controllable parameters of this plugin.
660 <p>
661
662 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
663
664 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">187</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
665
666 <p>References <a class="el" href="vamp_8h-source.html#l00092">_VampParameterDescriptor::defaultValue</a>, <a class="el" href="PluginBase_8h-source.html#l00166">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp_8h-source.html#l00080">_VampParameterDescriptor::description</a>, <a class="el" href="PluginBase_8h-source.html#l00143">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp_8h-source.html#l00074">_VampParameterDescriptor::identifier</a>, <a class="el" href="PluginBase_8h-source.html#l00132">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp_8h-source.html#l00095">_VampParameterDescriptor::isQuantized</a>, <a class="el" href="PluginBase_8h-source.html#l00172">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="vamp_8h-source.html#l00089">_VampParameterDescriptor::maxValue</a>, <a class="el" href="PluginBase_8h-source.html#l00158">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp_8h-source.html#l00086">_VampParameterDescriptor::minValue</a>, <a class="el" href="PluginBase_8h-source.html#l00153">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp_8h-source.html#l00077">_VampParameterDescriptor::name</a>, <a class="el" href="PluginBase_8h-source.html#l00137">Vamp::PluginBase::ParameterDescriptor::name</a>, <a class="el" href="vamp_8h-source.html#l00230">_VampPluginDescriptor::parameterCount</a>, <a class="el" href="vamp_8h-source.html#l00233">_VampPluginDescriptor::parameters</a>, <a class="el" href="vamp_8h-source.html#l00098">_VampParameterDescriptor::quantizeStep</a>, <a class="el" href="PluginBase_8h-source.html#l00179">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a>, <a class="el" href="vamp_8h-source.html#l00083">_VampParameterDescriptor::unit</a>, <a class="el" href="PluginBase_8h-source.html#l00148">Vamp::PluginBase::ParameterDescriptor::unit</a>, <a class="el" href="PluginBase_8h-source.html#l00192">Vamp::PluginBase::ParameterDescriptor::valueNames</a>, and <a class="el" href="vamp_8h-source.html#l00101">_VampParameterDescriptor::valueNames</a>.</p>
667
668 </div>
669 </div><p>
670 <a class="anchor" name="f0c46d4f67ca93be7c76f3ea2e6c8efb"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getParameter" ref="f0c46d4f67ca93be7c76f3ea2e6c8efb" args="(std::string) const " -->
671 <div class="memitem">
672 <div class="memproto">
673 <table class="memname">
674 <tr>
675 <td class="memname">float Vamp::PluginHostAdapter::getParameter </td>
676 <td>(</td>
677 <td class="paramtype">std::string&nbsp;</td>
678 <td class="paramname"> </td>
679 <td>&nbsp;)&nbsp;</td>
680 <td width="100%"> const<code> [virtual]</code></td>
681 </tr>
682 </table>
683 </div>
684 <div class="memdoc">
685
686 <p>
687 Get the value of a named parameter.
688 <p>
689 The argument is the identifier field from that parameter's descriptor.
690 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
691
692 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">213</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
693
694 <p>References <a class="el" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395">_VampPluginDescriptor::getParameter</a>, <a class="el" href="vamp_8h-source.html#l00074">_VampParameterDescriptor::identifier</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, <a class="el" href="vamp_8h-source.html#l00230">_VampPluginDescriptor::parameterCount</a>, and <a class="el" href="vamp_8h-source.html#l00233">_VampPluginDescriptor::parameters</a>.</p>
695
696 </div>
697 </div><p>
698 <a class="anchor" name="29f75395aa75b9de0228aa11edf9c6d6"></a><!-- doxytag: member="Vamp::PluginHostAdapter::setParameter" ref="29f75395aa75b9de0228aa11edf9c6d6" args="(std::string, float)" -->
699 <div class="memitem">
700 <div class="memproto">
701 <table class="memname">
702 <tr>
703 <td class="memname">void Vamp::PluginHostAdapter::setParameter </td>
704 <td>(</td>
705 <td class="paramtype">std::string&nbsp;</td>
706 <td class="paramname">, </td>
707 </tr>
708 <tr>
709 <td class="paramkey"></td>
710 <td></td>
711 <td class="paramtype">float&nbsp;</td>
712 <td class="paramname"></td><td>&nbsp;</td>
713 </tr>
714 <tr>
715 <td></td>
716 <td>)</td>
717 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
718 </tr>
719 </table>
720 </div>
721 <div class="memdoc">
722
723 <p>
724 Set a named parameter.
725 <p>
726 The first argument is the identifier field from that parameter's descriptor.
727 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
728
729 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">227</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
730
731 <p>References <a class="el" href="vamp_8h-source.html#l00074">_VampParameterDescriptor::identifier</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, <a class="el" href="vamp_8h-source.html#l00230">_VampPluginDescriptor::parameterCount</a>, <a class="el" href="vamp_8h-source.html#l00233">_VampPluginDescriptor::parameters</a>, and <a class="el" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481">_VampPluginDescriptor::setParameter</a>.</p>
732
733 </div>
734 </div><p>
735 <a class="anchor" name="7ac5681dcfe08b7b8a796bffc0aff3e3"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPrograms" ref="7ac5681dcfe08b7b8a796bffc0aff3e3" args="() const " -->
736 <div class="memitem">
737 <div class="memproto">
738 <table class="memname">
739 <tr>
740 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">PluginHostAdapter::ProgramList</a> Vamp::PluginHostAdapter::getPrograms </td>
741 <td>(</td>
742 <td class="paramname"> </td>
743 <td>&nbsp;)&nbsp;</td>
744 <td width="100%"> const<code> [virtual]</code></td>
745 </tr>
746 </table>
747 </div>
748 <div class="memdoc">
749
750 <p>
751 Get the program settings available in this plugin.
752 <p>
753 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>
754 The programs must have unique names.
755 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
756
757 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00241">241</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
758
759 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="vamp_8h-source.html#l00236">_VampPluginDescriptor::programCount</a>, and <a class="el" href="vamp_8h-source.html#l00239">_VampPluginDescriptor::programs</a>.</p>
760
761 </div>
762 </div><p>
763 <a class="anchor" name="34859eff8ca8d862af39be9636ec1867"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getCurrentProgram" ref="34859eff8ca8d862af39be9636ec1867" args="() const " -->
764 <div class="memitem">
765 <div class="memproto">
766 <table class="memname">
767 <tr>
768 <td class="memname">std::string Vamp::PluginHostAdapter::getCurrentProgram </td>
769 <td>(</td>
770 <td class="paramname"> </td>
771 <td>&nbsp;)&nbsp;</td>
772 <td width="100%"> const<code> [virtual]</code></td>
773 </tr>
774 </table>
775 </div>
776 <div class="memdoc">
777
778 <p>
779 Get the current program.
780 <p>
781
782 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
783
784 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">253</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
785
786 <p>References <a class="el" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53">_VampPluginDescriptor::getCurrentProgram</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, and <a class="el" href="vamp_8h-source.html#l00239">_VampPluginDescriptor::programs</a>.</p>
787
788 </div>
789 </div><p>
790 <a class="anchor" name="8f5515ab34cc13d9403ccc6b4b788683"></a><!-- doxytag: member="Vamp::PluginHostAdapter::selectProgram" ref="8f5515ab34cc13d9403ccc6b4b788683" args="(std::string)" -->
791 <div class="memitem">
792 <div class="memproto">
793 <table class="memname">
794 <tr>
795 <td class="memname">void Vamp::PluginHostAdapter::selectProgram </td>
796 <td>(</td>
797 <td class="paramtype">std::string&nbsp;</td>
798 <td class="paramname"> </td>
799 <td>&nbsp;)&nbsp;</td>
800 <td width="100%"><code> [virtual]</code></td>
801 </tr>
802 </table>
803 </div>
804 <div class="memdoc">
805
806 <p>
807 Select a program.
808 <p>
809 (If the given program name is not one of the available programs, do nothing.)
810 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
811
812 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">262</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
813
814 <p>References <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, <a class="el" href="vamp_8h-source.html#l00236">_VampPluginDescriptor::programCount</a>, <a class="el" href="vamp_8h-source.html#l00239">_VampPluginDescriptor::programs</a>, and <a class="el" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf">_VampPluginDescriptor::selectProgram</a>.</p>
815
816 </div>
817 </div><p>
818 <a class="anchor" name="859ad5d59402691daed3cf1af1899ebe"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPreferredStepSize" ref="859ad5d59402691daed3cf1af1899ebe" args="() const " -->
819 <div class="memitem">
820 <div class="memproto">
821 <table class="memname">
822 <tr>
823 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredStepSize </td>
824 <td>(</td>
825 <td class="paramname"> </td>
826 <td>&nbsp;)&nbsp;</td>
827 <td width="100%"> const<code> [virtual]</code></td>
828 </tr>
829 </table>
830 </div>
831 <div class="memdoc">
832
833 <p>
834 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" title="Process a single block of input data.">process()</a> function) for the plugin.
835 <p>
836 This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
837 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
838 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
839
840 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00275">275</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
841
842 <p>References <a class="el" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb">_VampPluginDescriptor::getPreferredStepSize</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
843
844 </div>
845 </div><p>
846 <a class="anchor" name="d5e0ea8042bdec4dd18428991117e07a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getPreferredBlockSize" ref="d5e0ea8042bdec4dd18428991117e07a" args="() const " -->
847 <div class="memitem">
848 <div class="memproto">
849 <table class="memname">
850 <tr>
851 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredBlockSize </td>
852 <td>(</td>
853 <td class="paramname"> </td>
854 <td>&nbsp;)&nbsp;</td>
855 <td width="100%"> const<code> [virtual]</code></td>
856 </tr>
857 </table>
858 </div>
859 <div class="memdoc">
860
861 <p>
862 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" title="Process a single block of input data.">process()</a> function).
863 <p>
864 This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
865 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1PluginHostAdapter.html#dd6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
866 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
867
868 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00282">282</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
869
870 <p>References <a class="el" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8">_VampPluginDescriptor::getPreferredBlockSize</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
871
872 </div>
873 </div><p>
874 <a class="anchor" name="67d1198c0e58d3f0076d0eda599ff28d"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMinChannelCount" ref="67d1198c0e58d3f0076d0eda599ff28d" args="() const " -->
875 <div class="memitem">
876 <div class="memproto">
877 <table class="memname">
878 <tr>
879 <td class="memname">size_t Vamp::PluginHostAdapter::getMinChannelCount </td>
880 <td>(</td>
881 <td class="paramname"> </td>
882 <td>&nbsp;)&nbsp;</td>
883 <td width="100%"> const<code> [virtual]</code></td>
884 </tr>
885 </table>
886 </div>
887 <div class="memdoc">
888
889 <p>
890 Get the minimum supported number of input channels.
891 <p>
892
893 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
894
895 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00289">289</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
896
897 <p>References <a class="el" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92">_VampPluginDescriptor::getMinChannelCount</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
898
899 </div>
900 </div><p>
901 <a class="anchor" name="25091905e97e39d515d8ffc1a9f2b9e0"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getMaxChannelCount" ref="25091905e97e39d515d8ffc1a9f2b9e0" args="() const " -->
902 <div class="memitem">
903 <div class="memproto">
904 <table class="memname">
905 <tr>
906 <td class="memname">size_t Vamp::PluginHostAdapter::getMaxChannelCount </td>
907 <td>(</td>
908 <td class="paramname"> </td>
909 <td>&nbsp;)&nbsp;</td>
910 <td width="100%"> const<code> [virtual]</code></td>
911 </tr>
912 </table>
913 </div>
914 <div class="memdoc">
915
916 <p>
917 Get the maximum supported number of input channels.
918 <p>
919
920 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
921
922 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00296">296</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
923
924 <p>References <a class="el" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b">_VampPluginDescriptor::getMaxChannelCount</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, and <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>.</p>
925
926 </div>
927 </div><p>
928 <a class="anchor" name="e02670cca9d25cdc4100cbe7a12e3e68"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getOutputDescriptors" ref="e02670cca9d25cdc4100cbe7a12e3e68" args="() const " -->
929 <div class="memitem">
930 <div class="memproto">
931 <table class="memname">
932 <tr>
933 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">PluginHostAdapter::OutputList</a> Vamp::PluginHostAdapter::getOutputDescriptors </td>
934 <td>(</td>
935 <td class="paramname"> </td>
936 <td>&nbsp;)&nbsp;</td>
937 <td width="100%"> const<code> [virtual]</code></td>
938 </tr>
939 </table>
940 </div>
941 <div class="memdoc">
942
943 <p>
944 Get the outputs of this plugin.
945 <p>
946 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1PluginHostAdapter.html#82c29a512c0587ea0121eee4b0c2a684" title="Process a single block of input data.">process()</a> call.
947 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
948
949 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">303</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
950
951 <p>References <a class="el" href="vamp_8h-source.html#l00136">_VampOutputDescriptor::binCount</a>, <a class="el" href="Plugin_8h-source.html#l00239">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp_8h-source.html#l00139">_VampOutputDescriptor::binNames</a>, <a class="el" href="Plugin_8h-source.html#l00245">Vamp::Plugin::OutputDescriptor::binNames</a>, <a class="el" href="vamp_8h-source.html#l00127">_VampOutputDescriptor::description</a>, <a class="el" href="Plugin_8h-source.html#l00219">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="Plugin_8h-source.html#l00285">Vamp::Plugin::OutputDescriptor::FixedSampleRate</a>, <a class="el" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1">_VampPluginDescriptor::getOutputCount</a>, <a class="el" href="struct__VampPluginDescriptor.html#92c58b8ff99ad0c23a42333aa55c144d">_VampPluginDescriptor::getOutputDescriptor</a>, <a class="el" href="vamp_8h-source.html#l00133">_VampOutputDescriptor::hasFixedBinCount</a>, <a class="el" href="Plugin_8h-source.html#l00231">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp_8h-source.html#l00142">_VampOutputDescriptor::hasKnownExtents</a>, <a class="el" href="Plugin_8h-source.html#l00252">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp_8h-source.html#l00121">_VampOutputDescriptor::identifier</a>, <a class="el" href="Plugin_8h-source.html#l00206">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp_8h-source.html#l00151">_VampOutputDescriptor::isQuantized</a>, <a class="el" href="Plugin_8h-source.html#l00270">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, <a class="el" href="vamp_8h-source.html#l00148">_VampOutputDescriptor::maxValue</a>, <a class="el" href="Plugin_8h-source.html#l00264">Vamp::Plugin::OutputDescriptor::maxValue</a>, <a class="el" href="vamp_8h-source.html#l00145">_VampOutputDescriptor::minValue</a>, <a class="el" href="Plugin_8h-source.html#l00258">Vamp::Plugin::OutputDescriptor::minValue</a>, <a class="el" href="vamp_8h-source.html#l00124">_VampOutputDescriptor::name</a>, <a class="el" href="Plugin_8h-source.html#l00212">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="Plugin_8h-source.html#l00282">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp_8h-source.html#l00154">_VampOutputDescriptor::quantizeStep</a>, <a class="el" href="Plugin_8h-source.html#l00277">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79">_VampPluginDescriptor::releaseOutputDescriptor</a>, <a class="el" href="vamp_8h-source.html#l00161">_VampOutputDescriptor::sampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00306">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="Plugin_8h-source.html#l00294">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="vamp_8h-source.html#l00157">_VampOutputDescriptor::sampleType</a>, <a class="el" href="vamp_8h-source.html#l00130">_VampOutputDescriptor::unit</a>, <a class="el" href="Plugin_8h-source.html#l00224">Vamp::Plugin::OutputDescriptor::unit</a>, <a class="el" href="vamp_8h-source.html#l00111">vampFixedSampleRate</a>, <a class="el" href="vamp_8h-source.html#l00108">vampOneSamplePerStep</a>, <a class="el" href="vamp_8h-source.html#l00114">vampVariableSampleRate</a>, and <a class="el" href="Plugin_8h-source.html#l00288">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p>
952
953 </div>
954 </div><p>
955 <a class="anchor" name="82c29a512c0587ea0121eee4b0c2a684"></a><!-- doxytag: member="Vamp::PluginHostAdapter::process" ref="82c29a512c0587ea0121eee4b0c2a684" args="(const float *const *inputBuffers, RealTime timestamp)" -->
956 <div class="memitem">
957 <div class="memproto">
958 <table class="memname">
959 <tr>
960 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PluginHostAdapter::FeatureSet</a> Vamp::PluginHostAdapter::process </td>
961 <td>(</td>
962 <td class="paramtype">const float *const *&nbsp;</td>
963 <td class="paramname"> <em>inputBuffers</em>, </td>
964 </tr>
965 <tr>
966 <td class="paramkey"></td>
967 <td></td>
968 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td>
969 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
970 </tr>
971 <tr>
972 <td></td>
973 <td>)</td>
974 <td></td><td></td><td width="100%"><code> [virtual]</code></td>
975 </tr>
976 </table>
977 </div>
978 <div class="memdoc">
979
980 <p>
981 Process a single block of input data.
982 <p>
983 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>
984 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>
985 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.)
986 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
987
988 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">353</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
989
990 <p>References <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">convertFeatures()</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, <a class="el" href="RealTime_8h-source.html#l00066">Vamp::RealTime::nsec</a>, <a class="el" href="struct__VampPluginDescriptor.html#c5a0a75b6e68b22fed536765d1f2f254">_VampPluginDescriptor::process</a>, <a class="el" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63">_VampPluginDescriptor::releaseFeatureSet</a>, and <a class="el" href="RealTime_8h-source.html#l00065">Vamp::RealTime::sec</a>.</p>
991
992 </div>
993 </div><p>
994 <a class="anchor" name="d3f5f16a89a821da2ec1186fd2062e83"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getRemainingFeatures" ref="d3f5f16a89a821da2ec1186fd2062e83" args="()" -->
995 <div class="memitem">
996 <div class="memproto">
997 <table class="memname">
998 <tr>
999 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">PluginHostAdapter::FeatureSet</a> Vamp::PluginHostAdapter::getRemainingFeatures </td>
1000 <td>(</td>
1001 <td class="paramname"> </td>
1002 <td>&nbsp;)&nbsp;</td>
1003 <td width="100%"><code> [virtual]</code></td>
1004 </tr>
1005 </table>
1006 </div>
1007 <div class="memdoc">
1008
1009 <p>
1010 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
1011 <p>
1012
1013 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
1014
1015 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">372</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
1016
1017 <p>References <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">convertFeatures()</a>, <a class="el" href="struct__VampPluginDescriptor.html#d22c666188aadab83c354a0edb18fcf0">_VampPluginDescriptor::getRemainingFeatures</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, and <a class="el" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63">_VampPluginDescriptor::releaseFeatureSet</a>.</p>
1018
1019 </div>
1020 </div><p>
1021 <a class="anchor" name="ee417a4c9ba9dbb63777c963d5f9452a"></a><!-- doxytag: member="Vamp::PluginHostAdapter::convertFeatures" ref="ee417a4c9ba9dbb63777c963d5f9452a" args="(VampFeatureList *, FeatureSet &amp;)" -->
1022 <div class="memitem">
1023 <div class="memproto">
1024 <table class="memname">
1025 <tr>
1026 <td class="memname">void Vamp::PluginHostAdapter::convertFeatures </td>
1027 <td>(</td>
1028 <td class="paramtype"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *&nbsp;</td>
1029 <td class="paramname"> <em>features</em>, </td>
1030 </tr>
1031 <tr>
1032 <td class="paramkey"></td>
1033 <td></td>
1034 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;&nbsp;</td>
1035 <td class="paramname"> <em>fs</em></td><td>&nbsp;</td>
1036 </tr>
1037 <tr>
1038 <td></td>
1039 <td>)</td>
1040 <td></td><td></td><td width="100%"><code> [protected]</code></td>
1041 </tr>
1042 </table>
1043 </div>
1044 <div class="memdoc">
1045
1046 <p>
1047
1048 <p>Definition at line <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">385</a> of file <a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a>.</p>
1049
1050 <p>References <a class="el" href="vamp_8h-source.html#l00190">_VampFeatureList::featureCount</a>, <a class="el" href="vamp_8h-source.html#l00193">_VampFeatureList::features</a>, <a class="el" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1">_VampPluginDescriptor::getOutputCount</a>, <a class="el" href="vamp_8h-source.html#l00168">_VampFeature::hasTimestamp</a>, <a class="el" href="Plugin_8h-source.html#l00325">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="Plugin_8h-source.html#l00344">Vamp::Plugin::Feature::label</a>, <a class="el" href="vamp_8h-source.html#l00183">_VampFeature::label</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00109">m_descriptor</a>, <a class="el" href="PluginHostAdapter_8h-source.html#l00110">m_handle</a>, <a class="el" href="vamp_8h-source.html#l00174">_VampFeature::nsec</a>, <a class="el" href="vamp_8h-source.html#l00171">_VampFeature::sec</a>, <a class="el" href="Plugin_8h-source.html#l00332">Vamp::Plugin::Feature::timestamp</a>, <a class="el" href="vamp_8h-source.html#l00177">_VampFeature::valueCount</a>, <a class="el" href="vamp_8h-source.html#l00180">_VampFeature::values</a>, and <a class="el" href="Plugin_8h-source.html#l00339">Vamp::Plugin::Feature::values</a>.</p>
1051
1052 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">getRemainingFeatures()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">process()</a>.</p>
1053
1054 </div>
1055 </div><p>
1056 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::PluginHostAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
1057 <div class="memitem">
1058 <div class="memproto">
1059 <table class="memname">
1060 <tr>
1061 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1062 <td>(</td>
1063 <td class="paramname"> </td>
1064 <td>&nbsp;)&nbsp;</td>
1065 <td width="100%"> const<code> [inline, virtual, inherited]</code></td>
1066 </tr>
1067 </table>
1068 </div>
1069 <div class="memdoc">
1070
1071 <p>
1072 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>.
1073 <p>
1074 Do not reimplement this function in your subclass.
1075 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1076
1077 <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>
1078
1079 </div>
1080 </div><p>
1081 <hr><h2>Member Data Documentation</h2>
1082 <a class="anchor" name="0c9f252aca8ac298e30cadd0de032ec2"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_descriptor" ref="0c9f252aca8ac298e30cadd0de032ec2" args="" -->
1083 <div class="memitem">
1084 <div class="memproto">
1085 <table class="memname">
1086 <tr>
1087 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* <a class="el" href="classVamp_1_1PluginHostAdapter.html#0c9f252aca8ac298e30cadd0de032ec2">Vamp::PluginHostAdapter::m_descriptor</a><code> [protected]</code> </td>
1088 </tr>
1089 </table>
1090 </div>
1091 <div class="memdoc">
1092
1093 <p>
1094
1095 <p>Definition at line <a class="el" href="PluginHostAdapter_8h-source.html#l00109">109</a> of file <a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a>.</p>
1096
1097 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">convertFeatures()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00181">getCopyright()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">getCurrentProgram()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00163">getDescription()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00151">getIdentifier()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00135">getInputDomain()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00169">getMaker()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00296">getMaxChannelCount()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00289">getMinChannelCount()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00157">getName()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">getParameterDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00175">getPluginVersion()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00282">getPreferredBlockSize()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00275">getPreferredStepSize()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00241">getPrograms()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">getRemainingFeatures()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00145">getVampApiVersion()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00118">initialise()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00043">PluginHostAdapter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">process()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00128">reset()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">selectProgram()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">setParameter()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00055">~PluginHostAdapter()</a>.</p>
1098
1099 </div>
1100 </div><p>
1101 <a class="anchor" name="02ebd03b226b4a467cad747ce77e79ee"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_handle" ref="02ebd03b226b4a467cad747ce77e79ee" args="" -->
1102 <div class="memitem">
1103 <div class="memproto">
1104 <table class="memname">
1105 <tr>
1106 <td class="memname"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#02ebd03b226b4a467cad747ce77e79ee">Vamp::PluginHostAdapter::m_handle</a><code> [protected]</code> </td>
1107 </tr>
1108 </table>
1109 </div>
1110 <div class="memdoc">
1111
1112 <p>
1113
1114 <p>Definition at line <a class="el" href="PluginHostAdapter_8h-source.html#l00110">110</a> of file <a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a>.</p>
1115
1116 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">convertFeatures()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">getCurrentProgram()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00296">getMaxChannelCount()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00289">getMinChannelCount()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00282">getPreferredBlockSize()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00275">getPreferredStepSize()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">getRemainingFeatures()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00118">initialise()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00043">PluginHostAdapter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">process()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00128">reset()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">selectProgram()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">setParameter()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00055">~PluginHostAdapter()</a>.</p>
1117
1118 </div>
1119 </div><p>
1120 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::PluginHostAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1121 <div class="memitem">
1122 <div class="memproto">
1123 <table class="memname">
1124 <tr>
1125 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td>
1126 </tr>
1127 </table>
1128 </div>
1129 <div class="memdoc">
1130
1131 <p>
1132
1133 <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>
1134
1135 <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>
1136
1137 </div>
1138 </div><p>
1139 <hr>The documentation for this class was generated from the following files:<ul>
1140 <li><a class="el" href="PluginHostAdapter_8h-source.html">PluginHostAdapter.h</a><li><a class="el" href="PluginHostAdapter_8cpp-source.html">PluginHostAdapter.cpp</a></ul>
1141 </div>
1142 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp;
1143 <a href="http://www.doxygen.org/index.html">
1144 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
1145 </body>
1146 </html>