btrack: doc/html/index.html comparison

comparison doc/html/index.html @ 24:deb49a2590f3 develop

Updated README, commented more code, added a Vamp plug-in

author	Adam <adamstark.uk@gmail.com>
date	Mon, 27 Jan 2014 23:11:31 +0000
parents	92ee4ace9d46
children	7af87d3f2ce2

comparison

equal deleted inserted replaced

-:92ee4ace9d46
+:deb49a2590f3
 <!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: 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>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/search.js"></script>
 <!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a></div>
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</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 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 &#160;<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 &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.2
 </small></address>
 </body>
 </html>

Mercurial > hg > btrack

comparison doc/html/index.html @ 24:deb49a2590f3 develop