Mercurial > hg > btrack
view doc/html/class_b_track.html @ 28:7af87d3f2ce2 develop
Added a function to allow updates to the hop and frame size of the beat tracker
| author | Adam <adamstark.uk@gmail.com> |
|---|---|
| date | Tue, 28 Jan 2014 00:31:17 +0000 |
| parents | deb49a2590f3 |
| children | 687b8dd41934 |
line wrap: on
line source
<!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <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/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> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">BTrack - A Real-Time Beat Tracker </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.2 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </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> <!-- 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> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <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><!--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> 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: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> <tr class="separator:a6fab18732bef8c87152e93dec9e4f854"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac06aa079977062bfa2930cdca45e69fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">getHopSize</a> ()</td></tr> <tr class="separator:ac06aa079977062bfa2930cdca45e69fb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">beatDueInCurrentFrame</a> ()</td></tr> <tr class="separator:ac92eaea0e42dd18c79de10bf852d7f4a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">getCurrentTempoEstimate</a> ()</td></tr> <tr class="separator:a17cea0a4dff3908660e4117e9a6c42bb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">getLatestCumulativeScoreValue</a> ()</td></tr> <tr class="separator:a7ccb5059d0f00e3217ea686e4c1e156d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a96cf4088e40dff66ce15ada1f671a186"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">setTempo</a> (double tempo)</td></tr> <tr class="separator:a96cf4088e40dff66ce15ada1f671a186"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a550829be9b4c58cd53195ec4900c7c71"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">fixTempo</a> (double tempo)</td></tr> <tr class="separator:a550829be9b4c58cd53195ec4900c7c71"><td class="memSeparator" colspan="2"> </td></tr> <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> 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> <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>Constructor assuming hop size of 512 and frame size of 1024 </p> </div> </div> <a class="anchor" id="ac4dbda7c90ce1a3080def2d5da875171"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">BTrack::BTrack </td> <td>(</td> <td class="paramtype">int </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> <table class="params"> <tr><td class="paramname">hopSize</td><td>the hop size in audio samples </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="afce9e207a2f6ff71d96125dee16797de"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">BTrack::BTrack </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>frameSize_</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <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> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ac92eaea0e42dd18c79de10bf852d7f4a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool BTrack::beatDueInCurrentFrame </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="section return"><dt>Returns</dt><dd>true if a beat should occur in the current audio frame </dd></dl> </div> </div> <a class="anchor" id="a22917ea231d2efd5670a764dd5a98983"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BTrack::doNotFixTempo </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Tell the algorithm to not fix the tempo anymore </p> </div> </div> <a class="anchor" id="a550829be9b4c58cd53195ec4900c7c71"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BTrack::fixTempo </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>tempo</em></td><td>)</td> <td></td> </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> <table class="params"> <tr><td class="paramname">tempo</td><td>the tempo in beats per minute (bpm) </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aa66d0b9dfb4408e8cf84398f03b60a56"></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">long </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 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> <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> </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> </div> </div> <a class="anchor" id="a17cea0a4dff3908660e4117e9a6c42bb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double BTrack::getCurrentTempoEstimate </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="section return"><dt>Returns</dt><dd>the current tempo estimate being used by the beat tracker </dd></dl> </div> </div> <a class="anchor" id="ac06aa079977062bfa2930cdca45e69fb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int BTrack::getHopSize </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="section return"><dt>Returns</dt><dd>the current hop size being used by the beat tracker </dd></dl> </div> </div> <a class="anchor" id="a7ccb5059d0f00e3217ea686e4c1e156d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double BTrack::getLatestCumulativeScoreValue </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="section return"><dt>Returns</dt><dd>the most recent value of the cumulative score function </dd></dl> </div> </div> <a class="anchor" id="abb7ce7253095e6f859ef7b30f06ce051"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BTrack::processAudioFrame </td> <td>(</td> <td class="paramtype">double * </td> <td class="paramname"><em>frame</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <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> </dd> </dl> </div> </div> <a class="anchor" id="a6fab18732bef8c87152e93dec9e4f854"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BTrack::processOnsetDetectionFunctionSample </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>sample</em></td><td>)</td> <td></td> </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> <table class="params"> <tr><td class="paramname">sample</td><td>an onset detection function sample </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a96cf4088e40dff66ce15ada1f671a186"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BTrack::setTempo </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>tempo</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <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> </dd> </dl> </div> </div> <a class="anchor" id="a70244e9a5aa8f860533fa56f942b7ede"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void BTrack::updateHopAndFrameSize </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>frameSize_</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </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> <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> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>src/<a class="el" href="_b_track_8h_source.html">BTrack.h</a></li> <li>src/<a class="el" href="_b_track_8cpp.html">BTrack.cpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Tue Jan 28 2014 00:29:23 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 </small></address> </body> </html>