Mercurial > hg > btrack
diff doc/html/_b_track_8h_source.html @ 60:bf256abf1dd4
Did more commenting. Added documentation.
| author | Adam Stark <adamstark@users.noreply.github.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/_b_track_8h_source.html Sat Jan 25 18:17:51 2014 +0000 @@ -0,0 +1,205 @@ +<!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/BTrack.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">BTrack.h</div> </div> +</div><!--header--> +<div class="contents"> +<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> <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 __BTRACK_H</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define __BTRACK_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 "<a class="code" href="_onset_detection_function_8h.html" title="A class for calculating onset detection functions.">OnsetDetectionFunction.h</a>"</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="l00033"></a><span class="lineno"><a class="code" href="class_b_track.html"> 33</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_b_track.html">BTrack</a> {</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</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="comment">//=======================================================================</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> <a class="code" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a>();</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a>(<span class="keywordtype">int</span> hopSize_);</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_);</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <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> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">processOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> sample);</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">getHopSize</a>();</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> <a class="code" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">beatDueInCurrentFrame</a>();</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">double</span> <a class="code" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">getCurrentTempoEstimate</a>();</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">double</span> <a class="code" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">getLatestCumulativeScoreValue</a>();</div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <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> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">fixTempo</a>(<span class="keywordtype">double</span> tempo);</div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> <a class="code" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">doNotFixTempo</a>();</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <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> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</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">int</span> frameNumber,<span class="keywordtype">int</span> hopSize,<span class="keywordtype">int</span> fs);</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>  </div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div> +<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span> initialise(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_);</div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> setHopSize(<span class="keywordtype">int</span> hopSize_);</div> +<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">void</span> resampleOnsetDetectionFunction();</div> +<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  </div> +<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">void</span> updateCumulativeScore(<span class="keywordtype">double</span> odfSample);</div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">void</span> predictBeat();</div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">void</span> calculateTempo();</div> +<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div> +<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">void</span> adaptiveThreshold(<span class="keywordtype">double</span> *x,<span class="keywordtype">int</span> N);</div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div> +<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <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> +<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">void</span> normaliseArray(<span class="keywordtype">double</span> *array,<span class="keywordtype">int</span> N);</div> +<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  </div> +<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">void</span> calculateBalancedACF(<span class="keywordtype">double</span> *onsetDetectionFunction);</div> +<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  </div> +<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">void</span> calculateOutputOfCombFilterBank();</div> +<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div> +<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div> +<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <a class="code" href="class_onset_detection_function.html">OnsetDetectionFunction</a> odf;</div> +<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  </div> +<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="comment">// buffers</span></div> +<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">double</span> *onsetDF; </div> +<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">double</span> resampledOnsetDF[512]; </div> +<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordtype">double</span> *cumulativeScore; </div> +<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">double</span> acf[512]; </div> +<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordtype">double</span> weightingVector[128]; </div> +<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordtype">double</span> combFilterBankOutput[128]; </div> +<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">double</span> tempoObservationVector[41]; </div> +<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">double</span> delta[41]; </div> +<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordtype">double</span> prevDelta[41]; </div> +<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">double</span> prevDeltaFixed[41]; </div> +<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordtype">double</span> tempoTransitionMatrix[41][41]; </div> +<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="comment">// parameters</span></div> +<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div> +<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div> +<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordtype">double</span> tightness; </div> +<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordtype">double</span> alpha; </div> +<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keywordtype">double</span> beatPeriod; </div> +<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordtype">double</span> tempo; </div> +<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">double</span> estimatedTempo; </div> +<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordtype">double</span> latestCumulativeScoreValue; </div> +<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordtype">double</span> tempoToLagFactor; </div> +<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordtype">int</span> m0; </div> +<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keywordtype">int</span> beatCounter; </div> +<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">int</span> hopSize; </div> +<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordtype">int</span> onsetDFBufferSize; </div> +<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordtype">bool</span> tempoFixed; </div> +<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordtype">bool</span> beatDueInFrame; </div> +<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> };</div> +<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div> +<div class="line"><a name="l00225"></a><span class="lineno"> 225</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>