Mercurial > hg > vamp-website
diff code-doc/PluginSummarisingAdapter_8h-source.html @ 35:0976232e353b website
* Update for 2.1 release; add wiki link
| author | cannam |
|---|---|
| date | Fri, 25 Sep 2009 15:40:18 +0000 |
| parents | cc0be37dc9d3 |
| children |
line wrap: on
line diff
--- a/code-doc/PluginSummarisingAdapter_8h-source.html Wed Sep 23 15:09:53 2009 +0000 +++ b/code-doc/PluginSummarisingAdapter_8h-source.html Fri Sep 25 15:40:18 2009 +0000 @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: PluginSummarisingAdapter.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> -<link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.5.6 --> +<!-- Generated by Doxygen 1.5.8 --> <div class="navigation" id="top"> <div class="tabs"> <ul> @@ -15,6 +15,12 @@ <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> <div class="navpath"><a class="el" href="dir_4571ebff077265f6d30f5427df02fcd6.html">vamp-hostsdk</a> </div> </div> @@ -27,7 +33,7 @@ <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span> <a name="l00007"></a>00007 <span class="comment"></span> <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span> -<a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2008 Chris Cannam and QMUL.</span> +<a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span> <a name="l00010"></a>00010 <span class="comment"> </span> <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span> <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span> @@ -77,54 +83,56 @@ <a name="l00096"></a>00096 <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); <a name="l00098"></a>00098 -<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); -<a name="l00100"></a>00100 FeatureSet getRemainingFeatures(); -<a name="l00101"></a>00101 -<a name="l00102"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">00102</a> <span class="keyword">typedef</span> std::set<RealTime> SegmentBoundaries; +<a name="l00099"></a>00099 <span class="keywordtype">void</span> reset(); +<a name="l00100"></a>00100 +<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); +<a name="l00102"></a>00102 FeatureSet getRemainingFeatures(); <a name="l00103"></a>00103 -<a name="l00117"></a>00117 <span class="keywordtype">void</span> setSummarySegmentBoundaries(<span class="keyword">const</span> SegmentBoundaries &); -<a name="l00118"></a>00118 -<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> { -<a name="l00120"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c">00120</a> Minimum = 0, -<a name="l00121"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9">00121</a> Maximum = 1, -<a name="l00122"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75">00122</a> Mean = 2, -<a name="l00123"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195">00123</a> Median = 3, -<a name="l00124"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614">00124</a> Mode = 4, -<a name="l00125"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b">00125</a> Sum = 5, -<a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075">00126</a> Variance = 6, -<a name="l00127"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7">00127</a> StandardDeviation = 7, -<a name="l00128"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6">00128</a> Count = 8, -<a name="l00129"></a>00129 -<a name="l00130"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c">00130</a> UnknownSummaryType = 999 -<a name="l00131"></a>00131 }; -<a name="l00132"></a>00132 -<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> { -<a name="l00156"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36">00156</a> SampleAverage = 0, -<a name="l00157"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa">00157</a> ContinuousTimeAverage = 1, -<a name="l00158"></a>00158 }; -<a name="l00159"></a>00159 -<a name="l00168"></a>00168 FeatureList getSummaryForOutput(<span class="keywordtype">int</span> output, -<a name="l00169"></a>00169 SummaryType type, -<a name="l00170"></a>00170 AveragingMethod method = SampleAverage); -<a name="l00171"></a>00171 -<a name="l00181"></a>00181 FeatureSet getSummaryForAllOutputs(SummaryType type, -<a name="l00182"></a>00182 AveragingMethod method = SampleAverage); -<a name="l00183"></a>00183 -<a name="l00184"></a>00184 <span class="keyword">protected</span>: -<a name="l00185"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">00185</a> <span class="keyword">class </span>Impl; -<a name="l00186"></a>00186 Impl *m_impl; -<a name="l00187"></a>00187 }; -<a name="l00188"></a>00188 -<a name="l00189"></a>00189 } +<a name="l00104"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">00104</a> <span class="keyword">typedef</span> std::set<RealTime> SegmentBoundaries; +<a name="l00105"></a>00105 +<a name="l00119"></a>00119 <span class="keywordtype">void</span> setSummarySegmentBoundaries(<span class="keyword">const</span> SegmentBoundaries &); +<a name="l00120"></a>00120 +<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> { +<a name="l00122"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c">00122</a> Minimum = 0, +<a name="l00123"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9">00123</a> Maximum = 1, +<a name="l00124"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75">00124</a> Mean = 2, +<a name="l00125"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195">00125</a> Median = 3, +<a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614">00126</a> Mode = 4, +<a name="l00127"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b">00127</a> Sum = 5, +<a name="l00128"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075">00128</a> Variance = 6, +<a name="l00129"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7">00129</a> StandardDeviation = 7, +<a name="l00130"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6">00130</a> Count = 8, +<a name="l00131"></a>00131 +<a name="l00132"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c">00132</a> UnknownSummaryType = 999 +<a name="l00133"></a>00133 }; +<a name="l00134"></a>00134 +<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> { +<a name="l00158"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36">00158</a> SampleAverage = 0, +<a name="l00159"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa">00159</a> ContinuousTimeAverage = 1 +<a name="l00160"></a>00160 }; +<a name="l00161"></a>00161 +<a name="l00170"></a>00170 FeatureList getSummaryForOutput(<span class="keywordtype">int</span> output, +<a name="l00171"></a>00171 SummaryType type, +<a name="l00172"></a>00172 AveragingMethod method = SampleAverage); +<a name="l00173"></a>00173 +<a name="l00183"></a>00183 FeatureSet getSummaryForAllOutputs(SummaryType type, +<a name="l00184"></a>00184 AveragingMethod method = SampleAverage); +<a name="l00185"></a>00185 +<a name="l00186"></a>00186 <span class="keyword">protected</span>: +<a name="l00187"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">00187</a> <span class="keyword">class </span>Impl; +<a name="l00188"></a>00188 Impl *m_impl; +<a name="l00189"></a>00189 }; <a name="l00190"></a>00190 <a name="l00191"></a>00191 } <a name="l00192"></a>00192 -<a name="l00193"></a>00193 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginSummarisingAdapter.h) +<a name="l00193"></a>00193 } <a name="l00194"></a>00194 -<a name="l00195"></a>00195 <span class="preprocessor">#endif</span> +<a name="l00195"></a>00195 <a class="code" href="hostguard_8h.html#0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginSummarisingAdapter.h) +<a name="l00196"></a>00196 +<a name="l00197"></a>00197 <span class="preprocessor">#endif</span> </pre></div></div> -<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by +<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> </body> </html>