ref: ab2f66165913c6ea18e105ce5da7431fb21a2fbd
dir: /docs/leaf/group__tpitchdetector.html/
<!-- HTML header for doxygen 1.8.18--> <!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"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" /> <meta http-equiv="X-UA-Compatible" content="IE=9" /> <meta name="generator" content="Doxygen 1.8.16" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>LEAF: tPitchDetector</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> <script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script> <!-- <script src="/js/template.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> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function() { init_search(); }); /* @license-end */ </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> <!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> --> </head> <body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()"> <div> <!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr> </tr> </tbody> </table> </div> <!-- end header part --> </div> </body> </html><!-- Generated by Doxygen 1.8.16 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </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="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</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><!-- 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"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">tPitchDetector<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Pitch detection algorithm from Joel de Guzman's Q Audio DSP Library. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga99e55d649e58523aa706c711082585f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#ga99e55d649e58523aa706c711082585f6">tPitchDetector_init</a> (tPitchDetector *const detector, float lowestFreq, float highestFreq, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr> <tr class="memdesc:ga99e55d649e58523aa706c711082585f6"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPitchDetector to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. <a href="group__tpitchdetector.html#ga99e55d649e58523aa706c711082585f6">More...</a><br /></td></tr> <tr class="separator:ga99e55d649e58523aa706c711082585f6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaaa325f08c7c80ecace14fcd7f934d211"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#gaaa325f08c7c80ecace14fcd7f934d211">tPitchDetector_initToPool</a> (tPitchDetector *const detector, float lowestFreq, float highestFreq, tMempool *const mempool)</td></tr> <tr class="memdesc:gaaa325f08c7c80ecace14fcd7f934d211"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPitchDetector to a specified mempool. <a href="group__tpitchdetector.html#gaaa325f08c7c80ecace14fcd7f934d211">More...</a><br /></td></tr> <tr class="separator:gaaa325f08c7c80ecace14fcd7f934d211"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga21a8caf85569fa4366e83aa776831273"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#ga21a8caf85569fa4366e83aa776831273">tPitchDetector_free</a> (tPitchDetector *const detector)</td></tr> <tr class="memdesc:ga21a8caf85569fa4366e83aa776831273"><td class="mdescLeft"> </td><td class="mdescRight">Free a tPitchDetector from its mempool. <a href="group__tpitchdetector.html#ga21a8caf85569fa4366e83aa776831273">More...</a><br /></td></tr> <tr class="separator:ga21a8caf85569fa4366e83aa776831273"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7ff9d62bb716a57fce8ffeb5558c4890"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#ga7ff9d62bb716a57fce8ffeb5558c4890">tPitchDetector_tick</a> (tPitchDetector *const detector, float sample)</td></tr> <tr class="separator:ga7ff9d62bb716a57fce8ffeb5558c4890"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5b4f011cdb1812ab29022e4851e81c7e"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#ga5b4f011cdb1812ab29022e4851e81c7e">tPitchDetector_getFrequency</a> (tPitchDetector *const detector)</td></tr> <tr class="separator:ga5b4f011cdb1812ab29022e4851e81c7e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad99b1eb3569ac87a54a31ddc7ec78eea"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#gad99b1eb3569ac87a54a31ddc7ec78eea">tPitchDetector_getPeriodicity</a> (tPitchDetector *const detector)</td></tr> <tr class="separator:gad99b1eb3569ac87a54a31ddc7ec78eea"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae830c20dc77369d3055f23cd0fc51435"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#gae830c20dc77369d3055f23cd0fc51435">tPitchDetector_harmonic</a> (tPitchDetector *const detector, int harmonicIndex)</td></tr> <tr class="separator:gae830c20dc77369d3055f23cd0fc51435"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab29d82d5391480c9310b9c5074576966"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#gab29d82d5391480c9310b9c5074576966">tPitchDetector_predictFrequency</a> (tPitchDetector *const detector)</td></tr> <tr class="separator:gab29d82d5391480c9310b9c5074576966"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga65ead0c2f0f3f30b2e64f5a6aa50d6f9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tpitchdetector.html#ga65ead0c2f0f3f30b2e64f5a6aa50d6f9">tPitchDetector_setHysteresis</a> (tPitchDetector *const detector, float hysteresis)</td></tr> <tr class="memdesc:ga65ead0c2f0f3f30b2e64f5a6aa50d6f9"><td class="mdescLeft"> </td><td class="mdescRight">Set the hysteresis used in zero crossing detection. <a href="group__tpitchdetector.html#ga65ead0c2f0f3f30b2e64f5a6aa50d6f9">More...</a><br /></td></tr> <tr class="separator:ga65ead0c2f0f3f30b2e64f5a6aa50d6f9"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Pitch detection algorithm from Joel de Guzman's Q Audio DSP Library. </p> <h2 class="groupheader">Function Documentation</h2> <a id="ga99e55d649e58523aa706c711082585f6"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga99e55d649e58523aa706c711082585f6">◆ </a></span>tPitchDetector_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPitchDetector_init </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>lowestFreq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>highestFreq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const </td> <td class="paramname"><em>leaf</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a tPitchDetector to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> <tr><td class="paramname">lowestFreq</td><td></td></tr> <tr><td class="paramname">highestFreq</td><td></td></tr> <tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr> </table> </dd> </dl> </div> </div> <a id="gaaa325f08c7c80ecace14fcd7f934d211"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaaa325f08c7c80ecace14fcd7f934d211">◆ </a></span>tPitchDetector_initToPool()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPitchDetector_initToPool </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>lowestFreq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>highestFreq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">tMempool *const </td> <td class="paramname"><em>mempool</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize a tPitchDetector to a specified mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> <tr><td class="paramname">lowestFreq</td><td></td></tr> <tr><td class="paramname">highestFreq</td><td></td></tr> <tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga21a8caf85569fa4366e83aa776831273"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga21a8caf85569fa4366e83aa776831273">◆ </a></span>tPitchDetector_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPitchDetector_free </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a tPitchDetector from its mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga7ff9d62bb716a57fce8ffeb5558c4890"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7ff9d62bb716a57fce8ffeb5558c4890">◆ </a></span>tPitchDetector_tick()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int tPitchDetector_tick </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>sample</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> <tr><td class="paramname">input</td><td></td></tr> </table> </dd> </dl> </div> </div> <a id="ga5b4f011cdb1812ab29022e4851e81c7e"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5b4f011cdb1812ab29022e4851e81c7e">◆ </a></span>tPitchDetector_getFrequency()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPitchDetector_getFrequency </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> </table> </dd> </dl> </div> </div> <a id="gad99b1eb3569ac87a54a31ddc7ec78eea"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad99b1eb3569ac87a54a31ddc7ec78eea">◆ </a></span>tPitchDetector_getPeriodicity()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPitchDetector_getPeriodicity </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> </table> </dd> </dl> </div> </div> <a id="gae830c20dc77369d3055f23cd0fc51435"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae830c20dc77369d3055f23cd0fc51435">◆ </a></span>tPitchDetector_harmonic()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPitchDetector_harmonic </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>harmonicIndex</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> <tr><td class="paramname">harmonicIndex</td><td></td></tr> </table> </dd> </dl> </div> </div> <a id="gab29d82d5391480c9310b9c5074576966"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab29d82d5391480c9310b9c5074576966">◆ </a></span>tPitchDetector_predictFrequency()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tPitchDetector_predictFrequency </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga65ead0c2f0f3f30b2e64f5a6aa50d6f9"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga65ead0c2f0f3f30b2e64f5a6aa50d6f9">◆ </a></span>tPitchDetector_setHysteresis()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tPitchDetector_setHysteresis </td> <td>(</td> <td class="paramtype">tPitchDetector *const </td> <td class="paramname"><em>detector</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>hysteresis</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the hysteresis used in zero crossing detection. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">detector</td><td>A pointer to the relevant tPitchDetector. </td></tr> <tr><td class="paramname">hysteresis</td><td>The hysteresis in decibels. Defaults to -40db.  </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.18--> <!-- start footer part --> </body> </html>