Skip to content

Commit

Permalink
Deploying to doxygen from @ d5d1b90 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Oct 12, 2023
1 parent c6a5594 commit 86c2f7d
Show file tree
Hide file tree
Showing 173 changed files with 4,968 additions and 3,965 deletions.
12 changes: 6 additions & 6 deletions _analog_audio_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#a64e9fa75beda50a9e8400ee0d4e61984">end</a>();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#ac4b262f441e13eb8054c879d9dd57edd"> 31</a></span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#ac4b262f441e13eb8054c879d9dd57edd">defaultConfig</a>(<a class="code" href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">RxTxMode</a> mode=TX_MODE) {</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#ac4b262f441e13eb8054c879d9dd57edd"> 31</a></span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#ac4b262f441e13eb8054c879d9dd57edd">defaultConfig</a>(<a class="code" href="group__basic.html#ga8cbd91a8bac9b5ab425112be1620eb49">RxTxMode</a> mode=TX_MODE) {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; TRACED();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> config(mode);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> config(mode);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> config;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
Expand All @@ -112,7 +112,7 @@
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#acba365cc28eb702040c382646cfb0a7a">begin</a>(adc_config);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#a5b57d1fefbbb011e8e8672dcc6750895"> 58</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#a5b57d1fefbbb011e8e8672dcc6750895">begin</a>(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> cfg) {</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#a5b57d1fefbbb011e8e8672dcc6750895"> 58</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#a5b57d1fefbbb011e8e8672dcc6750895">begin</a>(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> cfg) {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; TRACEI();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> analog.begin(cfg);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div>
Expand All @@ -127,7 +127,7 @@
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">// analog.setMaxSampleRate();</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">// }</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> &amp;config() {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> &amp;config() {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> adc_config;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
Expand All @@ -154,7 +154,7 @@
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriver</a> analog;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> adc_config;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> adc_config;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;};</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;}</div>
Expand All @@ -170,7 +170,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_aba931b0caac2fb7d903fc6ed41dedf55"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#aba931b0caac2fb7d903fc6ed41dedf55">audio_tools::AnalogAudioStream::~AnalogAudioStream</a></div><div class="ttdeci">virtual ~AnalogAudioStream()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:26</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_ac4b262f441e13eb8054c879d9dd57edd"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#ac4b262f441e13eb8054c879d9dd57edd">audio_tools::AnalogAudioStream::defaultConfig</a></div><div class="ttdeci">AnalogConfig defaultConfig(RxTxMode mode=TX_MODE)</div><div class="ttdoc">Provides the default configuration.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:31</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_acba365cc28eb702040c382646cfb0a7a"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#acba365cc28eb702040c382646cfb0a7a">audio_tools::AnalogAudioStream::begin</a></div><div class="ttdeci">bool begin() override</div><div class="ttdoc">Reopen with last config.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:53</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_v1_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">audio_tools::AnalogConfigESP32V1</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc using the adc_continuous API.</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32V1.h:32</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32.html">audio_tools::AnalogConfigESP32</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc. The default input pin is GPIO34....</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32.h:21</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html">audio_tools::AnalogDriverArduino</a></div><div class="ttdoc">Please use the AnalogAudioStream: Reading Analog Data using a timer and the Arduino analogRead() meth...</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:21</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html_a361d357290e3fab139cd3de2bebabe1b"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html#a361d357290e3fab139cd3de2bebabe1b">audio_tools::AnalogDriverArduino::readBytes</a></div><div class="ttdeci">size_t readBytes(uint8_t *values, size_t len) override</div><div class="ttdoc">Provides the sampled audio data.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:52</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html">audio_tools::AudioStream</a></div><div class="ttdoc">Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...</div><div class="ttdef"><b>Definition:</b> AudioStreams.h:47</div></div>
Expand Down
8 changes: 4 additions & 4 deletions _analog_audio_arduino_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;AudioConfig.h&quot;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#ifdef USE_ANALOG_ARDUINO</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#if defined(USE_ANALOG_ARDUINO) || defined(DOXYGEN)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;AudioAnalog/AnalogAudioBase.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;AudioTimer/AudioTimer.h&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;AudioTools/AudioStreams.h&quot;</span></div>
Expand All @@ -85,7 +85,7 @@
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriverArduino</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">bool</span> begin(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> cfg) {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">bool</span> begin(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> cfg) {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; TRACED();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; config = cfg;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">if</span> (config.rx_tx_mode == RXTX_MODE) {</div>
Expand Down Expand Up @@ -312,12 +312,12 @@
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; </div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;};</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; </div>
<div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="namespaceaudio__tools.html#aed49378ae20ae0db086ef00cb4983f18"> 257</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriver</a> = <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriverArduino</a>;</div>
<div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="namespaceaudio__tools.html#a91ca8c40ca55c1fbc577d0fa03ba527d"> 257</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriver</a> = <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriverArduino</a>;</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; </div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; </div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_v1_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">audio_tools::AnalogConfigESP32V1</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc using the adc_continuous API.</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32V1.h:32</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32.html">audio_tools::AnalogConfigESP32</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc. The default input pin is GPIO34....</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32.h:21</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html">audio_tools::AnalogDriverArduino</a></div><div class="ttdoc">Please use the AnalogAudioStream: Reading Analog Data using a timer and the Arduino analogRead() meth...</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:21</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html_a1f6728aa34c4d7f0743160574e03d594"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html#a1f6728aa34c4d7f0743160574e03d594">audio_tools::AnalogDriverArduino::callback</a></div><div class="ttdeci">static void callback(void *arg)</div><div class="ttdoc">Sample data and write to buffer.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:154</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html_a2f783aba1c48dbdaf2d2be77681130e9"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html#a2f783aba1c48dbdaf2d2be77681130e9">audio_tools::AnalogDriverArduino::isDecimateActive</a></div><div class="ttdeci">bool isDecimateActive()</div><div class="ttdoc">The requested sampling rate is too hight: we only process half of the samples so we can half the samp...</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:229</div></div>
Expand Down
4 changes: 2 additions & 2 deletions _analog_audio_base_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_driver_base.html"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="classaudio__tools_1_1_analog_driver_base.html">AnalogDriverBase</a> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> begin(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">AnalogConfig</a> cfg) = 0;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> begin(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> cfg) = 0;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> end() = 0;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> write(<span class="keyword">const</span> uint8_t *src, <span class="keywordtype">size_t</span> size_bytes) { <span class="keywordflow">return</span> 0;}</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> readBytes(uint8_t *dest, <span class="keywordtype">size_t</span> size_bytes) = 0;</div>
Expand All @@ -93,7 +93,7 @@
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;} <span class="comment">// ns</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_v1_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32_v1.html">audio_tools::AnalogConfigESP32V1</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc using the adc_continuous API.</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32V1.h:32</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32.html">audio_tools::AnalogConfigESP32</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc. The default input pin is GPIO34....</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32.h:21</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_base_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_base.html">audio_tools::AnalogDriverBase</a></div><div class="ttdef"><b>Definition:</b> AnalogAudioBase.h:13</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> AnalogAudio.h:10</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
Loading

0 comments on commit 86c2f7d

Please sign in to comment.