mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
150 lines
12 KiB
HTML
150 lines
12 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: BaseConverter 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&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_base_converter.html">BaseConverter</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classaudio__tools_1_1_base_converter-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">BaseConverter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__tools.html">Tools</a> » <a class="el" href="group__convert.html">Converters</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Abstract Base class for Converters A converter is processing the data in the indicated array.
|
|
<a href="classaudio__tools_1_1_base_converter.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_base_converter_8h_source.html">BaseConverter.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BaseConverter:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_base_converter.png" usemap="#BaseConverter_map" alt=""/>
|
|
<map id="BaseConverter_map" name="BaseConverter_map">
|
|
<area href="classaudio__tools_1_1_converter_n_channels.html" alt="ConverterNChannels< T, TF >" shape="rect" coords="232,56,454,80"/>
|
|
<area href="classaudio__tools_1_1_bin.html" title="Provides reduced sampling rates through binning." alt="Bin" shape="rect" coords="232,112,454,136"/>
|
|
<area href="classaudio__tools_1_1_bin_t.html" alt="BinT< T >" shape="rect" coords="232,168,454,192"/>
|
|
<area href="classaudio__tools_1_1_callback_converter_t.html" title="You can provide a lambda expression to conver the data." alt="CallbackConverterT< T >" shape="rect" coords="232,224,454,248"/>
|
|
<area href="classaudio__tools_1_1_channel_avg.html" alt="ChannelAvg" shape="rect" coords="232,280,454,304"/>
|
|
<area href="classaudio__tools_1_1_channel_avg_t.html" title="We average pairs of channels in a datastream. E.g. if we have 4 channels we end up with 2 channels...." alt="ChannelAvgT< T >" shape="rect" coords="232,336,454,360"/>
|
|
<area href="classaudio__tools_1_1_channel_bin_diff.html" title="Provides combination of binning and subtracting channels." alt="ChannelBinDiff" shape="rect" coords="232,392,454,416"/>
|
|
<area href="classaudio__tools_1_1_channel_bin_diff_t.html" title="We first bin the channels then we calculate the difference between pairs of channels in a datastream...." alt="ChannelBinDiffT< T >" shape="rect" coords="232,448,454,472"/>
|
|
<area href="classaudio__tools_1_1_channel_diff.html" alt="ChannelDiff" shape="rect" coords="232,504,454,528"/>
|
|
<area href="classaudio__tools_1_1_channel_diff_t.html" title="We calculate the difference between pairs of channels in a datastream. E.g. if we have 4 channels we ..." alt="ChannelDiffT< T >" shape="rect" coords="232,560,454,584"/>
|
|
<area href="classaudio__tools_1_1_channel_reducer.html" title="We combine a datastream which consists of multiple channels into less channels. E...." alt="ChannelReducer" shape="rect" coords="232,616,454,640"/>
|
|
<area href="classaudio__tools_1_1_channel_reducer_t.html" title="We combine a datastream which consists of multiple channels into less channels. E...." alt="ChannelReducerT< T >" shape="rect" coords="232,672,454,696"/>
|
|
<area href="classaudio__tools_1_1_converter1_channel.html" title="Converter for 1 Channel which applies the indicated Filter." alt="Converter1Channel< T >" shape="rect" coords="232,728,454,752"/>
|
|
<area href="classaudio__tools_1_1_converter_auto_center.html" title="Makes sure that the avg of the signal is set to 0." alt="ConverterAutoCenter" shape="rect" coords="232,784,454,808"/>
|
|
<area href="classaudio__tools_1_1_converter_auto_center_t.html" title="Makes sure that the avg of the signal is set to 0." alt="ConverterAutoCenterT< T >" shape="rect" coords="232,840,454,864"/>
|
|
<area href="classaudio__tools_1_1_converter_fill_left_and_right.html" title="Make sure that both channels contain any data." alt="ConverterFillLeftAndRight< T >" shape="rect" coords="232,896,454,920"/>
|
|
<area href="classaudio__tools_1_1_converter_n_channels.html" title="Converter for n Channels which applies the indicated Filter." alt="ConverterNChannels< T, FT >" shape="rect" coords="232,952,454,976"/>
|
|
<area href="classaudio__tools_1_1_converter_scaler.html" title="Multiplies the values with the indicated factor adds the offset and clips at maxValue...." alt="ConverterScaler< T >" shape="rect" coords="232,1008,454,1032"/>
|
|
<area href="classaudio__tools_1_1_converter_switch_left_and_right.html" title="Switches the left and right channel." alt="ConverterSwitchLeftAndRight< T >" shape="rect" coords="232,1064,454,1088"/>
|
|
<area href="classaudio__tools_1_1_converter_to_internal_d_a_c_format.html" title="special case for internal DAC output, the incomming PCM buffer needs to be converted from signed 16bi..." alt="ConverterToInternalDACFormat< T >" shape="rect" coords="232,1120,454,1144"/>
|
|
<area href="classaudio__tools_1_1_copy_channels.html" title="Copy channel Cx value of type T shifted by S bits to all Cn channels." alt="CopyChannels< T, Cn, Cx, S >" shape="rect" coords="232,1176,454,1200"/>
|
|
<area href="classaudio__tools_1_1_decimate.html" title="Provides a reduced sampling rate by taking a sample at every factor location (ingoring factor-1 sampl..." alt="Decimate" shape="rect" coords="232,1232,454,1256"/>
|
|
<area href="classaudio__tools_1_1_decimate_t.html" title="Provides reduced sampling rates." alt="DecimateT< T >" shape="rect" coords="232,1288,454,1312"/>
|
|
<area href="classaudio__tools_1_1_fade_converter.html" title="converter which does a fade out or fade in." alt="FadeConverter< T >" shape="rect" coords="232,1344,454,1368"/>
|
|
<area href="classaudio__tools_1_1_multi_converter.html" title="Combines multiple converters." alt="MultiConverter< T >" shape="rect" coords="232,1400,454,1424"/>
|
|
<area href="classaudio__tools_1_1_n_o_p_converter.html" title="Dummy converter which does nothing." alt="NOPConverter" shape="rect" coords="232,1456,454,1480"/>
|
|
<area href="classaudio__tools_1_1_popping_sound_remover.html" title="Big value gaps (at the beginning and the end of a recording) can lead to some popping sounds...." alt="PoppingSoundRemover< T >" shape="rect" coords="232,1512,454,1536"/>
|
|
<area href="classaudio__tools_1_1_silence_removal_converter.html" title="Removes any silence from the buffer that is longer then n samples with a amplitude below the indicate..." alt="SilenceRemovalConverter< T >" shape="rect" coords="232,1568,454,1592"/>
|
|
<area href="classaudio__tools_1_1_smooth_transition.html" title="Changes the samples at the beginning or at the end to slowly ramp up the volume." alt="SmoothTransition< T >" shape="rect" coords="232,1624,454,1648"/>
|
|
</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:ab55035f1453457e4ca012d921158e1ec"><td class="memItemLeft" align="right" valign="top"><a id="ab55035f1453457e4ca012d921158e1ec"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BaseConverter</b> (<a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a> const &)=delete</td></tr>
|
|
<tr class="separator:ab55035f1453457e4ca012d921158e1ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5643b574f501fa22f1604e08f1e031f"><td class="memItemLeft" align="right" valign="top"><a id="ae5643b574f501fa22f1604e08f1e031f"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>convert</b> (uint8_t *src, size_t size)=0</td></tr>
|
|
<tr class="separator:ae5643b574f501fa22f1604e08f1e031f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ef7817ddebae64b166c123e2bf92275"><td class="memItemLeft" align="right" valign="top"><a id="a0ef7817ddebae64b166c123e2bf92275"></a>
|
|
<a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a> const &)=delete</td></tr>
|
|
<tr class="separator:a0ef7817ddebae64b166c123e2bf92275"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Abstract Base class for Converters A converter is processing the data in the indicated array. </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><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioTools/<a class="el" href="_base_converter_8h_source.html">BaseConverter.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>
|