Mercurial > hg > btrack

annotate doc/html/class_b_track.html @ 60:bf256abf1dd4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
rev   line source
adamstark@60 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
adamstark@60 2 <html xmlns="http://www.w3.org/1999/xhtml">
adamstark@60 3 <head>
adamstark@60 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
adamstark@60 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
adamstark@60 6 <title>BTrack - A Real-Time Beat Tracker: BTrack Class Reference</title>
adamstark@60 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
adamstark@60 8 <script type="text/javascript" src="jquery.js"></script>
adamstark@60 9 <script type="text/javascript" src="dynsections.js"></script>
adamstark@60 10 <link href="search/search.css" rel="stylesheet" type="text/css"/>
adamstark@60 11 <script type="text/javascript" src="search/search.js"></script>
adamstark@60 12 <script type="text/javascript">
adamstark@60 13 $(document).ready(function() { searchBox.OnSelectItem(0); });
adamstark@60 14 </script>
adamstark@60 15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
adamstark@60 16 </head>
adamstark@60 17 <body>
adamstark@60 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
adamstark@60 19 <div id="titlearea">
adamstark@60 20 <table cellspacing="0" cellpadding="0">
adamstark@60 21 <tbody>
adamstark@60 22 <tr style="height: 56px;">
adamstark@60 23 <td style="padding-left: 0.5em;">
adamstark@60 24 <div id="projectname">BTrack - A Real-Time Beat Tracker
adamstark@60 25 </div>
adamstark@60 26 </td>
adamstark@60 27 </tr>
adamstark@60 28 </tbody>
adamstark@60 29 </table>
adamstark@60 30 </div>
adamstark@60 31 <!-- end header part -->
adamstark@60 32 <!-- Generated by Doxygen 1.8.2 -->
adamstark@60 33 <script type="text/javascript">
adamstark@60 34 var searchBox = new SearchBox("searchBox", "search",false,'Search');
adamstark@60 35 </script>
adamstark@60 36 <div id="navrow1" class="tabs">
adamstark@60 37 <ul class="tablist">
adamstark@60 38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
adamstark@60 39 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
adamstark@60 40 <li><a href="files.html"><span>Files</span></a></li>
adamstark@60 41 <li>
adamstark@60 42 <div id="MSearchBox" class="MSearchBoxInactive">
adamstark@60 43 <span class="left">
adamstark@60 44 <img id="MSearchSelect" src="search/mag_sel.png"
adamstark@60 45 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 46 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 47 alt=""/>
adamstark@60 48 <input type="text" id="MSearchField" value="Search" accesskey="S"
adamstark@60 49 onfocus="searchBox.OnSearchFieldFocus(true)"
adamstark@60 50 onblur="searchBox.OnSearchFieldFocus(false)"
adamstark@60 51 onkeyup="searchBox.OnSearchFieldChange(event)"/>
adamstark@60 52 </span><span class="right">
adamstark@60 53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
adamstark@60 54 </span>
adamstark@60 55 </div>
adamstark@60 56 </li>
adamstark@60 57 </ul>
adamstark@60 58 </div>
adamstark@60 59 <div id="navrow2" class="tabs2">
adamstark@60 60 <ul class="tablist">
adamstark@60 61 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
adamstark@60 62 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
adamstark@60 63 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
adamstark@60 64 </ul>
adamstark@60 65 </div>
adamstark@60 66 <!-- window showing the filter options -->
adamstark@60 67 <div id="MSearchSelectWindow"
adamstark@60 68 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 69 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 70 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@60 71 <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>
adamstark@60 72
adamstark@60 73 <!-- iframe showing the search results (closed by default) -->
adamstark@60 74 <div id="MSearchResultsWindow">
adamstark@60 75 <iframe src="javascript:void(0)" frameborder="0"
adamstark@60 76 name="MSearchResults" id="MSearchResults">
adamstark@60 77 </iframe>
adamstark@60 78 </div>
adamstark@60 79
adamstark@60 80 </div><!-- top -->
adamstark@60 81 <div class="header">
adamstark@60 82 <div class="summary">
adamstark@60 83 <a href="#pub-methods">Public Member Functions</a> &#124;
adamstark@60 84 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
adamstark@60 85 <a href="class_b_track-members.html">List of all members</a> </div>
adamstark@60 86 <div class="headertitle">
adamstark@60 87 <div class="title">BTrack Class Reference</div> </div>
adamstark@60 88 </div><!--header-->
adamstark@60 89 <div class="contents">
adamstark@60 90
adamstark@60 91 <p><code>#include &lt;<a class="el" href="_b_track_8h_source.html">BTrack.h</a>&gt;</code></p>
adamstark@60 92 <table class="memberdecls">
adamstark@60 93 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
adamstark@60 94 Public Member Functions</h2></td></tr>
adamstark@60 95 <tr class="memitem:a243ac408666ce0301fecd9b0a2a6f307"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a> ()</td></tr>
adamstark@60 96 <tr class="separator:a243ac408666ce0301fecd9b0a2a6f307"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 97 <tr class="memitem:ac4dbda7c90ce1a3080def2d5da875171"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac4dbda7c90ce1a3080def2d5da875171">BTrack</a> (int hopSize_)</td></tr>
adamstark@60 98 <tr class="separator:ac4dbda7c90ce1a3080def2d5da875171"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 99 <tr class="memitem:afce9e207a2f6ff71d96125dee16797de"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a> (int hopSize_, int frameSize_)</td></tr>
adamstark@60 100 <tr class="separator:afce9e207a2f6ff71d96125dee16797de"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 101 <tr class="memitem:abb7ce7253095e6f859ef7b30f06ce051"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">processAudioFrame</a> (double *frame)</td></tr>
adamstark@60 102 <tr class="separator:abb7ce7253095e6f859ef7b30f06ce051"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 103 <tr class="memitem:a6fab18732bef8c87152e93dec9e4f854"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">processOnsetDetectionFunctionSample</a> (double sample)</td></tr>
adamstark@60 104 <tr class="separator:a6fab18732bef8c87152e93dec9e4f854"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 105 <tr class="memitem:ac06aa079977062bfa2930cdca45e69fb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">getHopSize</a> ()</td></tr>
adamstark@60 106 <tr class="separator:ac06aa079977062bfa2930cdca45e69fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 107 <tr class="memitem:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">beatDueInCurrentFrame</a> ()</td></tr>
adamstark@60 108 <tr class="separator:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 109 <tr class="memitem:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">getCurrentTempoEstimate</a> ()</td></tr>
adamstark@60 110 <tr class="separator:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 111 <tr class="memitem:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">getLatestCumulativeScoreValue</a> ()</td></tr>
adamstark@60 112 <tr class="separator:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 113 <tr class="memitem:a96cf4088e40dff66ce15ada1f671a186"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">setTempo</a> (double tempo)</td></tr>
adamstark@60 114 <tr class="separator:a96cf4088e40dff66ce15ada1f671a186"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 115 <tr class="memitem:a550829be9b4c58cd53195ec4900c7c71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">fixTempo</a> (double tempo)</td></tr>
adamstark@60 116 <tr class="separator:a550829be9b4c58cd53195ec4900c7c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 117 <tr class="memitem:a22917ea231d2efd5670a764dd5a98983"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">doNotFixTempo</a> ()</td></tr>
adamstark@60 118 <tr class="separator:a22917ea231d2efd5670a764dd5a98983"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 119 </table><table class="memberdecls">
adamstark@60 120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
adamstark@60 121 Static Public Member Functions</h2></td></tr>
adamstark@60 122 <tr class="memitem:aa66d0b9dfb4408e8cf84398f03b60a56"><td class="memItemLeft" align="right" valign="top">static double&#160;</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>
adamstark@60 123 <tr class="separator:aa66d0b9dfb4408e8cf84398f03b60a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 124 <tr class="memitem:a1ebb4312fed8cf1de5353fef68c0fe74"><td class="memItemLeft" align="right" valign="top">static double&#160;</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>
adamstark@60 125 <tr class="separator:a1ebb4312fed8cf1de5353fef68c0fe74"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 126 </table>
adamstark@60 127 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
adamstark@60 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>
adamstark@60 129 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
adamstark@60 130 <a class="anchor" id="a243ac408666ce0301fecd9b0a2a6f307"></a>
adamstark@60 131 <div class="memitem">
adamstark@60 132 <div class="memproto">
adamstark@60 133 <table class="memname">
adamstark@60 134 <tr>
adamstark@60 135 <td class="memname">BTrack::BTrack </td>
adamstark@60 136 <td>(</td>
adamstark@60 137 <td class="paramname"></td><td>)</td>
adamstark@60 138 <td></td>
adamstark@60 139 </tr>
adamstark@60 140 </table>
adamstark@60 141 </div><div class="memdoc">
adamstark@60 142 <p>constructor assuming hop size of 512 and frame size of 1024 </p>
adamstark@60 143
adamstark@60 144 </div>
adamstark@60 145 </div>
adamstark@60 146 <a class="anchor" id="ac4dbda7c90ce1a3080def2d5da875171"></a>
adamstark@60 147 <div class="memitem">
adamstark@60 148 <div class="memproto">
adamstark@60 149 <table class="memname">
adamstark@60 150 <tr>
adamstark@60 151 <td class="memname">BTrack::BTrack </td>
adamstark@60 152 <td>(</td>
adamstark@60 153 <td class="paramtype">int&#160;</td>
adamstark@60 154 <td class="paramname"><em>hopSize_</em></td><td>)</td>
adamstark@60 155 <td></td>
adamstark@60 156 </tr>
adamstark@60 157 </table>
adamstark@60 158 </div><div class="memdoc">
adamstark@60 159 <p>constructor assuming frame size will be double the hopSize </p>
adamstark@60 160 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 161 <table class="params">
adamstark@60 162 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr>
adamstark@60 163 </table>
adamstark@60 164 </dd>
adamstark@60 165 </dl>
adamstark@60 166
adamstark@60 167 </div>
adamstark@60 168 </div>
adamstark@60 169 <a class="anchor" id="afce9e207a2f6ff71d96125dee16797de"></a>
adamstark@60 170 <div class="memitem">
adamstark@60 171 <div class="memproto">
adamstark@60 172 <table class="memname">
adamstark@60 173 <tr>
adamstark@60 174 <td class="memname">BTrack::BTrack </td>
adamstark@60 175 <td>(</td>
adamstark@60 176 <td class="paramtype">int&#160;</td>
adamstark@60 177 <td class="paramname"><em>hopSize_</em>, </td>
adamstark@60 178 </tr>
adamstark@60 179 <tr>
adamstark@60 180 <td class="paramkey"></td>
adamstark@60 181 <td></td>
adamstark@60 182 <td class="paramtype">int&#160;</td>
adamstark@60 183 <td class="paramname"><em>frameSize_</em>&#160;</td>
adamstark@60 184 </tr>
adamstark@60 185 <tr>
adamstark@60 186 <td></td>
adamstark@60 187 <td>)</td>
adamstark@60 188 <td></td><td></td>
adamstark@60 189 </tr>
adamstark@60 190 </table>
adamstark@60 191 </div><div class="memdoc">
adamstark@60 192 <p>constructor taking both hopSize and frameSize </p>
adamstark@60 193 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 194 <table class="params">
adamstark@60 195 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr>
adamstark@60 196 <tr><td class="paramname">frameSize</td><td>the frame size in audio samples </td></tr>
adamstark@60 197 </table>
adamstark@60 198 </dd>
adamstark@60 199 </dl>
adamstark@60 200
adamstark@60 201 </div>
adamstark@60 202 </div>
adamstark@60 203 <h2 class="groupheader">Member Function Documentation</h2>
adamstark@60 204 <a class="anchor" id="ac92eaea0e42dd18c79de10bf852d7f4a"></a>
adamstark@60 205 <div class="memitem">
adamstark@60 206 <div class="memproto">
adamstark@60 207 <table class="memname">
adamstark@60 208 <tr>
adamstark@60 209 <td class="memname">bool BTrack::beatDueInCurrentFrame </td>
adamstark@60 210 <td>(</td>
adamstark@60 211 <td class="paramname"></td><td>)</td>
adamstark@60 212 <td></td>
adamstark@60 213 </tr>
adamstark@60 214 </table>
adamstark@60 215 </div><div class="memdoc">
adamstark@60 216 <dl class="section return"><dt>Returns</dt><dd>true if a beat should occur in the current audio frame </dd></dl>
adamstark@60 217
adamstark@60 218 </div>
adamstark@60 219 </div>
adamstark@60 220 <a class="anchor" id="a22917ea231d2efd5670a764dd5a98983"></a>
adamstark@60 221 <div class="memitem">
adamstark@60 222 <div class="memproto">
adamstark@60 223 <table class="memname">
adamstark@60 224 <tr>
adamstark@60 225 <td class="memname">void BTrack::doNotFixTempo </td>
adamstark@60 226 <td>(</td>
adamstark@60 227 <td class="paramname"></td><td>)</td>
adamstark@60 228 <td></td>
adamstark@60 229 </tr>
adamstark@60 230 </table>
adamstark@60 231 </div><div class="memdoc">
adamstark@60 232 <p>tell the algorithm to not fix the tempo anymore </p>
adamstark@60 233
adamstark@60 234 </div>
adamstark@60 235 </div>
adamstark@60 236 <a class="anchor" id="a550829be9b4c58cd53195ec4900c7c71"></a>
adamstark@60 237 <div class="memitem">
adamstark@60 238 <div class="memproto">
adamstark@60 239 <table class="memname">
adamstark@60 240 <tr>
adamstark@60 241 <td class="memname">void BTrack::fixTempo </td>
adamstark@60 242 <td>(</td>
adamstark@60 243 <td class="paramtype">double&#160;</td>
adamstark@60 244 <td class="paramname"><em>tempo</em></td><td>)</td>
adamstark@60 245 <td></td>
adamstark@60 246 </tr>
adamstark@60 247 </table>
adamstark@60 248 </div><div class="memdoc">
adamstark@60 249 <p>fix tempo to roughly around some value, so that the algorithm will only try to track tempi around the given tempo </p>
adamstark@60 250 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 251 <table class="params">
adamstark@60 252 <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr>
adamstark@60 253 </table>
adamstark@60 254 </dd>
adamstark@60 255 </dl>
adamstark@60 256
adamstark@60 257 </div>
adamstark@60 258 </div>
adamstark@60 259 <a class="anchor" id="aa66d0b9dfb4408e8cf84398f03b60a56"></a>
adamstark@60 260 <div class="memitem">
adamstark@60 261 <div class="memproto">
adamstark@60 262 <table class="mlabels">
adamstark@60 263 <tr>
adamstark@60 264 <td class="mlabels-left">
adamstark@60 265 <table class="memname">
adamstark@60 266 <tr>
adamstark@60 267 <td class="memname">double BTrack::getBeatTimeInSeconds </td>
adamstark@60 268 <td>(</td>
adamstark@60 269 <td class="paramtype">long&#160;</td>
adamstark@60 270 <td class="paramname"><em>frameNumber</em>, </td>
adamstark@60 271 </tr>
adamstark@60 272 <tr>
adamstark@60 273 <td class="paramkey"></td>
adamstark@60 274 <td></td>
adamstark@60 275 <td class="paramtype">int&#160;</td>
adamstark@60 276 <td class="paramname"><em>hopSize</em>, </td>
adamstark@60 277 </tr>
adamstark@60 278 <tr>
adamstark@60 279 <td class="paramkey"></td>
adamstark@60 280 <td></td>
adamstark@60 281 <td class="paramtype">int&#160;</td>
adamstark@60 282 <td class="paramname"><em>fs</em>&#160;</td>
adamstark@60 283 </tr>
adamstark@60 284 <tr>
adamstark@60 285 <td></td>
adamstark@60 286 <td>)</td>
adamstark@60 287 <td></td><td></td>
adamstark@60 288 </tr>
adamstark@60 289 </table>
adamstark@60 290 </td>
adamstark@60 291 <td class="mlabels-right">
adamstark@60 292 <span class="mlabels"><span class="mlabel">static</span></span> </td>
adamstark@60 293 </tr>
adamstark@60 294 </table>
adamstark@60 295 </div><div class="memdoc">
adamstark@60 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>
adamstark@60 297 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 298 <table class="params">
adamstark@60 299 <tr><td class="paramname">frameNumber</td><td>the index of the current frame </td></tr>
adamstark@60 300 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr>
adamstark@60 301 <tr><td class="paramname">fs</td><td>the sampling frequency in Hz </td></tr>
adamstark@60 302 </table>
adamstark@60 303 </dd>
adamstark@60 304 </dl>
adamstark@60 305 <dl class="section return"><dt>Returns</dt><dd>a beat time in seconds </dd></dl>
adamstark@60 306
adamstark@60 307 </div>
adamstark@60 308 </div>
adamstark@60 309 <a class="anchor" id="a1ebb4312fed8cf1de5353fef68c0fe74"></a>
adamstark@60 310 <div class="memitem">
adamstark@60 311 <div class="memproto">
adamstark@60 312 <table class="mlabels">
adamstark@60 313 <tr>
adamstark@60 314 <td class="mlabels-left">
adamstark@60 315 <table class="memname">
adamstark@60 316 <tr>
adamstark@60 317 <td class="memname">double BTrack::getBeatTimeInSeconds </td>
adamstark@60 318 <td>(</td>
adamstark@60 319 <td class="paramtype">int&#160;</td>
adamstark@60 320 <td class="paramname"><em>frameNumber</em>, </td>
adamstark@60 321 </tr>
adamstark@60 322 <tr>
adamstark@60 323 <td class="paramkey"></td>
adamstark@60 324 <td></td>
adamstark@60 325 <td class="paramtype">int&#160;</td>
adamstark@60 326 <td class="paramname"><em>hopSize</em>, </td>
adamstark@60 327 </tr>
adamstark@60 328 <tr>
adamstark@60 329 <td class="paramkey"></td>
adamstark@60 330 <td></td>
adamstark@60 331 <td class="paramtype">int&#160;</td>
adamstark@60 332 <td class="paramname"><em>fs</em>&#160;</td>
adamstark@60 333 </tr>
adamstark@60 334 <tr>
adamstark@60 335 <td></td>
adamstark@60 336 <td>)</td>
adamstark@60 337 <td></td><td></td>
adamstark@60 338 </tr>
adamstark@60 339 </table>
adamstark@60 340 </td>
adamstark@60 341 <td class="mlabels-right">
adamstark@60 342 <span class="mlabels"><span class="mlabel">static</span></span> </td>
adamstark@60 343 </tr>
adamstark@60 344 </table>
adamstark@60 345 </div><div class="memdoc">
adamstark@60 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>
adamstark@60 347 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 348 <table class="params">
adamstark@60 349 <tr><td class="paramname">frameNumber</td><td>the index of the current frame </td></tr>
adamstark@60 350 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr>
adamstark@60 351 <tr><td class="paramname">fs</td><td>the sampling frequency in Hz </td></tr>
adamstark@60 352 </table>
adamstark@60 353 </dd>
adamstark@60 354 </dl>
adamstark@60 355 <dl class="section return"><dt>Returns</dt><dd>a beat time in seconds </dd></dl>
adamstark@60 356
adamstark@60 357 </div>
adamstark@60 358 </div>
adamstark@60 359 <a class="anchor" id="a17cea0a4dff3908660e4117e9a6c42bb"></a>
adamstark@60 360 <div class="memitem">
adamstark@60 361 <div class="memproto">
adamstark@60 362 <table class="memname">
adamstark@60 363 <tr>
adamstark@60 364 <td class="memname">double BTrack::getCurrentTempoEstimate </td>
adamstark@60 365 <td>(</td>
adamstark@60 366 <td class="paramname"></td><td>)</td>
adamstark@60 367 <td></td>
adamstark@60 368 </tr>
adamstark@60 369 </table>
adamstark@60 370 </div><div class="memdoc">
adamstark@60 371 <dl class="section return"><dt>Returns</dt><dd>the current tempo estimate being used by the beat tracker </dd></dl>
adamstark@60 372
adamstark@60 373 </div>
adamstark@60 374 </div>
adamstark@60 375 <a class="anchor" id="ac06aa079977062bfa2930cdca45e69fb"></a>
adamstark@60 376 <div class="memitem">
adamstark@60 377 <div class="memproto">
adamstark@60 378 <table class="memname">
adamstark@60 379 <tr>
adamstark@60 380 <td class="memname">int BTrack::getHopSize </td>
adamstark@60 381 <td>(</td>
adamstark@60 382 <td class="paramname"></td><td>)</td>
adamstark@60 383 <td></td>
adamstark@60 384 </tr>
adamstark@60 385 </table>
adamstark@60 386 </div><div class="memdoc">
adamstark@60 387 <dl class="section return"><dt>Returns</dt><dd>the current hop size being used by the beat tracker </dd></dl>
adamstark@60 388
adamstark@60 389 </div>
adamstark@60 390 </div>
adamstark@60 391 <a class="anchor" id="a7ccb5059d0f00e3217ea686e4c1e156d"></a>
adamstark@60 392 <div class="memitem">
adamstark@60 393 <div class="memproto">
adamstark@60 394 <table class="memname">
adamstark@60 395 <tr>
adamstark@60 396 <td class="memname">double BTrack::getLatestCumulativeScoreValue </td>
adamstark@60 397 <td>(</td>
adamstark@60 398 <td class="paramname"></td><td>)</td>
adamstark@60 399 <td></td>
adamstark@60 400 </tr>
adamstark@60 401 </table>
adamstark@60 402 </div><div class="memdoc">
adamstark@60 403 <dl class="section return"><dt>Returns</dt><dd>the most recent value of the cumulative score function </dd></dl>
adamstark@60 404
adamstark@60 405 </div>
adamstark@60 406 </div>
adamstark@60 407 <a class="anchor" id="abb7ce7253095e6f859ef7b30f06ce051"></a>
adamstark@60 408 <div class="memitem">
adamstark@60 409 <div class="memproto">
adamstark@60 410 <table class="memname">
adamstark@60 411 <tr>
adamstark@60 412 <td class="memname">void BTrack::processAudioFrame </td>
adamstark@60 413 <td>(</td>
adamstark@60 414 <td class="paramtype">double *&#160;</td>
adamstark@60 415 <td class="paramname"><em>frame</em></td><td>)</td>
adamstark@60 416 <td></td>
adamstark@60 417 </tr>
adamstark@60 418 </table>
adamstark@60 419 </div><div class="memdoc">
adamstark@60 420 <p>Process a single audio frame </p>
adamstark@60 421 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 422 <table class="params">
adamstark@60 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>
adamstark@60 424 </table>
adamstark@60 425 </dd>
adamstark@60 426 </dl>
adamstark@60 427
adamstark@60 428 </div>
adamstark@60 429 </div>
adamstark@60 430 <a class="anchor" id="a6fab18732bef8c87152e93dec9e4f854"></a>
adamstark@60 431 <div class="memitem">
adamstark@60 432 <div class="memproto">
adamstark@60 433 <table class="memname">
adamstark@60 434 <tr>
adamstark@60 435 <td class="memname">void BTrack::processOnsetDetectionFunctionSample </td>
adamstark@60 436 <td>(</td>
adamstark@60 437 <td class="paramtype">double&#160;</td>
adamstark@60 438 <td class="paramname"><em>sample</em></td><td>)</td>
adamstark@60 439 <td></td>
adamstark@60 440 </tr>
adamstark@60 441 </table>
adamstark@60 442 </div><div class="memdoc">
adamstark@60 443 <p>Add new onset detection function sample to buffer and apply beat tracking </p>
adamstark@60 444 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 445 <table class="params">
adamstark@60 446 <tr><td class="paramname">sample</td><td>an onset detection function sample </td></tr>
adamstark@60 447 </table>
adamstark@60 448 </dd>
adamstark@60 449 </dl>
adamstark@60 450
adamstark@60 451 </div>
adamstark@60 452 </div>
adamstark@60 453 <a class="anchor" id="a96cf4088e40dff66ce15ada1f671a186"></a>
adamstark@60 454 <div class="memitem">
adamstark@60 455 <div class="memproto">
adamstark@60 456 <table class="memname">
adamstark@60 457 <tr>
adamstark@60 458 <td class="memname">void BTrack::setTempo </td>
adamstark@60 459 <td>(</td>
adamstark@60 460 <td class="paramtype">double&#160;</td>
adamstark@60 461 <td class="paramname"><em>tempo</em></td><td>)</td>
adamstark@60 462 <td></td>
adamstark@60 463 </tr>
adamstark@60 464 </table>
adamstark@60 465 </div><div class="memdoc">
adamstark@60 466 <p>Set the tempo of the beat tracker </p>
adamstark@60 467 <dl class="params"><dt>Parameters</dt><dd>
adamstark@60 468 <table class="params">
adamstark@60 469 <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr>
adamstark@60 470 </table>
adamstark@60 471 </dd>
adamstark@60 472 </dl>
adamstark@60 473
adamstark@60 474 </div>
adamstark@60 475 </div>
adamstark@60 476 <hr/>The documentation for this class was generated from the following files:<ul>
adamstark@60 477 <li>src/<a class="el" href="_b_track_8h_source.html">BTrack.h</a></li>
adamstark@60 478 <li>src/<a class="el" href="_b_track_8cpp.html">BTrack.cpp</a></li>
adamstark@60 479 </ul>
adamstark@60 480 </div><!-- contents -->
adamstark@60 481 <!-- start footer part -->
adamstark@60 482 <hr class="footer"/><address class="footer"><small>
adamstark@60 483 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">
adamstark@60 484 <img class="footer" src="doxygen.png" alt="doxygen"/>
adamstark@60 485 </a> 1.8.2
adamstark@60 486 </small></address>
adamstark@60 487 </body>
adamstark@60 488 </html>