Mercurial > hg > vamp-docs

annotate code-docs/PluginSummarisingAdapter_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
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@1 5 <title>VampPluginSDK: PluginSummarisingAdapter.h Source File</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li class="current"><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="files.html"><span>File&#160;List</span></a></li>
Chris@1 56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
Chris@1 57 </ul>
Chris@1 58 </div>
Chris@1 59 </div>
Chris@1 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 61 <div id="nav-tree">
Chris@1 62 <div id="nav-tree-contents">
Chris@1 63 </div>
Chris@1 64 </div>
Chris@1 65 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 66 class="ui-resizable-handle">
Chris@1 67 </div>
Chris@1 68 </div>
Chris@1 69 <script type="text/javascript">
Chris@1 70 initNavTree('PluginSummarisingAdapter_8h.html','');
Chris@1 71 </script>
Chris@1 72 <div id="doc-content">
Chris@1 73 <div class="header">
Chris@1 74 <div class="headertitle">
Chris@1 75 <div class="title">PluginSummarisingAdapter.h</div> </div>
Chris@1 76 </div>
Chris@1 77 <div class="contents">
Chris@1 78 <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>
Chris@1 79 <a name="l00002"></a>00002
Chris@1 80 <a name="l00003"></a>00003 <span class="comment">/*</span>
Chris@1 81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
Chris@1 82 <a name="l00005"></a>00005 <span class="comment"></span>
Chris@1 83 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
Chris@1 84 <a name="l00007"></a>00007 <span class="comment"></span>
Chris@1 85 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
Chris@1 86 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006-2009 Chris Cannam and QMUL.</span>
Chris@1 87 <a name="l00010"></a>00010 <span class="comment"> </span>
Chris@1 88 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
Chris@1 89 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
Chris@1 90 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
Chris@1 91 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
Chris@1 92 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
Chris@1 93 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
Chris@1 94 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
Chris@1 95 <a name="l00018"></a>00018 <span class="comment"></span>
Chris@1 96 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
Chris@1 97 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
Chris@1 98 <a name="l00021"></a>00021 <span class="comment"></span>
Chris@1 99 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
Chris@1 100 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
Chris@1 101 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
Chris@1 102 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
Chris@1 103 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
Chris@1 104 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
Chris@1 105 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
Chris@1 106 <a name="l00029"></a>00029 <span class="comment"></span>
Chris@1 107 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
Chris@1 108 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
Chris@1 109 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
Chris@1 110 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
Chris@1 111 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
Chris@1 112 <a name="l00035"></a>00035 <span class="comment">*/</span>
Chris@1 113 <a name="l00036"></a>00036
Chris@1 114 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_</span>
Chris@1 115 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_PLUGIN_SUMMARISING_ADAPTER_H_</span>
Chris@1 116 <a name="l00039"></a>00039 <span class="preprocessor"></span>
Chris@1 117 <a name="l00040"></a>00040 <span class="preprocessor">#include &quot;<a class="code" href="hostguard_8h.html">hostguard.h</a>&quot;</span>
Chris@1 118 <a name="l00041"></a>00041 <span class="preprocessor">#include &quot;<a class="code" href="PluginWrapper_8h.html">PluginWrapper.h</a>&quot;</span>
Chris@1 119 <a name="l00042"></a>00042
Chris@1 120 <a name="l00043"></a>00043 <span class="preprocessor">#include &lt;set&gt;</span>
Chris@1 121 <a name="l00044"></a>00044
Chris@1 122 <a name="l00045"></a>00045 <a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">_VAMP_SDK_HOSTSPACE_BEGIN</a>(PluginSummarisingAdapter.h)
Chris@1 123 <a name="l00046"></a>00046
Chris@1 124 <a name="l00047"></a>00047 namespace Vamp {
Chris@1 125 <a name="l00048"></a>00048
Chris@1 126 <a name="l00049"></a>00049 <span class="keyword">namespace </span>HostExt {
Chris@1 127 <a name="l00050"></a>00050
Chris@1 128 <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 such as mean an...">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>
Chris@1 129 <a name="l00087"></a>00087 {
Chris@1 130 <a name="l00088"></a>00088 <span class="keyword">public</span>:
Chris@1 131 <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 such as mean an...">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 from audio o...">Plugin</a> *plugin);
Chris@1 132 <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 such as mean an...">PluginSummarisingAdapter</a>();
Chris@1 133 <a name="l00096"></a>00096
Chris@1 134 <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);
Chris@1 135 <a name="l00098"></a>00098
Chris@1 136 <a name="l00099"></a>00099 <span class="keywordtype">void</span> reset();
Chris@1 137 <a name="l00100"></a>00100
Chris@1 138 <a name="l00101"></a>00101 <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);
Chris@1 139 <a name="l00102"></a>00102 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> getRemainingFeatures();
Chris@1 140 <a name="l00103"></a>00103
Chris@1 141 <a name="l00104"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">00104</a> <span class="keyword">typedef</span> std::set&lt;RealTime&gt; <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a>;
Chris@1 142 <a name="l00105"></a>00105
Chris@1 143 <a name="l00119"></a>00119 <span class="keywordtype">void</span> setSummarySegmentBoundaries(<span class="keyword">const</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;);
Chris@1 144 <a name="l00120"></a>00120
Chris@1 145 <a name="l00121"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">00121</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> {
Chris@1 146 <a name="l00122"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c">00122</a> Minimum = 0,
Chris@1 147 <a name="l00123"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9">00123</a> Maximum = 1,
Chris@1 148 <a name="l00124"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75">00124</a> Mean = 2,
Chris@1 149 <a name="l00125"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195">00125</a> Median = 3,
Chris@1 150 <a name="l00126"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614">00126</a> Mode = 4,
Chris@1 151 <a name="l00127"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b">00127</a> Sum = 5,
Chris@1 152 <a name="l00128"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075">00128</a> Variance = 6,
Chris@1 153 <a name="l00129"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7">00129</a> StandardDeviation = 7,
Chris@1 154 <a name="l00130"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6">00130</a> Count = 8,
Chris@1 155 <a name="l00131"></a>00131
Chris@1 156 <a name="l00132"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c">00132</a> UnknownSummaryType = 999
Chris@1 157 <a name="l00133"></a>00133 };
Chris@1 158 <a name="l00134"></a>00134
Chris@1 159 <a name="l00157"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">00157</a> <span class="keyword">enum</span> <a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76" title="AveragingMethod indicates how the adapter should handle average-based summaries of features whose res...">AveragingMethod</a> {
Chris@1 160 <a name="l00158"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">00158</a> SampleAverage = 0,
Chris@1 161 <a name="l00159"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa">00159</a> ContinuousTimeAverage = 1
Chris@1 162 <a name="l00160"></a>00160 };
Chris@1 163 <a name="l00161"></a>00161
Chris@1 164 <a name="l00170"></a>00170 FeatureList getSummaryForOutput(<span class="keywordtype">int</span> output,
Chris@1 165 <a name="l00171"></a>00171 SummaryType type,
Chris@1 166 <a name="l00172"></a>00172 AveragingMethod method = SampleAverage);
Chris@1 167 <a name="l00173"></a>00173
Chris@1 168 <a name="l00183"></a>00183 FeatureSet getSummaryForAllOutputs(SummaryType type,
Chris@1 169 <a name="l00184"></a>00184 AveragingMethod method = SampleAverage);
Chris@1 170 <a name="l00185"></a>00185
Chris@1 171 <a name="l00186"></a>00186 <span class="keyword">protected</span>:
Chris@1 172 <a name="l00187"></a><a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af131140817d9f131650af98b6b8d7a94">00187</a> <span class="keyword">class </span>Impl;
Chris@1 173 <a name="l00188"></a>00188 Impl *<a class="code" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af131140817d9f131650af98b6b8d7a94">m_impl</a>;
Chris@1 174 <a name="l00189"></a>00189 };
Chris@1 175 <a name="l00190"></a>00190
Chris@1 176 <a name="l00191"></a>00191 }
Chris@1 177 <a name="l00192"></a>00192
Chris@1 178 <a name="l00193"></a>00193 }
Chris@1 179 <a name="l00194"></a>00194
Chris@1 180 <a name="l00195"></a>00195 <a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">_VAMP_SDK_HOSTSPACE_END</a>(PluginSummarisingAdapter.h)
Chris@1 181 <a name="l00196"></a>00196
Chris@1 182 <a name="l00197"></a>00197 <span class="preprocessor">#endif</span>
Chris@1 183 </pre></div></div>
Chris@1 184 </div>
Chris@1 185 <div id="nav-path" class="navpath">
Chris@1 186 <ul>
Chris@1 187 <li class="navelem"><a class="el" href="PluginSummarisingAdapter_8h.html">PluginSummarisingAdapter.h</a> </li>
Chris@1 188
Chris@1 189 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
Chris@1 190 <a href="http://www.doxygen.org/index.html">
Chris@1 191 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 192 </ul>
Chris@1 193 </div>
Chris@1 194
Chris@1 195
Chris@1 196 </body>
Chris@1 197 </html>