Mercurial > hg > btrack

comparison doc/html/_b_track_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/BTrack.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">BTrack.h</div> </div>
87 </div><!--header-->
88 <div class="contents">
89 <a href="_b_track_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 __BTRACK_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 __BTRACK_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;<a class="code" href="_onset_detection_function_8h.html" title="A class for calculating onset detection functions.">OnsetDetectionFunction.h</a>&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="l00033"></a><span class="lineno"><a class="code" href="class_b_track.html"> 33</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="class_b_track.html">BTrack</a> {</div>
99 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
100 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
101 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
102 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">//=======================================================================</span></div>
103 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span> <a class="code" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a>();</div>
104 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
105 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a>(<span class="keywordtype">int</span> hopSize_);</div>
106 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
107 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_);</div>
108 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
109 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">//=======================================================================</span></div>
110 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">processAudioFrame</a>(<span class="keywordtype">double</span> *frame);</div>
111 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
112 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">processOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> sample);</div>
113 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
114 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">//=======================================================================</span></div>
115 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">getHopSize</a>();</div>
116 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
117 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">beatDueInCurrentFrame</a>();</div>
118 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
119 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">double</span> <a class="code" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">getCurrentTempoEstimate</a>();</div>
120 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
121 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">double</span> <a class="code" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">getLatestCumulativeScoreValue</a>();</div>
122 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
123 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">//=======================================================================</span></div>
124 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">setTempo</a>(<span class="keywordtype">double</span> tempo);</div>
125 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
126 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">fixTempo</a>(<span class="keywordtype">double</span> tempo);</div>
127 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
128 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">doNotFixTempo</a>();</div>
129 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
130 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">//=======================================================================</span></div>
131 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">getBeatTimeInSeconds</a>(<span class="keywordtype">long</span> frameNumber,<span class="keywordtype">int</span> hopSize,<span class="keywordtype">int</span> fs);</div>
132 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
133 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">getBeatTimeInSeconds</a>(<span class="keywordtype">int</span> frameNumber,<span class="keywordtype">int</span> hopSize,<span class="keywordtype">int</span> fs);</div>
134 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
135 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
136 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="keyword">private</span>:</div>
137 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; </div>
138 <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordtype">void</span> initialise(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_);</div>
139 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
140 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">void</span> setHopSize(<span class="keywordtype">int</span> hopSize_);</div>
141 <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
142 <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordtype">void</span> resampleOnsetDetectionFunction();</div>
143 <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
144 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">void</span> updateCumulativeScore(<span class="keywordtype">double</span> odfSample);</div>
145 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
146 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordtype">void</span> predictBeat();</div>
147 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; </div>
148 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">void</span> calculateTempo();</div>
149 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
150 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keywordtype">void</span> adaptiveThreshold(<span class="keywordtype">double</span> *x,<span class="keywordtype">int</span> N);</div>
151 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
152 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keywordtype">double</span> calculateMeanOfArray(<span class="keywordtype">double</span> *array,<span class="keywordtype">int</span> startIndex,<span class="keywordtype">int</span> endIndex);</div>
153 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; </div>
154 <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keywordtype">void</span> normaliseArray(<span class="keywordtype">double</span> *array,<span class="keywordtype">int</span> N);</div>
155 <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
156 <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordtype">void</span> calculateBalancedACF(<span class="keywordtype">double</span> *onsetDetectionFunction);</div>
157 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; </div>
158 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordtype">void</span> calculateOutputOfCombFilterBank();</div>
159 <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; </div>
160 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="comment">//=======================================================================</span></div>
161 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;</div>
162 <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <a class="code" href="class_onset_detection_function.html">OnsetDetectionFunction</a> odf;</div>
163 <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; </div>
164 <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="comment">//=======================================================================</span></div>
165 <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <span class="comment">// buffers</span></div>
166 <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keywordtype">double</span> *onsetDF; </div>
167 <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordtype">double</span> resampledOnsetDF[512]; </div>
168 <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keywordtype">double</span> *cumulativeScore; </div>
169 <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordtype">double</span> acf[512]; </div>
170 <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keywordtype">double</span> weightingVector[128]; </div>
171 <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="keywordtype">double</span> combFilterBankOutput[128]; </div>
172 <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <span class="keywordtype">double</span> tempoObservationVector[41]; </div>
173 <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keywordtype">double</span> delta[41]; </div>
174 <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordtype">double</span> prevDelta[41]; </div>
175 <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keywordtype">double</span> prevDeltaFixed[41]; </div>
176 <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordtype">double</span> tempoTransitionMatrix[41][41]; </div>
177 <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="comment">//=======================================================================</span></div>
178 <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="comment">// parameters</span></div>
179 <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; </div>
180 <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; </div>
181 <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keywordtype">double</span> tightness; </div>
182 <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keywordtype">double</span> alpha; </div>
183 <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keywordtype">double</span> beatPeriod; </div>
184 <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="keywordtype">double</span> tempo; </div>
185 <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="keywordtype">double</span> estimatedTempo; </div>
186 <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="keywordtype">double</span> latestCumulativeScoreValue; </div>
187 <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; <span class="keywordtype">double</span> tempoToLagFactor; </div>
188 <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; <span class="keywordtype">int</span> m0; </div>
189 <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; <span class="keywordtype">int</span> beatCounter; </div>
190 <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="keywordtype">int</span> hopSize; </div>
191 <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keywordtype">int</span> onsetDFBufferSize; </div>
192 <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <span class="keywordtype">bool</span> tempoFixed; </div>
193 <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <span class="keywordtype">bool</span> beatDueInFrame; </div>
194 <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;};</div>
195 <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;</div>
196 <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;<span class="preprocessor">#endif</span></div>
197 </div><!-- fragment --></div><!-- contents -->
198 <!-- start footer part -->
199 <hr class="footer"/><address class="footer"><small>
200 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">
201 <img class="footer" src="doxygen.png" alt="doxygen"/>
202 </a> 1.8.2
203 </small></address>
204 </body>
205 </html>