ref: c9f87b8761155abf2cab26cb809bcf89016697f3
dir: /docs/leaf/group__tformantshifter.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: tFormantShifter</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">tFormantShifter<div class="ingroups"><a class="el" href="group__effects.html">Effects</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Formant remover and adder, allowing for formant shifting.
<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:ga42890ba9ac29c3f200d617647fcd321b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#ga42890ba9ac29c3f200d617647fcd321b">tFormantShifter_init</a> (tFormantShifter *const, int order, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:ga42890ba9ac29c3f200d617647fcd321b"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tFormantShifter 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__tformantshifter.html#ga42890ba9ac29c3f200d617647fcd321b">More...</a><br /></td></tr>
<tr class="separator:ga42890ba9ac29c3f200d617647fcd321b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad79a5e074c0f99ac7c7af3d530fdd214"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#gad79a5e074c0f99ac7c7af3d530fdd214">tFormantShifter_initToPool</a> (tFormantShifter *const, int order, tMempool *const)</td></tr>
<tr class="memdesc:gad79a5e074c0f99ac7c7af3d530fdd214"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tFormantShifter to a specified mempool. <a href="group__tformantshifter.html#gad79a5e074c0f99ac7c7af3d530fdd214">More...</a><br /></td></tr>
<tr class="separator:gad79a5e074c0f99ac7c7af3d530fdd214"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4d9198bc06d81125663dd3da00fbf47"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#gab4d9198bc06d81125663dd3da00fbf47">tFormantShifter_free</a> (tFormantShifter *const)</td></tr>
<tr class="memdesc:gab4d9198bc06d81125663dd3da00fbf47"><td class="mdescLeft"> </td><td class="mdescRight">Free a tFormantShifter from its mempool. <a href="group__tformantshifter.html#gab4d9198bc06d81125663dd3da00fbf47">More...</a><br /></td></tr>
<tr class="separator:gab4d9198bc06d81125663dd3da00fbf47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e02d685feef8233a0949e19718b2884"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#ga6e02d685feef8233a0949e19718b2884">tFormantShifter_tick</a> (tFormantShifter *const, float input)</td></tr>
<tr class="separator:ga6e02d685feef8233a0949e19718b2884"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20c5dcc163a256e5b7792b1cd4788d59"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#ga20c5dcc163a256e5b7792b1cd4788d59">tFormantShifter_remove</a> (tFormantShifter *const, float input)</td></tr>
<tr class="separator:ga20c5dcc163a256e5b7792b1cd4788d59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1697aa8f5614be25546943c7a3c6f46"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#gaa1697aa8f5614be25546943c7a3c6f46">tFormantShifter_add</a> (tFormantShifter *const, float input)</td></tr>
<tr class="separator:gaa1697aa8f5614be25546943c7a3c6f46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf13d01a3ed6e8941d93e521769f5447"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#gadf13d01a3ed6e8941d93e521769f5447">tFormantShifter_ioSamples</a> (tFormantShifter *const, float *in, float *out, int size, float fwarp)</td></tr>
<tr class="separator:gadf13d01a3ed6e8941d93e521769f5447"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f5493a4bce93a71124aed52d374cfdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#ga3f5493a4bce93a71124aed52d374cfdc">tFormantShifter_setShiftFactor</a> (tFormantShifter *const, float shiftFactor)</td></tr>
<tr class="separator:ga3f5493a4bce93a71124aed52d374cfdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf975f968b7428a7d744b2493c68267d4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tformantshifter.html#gaf975f968b7428a7d744b2493c68267d4">tFormantShifter_setIntensity</a> (tFormantShifter *const, float intensity)</td></tr>
<tr class="separator:gaf975f968b7428a7d744b2493c68267d4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Formant remover and adder, allowing for formant shifting. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga42890ba9ac29c3f200d617647fcd321b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42890ba9ac29c3f200d617647fcd321b">◆ </a></span>tFormantShifter_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tFormantShifter_init </td>
<td>(</td>
<td class="paramtype">tFormantShifter * 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"><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 tFormantShifter 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">formant</td><td>A pointer to the tFormantShifter 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="gad79a5e074c0f99ac7c7af3d530fdd214"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad79a5e074c0f99ac7c7af3d530fdd214">◆ </a></span>tFormantShifter_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tFormantShifter_initToPool </td>
<td>(</td>
<td class="paramtype">tFormantShifter * 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">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 tFormantShifter to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">formant</td><td>A pointer to the tFormantShifter 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="gab4d9198bc06d81125663dd3da00fbf47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab4d9198bc06d81125663dd3da00fbf47">◆ </a></span>tFormantShifter_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tFormantShifter_free </td>
<td>(</td>
<td class="paramtype">tFormantShifter * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tFormantShifter from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">formant</td><td>A pointer to the tFormantShifter to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6e02d685feef8233a0949e19718b2884"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e02d685feef8233a0949e19718b2884">◆ </a></span>tFormantShifter_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tFormantShifter_tick </td>
<td>(</td>
<td class="paramtype">tFormantShifter * 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></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">formant</td><td>A pointer to the relevant tFormantShifter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga20c5dcc163a256e5b7792b1cd4788d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga20c5dcc163a256e5b7792b1cd4788d59">◆ </a></span>tFormantShifter_remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tFormantShifter_remove </td>
<td>(</td>
<td class="paramtype">tFormantShifter * 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></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">formant</td><td>A pointer to the relevant tFormantShifter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa1697aa8f5614be25546943c7a3c6f46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1697aa8f5614be25546943c7a3c6f46">◆ </a></span>tFormantShifter_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tFormantShifter_add </td>
<td>(</td>
<td class="paramtype">tFormantShifter * 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></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">formant</td><td>A pointer to the relevant tFormantShifter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gadf13d01a3ed6e8941d93e521769f5447"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf13d01a3ed6e8941d93e521769f5447">◆ </a></span>tFormantShifter_ioSamples()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tFormantShifter_ioSamples </td>
<td>(</td>
<td class="paramtype">tFormantShifter * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>fwarp</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">formant</td><td>A pointer to the relevant tFormantShifter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3f5493a4bce93a71124aed52d374cfdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f5493a4bce93a71124aed52d374cfdc">◆ </a></span>tFormantShifter_setShiftFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tFormantShifter_setShiftFactor </td>
<td>(</td>
<td class="paramtype">tFormantShifter * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>shiftFactor</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">formant</td><td>A pointer to the relevant tFormantShifter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf975f968b7428a7d744b2493c68267d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf975f968b7428a7d744b2493c68267d4">◆ </a></span>tFormantShifter_setIntensity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tFormantShifter_setIntensity </td>
<td>(</td>
<td class="paramtype">tFormantShifter * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>intensity</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">formant</td><td>A pointer to the relevant tFormantShifter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>