arduino/arduino-audio-tools
1
0
Fork 0
mirror of https://github.com/pschatzmann/arduino-audio-tools.git synced 2024-09-21 10:27:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
doxygen
arduino-audio-tools/classaudio__tools_1_1_s_t_k_n_reverb.html

157 lines
11 KiB
HTML
Raw Permalink Blame History

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>arduino-audio-tools: STKNReverb 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">arduino-audio-tools
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_s_t_k_n_reverb.html">STKNReverb</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classaudio__tools_1_1_s_t_k_n_reverb-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">STKNReverb Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__dsp.html">DSP</a> &raquo; <a class="el" href="group__effects.html">Effects</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>CCRMA's NRev reverberator class.
<a href="classaudio__tools_1_1_s_t_k_n_reverb.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_audio_s_t_k_8h_source.html">AudioSTK.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for STKNReverb:</div>
<div class="dyncontent">
<div class="center">
<img src="classaudio__tools_1_1_s_t_k_n_reverb.png" usemap="#STKNReverb_map" alt=""/>
<map id="STKNReverb_map" name="STKNReverb_map">
<area href="classaudio__tools_1_1_audio_effect.html" title="Abstract Base class for Sound Effects." alt="AudioEffect" shape="rect" coords="0,0,85,24"/>
</map>
</div></div>
<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:a8c604f5156bab2fccd2c7c9988af518c"><td class="memItemLeft" align="right" valign="top"><a id="a8c604f5156bab2fccd2c7c9988af518c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STKNReverb</b> (const <a class="el" href="classaudio__tools_1_1_s_t_k_n_reverb.html">STKNReverb</a> &amp;copy)=default</td></tr>
<tr class="separator:a8c604f5156bab2fccd2c7c9988af518c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0c854b8095167e0273141e26dd8a6f6"><td class="memItemLeft" align="right" valign="top"><a id="ab0c854b8095167e0273141e26dd8a6f6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STKNReverb</b> (float t60=1.0)</td></tr>
<tr class="separator:ab0c854b8095167e0273141e26dd8a6f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3708b79a6e03c964327c2988b2a70668"><td class="memItemLeft" align="right" valign="top"><a id="a3708b79a6e03c964327c2988b2a70668"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a3708b79a6e03c964327c2988b2a70668">active</a> ()</td></tr>
<tr class="memdesc:a3708b79a6e03c964327c2988b2a70668"><td class="mdescLeft">&#160;</td><td class="mdescRight">determines if the effect is active <br /></td></tr>
<tr class="separator:a3708b79a6e03c964327c2988b2a70668"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dd900474cc05774cfa222eebb66a899"><td class="memItemLeft" align="right" valign="top"><a id="a7dd900474cc05774cfa222eebb66a899"></a>
<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>clone</b> () override</td></tr>
<tr class="separator:a7dd900474cc05774cfa222eebb66a899"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a716406d3d9d4fdbbe46f100e648f3b"><td class="memItemLeft" align="right" valign="top"><a id="a4a716406d3d9d4fdbbe46f100e648f3b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a4a716406d3d9d4fdbbe46f100e648f3b">id</a> ()</td></tr>
<tr class="memdesc:a4a716406d3d9d4fdbbe46f100e648f3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows to identify an effect. <br /></td></tr>
<tr class="separator:a4a716406d3d9d4fdbbe46f100e648f3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae60a58177e645e1f35bb5ffe394427a2"><td class="memItemLeft" align="right" valign="top"><a id="ae60a58177e645e1f35bb5ffe394427a2"></a>
virtual effect_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_s_t_k_n_reverb.html#ae60a58177e645e1f35bb5ffe394427a2">process</a> (effect_t in)</td></tr>
<tr class="memdesc:ae60a58177e645e1f35bb5ffe394427a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">calculates the effect output from the input <br /></td></tr>
<tr class="separator:ae60a58177e645e1f35bb5ffe394427a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a392adf5d7d03b5339b77ec58bca5f9a9"><td class="memItemLeft" align="right" valign="top"><a id="a392adf5d7d03b5339b77ec58bca5f9a9"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a392adf5d7d03b5339b77ec58bca5f9a9">setActive</a> (bool value)</td></tr>
<tr class="memdesc:a392adf5d7d03b5339b77ec58bca5f9a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the effect active/inactive <br /></td></tr>
<tr class="separator:a392adf5d7d03b5339b77ec58bca5f9a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d929477fef71d52c9c6df2ba2d50841"><td class="memItemLeft" align="right" valign="top"><a id="a3d929477fef71d52c9c6df2ba2d50841"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a3d929477fef71d52c9c6df2ba2d50841">setId</a> (int <a class="el" href="classaudio__tools_1_1_audio_effect.html#a4a716406d3d9d4fdbbe46f100e648f3b">id</a>)</td></tr>
<tr class="memdesc:a3d929477fef71d52c9c6df2ba2d50841"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows to identify an effect. <br /></td></tr>
<tr class="separator:a3d929477fef71d52c9c6df2ba2d50841"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af52bdd0b692ecf558d8bd97fac35bf6b"><td class="memItemLeft" align="right" valign="top"><a id="af52bdd0b692ecf558d8bd97fac35bf6b"></a>
int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#af52bdd0b692ecf558d8bd97fac35bf6b">clip</a> (int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)</td></tr>
<tr class="memdesc:af52bdd0b692ecf558d8bd97fac35bf6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">generic clipping method <br /></td></tr>
<tr class="separator:af52bdd0b692ecf558d8bd97fac35bf6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab09618ef5ecbce364b46a4a0b44de2ef"><td class="memItemLeft" align="right" valign="top"><a id="ab09618ef5ecbce364b46a4a0b44de2ef"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>copyParent</b> (<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> *copy)</td></tr>
<tr class="separator:ab09618ef5ecbce364b46a4a0b44de2ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7816e2085c1adaae2c69ed5f65f1d212"><td class="memItemLeft" align="right" valign="top"><a id="a7816e2085c1adaae2c69ed5f65f1d212"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>active_flag</b> = true</td></tr>
<tr class="separator:a7816e2085c1adaae2c69ed5f65f1d212"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55d6269c0eac19475dd606fe07eb8a48"><td class="memItemLeft" align="right" valign="top"><a id="a55d6269c0eac19475dd606fe07eb8a48"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_value</b> = -1</td></tr>
<tr class="separator:a55d6269c0eac19475dd606fe07eb8a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>CCRMA's NRev reverberator class. </p>
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/AudioLibs/<a class="el" href="_audio_s_t_k_8h_source.html">AudioSTK.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink