Skip to content

Commit ef645f3

Browse files
committed
Deploying to doxygen from @ bc770e2 🚀
1 parent ca007f6 commit ef645f3

File tree

73 files changed

+9810
-5527
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+9810
-5527
lines changed

_audio_cmsis_f_f_t_8h_source.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@
221221
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>}</div>
222222
<div class="ttc" id="aclassaudio__tools_1_1_audio_cmsis_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_cmsis_f_f_t.html">audio_tools::AudioCmsisFFT</a></div><div class="ttdoc">AudioFFT for ARM processors that provided Cmsis DSP.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:112</div></div>
223223
<div class="ttc" id="aclassaudio__tools_1_1_audio_cmsis_f_f_t_html_a2b5e1c6a270a54d6711fb0a83866efb8"><div class="ttname"><a href="classaudio__tools_1_1_audio_cmsis_f_f_t.html#a2b5e1c6a270a54d6711fb0a83866efb8">audio_tools::AudioCmsisFFT::array</a></div><div class="ttdeci">float * array()</div><div class="ttdoc">Provides the result array returned by CMSIS FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:117</div></div>
224-
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data privded by write() and/or an inverse FFT where the samples are made ava...</div><div class="ttdef"><b>Definition</b> AudioFFT.h:188</div></div>
225-
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a78331df1a4e6bd150c2be32ae74b7b29"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a78331df1a4e6bd150c2be32ae74b7b29">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdef"><b>Definition</b> AudioFFT.h:388</div></div>
224+
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data privded by write() and/or an inverse FFT where the samples are made ava...</div><div class="ttdef"><b>Definition</b> AudioFFT.h:190</div></div>
225+
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a78331df1a4e6bd150c2be32ae74b7b29"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a78331df1a4e6bd150c2be32ae74b7b29">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdef"><b>Definition</b> AudioFFT.h:390</div></div>
226226
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html">audio_tools::FFTDriverCmsisFFT</a></div><div class="ttdoc">Driver for Cmsis-FFT see https://arm-software.github.io/CMSIS_5/DSP.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:23</div></div>
227227
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_a01f7d08ca15b0ebd7bb4d17101ba8d72"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#a01f7d08ca15b0ebd7bb4d17101ba8d72">audio_tools::FFTDriverCmsisFFT::magnitudeFast</a></div><div class="ttdeci">float magnitudeFast(int idx) override</div><div class="ttdoc">same as magnitude</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:72</div></div>
228228
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_a11592af256fefabe7c1e1cc9b8b516b6"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#a11592af256fefabe7c1e1cc9b8b516b6">audio_tools::FFTDriverCmsisFFT::setValue</a></div><div class="ttdeci">void setValue(int idx, float value) override</div><div class="ttdoc">Sets the real value.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:50</div></div>
@@ -233,10 +233,10 @@
233233
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_ab08cf2f66075519cfdaddedcce92527f"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#ab08cf2f66075519cfdaddedcce92527f">audio_tools::FFTDriverCmsisFFT::fft</a></div><div class="ttdeci">void fft() override</div><div class="ttdoc">Perform FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:54</div></div>
234234
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_add3df8e9c88c438537a87be3415ef2ba"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#add3df8e9c88c438537a87be3415ef2ba">audio_tools::FFTDriverCmsisFFT::rfft</a></div><div class="ttdeci">void rfft() override</div><div class="ttdoc">Calculate reverse FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:63</div></div>
235235
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t_html_aec550aae099c1a4afec6a9df3512ad21"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_cmsis_f_f_t.html#aec550aae099c1a4afec6a9df3512ad21">audio_tools::FFTDriverCmsisFFT::getValue</a></div><div class="ttdeci">float getValue(int idx) override</div><div class="ttdoc">Get result value from Reverse FFT.</div><div class="ttdef"><b>Definition</b> AudioCmsisFFT.h:76</div></div>
236-
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:153</div></div>
236+
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:155</div></div>
237237
<div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector</a></div><div class="ttdoc">Vector implementation which provides the most important methods as defined by std::vector....</div><div class="ttdef"><b>Definition</b> Vector.h:21</div></div>
238238
<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:877</div></div>
239-
<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:63</div></div>
239+
<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:65</div></div>
240240
</div><!-- fragment --></div><!-- contents -->
241241
<!-- start footer part -->
242242
<hr class="footer"/><address class="footer"><small>

_audio_e_s_p32_f_f_t_8h_source.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@
179179
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>}</div>
180180
<div class="ttc" id="aclassaudio__tools_1_1_audio_e_s_p32_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_e_s_p32_f_f_t.html">audio_tools::AudioESP32FFT</a></div><div class="ttdoc">AudioFFT using RealFFT.</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:84</div></div>
181181
<div class="ttc" id="aclassaudio__tools_1_1_audio_e_s_p32_f_f_t_html_a2b5e1c6a270a54d6711fb0a83866efb8"><div class="ttname"><a href="classaudio__tools_1_1_audio_e_s_p32_f_f_t.html#a2b5e1c6a270a54d6711fb0a83866efb8">audio_tools::AudioESP32FFT::array</a></div><div class="ttdeci">float * array()</div><div class="ttdoc">Provides the result array returned by the FFT: The real part of a magnitude at a frequency is followe...</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:89</div></div>
182-
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data privded by write() and/or an inverse FFT where the samples are made ava...</div><div class="ttdef"><b>Definition</b> AudioFFT.h:188</div></div>
183-
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a78331df1a4e6bd150c2be32ae74b7b29"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a78331df1a4e6bd150c2be32ae74b7b29">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdef"><b>Definition</b> AudioFFT.h:388</div></div>
182+
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html">audio_tools::AudioFFTBase</a></div><div class="ttdoc">Executes FFT using audio data privded by write() and/or an inverse FFT where the samples are made ava...</div><div class="ttdef"><b>Definition</b> AudioFFT.h:190</div></div>
183+
<div class="ttc" id="aclassaudio__tools_1_1_audio_f_f_t_base_html_a78331df1a4e6bd150c2be32ae74b7b29"><div class="ttname"><a href="classaudio__tools_1_1_audio_f_f_t_base.html#a78331df1a4e6bd150c2be32ae74b7b29">audio_tools::AudioFFTBase::driver</a></div><div class="ttdeci">FFTDriver * driver()</div><div class="ttdef"><b>Definition</b> AudioFFT.h:390</div></div>
184184
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html">audio_tools::FFTDriverESP32FFT</a></div><div class="ttdoc">Driver for ESP32-FFT https://github.com/pschatzmann/esp32-fft</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:21</div></div>
185185
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_a01f7d08ca15b0ebd7bb4d17101ba8d72"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#a01f7d08ca15b0ebd7bb4d17101ba8d72">audio_tools::FFTDriverESP32FFT::magnitudeFast</a></div><div class="ttdeci">float magnitudeFast(int idx) override</div><div class="ttdoc">magnitude w/o sqrt</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:49</div></div>
186186
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_a09c13a7b0d31155679c3285b4e19d334"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#a09c13a7b0d31155679c3285b4e19d334">audio_tools::FFTDriverESP32FFT::getValue</a></div><div class="ttdeci">float getValue(int idx)</div><div class="ttdoc">Get result value from Reverse FFT.</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:53</div></div>
@@ -191,10 +191,10 @@
191191
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_a7adfa4b95180c0520f797ce976e9fb58"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#a7adfa4b95180c0520f797ce976e9fb58">audio_tools::FFTDriverESP32FFT::magnitude</a></div><div class="ttdeci">float magnitude(int idx) override</div><div class="ttdoc">Calculate the magnitude (fft result) at index (sqr(i² + r²))</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:44</div></div>
192192
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_ab08cf2f66075519cfdaddedcce92527f"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#ab08cf2f66075519cfdaddedcce92527f">audio_tools::FFTDriverESP32FFT::fft</a></div><div class="ttdeci">void fft() override</div><div class="ttdoc">Perform FFT.</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:36</div></div>
193193
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t_html_add3df8e9c88c438537a87be3415ef2ba"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver_e_s_p32_f_f_t.html#add3df8e9c88c438537a87be3415ef2ba">audio_tools::FFTDriverESP32FFT::rfft</a></div><div class="ttdeci">void rfft() override</div><div class="ttdoc">Calculate reverse FFT.</div><div class="ttdef"><b>Definition</b> AudioESP32FFT.h:40</div></div>
194-
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:153</div></div>
194+
<div class="ttc" id="aclassaudio__tools_1_1_f_f_t_driver_html"><div class="ttname"><a href="classaudio__tools_1_1_f_f_t_driver.html">audio_tools::FFTDriver</a></div><div class="ttdoc">Abstract Class which defines the basic FFT functionality.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:155</div></div>
195195
<div class="ttc" id="aclassaudio__tools_1_1_vector_html"><div class="ttname"><a href="classaudio__tools_1_1_vector.html">audio_tools::Vector</a></div><div class="ttdoc">Vector implementation which provides the most important methods as defined by std::vector....</div><div class="ttdef"><b>Definition</b> Vector.h:21</div></div>
196196
<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:877</div></div>
197-
<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:63</div></div>
197+
<div class="ttc" id="astructaudio__tools_1_1_f_f_t_bin_html"><div class="ttname"><a href="structaudio__tools_1_1_f_f_t_bin.html">audio_tools::FFTBin</a></div><div class="ttdoc">And individual FFT Bin.</div><div class="ttdef"><b>Definition</b> AudioFFT.h:65</div></div>
198198
</div><!-- fragment --></div><!-- contents -->
199199
<!-- start footer part -->
200200
<hr class="footer"/><address class="footer"><small>

0 commit comments

Comments
 (0)