Mercurial > hg > btrack
view doc/html/class_onset_detection_function.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: OnsetDetectionFunction 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="class_onset_detection_function-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">OnsetDetectionFunction Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.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:a7b4e4ab1b0be5f57682c52141eb959d6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a7b4e4ab1b0be5f57682c52141eb959d6">OnsetDetectionFunction</a> (int hopSize_, int frameSize_, int onsetDetectionFunctionType_, int windowType)</td></tr> <tr class="separator:a7b4e4ab1b0be5f57682c52141eb959d6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa01f8125c950f3def45154878107e503"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a> ()</td></tr> <tr class="separator:aa01f8125c950f3def45154878107e503"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a654ed22782f6dc62e8347df44c90fbeb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a654ed22782f6dc62e8347df44c90fbeb">initialise</a> (int hopSize_, int frameSize_, int onsetDetectionFunctionType_, int windowType)</td></tr> <tr class="separator:a654ed22782f6dc62e8347df44c90fbeb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a> (double *buffer)</td></tr> <tr class="separator:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a51fdab443155aaaa935956645e8f9131"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a> (int onsetDetectionFunctionType_)</td></tr> <tr class="separator:a51fdab443155aaaa935956645e8f9131"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A class for calculating onset detection functions. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a7b4e4ab1b0be5f57682c52141eb959d6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </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 class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>windowType</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor </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> <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr> <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aa01f8125c950f3def45154878107e503"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OnsetDetectionFunction::~OnsetDetectionFunction </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructor </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a7b8fffe6221d3bd4f6cac82c17db0e92"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double OnsetDetectionFunction::calculateOnsetDetectionFunctionSample </td> <td>(</td> <td class="paramtype">double * </td> <td class="paramname"><em>buffer</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Process input frame and calculate detection function sample </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">buffer</td><td>a pointer to an array containing the audio samples to be processed </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the onset detection function sample </dd></dl> </div> </div> <a class="anchor" id="a654ed22782f6dc62e8347df44c90fbeb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OnsetDetectionFunction::initialise </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 class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>windowType</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialisation Function </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> <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr> <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a51fdab443155aaaa935956645e8f9131"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OnsetDetectionFunction::setOnsetDetectionFunctionType </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>onsetDetectionFunctionType_</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the detection function type </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </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="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a></li> <li>src/<a class="el" href="_onset_detection_function_8cpp.html">OnsetDetectionFunction.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>