Mercurial > hg > btrack
comparison doc/html/class_b_track.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 |
comparison
equal
deleted
inserted
replaced
| 59:ba3fc238ccad | 60:bf256abf1dd4 |
|---|---|
| 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: BTrack Class Reference</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 Page</span></a></li> | |
| 39 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> | |
| 40 <li><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="annotated.html"><span>Class List</span></a></li> | |
| 62 <li><a href="classes.html"><span>Class Index</span></a></li> | |
| 63 <li><a href="functions.html"><span>Class Members</span></a></li> | |
| 64 </ul> | |
| 65 </div> | |
| 66 <!-- window showing the filter options --> | |
| 67 <div id="MSearchSelectWindow" | |
| 68 onmouseover="return searchBox.OnSearchSelectShow()" | |
| 69 onmouseout="return searchBox.OnSearchSelectHide()" | |
| 70 onkeydown="return searchBox.OnSearchSelectKey(event)"> | |
| 71 <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> | |
| 72 | |
| 73 <!-- iframe showing the search results (closed by default) --> | |
| 74 <div id="MSearchResultsWindow"> | |
| 75 <iframe src="javascript:void(0)" frameborder="0" | |
| 76 name="MSearchResults" id="MSearchResults"> | |
| 77 </iframe> | |
| 78 </div> | |
| 79 | |
| 80 </div><!-- top --> | |
| 81 <div class="header"> | |
| 82 <div class="summary"> | |
| 83 <a href="#pub-methods">Public Member Functions</a> | | |
| 84 <a href="#pub-static-methods">Static Public Member Functions</a> | | |
| 85 <a href="class_b_track-members.html">List of all members</a> </div> | |
| 86 <div class="headertitle"> | |
| 87 <div class="title">BTrack Class Reference</div> </div> | |
| 88 </div><!--header--> | |
| 89 <div class="contents"> | |
| 90 | |
| 91 <p><code>#include <<a class="el" href="_b_track_8h_source.html">BTrack.h</a>></code></p> | |
| 92 <table class="memberdecls"> | |
| 93 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> | |
| 94 Public Member Functions</h2></td></tr> | |
| 95 <tr class="memitem:a243ac408666ce0301fecd9b0a2a6f307"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a> ()</td></tr> | |
| 96 <tr class="separator:a243ac408666ce0301fecd9b0a2a6f307"><td class="memSeparator" colspan="2"> </td></tr> | |
| 97 <tr class="memitem:ac4dbda7c90ce1a3080def2d5da875171"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac4dbda7c90ce1a3080def2d5da875171">BTrack</a> (int hopSize_)</td></tr> | |
| 98 <tr class="separator:ac4dbda7c90ce1a3080def2d5da875171"><td class="memSeparator" colspan="2"> </td></tr> | |
| 99 <tr class="memitem:afce9e207a2f6ff71d96125dee16797de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a> (int hopSize_, int frameSize_)</td></tr> | |
| 100 <tr class="separator:afce9e207a2f6ff71d96125dee16797de"><td class="memSeparator" colspan="2"> </td></tr> | |
| 101 <tr class="memitem:abb7ce7253095e6f859ef7b30f06ce051"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">processAudioFrame</a> (double *frame)</td></tr> | |
| 102 <tr class="separator:abb7ce7253095e6f859ef7b30f06ce051"><td class="memSeparator" colspan="2"> </td></tr> | |
| 103 <tr class="memitem:a6fab18732bef8c87152e93dec9e4f854"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">processOnsetDetectionFunctionSample</a> (double sample)</td></tr> | |
| 104 <tr class="separator:a6fab18732bef8c87152e93dec9e4f854"><td class="memSeparator" colspan="2"> </td></tr> | |
| 105 <tr class="memitem:ac06aa079977062bfa2930cdca45e69fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">getHopSize</a> ()</td></tr> | |
| 106 <tr class="separator:ac06aa079977062bfa2930cdca45e69fb"><td class="memSeparator" colspan="2"> </td></tr> | |
| 107 <tr class="memitem:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">beatDueInCurrentFrame</a> ()</td></tr> | |
| 108 <tr class="separator:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memSeparator" colspan="2"> </td></tr> | |
| 109 <tr class="memitem:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">getCurrentTempoEstimate</a> ()</td></tr> | |
| 110 <tr class="separator:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memSeparator" colspan="2"> </td></tr> | |
| 111 <tr class="memitem:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">getLatestCumulativeScoreValue</a> ()</td></tr> | |
| 112 <tr class="separator:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memSeparator" colspan="2"> </td></tr> | |
| 113 <tr class="memitem:a96cf4088e40dff66ce15ada1f671a186"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">setTempo</a> (double tempo)</td></tr> | |
| 114 <tr class="separator:a96cf4088e40dff66ce15ada1f671a186"><td class="memSeparator" colspan="2"> </td></tr> | |
| 115 <tr class="memitem:a550829be9b4c58cd53195ec4900c7c71"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">fixTempo</a> (double tempo)</td></tr> | |
| 116 <tr class="separator:a550829be9b4c58cd53195ec4900c7c71"><td class="memSeparator" colspan="2"> </td></tr> | |
| 117 <tr class="memitem:a22917ea231d2efd5670a764dd5a98983"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">doNotFixTempo</a> ()</td></tr> | |
| 118 <tr class="separator:a22917ea231d2efd5670a764dd5a98983"><td class="memSeparator" colspan="2"> </td></tr> | |
| 119 </table><table class="memberdecls"> | |
| 120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> | |
| 121 Static Public Member Functions</h2></td></tr> | |
| 122 <tr class="memitem:aa66d0b9dfb4408e8cf84398f03b60a56"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">getBeatTimeInSeconds</a> (long frameNumber, int hopSize, int fs)</td></tr> | |
| 123 <tr class="separator:aa66d0b9dfb4408e8cf84398f03b60a56"><td class="memSeparator" colspan="2"> </td></tr> | |
| 124 <tr class="memitem:a1ebb4312fed8cf1de5353fef68c0fe74"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a1ebb4312fed8cf1de5353fef68c0fe74">getBeatTimeInSeconds</a> (int frameNumber, int hopSize, int fs)</td></tr> | |
| 125 <tr class="separator:a1ebb4312fed8cf1de5353fef68c0fe74"><td class="memSeparator" colspan="2"> </td></tr> | |
| 126 </table> | |
| 127 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | |
| 128 <div class="textblock"><p>The main beat tracking class and the interface to the <a class="el" href="class_b_track.html">BTrack</a> beat tracking algorithm. The algorithm can process either audio frames or onset detection function samples and also contains some static functions for calculating beat times in seconds </p> | |
| 129 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> | |
| 130 <a class="anchor" id="a243ac408666ce0301fecd9b0a2a6f307"></a> | |
| 131 <div class="memitem"> | |
| 132 <div class="memproto"> | |
| 133 <table class="memname"> | |
| 134 <tr> | |
| 135 <td class="memname">BTrack::BTrack </td> | |
| 136 <td>(</td> | |
| 137 <td class="paramname"></td><td>)</td> | |
| 138 <td></td> | |
| 139 </tr> | |
| 140 </table> | |
| 141 </div><div class="memdoc"> | |
| 142 <p>constructor assuming hop size of 512 and frame size of 1024 </p> | |
| 143 | |
| 144 </div> | |
| 145 </div> | |
| 146 <a class="anchor" id="ac4dbda7c90ce1a3080def2d5da875171"></a> | |
| 147 <div class="memitem"> | |
| 148 <div class="memproto"> | |
| 149 <table class="memname"> | |
| 150 <tr> | |
| 151 <td class="memname">BTrack::BTrack </td> | |
| 152 <td>(</td> | |
| 153 <td class="paramtype">int </td> | |
| 154 <td class="paramname"><em>hopSize_</em></td><td>)</td> | |
| 155 <td></td> | |
| 156 </tr> | |
| 157 </table> | |
| 158 </div><div class="memdoc"> | |
| 159 <p>constructor assuming frame size will be double the hopSize </p> | |
| 160 <dl class="params"><dt>Parameters</dt><dd> | |
| 161 <table class="params"> | |
| 162 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> | |
| 163 </table> | |
| 164 </dd> | |
| 165 </dl> | |
| 166 | |
| 167 </div> | |
| 168 </div> | |
| 169 <a class="anchor" id="afce9e207a2f6ff71d96125dee16797de"></a> | |
| 170 <div class="memitem"> | |
| 171 <div class="memproto"> | |
| 172 <table class="memname"> | |
| 173 <tr> | |
| 174 <td class="memname">BTrack::BTrack </td> | |
| 175 <td>(</td> | |
| 176 <td class="paramtype">int </td> | |
| 177 <td class="paramname"><em>hopSize_</em>, </td> | |
| 178 </tr> | |
| 179 <tr> | |
| 180 <td class="paramkey"></td> | |
| 181 <td></td> | |
| 182 <td class="paramtype">int </td> | |
| 183 <td class="paramname"><em>frameSize_</em> </td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td></td> | |
| 187 <td>)</td> | |
| 188 <td></td><td></td> | |
| 189 </tr> | |
| 190 </table> | |
| 191 </div><div class="memdoc"> | |
| 192 <p>constructor taking both hopSize and frameSize </p> | |
| 193 <dl class="params"><dt>Parameters</dt><dd> | |
| 194 <table class="params"> | |
| 195 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> | |
| 196 <tr><td class="paramname">frameSize</td><td>the frame size in audio samples </td></tr> | |
| 197 </table> | |
| 198 </dd> | |
| 199 </dl> | |
| 200 | |
| 201 </div> | |
| 202 </div> | |
| 203 <h2 class="groupheader">Member Function Documentation</h2> | |
| 204 <a class="anchor" id="ac92eaea0e42dd18c79de10bf852d7f4a"></a> | |
| 205 <div class="memitem"> | |
| 206 <div class="memproto"> | |
| 207 <table class="memname"> | |
| 208 <tr> | |
| 209 <td class="memname">bool BTrack::beatDueInCurrentFrame </td> | |
| 210 <td>(</td> | |
| 211 <td class="paramname"></td><td>)</td> | |
| 212 <td></td> | |
| 213 </tr> | |
| 214 </table> | |
| 215 </div><div class="memdoc"> | |
| 216 <dl class="section return"><dt>Returns</dt><dd>true if a beat should occur in the current audio frame </dd></dl> | |
| 217 | |
| 218 </div> | |
| 219 </div> | |
| 220 <a class="anchor" id="a22917ea231d2efd5670a764dd5a98983"></a> | |
| 221 <div class="memitem"> | |
| 222 <div class="memproto"> | |
| 223 <table class="memname"> | |
| 224 <tr> | |
| 225 <td class="memname">void BTrack::doNotFixTempo </td> | |
| 226 <td>(</td> | |
| 227 <td class="paramname"></td><td>)</td> | |
| 228 <td></td> | |
| 229 </tr> | |
| 230 </table> | |
| 231 </div><div class="memdoc"> | |
| 232 <p>tell the algorithm to not fix the tempo anymore </p> | |
| 233 | |
| 234 </div> | |
| 235 </div> | |
| 236 <a class="anchor" id="a550829be9b4c58cd53195ec4900c7c71"></a> | |
| 237 <div class="memitem"> | |
| 238 <div class="memproto"> | |
| 239 <table class="memname"> | |
| 240 <tr> | |
| 241 <td class="memname">void BTrack::fixTempo </td> | |
| 242 <td>(</td> | |
| 243 <td class="paramtype">double </td> | |
| 244 <td class="paramname"><em>tempo</em></td><td>)</td> | |
| 245 <td></td> | |
| 246 </tr> | |
| 247 </table> | |
| 248 </div><div class="memdoc"> | |
| 249 <p>fix tempo to roughly around some value, so that the algorithm will only try to track tempi around the given tempo </p> | |
| 250 <dl class="params"><dt>Parameters</dt><dd> | |
| 251 <table class="params"> | |
| 252 <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr> | |
| 253 </table> | |
| 254 </dd> | |
| 255 </dl> | |
| 256 | |
| 257 </div> | |
| 258 </div> | |
| 259 <a class="anchor" id="aa66d0b9dfb4408e8cf84398f03b60a56"></a> | |
| 260 <div class="memitem"> | |
| 261 <div class="memproto"> | |
| 262 <table class="mlabels"> | |
| 263 <tr> | |
| 264 <td class="mlabels-left"> | |
| 265 <table class="memname"> | |
| 266 <tr> | |
| 267 <td class="memname">double BTrack::getBeatTimeInSeconds </td> | |
| 268 <td>(</td> | |
| 269 <td class="paramtype">long </td> | |
| 270 <td class="paramname"><em>frameNumber</em>, </td> | |
| 271 </tr> | |
| 272 <tr> | |
| 273 <td class="paramkey"></td> | |
| 274 <td></td> | |
| 275 <td class="paramtype">int </td> | |
| 276 <td class="paramname"><em>hopSize</em>, </td> | |
| 277 </tr> | |
| 278 <tr> | |
| 279 <td class="paramkey"></td> | |
| 280 <td></td> | |
| 281 <td class="paramtype">int </td> | |
| 282 <td class="paramname"><em>fs</em> </td> | |
| 283 </tr> | |
| 284 <tr> | |
| 285 <td></td> | |
| 286 <td>)</td> | |
| 287 <td></td><td></td> | |
| 288 </tr> | |
| 289 </table> | |
| 290 </td> | |
| 291 <td class="mlabels-right"> | |
| 292 <span class="mlabels"><span class="mlabel">static</span></span> </td> | |
| 293 </tr> | |
| 294 </table> | |
| 295 </div><div class="memdoc"> | |
| 296 <p>calculates a beat time in seconds, given the frame number, hop size and sampling frequency. This version uses a long to represent the frame number </p> | |
| 297 <dl class="params"><dt>Parameters</dt><dd> | |
| 298 <table class="params"> | |
| 299 <tr><td class="paramname">frameNumber</td><td>the index of the current frame </td></tr> | |
| 300 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> | |
| 301 <tr><td class="paramname">fs</td><td>the sampling frequency in Hz </td></tr> | |
| 302 </table> | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <dl class="section return"><dt>Returns</dt><dd>a beat time in seconds </dd></dl> | |
| 306 | |
| 307 </div> | |
| 308 </div> | |
| 309 <a class="anchor" id="a1ebb4312fed8cf1de5353fef68c0fe74"></a> | |
| 310 <div class="memitem"> | |
| 311 <div class="memproto"> | |
| 312 <table class="mlabels"> | |
| 313 <tr> | |
| 314 <td class="mlabels-left"> | |
| 315 <table class="memname"> | |
| 316 <tr> | |
| 317 <td class="memname">double BTrack::getBeatTimeInSeconds </td> | |
| 318 <td>(</td> | |
| 319 <td class="paramtype">int </td> | |
| 320 <td class="paramname"><em>frameNumber</em>, </td> | |
| 321 </tr> | |
| 322 <tr> | |
| 323 <td class="paramkey"></td> | |
| 324 <td></td> | |
| 325 <td class="paramtype">int </td> | |
| 326 <td class="paramname"><em>hopSize</em>, </td> | |
| 327 </tr> | |
| 328 <tr> | |
| 329 <td class="paramkey"></td> | |
| 330 <td></td> | |
| 331 <td class="paramtype">int </td> | |
| 332 <td class="paramname"><em>fs</em> </td> | |
| 333 </tr> | |
| 334 <tr> | |
| 335 <td></td> | |
| 336 <td>)</td> | |
| 337 <td></td><td></td> | |
| 338 </tr> | |
| 339 </table> | |
| 340 </td> | |
| 341 <td class="mlabels-right"> | |
| 342 <span class="mlabels"><span class="mlabel">static</span></span> </td> | |
| 343 </tr> | |
| 344 </table> | |
| 345 </div><div class="memdoc"> | |
| 346 <p>calculates a beat time in seconds, given the frame number, hop size and sampling frequency. This version uses an int to represent the frame number </p> | |
| 347 <dl class="params"><dt>Parameters</dt><dd> | |
| 348 <table class="params"> | |
| 349 <tr><td class="paramname">frameNumber</td><td>the index of the current frame </td></tr> | |
| 350 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> | |
| 351 <tr><td class="paramname">fs</td><td>the sampling frequency in Hz </td></tr> | |
| 352 </table> | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <dl class="section return"><dt>Returns</dt><dd>a beat time in seconds </dd></dl> | |
| 356 | |
| 357 </div> | |
| 358 </div> | |
| 359 <a class="anchor" id="a17cea0a4dff3908660e4117e9a6c42bb"></a> | |
| 360 <div class="memitem"> | |
| 361 <div class="memproto"> | |
| 362 <table class="memname"> | |
| 363 <tr> | |
| 364 <td class="memname">double BTrack::getCurrentTempoEstimate </td> | |
| 365 <td>(</td> | |
| 366 <td class="paramname"></td><td>)</td> | |
| 367 <td></td> | |
| 368 </tr> | |
| 369 </table> | |
| 370 </div><div class="memdoc"> | |
| 371 <dl class="section return"><dt>Returns</dt><dd>the current tempo estimate being used by the beat tracker </dd></dl> | |
| 372 | |
| 373 </div> | |
| 374 </div> | |
| 375 <a class="anchor" id="ac06aa079977062bfa2930cdca45e69fb"></a> | |
| 376 <div class="memitem"> | |
| 377 <div class="memproto"> | |
| 378 <table class="memname"> | |
| 379 <tr> | |
| 380 <td class="memname">int BTrack::getHopSize </td> | |
| 381 <td>(</td> | |
| 382 <td class="paramname"></td><td>)</td> | |
| 383 <td></td> | |
| 384 </tr> | |
| 385 </table> | |
| 386 </div><div class="memdoc"> | |
| 387 <dl class="section return"><dt>Returns</dt><dd>the current hop size being used by the beat tracker </dd></dl> | |
| 388 | |
| 389 </div> | |
| 390 </div> | |
| 391 <a class="anchor" id="a7ccb5059d0f00e3217ea686e4c1e156d"></a> | |
| 392 <div class="memitem"> | |
| 393 <div class="memproto"> | |
| 394 <table class="memname"> | |
| 395 <tr> | |
| 396 <td class="memname">double BTrack::getLatestCumulativeScoreValue </td> | |
| 397 <td>(</td> | |
| 398 <td class="paramname"></td><td>)</td> | |
| 399 <td></td> | |
| 400 </tr> | |
| 401 </table> | |
| 402 </div><div class="memdoc"> | |
| 403 <dl class="section return"><dt>Returns</dt><dd>the most recent value of the cumulative score function </dd></dl> | |
| 404 | |
| 405 </div> | |
| 406 </div> | |
| 407 <a class="anchor" id="abb7ce7253095e6f859ef7b30f06ce051"></a> | |
| 408 <div class="memitem"> | |
| 409 <div class="memproto"> | |
| 410 <table class="memname"> | |
| 411 <tr> | |
| 412 <td class="memname">void BTrack::processAudioFrame </td> | |
| 413 <td>(</td> | |
| 414 <td class="paramtype">double * </td> | |
| 415 <td class="paramname"><em>frame</em></td><td>)</td> | |
| 416 <td></td> | |
| 417 </tr> | |
| 418 </table> | |
| 419 </div><div class="memdoc"> | |
| 420 <p>Process a single audio frame </p> | |
| 421 <dl class="params"><dt>Parameters</dt><dd> | |
| 422 <table class="params"> | |
| 423 <tr><td class="paramname">frame</td><td>a pointer to an array containing an audio frame. The number of samples should match the frame size that the algorithm was initialised with. </td></tr> | |
| 424 </table> | |
| 425 </dd> | |
| 426 </dl> | |
| 427 | |
| 428 </div> | |
| 429 </div> | |
| 430 <a class="anchor" id="a6fab18732bef8c87152e93dec9e4f854"></a> | |
| 431 <div class="memitem"> | |
| 432 <div class="memproto"> | |
| 433 <table class="memname"> | |
| 434 <tr> | |
| 435 <td class="memname">void BTrack::processOnsetDetectionFunctionSample </td> | |
| 436 <td>(</td> | |
| 437 <td class="paramtype">double </td> | |
| 438 <td class="paramname"><em>sample</em></td><td>)</td> | |
| 439 <td></td> | |
| 440 </tr> | |
| 441 </table> | |
| 442 </div><div class="memdoc"> | |
| 443 <p>Add new onset detection function sample to buffer and apply beat tracking </p> | |
| 444 <dl class="params"><dt>Parameters</dt><dd> | |
| 445 <table class="params"> | |
| 446 <tr><td class="paramname">sample</td><td>an onset detection function sample </td></tr> | |
| 447 </table> | |
| 448 </dd> | |
| 449 </dl> | |
| 450 | |
| 451 </div> | |
| 452 </div> | |
| 453 <a class="anchor" id="a96cf4088e40dff66ce15ada1f671a186"></a> | |
| 454 <div class="memitem"> | |
| 455 <div class="memproto"> | |
| 456 <table class="memname"> | |
| 457 <tr> | |
| 458 <td class="memname">void BTrack::setTempo </td> | |
| 459 <td>(</td> | |
| 460 <td class="paramtype">double </td> | |
| 461 <td class="paramname"><em>tempo</em></td><td>)</td> | |
| 462 <td></td> | |
| 463 </tr> | |
| 464 </table> | |
| 465 </div><div class="memdoc"> | |
| 466 <p>Set the tempo of the beat tracker </p> | |
| 467 <dl class="params"><dt>Parameters</dt><dd> | |
| 468 <table class="params"> | |
| 469 <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr> | |
| 470 </table> | |
| 471 </dd> | |
| 472 </dl> | |
| 473 | |
| 474 </div> | |
| 475 </div> | |
| 476 <hr/>The documentation for this class was generated from the following files:<ul> | |
| 477 <li>src/<a class="el" href="_b_track_8h_source.html">BTrack.h</a></li> | |
| 478 <li>src/<a class="el" href="_b_track_8cpp.html">BTrack.cpp</a></li> | |
| 479 </ul> | |
| 480 </div><!-- contents --> | |
| 481 <!-- start footer part --> | |
| 482 <hr class="footer"/><address class="footer"><small> | |
| 483 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"> | |
| 484 <img class="footer" src="doxygen.png" alt="doxygen"/> | |
| 485 </a> 1.8.2 | |
| 486 </small></address> | |
| 487 </body> | |
| 488 </html> |
