mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
351 lines
34 KiB
HTML
351 lines
34 KiB
HTML
|
<!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: AudioEffectStreamT< T > Class Template 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&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&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_audio_effect_stream_t.html">AudioEffectStreamT</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
||
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
||
|
|
<a href="classaudio__tools_1_1_audio_effect_stream_t-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">AudioEffectStreamT< T > Class Template Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__dsp.html">DSP</a> » <a class="el" href="group__effects.html">Effects</a> | <a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__transform.html">Converting Streams</a></div></div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. The number of channels are used to merge the samples of one frame into one sample before outputting the result as a frame (by repeating the result sample for each channel). Currently only int16_t values are supported, so I recommend to use the <b><a class="el" href="classaudio__tools_1_1_audio_effect_stream.html" title="EffectsStream supporting variable bits_per_sample. This class is only available when __cplusplus >= 2...">AudioEffectStream</a></b> class which is defined as using <a class="el" href="classaudio__tools_1_1_audio_effect_stream.html" title="EffectsStream supporting variable bits_per_sample. This class is only available when __cplusplus >= 2...">AudioEffectStream</a> = AudioEffectStreamT<effect_t>;.
|
||
|
|
<a href="classaudio__tools_1_1_audio_effect_stream_t.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="_audio_effects_8h_source.html">AudioEffects.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for AudioEffectStreamT< T >:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center">
|
||
|
|
<img src="classaudio__tools_1_1_audio_effect_stream_t.png" usemap="#AudioEffectStreamT_3C_20T_20_3E_map" alt=""/>
|
||
|
|
<map id="AudioEffectStreamT_3C_20T_20_3E_map" name="AudioEffectStreamT_3C_20T_20_3E_map">
|
||
|
|
<area href="classaudio__tools_1_1_modifying_stream.html" title="Abstract class: Objects can be put into a pipleline." alt="ModifyingStream" shape="rect" coords="165,224,320,248"/>
|
||
|
|
<area href="classaudio__tools_1_1_audio_stream.html" title="Base class for all Audio Streams. It support the boolean operator to test if the object is ready with..." alt="AudioStream" shape="rect" coords="165,168,320,192"/>
|
||
|
|
<area href="classaudio__tools_1_1_base_stream.html" title="Base class for all Streams. It relies on write(const uint8_t *buffer, size_t size) and readBytes(uint..." alt="BaseStream" shape="rect" coords="0,112,155,136"/>
|
||
|
|
<area href="classaudio__tools_1_1_audio_info_support.html" title="Supports changes to the sampling rate, bits and channels." alt="AudioInfoSupport" shape="rect" coords="165,112,320,136"/>
|
||
|
|
<area href="classaudio__tools_1_1_audio_info_source.html" title="Supports the subscription to audio change notifications." alt="AudioInfoSource" shape="rect" coords="330,112,485,136"/>
|
||
|
|
<area href="classaudio__tools_1_1_stream.html" alt="Stream" shape="rect" coords="0,56,155,80"/>
|
||
|
|
<area href="classaudio__tools_1_1_print.html" alt="Print" shape="rect" coords="0,0,155,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:a4efaa3cbff6e9c8f93e50e85555b4e46"><td class="memItemLeft" align="right" valign="top"><a id="a4efaa3cbff6e9c8f93e50e85555b4e46"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><b>AudioEffectStreamT</b> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> &out)</td></tr>
|
||
|
|
<tr class="separator:a4efaa3cbff6e9c8f93e50e85555b4e46"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acb526a7a0d2e25c2295c70865dfdd856"><td class="memItemLeft" align="right" valign="top"><a id="acb526a7a0d2e25c2295c70865dfdd856"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><b>AudioEffectStreamT</b> (<a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> &io)</td></tr>
|
||
|
|
<tr class="separator:acb526a7a0d2e25c2295c70865dfdd856"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8c1b8bfcd46d399503e45d49c32ce087"><td class="memItemLeft" align="right" valign="top"><a id="a8c1b8bfcd46d399503e45d49c32ce087"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a8c1b8bfcd46d399503e45d49c32ce087">addEffect</a> (<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> &effect)</td></tr>
|
||
|
|
<tr class="memdesc:a8c1b8bfcd46d399503e45d49c32ce087"><td class="mdescLeft"> </td><td class="mdescRight">Adds an effect object (by reference) <br /></td></tr>
|
||
|
|
<tr class="separator:a8c1b8bfcd46d399503e45d49c32ce087"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a76977e2ce53e1e0cb66e2dc76eb34500"><td class="memItemLeft" align="right" valign="top"><a id="a76977e2ce53e1e0cb66e2dc76eb34500"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a76977e2ce53e1e0cb66e2dc76eb34500">addEffect</a> (<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> *effect)</td></tr>
|
||
|
|
<tr class="memdesc:a76977e2ce53e1e0cb66e2dc76eb34500"><td class="mdescLeft"> </td><td class="mdescRight">Adds an effect using a pointer. <br /></td></tr>
|
||
|
|
<tr class="separator:a76977e2ce53e1e0cb66e2dc76eb34500"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a727a24459787e1eeeb7a37ba888394a6"><td class="memItemLeft" align="right" valign="top"><a id="a727a24459787e1eeeb7a37ba888394a6"></a>
|
||
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a727a24459787e1eeeb7a37ba888394a6">addNotifyAudioChange</a> (<a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
||
|
|
<tr class="memdesc:a727a24459787e1eeeb7a37ba888394a6"><td class="mdescLeft"> </td><td class="mdescRight">Adds target to be notified about audio changes. <br /></td></tr>
|
||
|
|
<tr class="separator:a727a24459787e1eeeb7a37ba888394a6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aececda97cff151859a8695d30896dd20"><td class="memItemLeft" align="right" valign="top"><a id="aececda97cff151859a8695d30896dd20"></a>
|
||
|
|
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#aececda97cff151859a8695d30896dd20">audioInfo</a> () override</td></tr>
|
||
|
|
<tr class="memdesc:aececda97cff151859a8695d30896dd20"><td class="mdescLeft"> </td><td class="mdescRight">provides the actual input <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> <br /></td></tr>
|
||
|
|
<tr class="separator:aececda97cff151859a8695d30896dd20"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memItemLeft" align="right" valign="top"><a id="a1c77cb3dbe910c765ea439d103bdcbb9"></a>
|
||
|
|
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_support.html#a1c77cb3dbe910c765ea439d103bdcbb9">audioInfoOut</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="mdescLeft"> </td><td class="mdescRight">provides the actual output <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a>: this is usually the same as <a class="el" href="classaudio__tools_1_1_audio_info_support.html#ae0d5f156b0564368220fa8d328db3880" title="provides the actual input AudioInfo">audioInfo()</a> unless we use a transforming stream <br /></td></tr>
|
||
|
|
<tr class="separator:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a692e2b18b3c2452e38e3f558ad87e9a5"><td class="memItemLeft" align="right" valign="top"><a id="a692e2b18b3c2452e38e3f558ad87e9a5"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>available</b> () override</td></tr>
|
||
|
|
<tr class="separator:a692e2b18b3c2452e38e3f558ad87e9a5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a87b51853b7bf1bc90d9efa9f3b8d4fea"><td class="memItemLeft" align="right" valign="top"><a id="a87b51853b7bf1bc90d9efa9f3b8d4fea"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>availableForWrite</b> () override</td></tr>
|
||
|
|
<tr class="separator:a87b51853b7bf1bc90d9efa9f3b8d4fea"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a601fb7cf1fc15db50c71a826f084f934"><td class="memItemLeft" align="right" valign="top"><a id="a601fb7cf1fc15db50c71a826f084f934"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
|
||
|
|
<tr class="separator:a601fb7cf1fc15db50c71a826f084f934"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af99303e9bfe78c84f1abd84376477ec7"><td class="memItemLeft" align="right" valign="top"><a id="af99303e9bfe78c84f1abd84376477ec7"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>begin</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> cfg)</td></tr>
|
||
|
|
<tr class="separator:af99303e9bfe78c84f1abd84376477ec7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a id="ac8bb3912a3ce86b15842e79d0b421204"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">deletes all defined effects <br /></td></tr>
|
||
|
|
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:affd15675a5e391c34cccefa7181354bb"><td class="memItemLeft" align="right" valign="top"><a id="affd15675a5e391c34cccefa7181354bb"></a>
|
||
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#affd15675a5e391c34cccefa7181354bb">clearNotifyAudioChange</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:affd15675a5e391c34cccefa7181354bb"><td class="mdescLeft"> </td><td class="mdescRight">Deletes all change notify subscriptions. <br /></td></tr>
|
||
|
|
<tr class="separator:affd15675a5e391c34cccefa7181354bb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a80e4660b5bd60cf09803f81e3e443644"><td class="memItemLeft" align="right" valign="top"><a id="a80e4660b5bd60cf09803f81e3e443644"></a>
|
||
|
|
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><b>defaultConfig</b> ()</td></tr>
|
||
|
|
<tr class="separator:a80e4660b5bd60cf09803f81e3e443644"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a64e9fa75beda50a9e8400ee0d4e61984"><td class="memItemLeft" align="right" valign="top"><a id="a64e9fa75beda50a9e8400ee0d4e61984"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>end</b> () override</td></tr>
|
||
|
|
<tr class="separator:a64e9fa75beda50a9e8400ee0d4e61984"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab74dd95287679b2bd45a7bb17fb05991"><td class="memItemLeft" align="right" valign="top"><a id="ab74dd95287679b2bd45a7bb17fb05991"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#ab74dd95287679b2bd45a7bb17fb05991">findEffect</a> (int id)</td></tr>
|
||
|
|
<tr class="memdesc:ab74dd95287679b2bd45a7bb17fb05991"><td class="mdescLeft"> </td><td class="mdescRight">Finds an effect by id. <br /></td></tr>
|
||
|
|
<tr class="separator:ab74dd95287679b2bd45a7bb17fb05991"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af654b48544c195ab99fe27e7bc3ed5fe"><td class="memItemLeft" align="right" valign="top"><a id="af654b48544c195ab99fe27e7bc3ed5fe"></a>
|
||
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>flush</b> () override</td></tr>
|
||
|
|
<tr class="separator:af654b48544c195ab99fe27e7bc3ed5fe"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="memItemLeft" align="right" valign="top"><a id="a475bc9908ea8a1d67e5cc1c1f67a71b2"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a475bc9908ea8a1d67e5cc1c1f67a71b2">isNotifyActive</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the automatic <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> update is active. <br /></td></tr>
|
||
|
|
<tr class="separator:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0d52c0ed98e047d782054fa126b281e5"><td class="memItemLeft" align="right" valign="top"><a id="a0d52c0ed98e047d782054fa126b281e5"></a>
|
||
|
|
virtual </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
|
||
|
|
<tr class="separator:a0d52c0ed98e047d782054fa126b281e5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a722144d124c35931c637345566824441"><td class="memItemLeft" align="right" valign="top"><a id="a722144d124c35931c637345566824441"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a722144d124c35931c637345566824441">operator[]</a> (int idx)</td></tr>
|
||
|
|
<tr class="memdesc:a722144d124c35931c637345566824441"><td class="mdescLeft"> </td><td class="mdescRight">gets an effect by index <br /></td></tr>
|
||
|
|
<tr class="separator:a722144d124c35931c637345566824441"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4c5c6275ddee80eb02839356b6185c0b"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a4c5c6275ddee80eb02839356b6185c0b">readBytes</a> (uint8_t *data, size_t len) override</td></tr>
|
||
|
|
<tr class="separator:a4c5c6275ddee80eb02839356b6185c0b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a36e26f40121eda38b0042dcba026ab82"><td class="memItemLeft" align="right" valign="top"><a id="a36e26f40121eda38b0042dcba026ab82"></a>
|
||
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#a36e26f40121eda38b0042dcba026ab82">readSilence</a> (uint8_t *buffer, size_t length)</td></tr>
|
||
|
|
<tr class="memdesc:a36e26f40121eda38b0042dcba026ab82"><td class="mdescLeft"> </td><td class="mdescRight">Source to generate silence: just sets the buffer to 0. <br /></td></tr>
|
||
|
|
<tr class="separator:a36e26f40121eda38b0042dcba026ab82"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="memItemLeft" align="right" valign="top"><a id="aa5b1cdb06807ff2dc37acbaff63410b9"></a>
|
||
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#aa5b1cdb06807ff2dc37acbaff63410b9">removeNotifyAudioChange</a> (<a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
||
|
|
<tr class="memdesc:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="mdescLeft"> </td><td class="mdescRight">Removes a target in order not to be notified about audio changes. <br /></td></tr>
|
||
|
|
<tr class="separator:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acbaca7240bc555603b0da5b7ca11ce10"><td class="memItemLeft" align="right" valign="top"><a id="acbaca7240bc555603b0da5b7ca11ce10"></a>
|
||
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#acbaca7240bc555603b0da5b7ca11ce10">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> newInfo) override</td></tr>
|
||
|
|
<tr class="memdesc:acbaca7240bc555603b0da5b7ca11ce10"><td class="mdescLeft"> </td><td class="mdescRight">Defines the input <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a>. <br /></td></tr>
|
||
|
|
<tr class="separator:acbaca7240bc555603b0da5b7ca11ce10"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a909f118906f9cf7024baae224dcd90a7"><td class="memItemLeft" align="right" valign="top"><a id="a909f118906f9cf7024baae224dcd90a7"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a909f118906f9cf7024baae224dcd90a7">setNotifyActive</a> (bool flag)</td></tr>
|
||
|
|
<tr class="memdesc:a909f118906f9cf7024baae224dcd90a7"><td class="mdescLeft"> </td><td class="mdescRight">Deactivate/Reactivate automatic <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> updates: (default is active) <br /></td></tr>
|
||
|
|
<tr class="separator:a909f118906f9cf7024baae224dcd90a7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1a28a6cba0e36eb54e72b3336f8b3ed1"><td class="memItemLeft" align="right" valign="top"><a id="a1a28a6cba0e36eb54e72b3336f8b3ed1"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a1a28a6cba0e36eb54e72b3336f8b3ed1">setOutput</a> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> &print) override</td></tr>
|
||
|
|
<tr class="memdesc:a1a28a6cba0e36eb54e72b3336f8b3ed1"><td class="mdescLeft"> </td><td class="mdescRight">Defines/Changes the output target. <br /></td></tr>
|
||
|
|
<tr class="separator:a1a28a6cba0e36eb54e72b3336f8b3ed1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adb3b6de56b862417b2d77962d06db58c"><td class="memItemLeft" align="right" valign="top"><a id="adb3b6de56b862417b2d77962d06db58c"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#adb3b6de56b862417b2d77962d06db58c">setStream</a> (<a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> &io) override</td></tr>
|
||
|
|
<tr class="memdesc:adb3b6de56b862417b2d77962d06db58c"><td class="mdescLeft"> </td><td class="mdescRight">Defines/Changes the input & output. <br /></td></tr>
|
||
|
|
<tr class="separator:adb3b6de56b862417b2d77962d06db58c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0b6b70701c46e22849f0f363861351cd"><td class="memItemLeft" align="right" valign="top"><a id="a0b6b70701c46e22849f0f363861351cd"></a>
|
||
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a0b6b70701c46e22849f0f363861351cd">size</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a0b6b70701c46e22849f0f363861351cd"><td class="mdescLeft"> </td><td class="mdescRight">Provides the actual number of defined effects. <br /></td></tr>
|
||
|
|
<tr class="separator:a0b6b70701c46e22849f0f363861351cd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7597ef706dd1aa590903ce9e095db20a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect_stream_t.html#a7597ef706dd1aa590903ce9e095db20a">write</a> (const uint8_t *data, size_t len) override</td></tr>
|
||
|
|
<tr class="separator:a7597ef706dd1aa590903ce9e095db20a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adffba128cba62b029746648f6946945c"><td class="memItemLeft" align="right" valign="top"><a id="adffba128cba62b029746648f6946945c"></a>
|
||
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t ch) override</td></tr>
|
||
|
|
<tr class="separator:adffba128cba62b029746648f6946945c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad89418aeb557f65a8f1a0aed755633b1"><td class="memItemLeft" align="right" valign="top"><a id="ad89418aeb557f65a8f1a0aed755633b1"></a>
|
||
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_stream.html#ad89418aeb557f65a8f1a0aed755633b1">writeSilence</a> (size_t len)</td></tr>
|
||
|
|
<tr class="memdesc:ad89418aeb557f65a8f1a0aed755633b1"><td class="mdescLeft"> </td><td class="mdescRight">Writes len bytes of silence (=0). <br /></td></tr>
|
||
|
|
<tr class="separator:ad89418aeb557f65a8f1a0aed755633b1"><td class="memSeparator" colspan="2"> </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:afc00b141650b11fe19d4c7055d96a075"><td class="memItemLeft" align="right" valign="top"><a id="afc00b141650b11fe19d4c7055d96a075"></a>
|
||
|
|
virtual int </td><td class="memItemRight" valign="bottom"><b>not_supported</b> (int out, const char *msg="")</td></tr>
|
||
|
|
<tr class="separator:afc00b141650b11fe19d4c7055d96a075"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6a9a665a387a8c4fbf7fed14bbbfc093"><td class="memItemLeft" align="right" valign="top"><a id="a6a9a665a387a8c4fbf7fed14bbbfc093"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>notifyAudioChange</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
|
||
|
|
<tr class="separator:a6a9a665a387a8c4fbf7fed14bbbfc093"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5caf99a24686511722c4c9f94c4ec52e"><td class="memItemLeft" align="right" valign="top"><a id="a5caf99a24686511722c4c9f94c4ec52e"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>refillReadBuffer</b> ()</td></tr>
|
||
|
|
<tr class="separator:a5caf99a24686511722c4c9f94c4ec52e"><td class="memSeparator" colspan="2"> </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:aa66a35e5edf58ce00047afcd1d4f455e"><td class="memItemLeft" align="right" valign="top"><a id="aa66a35e5edf58ce00047afcd1d4f455e"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>_timeout</b> = 10</td></tr>
|
||
|
|
<tr class="separator:aa66a35e5edf58ce00047afcd1d4f455e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top"><a id="a03c996f9fcf0e10baeb3e700be0c409a"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>active</b> = false</td></tr>
|
||
|
|
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aabf82b9d0d68dbcf9120221076b05b01"><td class="memItemLeft" align="right" valign="top"><a id="aabf82b9d0d68dbcf9120221076b05b01"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_audio_effect_common.html">AudioEffectCommon</a> </td><td class="memItemRight" valign="bottom"><b>effects</b></td></tr>
|
||
|
|
<tr class="separator:aabf82b9d0d68dbcf9120221076b05b01"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a47385aa19435f5fca9d3083a748258c5"><td class="memItemLeft" align="right" valign="top"><a id="a47385aa19435f5fca9d3083a748258c5"></a>
|
||
|
|
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><b>info</b></td></tr>
|
||
|
|
<tr class="separator:a47385aa19435f5fca9d3083a748258c5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aeaba7fcedcb403536c79ee7f04de17fc"><td class="memItemLeft" align="right" valign="top"><a id="aeaba7fcedcb403536c79ee7f04de17fc"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>is_notify_active</b> = true</td></tr>
|
||
|
|
<tr class="separator:aeaba7fcedcb403536c79ee7f04de17fc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad35c4e2ef458c36e8d36676958cc9cd3"><td class="memItemLeft" align="right" valign="top"><a id="ad35c4e2ef458c36e8d36676958cc9cd3"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_vector.html">Vector</a>< <a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> * > </td><td class="memItemRight" valign="bottom"><b>notify_vector</b></td></tr>
|
||
|
|
<tr class="separator:ad35c4e2ef458c36e8d36676958cc9cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afb1e9a9c69281667d85bc8dfdc46dd95"><td class="memItemLeft" align="right" valign="top"><a id="afb1e9a9c69281667d85bc8dfdc46dd95"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> * </td><td class="memItemRight" valign="bottom"><b>p_io</b> =nullptr</td></tr>
|
||
|
|
<tr class="separator:afb1e9a9c69281667d85bc8dfdc46dd95"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acdad90adc3ba71f7b1e16444c23b5502"><td class="memItemLeft" align="right" valign="top"><a id="acdad90adc3ba71f7b1e16444c23b5502"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_print.html">Print</a> * </td><td class="memItemRight" valign="bottom"><b>p_print</b> =nullptr</td></tr>
|
||
|
|
<tr class="separator:acdad90adc3ba71f7b1e16444c23b5502"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adf64bd29ec689f2d7574efbb63f440bb"><td class="memItemLeft" align="right" valign="top"><a id="adf64bd29ec689f2d7574efbb63f440bb"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_ring_buffer.html">RingBuffer</a>< uint8_t > </td><td class="memItemRight" valign="bottom"><b>tmp_in</b> {0}</td></tr>
|
||
|
|
<tr class="separator:adf64bd29ec689f2d7574efbb63f440bb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:add363d597c7d8108a5350406105d158d"><td class="memItemLeft" align="right" valign="top"><a id="add363d597c7d8108a5350406105d158d"></a>
|
||
|
|
<a class="el" href="classaudio__tools_1_1_ring_buffer.html">RingBuffer</a>< uint8_t > </td><td class="memItemRight" valign="bottom"><b>tmp_out</b> {0}</td></tr>
|
||
|
|
<tr class="separator:add363d597c7d8108a5350406105d158d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><h3>template<class T><br />
|
||
|
|
class audio_tools::AudioEffectStreamT< T ></h3>
|
||
|
|
|
||
|
|
<p>EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. The number of channels are used to merge the samples of one frame into one sample before outputting the result as a frame (by repeating the result sample for each channel). Currently only int16_t values are supported, so I recommend to use the <b><a class="el" href="classaudio__tools_1_1_audio_effect_stream.html" title="EffectsStream supporting variable bits_per_sample. This class is only available when __cplusplus >= 2...">AudioEffectStream</a></b> class which is defined as using <a class="el" href="classaudio__tools_1_1_audio_effect_stream.html" title="EffectsStream supporting variable bits_per_sample. This class is only available when __cplusplus >= 2...">AudioEffectStream</a> = AudioEffectStreamT<effect_t>;. </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><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a4c5c6275ddee80eb02839356b6185c0b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c5c6275ddee80eb02839356b6185c0b">◆ </a></span>readBytes()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t readBytes </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint8_t * </td>
|
||
|
|
<td class="paramname"><em>data</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>len</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Provides the audio data by reading the assinged <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> and applying the effects on that input </p>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7597ef706dd1aa590903ce9e095db20a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7597ef706dd1aa590903ce9e095db20a">◆ </a></span>write()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t write </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const uint8_t * </td>
|
||
|
|
<td class="paramname"><em>data</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>len</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Writes the samples passed in the buffer and applies the effects before writing the result to the output defined in the constructor. </p>
|
||
|
|
|
||
|
|
<p>Reimplemented from <a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>src/AudioEffects/<a class="el" href="_audio_effects_8h_source.html">AudioEffects.h</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by <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>
|