Mercurial > hg > btrack

comparison doc/html/class_b_track.html @ 36:5bd9ae503dcf master 1.0.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
flow: Merged <release> '1.0.0' to <master> ('master').
author Adam Stark <adamstark.uk@gmail.com>
date Tue, 08 Jul 2014 12:32:27 +0100
parents 687b8dd41934
children d6d9df2db3e1
comparison
equal deleted inserted replaced
13:0d29e68fa2ee 36:5bd9ae503dcf
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>BTrack - A Real-Time Beat Tracker: BTrack Class Reference</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javascript" src="jquery.js"></script>
9 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="search/search.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="search/search.js"></script>
12 <script type="text/javascript">
13 $(document).ready(function() { searchBox.OnSelectItem(0); });
14 </script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td style="padding-left: 0.5em;">
24 <div id="projectname">BTrack - A Real-Time Beat Tracker
25 </div>
26 </td>
27 </tr>
28 </tbody>
29 </table>
30 </div>
31 <!-- end header part -->
32 <!-- Generated by Doxygen 1.8.2 -->
33 <script type="text/javascript">
34 var searchBox = new SearchBox("searchBox", "search",false,'Search');
35 </script>
36 <div id="navrow1" class="tabs">
37 <ul class="tablist">
38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
39 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
40 <li><a href="files.html"><span>Files</span></a></li>
41 <li>
42 <div id="MSearchBox" class="MSearchBoxInactive">
43 <span class="left">
44 <img id="MSearchSelect" src="search/mag_sel.png"
45 onmouseover="return searchBox.OnSearchSelectShow()"
46 onmouseout="return searchBox.OnSearchSelectHide()"
47 alt=""/>
48 <input type="text" id="MSearchField" value="Search" accesskey="S"
49 onfocus="searchBox.OnSearchFieldFocus(true)"
50 onblur="searchBox.OnSearchFieldFocus(false)"
51 onkeyup="searchBox.OnSearchFieldChange(event)"/>
52 </span><span class="right">
53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
54 </span>
55 </div>
56 </li>
57 </ul>
58 </div>
59 <div id="navrow2" class="tabs2">
60 <ul class="tablist">
61 <li><a href="annotated.html"><span>Class&#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 -->
67 <div id="MSearchSelectWindow"
68 onmouseover="return searchBox.OnSearchSelectShow()"
69 onmouseout="return searchBox.OnSearchSelectHide()"
70 onkeydown="return searchBox.OnSearchSelectKey(event)">
71 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#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>
72
73 <!-- iframe showing the search results (closed by default) -->
74 <div id="MSearchResultsWindow">
75 <iframe src="javascript:void(0)" frameborder="0"
76 name="MSearchResults" id="MSearchResults">
77 </iframe>
78 </div>
79
80 </div><!-- top -->
81 <div class="header">
82 <div class="summary">
83 <a href="#pub-methods">Public Member Functions</a> &#124;
84 <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>
86 <div class="headertitle">
87 <div class="title">BTrack Class Reference</div> </div>
88 </div><!--header-->
89 <div class="contents">
90
91 <p><code>#include &lt;<a class="el" href="_b_track_8h_source.html">BTrack.h</a>&gt;</code></p>
92 <table class="memberdecls">
93 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
94 Public Member Functions</h2></td></tr>
95 <tr class="memitem:a243ac408666ce0301fecd9b0a2a6f307"><td class="memItemLeft" align="right" valign="top">&#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>
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>
98 <tr class="separator:ac4dbda7c90ce1a3080def2d5da875171"><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>
100 <tr class="separator:afce9e207a2f6ff71d96125dee16797de"><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>
102 <tr class="separator:a70244e9a5aa8f860533fa56f942b7ede"><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>
104 <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>
106 <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>
108 <tr class="separator:ac06aa079977062bfa2930cdca45e69fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <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>
110 <tr class="separator:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <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>
112 <tr class="separator:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 <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>
114 <tr class="separator:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 <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>
116 <tr class="separator:a96cf4088e40dff66ce15ada1f671a186"><td class="memSeparator" colspan="2">&#160;</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>
118 <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>
120 <tr class="separator:a22917ea231d2efd5670a764dd5a98983"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 </table><table class="memberdecls">
122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
123 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>
125 <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>
129 <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>
131 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
132 <a class="anchor" id="a243ac408666ce0301fecd9b0a2a6f307"></a>
133 <div class="memitem">
134 <div class="memproto">
135 <table class="memname">
136 <tr>
137 <td class="memname">BTrack::BTrack </td>
138 <td>(</td>
139 <td class="paramname"></td><td>)</td>
140 <td></td>
141 </tr>
142 </table>
143 </div><div class="memdoc">
144 <p>Constructor assuming hop size of 512 and frame size of 1024 </p>
145
146 </div>
147 </div>
148 <a class="anchor" id="ac4dbda7c90ce1a3080def2d5da875171"></a>
149 <div class="memitem">
150 <div class="memproto">
151 <table class="memname">
152 <tr>
153 <td class="memname">BTrack::BTrack </td>
154 <td>(</td>
155 <td class="paramtype">int&#160;</td>
156 <td class="paramname"><em>hopSize_</em></td><td>)</td>
157 <td></td>
158 </tr>
159 </table>
160 </div><div class="memdoc">
161 <p>Constructor assuming frame size will be double the hopSize </p>
162 <dl class="params"><dt>Parameters</dt><dd>
163 <table class="params">
164 <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr>
165 </table>
166 </dd>
167 </dl>
168
169 </div>
170 </div>
171 <a class="anchor" id="afce9e207a2f6ff71d96125dee16797de"></a>
172 <div class="memitem">
173 <div class="memproto">
174 <table class="memname">
175 <tr>
176 <td class="memname">BTrack::BTrack </td>
177 <td>(</td>
178 <td class="paramtype">int&#160;</td>
179 <td class="paramname"><em>hopSize_</em>, </td>
180 </tr>
181 <tr>
182 <td class="paramkey"></td>
183 <td></td>
184 <td class="paramtype">int&#160;</td>
185 <td class="paramname"><em>frameSize_</em>&#160;</td>
186 </tr>
187 <tr>
188 <td></td>
189 <td>)</td>
190 <td></td><td></td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194 <p>Constructor taking both hopSize and frameSize </p>
195 <dl class="params"><dt>Parameters</dt><dd>
196 <table class="params">
197 <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>
199 </table>
200 </dd>
201 </dl>
202
203 </div>
204 </div>
205 <h2 class="groupheader">Member Function Documentation</h2>
206 <a class="anchor" id="ac92eaea0e42dd18c79de10bf852d7f4a"></a>
207 <div class="memitem">
208 <div class="memproto">
209 <table class="memname">
210 <tr>
211 <td class="memname">bool BTrack::beatDueInCurrentFrame </td>
212 <td>(</td>
213 <td class="paramname"></td><td>)</td>
214 <td></td>
215 </tr>
216 </table>
217 </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>
219
220 </div>
221 </div>
222 <a class="anchor" id="a22917ea231d2efd5670a764dd5a98983"></a>
223 <div class="memitem">
224 <div class="memproto">
225 <table class="memname">
226 <tr>
227 <td class="memname">void BTrack::doNotFixTempo </td>
228 <td>(</td>
229 <td class="paramname"></td><td>)</td>
230 <td></td>
231 </tr>
232 </table>
233 </div><div class="memdoc">
234 <p>Tell the algorithm to not fix the tempo anymore </p>
235
236 </div>
237 </div>
238 <a class="anchor" id="a550829be9b4c58cd53195ec4900c7c71"></a>
239 <div class="memitem">
240 <div class="memproto">
241 <table class="memname">
242 <tr>
243 <td class="memname">void BTrack::fixTempo </td>
244 <td>(</td>
245 <td class="paramtype">double&#160;</td>
246 <td class="paramname"><em>tempo</em></td><td>)</td>
247 <td></td>
248 </tr>
249 </table>
250 </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>
252 <dl class="params"><dt>Parameters</dt><dd>
253 <table class="params">
254 <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr>
255 </table>
256 </dd>
257 </dl>
258
259 </div>
260 </div>
261 <a class="anchor" id="aa66d0b9dfb4408e8cf84398f03b60a56"></a>
262 <div class="memitem">
263 <div class="memproto">
264 <table class="mlabels">
265 <tr>
266 <td class="mlabels-left">
267 <table class="memname">
268 <tr>
269 <td class="memname">double BTrack::getBeatTimeInSeconds </td>
270 <td>(</td>
271 <td class="paramtype">long&#160;</td>
272 <td class="paramname"><em>frameNumber</em>, </td>
273 </tr>
274 <tr>
275 <td class="paramkey"></td>
276 <td></td>
277 <td class="paramtype">int&#160;</td>
278 <td class="paramname"><em>hopSize</em>, </td>
279 </tr>
280 <tr>
281 <td class="paramkey"></td>
282 <td></td>
283 <td class="paramtype">int&#160;</td>
284 <td class="paramname"><em>fs</em>&#160;</td>
285 </tr>
286 <tr>
287 <td></td>
288 <td>)</td>
289 <td></td><td></td>
290 </tr>
291 </table>
292 </td>
293 <td class="mlabels-right">
294 <span class="mlabels"><span class="mlabel">static</span></span> </td>
295 </tr>
296 </table>
297 </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>
299 <dl class="params"><dt>Parameters</dt><dd>
300 <table class="params">
301 <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>
303 <tr><td class="paramname">fs</td><td>the sampling frequency in Hz </td></tr>
304 </table>
305 </dd>
306 </dl>
307 <dl class="section return"><dt>Returns</dt><dd>a beat time in seconds </dd></dl>
308
309 </div>
310 </div>
311 <a class="anchor" id="a1ebb4312fed8cf1de5353fef68c0fe74"></a>
312 <div class="memitem">
313 <div class="memproto">
314 <table class="mlabels">
315 <tr>
316 <td class="mlabels-left">
317 <table class="memname">
318 <tr>
319 <td class="memname">double BTrack::getBeatTimeInSeconds </td>
320 <td>(</td>
321 <td class="paramtype">int&#160;</td>
322 <td class="paramname"><em>frameNumber</em>, </td>
323 </tr>
324 <tr>
325 <td class="paramkey"></td>
326 <td></td>
327 <td class="paramtype">int&#160;</td>
328 <td class="paramname"><em>hopSize</em>, </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>
336 <tr>
337 <td></td>
338 <td>)</td>
339 <td></td><td></td>
340 </tr>
341 </table>
342 </td>
343 <td class="mlabels-right">
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">
504 <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>
506 </table>
507 </dd>
508 </dl>
509
510 </div>
511 </div>
512 <hr/>The documentation for this class was generated from the following files:<ul>
513 <li>src/<a class="el" href="_b_track_8h_source.html">BTrack.h</a></li>
514 <li>src/<a class="el" href="_b_track_8cpp.html">BTrack.cpp</a></li>
515 </ul>
516 </div><!-- contents -->
517 <!-- start footer part -->
518 <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">
520 <img class="footer" src="doxygen.png" alt="doxygen"/>
521 </a> 1.8.2
522 </small></address>
523 </body>
524 </html>