Mercurial > hg > vamp-website

comparison code-doc/PluginSummarisingAdapter_8h-source.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
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
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: PluginSummarisingAdapter.h Source File</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.6 -->
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><a href="annotated.html"><span>Classes</span></a></li>
14 <li class="current"><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="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a>
19 </div>
20 </div>
21 <div class="contents">
22 <h1>PluginSummarisingAdapter.h</h1><a href="PluginSummarisingAdapter_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>
23 <a name="l00002"></a>00002
24 <a name="l00003"></a>00003 <span class="comment">/*</span>
25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
26 <a name="l00005"></a>00005 <span class="comment"></span>
27 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
28 <a name="l00007"></a>00007 <span class="comment"></span>
29 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
30 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2008 Chris Cannam and QMUL.</span>
31 <a name="l00010"></a>00010 <span class="comment"> </span>
32 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
33 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
34 <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span>
35 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
36 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
37 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
38 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
39 <a name="l00018"></a>00018 <span class="comment"></span>
40 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
41 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
42 <a name="l00021"></a>00021 <span class="comment"></span>
43 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
44 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
45 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
46 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
47 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
48 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
49 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
50 <a name="l00029"></a>00029 <span class="comment"></span>
51 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
52 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
53 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
54 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
55 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
56 <a name="l00035"></a>00035 <span class="comment">*/</span>
57 <a name="l00036"></a>00036
58 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_</span>
59 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_</span>
60 <a name="l00039"></a>00039 <span class="preprocessor"></span>
61 <a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="hostguard_8h.html">hostguard.h</a>"</span>
62 <a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>"</span>
63 <a name="l00042"></a>00042
64 <a name="l00043"></a>00043 <span class="preprocessor">#include &lt;set&gt;</span>
65 <a name="l00044"></a>00044
66 <a name="l00045"></a>00045 <a class="code" href="hostguard_8h.html#ef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginSummarisingAdapter.h)
67 <a name="l00046"></a>00046
68 <a name="l00047"></a>00047 namespace Vamp {
69 <a name="l00048"></a>00048
70 <a name="l00049"></a>00049 <span class="keyword">namespace </span>HostExt {
71 <a name="l00050"></a>00050
72 <a name="l00086"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html">00086</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">PluginSummarisingAdapter</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>
73 <a name="l00087"></a>00087 {
74 <a name="l00088"></a>00088 <span class="keyword">public</span>:
75 <a name="l00094"></a>00094 <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">PluginSummarisingAdapter</a>(<a class="code" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Plugin</a> *plugin);
76 <a name="l00095"></a>00095 <span class="keyword">virtual</span> ~<a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">PluginSummarisingAdapter</a>();
77 <a name="l00096"></a>00096
78 <a name="l00097"></a>00097 <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);
79 <a name="l00098"></a>00098
80 <a name="l00099"></a>00099 FeatureSet 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...">RealTime</a> timestamp);
81 <a name="l00100"></a>00100 FeatureSet getRemainingFeatures();
82 <a name="l00101"></a>00101
83 <a name="l00102"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">00102</a> <span class="keyword">typedef</span> std::set&lt;RealTime&gt; SegmentBoundaries;
84 <a name="l00103"></a>00103
85 <a name="l00117"></a>00117 <span class="keywordtype">void</span> setSummarySegmentBoundaries(<span class="keyword">const</span> SegmentBoundaries &amp;);
86 <a name="l00118"></a>00118
87 <a name="l00119"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">00119</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a> {
88 <a name="l00120"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c">00120</a> Minimum = 0,
89 <a name="l00121"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9">00121</a> Maximum = 1,
90 <a name="l00122"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75">00122</a> Mean = 2,
91 <a name="l00123"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195">00123</a> Median = 3,
92 <a name="l00124"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614">00124</a> Mode = 4,
93 <a name="l00125"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b">00125</a> Sum = 5,
94 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075">00126</a> Variance = 6,
95 <a name="l00127"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7">00127</a> StandardDeviation = 7,
96 <a name="l00128"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6">00128</a> Count = 8,
97 <a name="l00129"></a>00129
98 <a name="l00130"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c">00130</a> UnknownSummaryType = 999
99 <a name="l00131"></a>00131 };
100 <a name="l00132"></a>00132
101 <a name="l00155"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">00155</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76" title="AveragingMethod indicates how the adapter should handle average-based summaries of...">AveragingMethod</a> {
102 <a name="l00156"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36">00156</a> SampleAverage = 0,
103 <a name="l00157"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa">00157</a> ContinuousTimeAverage = 1,
104 <a name="l00158"></a>00158 };
105 <a name="l00159"></a>00159
106 <a name="l00168"></a>00168 FeatureList getSummaryForOutput(<span class="keywordtype">int</span> output,
107 <a name="l00169"></a>00169 SummaryType type,
108 <a name="l00170"></a>00170 AveragingMethod method = SampleAverage);
109 <a name="l00171"></a>00171
110 <a name="l00181"></a>00181 FeatureSet getSummaryForAllOutputs(SummaryType type,
111 <a name="l00182"></a>00182 AveragingMethod method = SampleAverage);
112 <a name="l00183"></a>00183
113 <a name="l00184"></a>00184 <span class="keyword">protected</span>:
114 <a name="l00185"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">00185</a> <span class="keyword">class </span>Impl;
115 <a name="l00186"></a>00186 Impl *m_impl;
116 <a name="l00187"></a>00187 };
117 <a name="l00188"></a>00188
118 <a name="l00189"></a>00189 }
119 <a name="l00190"></a>00190
120 <a name="l00191"></a>00191 }
121 <a name="l00192"></a>00192
122 <a name="l00193"></a>00193 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginSummarisingAdapter.h)
123 <a name="l00194"></a>00194
124 <a name="l00195"></a>00195 <span class="preprocessor">#endif</span>
125 </pre></div></div>
126 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
127 <a href="http://www.doxygen.org/index.html">
128 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
129 </body>
130 </html>