Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1PluginAdapterBase.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::PluginAdapterBase Class Reference</title> 3 <title>VampPluginSDK: Vamp::PluginAdapterBase Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
31 <div class="dynheader"> 31 <div class="dynheader">
32 Inheritance diagram for Vamp::PluginAdapterBase:</div> 32 Inheritance diagram for Vamp::PluginAdapterBase:</div>
33 <div class="dynsection"> 33 <div class="dynsection">
34 <p><center><img src="classVamp_1_1PluginAdapterBase__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginAdapterBase__inherit__map" alt="Inheritance graph"></center> 34 <p><center><img src="classVamp_1_1PluginAdapterBase__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginAdapterBase__inherit__map" alt="Inheritance graph"></center>
35 <map name="Vamp_1_1PluginAdapterBase__inherit__map"> 35 <map name="Vamp_1_1PluginAdapterBase__inherit__map">
36 <area shape="rect" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular..." alt="" coords="5,81,181,105"></map> 36 <area shape="rect" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular..." alt="" coords="5,80,181,107"></map>
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> 37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
38 38
39 <p> 39 <p>
40 <a href="classVamp_1_1PluginAdapterBase-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 40 <a href="classVamp_1_1PluginAdapterBase-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
41 <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its 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> objects available through 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> C API. 41 <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its 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> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API.
42 <p> 42 <p>
43 Almost all <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 libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter&lt;T&gt; for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="plugins_8cpp.html#bb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl> 43 Almost all <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter&lt;T&gt; for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="plugins_8cpp.html#bb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl>
44 44
45 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00063">63</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p> 45 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00065">65</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
46 <table border="0" cellpadding="0" cellspacing="0"> 46 <table border="0" cellpadding="0" cellspacing="0">
47 <tr><td></td></tr> 47 <tr><td></td></tr>
48 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 48 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#e39492abdca4b588a582962fdeab819d">~PluginAdapterBase</a> ()</td></tr> 49 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#aa8afd318b6c3da108e1cbcc7e46603d">~PluginAdapterBase</a> ()</td></tr>
50 50
51 <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_1PluginAdapterBase.html#7ff5c9374a8dc43f977c3707d1da45b5">getDescriptor</a> ()</td></tr> 51 <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_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb">getDescriptor</a> ()</td></tr>
52 52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#7ff5c9374a8dc43f977c3707d1da45b5"></a><br></td></tr> 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#d24595002512f9f00e8e45216d6f5dfb"></a><br></td></tr>
54 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 54 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr> 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr>
56 56
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</td></tr> 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</td></tr>
58 58
59 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 59 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr> 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr>
61
62 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
63 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a></td></tr>
64 61
65 </table> 62 </table>
66 <hr><h2>Constructor &amp; Destructor Documentation</h2> 63 <hr><h2>Constructor &amp; Destructor Documentation</h2>
67 <a class="anchor" name="e39492abdca4b588a582962fdeab819d"></a><!-- doxytag: member="Vamp::PluginAdapterBase::~PluginAdapterBase" ref="e39492abdca4b588a582962fdeab819d" args="()" --> 64 <a class="anchor" name="aa8afd318b6c3da108e1cbcc7e46603d"></a><!-- doxytag: member="Vamp::PluginAdapterBase::~PluginAdapterBase" ref="aa8afd318b6c3da108e1cbcc7e46603d" args="()" -->
68 <div class="memitem"> 65 <div class="memitem">
69 <div class="memproto"> 66 <div class="memproto">
70 <table class="memname"> 67 <table class="memname">
71 <tr> 68 <tr>
72 <td class="memname">Vamp::PluginAdapterBase::~PluginAdapterBase </td> 69 <td class="memname">virtual Vamp::PluginAdapterBase::~PluginAdapterBase </td>
73 <td>(</td> 70 <td>(</td>
74 <td class="paramname"> </td> 71 <td class="paramname"> </td>
75 <td>&nbsp;)&nbsp;</td> 72 <td>&nbsp;)&nbsp;</td>
76 <td width="100%"><code> [virtual]</code></td> 73 <td><code> [virtual]</code></td>
77 </tr> 74 </tr>
78 </table> 75 </table>
79 </div> 76 </div>
80 <div class="memdoc"> 77 <div class="memdoc">
81 78
82 <p> 79 <p>
83
84 <p>Definition at line <a class="el" href="PluginAdapter_8cpp-source.html#l00132">132</a> of file <a class="el" href="PluginAdapter_8cpp-source.html">PluginAdapter.cpp</a>.</p>
85
86 <p>References <a class="el" href="PluginAdapter_8h-source.html#l00079">m_impl</a>.</p>
87 80
88 </div> 81 </div>
89 </div><p> 82 </div><p>
90 <a class="anchor" name="5dad6a9b4b170c0f284962e125ac988e"></a><!-- doxytag: member="Vamp::PluginAdapterBase::PluginAdapterBase" ref="5dad6a9b4b170c0f284962e125ac988e" args="()" --> 83 <a class="anchor" name="5dad6a9b4b170c0f284962e125ac988e"></a><!-- doxytag: member="Vamp::PluginAdapterBase::PluginAdapterBase" ref="5dad6a9b4b170c0f284962e125ac988e" args="()" -->
91 <div class="memitem"> 84 <div class="memitem">
94 <tr> 87 <tr>
95 <td class="memname">Vamp::PluginAdapterBase::PluginAdapterBase </td> 88 <td class="memname">Vamp::PluginAdapterBase::PluginAdapterBase </td>
96 <td>(</td> 89 <td>(</td>
97 <td class="paramname"> </td> 90 <td class="paramname"> </td>
98 <td>&nbsp;)&nbsp;</td> 91 <td>&nbsp;)&nbsp;</td>
99 <td width="100%"><code> [protected]</code></td> 92 <td><code> [protected]</code></td>
100 </tr> 93 </tr>
101 </table> 94 </table>
102 </div> 95 </div>
103 <div class="memdoc"> 96 <div class="memdoc">
104 97
105 <p> 98 <p>
106 99
107 <p>Definition at line <a class="el" href="PluginAdapter_8cpp-source.html#l00127">127</a> of file <a class="el" href="PluginAdapter_8cpp-source.html">PluginAdapter.cpp</a>.</p>
108
109 <p>References <a class="el" href="PluginAdapter_8h-source.html#l00079">m_impl</a>.</p>
110
111 </div> 100 </div>
112 </div><p> 101 </div><p>
113 <hr><h2>Member Function Documentation</h2> 102 <hr><h2>Member Function Documentation</h2>
114 <a class="anchor" name="7ff5c9374a8dc43f977c3707d1da45b5"></a><!-- doxytag: member="Vamp::PluginAdapterBase::getDescriptor" ref="7ff5c9374a8dc43f977c3707d1da45b5" args="()" --> 103 <a class="anchor" name="d24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapterBase::getDescriptor" ref="d24595002512f9f00e8e45216d6f5dfb" args="()" -->
115 <div class="memitem"> 104 <div class="memitem">
116 <div class="memproto"> 105 <div class="memproto">
117 <table class="memname"> 106 <table class="memname">
118 <tr> 107 <tr>
119 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> * Vamp::PluginAdapterBase::getDescriptor </td> 108 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td>
120 <td>(</td> 109 <td>(</td>
121 <td class="paramname"> </td> 110 <td class="paramname"> </td>
122 <td>&nbsp;)&nbsp;</td> 111 <td>&nbsp;)&nbsp;</td>
123 <td width="100%"></td> 112 <td></td>
124 </tr> 113 </tr>
125 </table> 114 </table>
126 </div> 115 </div>
127 <div class="memdoc"> 116 <div class="memdoc">
128 117
129 <p> 118 <p>
130 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. 119 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
131 <p> 120 <p>
132 121
133 <p>Definition at line <a class="el" href="PluginAdapter_8cpp-source.html#l00138">138</a> of file <a class="el" href="PluginAdapter_8cpp-source.html">PluginAdapter.cpp</a>.</p> 122 <p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00054">vampGetPluginDescriptor()</a>.</p>
134
135 <p>References <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8h-source.html#l00079">m_impl</a>.</p>
136
137 <p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00050">vampGetPluginDescriptor()</a>.</p>
138 123
139 </div> 124 </div>
140 </div><p> 125 </div><p>
141 <a class="anchor" name="9116adb9b7a426f4f0ded15e45a5531b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::createPlugin" ref="9116adb9b7a426f4f0ded15e45a5531b" args="(float inputSampleRate)=0" --> 126 <a class="anchor" name="9116adb9b7a426f4f0ded15e45a5531b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::createPlugin" ref="9116adb9b7a426f4f0ded15e45a5531b" args="(float inputSampleRate)=0" -->
142 <div class="memitem"> 127 <div class="memitem">
146 <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::PluginAdapterBase::createPlugin </td> 131 <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::PluginAdapterBase::createPlugin </td>
147 <td>(</td> 132 <td>(</td>
148 <td class="paramtype">float&nbsp;</td> 133 <td class="paramtype">float&nbsp;</td>
149 <td class="paramname"> <em>inputSampleRate</em> </td> 134 <td class="paramname"> <em>inputSampleRate</em> </td>
150 <td>&nbsp;)&nbsp;</td> 135 <td>&nbsp;)&nbsp;</td>
151 <td width="100%"><code> [protected, pure virtual]</code></td> 136 <td><code> [protected, pure virtual]</code></td>
152 </tr> 137 </tr>
153 </table> 138 </table>
154 </div> 139 </div>
155 <div class="memdoc"> 140 <div class="memdoc">
156 141
157 <p> 142 <p>
158 143
159 <p>Implemented in <a class="el" href="classVamp_1_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">Vamp::PluginAdapter&lt; P &gt;</a>.</p> 144 <p>Implemented in <a class="el" href="classVamp_1_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">Vamp::PluginAdapter&lt; P &gt;</a>.</p>
160 145
161 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00317">Vamp::PluginAdapterBase::Impl::vampInstantiate()</a>.</p>
162
163 </div> 146 </div>
164 </div><p> 147 </div><p>
165 <hr><h2>Member Data Documentation</h2> 148 <hr><h2>Member Data Documentation</h2>
166 <a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" --> 149 <a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" -->
167 <div class="memitem"> 150 <div class="memitem">
168 <div class="memproto"> 151 <div class="memproto">
169 <table class="memname"> 152 <table class="memname">
170 <tr> 153 <tr>
171 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected]</code> </td> 154 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected]</code> </td>
172 </tr> 155 </tr>
173 </table> 156 </table>
174 </div> 157 </div>
175 <div class="memdoc"> 158 <div class="memdoc">
176 159
177 <p> 160 <p>
178 161
179 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00079">79</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p> 162 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00081">81</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
180
181 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00138">getDescriptor()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00127">PluginAdapterBase()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00132">~PluginAdapterBase()</a>.</p>
182 163
183 </div> 164 </div>
184 </div><p> 165 </div><p>
185 <hr>The documentation for this class was generated from the following files:<ul> 166 <hr>The documentation for this class was generated from the following file:<ul>
186 <li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a><li><a class="el" href="PluginAdapter_8cpp-source.html">PluginAdapter.cpp</a></ul> 167 <li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a></ul>
187 </div> 168 </div>
188 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by&nbsp; 169 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:20 2008 for VampPluginSDK by&nbsp;
189 <a href="http://www.doxygen.org/index.html"> 170 <a href="http://www.doxygen.org/index.html">
190 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 171 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
191 </body> 172 </body>
192 </html> 173 </html>