Mercurial > hg > btrack

annotate doc/html/index.html @ 117:ca2d83d29814 tip master

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
rev   line source
adamstark@114 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
adamstark@114 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
adamstark@60 3 <head>
adamstark@60 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
adamstark@114 5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
adamstark@114 6 <meta name="generator" content="Doxygen 1.9.7"/>
adamstark@114 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
adamstark@61 8 <title>BTrack - A Real-Time Beat Tracker: BTrack - A Real-Time Beat Tracker</title>
adamstark@60 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
adamstark@60 10 <script type="text/javascript" src="jquery.js"></script>
adamstark@60 11 <script type="text/javascript" src="dynsections.js"></script>
adamstark@60 12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
adamstark@114 13 <script type="text/javascript" src="search/searchdata.js"></script>
adamstark@60 14 <script type="text/javascript" src="search/search.js"></script>
adamstark@60 15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
adamstark@60 16 </head>
adamstark@60 17 <body>
adamstark@60 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
adamstark@60 19 <div id="titlearea">
adamstark@60 20 <table cellspacing="0" cellpadding="0">
adamstark@60 21 <tbody>
adamstark@114 22 <tr id="projectrow">
adamstark@114 23 <td id="projectalign">
adamstark@60 24 <div id="projectname">BTrack - A Real-Time Beat Tracker
adamstark@60 25 </div>
adamstark@60 26 </td>
adamstark@60 27 </tr>
adamstark@60 28 </tbody>
adamstark@60 29 </table>
adamstark@60 30 </div>
adamstark@60 31 <!-- end header part -->
adamstark@114 32 <!-- Generated by Doxygen 1.9.7 -->
adamstark@60 33 <script type="text/javascript">
adamstark@114 34 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 35 var searchBox = new SearchBox("searchBox", "search/",'.html');
adamstark@114 36 /* @license-end */
adamstark@60 37 </script>
adamstark@114 38 <script type="text/javascript" src="menudata.js"></script>
adamstark@114 39 <script type="text/javascript" src="menu.js"></script>
adamstark@114 40 <script type="text/javascript">
adamstark@114 41 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 42 $(function() {
adamstark@114 43 initMenu('',true,false,'search.php','Search');
adamstark@114 44 $(document).ready(function() { init_search(); });
adamstark@114 45 });
adamstark@114 46 /* @license-end */
adamstark@114 47 </script>
adamstark@114 48 <div id="main-nav"></div>
adamstark@60 49 </div><!-- top -->
adamstark@60 50 <!-- window showing the filter options -->
adamstark@60 51 <div id="MSearchSelectWindow"
adamstark@60 52 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 53 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 54 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@114 55 </div>
adamstark@60 56
adamstark@60 57 <!-- iframe showing the search results (closed by default) -->
adamstark@60 58 <div id="MSearchResultsWindow">
adamstark@114 59 <div id="MSearchResults">
adamstark@114 60 <div class="SRPage">
adamstark@114 61 <div id="SRIndex">
adamstark@114 62 <div id="SRResults"></div>
adamstark@114 63 <div class="SRStatus" id="Loading">Loading...</div>
adamstark@114 64 <div class="SRStatus" id="Searching">Searching...</div>
adamstark@114 65 <div class="SRStatus" id="NoMatches">No Matches</div>
adamstark@114 66 </div>
adamstark@114 67 </div>
adamstark@114 68 </div>
adamstark@60 69 </div>
adamstark@60 70
adamstark@114 71 <div><div class="header">
adamstark@114 72 <div class="headertitle"><div class="title"><a class="el" href="class_b_track.html">BTrack</a> - A Real-Time Beat Tracker </div></div>
adamstark@60 73 </div><!--header-->
adamstark@60 74 <div class="contents">
adamstark@61 75 <div class="textblock"><p>A real-time beat tracker, implemented in C++.</p>
adamstark@61 76 <p>Written by Adam Stark, Matthew Davies and Mark Plumbley.</p>
adamstark@114 77 <h2><a class="anchor" id="autotoc_md0"></a>
adamstark@114 78 License</h2>
adamstark@61 79 <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>
adamstark@114 80 <h2><a class="anchor" id="autotoc_md1"></a>
adamstark@114 81 Usage - C++</h2>
adamstark@61 82 <p><b>STEP 1</b></p>
adamstark@114 83 <p>Include the <a class="el" href="class_b_track.html">BTrack</a> header file as follows: </p><pre class="fragment"> #include "BTrack.h"
adamstark@114 84 </pre><p> <b>STEP 2</b></p>
adamstark@114 85 <p>Instantiate the algorithm by one of the following:</p>
adamstark@61 86 <pre class="fragment">// to use the default 512 hop size and 1024 frame size
adamstark@61 87 BTrack b;
adamstark@114 88 </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
adamstark@61 89 BTrack b(512);
adamstark@114 90 </pre><p> or: </p><pre class="fragment">// to specify both the hop size and frame size
adamstark@61 91 BTrack b(512,1024);
adamstark@114 92 </pre><p> <b>STEP 3.1 - Audio Input</b></p>
adamstark@114 93 <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;
adamstark@61 94
adamstark@61 95 // !
adamstark@61 96 // do something here to fill the frame with audio samples
adamstark@61 97 // !
adamstark@114 98 </pre><p> and then call: </p><pre class="fragment">b.processAudioFrame(frame);
adamstark@114 99 </pre><p> and to check for beats, simply call: </p><pre class="fragment">if (b.beatDueInCurrentFrame())
adamstark@61 100 {
adamstark@61 101 // do something on the beat
adamstark@61 102 }
adamstark@114 103 </pre><p> <b>STEP 3.2 - Onset Detection Function Input</b> <br />
adamstark@114 104 </p>
adamstark@114 105 <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);
adamstark@114 106 </pre><p> and then check for beats with: </p><pre class="fragment">if (b.beatDueInCurrentFrame())
adamstark@61 107 {
adamstark@61 108 // do something on the beat
adamstark@61 109 }
adamstark@114 110 </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>
adamstark@114 111 </div></div><!-- PageDoc -->
adamstark@114 112 </div><!-- contents -->
adamstark@60 113 <!-- start footer part -->
adamstark@60 114 <hr class="footer"/><address class="footer"><small>
adamstark@114 115 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
adamstark@60 116 </small></address>
adamstark@60 117 </body>
adamstark@60 118 </html>