Skip to content

Commit

Permalink
Deploying to doxygen from @ 740b2a6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Nov 5, 2024
1 parent 9a1a09c commit 9dd5493
Show file tree
Hide file tree
Showing 181 changed files with 4,516 additions and 4,702 deletions.
2 changes: 1 addition & 1 deletion _analog_driver_e_s_p32_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_e_s_p32_html_a560c63a83b5e734d8c8ef5e778857ff4"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_e_s_p32.html#a560c63a83b5e734d8c8ef5e778857ff4">audio_tools::AnalogDriverESP32::AnalogDriverESP32</a></div><div class="ttdeci">AnalogDriverESP32()=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_e_s_p32_html_a64e9fa75beda50a9e8400ee0d4e61984"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_e_s_p32.html#a64e9fa75beda50a9e8400ee0d4e61984">audio_tools::AnalogDriverESP32::end</a></div><div class="ttdeci">void end() override</div><div class="ttdoc">stops the I2S and unistalls the driver</div><div class="ttdef"><b>Definition:</b> AnalogDriverESP32.h:137</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_e_s_p32_html_ad6adf8a8f39c09edf7a0a8b2564e1205"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_e_s_p32.html#ad6adf8a8f39c09edf7a0a8b2564e1205">audio_tools::AnalogDriverESP32::~AnalogDriverESP32</a></div><div class="ttdeci">virtual ~AnalogDriverESP32()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> AnalogDriverESP32.h:41</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:325</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:301</div></div>
<div class="ttc" id="agroup__basic_html_ga8c528baf37154d347366083f0f816846"><div class="ttname"><a href="group__basic.html#ga8c528baf37154d347366083f0f816846">stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Public generic methods.</div><div class="ttdef"><b>Definition:</b> AudioRuntime.h:27</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> AudioConfig.h:821</div></div>
<div class="ttc" id="anamespaceaudio__tools_html_a91ca8c40ca55c1fbc577d0fa03ba527d"><div class="ttname"><a href="namespaceaudio__tools.html#a91ca8c40ca55c1fbc577d0fa03ba527d">audio_tools::AnalogDriver</a></div><div class="ttdeci">AnalogDriverArduino AnalogDriver</div><div class="ttdoc">AnalogAudioStream.</div><div class="ttdef"><b>Definition:</b> AnalogDriverArduino.h:48</div></div>
Expand Down
7 changes: 3 additions & 4 deletions _audio_encoded_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160; }</div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160; </div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; <span class="keywordtype">bool</span> begin() {</div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; is_output_notify = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; <span class="comment">//is_output_notify = false;</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; reader.setByteCountFactor(10);</div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; setupReader();</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; ReformatBaseStream::begin();</div>
Expand All @@ -402,7 +402,7 @@
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; <span class="keywordtype">int</span> availableForWrite() { <span class="keywordflow">return</span> enc_out.availableForWrite(); }</div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160; </div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160; <span class="keywordtype">size_t</span> write(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> len) {</div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; <a class="code" href="classaudio__tools_1_1_reformat_base_stream.html#a19db610062b0771c616d6e31cddc5ddc">addNotifyOnFirstWrite</a>();</div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160; <span class="comment">//addNotifyOnFirstWrite();</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160; <span class="keywordflow">return</span> enc_out.<a class="code" href="classaudio__tools_1_1_encoded_audio_output.html#a016bb39af201e717c1975551b7ecc1b3">write</a>(data, len);</div>
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160; }</div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160; </div>
Expand Down Expand Up @@ -513,7 +513,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_audio_encoder_html_a5c749802992efec8bc20ba4a522b027f"><div class="ttname"><a href="classaudio__tools_1_1_audio_encoder.html#a5c749802992efec8bc20ba4a522b027f">audio_tools::AudioEncoder::setAudioInfo</a></div><div class="ttdeci">void setAudioInfo(AudioInfo from) override</div><div class="ttdoc">Defines the sample rate, number of channels and bits per sample.</div><div class="ttdef"><b>Definition:</b> AudioCodecsBase.h:95</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_info_source_html_a727a24459787e1eeeb7a37ba888394a6"><div class="ttname"><a href="classaudio__tools_1_1_audio_info_source.html#a727a24459787e1eeeb7a37ba888394a6">audio_tools::AudioInfoSource::addNotifyAudioChange</a></div><div class="ttdeci">virtual void addNotifyAudioChange(AudioInfoSupport &amp;bi)</div><div class="ttdoc">Adds target to be notified about audio changes.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:160</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_info_support_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_info_support.html">audio_tools::AudioInfoSupport</a></div><div class="ttdoc">Supports changes to the sampling rate, bits and channels.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:137</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_output_adapter_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_output_adapter.html">audio_tools::AudioOutputAdapter</a></div><div class="ttdoc">Base class for Output Adpapters.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:223</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_output_adapter_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_output_adapter.html">audio_tools::AudioOutputAdapter</a></div><div class="ttdoc">Base class for Output Adpapters.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:224</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_output_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_output.html">audio_tools::AudioOutput</a></div><div class="ttdoc">Abstract Audio Ouptut class.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:22</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> BaseStream.h:109</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_audio_stream_html_acbaca7240bc555603b0da5b7ca11ce10"><div class="ttname"><a href="classaudio__tools_1_1_audio_stream.html#acbaca7240bc555603b0da5b7ca11ce10">audio_tools::AudioStream::setAudioInfo</a></div><div class="ttdeci">virtual void setAudioInfo(AudioInfo newInfo) override</div><div class="ttdoc">Defines the input AudioInfo.</div><div class="ttdef"><b>Definition:</b> BaseStream.h:117</div></div>
Expand Down Expand Up @@ -547,7 +547,6 @@
<div class="ttc" id="aclassaudio__tools_1_1_modifying_output_html"><div class="ttname"><a href="classaudio__tools_1_1_modifying_output.html">audio_tools::ModifyingOutput</a></div><div class="ttdoc">Abstract class: Objects can be put into a pipleline.</div><div class="ttdef"><b>Definition:</b> AudioOutput.h:97</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_reformat_base_stream_html"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html">audio_tools::ReformatBaseStream</a></div><div class="ttdoc">Base class for chained converting streams.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:142</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_reformat_base_stream_html_a19db610062b0771c616d6e31cddc5ddc"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html#a19db610062b0771c616d6e31cddc5ddc">audio_tools::ReformatBaseStream::addNotifyOnFirstWrite</a></div><div class="ttdeci">void addNotifyOnFirstWrite()</div><div class="ttdoc">Add notification on first call of write.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:204</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_reformat_base_stream_html_a3175c90bb7d1186fc8eea5d5114a3766"><div class="ttname"><a href="classaudio__tools_1_1_reformat_base_stream.html#a3175c90bb7d1186fc8eea5d5114a3766">audio_tools::ReformatBaseStream::setStream</a></div><div class="ttdeci">virtual void setStream(Stream &amp;stream) override</div><div class="ttdoc">Defines/Changes the input &amp; output.</div><div class="ttdef"><b>Definition:</b> AudioIO.h:144</div></div>
<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:125</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> AudioConfig.h:821</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _audio_f_f_t_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html_af4a96b1f43237aa1c68c2479dbc0ec44"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html#af4a96b1f43237aa1c68c2479dbc0ec44">audio_tools::FFTDriver::getBin</a></div><div class="ttdeci">virtual bool getBin(int pos, FFTBin &amp;bin)</div><div class="ttdoc">gets the value of a bin</div><div class="ttdef"><b>Definition:</b> AudioFFT.h:116</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html_af652edc74a16a8a9ceb27cff50b665c9"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html#af652edc74a16a8a9ceb27cff50b665c9">audio_tools::FFTDriver::getValue</a></div><div class="ttdeci">virtual float getValue(int pos)=0</div><div class="ttdoc">Get result value from Reverse FFT.</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_musical_notes_html_a6118397b44998f418696d77e679721bc"><div class="ttname"><a href="classaudio__tools_1_1_musical_notes.html#a6118397b44998f418696d77e679721bc">audio_tools::MusicalNotes::note</a></div><div class="ttdeci">const char * note(float frequency, float &amp;diff) const</div><div class="ttdoc">Determines the closes note for a frequency. We also return the frequency difference.</div><div class="ttdef"><b>Definition:</b> MusicalNotes.h:169</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:325</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:301</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_ring_buffer_html"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html">audio_tools::RingBuffer&lt; uint8_t &gt;</a></div></div>
<div class="ttc" id="aclassaudio__tools_1_1_ring_buffer_html_a1b28d39faccd30992c1b64ddc6e21fe9"><div class="ttname"><a href="classaudio__tools_1_1_ring_buffer.html#a1b28d39faccd30992c1b64ddc6e21fe9">audio_tools::RingBuffer::read</a></div><div class="ttdeci">virtual T read()</div><div class="ttdoc">reads a single value</div><div class="ttdef"><b>Definition:</b> Buffers.h:309</div></div>
Expand Down
2 changes: 1 addition & 1 deletion _audio_faust_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@
<div class="ttc" id="aclassaudio__tools_1_1_faust_stream_html_adf61fad72c5b046b573970f6bc7f9431"><div class="ttname"><a href="classaudio__tools_1_1_faust_stream.html#adf61fad72c5b046b573970f6bc7f9431">audio_tools::FaustStream::allocateFloatBuffer</a></div><div class="ttdeci">void allocateFloatBuffer(int samples, bool allocate_out)</div><div class="ttdoc">Allocate the buffer that is needed by faust.</div><div class="ttdef"><b>Definition:</b> AudioFaust.h:332</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_faust_stream_html_af99303e9bfe78c84f1abd84376477ec7"><div class="ttname"><a href="classaudio__tools_1_1_faust_stream.html#af99303e9bfe78c84f1abd84376477ec7">audio_tools::FaustStream::begin</a></div><div class="ttdeci">bool begin(AudioInfo cfg)</div><div class="ttdoc">Checks the parameters and starts the processing.</div><div class="ttdef"><b>Definition:</b> AudioFaust.h:54</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_faust_stream_html_afe681c8ec67cf8ba9eef6444024dec03"><div class="ttname"><a href="classaudio__tools_1_1_faust_stream.html#afe681c8ec67cf8ba9eef6444024dec03">audio_tools::FaustStream::setLabelValue</a></div><div class="ttdeci">virtual bool setLabelValue(const char *label, FAUSTFLOAT value)</div><div class="ttdoc">Defines the value of a parameter.</div><div class="ttdef"><b>Definition:</b> AudioFaust.h:177</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:325</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa83040da5c51151a9bd3286ecfcfe413"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">audio_tools::NumberConverter::maxValue</a></div><div class="ttdeci">static int64_t maxValue(int value_bits_per_sample)</div><div class="ttdoc">provides the biggest number for the indicated number of bits</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:301</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="aclassdsp__memory__manager_html"><div class="ttname"><a href="classdsp__memory__manager.html">dsp_memory_manager</a></div><div class="ttdoc">Memory manager which uses psram when it is available.</div><div class="ttdef"><b>Definition:</b> AudioFaustDSP.h:181</div></div>
<div class="ttc" id="aclassdsp_html"><div class="ttname"><a href="classdsp.html">dsp</a></div><div class="ttdoc">minimal dsp base class needed by Faust</div><div class="ttdef"><b>Definition:</b> AudioFaustDSP.h:25</div></div>
Expand Down
Loading

0 comments on commit 9dd5493

Please sign in to comment.