arduino-audio-tools/modules.html

123 lines
13 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: Modules</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>
</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="headertitle">
<div class="title">Modules</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here is a list of all modules:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group__main.html" target="_self">Arduino Audio Tools</a></td><td class="desc">A powerful audio library (not only) for Arduino </td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__basic.html" target="_self">Basic</a></td><td class="desc">Basic Concepts </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><a class="el" href="group__codecs.html" target="_self">Codecs</a></td><td class="desc">Audio Coder and Decoder <br />
</td></tr>
<tr id="row_0_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__decoder.html" target="_self">Decoder</a></td><td class="desc">Audio Decoder </td></tr>
<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__encoder.html" target="_self">Encoder</a></td><td class="desc">Audio Encoder </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><a class="el" href="group__communications.html" target="_self">Communications</a></td><td class="desc">Transmit Audio Please note that the standard Arduino WiFiClient and WifiServer (to use TCP/IP), Serial or BluetoothSerial are also supported. <br />
</td></tr>
<tr id="row_0_2_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__fec.html" target="_self">FEC</a></td><td class="desc">Forward Error Correction </td></tr>
<tr id="row_0_2_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__http.html" target="_self">Http</a></td><td class="desc">Http client &amp; server <br />
</td></tr>
<tr id="row_0_2_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__rtsp.html" target="_self">RTSP Streaming</a></td><td class="desc"></td></tr>
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__concurrency.html" target="_self">Concurrency</a></td><td class="desc">Multicore support </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__transform.html" target="_self">Converting Streams</a></td><td class="desc">Stream classes which change the input or output </td></tr>
<tr id="row_0_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_5_" class="arrow" onclick="toggleFolder('0_5_')">&#9660;</span><a class="el" href="group__dsp.html" target="_self">DSP</a></td><td class="desc">Digital Signal Processing </td></tr>
<tr id="row_0_5_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__effects.html" target="_self">Effects</a></td><td class="desc">Audio Effects <br />
</td></tr>
<tr id="row_0_5_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__equilizer.html" target="_self">Equilizer</a></td><td class="desc">Digital Equilizer </td></tr>
<tr id="row_0_5_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_5_2_" class="arrow" onclick="toggleFolder('0_5_2_')">&#9660;</span><a class="el" href="group__fft.html" target="_self">FFT</a></td><td class="desc">Fast Fourier Transform <br />
</td></tr>
<tr id="row_0_5_2_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a class="el" href="group__fft-cmsis.html" target="_self">CMSIS</a></td><td class="desc">FFT using CMSIS </td></tr>
<tr id="row_0_5_2_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a class="el" href="group__fft-kiss.html" target="_self">KISS</a></td><td class="desc">FFT using KISS </td></tr>
<tr id="row_0_5_2_2_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a class="el" href="group__fft-real.html" target="_self">Real</a></td><td class="desc">FFT using Real FFT </td></tr>
<tr id="row_0_5_2_3_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a class="el" href="group__fft-dsp.html" target="_self">esp32-dsp</a></td><td class="desc">FFT using esp32 esp-dsp library </td></tr>
<tr id="row_0_5_2_4_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a class="el" href="group__fft-esp32.html" target="_self">esp32-fft</a></td><td class="desc">FFT using esp32-fft </td></tr>
<tr id="row_0_5_3_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__filter.html" target="_self">Filters</a></td><td class="desc">Digital Filters </td></tr>
<tr id="row_0_5_4_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__generator.html" target="_self">Generators</a></td><td class="desc">Sound Generators </td></tr>
<tr id="row_0_5_5_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__volume.html" target="_self">Volume</a></td><td class="desc">Volume Calculations </td></tr>
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__io.html" target="_self">IO</a></td><td class="desc">Input/Output </td></tr>
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_7_" class="arrow" onclick="toggleFolder('0_7_')">&#9660;</span><a class="el" href="group__ml.html" target="_self">Machine Learning</a></td><td class="desc">Artificial Intelligence </td></tr>
<tr id="row_0_7_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__tflite.html" target="_self">TFLite</a></td><td class="desc">Tensorflow </td></tr>
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_8_" class="arrow" onclick="toggleFolder('0_8_')">&#9660;</span><a class="el" href="group__metadata.html" target="_self">Metadata</a></td><td class="desc">Audio Metadata (Title, Author...) </td></tr>
<tr id="row_0_8_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__metadata-icy.html" target="_self">ICY</a></td><td class="desc">Icecast/Shoutcast Metadata </td></tr>
<tr id="row_0_8_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__metadata-id3.html" target="_self">ID3</a></td><td class="desc">Parser for MP3 ID3 <a class="el" href="class_meta.html" title="minimial implementtion of Meta which just ignores the data">Meta</a> Data: The goal is to implement a simple API which provides the title, artist, albmum and the Genre </td></tr>
<tr id="row_0_9_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__platform.html" target="_self">Platform</a></td><td class="desc">Platform specific implementations. Do not use any of theses classes directly and use the related platform independent typedef instead: </td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__player.html" target="_self">Player</a></td><td class="desc">Audio Player </td></tr>
<tr id="row_0_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_11_" class="arrow" onclick="toggleFolder('0_11_')">&#9660;</span><a class="el" href="group__tools.html" target="_self">Tools</a></td><td class="desc">Div Tools </td></tr>
<tr id="row_0_11_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__buffers.html" target="_self">Buffers</a></td><td class="desc">Different Buffer Implementations </td></tr>
<tr id="row_0_11_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__collections.html" target="_self">Collections</a></td><td class="desc">Vector, List, Queue, Stack.. </td></tr>
<tr id="row_0_11_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__convert.html" target="_self">Converters</a></td><td class="desc">Convert Audio You can add a converter as argument to the StreamCopy::copy() or better use is with a ConverterStream </td></tr>
<tr id="row_0_11_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__memorymgmt.html" target="_self">Memory Management</a></td><td class="desc">Allocators and Memory Manager </td></tr>
<tr id="row_0_11_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__string.html" target="_self">Strings</a></td><td class="desc">Strings This framework is avoiding the use of Arduino Strings, so that we can use it easily also on other platforms! </td></tr>
<tr id="row_0_11_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group__timer.html" target="_self">Timers</a></td><td class="desc">Platform independent timer API </td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a class="el" href="group__video.html" target="_self">Video</a></td><td class="desc">Video playback </td></tr>
</table>
</div><!-- directory -->
</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>