Mercurial > hg > vamp-docs
view code-docs/FFT_8h_source.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7
Update code docs to v2.7 SDK
| author | Chris Cannam |
|---|---|
| date | Fri, 24 Feb 2017 16:44:47 +0000 |
| parents | 5c2683745b33 |
| 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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>VampPluginSDK: FFT.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('FFT_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">FFT.h</div> </div> </div><!--header--> <div class="contents"> <a href="FFT_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Vamp</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> An API for audio analysis and feature extraction plugins.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Copyright 2006-2012 Chris Cannam and QMUL.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> Permission is hereby granted, free of charge, to any person</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> obtaining a copy of this software and associated documentation</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> files (the "Software"), to deal in the Software without</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> restriction, including without limitation the rights to use, copy,</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> The above copyright notice and this permission notice shall be</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> included in all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> Except as contained in this notice, the names of the Centre for</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> use or other dealings in this Software without prior written</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> authorization.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifndef _VAMP_FFT_H_</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define _VAMP_FFT_H_</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="plugguard_8h.html">plugguard.h</a>"</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(FFT.h)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespaceVamp.html"> 43</a></span> namespace <a class="code" href="namespaceVamp.html">Vamp</a> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classVamp_1_1FFT.html"> 59</a></span> <span class="keyword">class </span><a class="code" href="classVamp_1_1FFT.html">FFT</a></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> forward(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> *ri, <span class="keyword">const</span> <span class="keywordtype">double</span> *ii,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">double</span> *ro, <span class="keywordtype">double</span> *io);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> inverse(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> *ri, <span class="keyword">const</span> <span class="keywordtype">double</span> *ii,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">double</span> *ro, <span class="keywordtype">double</span> *io);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> };</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classVamp_1_1FFTComplex.html"> 109</a></span> <span class="keyword">class </span><a class="code" href="classVamp_1_1FFTComplex.html">FFTComplex</a></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="classVamp_1_1FFTComplex.html">FFTComplex</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  ~<a class="code" href="classVamp_1_1FFTComplex.html">FFTComplex</a>();</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span> forward(<span class="keyword">const</span> <span class="keywordtype">double</span> *ci, <span class="keywordtype">double</span> *co);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">void</span> inverse(<span class="keyword">const</span> <span class="keywordtype">double</span> *ci, <span class="keywordtype">double</span> *co);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classVamp_1_1FFTComplex.html#aa521eef4194d91d2c48d07ed5f6d7f5f"> 144</a></span>  <span class="keyword">class </span>D;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  D *<a class="code" href="classVamp_1_1FFTComplex.html#aa521eef4194d91d2c48d07ed5f6d7f5f">m_d</a>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> };</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="classVamp_1_1FFTReal.html"> 161</a></span> <span class="keyword">class </span><a class="code" href="classVamp_1_1FFTReal.html">FFTReal</a></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> {</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <a class="code" href="classVamp_1_1FFTReal.html">FFTReal</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> n);</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  ~<a class="code" href="classVamp_1_1FFTReal.html">FFTReal</a>();</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">void</span> forward(<span class="keyword">const</span> <span class="keywordtype">double</span> *ri, <span class="keywordtype">double</span> *co);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">void</span> inverse(<span class="keyword">const</span> <span class="keywordtype">double</span> *ci, <span class="keywordtype">double</span> *ro);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00195"></a><span class="lineno"><a class="line" href="classVamp_1_1FFTReal.html#a7161d0e61886644b362392fa7df03104"> 195</a></span>  <span class="keyword">class </span>D;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  D *<a class="code" href="classVamp_1_1FFTReal.html#a7161d0e61886644b362392fa7df03104">m_d</a>;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> };</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> }</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(<a class="code" href="classVamp_1_1FFT.html">FFT</a>.h)</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceVamp_html"><div class="ttname"><a href="namespaceVamp.html">Vamp</a></div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00043">FFT.h:43</a></div></div> <div class="ttc" id="classVamp_1_1FFTReal_html"><div class="ttname"><a href="classVamp_1_1FFTReal.html">Vamp::FFTReal</a></div><div class="ttdoc">A simple FFT implementation provided for convenience of plugin authors. </div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00161">FFT.h:161</a></div></div> <div class="ttc" id="classVamp_1_1FFTComplex_html"><div class="ttname"><a href="classVamp_1_1FFTComplex.html">Vamp::FFTComplex</a></div><div class="ttdoc">A simple FFT implementation provided for convenience of plugin authors. </div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00109">FFT.h:109</a></div></div> <div class="ttc" id="classVamp_1_1FFTReal_html_a7161d0e61886644b362392fa7df03104"><div class="ttname"><a href="classVamp_1_1FFTReal.html#a7161d0e61886644b362392fa7df03104">Vamp::FFTReal::m_d</a></div><div class="ttdeci">D * m_d</div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00195">FFT.h:195</a></div></div> <div class="ttc" id="plugguard_8h_html_a1a2724ea453971288d3218e4eab3072c"><div class="ttname"><a href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a></div><div class="ttdeci">#define _VAMP_SDK_PLUGSPACE_BEGIN(h)</div><div class="ttdef"><b>Definition:</b> <a href="plugguard_8h_source.html#l00079">plugguard.h:79</a></div></div> <div class="ttc" id="classVamp_1_1FFT_html"><div class="ttname"><a href="classVamp_1_1FFT.html">Vamp::FFT</a></div><div class="ttdoc">A simple FFT implementation provided for convenience of plugin authors. </div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00059">FFT.h:59</a></div></div> <div class="ttc" id="plugguard_8h_html_ac879bb1077ecc6132ea3581ef9033753"><div class="ttname"><a href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a></div><div class="ttdeci">#define _VAMP_SDK_PLUGSPACE_END(h)</div><div class="ttdef"><b>Definition:</b> <a href="plugguard_8h_source.html#l00080">plugguard.h:80</a></div></div> <div class="ttc" id="classVamp_1_1FFTComplex_html_aa521eef4194d91d2c48d07ed5f6d7f5f"><div class="ttname"><a href="classVamp_1_1FFTComplex.html#aa521eef4194d91d2c48d07ed5f6d7f5f">Vamp::FFTComplex::m_d</a></div><div class="ttdeci">D * m_d</div><div class="ttdef"><b>Definition:</b> <a href="FFT_8h_source.html#l00144">FFT.h:144</a></div></div> <div class="ttc" id="plugguard_8h_html"><div class="ttname"><a href="plugguard_8h.html">plugguard.h</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_8661d6ced9d80e9e8c7982a58cd73404.html">vamp-sdk</a></li><li class="navelem"><a class="el" href="FFT_8h.html">FFT.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>