Deploying to doxygen from @ 81cbbb6 🚀

pschatzmann · Nov 2, 2024 · 36bbf6a · 36bbf6a
1 parent 866c6b2
commit 36bbf6a
Show file tree

Hide file tree

Showing 145 changed files with 3,588 additions and 3,464 deletions.
diff --git a/_audio_actions_8h_source.html b/_audio_actions_8h_source.html
diff --git a/_audio_board_stream_8h_source.html b/_audio_board_stream_8h_source.html
diff --git a/_audio_kit_8h_source.html b/_audio_kit_8h_source.html
@@ -377,12 +377,12 @@
 <div class="line"><a name="l00355"></a><span class="lineno">  355</span>&#160;    TRACEI();</div>
 <div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160;    <span class="comment">// determine logic from config</span></div>
 <div class="line"><a name="l00357"></a><span class="lineno">  357</span>&#160;    AudioActions::ActiveLogic activeLogic = <a class="code" href="classaudio__tools_1_1_audio_kit_stream.html#a429791ee6aa07d099b1e2df39b688507">getActionLogic</a>(pin);</div>
-<div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;    actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">add</a>(pin, action, activeLogic, ref);</div>
+<div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;    actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">add</a>(pin, action, activeLogic, ref);</div>
 <div class="line"><a name="l00359"></a><span class="lineno">  359</span>&#160;  }</div>
 <div class="line"><a name="l00360"></a><span class="lineno">  360</span>&#160; </div>
 <div class="line"><a name="l00370"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_kit_stream.html#a24fac46b019688e1b0993569912128a1">  370</a></span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_audio_kit_stream.html#a24fac46b019688e1b0993569912128a1">addAction</a>(<span class="keywordtype">int</span> pin, <span class="keywordtype">void</span> (*action)(<span class="keywordtype">bool</span>,<span class="keywordtype">int</span>,<span class="keywordtype">void</span>*), AudioActions::ActiveLogic activeLogic, <span class="keywordtype">void</span>* ref=<span class="keyword">nullptr</span> ) {</div>
 <div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;    TRACEI();</div>
-<div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;    actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">add</a>(pin, action, activeLogic, ref);</div>
+<div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;    actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">add</a>(pin, action, activeLogic, ref);</div>
 <div class="line"><a name="l00373"></a><span class="lineno">  373</span>&#160;  }</div>
 <div class="line"><a name="l00374"></a><span class="lineno">  374</span>&#160; </div>
 <div class="line"><a name="l00376"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_audio_kit_stream.html#a4712eb0707514d26c1f17fc09575c6ff">  376</a></span>&#160;  <a class="code" href="classaudio__tools_1_1_audio_actions.html">AudioActions</a> &amp;<a class="code" href="classaudio__tools_1_1_audio_kit_stream.html#a4712eb0707514d26c1f17fc09575c6ff">audioActions</a>() {</div>
@@ -505,7 +505,7 @@
 <div class="line"><a name="l00615"></a><span class="lineno">  615</span>&#160;    <span class="comment">// pin conflicts with AIThinker A101 and headphone detection</span></div>
 <div class="line"><a name="l00616"></a><span class="lineno">  616</span>&#160;    <span class="keywordflow">if</span> (! (cfg.sd_active &amp;&amp; AUDIOKIT_BOARD==6)) {  </div>
 <div class="line"><a name="l00617"></a><span class="lineno">  617</span>&#160;      LOGD(<span class="stringliteral">&quot;actionHeadphoneDetection pin:%d&quot;</span>,kit.pinHeadphoneDetect())</div>
-<div class="line"><a name="l00618"></a><span class="lineno">  618</span>&#160;      actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">add</a>(kit.pinHeadphoneDetect(), <a class="code" href="classaudio__tools_1_1_audio_kit_stream.html#a649ac2c61ceb08c2b2290898512a413a">actionHeadphoneDetection</a>, AudioActions::ActiveChange);</div>
+<div class="line"><a name="l00618"></a><span class="lineno">  618</span>&#160;      actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">add</a>(kit.pinHeadphoneDetect(), <a class="code" href="classaudio__tools_1_1_audio_kit_stream.html#a649ac2c61ceb08c2b2290898512a413a">actionHeadphoneDetection</a>, AudioActions::ActiveChange);</div>
 <div class="line"><a name="l00619"></a><span class="lineno">  619</span>&#160;    } <span class="keywordflow">else</span> {</div>
 <div class="line"><a name="l00620"></a><span class="lineno">  620</span>&#160;      LOGW(<span class="stringliteral">&quot;Headphone detection ignored because of conflict: %d &quot;</span>,kit.pinHeadphoneDetect());</div>
 <div class="line"><a name="l00621"></a><span class="lineno">  621</span>&#160;    }</div>
@@ -525,8 +525,8 @@
 <div class="line"><a name="l00635"></a><span class="lineno">  635</span>&#160;}  <span class="comment">// namespace audio_tools</span></div>
 <div class="ttc" id="a_audio_tools_8h_html"><div class="ttname"><a href="_audio_tools_8h.html">AudioTools.h</a></div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html">audio_tools::AudioActions</a></div><div class="ttdoc">A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:29</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a251a13b88d6b778ec1f5babf5cf0a894"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(int pin, void(*actionOn)(bool pinStatus, int pin, void *ref), ActiveLogic activeLogic=ActiveLow, void *ref=nullptr)</div><div class="ttdoc">Adds an action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:122</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:174</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a7897359154057644b97714a13fc70581"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a7897359154057644b97714a13fc70581">audio_tools::AudioActions::processActions</a></div><div class="ttdeci">void processActions()</div><div class="ttdoc">Execute all actions if the corresponding pin is low To minimize the runtime: With each call we proces...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:178</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:131</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_config_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream_config.html">audio_tools::AudioKitStreamConfig</a></div><div class="ttdoc">Configuration for AudioKitStream: we use as subclass of I2SConfig.</div><div class="ttdef"><b>Definition:</b> AudioKit.h:23</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_config_html_a4004138f5ff66c31ad339182f71849cd"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream_config.html#a4004138f5ff66c31ad339182f71849cd">audio_tools::AudioKitStreamConfig::toAudioKitConfig</a></div><div class="ttdeci">AudioKitConfig toAudioKitConfig()</div><div class="ttdoc">convert to config object needed by HAL</div><div class="ttdef"><b>Definition:</b> AudioKit.h:39</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_kit_stream_config_html_a567e2afb71a4d538ed517075a55b0802"><div class="ttname"><a href="classaudio__tools_1_1_audio_kit_stream_config.html#a567e2afb71a4d538ed517075a55b0802">audio_tools::AudioKitStreamConfig::setupI2SPins</a></div><div class="ttdeci">void setupI2SPins(RxTxMode rxtx_mode)</div><div class="ttdoc">Defines the pins based on the information provided by the AudioKit project.</div><div class="ttdef"><b>Definition:</b> AudioKit.h:74</div></div>

diff --git a/_synthesizer_8h_source.html b/_synthesizer_8h_source.html
@@ -266,7 +266,7 @@
 <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160; </div>
 <div class="line"><a name="l00233"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_synthesizer.html#a68a78f9040b1e4a51c04c839a78d540d">  233</a></span>&#160;        <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_synthesizer.html#a68a78f9040b1e4a51c04c839a78d540d">setKeys</a>(<a class="code" href="classaudio__tools_1_1_audio_actions.html">AudioActions</a> &amp;actions, <a class="code" href="structaudio__tools_1_1_synthesizer_key.html">SynthesizerKey</a>* p_keys, AudioActions::ActiveLogic activeValue){</div>
 <div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;            <span class="keywordflow">while</span> (p_keys-&gt;note &gt; 0){</div>
-<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;                actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">add</a>(p_keys-&gt;pin, callbackKeyOn, callbackKeyOff, activeValue , <span class="keyword">new</span> <a class="code" href="structaudio__tools_1_1_synthesizer_1_1_key_parameter.html">KeyParameter</a>(<span class="keyword">this</span>, p_keys-&gt;note)); </div>
+<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;                actions.<a class="code" href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">add</a>(p_keys-&gt;pin, callbackKeyOn, callbackKeyOff, activeValue , <span class="keyword">new</span> <a class="code" href="structaudio__tools_1_1_synthesizer_1_1_key_parameter.html">KeyParameter</a>(<span class="keyword">this</span>, p_keys-&gt;note)); </div>
 <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;                p_keys++;</div>
 <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;            }</div>
 <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;        }</div>
@@ -379,7 +379,7 @@
 <div class="ttc" id="aclassaudio__tools_1_1_abstract_synthesizer_channel_html_af76ee74db3b728362a62e303928dc642"><div class="ttname"><a href="classaudio__tools_1_1_abstract_synthesizer_channel.html#af76ee74db3b728362a62e303928dc642">audio_tools::AbstractSynthesizerChannel::note</a></div><div class="ttdeci">virtual int note()=0</div><div class="ttdoc">Provides the actual midi note that is played.</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_abstract_synthesizer_channel_html_afe2ceeff51e99722f7b6855b674797e9"><div class="ttname"><a href="classaudio__tools_1_1_abstract_synthesizer_channel.html#afe2ceeff51e99722f7b6855b674797e9">audio_tools::AbstractSynthesizerChannel::keyOn</a></div><div class="ttdeci">virtual void keyOn(int nte, float tgt)=0</div><div class="ttdoc">Provides the key on event to ADSR to start the sound.</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html">audio_tools::AudioActions</a></div><div class="ttdoc">A simple class to assign functions to gpio pins e.g. to implement a simple navigation control or volu...</div><div class="ttdef"><b>Definition:</b> AudioActions.h:29</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a251a13b88d6b778ec1f5babf5cf0a894"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a251a13b88d6b778ec1f5babf5cf0a894">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(int pin, void(*actionOn)(bool pinStatus, int pin, void *ref), ActiveLogic activeLogic=ActiveLow, void *ref=nullptr)</div><div class="ttdoc">Adds an action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:122</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_audio_actions_html_a894ef8143616eca07c59f1f2deea3955"><div class="ttname"><a href="classaudio__tools_1_1_audio_actions.html#a894ef8143616eca07c59f1f2deea3955">audio_tools::AudioActions::add</a></div><div class="ttdeci">void add(Action &amp;action)</div><div class="ttdoc">Adds an Action.</div><div class="ttdef"><b>Definition:</b> AudioActions.h:131</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_effect_common_html_a0b6b70701c46e22849f0f363861351cd"><div class="ttname"><a href="classaudio__tools_1_1_audio_effect_common.html#a0b6b70701c46e22849f0f363861351cd">audio_tools::AudioEffectCommon::size</a></div><div class="ttdeci">size_t size()</div><div class="ttdoc">Provides the actual number of defined effects.</div><div class="ttdef"><b>Definition:</b> AudioEffects.h:45</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_effect_common_html_a8c1b8bfcd46d399503e45d49c32ce087"><div class="ttname"><a href="classaudio__tools_1_1_audio_effect_common.html#a8c1b8bfcd46d399503e45d49c32ce087">audio_tools::AudioEffectCommon::addEffect</a></div><div class="ttdeci">void addEffect(AudioEffect &amp;effect)</div><div class="ttdoc">Adds an effect object (by reference)</div><div class="ttdef"><b>Definition:</b> AudioEffects.h:27</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_audio_effect_common_html_ab74dd95287679b2bd45a7bb17fb05991"><div class="ttname"><a href="classaudio__tools_1_1_audio_effect_common.html#ab74dd95287679b2bd45a7bb17fb05991">audio_tools::AudioEffectCommon::findEffect</a></div><div class="ttdeci">AudioEffect * findEffect(int id)</div><div class="ttdoc">Finds an effect by id.</div><div class="ttdef"><b>Definition:</b> AudioEffects.h:50</div></div>