Skip to content

Commit 34212d7

Browse files
committed
Deploying to doxygen from @ 4b9104b 🚀
1 parent 5096451 commit 34212d7

11 files changed

+894
-877
lines changed

_audio_streams_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2360,8 +2360,8 @@
23602360
<div class="ttc" id="aclassaudio__tools_1_1_callback_stream_html_ae0807bac7f84b402b0cd29393fc96390"><div class="ttname"><a href="classaudio__tools_1_1_callback_stream.html#ae0807bac7f84b402b0cd29393fc96390">audio_tools::CallbackStream::setStream</a></div><div class="ttdeci">void setStream(Stream &amp;in) override</div><div class="ttdoc">Defines/Changes the input &amp; output.</div><div class="ttdef"><b>Definition</b> AudioStreams.h:1601</div></div>
23612361
<div class="ttc" id="aclassaudio__tools_1_1_callback_stream_html_aee006910b0fa814eeac61cf80907131f"><div class="ttname"><a href="classaudio__tools_1_1_callback_stream.html#aee006910b0fa814eeac61cf80907131f">audio_tools::CallbackStream::CallbackStream</a></div><div class="ttdeci">CallbackStream(Stream &amp;io, size_t(*cb_update)(uint8_t *data, size_t len))</div><div class="ttdef"><b>Definition</b> AudioStreams.h:1494</div></div>
23622362
<div class="ttc" id="aclassaudio__tools_1_1_callback_stream_html_af4e8d27509335897584332ec963fb81d"><div class="ttname"><a href="classaudio__tools_1_1_callback_stream.html#af4e8d27509335897584332ec963fb81d">audio_tools::CallbackStream::setAudioInfoCallback</a></div><div class="ttdeci">void setAudioInfoCallback(void(*cb)(AudioInfo info))</div><div class="ttdoc">defines the callback to receive the actual audio info</div><div class="ttdef"><b>Definition</b> AudioStreams.h:1529</div></div>
2363-
<div class="ttc" id="aclassaudio__tools_1_1_converter_n_channels_html"><div class="ttname"><a href="classaudio__tools_1_1_converter_n_channels.html">audio_tools::ConverterNChannels</a></div><div class="ttdoc">Converter for n Channels which applies the indicated Filter.</div><div class="ttdef"><b>Definition</b> BaseConverter.h:1566</div></div>
2364-
<div class="ttc" id="aclassaudio__tools_1_1_converter_n_channels_html_acd3ea5fe5d4f6e3837e15d1e8eceae20"><div class="ttname"><a href="classaudio__tools_1_1_converter_n_channels.html#acd3ea5fe5d4f6e3837e15d1e8eceae20">audio_tools::ConverterNChannels::setFilter</a></div><div class="ttdeci">void setFilter(int channel, Filter&lt; FT &gt; *filter)</div><div class="ttdoc">defines the filter for an individual channel - the first channel is 0</div><div class="ttdef"><b>Definition</b> BaseConverter.h:1590</div></div>
2363+
<div class="ttc" id="aclassaudio__tools_1_1_converter_n_channels_html"><div class="ttname"><a href="classaudio__tools_1_1_converter_n_channels.html">audio_tools::ConverterNChannels</a></div><div class="ttdoc">Converter for n Channels which applies the indicated Filter.</div><div class="ttdef"><b>Definition</b> BaseConverter.h:1583</div></div>
2364+
<div class="ttc" id="aclassaudio__tools_1_1_converter_n_channels_html_acd3ea5fe5d4f6e3837e15d1e8eceae20"><div class="ttname"><a href="classaudio__tools_1_1_converter_n_channels.html#acd3ea5fe5d4f6e3837e15d1e8eceae20">audio_tools::ConverterNChannels::setFilter</a></div><div class="ttdeci">void setFilter(int channel, Filter&lt; FT &gt; *filter)</div><div class="ttdoc">defines the filter for an individual channel - the first channel is 0</div><div class="ttdef"><b>Definition</b> BaseConverter.h:1607</div></div>
23652365
<div class="ttc" id="aclassaudio__tools_1_1_converter_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_converter_stream.html">audio_tools::ConverterStream</a></div><div class="ttdoc">Both the data of the read or write operations will be converted with the help of the indicated conver...</div><div class="ttdef"><b>Definition</b> AudioStreams.h:649</div></div>
23662366
<div class="ttc" id="aclassaudio__tools_1_1_converter_stream_html_a4ea3110016f67d3dcb9793fcae72288f"><div class="ttname"><a href="classaudio__tools_1_1_converter_stream.html#a4ea3110016f67d3dcb9793fcae72288f">audio_tools::ConverterStream::setStream</a></div><div class="ttdeci">void setStream(Stream &amp;stream)</div><div class="ttdoc">Defines/Changes the input &amp; output.</div><div class="ttdef"><b>Definition</b> AudioStreams.h:665</div></div>
23672367
<div class="ttc" id="aclassaudio__tools_1_1_converter_stream_html_ae1220e7e3542f5a84c21fe2f7cef194c"><div class="ttname"><a href="classaudio__tools_1_1_converter_stream.html#ae1220e7e3542f5a84c21fe2f7cef194c">audio_tools::ConverterStream::setOutput</a></div><div class="ttdeci">void setOutput(Print &amp;out)</div><div class="ttdoc">Defines/Changes the output target.</div><div class="ttdef"><b>Definition</b> AudioStreams.h:671</div></div>

_base_converter_8h_source.html

Lines changed: 873 additions & 856 deletions
Large diffs are not rendered by default.

_base_stream_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -801,7 +801,7 @@
801801
<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_ad83053371f5afc622b82660e8bee750f"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#ad83053371f5afc622b82660e8bee750f">audio_tools::RingBuffer::isFull</a></div><div class="ttdeci">virtual bool isFull() override</div><div class="ttdoc">checks if the buffer is full</div><div class="ttdef"><b>Definition</b> Buffers.h:386</div></div>
802802
<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_af7294f0869fe98b8281bdc829883445d"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#af7294f0869fe98b8281bdc829883445d">audio_tools::RingBuffer::resize</a></div><div class="ttdeci">virtual bool resize(int len)</div><div class="ttdoc">Resizes the buffer if supported: returns false if not supported.</div><div class="ttdef"><b>Definition</b> Buffers.h:418</div></div>
803803
<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_afbb59a2f946191d7cf2a5c0a00b29ec2"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#afbb59a2f946191d7cf2a5c0a00b29ec2">audio_tools::RingBuffer::available</a></div><div class="ttdeci">virtual int available() override</div><div class="ttdoc">provides the number of entries that are available to read</div><div class="ttdef"><b>Definition</b> Buffers.h:410</div></div>
804-
<div class="ttc" id="aclassaudio__tools_1_1_smooth_transition_html"><div class="ttname"><a href="classaudio__tools_1_1_smooth_transition.html">audio_tools::SmoothTransition</a></div><div class="ttdoc">Changes the samples at the beginning or at the end to slowly ramp up the volume.</div><div class="ttdef"><b>Definition</b> BaseConverter.h:1768</div></div>
804+
<div class="ttc" id="aclassaudio__tools_1_1_smooth_transition_html"><div class="ttname"><a href="classaudio__tools_1_1_smooth_transition.html">audio_tools::SmoothTransition</a></div><div class="ttdoc">Changes the samples at the beginning or at the end to slowly ramp up the volume.</div><div class="ttdef"><b>Definition</b> BaseConverter.h:1785</div></div>
805805
<div class="ttc" id="aclassaudio__tools_1_1_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_stream.html">audio_tools::Stream</a></div><div class="ttdef"><b>Definition</b> NoArduino.h:142</div></div>
806806
<div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector</a></div><div class="ttdoc">Vector implementation which provides the most important methods as defined by std::vector....</div><div class="ttdef"><b>Definition</b> Vector.h:21</div></div>
807807
<div class="ttc" id="anamespaceaudio__tools_html"><div class="ttname"><a href="namespaceaudio__tools.html">audio_tools</a></div><div class="ttdoc">Generic Implementation of sound input and output for desktop environments using portaudio.</div><div class="ttdef"><b>Definition</b> AudioCodecsBase.h:10</div></div>

_codec_a_a_c_helix_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@
223223
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> baseInfo.<a class="code hl_variable" href="structaudio__tools_1_1_audio_info.html#a0e86c53dfa0ad5dc0d2ecd0304fabc95">sample_rate</a> = i.sampRateOut;</div>
224224
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> baseInfo.<a class="code hl_variable" href="structaudio__tools_1_1_audio_info.html#aa65c89fa8336bfdc4f8d916d9d415a9f">bits_per_sample</a> = i.bitsPerSample;</div>
225225
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="comment">// p_helix-&gt;audioChangeAACHelix-&gt;setAudioInfo(baseInfo);</span></div>
226-
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> LOGW(<span class="stringliteral">&quot;sample_rate: %d&quot;</span>, i.sampRateOut);</div>
226+
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> LOGW(<span class="stringliteral">&quot;sample_rate: %d / channels: %d&quot;</span>, i.sampRateOut, i.nChans);</div>
227227
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> p_helix-&gt;<a class="code hl_function" href="classaudio__tools_1_1_a_a_c_decoder_helix.html#ad1fdd56031f1195cb221ab855fb6a102">setAudioInfo</a>(baseInfo);</div>
228228
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> }</div>
229229
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> }</div>

classaudio__tools_1_1_base_converter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<area href="classaudio__tools_1_1_bin_t.html" alt="BinT&lt; T &gt;" shape="rect" coords="232,280,454,304"/>
9898
<area href="classaudio__tools_1_1_callback_converter_t.html" title="You can provide a lambda expression to convert the data." alt="CallbackConverterT&lt; T &gt;" shape="rect" coords="232,336,454,360"/>
9999
<area href="classaudio__tools_1_1_channel_avg.html" title="We average pairs of channels in a datastream. E.g. if we have 4 channels we end up with 2 channels...." alt="ChannelAvg" shape="rect" coords="232,392,454,416"/>
100-
<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&lt; T &gt;" shape="rect" coords="232,448,454,472"/>
100+
<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&lt; T, AvgT &gt;" shape="rect" coords="232,448,454,472"/>
101101
<area href="classaudio__tools_1_1_channel_bin_diff.html" title="Provides combination of binning and subtracting channels." alt="ChannelBinDiff" shape="rect" coords="232,504,454,528"/>
102102
<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&lt; T &gt;" shape="rect" coords="232,560,454,584"/>
103103
<area href="classaudio__tools_1_1_channel_diff.html" alt="ChannelDiff" shape="rect" coords="232,616,454,640"/>
52 Bytes
Loading

classaudio__tools_1_1_channel_avg_t-members.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,17 @@
7373
</div>
7474
</div><!-- top -->
7575
<div class="header">
76-
<div class="headertitle"><div class="title">ChannelAvgT&lt; T &gt; Member List</div></div>
76+
<div class="headertitle"><div class="title">ChannelAvgT&lt; T, AvgT &gt; Member List</div></div>
7777
</div><!--header-->
7878
<div class="contents">
7979

80-
<p>This is the complete list of members for <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a>, including all inherited members.</p>
80+
<p>This is the complete list of members for <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a>, including all inherited members.</p>
8181
<table class="directory">
8282
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>BaseConverter</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a></td><td class="entry"></td></tr>
8383
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>BaseConverter</b>(BaseConverter const &amp;)=delete (defined in <a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a></td><td class="entry"></td></tr>
84-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ChannelAvgT</b>() (defined in <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
85-
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>convert</b>(uint8_t *src, size_t size) override (defined in <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
86-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>convert</b>(uint8_t *target, uint8_t *src, size_t size) (defined in <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
84+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ChannelAvgT</b>() (defined in <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
85+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>convert</b>(uint8_t *src, size_t size) override (defined in <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
86+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>convert</b>(uint8_t *target, uint8_t *src, size_t size) (defined in <a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_channel_avg_t.html">ChannelAvgT&lt; T, AvgT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
8787
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>operator=</b>(BaseConverter const &amp;)=delete (defined in <a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a></td><td class="entry"></td></tr>
8888
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~BaseConverter</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_base_converter.html">BaseConverter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
8989
</table></div><!-- contents -->

classaudio__tools_1_1_channel_avg_t.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
66
<meta name="generator" content="Doxygen 1.9.8"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>arduino-audio-tools: ChannelAvgT&lt; T &gt; Class Template Reference</title>
8+
<title>arduino-audio-tools: ChannelAvgT&lt; T, AvgT &gt; Class Template Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
@@ -76,7 +76,7 @@
7676
<div class="summary">
7777
<a href="#pub-methods">Public Member Functions</a> &#124;
7878
<a href="classaudio__tools_1_1_channel_avg_t-members.html">List of all members</a> </div>
79-
<div class="headertitle"><div class="title">ChannelAvgT&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__tools.html">Tools</a> &raquo; <a class="el" href="group__convert.html">Converters</a></div></div></div>
79+
<div class="headertitle"><div class="title">ChannelAvgT&lt; T, AvgT &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__tools.html">Tools</a> &raquo; <a class="el" href="group__convert.html">Converters</a></div></div></div>
8080
</div><!--header-->
8181
<div class="contents">
8282

@@ -85,12 +85,12 @@
8585

8686
<p><code>#include &lt;<a class="el" href="_base_converter_8h_source.html">BaseConverter.h</a>&gt;</code></p>
8787
<div class="dynheader">
88-
Inheritance diagram for ChannelAvgT&lt; T &gt;:</div>
88+
Inheritance diagram for ChannelAvgT&lt; T, AvgT &gt;:</div>
8989
<div class="dyncontent">
9090
<div class="center">
91-
<img src="classaudio__tools_1_1_channel_avg_t.png" usemap="#ChannelAvgT_3C_20T_20_3E_map" alt=""/>
92-
<map id="ChannelAvgT_3C_20T_20_3E_map" name="ChannelAvgT_3C_20T_20_3E_map">
93-
<area href="classaudio__tools_1_1_base_converter.html" title="Abstract Base class for Converters A converter is processing the data in the indicated array." alt="BaseConverter" shape="rect" coords="0,0,120,24"/>
91+
<img src="classaudio__tools_1_1_channel_avg_t.png" usemap="#ChannelAvgT_3C_20T_2C_20AvgT_20_3E_map" alt=""/>
92+
<map id="ChannelAvgT_3C_20T_2C_20AvgT_20_3E_map" name="ChannelAvgT_3C_20T_2C_20AvgT_20_3E_map">
93+
<area href="classaudio__tools_1_1_base_converter.html" title="Abstract Base class for Converters A converter is processing the data in the indicated array." alt="BaseConverter" shape="rect" coords="0,0,159,24"/>
9494
</map>
9595
</div></div>
9696
<table class="memberdecls">
@@ -103,8 +103,8 @@
103103
<tr class="separator:ab42262038579ccc4e2b40cbbd4034847"><td class="memSeparator" colspan="2">&#160;</td></tr>
104104
</table>
105105
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
106-
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T = int16_t&gt;<br />
107-
class audio_tools::ChannelAvgT&lt; T &gt;</div><p>We average pairs of channels in a datastream. E.g. if we have 4 channels we end up with 2 channels. The channels will be (channel_1 + channel_2)/2 (channel_3 - channel_4)/2. This is equivalent of stereo to mono conversion but will also work for quadric, sexic or octic audio. This will not work if you provide single channel data! </p>
106+
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T = int16_t, typename AvgT = float&gt;<br />
107+
class audio_tools::ChannelAvgT&lt; T, AvgT &gt;</div><p>We average pairs of channels in a datastream. E.g. if we have 4 channels we end up with 2 channels. The channels will be (channel_1 + channel_2)/2 (channel_3 - channel_4)/2. This is equivalent of stereo to mono conversion but will also work for quadric, sexic or octic audio. This will not work if you provide single channel data! </p>
108108
<dl class="section author"><dt>Author</dt><dd>Urs Utzinger</dd></dl>
109109
<dl class="tparams"><dt>Template Parameters</dt><dd>
110110
<table class="tparams">
@@ -119,7 +119,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9f22cb9d0b657ed5e0c60120
119119
<div class="memitem">
120120
<div class="memproto">
121121
<div class="memtemplate">
122-
template&lt;typename T = int16_t&gt; </div>
122+
template&lt;typename T = int16_t, typename AvgT = float&gt; </div>
123123
<table class="mlabels">
124124
<tr>
125125
<td class="mlabels-left">
91 Bytes
Loading

0 commit comments

Comments
 (0)