Mercurial > hg > btrack

<!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=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 - A Real-Time Beat Tracker</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>
<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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">BTrack - A Real-Time Beat Tracker
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<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><div class="header">
  <div class="headertitle"><div class="title"><a class="el" href="class_b_track.html">BTrack</a> - A Real-Time Beat Tracker </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>A real-time beat tracker, implemented in C++.</p>
<p>Written by Adam Stark, Matthew Davies and Mark Plumbley.</p>
<h2><a class="anchor" id="autotoc_md0"></a>
License</h2>
<p><a class="el" href="class_b_track.html">BTrack</a> is made available under the GNU General Public License, version 3. Please see the included LICENSE.txt for more details.</p>
<h2><a class="anchor" id="autotoc_md1"></a>
Usage - C++</h2>
<p><b>STEP 1</b></p>
<p>Include the <a class="el" href="class_b_track.html">BTrack</a> header file as follows: </p><pre class="fragment">    #include "BTrack.h"
</pre><p> <b>STEP 2</b></p>
<p>Instantiate the algorithm by one of the following:</p>
<pre class="fragment">// to use the default 512 hop size and 1024 frame size
BTrack b;
</pre><p> or: </p><pre class="fragment">// to specify a hop size (e.g. 512) and have a frame size of 2 x the hop size
BTrack b(512);
</pre><p> or: </p><pre class="fragment">// to specify both the hop size and frame size
BTrack b(512,1024);
</pre><p> <b>STEP 3.1 - Audio Input</b></p>
<p>In the processing loop, fill a double precision array with one frame of audio samples (as determined in step 2): </p><pre class="fragment">double *frame;

// !
// do something here to fill the frame with audio samples
// !
</pre><p> and then call: </p><pre class="fragment">b.processAudioFrame(frame);
</pre><p> and to check for beats, simply call: </p><pre class="fragment">if (b.beatDueInCurrentFrame())
{
    // do something on the beat
}
</pre><p> <b>STEP 3.2 - Onset Detection Function Input</b> <br  />
</p>
<p>The algorithm can process onset detection function samples. Given a double precision onset detection function sample called 'newSamples', at each step, call: </p><pre class="fragment">b.processOnsetDetectionFunctionSample(newSample);
</pre><p> and then check for beats with: </p><pre class="fragment">if (b.beatDueInCurrentFrame())
{
    // do something on the beat
}
</pre><p> For any questions, please email Adam Stark (email at <a href="http://www.adamstark.co.uk">http://www.adamstark.co.uk</a>). </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>
author	Adam Stark <adamstark.uk@gmail.com>
date	Fri, 18 Aug 2023 20:07:33 +0200
parents	d6d9df2db3e1
children