Mercurial > hg > btrack

annotate doc/html/class_b_track.html @ 24:deb49a2590f3 develop

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