Skip to content

Commit

Permalink
Deploying to doxygen from @ 4fd7a65 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Oct 23, 2023
1 parent f350593 commit 953fe63
Show file tree
Hide file tree
Showing 181 changed files with 4,752 additions and 3,616 deletions.
69 changes: 32 additions & 37 deletions _analog_audio_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,51 +122,46 @@
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; analog.end();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// /// Overides the sample rate and uses the max value which is around ~13MHz. Call this methd after begin();</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// void setMaxSampleRate() {</span></div>
<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.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>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#a360ffe5435df7f910720c0f3faa04dee"> 79</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#a360ffe5435df7f910720c0f3faa04dee">write</a>(<span class="keyword">const</span> uint8_t *src, <span class="keywordtype">size_t</span> size_bytes)<span class="keyword"> override </span>{ </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; TRACED();</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> analog.write(src, size_bytes);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; } </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">size_t</span> readBytes(uint8_t *dest, <span class="keywordtype">size_t</span> size_bytes)<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">return</span> analog.<a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html#a361d357290e3fab139cd3de2bebabe1b">readBytes</a>(dest, size_bytes);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; }</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">int</span> available()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">return</span> analog.available();</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">int</span> availableForWrite()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> analog.availableForWrite();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</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="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> adc_config;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#a360ffe5435df7f910720c0f3faa04dee"> 74</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#a360ffe5435df7f910720c0f3faa04dee">write</a>(<span class="keyword">const</span> uint8_t *src, <span class="keywordtype">size_t</span> size_bytes)<span class="keyword"> override </span>{ </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; TRACED();</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> analog.write(src, size_bytes);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; } </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">size_t</span> readBytes(uint8_t *dest, <span class="keywordtype">size_t</span> size_bytes)<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> analog.<a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html#a361d357290e3fab139cd3de2bebabe1b">readBytes</a>(dest, size_bytes);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">int</span> available()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">return</span> analog.available();</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">int</span> availableForWrite()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> analog.availableForWrite();</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#ab8bcb0b11d13b5c5bc739c6f759bf8cc"> 92</a></span>&#160; <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriver</a>* <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#ab8bcb0b11d13b5c5bc739c6f759bf8cc">driver</a>() {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> &amp;analog;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_analog_audio_stream.html#ab8bcb0b11d13b5c5bc739c6f759bf8cc"> 97</a></span>&#160; <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriver</a>* <a class="code" href="classaudio__tools_1_1_analog_audio_stream.html#ab8bcb0b11d13b5c5bc739c6f759bf8cc">driver</a>() {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordflow">return</span> &amp;analog;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriver</a> analog;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</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="l00099"></a><span class="lineno"> 99</span>&#160;};</div>
<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.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>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html">audio_tools::AnalogAudioStream</a></div><div class="ttdoc">ESP32: A very fast ADC and DAC using the ESP32 I2S interface. For all other architectures we support ...</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:20</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_a360ffe5435df7f910720c0f3faa04dee"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#a360ffe5435df7f910720c0f3faa04dee">audio_tools::AnalogAudioStream::write</a></div><div class="ttdeci">size_t write(const uint8_t *src, size_t size_bytes) override</div><div class="ttdoc">ESP32 only: writes the data to the I2S interface.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:79</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_a360ffe5435df7f910720c0f3faa04dee"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#a360ffe5435df7f910720c0f3faa04dee">audio_tools::AnalogAudioStream::write</a></div><div class="ttdeci">size_t write(const uint8_t *src, size_t size_bytes) override</div><div class="ttdoc">ESP32 only: writes the data to the I2S interface.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:74</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_a5b57d1fefbbb011e8e8672dcc6750895"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#a5b57d1fefbbb011e8e8672dcc6750895">audio_tools::AnalogAudioStream::begin</a></div><div class="ttdeci">bool begin(AnalogConfig cfg)</div><div class="ttdoc">starts the DAC</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:58</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_a64e9fa75beda50a9e8400ee0d4e61984"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#a64e9fa75beda50a9e8400ee0d4e61984">audio_tools::AnalogAudioStream::end</a></div><div class="ttdeci">void end() override</div><div class="ttdoc">stops the I2S and unistalls the analog</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:64</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_a87feead15897a49c7dccb043ac9fcddc"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#a87feead15897a49c7dccb043ac9fcddc">audio_tools::AnalogAudioStream::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo info)</div><div class="ttdoc">updates the sample rate dynamically</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:38</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_a88bb3966d8d45a746454c48d2c3ff655"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#a88bb3966d8d45a746454c48d2c3ff655">audio_tools::AnalogAudioStream::AnalogAudioStream</a></div><div class="ttdeci">AnalogAudioStream()=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_ab8bcb0b11d13b5c5bc739c6f759bf8cc"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#ab8bcb0b11d13b5c5bc739c6f759bf8cc">audio_tools::AnalogAudioStream::driver</a></div><div class="ttdeci">AnalogDriver * driver()</div><div class="ttdoc">Provides access to the driver.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:97</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_stream_html_ab8bcb0b11d13b5c5bc739c6f759bf8cc"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_stream.html#ab8bcb0b11d13b5c5bc739c6f759bf8cc">audio_tools::AnalogAudioStream::driver</a></div><div class="ttdeci">AnalogDriver * driver()</div><div class="ttdoc">Provides access to the driver.</div><div class="ttdef"><b>Definition:</b> AnalogAudio.h:92</div></div>
<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>
Expand Down
Loading

0 comments on commit 953fe63

Please sign in to comment.