Mercurial > hg > btrack
diff doc/html/class_b_track.html @ 117:ca2d83d29814 tip master
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 |
line wrap: on
line diff
--- a/doc/html/class_b_track.html Sat Jun 18 10:50:06 2016 +0100 +++ b/doc/html/class_b_track.html Fri Aug 18 20:07:33 2023 +0200 @@ -1,17 +1,17 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta http-equiv="X-UA-Compatible" content="IE=11"/> +<meta name="generator" content="Doxygen 1.9.7"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> <title>BTrack - A Real-Time Beat Tracker: BTrack Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -19,8 +19,8 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> + <tr id="projectrow"> + <td id="projectalign"> <div id="projectname">BTrack - A Real-Time Beat Tracker </div> </td> @@ -29,52 +29,42 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.2 --> +<!-- Generated by Doxygen 1.9.7 --> <script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search/",'.html'); +/* @license-end */ </script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li class="current"><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="classes.html"><span>Class Index</span></a></li> - <li><a href="functions.html"><span>Class Members</span></a></li> - </ul> - </div> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */ +</script> +<div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div> +</div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> +<div id="MSearchResults"> +<div class="SRPage"> +<div id="SRIndex"> +<div id="SRResults"></div> +<div class="SRStatus" id="Loading">Loading...</div> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +</div> +</div> +</div> </div> </div><!-- top --> @@ -83,23 +73,24 @@ <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="class_b_track-members.html">List of all members</a> </div> - <div class="headertitle"> -<div class="title">BTrack Class Reference</div> </div> + <div class="headertitle"><div class="title">BTrack Class Reference</div></div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="_b_track_8h_source.html">BTrack.h</a>></code></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a243ac408666ce0301fecd9b0a2a6f307"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a> ()</td></tr> <tr class="separator:a243ac408666ce0301fecd9b0a2a6f307"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ac4dbda7c90ce1a3080def2d5da875171"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac4dbda7c90ce1a3080def2d5da875171">BTrack</a> (int hopSize_)</td></tr> -<tr class="separator:ac4dbda7c90ce1a3080def2d5da875171"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afce9e207a2f6ff71d96125dee16797de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a> (int hopSize_, int frameSize_)</td></tr> -<tr class="separator:afce9e207a2f6ff71d96125dee16797de"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a70244e9a5aa8f860533fa56f942b7ede"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a70244e9a5aa8f860533fa56f942b7ede">updateHopAndFrameSize</a> (int hopSize_, int frameSize_)</td></tr> -<tr class="separator:a70244e9a5aa8f860533fa56f942b7ede"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8bc0e4933dcec6ced684d69d9c9e5014"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a8bc0e4933dcec6ced684d69d9c9e5014">BTrack</a> (int hopSize)</td></tr> +<tr class="separator:a8bc0e4933dcec6ced684d69d9c9e5014"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7196e2dcb729c1bd6e09a9494a6be1f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a7196e2dcb729c1bd6e09a9494a6be1f4">BTrack</a> (int hopSize, int frameSize)</td></tr> +<tr class="separator:a7196e2dcb729c1bd6e09a9494a6be1f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a386413d90e57d0a2cf7f18413338bbaf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a386413d90e57d0a2cf7f18413338bbaf">~BTrack</a> ()</td></tr> +<tr class="separator:a386413d90e57d0a2cf7f18413338bbaf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adda9c1b3a9e3fc02accfacc9d144e33d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#adda9c1b3a9e3fc02accfacc9d144e33d">updateHopAndFrameSize</a> (int hopSize, int frameSize)</td></tr> +<tr class="separator:adda9c1b3a9e3fc02accfacc9d144e33d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abb7ce7253095e6f859ef7b30f06ce051"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">processAudioFrame</a> (double *frame)</td></tr> <tr class="separator:abb7ce7253095e6f859ef7b30f06ce051"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6fab18732bef8c87152e93dec9e4f854"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">processOnsetDetectionFunctionSample</a> (double sample)</td></tr> @@ -119,17 +110,17 @@ <tr class="memitem:a22917ea231d2efd5670a764dd5a98983"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">doNotFixTempo</a> ()</td></tr> <tr class="separator:a22917ea231d2efd5670a764dd5a98983"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:aa66d0b9dfb4408e8cf84398f03b60a56"><td class="memItemLeft" align="right" valign="top">static double </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> <tr class="separator:aa66d0b9dfb4408e8cf84398f03b60a56"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1ebb4312fed8cf1de5353fef68c0fe74"><td class="memItemLeft" align="right" valign="top">static double </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> -<tr class="separator:a1ebb4312fed8cf1de5353fef68c0fe74"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <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> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a class="anchor" id="a243ac408666ce0301fecd9b0a2a6f307"></a> +<a id="a243ac408666ce0301fecd9b0a2a6f307" name="a243ac408666ce0301fecd9b0a2a6f307"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a243ac408666ce0301fecd9b0a2a6f307">◆ </a></span>BTrack() <span class="overload">[1/3]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -145,7 +136,9 @@ </div> </div> -<a class="anchor" id="ac4dbda7c90ce1a3080def2d5da875171"></a> +<a id="a8bc0e4933dcec6ced684d69d9c9e5014" name="a8bc0e4933dcec6ced684d69d9c9e5014"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8bc0e4933dcec6ced684d69d9c9e5014">◆ </a></span>BTrack() <span class="overload">[2/3]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -153,13 +146,12 @@ <td class="memname">BTrack::BTrack </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em></td><td>)</td> + <td class="paramname"><em>hopSize</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Constructor assuming frame size will be double the hopSize </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Constructor assuming frame size will be double the hopSize </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> </table> @@ -168,7 +160,9 @@ </div> </div> -<a class="anchor" id="afce9e207a2f6ff71d96125dee16797de"></a> +<a id="a7196e2dcb729c1bd6e09a9494a6be1f4" name="a7196e2dcb729c1bd6e09a9494a6be1f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7196e2dcb729c1bd6e09a9494a6be1f4">◆ </a></span>BTrack() <span class="overload">[3/3]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -176,13 +170,13 @@ <td class="memname">BTrack::BTrack </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em>, </td> + <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>frameSize_</em> </td> + <td class="paramname"><em>frameSize</em> </td> </tr> <tr> <td></td> @@ -191,8 +185,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Constructor taking both hopSize and frameSize </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Constructor taking both hopSize and frameSize </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> <tr><td class="paramname">frameSize</td><td>the frame size in audio samples </td></tr> @@ -202,8 +195,28 @@ </div> </div> +<a id="a386413d90e57d0a2cf7f18413338bbaf" name="a386413d90e57d0a2cf7f18413338bbaf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a386413d90e57d0a2cf7f18413338bbaf">◆ </a></span>~BTrack()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">BTrack::~BTrack </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Destructor </p> + +</div> +</div> <h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="ac92eaea0e42dd18c79de10bf852d7f4a"></a> +<a id="ac92eaea0e42dd18c79de10bf852d7f4a" name="ac92eaea0e42dd18c79de10bf852d7f4a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac92eaea0e42dd18c79de10bf852d7f4a">◆ </a></span>beatDueInCurrentFrame()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -219,7 +232,9 @@ </div> </div> -<a class="anchor" id="a22917ea231d2efd5670a764dd5a98983"></a> +<a id="a22917ea231d2efd5670a764dd5a98983" name="a22917ea231d2efd5670a764dd5a98983"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a22917ea231d2efd5670a764dd5a98983">◆ </a></span>doNotFixTempo()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -235,7 +250,9 @@ </div> </div> -<a class="anchor" id="a550829be9b4c58cd53195ec4900c7c71"></a> +<a id="a550829be9b4c58cd53195ec4900c7c71" name="a550829be9b4c58cd53195ec4900c7c71"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a550829be9b4c58cd53195ec4900c7c71">◆ </a></span>fixTempo()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -248,8 +265,7 @@ </tr> </table> </div><div class="memdoc"> -<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> +<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> <table class="params"> <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr> </table> @@ -258,7 +274,9 @@ </div> </div> -<a class="anchor" id="aa66d0b9dfb4408e8cf84398f03b60a56"></a> +<a id="aa66d0b9dfb4408e8cf84398f03b60a56" name="aa66d0b9dfb4408e8cf84398f03b60a56"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa66d0b9dfb4408e8cf84398f03b60a56">◆ </a></span>getBeatTimeInSeconds()</h2> + <div class="memitem"> <div class="memproto"> <table class="mlabels"> @@ -295,8 +313,7 @@ </tr> </table> </div><div class="memdoc"> -<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> +<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> <table class="params"> <tr><td class="paramname">frameNumber</td><td>the index of the current frame </td></tr> <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> @@ -308,57 +325,9 @@ </div> </div> -<a class="anchor" id="a1ebb4312fed8cf1de5353fef68c0fe74"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">double BTrack::getBeatTimeInSeconds </td> - <td>(</td> - <td class="paramtype">int </td> - <td class="paramname"><em>frameNumber</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>hopSize</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>fs</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">static</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> -<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> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">frameNumber</td><td>the index of the current frame </td></tr> - <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> - <tr><td class="paramname">fs</td><td>the sampling frequency in Hz </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>a beat time in seconds </dd></dl> +<a id="a17cea0a4dff3908660e4117e9a6c42bb" name="a17cea0a4dff3908660e4117e9a6c42bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a17cea0a4dff3908660e4117e9a6c42bb">◆ </a></span>getCurrentTempoEstimate()</h2> -</div> -</div> -<a class="anchor" id="a17cea0a4dff3908660e4117e9a6c42bb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -374,7 +343,9 @@ </div> </div> -<a class="anchor" id="ac06aa079977062bfa2930cdca45e69fb"></a> +<a id="ac06aa079977062bfa2930cdca45e69fb" name="ac06aa079977062bfa2930cdca45e69fb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac06aa079977062bfa2930cdca45e69fb">◆ </a></span>getHopSize()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -390,7 +361,9 @@ </div> </div> -<a class="anchor" id="a7ccb5059d0f00e3217ea686e4c1e156d"></a> +<a id="a7ccb5059d0f00e3217ea686e4c1e156d" name="a7ccb5059d0f00e3217ea686e4c1e156d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7ccb5059d0f00e3217ea686e4c1e156d">◆ </a></span>getLatestCumulativeScoreValue()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -406,7 +379,9 @@ </div> </div> -<a class="anchor" id="abb7ce7253095e6f859ef7b30f06ce051"></a> +<a id="abb7ce7253095e6f859ef7b30f06ce051" name="abb7ce7253095e6f859ef7b30f06ce051"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abb7ce7253095e6f859ef7b30f06ce051">◆ </a></span>processAudioFrame()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -419,8 +394,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Process a single audio frame </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Process a single audio frame </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <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> </table> @@ -429,7 +403,9 @@ </div> </div> -<a class="anchor" id="a6fab18732bef8c87152e93dec9e4f854"></a> +<a id="a6fab18732bef8c87152e93dec9e4f854" name="a6fab18732bef8c87152e93dec9e4f854"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6fab18732bef8c87152e93dec9e4f854">◆ </a></span>processOnsetDetectionFunctionSample()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -442,8 +418,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Add new onset detection function sample to buffer and apply beat tracking </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Add new onset detection function sample to buffer and apply beat tracking </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">sample</td><td>an onset detection function sample </td></tr> </table> @@ -452,7 +427,9 @@ </div> </div> -<a class="anchor" id="a96cf4088e40dff66ce15ada1f671a186"></a> +<a id="a96cf4088e40dff66ce15ada1f671a186" name="a96cf4088e40dff66ce15ada1f671a186"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a96cf4088e40dff66ce15ada1f671a186">◆ </a></span>setTempo()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -465,8 +442,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Set the tempo of the beat tracker </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Set the tempo of the beat tracker </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr> </table> @@ -475,7 +451,9 @@ </div> </div> -<a class="anchor" id="a70244e9a5aa8f860533fa56f942b7ede"></a> +<a id="adda9c1b3a9e3fc02accfacc9d144e33d" name="adda9c1b3a9e3fc02accfacc9d144e33d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adda9c1b3a9e3fc02accfacc9d144e33d">◆ </a></span>updateHopAndFrameSize()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -483,13 +461,13 @@ <td class="memname">void BTrack::updateHopAndFrameSize </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em>, </td> + <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>frameSize_</em> </td> + <td class="paramname"><em>frameSize</em> </td> </tr> <tr> <td></td> @@ -498,8 +476,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Updates the hop and frame size used by the beat tracker </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Updates the hop and frame size used by the beat tracker </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> <tr><td class="paramname">frameSize</td><td>the frame size in audio samples </td></tr> @@ -516,9 +493,7 @@ </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Tue Jan 28 2014 01:06:53 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.2 +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7 </small></address> </body> </html>