Mercurial > hg > btrack

comparison doc/html/class_b_track.html @ 114:d6d9df2db3e1

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