Mercurial > hg > btrack
diff doc/html/_onset_detection_function_8h_source.html @ 23:92ee4ace9d46 develop
Did more commenting. Added documentation.
| author | Adam <adamstark.uk@gmail.com> |
|---|---|
| date | Sat, 25 Jan 2014 18:17:51 +0000 |
| parents | |
| children | deb49a2590f3 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/_onset_detection_function_8h_source.html Sat Jan 25 18:17:51 2014 +0000 @@ -0,0 +1,204 @@ +<!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"/> +<title>BTrack - A Real-Time Beat Tracker: src/OnsetDetectionFunction.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="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">BTrack - A Real-Time Beat Tracker + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.2 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</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> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </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> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">OnsetDetectionFunction.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_onset_detection_function_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">//=======================================================================</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span><span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef __ONSETDETECTIONFUNCTION_H</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define __ONSETDETECTIONFUNCTION_H</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "fftw3.h"</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b"> 29</a></span> <span class="comment"></span><span class="keyword">enum</span> <a class="code" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  EnergyEnvelope,</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  EnergyDifference,</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  SpectralDifference,</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  SpectralDifferenceHWR,</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  PhaseDeviation,</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  ComplexSpectralDifference,</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  ComplexSpectralDifferenceHWR,</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  HighFrequencyContent,</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  HighFrequencySpectralDifference,</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  HighFrequencySpectralDifferenceHWR</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509"> 45</a></span> <span class="comment"></span><span class="keyword">enum</span> <a class="code" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  RectangularWindow,</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  HanningWindow,</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  HammingWindow,</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  BlackmanWindow,</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  TukeyWindow</div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> };</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> +<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="class_onset_detection_function.html"> 54</a></span> <span class="keyword">class </span><a class="code" href="class_onset_detection_function.html">OnsetDetectionFunction</a></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="class_onset_detection_function.html#a7b4e4ab1b0be5f57682c52141eb959d6">OnsetDetectionFunction</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_,<span class="keywordtype">int</span> onsetDetectionFunctionType_,<span class="keywordtype">int</span> windowType);</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a>();</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a654ed22782f6dc62e8347df44c90fbeb">initialise</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_,<span class="keywordtype">int</span> onsetDetectionFunctionType_,<span class="keywordtype">int</span> windowType);</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">double</span> <a class="code" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> *buffer);</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a>(<span class="keywordtype">int</span> onsetDetectionFunctionType_);</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> performFFT();</div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span> <span class="keywordtype">double</span> energyEnvelope();</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">double</span> energyDifference();</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">double</span> spectralDifference();</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">double</span> spectralDifferenceHWR();</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">double</span> phaseDeviation();</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">double</span> complexSpectralDifference();</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">double</span> complexSpectralDifferenceHWR();</div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">double</span> highFrequencyContent();</div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">double</span> highFrequencySpectralDifference();</div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">double</span> highFrequencySpectralDifferenceHWR();</div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span> <span class="keywordtype">void</span> calculateRectangularWindow();</div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> calculateHanningWindow();</div> +<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div> +<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> calclulateHammingWindow();</div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> +<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> calculateBlackmanWindow();</div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span> calculateTukeyWindow();</div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> +<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"></span> <span class="keywordtype">double</span> princarg(<span class="keywordtype">double</span> phaseVal);</div> +<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">double</span> pi; </div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">int</span> frameSize; </div> +<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">int</span> hopSize; </div> +<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">int</span> onsetDetectionFunctionType; </div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  fftw_plan p; </div> +<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  fftw_complex *complexIn; </div> +<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  fftw_complex *complexOut; </div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">int</span> initialised; </div> +<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">double</span> *frame; </div> +<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">double</span> *window; </div> +<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">double</span> prevEnergySum; </div> +<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">double</span> *magSpec; </div> +<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">double</span> *prevMagSpec; </div> +<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">double</span> *phase; </div> +<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">double</span> *prevPhase; </div> +<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">double</span> *prevPhase2; </div> +<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> };</div> +<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> +<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div> +<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#endif</span></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Sat Jan 25 2014 18:11:17 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.2 +</small></address> +</body> +</html>