Mercurial > hg > btrack
diff doc/html/index.html @ 61:ce806db4468b
Updated README, commented more code, added a Vamp plug-in
| author | Adam Stark <adamstark@users.noreply.github.com> |
|---|---|
| date | Mon, 27 Jan 2014 23:11:31 +0000 |
| parents | bf256abf1dd4 |
| children | 7af87d3f2ce2 |
line wrap: on
line diff
--- a/doc/html/index.html Sat Jan 25 18:17:51 2014 +0000 +++ b/doc/html/index.html Mon Jan 27 23:11:31 2014 +0000 @@ -3,7 +3,7 @@ <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: Main Page</title> +<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> @@ -62,7 +62,7 @@ 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></div> +<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"> @@ -73,13 +73,54 @@ <div class="header"> <div class="headertitle"> -<div class="title">BTrack - A Real-Time Beat Tracker Documentation</div> </div> +<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><!-- 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>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>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></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><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Sat Jan 25 2014 18:11:17 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> +Generated on Mon Jan 27 2014 22:01:21 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>