Mercurial > hg > btrack

comparison doc/html/_onset_detection_function_8h_source.html @ 23:92ee4ace9d46 develop

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Did more commenting. Added documentation.
author Adam <adamstark.uk@gmail.com>
date Sat, 25 Jan 2014 18:17:51 +0000
parents
children deb49a2590f3
comparison
equal deleted inserted replaced
22:a8e3e95d14e4 23:92ee4ace9d46
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>BTrack - A Real-Time Beat Tracker: src/OnsetDetectionFunction.h Source File</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javascript" src="jquery.js"></script>
9 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="search/search.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="search/search.js"></script>
12 <script type="text/javascript">
13 $(document).ready(function() { searchBox.OnSelectItem(0); });
14 </script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td style="padding-left: 0.5em;">
24 <div id="projectname">BTrack - A Real-Time Beat Tracker
25 </div>
26 </td>
27 </tr>
28 </tbody>
29 </table>
30 </div>
31 <!-- end header part -->
32 <!-- Generated by Doxygen 1.8.2 -->
33 <script type="text/javascript">
34 var searchBox = new SearchBox("searchBox", "search",false,'Search');
35 </script>
36 <div id="navrow1" class="tabs">
37 <ul class="tablist">
38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
39 <li><a href="annotated.html"><span>Classes</span></a></li>
40 <li class="current"><a href="files.html"><span>Files</span></a></li>
41 <li>
42 <div id="MSearchBox" class="MSearchBoxInactive">
43 <span class="left">
44 <img id="MSearchSelect" src="search/mag_sel.png"
45 onmouseover="return searchBox.OnSearchSelectShow()"
46 onmouseout="return searchBox.OnSearchSelectHide()"
47 alt=""/>
48 <input type="text" id="MSearchField" value="Search" accesskey="S"
49 onfocus="searchBox.OnSearchFieldFocus(true)"
50 onblur="searchBox.OnSearchFieldFocus(false)"
51 onkeyup="searchBox.OnSearchFieldChange(event)"/>
52 </span><span class="right">
53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
54 </span>
55 </div>
56 </li>
57 </ul>
58 </div>
59 <div id="navrow2" class="tabs2">
60 <ul class="tablist">
61 <li><a href="files.html"><span>File&#160;List</span></a></li>
62 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
63 </ul>
64 </div>
65 <!-- window showing the filter options -->
66 <div id="MSearchSelectWindow"
67 onmouseover="return searchBox.OnSearchSelectShow()"
68 onmouseout="return searchBox.OnSearchSelectHide()"
69 onkeydown="return searchBox.OnSearchSelectKey(event)">
70 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a></div>
71
72 <!-- iframe showing the search results (closed by default) -->
73 <div id="MSearchResultsWindow">
74 <iframe src="javascript:void(0)" frameborder="0"
75 name="MSearchResults" id="MSearchResults">
76 </iframe>
77 </div>
78
79 <div id="nav-path" class="navpath">
80 <ul>
81 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
82 </div>
83 </div><!-- top -->
84 <div class="header">
85 <div class="headertitle">
86 <div class="title">OnsetDetectionFunction.h</div> </div>
87 </div><!--header-->
88 <div class="contents">
89 <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>&#160;<span class="comment">//=======================================================================</span></div>
90 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"></span><span class="comment">//=======================================================================</span></div>
91 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
92 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#ifndef __ONSETDETECTIONFUNCTION_H</span></div>
93 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __ONSETDETECTIONFUNCTION_H</span></div>
94 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"></span></div>
95 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;fftw3.h&quot;</span></div>
96 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
97 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">//=======================================================================</span></div>
98 <div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b"> 29</a></span>&#160;<span class="comment"></span><span class="keyword">enum</span> <a class="code" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></div>
99 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
100 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; EnergyEnvelope,</div>
101 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; EnergyDifference,</div>
102 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; SpectralDifference,</div>
103 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; SpectralDifferenceHWR,</div>
104 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; PhaseDeviation,</div>
105 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; ComplexSpectralDifference,</div>
106 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; ComplexSpectralDifferenceHWR,</div>
107 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; HighFrequencyContent,</div>
108 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; HighFrequencySpectralDifference,</div>
109 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; HighFrequencySpectralDifferenceHWR</div>
110 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;};</div>
111 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
112 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">//=======================================================================</span></div>
113 <div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509"> 45</a></span>&#160;<span class="comment"></span><span class="keyword">enum</span> <a class="code" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></div>
114 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{</div>
115 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; RectangularWindow,</div>
116 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; HanningWindow,</div>
117 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; HammingWindow,</div>
118 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; BlackmanWindow,</div>
119 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; TukeyWindow</div>
120 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;};</div>
121 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
122 <div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="class_onset_detection_function.html"> 54</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_onset_detection_function.html">OnsetDetectionFunction</a></div>
123 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</div>
124 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">public</span>:</div>
125 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
126 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <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>
127 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
128 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a>();</div>
129 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
130 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <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>
131 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
132 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">double</span> <a class="code" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> *buffer);</div>
133 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
134 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a>(<span class="keywordtype">int</span> onsetDetectionFunctionType_);</div>
135 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
136 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="keyword">private</span>:</div>
137 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
138 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">void</span> performFFT();</div>
139 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
140 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">//=======================================================================</span></div>
141 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> energyEnvelope();</div>
142 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
143 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">double</span> energyDifference();</div>
144 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
145 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordtype">double</span> spectralDifference();</div>
146 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
147 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">double</span> spectralDifferenceHWR();</div>
148 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
149 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordtype">double</span> phaseDeviation();</div>
150 <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
151 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordtype">double</span> complexSpectralDifference();</div>
152 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
153 <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">double</span> complexSpectralDifferenceHWR();</div>
154 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
155 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">double</span> highFrequencyContent();</div>
156 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
157 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">double</span> highFrequencySpectralDifference();</div>
158 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
159 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordtype">double</span> highFrequencySpectralDifferenceHWR();</div>
160 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
161 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="comment">//=======================================================================</span></div>
162 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> calculateRectangularWindow();</div>
163 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
164 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordtype">void</span> calculateHanningWindow();</div>
165 <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
166 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">void</span> calclulateHammingWindow();</div>
167 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div>
168 <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">void</span> calculateBlackmanWindow();</div>
169 <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; </div>
170 <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordtype">void</span> calculateTukeyWindow();</div>
171 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
172 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="comment">//=======================================================================</span></div>
173 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> princarg(<span class="keywordtype">double</span> phaseVal);</div>
174 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
175 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
176 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordtype">double</span> pi; </div>
177 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">int</span> frameSize; </div>
178 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordtype">int</span> hopSize; </div>
179 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">int</span> onsetDetectionFunctionType; </div>
180 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; fftw_plan p; </div>
181 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; fftw_complex *complexIn; </div>
182 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; fftw_complex *complexOut; </div>
183 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordtype">int</span> initialised; </div>
184 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordtype">double</span> *frame; </div>
185 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordtype">double</span> *window; </div>
186 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordtype">double</span> prevEnergySum; </div>
187 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keywordtype">double</span> *magSpec; </div>
188 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">double</span> *prevMagSpec; </div>
189 <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keywordtype">double</span> *phase; </div>
190 <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keywordtype">double</span> *prevPhase; </div>
191 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keywordtype">double</span> *prevPhase2; </div>
192 <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;};</div>
193 <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;</div>
194 <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;</div>
195 <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="preprocessor">#endif</span></div>
196 </div><!-- fragment --></div><!-- contents -->
197 <!-- start footer part -->
198 <hr class="footer"/><address class="footer"><small>
199 Generated on Sat Jan 25 2014 18:11:17 for BTrack - A Real-Time Beat Tracker by &#160;<a href="http://www.doxygen.org/index.html">
200 <img class="footer" src="doxygen.png" alt="doxygen"/>
201 </a> 1.8.2
202 </small></address>
203 </body>
204 </html>