Deploying to doxygen from @ d78db36 🚀

_audio_effect_8h_source.html

@@ -451,7 +451,7 @@
 <div class="line"><a name="l00467"></a><span class="lineno">  467</span>&#160;<span class="keyword">public</span>:    </div>
 <div class="line"><a name="l00469"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#aab865fd787ef6b2149736a248d0857a3">  469</a></span>&#160;    <a class="code" href="classaudio__tools_1_1_compressor.html#aab865fd787ef6b2149736a248d0857a3">Compressor</a>(<span class="keyword">const</span> <a class="code" href="classaudio__tools_1_1_compressor.html">Compressor</a> &amp;copy) = <span class="keywordflow">default</span>;</div>
 <div class="line"><a name="l00470"></a><span class="lineno">  470</span>&#160; </div>
-<div class="line"><a name="l00472"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#a90086c83b6f8e18a019d51f7b37e38a6">  472</a></span>&#160;    <a class="code" href="classaudio__tools_1_1_compressor.html#a90086c83b6f8e18a019d51f7b37e38a6">Compressor</a>(uint32_t sampleRate = 44100, int32_t attackMs=30, int32_t releaseMs=20, int32_t holdMs=10, uint8_t thresholdPercent=10, <span class="keywordtype">float</span> compressionRatio=0.5){</div>
+<div class="line"><a name="l00472"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#a99bcea167878342b636ed584a588e9a7">  472</a></span>&#160;    <a class="code" href="classaudio__tools_1_1_compressor.html#a99bcea167878342b636ed584a588e9a7">Compressor</a>(uint32_t sampleRate = 44100, uint16_t attackMs=30, uint16_t releaseMs=20, uint16_t holdMs=10, uint8_t thresholdPercent=10, <span class="keywordtype">float</span> compressionRatio=0.5){</div>
 <div class="line"><a name="l00473"></a><span class="lineno">  473</span>&#160;        <span class="comment">//assuming 1 sample = 1/96kHz = ~10us</span></div>
 <div class="line"><a name="l00474"></a><span class="lineno">  474</span>&#160;        <span class="comment">//Attack -&gt; 30 ms -&gt; 3000</span></div>
 <div class="line"><a name="l00475"></a><span class="lineno">  475</span>&#160;        <span class="comment">//Release -&gt; 20 ms -&gt; 2000</span></div>
@@ -470,17 +470,17 @@
 <div class="line"><a name="l00488"></a><span class="lineno">  488</span>&#160;        recalculate();</div>
 <div class="line"><a name="l00489"></a><span class="lineno">  489</span>&#160;    }</div>
 <div class="line"><a name="l00490"></a><span class="lineno">  490</span>&#160; </div>
-<div class="line"><a name="l00492"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#aee8a89695b54e655d3e62d683d0fd3d5">  492</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_compressor.html#aee8a89695b54e655d3e62d683d0fd3d5">setAttack</a>(int32_t attackMs){</div>
+<div class="line"><a name="l00492"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#a27061cfaaa7b2023482764b226337776">  492</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_compressor.html#a27061cfaaa7b2023482764b226337776">setAttack</a>(uint16_t attackMs){</div>
 <div class="line"><a name="l00493"></a><span class="lineno">  493</span>&#160;        attack_count = sample_rate * attackMs / 1000;</div>
 <div class="line"><a name="l00494"></a><span class="lineno">  494</span>&#160;        recalculate();</div>
 <div class="line"><a name="l00495"></a><span class="lineno">  495</span>&#160;    }</div>
 <div class="line"><a name="l00496"></a><span class="lineno">  496</span>&#160; </div>
-<div class="line"><a name="l00498"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#a3d6cba839271825c4297e64f808cfc54">  498</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_compressor.html#a3d6cba839271825c4297e64f808cfc54">setRelease</a>(int32_t releaseMs){</div>
+<div class="line"><a name="l00498"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#a794a1c8a05779649b1061a7f9321e2af">  498</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_compressor.html#a794a1c8a05779649b1061a7f9321e2af">setRelease</a>(uint16_t releaseMs){</div>
 <div class="line"><a name="l00499"></a><span class="lineno">  499</span>&#160;        release_count = sample_rate * releaseMs / 1000;</div>
 <div class="line"><a name="l00500"></a><span class="lineno">  500</span>&#160;        recalculate();</div>
 <div class="line"><a name="l00501"></a><span class="lineno">  501</span>&#160;    }</div>
 <div class="line"><a name="l00502"></a><span class="lineno">  502</span>&#160; </div>
-<div class="line"><a name="l00504"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#ada71dd4cd7afad13f895a3028fb08976">  504</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_compressor.html#ada71dd4cd7afad13f895a3028fb08976">setHold</a>(int32_t holdMs){</div>
+<div class="line"><a name="l00504"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_compressor.html#aa0c9c106f1b8084028e598fabb64518d">  504</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_compressor.html#aa0c9c106f1b8084028e598fabb64518d">setHold</a>(uint16_t holdMs){</div>
 <div class="line"><a name="l00505"></a><span class="lineno">  505</span>&#160;        hold_count = sample_rate * holdMs / 1000; </div>
 <div class="line"><a name="l00506"></a><span class="lineno">  506</span>&#160;        recalculate();</div>
 <div class="line"><a name="l00507"></a><span class="lineno">  507</span>&#160;    }</div>
@@ -601,14 +601,14 @@
 <div class="ttc" id="aclassaudio__tools_1_1_boost_html_a3560bcb309efc4862dfbf1aae406b47d"><div class="ttname"><a href="classaudio__tools_1_1_boost.html#a3560bcb309efc4862dfbf1aae406b47d">audio_tools::Boost::process</a></div><div class="ttdeci">effect_t process(effect_t input)</div><div class="ttdoc">calculates the effect output from the input</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:85</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_boost_html_af191c4af195d48e13b647f34007e9c22"><div class="ttname"><a href="classaudio__tools_1_1_boost.html#af191c4af195d48e13b647f34007e9c22">audio_tools::Boost::Boost</a></div><div class="ttdeci">Boost(float volume=1.0)</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:77</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_compressor_html"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html">audio_tools::Compressor</a></div><div class="ttdoc">Compressor inspired by https://github.com/YetAnotherElectronicsChannel/STM32_DSP_COMPRESSOR/blob/mast...</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:466</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_a3d6cba839271825c4297e64f808cfc54"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#a3d6cba839271825c4297e64f808cfc54">audio_tools::Compressor::setRelease</a></div><div class="ttdeci">void setRelease(int32_t releaseMs)</div><div class="ttdoc">Defines the release duration in ms.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:498</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_a90086c83b6f8e18a019d51f7b37e38a6"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#a90086c83b6f8e18a019d51f7b37e38a6">audio_tools::Compressor::Compressor</a></div><div class="ttdeci">Compressor(uint32_t sampleRate=44100, int32_t attackMs=30, int32_t releaseMs=20, int32_t holdMs=10, uint8_t thresholdPercent=10, float compressionRatio=0.5)</div><div class="ttdoc">Default Constructor.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:472</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_a27061cfaaa7b2023482764b226337776"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#a27061cfaaa7b2023482764b226337776">audio_tools::Compressor::setAttack</a></div><div class="ttdeci">void setAttack(uint16_t attackMs)</div><div class="ttdoc">Defines the attack duration in ms.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:492</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_a794a1c8a05779649b1061a7f9321e2af"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#a794a1c8a05779649b1061a7f9321e2af">audio_tools::Compressor::setRelease</a></div><div class="ttdeci">void setRelease(uint16_t releaseMs)</div><div class="ttdoc">Defines the release duration in ms.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:498</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_a99bcea167878342b636ed584a588e9a7"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#a99bcea167878342b636ed584a588e9a7">audio_tools::Compressor::Compressor</a></div><div class="ttdeci">Compressor(uint32_t sampleRate=44100, uint16_t attackMs=30, uint16_t releaseMs=20, uint16_t holdMs=10, uint8_t thresholdPercent=10, float compressionRatio=0.5)</div><div class="ttdoc">Default Constructor.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:472</div></div>
+<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_aa0c9c106f1b8084028e598fabb64518d"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#aa0c9c106f1b8084028e598fabb64518d">audio_tools::Compressor::setHold</a></div><div class="ttdeci">void setHold(uint16_t holdMs)</div><div class="ttdoc">Defines the hold duration in ms.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:504</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_compressor_html_aab865fd787ef6b2149736a248d0857a3"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#aab865fd787ef6b2149736a248d0857a3">audio_tools::Compressor::Compressor</a></div><div class="ttdeci">Compressor(const Compressor &amp;copy)=default</div><div class="ttdoc">Copy Constructor.</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_compressor_html_ab1f6194d1a670310cb303458c44eedf0"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#ab1f6194d1a670310cb303458c44eedf0">audio_tools::Compressor::setCompressionRatio</a></div><div class="ttdeci">void setCompressionRatio(float compressionRatio)</div><div class="ttdoc">Defines the compression ratio from 0 to 1.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:515</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_ada71dd4cd7afad13f895a3028fb08976"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#ada71dd4cd7afad13f895a3028fb08976">audio_tools::Compressor::setHold</a></div><div class="ttdeci">void setHold(int32_t holdMs)</div><div class="ttdoc">Defines the hold duration in ms.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:504</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_compressor_html_ae0b956d27d48ea749176032588d4f1ed"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#ae0b956d27d48ea749176032588d4f1ed">audio_tools::Compressor::process</a></div><div class="ttdeci">effect_t process(effect_t inSample)</div><div class="ttdoc">Processes the sample.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:523</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_compressor_html_aed07638c31d319b81b9532e787840077"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#aed07638c31d319b81b9532e787840077">audio_tools::Compressor::setThresholdPercent</a></div><div class="ttdeci">void setThresholdPercent(uint8_t thresholdPercent)</div><div class="ttdoc">Defines the threshod in %.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:510</div></div>
-<div class="ttc" id="aclassaudio__tools_1_1_compressor_html_aee8a89695b54e655d3e62d683d0fd3d5"><div class="ttname"><a href="classaudio__tools_1_1_compressor.html#aee8a89695b54e655d3e62d683d0fd3d5">audio_tools::Compressor::setAttack</a></div><div class="ttdeci">void setAttack(int32_t attackMs)</div><div class="ttdoc">Defines the attack duration in ms.</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:492</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_delay_html"><div class="ttname"><a href="classaudio__tools_1_1_delay.html">audio_tools::Delay</a></div><div class="ttdoc">Delay/Echo AudioEffect. See https://wiki.analog.com/resources/tools-software/sharc-audio-module/barem...</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:253</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_delay_html_a08a40da972e55ecd4498328ba78b4eaf"><div class="ttname"><a href="classaudio__tools_1_1_delay.html#a08a40da972e55ecd4498328ba78b4eaf">audio_tools::Delay::Delay</a></div><div class="ttdeci">Delay(uint16_t duration_ms=1000, float depth=0.5, float feedbackAmount=1.0, uint32_t sampleRate=44100, bool zeroIfBufferEmpty=false)</div><div class="ttdoc">e.g. depth=0.5, ms=1000, sampleRate=44100</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:256</div></div>
 <div class="ttc" id="aclassaudio__tools_1_1_delay_html_a3560bcb309efc4862dfbf1aae406b47d"><div class="ttname"><a href="classaudio__tools_1_1_delay.html#a3560bcb309efc4862dfbf1aae406b47d">audio_tools::Delay::process</a></div><div class="ttdeci">effect_t process(effect_t input)</div><div class="ttdoc">calculates the effect output from the input</div><div class="ttdef"><b>Definition:</b> AudioEffect.h:306</div></div>