Mercurial > hg > vamp-website

comparison code-doc/PluginSummarisingAdapter_8h-source.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children
comparison
equal deleted inserted replaced
34:4b4db9230e94 35:0976232e353b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 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"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: PluginSummarisingAdapter.h Source File</title> 3 <title>VampPluginSDK: PluginSummarisingAdapter.h Source File</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css">
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 <link href="doxygen.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.6 --> 7 <!-- Generated by Doxygen 1.5.8 -->
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>
13 <li><a href="annotated.html"><span>Classes</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> 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</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="files.html"><span>File&nbsp;List</span></a></li>
21 <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
16 </ul> 22 </ul>
17 </div> 23 </div>
18 <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a> 24 <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a>
19 </div> 25 </div>
20 </div> 26 </div>
25 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 31 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
26 <a name="l00005"></a>00005 <span class="comment"></span> 32 <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> 33 <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> 34 <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> 35 <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> 36 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
31 <a name="l00010"></a>00010 <span class="comment"> </span> 37 <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> 38 <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> 39 <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> 40 <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> 41 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</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); 81 <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>(); 82 <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 83 <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); 84 <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 85 <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); 86 <a name="l00099"></a>00099 <span class="keywordtype">void</span> reset();
81 <a name="l00100"></a>00100 FeatureSet getRemainingFeatures(); 87 <a name="l00100"></a>00100
82 <a name="l00101"></a>00101 88 <a name="l00101"></a>00101 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);
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; 89 <a name="l00102"></a>00102 FeatureSet getRemainingFeatures();
84 <a name="l00103"></a>00103 90 <a name="l00103"></a>00103
85 <a name="l00117"></a>00117 <span class="keywordtype">void</span> setSummarySegmentBoundaries(<span class="keyword">const</span> SegmentBoundaries &amp;); 91 <a name="l00104"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">00104</a> <span class="keyword">typedef</span> std::set&lt;RealTime&gt; SegmentBoundaries;
86 <a name="l00118"></a>00118 92 <a name="l00105"></a>00105
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> { 93 <a name="l00119"></a>00119 <span class="keywordtype">void</span> setSummarySegmentBoundaries(<span class="keyword">const</span> SegmentBoundaries &amp;);
88 <a name="l00120"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c">00120</a> Minimum = 0, 94 <a name="l00120"></a>00120
89 <a name="l00121"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9">00121</a> Maximum = 1, 95 <a name="l00121"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">00121</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a> {
90 <a name="l00122"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75">00122</a> Mean = 2, 96 <a name="l00122"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c">00122</a> Minimum = 0,
91 <a name="l00123"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195">00123</a> Median = 3, 97 <a name="l00123"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9">00123</a> Maximum = 1,
92 <a name="l00124"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614">00124</a> Mode = 4, 98 <a name="l00124"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75">00124</a> Mean = 2,
93 <a name="l00125"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b">00125</a> Sum = 5, 99 <a name="l00125"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195">00125</a> Median = 3,
94 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075">00126</a> Variance = 6, 100 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614">00126</a> Mode = 4,
95 <a name="l00127"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7">00127</a> StandardDeviation = 7, 101 <a name="l00127"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b">00127</a> Sum = 5,
96 <a name="l00128"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6">00128</a> Count = 8, 102 <a name="l00128"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075">00128</a> Variance = 6,
97 <a name="l00129"></a>00129 103 <a name="l00129"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7">00129</a> StandardDeviation = 7,
98 <a name="l00130"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c">00130</a> UnknownSummaryType = 999 104 <a name="l00130"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6">00130</a> Count = 8,
99 <a name="l00131"></a>00131 }; 105 <a name="l00131"></a>00131
100 <a name="l00132"></a>00132 106 <a name="l00132"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c">00132</a> UnknownSummaryType = 999
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> { 107 <a name="l00133"></a>00133 };
102 <a name="l00156"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36">00156</a> SampleAverage = 0, 108 <a name="l00134"></a>00134
103 <a name="l00157"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa">00157</a> ContinuousTimeAverage = 1, 109 <a name="l00157"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">00157</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> {
104 <a name="l00158"></a>00158 }; 110 <a name="l00158"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36">00158</a> SampleAverage = 0,
105 <a name="l00159"></a>00159 111 <a name="l00159"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa">00159</a> ContinuousTimeAverage = 1
106 <a name="l00168"></a>00168 FeatureList getSummaryForOutput(<span class="keywordtype">int</span> output, 112 <a name="l00160"></a>00160 };
107 <a name="l00169"></a>00169 SummaryType type, 113 <a name="l00161"></a>00161
108 <a name="l00170"></a>00170 AveragingMethod method = SampleAverage); 114 <a name="l00170"></a>00170 FeatureList getSummaryForOutput(<span class="keywordtype">int</span> output,
109 <a name="l00171"></a>00171 115 <a name="l00171"></a>00171 SummaryType type,
110 <a name="l00181"></a>00181 FeatureSet getSummaryForAllOutputs(SummaryType type, 116 <a name="l00172"></a>00172 AveragingMethod method = SampleAverage);
111 <a name="l00182"></a>00182 AveragingMethod method = SampleAverage); 117 <a name="l00173"></a>00173
112 <a name="l00183"></a>00183 118 <a name="l00183"></a>00183 FeatureSet getSummaryForAllOutputs(SummaryType type,
113 <a name="l00184"></a>00184 <span class="keyword">protected</span>: 119 <a name="l00184"></a>00184 AveragingMethod method = SampleAverage);
114 <a name="l00185"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">00185</a> <span class="keyword">class </span>Impl; 120 <a name="l00185"></a>00185
115 <a name="l00186"></a>00186 Impl *m_impl; 121 <a name="l00186"></a>00186 <span class="keyword">protected</span>:
116 <a name="l00187"></a>00187 }; 122 <a name="l00187"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">00187</a> <span class="keyword">class </span>Impl;
117 <a name="l00188"></a>00188 123 <a name="l00188"></a>00188 Impl *m_impl;
118 <a name="l00189"></a>00189 } 124 <a name="l00189"></a>00189 };
119 <a name="l00190"></a>00190 125 <a name="l00190"></a>00190
120 <a name="l00191"></a>00191 } 126 <a name="l00191"></a>00191 }
121 <a name="l00192"></a>00192 127 <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) 128 <a name="l00193"></a>00193 }
123 <a name="l00194"></a>00194 129 <a name="l00194"></a>00194
124 <a name="l00195"></a>00195 <span class="preprocessor">#endif</span> 130 <a name="l00195"></a>00195 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginSummarisingAdapter.h)
131 <a name="l00196"></a>00196
132 <a name="l00197"></a>00197 <span class="preprocessor">#endif</span>
125 </pre></div></div> 133 </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; 134 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
127 <a href="http://www.doxygen.org/index.html"> 135 <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> 136 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
129 </body> 137 </body>
130 </html> 138 </html>