Skip to content

Commit

Permalink
Deploying to doxygen from @ a1ecd88 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Oct 3, 2024
1 parent 538600b commit 9cb2636
Show file tree
Hide file tree
Showing 134 changed files with 3,291 additions and 3,250 deletions.
2 changes: 1 addition & 1 deletion _codec_helix_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_decoder_helix_html_afef1e91be11d5791ae90f522b46db3d7"><div class="ttname"><a href="classaudio__tools_1_1_decoder_helix.html#afef1e91be11d5791ae90f522b46db3d7">audio_tools::DecoderHelix::resetDecoder</a></div><div class="ttdeci">void resetDecoder()</div><div class="ttdoc">Deletes the decoder.</div><div class="ttdef"><b>Definition:</b> CodecHelix.h:101</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_m_p3_decoder_helix_html"><div class="ttname"><a href="classaudio__tools_1_1_m_p3_decoder_helix.html">audio_tools::MP3DecoderHelix</a></div><div class="ttdoc">MP3 Decoder using libhelix: https://github.com/pschatzmann/arduino-libhelix This is basically just a ...</div><div class="ttdef"><b>Definition:</b> CodecMP3Helix.h:17</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_print_html"><div class="ttname"><a href="classaudio__tools_1_1_print.html">audio_tools::Print</a></div><div class="ttdef"><b>Definition:</b> NoArduino.h:58</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_decoder.html">audio_tools::WAVDecoder</a></div><div class="ttdoc">A simple WAVDecoder: We parse the header data on the first record to determine the format....</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:245</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_decoder_html"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_decoder.html">audio_tools::WAVDecoder</a></div><div class="ttdoc">A simple WAVDecoder: We parse the header data on the first record to determine the format....</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:263</div></div>
<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> AnalogAudioArduino.h:12</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:50</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
973 changes: 497 additions & 476 deletions _codec_w_a_v_8h_source.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions _jupyter_audio_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,8 @@
<div class="ttc" id="aclassaudio__tools_1_1_jupyter_audio_t_html_a78cb84ad6d022a3d5f1b4267c4150b82"><div class="ttname"><a href="classaudio__tools_1_1_jupyter_audio_t.html#a78cb84ad6d022a3d5f1b4267c4150b82">audio_tools::JupyterAudioT::audioInfo</a></div><div class="ttdeci">AudioInfo audioInfo()</div><div class="ttdoc">provides the actual input AudioInfo</div><div class="ttdef"><b>Definition:</b> JupyterAudio.h:181</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_print_html"><div class="ttname"><a href="classaudio__tools_1_1_print.html">audio_tools::Print</a></div><div class="ttdef"><b>Definition:</b> NoArduino.h:58</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_stream_copy_t_html"><div class="ttname"><a href="classaudio__tools_1_1_stream_copy_t.html">audio_tools::StreamCopyT</a></div><div class="ttdoc">Typed Stream Copy which supports the conversion from channel to 2 channels. We make sure that we allw...</div><div class="ttdef"><b>Definition:</b> StreamCopy.h:23</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_encoder_html"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_encoder.html">audio_tools::WAVEncoder</a></div><div class="ttdoc">A simple WAV file encoder. If no AudioEncoderExt is specified the WAV file contains PCM data,...</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:440</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_encoder_html_accee684614189e73bdc9f1b2f7abf919"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_encoder.html#accee684614189e73bdc9f1b2f7abf919">audio_tools::WAVEncoder::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo from) override</div><div class="ttdoc">Update actual WAVAudioInfo.</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:484</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_encoder_html"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_encoder.html">audio_tools::WAVEncoder</a></div><div class="ttdoc">A simple WAV file encoder. If no AudioEncoderExt is specified the WAV file contains PCM data,...</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:461</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_w_a_v_encoder_html_accee684614189e73bdc9f1b2f7abf919"><div class="ttname"><a href="classaudio__tools_1_1_w_a_v_encoder.html#accee684614189e73bdc9f1b2f7abf919">audio_tools::WAVEncoder::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo from) override</div><div class="ttdoc">Update actual WAVAudioInfo.</div><div class="ttdef"><b>Definition:</b> CodecWAV.h:505</div></div>
<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> AnalogAudioArduino.h:12</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html">audio_tools::AudioInfo</a></div><div class="ttdoc">Basic Audio information which drives e.g. I2S.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:50</div></div>
<div class="ttc" id="astructaudio__tools_1_1_audio_info_html_a1ac7822956f57069d76da865d6b33c55"><div class="ttname"><a href="structaudio__tools_1_1_audio_info.html#a1ac7822956f57069d76da865d6b33c55">audio_tools::AudioInfo::channels</a></div><div class="ttdeci">uint16_t channels</div><div class="ttdoc">Number of channels: 2=stereo, 1=mono.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:55</div></div>
Expand Down
10 changes: 6 additions & 4 deletions classaudio__tools_1_1_w_a_v_header-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,15 @@
<p>This is the complete list of members for <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#af8e73b9ee5e107a8f2636b6efc0f3572">audioInfo</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>buffer</b> (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>clear</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>data_pos</b> (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#a946aef1a9634871bd728edb663075543">available</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>buffer</b> (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>clear</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>data_pos</b> (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>dumpHeader</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>eof</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>getChar</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getChar32</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>getDataPos</b>() (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#aa8bc0569dd2138e78f70047664dcee74">getDataPos</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>headerInfo</b> (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>indexOf</b>(const char *str) (defined in <a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#a1ff465571c87cad9bcbfcfd1d573b7d2">isDataComplete</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html">WAVHeader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
Expand Down
14 changes: 11 additions & 3 deletions classaudio__tools_1_1_w_a_v_header.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,23 @@
<a class="el" href="structaudio__tools_1_1_w_a_v_audio_info.html">WAVAudioInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#af8e73b9ee5e107a8f2636b6efc0f3572">audioInfo</a> ()</td></tr>
<tr class="memdesc:af8e73b9ee5e107a8f2636b6efc0f3572"><td class="mdescLeft">&#160;</td><td class="mdescRight">provides the info from the header <br /></td></tr>
<tr class="separator:af8e73b9ee5e107a8f2636b6efc0f3572"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a946aef1a9634871bd728edb663075543"><td class="memItemLeft" align="right" valign="top"><a id="a946aef1a9634871bd728edb663075543"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#a946aef1a9634871bd728edb663075543">available</a> ()</td></tr>
<tr class="memdesc:a946aef1a9634871bd728edb663075543"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of bytes available in the header buffer <br /></td></tr>
<tr class="separator:a946aef1a9634871bd728edb663075543"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a id="ac8bb3912a3ce86b15842e79d0b421204"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af74dcc31853ed58e41323c6a6f51ebf0"><td class="memItemLeft" align="right" valign="top"><a id="af74dcc31853ed58e41323c6a6f51ebf0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>dumpHeader</b> ()</td></tr>
<tr class="separator:af74dcc31853ed58e41323c6a6f51ebf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8bc0569dd2138e78f70047664dcee74"><td class="memItemLeft" align="right" valign="top"><a id="aa8bc0569dd2138e78f70047664dcee74"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getDataPos</b> ()</td></tr>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#aa8bc0569dd2138e78f70047664dcee74">getDataPos</a> ()</td></tr>
<tr class="memdesc:aa8bc0569dd2138e78f70047664dcee74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the data start position using the data tag. <br /></td></tr>
<tr class="separator:aa8bc0569dd2138e78f70047664dcee74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ff465571c87cad9bcbfcfd1d573b7d2"><td class="memItemLeft" align="right" valign="top"><a id="a1ff465571c87cad9bcbfcfd1d573b7d2"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#a1ff465571c87cad9bcbfcfd1d573b7d2">isDataComplete</a> ()</td></tr>
<tr class="memdesc:a1ff465571c87cad9bcbfcfd1d573b7d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the header is complete (with 44 bytes): contains data + 4 byte len. <br /></td></tr>
<tr class="memdesc:a1ff465571c87cad9bcbfcfd1d573b7d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the header is complete (containd data tag) <br /></td></tr>
<tr class="separator:a1ff465571c87cad9bcbfcfd1d573b7d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e17a5c9f8b518e6aea8ba0adb9113c4"><td class="memItemLeft" align="right" valign="top"><a id="a1e17a5c9f8b518e6aea8ba0adb9113c4"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_w_a_v_header.html#a1e17a5c9f8b518e6aea8ba0adb9113c4">parse</a> ()</td></tr>
Expand Down Expand Up @@ -170,7 +178,7 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aaf0eef2d94f5e586b3d7cd5935560e29"><td class="memItemLeft" align="right" valign="top"><a id="aaf0eef2d94f5e586b3d7cd5935560e29"></a>
<a class="el" href="classaudio__tools_1_1_single_buffer.html">SingleBuffer</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>buffer</b> { 50 }</td></tr>
<a class="el" href="classaudio__tools_1_1_single_buffer.html">SingleBuffer</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>buffer</b> { 200 }</td></tr>
<tr class="separator:aaf0eef2d94f5e586b3d7cd5935560e29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2467a0f6fad2dbbfabb5b429fa91710"><td class="memItemLeft" align="right" valign="top"><a id="af2467a0f6fad2dbbfabb5b429fa91710"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>data_pos</b> = 0</td></tr>
Expand Down
5 changes: 3 additions & 2 deletions functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ <h3><a id="index_a"></a>- a -</h3><ul>
: <a class="el" href="classaudio__tools_1_1_audio_source_idx_s_d.html#a39194a0faaa356de2529179d83854545">AudioSourceIdxSD</a>
</li>
<li>AudioSourceIdxSDFAT()
: <a class="el" href="classaudio__tools_1_1_audio_source_idx_s_d_f_a_t.html#af0819db3887b8a336e45ff0dc156f7dc">AudioSourceIdxSDFAT</a>
: <a class="el" href="classaudio__tools_1_1_audio_source_idx_s_d_f_a_t.html#aa93d3c8fec79725f28c9adf68aeb5c78">AudioSourceIdxSDFAT</a>
</li>
<li>AudioSourceIdxSDMMC()
: <a class="el" href="classaudio__tools_1_1_audio_source_idx_s_d_m_m_c.html#ad7406c44c13168206a2f072a5c27d123">AudioSourceIdxSDMMC</a>
Expand Down Expand Up @@ -385,6 +385,7 @@ <h3><a id="index_a"></a>- a -</h3><ul>
, <a class="el" href="classaudio__tools_1_1_variable_speed_ring_buffer.html#a512cfced3ab951dde7a9a78f1274fe63">VariableSpeedRingBuffer&lt; T &gt;</a>
, <a class="el" href="classaudio__tools_1_1_variable_speed_ring_buffer_simple.html#a512cfced3ab951dde7a9a78f1274fe63">VariableSpeedRingBufferSimple&lt; T &gt;</a>
, <a class="el" href="classaudio__tools_1_1_volume_stream.html#afbb59a2f946191d7cf2a5c0a00b29ec2">VolumeStream</a>
, <a class="el" href="classaudio__tools_1_1_w_a_v_header.html#a946aef1a9634871bd728edb663075543">WAVHeader</a>
</li>
<li>availableBytes()
: <a class="el" href="classaudio__tools_1_1_input_mixer.html#a901b9bd204a4845e3e7e61ad47ef81a2">InputMixer&lt; T &gt;</a>
Expand All @@ -402,7 +403,7 @@ <h3><a id="index_a"></a>- a -</h3><ul>
, <a class="el" href="classaudio__tools_1_1_i2_s_stream.html#a6ff0d6d1b0f3f9b652c9d5298ed0863c">I2SStream</a>
, <a class="el" href="classaudio__tools_1_1_measuring_stream.html#a6ff0d6d1b0f3f9b652c9d5298ed0863c">MeasuringStream</a>
, <a class="el" href="classaudio__tools_1_1_n_buffer.html#a86aa7db83a28e2662e01c57a36681cb0">NBuffer&lt; T &gt;</a>
, <a class="el" href="classaudio__tools_1_1_output_mixer.html#ad19e788ef2c620faad7b476ad50d7fd8">OutputMixer&lt; T &gt;</a>
, <a class="el" href="classaudio__tools_1_1_output_mixer.html#a87b51853b7bf1bc90d9efa9f3b8d4fea">OutputMixer&lt; T &gt;</a>
, <a class="el" href="classaudio__tools_1_1_progress_stream.html#a6ff0d6d1b0f3f9b652c9d5298ed0863c">ProgressStream</a>
, <a class="el" href="classaudio__tools_1_1_ring_buffer.html#a473a08fbb41a997860a55213bc367d44">RingBuffer&lt; T &gt;</a>
, <a class="el" href="classaudio__tools_1_1_ring_buffer_file.html#a87b51853b7bf1bc90d9efa9f3b8d4fea">RingBufferFile&lt; File, T &gt;</a>
Expand Down
Loading

0 comments on commit 9cb2636

Please sign in to comment.