Mercurial > hg > vamp-website
view code-doc/PowerSpectrum_8cpp_source.html @ 50:8260c0f4e05b website
Update code docs for 2.3
| author | cannam |
|---|---|
| date | Tue, 04 Oct 2011 13:47:23 +0000 |
| parents | |
| children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>VampPluginSDK: PowerSpectrum.cpp Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <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> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('PowerSpectrum_8cpp.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">PowerSpectrum.cpp</div> </div> </div> <div class="contents"> <a href="PowerSpectrum_8cpp.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> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">/*</span> <a name="l00004"></a>00004 <span class="comment"> Vamp</span> <a name="l00005"></a>00005 <span class="comment"></span> <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 2008 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> <a name="l00013"></a>00013 <span class="comment"> files (the "Software"), to deal in the Software without</span> <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span> <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span> <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span> <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span> <a name="l00018"></a>00018 <span class="comment"></span> <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span> <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span> <a name="l00021"></a>00021 <span class="comment"></span> <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span> <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span> <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span> <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span> <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span> <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span> <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span> <a name="l00029"></a>00029 <span class="comment"></span> <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span> <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span> <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span> <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span> <a name="l00034"></a>00034 <span class="comment"> authorization.</span> <a name="l00035"></a>00035 <span class="comment">*/</span> <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PowerSpectrum_8h.html">PowerSpectrum.h</a>"</span> <a name="l00038"></a>00038 <a name="l00039"></a>00039 <span class="keyword">using</span> std::string; <a name="l00040"></a>00040 <span class="keyword">using</span> std::cerr; <a name="l00041"></a>00041 <span class="keyword">using</span> std::endl; <a name="l00042"></a>00042 <a name="l00043"></a>00043 <span class="preprocessor">#include <math.h></span> <a name="l00044"></a>00044 <a name="l00045"></a><a class="code" href="classPowerSpectrum.html#aa2550486513a4abcf7b52869002947e7">00045</a> <a class="code" href="classPowerSpectrum.html#aa2550486513a4abcf7b52869002947e7">PowerSpectrum::PowerSpectrum</a>(<span class="keywordtype">float</span> inputSampleRate) : <a name="l00046"></a>00046 Plugin(inputSampleRate), <a name="l00047"></a>00047 m_blockSize(0) <a name="l00048"></a>00048 { <a name="l00049"></a>00049 } <a name="l00050"></a>00050 <a name="l00051"></a><a class="code" href="classPowerSpectrum.html#ae7081e159ad1da5da1721b3048075306">00051</a> <a class="code" href="classPowerSpectrum.html#ae7081e159ad1da5da1721b3048075306">PowerSpectrum::~PowerSpectrum</a>() <a name="l00052"></a>00052 { <a name="l00053"></a>00053 } <a name="l00054"></a>00054 <a name="l00055"></a>00055 <span class="keywordtype">string</span> <a name="l00056"></a><a class="code" href="classPowerSpectrum.html#a9e9d8349461cbb88d7565a5e8c51b64e">00056</a> <a class="code" href="classPowerSpectrum.html#a9e9d8349461cbb88d7565a5e8c51b64e" title="Get the computer-usable name of the plugin.">PowerSpectrum::getIdentifier</a>()<span class="keyword"> const</span> <a name="l00057"></a>00057 <span class="keyword"></span>{ <a name="l00058"></a>00058 <span class="keywordflow">return</span> <span class="stringliteral">"powerspectrum"</span>; <a name="l00059"></a>00059 } <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="keywordtype">string</span> <a name="l00062"></a><a class="code" href="classPowerSpectrum.html#ac9214f9cafeeed3fca549c90aef57623">00062</a> <a class="code" href="classPowerSpectrum.html#ac9214f9cafeeed3fca549c90aef57623" title="Get a human-readable name or title of the plugin.">PowerSpectrum::getName</a>()<span class="keyword"> const</span> <a name="l00063"></a>00063 <span class="keyword"></span>{ <a name="l00064"></a>00064 <span class="keywordflow">return</span> <span class="stringliteral">"Simple Power Spectrum"</span>; <a name="l00065"></a>00065 } <a name="l00066"></a>00066 <a name="l00067"></a>00067 <span class="keywordtype">string</span> <a name="l00068"></a><a class="code" href="classPowerSpectrum.html#a7b48d56dc954f3af344f7e4dcd8993e5">00068</a> <a class="code" href="classPowerSpectrum.html#a7b48d56dc954f3af344f7e4dcd8993e5" title="Get a human-readable description for the plugin, typically a line of text that may optionally be disp...">PowerSpectrum::getDescription</a>()<span class="keyword"> const</span> <a name="l00069"></a>00069 <span class="keyword"></span>{ <a name="l00070"></a>00070 <span class="keywordflow">return</span> <span class="stringliteral">"Return the power spectrum of a signal"</span>; <a name="l00071"></a>00071 } <a name="l00072"></a>00072 <a name="l00073"></a>00073 <span class="keywordtype">string</span> <a name="l00074"></a><a class="code" href="classPowerSpectrum.html#a9f3e3f759e2b67c771a41f1c276984b2">00074</a> <a class="code" href="classPowerSpectrum.html#a9f3e3f759e2b67c771a41f1c276984b2" title="Get the name of the author or vendor of the plugin in human-readable form.">PowerSpectrum::getMaker</a>()<span class="keyword"> const</span> <a name="l00075"></a>00075 <span class="keyword"></span>{ <a name="l00076"></a>00076 <span class="keywordflow">return</span> <span class="stringliteral">"Vamp SDK Example Plugins"</span>; <a name="l00077"></a>00077 } <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="keywordtype">int</span> <a name="l00080"></a><a class="code" href="classPowerSpectrum.html#ad23d27e4e82f10404a37b933f6a72c33">00080</a> <a class="code" href="classPowerSpectrum.html#ad23d27e4e82f10404a37b933f6a72c33" title="Get the version number of the plugin.">PowerSpectrum::getPluginVersion</a>()<span class="keyword"> const</span> <a name="l00081"></a>00081 <span class="keyword"></span>{ <a name="l00082"></a>00082 <span class="keywordflow">return</span> 1; <a name="l00083"></a>00083 } <a name="l00084"></a>00084 <a name="l00085"></a>00085 <span class="keywordtype">string</span> <a name="l00086"></a><a class="code" href="classPowerSpectrum.html#a708b4d335c57643d5ef2b2e1caf43bd9">00086</a> <a class="code" href="classPowerSpectrum.html#a708b4d335c57643d5ef2b2e1caf43bd9" title="Get the copyright statement or licensing summary for the plugin.">PowerSpectrum::getCopyright</a>()<span class="keyword"> const</span> <a name="l00087"></a>00087 <span class="keyword"></span>{ <a name="l00088"></a>00088 <span class="keywordflow">return</span> <span class="stringliteral">"Freely redistributable (BSD license)"</span>; <a name="l00089"></a>00089 } <a name="l00090"></a>00090 <a name="l00091"></a>00091 <span class="keywordtype">bool</span> <a name="l00092"></a><a class="code" href="classPowerSpectrum.html#ae2d046334c4bede5be72a0d97e4dfb29">00092</a> <a class="code" href="classPowerSpectrum.html#ae2d046334c4bede5be72a0d97e4dfb29" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">PowerSpectrum::initialise</a>(<span class="keywordtype">size_t</span> channels, <span class="keywordtype">size_t</span> stepSize, <span class="keywordtype">size_t</span> blockSize) <a name="l00093"></a>00093 { <a name="l00094"></a>00094 <span class="keywordflow">if</span> (channels < <a class="code" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525" title="Get the minimum supported number of input channels.">getMinChannelCount</a>() || <a name="l00095"></a>00095 channels > <a class="code" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e" title="Get the maximum supported number of input channels.">getMaxChannelCount</a>()) <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00096"></a>00096 <a name="l00097"></a>00097 <a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a> = blockSize; <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00100"></a>00100 } <a name="l00101"></a>00101 <a name="l00102"></a>00102 <span class="keywordtype">void</span> <a name="l00103"></a><a class="code" href="classPowerSpectrum.html#a091ba21e1697ea4208f42e8295c389d9">00103</a> <a class="code" href="classPowerSpectrum.html#a091ba21e1697ea4208f42e8295c389d9" title="Reset the plugin after use, to prepare it for another clean run.">PowerSpectrum::reset</a>() <a name="l00104"></a>00104 { <a name="l00105"></a>00105 } <a name="l00106"></a>00106 <a name="l00107"></a>00107 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">PowerSpectrum::OutputList</a> <a name="l00108"></a><a class="code" href="classPowerSpectrum.html#a6aac5f93e3a8c033026d739fed427242">00108</a> <a class="code" href="classPowerSpectrum.html#a6aac5f93e3a8c033026d739fed427242" title="Get the outputs of this plugin.">PowerSpectrum::getOutputDescriptors</a>()<span class="keyword"> const</span> <a name="l00109"></a>00109 <span class="keyword"></span>{ <a name="l00110"></a>00110 <a class="code" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> list; <a name="l00111"></a>00111 <a name="l00112"></a>00112 <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> d; <a name="l00113"></a>00113 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b" title="The name of the output, in computer-usable form.">identifier</a> = <span class="stringliteral">"powerspectrum"</span>; <a name="l00114"></a>00114 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87" title="The human-readable name of the output.">name</a> = <span class="stringliteral">"Power Spectrum"</span>; <a name="l00115"></a>00115 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1" title="A human-readable short text describing the output.">description</a> = <span class="stringliteral">"Power values of the frequency spectrum bins calculated from the input signal"</span>; <a name="l00116"></a>00116 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4" title="The unit of the output, in human-readable form.">unit</a> = <span class="stringliteral">""</span>; <a name="l00117"></a>00117 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d" title="True if the output has the same number of values per sample for every output sample.">hasFixedBinCount</a> = <span class="keyword">true</span>; <a name="l00118"></a>00118 <span class="keywordflow">if</span> (<a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a> == 0) { <a name="l00119"></a>00119 <span class="comment">// Just so as not to return "1". This is the bin count that</span> <a name="l00120"></a>00120 <span class="comment">// would result from a block size of 1024, which is a likely</span> <a name="l00121"></a>00121 <span class="comment">// default -- but the host should always set the block size</span> <a name="l00122"></a>00122 <span class="comment">// before querying the bin count for certain.</span> <a name="l00123"></a>00123 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = 513; <a name="l00124"></a>00124 } <span class="keywordflow">else</span> { <a name="l00125"></a>00125 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc" title="The number of values per result of the output.">binCount</a> = <a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a> / 2 + 1; <a name="l00126"></a>00126 } <a name="l00127"></a>00127 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31" title="True if the results in each output bin fall within a fixed numeric range (minimum and maximum values)...">hasKnownExtents</a> = <span class="keyword">false</span>; <a name="l00128"></a>00128 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4" title="True if the output values are quantized to a particular resolution.">isQuantized</a> = <span class="keyword">false</span>; <a name="l00129"></a>00129 d.<a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d" title="Positioning in time of the output results.">sampleType</a> = <a class="code" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca" title="Results from each process() align with that call's block start.">OutputDescriptor::OneSamplePerStep</a>; <a name="l00130"></a>00130 list.push_back(d); <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="keywordflow">return</span> list; <a name="l00133"></a>00133 } <a name="l00134"></a>00134 <a name="l00135"></a>00135 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PowerSpectrum::FeatureSet</a> <a name="l00136"></a><a class="code" href="classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f">00136</a> <a class="code" href="classPowerSpectrum.html#aa5664ffc2b37a16db471fae791c1f55f" title="Process a single block of input data.">PowerSpectrum::process</a>(<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...">Vamp::RealTime</a> timestamp) <a name="l00137"></a>00137 { <a name="l00138"></a>00138 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> fs; <a name="l00139"></a>00139 <a name="l00140"></a>00140 <span class="keywordflow">if</span> (<a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a> == 0) { <a name="l00141"></a>00141 cerr << <span class="stringliteral">"ERROR: PowerSpectrum::process: Not initialised"</span> << endl; <a name="l00142"></a>00142 <span class="keywordflow">return</span> fs; <a name="l00143"></a>00143 } <a name="l00144"></a>00144 <a name="l00145"></a>00145 <span class="keywordtype">size_t</span> n = <a class="code" href="classPowerSpectrum.html#a399e997c033f26b07edb7cc83cd5a6d8">m_blockSize</a> / 2 + 1; <a name="l00146"></a>00146 <span class="keyword">const</span> <span class="keywordtype">float</span> *fbuf = inputBuffers[0]; <a name="l00147"></a>00147 <a name="l00148"></a>00148 <a class="code" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> feature; <a name="l00149"></a>00149 feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b" title="True if an output feature has its own timestamp.">hasTimestamp</a> = <span class="keyword">false</span>; <a name="l00150"></a>00150 feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>.reserve(n); <span class="comment">// optional</span> <a name="l00151"></a>00151 <a name="l00152"></a>00152 <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < n; ++i) { <a name="l00153"></a>00153 <a name="l00154"></a>00154 <span class="keywordtype">double</span> real = fbuf[i * 2]; <a name="l00155"></a>00155 <span class="keywordtype">double</span> imag = fbuf[i * 2 + 1]; <a name="l00156"></a>00156 <a name="l00157"></a>00157 feature.<a class="code" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71" title="Results for a single sample of this feature.">values</a>.push_back(real * real + imag * imag); <a name="l00158"></a>00158 } <a name="l00159"></a>00159 <a name="l00160"></a>00160 fs[0].push_back(feature); <a name="l00161"></a>00161 <a name="l00162"></a>00162 <span class="keywordflow">return</span> fs; <a name="l00163"></a>00163 } <a name="l00164"></a>00164 <a name="l00165"></a>00165 <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">PowerSpectrum::FeatureSet</a> <a name="l00166"></a><a class="code" href="classPowerSpectrum.html#ac8a9661a785d38f4c5ce8ca2d53e69f9">00166</a> <a class="code" href="classPowerSpectrum.html#ac8a9661a785d38f4c5ce8ca2d53e69f9" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">PowerSpectrum::getRemainingFeatures</a>() <a name="l00167"></a>00167 { <a name="l00168"></a>00168 <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>(); <a name="l00169"></a>00169 } <a name="l00170"></a>00170 </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="PowerSpectrum_8cpp.html">PowerSpectrum.cpp</a> </li> <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> </ul> </div> </body> </html>