ref: ab2f66165913c6ea18e105ce5da7431fb21a2fbd
dir: /docs/leaf/group__toversampler.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: tOversampler</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">tOversampler<div class="ingroups"><a class="el" href="group__distortion.html">Distortion</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Oversampler.
<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:ga6c89c7875f0f5679ea59430d9a6c61e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#ga6c89c7875f0f5679ea59430d9a6c61e8">tOversampler_init</a> (tOversampler *const, int order, int extraQuality, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:ga6c89c7875f0f5679ea59430d9a6c61e8"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tOversampler 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__toversampler.html#ga6c89c7875f0f5679ea59430d9a6c61e8">More...</a><br /></td></tr>
<tr class="separator:ga6c89c7875f0f5679ea59430d9a6c61e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga65ae3bd40ead130ffc4a81d47bdc61fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#ga65ae3bd40ead130ffc4a81d47bdc61fe">tOversampler_initToPool</a> (tOversampler *const, int order, int extraQuality, tMempool *const)</td></tr>
<tr class="memdesc:ga65ae3bd40ead130ffc4a81d47bdc61fe"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tOversampler to a specified mempool. <a href="group__toversampler.html#ga65ae3bd40ead130ffc4a81d47bdc61fe">More...</a><br /></td></tr>
<tr class="separator:ga65ae3bd40ead130ffc4a81d47bdc61fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga809c183c7443aa77ae6233e8c5276218"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#ga809c183c7443aa77ae6233e8c5276218">tOversampler_free</a> (tOversampler *const)</td></tr>
<tr class="memdesc:ga809c183c7443aa77ae6233e8c5276218"><td class="mdescLeft"> </td><td class="mdescRight">Free a tOversampler from its mempool. <a href="group__toversampler.html#ga809c183c7443aa77ae6233e8c5276218">More...</a><br /></td></tr>
<tr class="separator:ga809c183c7443aa77ae6233e8c5276218"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga274c2b3d123628c2ecbb3e77d0f9bd3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#ga274c2b3d123628c2ecbb3e77d0f9bd3b">tOversampler_upsample</a> (tOversampler *const, float input, float *output)</td></tr>
<tr class="separator:ga274c2b3d123628c2ecbb3e77d0f9bd3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36a0bca206cb86ac529495bf0f1e487d"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#ga36a0bca206cb86ac529495bf0f1e487d">tOversampler_downsample</a> (tOversampler *const os, float *input)</td></tr>
<tr class="separator:ga36a0bca206cb86ac529495bf0f1e487d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8be1bb7f1f763de87c6e02f02b5d977f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#ga8be1bb7f1f763de87c6e02f02b5d977f">tOversampler_tick</a> (tOversampler *const, float input, float *oversample, float(*effectTick)(float))</td></tr>
<tr class="separator:ga8be1bb7f1f763de87c6e02f02b5d977f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa511cdb16fe967cf40000127319d9f0c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__toversampler.html#gaa511cdb16fe967cf40000127319d9f0c">tOversampler_getLatency</a> (tOversampler *const os)</td></tr>
<tr class="separator:gaa511cdb16fe967cf40000127319d9f0c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Oversampler. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga6c89c7875f0f5679ea59430d9a6c61e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6c89c7875f0f5679ea59430d9a6c61e8">◆ </a></span>tOversampler_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOversampler_init </td>
<td>(</td>
<td class="paramtype">tOversampler * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>extraQuality</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 tOversampler 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">oversampler</td><td>A pointer to the tOversampler to initialize. </td></tr>
<tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga65ae3bd40ead130ffc4a81d47bdc61fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65ae3bd40ead130ffc4a81d47bdc61fe">◆ </a></span>tOversampler_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOversampler_initToPool </td>
<td>(</td>
<td class="paramtype">tOversampler * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>extraQuality</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tMempool * const </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tOversampler to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">oversampler</td><td>A pointer to the tOversampler to initialize. </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="ga809c183c7443aa77ae6233e8c5276218"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga809c183c7443aa77ae6233e8c5276218">◆ </a></span>tOversampler_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOversampler_free </td>
<td>(</td>
<td class="paramtype">tOversampler * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tOversampler from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">oversampler</td><td>A pointer to the tOversampler to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga274c2b3d123628c2ecbb3e77d0f9bd3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga274c2b3d123628c2ecbb3e77d0f9bd3b">◆ </a></span>tOversampler_upsample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tOversampler_upsample </td>
<td>(</td>
<td class="paramtype">tOversampler * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>output</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">oversampler</td><td>A pointer to the relevant tOversampler. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga36a0bca206cb86ac529495bf0f1e487d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga36a0bca206cb86ac529495bf0f1e487d">◆ </a></span>tOversampler_downsample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tOversampler_downsample </td>
<td>(</td>
<td class="paramtype">tOversampler *const </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>input</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">oversampler</td><td>A pointer to the relevant tOversampler. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga8be1bb7f1f763de87c6e02f02b5d977f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8be1bb7f1f763de87c6e02f02b5d977f">◆ </a></span>tOversampler_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tOversampler_tick </td>
<td>(</td>
<td class="paramtype">tOversampler * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>oversample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float(*)(float) </td>
<td class="paramname"><em>effectTick</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">oversampler</td><td>A pointer to the relevant tOversampler. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa511cdb16fe967cf40000127319d9f0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa511cdb16fe967cf40000127319d9f0c">◆ </a></span>tOversampler_getLatency()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tOversampler_getLatency </td>
<td>(</td>
<td class="paramtype">tOversampler *const </td>
<td class="paramname"><em>os</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">oversampler</td><td>A pointer to the relevant tOversampler.  </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>