Mercurial > hg > btrack

annotate doc/html/class_b_track.html @ 117:ca2d83d29814 tip master

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