ref: 978a64fc4e52a85ef45f824d9d36e390c0a3a8e2
dir: /docs/leaf/group__tperioddetector.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: tPeriodDetector</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">tPeriodDetector<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Period 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:gaa0947f407eba0d205dfdb3f5221e8a68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#gaa0947f407eba0d205dfdb3f5221e8a68">tPeriodDetector_init</a> (tPeriodDetector *const detector, float lowestFreq, float highestFreq, float hysteresis, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:gaa0947f407eba0d205dfdb3f5221e8a68"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPeriodDetector 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__tperioddetector.html#gaa0947f407eba0d205dfdb3f5221e8a68">More...</a><br /></td></tr>
<tr class="separator:gaa0947f407eba0d205dfdb3f5221e8a68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga03431f353481718a4e573f4df4a0161f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga03431f353481718a4e573f4df4a0161f">tPeriodDetector_initToPool</a> (tPeriodDetector *const detector, float lowestFreq, float highestFreq, float hysteresis, tMempool *const mempool)</td></tr>
<tr class="memdesc:ga03431f353481718a4e573f4df4a0161f"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tPeriodDetector to a specified mempool. <a href="group__tperioddetector.html#ga03431f353481718a4e573f4df4a0161f">More...</a><br /></td></tr>
<tr class="separator:ga03431f353481718a4e573f4df4a0161f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga55e2ad80c68f2fbf0cafceee206abf3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga55e2ad80c68f2fbf0cafceee206abf3f">tPeriodDetector_free</a> (tPeriodDetector *const detector)</td></tr>
<tr class="memdesc:ga55e2ad80c68f2fbf0cafceee206abf3f"><td class="mdescLeft"> </td><td class="mdescRight">Free a tPeriodDetector from its mempool. <a href="group__tperioddetector.html#ga55e2ad80c68f2fbf0cafceee206abf3f">More...</a><br /></td></tr>
<tr class="separator:ga55e2ad80c68f2fbf0cafceee206abf3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaed4bf4a51580ba6209dfe5d35a235644"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#gaed4bf4a51580ba6209dfe5d35a235644">tPeriodDetector_tick</a> (tPeriodDetector *const detector, float sample)</td></tr>
<tr class="separator:gaed4bf4a51580ba6209dfe5d35a235644"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga025e1bc096ca88fc2f6e493513f0d6fb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga025e1bc096ca88fc2f6e493513f0d6fb">tPeriodDetector_getPeriod</a> (tPeriodDetector *const detector)</td></tr>
<tr class="memdesc:ga025e1bc096ca88fc2f6e493513f0d6fb"><td class="mdescLeft"> </td><td class="mdescRight">Get the periodicity for a given harmonic of the detected pitch. <a href="group__tperioddetector.html#ga025e1bc096ca88fc2f6e493513f0d6fb">More...</a><br /></td></tr>
<tr class="separator:ga025e1bc096ca88fc2f6e493513f0d6fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9e836c21a0dcabe9f3438bc56e671f39"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga9e836c21a0dcabe9f3438bc56e671f39">tPeriodDetector_getPeriodicity</a> (tPeriodDetector *const detector)</td></tr>
<tr class="separator:ga9e836c21a0dcabe9f3438bc56e671f39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a66a46a4a6bea562bae63640e6855a5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga4a66a46a4a6bea562bae63640e6855a5">tPeriodDetector_harmonic</a> (tPeriodDetector *const detector, int harmonicIndex)</td></tr>
<tr class="separator:ga4a66a46a4a6bea562bae63640e6855a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6bea587938466ba988a6e716446975ed"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga6bea587938466ba988a6e716446975ed">tPeriodDetector_predictPeriod</a> (tPeriodDetector *const detector)</td></tr>
<tr class="separator:ga6bea587938466ba988a6e716446975ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3d58e36fafa3e5b5102175e2c9062010"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga3d58e36fafa3e5b5102175e2c9062010">tPeriodDetector_isReady</a> (tPeriodDetector *const detector)</td></tr>
<tr class="separator:ga3d58e36fafa3e5b5102175e2c9062010"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad7d111b4c8dc6e7428ff2facdf90092a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#gad7d111b4c8dc6e7428ff2facdf90092a">tPeriodDetector_isReset</a> (tPeriodDetector *const detector)</td></tr>
<tr class="separator:gad7d111b4c8dc6e7428ff2facdf90092a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3157c7b7e210eafb0286aef6f1843f94"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tperioddetector.html#ga3157c7b7e210eafb0286aef6f1843f94">tPeriodDetector_setHysteresis</a> (tPeriodDetector *const detector, float hysteresis)</td></tr>
<tr class="memdesc:ga3157c7b7e210eafb0286aef6f1843f94"><td class="mdescLeft"> </td><td class="mdescRight">Set the hysteresis used in zero crossing detection. <a href="group__tperioddetector.html#ga3157c7b7e210eafb0286aef6f1843f94">More...</a><br /></td></tr>
<tr class="separator:ga3157c7b7e210eafb0286aef6f1843f94"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Period detection algorithm from Joel de Guzman's Q Audio DSP Library. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa0947f407eba0d205dfdb3f5221e8a68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa0947f407eba0d205dfdb3f5221e8a68">◆ </a></span>tPeriodDetector_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetector_init </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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">float </td>
<td class="paramname"><em>hysteresis</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 tPeriodDetector 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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga03431f353481718a4e573f4df4a0161f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03431f353481718a4e573f4df4a0161f">◆ </a></span>tPeriodDetector_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetector_initToPool </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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">float </td>
<td class="paramname"><em>hysteresis</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 tPeriodDetector to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga55e2ad80c68f2fbf0cafceee206abf3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga55e2ad80c68f2fbf0cafceee206abf3f">◆ </a></span>tPeriodDetector_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetector_free </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *const </td>
<td class="paramname"><em>detector</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tPeriodDetector 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 tPeriodDetector to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaed4bf4a51580ba6209dfe5d35a235644"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaed4bf4a51580ba6209dfe5d35a235644">◆ </a></span>tPeriodDetector_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tPeriodDetector_tick </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga025e1bc096ca88fc2f6e493513f0d6fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga025e1bc096ca88fc2f6e493513f0d6fb">◆ </a></span>tPeriodDetector_getPeriod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPeriodDetector_getPeriod </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *const </td>
<td class="paramname"><em>detector</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the periodicity for a given harmonic of the detected pitch. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9e836c21a0dcabe9f3438bc56e671f39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9e836c21a0dcabe9f3438bc56e671f39">◆ </a></span>tPeriodDetector_getPeriodicity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPeriodDetector_getPeriodicity </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4a66a46a4a6bea562bae63640e6855a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a66a46a4a6bea562bae63640e6855a5">◆ </a></span>tPeriodDetector_harmonic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPeriodDetector_harmonic </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6bea587938466ba988a6e716446975ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bea587938466ba988a6e716446975ed">◆ </a></span>tPeriodDetector_predictPeriod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tPeriodDetector_predictPeriod </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3d58e36fafa3e5b5102175e2c9062010"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3d58e36fafa3e5b5102175e2c9062010">◆ </a></span>tPeriodDetector_isReady()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tPeriodDetector_isReady </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad7d111b4c8dc6e7428ff2facdf90092a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad7d111b4c8dc6e7428ff2facdf90092a">◆ </a></span>tPeriodDetector_isReset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tPeriodDetector_isReset </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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"></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3157c7b7e210eafb0286aef6f1843f94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3157c7b7e210eafb0286aef6f1843f94">◆ </a></span>tPeriodDetector_setHysteresis()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tPeriodDetector_setHysteresis </td>
<td>(</td>
<td class="paramtype">tPeriodDetector *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 tPeriodDetector. </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>