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_test_generator.html

217 lines
16 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: TestGenerator&lt; T &gt; 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&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_test_generator.html">TestGenerator</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_test_generator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TestGenerator&lt; T &gt; Class Template 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__generator.html">Generators</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Generates a test signal which is easy to check because the values are incremented or decremented by 1.
<a href="classaudio__tools_1_1_test_generator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_sound_generator_8h_source.html">SoundGenerator.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TestGenerator&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classaudio__tools_1_1_test_generator.png" usemap="#TestGenerator_3C_20T_20_3E_map" alt=""/>
<map id="TestGenerator_3C_20T_20_3E_map" name="TestGenerator_3C_20T_20_3E_map">
<area href="classaudio__tools_1_1_sound_generator.html" title="Base class to define the abstract interface for the sound generating classes." alt="SoundGenerator&lt; T &gt;" shape="rect" coords="0,0,136,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:ac51206adce034bd85abfe05349f429f4"><td class="memItemLeft" align="right" valign="top"><a id="ac51206adce034bd85abfe05349f429f4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TestGenerator</b> (T max=1000, T inc=1)</td></tr>
<tr class="separator:ac51206adce034bd85abfe05349f429f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada56eff2516fb0a4f5091ce06805411a"><td class="memItemLeft" align="right" valign="top"><a id="ada56eff2516fb0a4f5091ce06805411a"></a>
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#ada56eff2516fb0a4f5091ce06805411a">audioInfo</a> ()</td></tr>
<tr class="memdesc:ada56eff2516fb0a4f5091ce06805411a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the <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:ada56eff2516fb0a4f5091ce06805411a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50f45551c10ca30a0bc7f447e70188b1"><td class="memItemLeft" align="right" valign="top"><a id="a50f45551c10ca30a0bc7f447e70188b1"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr class="separator:a50f45551c10ca30a0bc7f447e70188b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a419d5bfacb0a1e5bf46b5fbd8d94f446"><td class="memItemLeft" align="right" valign="top"><a id="a419d5bfacb0a1e5bf46b5fbd8d94f446"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
<tr class="separator:a419d5bfacb0a1e5bf46b5fbd8d94f446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1ae688606d873e5b04c9a7ada020a0d"><td class="memItemLeft" align="right" valign="top"><a id="af1ae688606d873e5b04c9a7ada020a0d"></a>
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#af1ae688606d873e5b04c9a7ada020a0d">defaultConfig</a> ()</td></tr>
<tr class="memdesc:af1ae688606d873e5b04c9a7ada020a0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the default configuration. <br /></td></tr>
<tr class="separator:af1ae688606d873e5b04c9a7ada020a0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc34417a19a7b70626d19c41072d72a5"><td class="memItemLeft" align="right" valign="top"><a id="adc34417a19a7b70626d19c41072d72a5"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#adc34417a19a7b70626d19c41072d72a5">end</a> ()</td></tr>
<tr class="memdesc:adc34417a19a7b70626d19c41072d72a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">ends the processing <br /></td></tr>
<tr class="separator:adc34417a19a7b70626d19c41072d72a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62eb104f87ff88c21fa01af29dbf0ee2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#a62eb104f87ff88c21fa01af29dbf0ee2">isActive</a> ()</td></tr>
<tr class="separator:a62eb104f87ff88c21fa01af29dbf0ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1635579cf4f895eaaded84a513cb90c9"><td class="memItemLeft" align="right" valign="top"><a id="a1635579cf4f895eaaded84a513cb90c9"></a>
virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#a1635579cf4f895eaaded84a513cb90c9">readBytes</a> (uint8_t *data, size_t len)</td></tr>
<tr class="memdesc:a1635579cf4f895eaaded84a513cb90c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the data as byte array with the requested number of channels. <br /></td></tr>
<tr class="separator:a1635579cf4f895eaaded84a513cb90c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913c911a6aff6d8c9b3deb24469ea336"><td class="memItemLeft" align="right" valign="top"><a id="a913c911a6aff6d8c9b3deb24469ea336"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_test_generator.html#a913c911a6aff6d8c9b3deb24469ea336">readSample</a> () override</td></tr>
<tr class="memdesc:a913c911a6aff6d8c9b3deb24469ea336"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides a single sample. <br /></td></tr>
<tr class="separator:a913c911a6aff6d8c9b3deb24469ea336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87feead15897a49c7dccb043ac9fcddc"><td class="memItemLeft" align="right" valign="top"><a id="a87feead15897a49c7dccb043ac9fcddc"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#a87feead15897a49c7dccb043ac9fcddc">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
<tr class="memdesc:a87feead15897a49c7dccb043ac9fcddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines/updates the <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:a87feead15897a49c7dccb043ac9fcddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ff3c2ef30b2de62b94852b5842fd3f7"><td class="memItemLeft" align="right" valign="top"><a id="a4ff3c2ef30b2de62b94852b5842fd3f7"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_sound_generator.html#a4ff3c2ef30b2de62b94852b5842fd3f7">setFrequency</a> (float frequency)</td></tr>
<tr class="memdesc:a4ff3c2ef30b2de62b94852b5842fd3f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract method: not implemented! Just provides an error message... <br /></td></tr>
<tr class="separator:a4ff3c2ef30b2de62b94852b5842fd3f7"><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:ab531445888201bd1155eb8316f33a33a"><td class="memItemLeft" align="right" valign="top"><a id="ab531445888201bd1155eb8316f33a33a"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>readBytesFrames</b> (uint8_t *buffer, size_t lengthBytes, int frames, int channels)</td></tr>
<tr class="separator:ab531445888201bd1155eb8316f33a33a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1639ce8ceb8a0cb43cb6aa9f500281e"><td class="memItemLeft" align="right" valign="top"><a id="af1639ce8ceb8a0cb43cb6aa9f500281e"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>readBytesFromBuffer</b> (uint8_t *buffer, size_t lengthBytes, int frame_size, int channels)</td></tr>
<tr class="separator:af1639ce8ceb8a0cb43cb6aa9f500281e"><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:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top"><a id="a03c996f9fcf0e10baeb3e700be0c409a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>active</b> = false</td></tr>
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2386b2282ef45b8c242209254044090c"><td class="memItemLeft" align="right" valign="top"><a id="a2386b2282ef45b8c242209254044090c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>activeWarningIssued</b> = false</td></tr>
<tr class="separator:a2386b2282ef45b8c242209254044090c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46c57b3a8e9ca579f516d4b01cbf99a3"><td class="memItemLeft" align="right" valign="top"><a id="a46c57b3a8e9ca579f516d4b01cbf99a3"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>inc</b> = 1</td></tr>
<tr class="separator:a46c57b3a8e9ca579f516d4b01cbf99a3"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><b>info</b></td></tr>
<tr class="separator:a47385aa19435f5fca9d3083a748258c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a4743082100574a99b5fb123cdf4f67"><td class="memItemLeft" align="right" valign="top"><a id="a5a4743082100574a99b5fb123cdf4f67"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>max</b></td></tr>
<tr class="separator:a5a4743082100574a99b5fb123cdf4f67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9870079e2dc48a291a15a41b6ecffbf"><td class="memItemLeft" align="right" valign="top"><a id="af9870079e2dc48a291a15a41b6ecffbf"></a>
<a class="el" href="classaudio__tools_1_1_ring_buffer.html">RingBuffer</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>ring_buffer</b> {0}</td></tr>
<tr class="separator:af9870079e2dc48a291a15a41b6ecffbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fc7f59e3113e19697159919a5aad095"><td class="memItemLeft" align="right" valign="top"><a id="a4fc7f59e3113e19697159919a5aad095"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>value</b> = 0</td></tr>
<tr class="separator:a4fc7f59e3113e19697159919a5aad095"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class audio_tools::TestGenerator&lt; T &gt;</h3>
<p>Generates a test signal which is easy to check because the values are incremented or decremented by 1. </p>
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td></td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a62eb104f87ff88c21fa01af29dbf0ee2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62eb104f87ff88c21fa01af29dbf0ee2">&#9670;&nbsp;</a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool isActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the begin method has been called - after <a class="el" href="classaudio__tools_1_1_sound_generator.html#adc34417a19a7b70626d19c41072d72a5" title="ends the processing">end()</a> isActive returns false </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/AudioEffects/<a class="el" href="_sound_generator_8h_source.html">SoundGenerator.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