Mercurial > hg > vamp-docs

comparison code-docs/PluginBufferingAdapter_8h_source.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: PluginBufferingAdapter.h Source File</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li>
49 <li class="current"><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="files.html"><span>File&#160;List</span></a></li>
56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
57 </ul>
58 </div>
59 </div>
60 <div id="side-nav" class="ui-resizable side-nav-resizable">
61 <div id="nav-tree">
62 <div id="nav-tree-contents">
63 </div>
64 </div>
65 <div id="splitbar" style="-moz-user-select:none;"
66 class="ui-resizable-handle">
67 </div>
68 </div>
69 <script type="text/javascript">
70 initNavTree('PluginBufferingAdapter_8h.html','');
71 </script>
72 <div id="doc-content">
73 <div class="header">
74 <div class="headertitle">
75 <div class="title">PluginBufferingAdapter.h</div> </div>
76 </div>
77 <div class="contents">
78 <a href="PluginBufferingAdapter_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span>
79 <a name="l00002"></a>00002
80 <a name="l00003"></a>00003 <span class="comment">/*</span>
81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
82 <a name="l00005"></a>00005 <span class="comment"></span>
83 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
84 <a name="l00007"></a>00007 <span class="comment"></span>
85 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
86 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
87 <a name="l00010"></a>00010 <span class="comment"> This file by Mark Levy and Chris Cannam, Copyright 2007-2008 QMUL.</span>
88 <a name="l00011"></a>00011 <span class="comment"> </span>
89 <a name="l00012"></a>00012 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
90 <a name="l00013"></a>00013 <span class="comment"> obtaining a copy of this software and associated documentation</span>
91 <a name="l00014"></a>00014 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
92 <a name="l00015"></a>00015 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
93 <a name="l00016"></a>00016 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
94 <a name="l00017"></a>00017 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
95 <a name="l00018"></a>00018 <span class="comment"> furnished to do so, subject to the following conditions:</span>
96 <a name="l00019"></a>00019 <span class="comment"></span>
97 <a name="l00020"></a>00020 <span class="comment"> The above copyright notice and this permission notice shall be</span>
98 <a name="l00021"></a>00021 <span class="comment"> included in all copies or substantial portions of the Software.</span>
99 <a name="l00022"></a>00022 <span class="comment"></span>
100 <a name="l00023"></a>00023 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
101 <a name="l00024"></a>00024 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
102 <a name="l00025"></a>00025 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
103 <a name="l00026"></a>00026 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
104 <a name="l00027"></a>00027 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
105 <a name="l00028"></a>00028 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
106 <a name="l00029"></a>00029 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
107 <a name="l00030"></a>00030 <span class="comment"></span>
108 <a name="l00031"></a>00031 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
109 <a name="l00032"></a>00032 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
110 <a name="l00033"></a>00033 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
111 <a name="l00034"></a>00034 <span class="comment"> use or other dealings in this Software without prior written</span>
112 <a name="l00035"></a>00035 <span class="comment"> authorization.</span>
113 <a name="l00036"></a>00036 <span class="comment">*/</span>
114 <a name="l00037"></a>00037
115 <a name="l00038"></a>00038 <span class="preprocessor">#ifndef _VAMP_PLUGIN_BUFFERING_ADAPTER_H_</span>
116 <a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_BUFFERING_ADAPTER_H_</span>
117 <a name="l00040"></a>00040 <span class="preprocessor"></span>
118 <a name="l00041"></a>00041 <span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span>
119 <a name="l00042"></a>00042 <span class="preprocessor">#include &quot;<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>&quot;</span>
120 <a name="l00043"></a>00043
121 <a name="l00044"></a>00044 <a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginBufferingAdapter.h)
122 <a name="l00045"></a>00045
123 <a name="l00046"></a>00046 namespace Vamp {
124 <a name="l00047"></a>00047
125 <a name="l00048"></a><a class="code" href="namespaceVamp_1_1HostExt.html">00048</a> <span class="keyword">namespace </span>HostExt {
126 <a name="l00049"></a>00049
127 <a name="l00075"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">00075</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> : <span class="keyword">public</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a>
128 <a name="l00076"></a>00076 {
129 <a name="l00077"></a>00077 <span class="keyword">public</span>:
130 <a name="l00083"></a>00083 <a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a>(<a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Plugin</a> *plugin);
131 <a name="l00084"></a>00084 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a>();
132 <a name="l00085"></a>00085
133 <a name="l00095"></a>00095 <span class="keywordtype">size_t</span> getPreferredStepSize() <span class="keyword">const</span>;
134 <a name="l00096"></a>00096
135 <a name="l00107"></a>00107 <span class="keywordtype">size_t</span> getPreferredBlockSize() <span class="keyword">const</span>;
136 <a name="l00108"></a>00108
137 <a name="l00118"></a>00118 <span class="keywordtype">bool</span> initialise(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize);
138 <a name="l00119"></a>00119
139 <a name="l00131"></a>00131 <span class="keywordtype">size_t</span> getPluginPreferredStepSize() <span class="keyword">const</span>;
140 <a name="l00132"></a>00132
141 <a name="l00139"></a>00139 <span class="keywordtype">size_t</span> getPluginPreferredBlockSize() <span class="keyword">const</span>;
142 <a name="l00140"></a>00140
143 <a name="l00148"></a>00148 <span class="keywordtype">void</span> setPluginStepSize(<span class="keywordtype">size_t</span> stepSize);
144 <a name="l00149"></a>00149
145 <a name="l00157"></a>00157 <span class="keywordtype">void</span> setPluginBlockSize(<span class="keywordtype">size_t</span> blockSize);
146 <a name="l00158"></a>00158
147 <a name="l00170"></a>00170 <span class="keywordtype">void</span> getActualStepAndBlockSizes(<span class="keywordtype">size_t</span> &amp;stepSize, <span class="keywordtype">size_t</span> &amp;blockSize);
148 <a name="l00171"></a>00171
149 <a name="l00172"></a>00172 <span class="keywordtype">void</span> setParameter(std::string, <span class="keywordtype">float</span>);
150 <a name="l00173"></a>00173 <span class="keywordtype">void</span> selectProgram(std::string);
151 <a name="l00174"></a>00174
152 <a name="l00175"></a>00175 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> getOutputDescriptors() <span class="keyword">const</span>;
153 <a name="l00176"></a>00176
154 <a name="l00177"></a>00177 <span class="keywordtype">void</span> reset();
155 <a name="l00178"></a>00178
156 <a name="l00179"></a>00179 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> process(<span class="keyword">const</span> <span class="keywordtype">float</span> *<span class="keyword">const</span> *inputBuffers, <a class="code" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> timestamp);
157 <a name="l00180"></a>00180
158 <a name="l00181"></a>00181 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures();
159 <a name="l00182"></a>00182
160 <a name="l00183"></a>00183 <span class="keyword">protected</span>:
161 <a name="l00184"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">00184</a> <span class="keyword">class </span>Impl;
162 <a name="l00185"></a>00185 Impl *<a class="code" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">m_impl</a>;
163 <a name="l00186"></a>00186 };
164 <a name="l00187"></a>00187
165 <a name="l00188"></a>00188 }
166 <a name="l00189"></a>00189
167 <a name="l00190"></a>00190 }
168 <a name="l00191"></a>00191
169 <a name="l00192"></a>00192 <a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginBufferingAdapter.h)
170 <a name="l00193"></a>00193
171 <a name="l00194"></a>00194 <span class="preprocessor">#endif</span>
172 </pre></div></div>
173 </div>
174 <div id="nav-path" class="navpath">
175 <ul>
176 <li class="navelem"><a class="el" href="PluginBufferingAdapter_8h.html">PluginBufferingAdapter.h</a> </li>
177
178 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
179 <a href="http://www.doxygen.org/index.html">
180 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
181 </ul>
182 </div>
183
184
185 </body>
186 </html>