Skip to content

Commit

Permalink
Deploying to doxygen from @ 2053bd6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Oct 18, 2024
1 parent cd5bc7a commit 4d36db1
Show file tree
Hide file tree
Showing 17 changed files with 563 additions and 554 deletions.
2 changes: 1 addition & 1 deletion _codec_g_g_wave_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_audio_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_decoder.html">audio_tools::AudioDecoder</a></div><div class="ttdoc">Docoding of encoded audio into PCM data.</div><div class="ttdef"><b>Definition:</b> AudioCodecsBase.h:16</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_encoder_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_encoder.html">audio_tools::AudioEncoder</a></div><div class="ttdoc">Encoding of PCM data.</div><div class="ttdef"><b>Definition:</b> AudioCodecsBase.h:86</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_fast_sine_generator_html"><div class="ttname"><a href="classaudio__tools_1_1_fast_sine_generator.html">audio_tools::FastSineGenerator&lt; int16_t &gt;</a></div></div>
<div class="ttc" id="aclassaudio__tools_1_1_fast_sine_generator_html_a45b168302ee30ce87241d8987e5f9adf"><div class="ttname"><a href="classaudio__tools_1_1_fast_sine_generator.html#a45b168302ee30ce87241d8987e5f9adf">audio_tools::FastSineGenerator::readSample</a></div><div class="ttdeci">virtual T readSample() override</div><div class="ttdoc">Provides a single sample.</div><div class="ttdef"><b>Definition:</b> SoundGenerator.h:265</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_fast_sine_generator_html_a45b168302ee30ce87241d8987e5f9adf"><div class="ttname"><a href="classaudio__tools_1_1_fast_sine_generator.html#a45b168302ee30ce87241d8987e5f9adf">audio_tools::FastSineGenerator::readSample</a></div><div class="ttdeci">virtual T readSample() override</div><div class="ttdoc">Provides a single sample.</div><div class="ttdef"><b>Definition:</b> SoundGenerator.h:240</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_g_g_wave_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_g_g_wave_decoder.html">audio_tools::GGWaveDecoder</a></div><div class="ttdoc">GGWaveDecoder: Translates audio into text Codec using https://github.com/ggerganov/ggwave-arduino.</div><div class="ttdef"><b>Definition:</b> CodecGGWave.h:36</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_g_g_wave_decoder_html_a0896777c04c7abdcbf62db66e73027b9"><div class="ttname"><a href="classaudio__tools_1_1_g_g_wave_decoder.html#a0896777c04c7abdcbf62db66e73027b9">audio_tools::GGWaveDecoder::setProtocols</a></div><div class="ttdeci">void setProtocols(ggwave_ProtocolId protocolsArray[N])</div><div class="ttdoc">Activate multiple protocols.</div><div class="ttdef"><b>Definition:</b> CodecGGWave.h:53</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_g_g_wave_decoder_html_a2b485ba5b9d96f94384f4a3840f84314"><div class="ttname"><a href="classaudio__tools_1_1_g_g_wave_decoder.html#a2b485ba5b9d96f94384f4a3840f84314">audio_tools::GGWaveDecoder::isResultPCM</a></div><div class="ttdeci">virtual bool isResultPCM()</div><div class="ttdoc">Returns true to indicate that the decoding result is PCM data.</div><div class="ttdef"><b>Definition:</b> CodecGGWave.h:138</div></div>
Expand Down
1,041 changes: 521 additions & 520 deletions _sound_generator_8h_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@
<tr id="row_0_446_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_r_t_s_p_p_c_m_audio_info.html" target="_self">RTSPPCMAudioInfo</a></td><td class="desc">PCMInfo subclass which provides the audio information from the <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> parameter </td></tr>
<tr id="row_0_447_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_r_t_s_p_source_from_audio_stream.html" target="_self">RTSPSourceFromAudioStream</a></td><td class="desc">Simple Facade which can turn <a class="el" 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...">AudioStream</a> into a IAudioSource. This way we can e.g. use an <a class="el" href="classaudio__tools_1_1_i2_s_stream.html" title="We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...">I2SStream</a> as source to stream data Depends on the <a href="https://github.com/pschatzmann/Micro-RTSP-Audio/">https://github.com/pschatzmann/Micro-RTSP-Audio/</a> library </td></tr>
<tr id="row_0_448_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_r_t_s_p_source_stream.html" target="_self">RTSPSourceStream</a></td><td class="desc">Simple Facade which can turn any <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> into a IAudioSource. This way we can e.g. use an <a class="el" href="classaudio__tools_1_1_i2_s_stream.html" title="We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...">I2SStream</a> as source to stream data Depends on the <a href="https://github.com/pschatzmann/Micro-RTSP-Audio/">https://github.com/pschatzmann/Micro-RTSP-Audio/</a> library </td></tr>
<tr id="row_0_449_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_saw_tooth_generator.html" target="_self">SawToothGenerator</a></td><td class="desc">Sine wave which is based on a fast approximation function </td></tr>
<tr id="row_0_449_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_saw_tooth_generator.html" target="_self">SawToothGenerator</a></td><td class="desc"><a class="el" href="classaudio__tools_1_1_saw_tooth_generator.html" title="SawToothGenerator.">SawToothGenerator</a> </td></tr>
<tr id="row_0_450_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_b_c_decoder.html" target="_self">SBCDecoder</a></td><td class="desc">Decoder for SBC. Depends on <a href="https://github.com/pschatzmann/arduino-libsbc">https://github.com/pschatzmann/arduino-libsbc</a>. Inspired by sbcdec.c </td></tr>
<tr id="row_0_451_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_b_c_encoder.html" target="_self">SBCEncoder</a></td><td class="desc">Encoder for SBC - Depends on <a href="https://github.com/pschatzmann/arduino-libsbc">https://github.com/pschatzmann/arduino-libsbc</a>. Inspired by sbcenc.c </td></tr>
<tr id="row_0_452_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_scaled_parameter.html" target="_self">ScaledParameter</a></td><td class="desc">Scales a dynamic parameter to the indicated range </td></tr>
Expand Down
5 changes: 3 additions & 2 deletions classaudio__tools_1_1_fast_sine_generator.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,9 @@
<div class="center">
<img src="classaudio__tools_1_1_fast_sine_generator.png" usemap="#FastSineGenerator_3C_20T_20_3E_map" alt=""/>
<map id="FastSineGenerator_3C_20T_20_3E_map" name="FastSineGenerator_3C_20T_20_3E_map">
<area href="classaudio__tools_1_1_sine_wave_generator.html" title="Generates a Sound with the help of sin() function. If you plan to change the amplitude or frequency (..." alt="SineWaveGenerator&lt; T &gt;" shape="rect" coords="0,56,157,80"/>
<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,157,24"/>
<area href="classaudio__tools_1_1_sine_wave_generator.html" title="Generates a Sound with the help of sin() function. If you plan to change the amplitude or frequency (..." alt="SineWaveGenerator&lt; T &gt;" shape="rect" coords="0,56,172,80"/>
<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,172,24"/>
<area href="classaudio__tools_1_1_square_wave_generator.html" title="Generates a square wave sound." alt="SquareWaveGenerator&lt; T &gt;" shape="rect" coords="0,168,172,192"/>
</map>
</div></div>
<table class="memberdecls">
Expand Down
Binary file modified classaudio__tools_1_1_fast_sine_generator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions classaudio__tools_1_1_saw_tooth_generator.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
</div><!--header-->
<div class="contents">

<p>Sine wave which is based on a fast approximation function.
<p><a class="el" href="classaudio__tools_1_1_saw_tooth_generator.html" title="SawToothGenerator.">SawToothGenerator</a>.
<a href="classaudio__tools_1_1_saw_tooth_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>
Expand Down Expand Up @@ -194,8 +194,8 @@
<div class="textblock"><h3>template&lt;class T&gt;<br />
class audio_tools::SawToothGenerator&lt; T &gt;</h3>

<p>Sine wave which is based on a fast approximation function. </p>
<dl class="section author"><dt>Author</dt><dd>Vivian Leigh Stewart </dd></dl>
<p><a class="el" href="classaudio__tools_1_1_saw_tooth_generator.html" title="SawToothGenerator.">SawToothGenerator</a>. </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">
Expand Down
6 changes: 3 additions & 3 deletions classaudio__tools_1_1_sine_wave_generator.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@
<div class="center">
<img src="classaudio__tools_1_1_sine_wave_generator.png" usemap="#SineWaveGenerator_3C_20T_20_3E_map" alt=""/>
<map id="SineWaveGenerator_3C_20T_20_3E_map" name="SineWaveGenerator_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="283,0,462,24"/>
<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="189,0,368,24"/>
<area href="classaudio__tools_1_1_fast_sine_generator.html" alt="FastSineGenerator&lt; int16_t &gt;" shape="rect" coords="0,112,179,136"/>
<area href="classaudio__tools_1_1_fast_sine_generator.html" title="Sine wave which is based on a fast approximation function." alt="FastSineGenerator&lt; T &gt;" shape="rect" coords="189,112,368,136"/>
<area href="classaudio__tools_1_1_saw_tooth_generator.html" title="Sine wave which is based on a fast approximation function." alt="SawToothGenerator&lt; T &gt;" shape="rect" coords="378,112,557,136"/>
<area href="classaudio__tools_1_1_square_wave_generator.html" title="Generates a square wave sound." alt="SquareWaveGenerator&lt; T &gt;" shape="rect" coords="567,112,746,136"/>
<area href="classaudio__tools_1_1_saw_tooth_generator.html" title="SawToothGenerator." alt="SawToothGenerator&lt; T &gt;" shape="rect" coords="378,112,557,136"/>
<area href="classaudio__tools_1_1_square_wave_generator.html" title="Generates a square wave sound." alt="SquareWaveGenerator&lt; T &gt;" shape="rect" coords="189,168,368,192"/>
</map>
</div></div>
<table class="memberdecls">
Expand Down
Binary file modified classaudio__tools_1_1_sine_wave_generator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4d36db1

Please sign in to comment.