Skip to content

Commit

Permalink
Deploying to doxygen from @ ee0f04f 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Nov 5, 2024
1 parent b01c056 commit 9a1a09c
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
12 changes: 6 additions & 6 deletions _audio_types_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -345,9 +345,9 @@
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; }</div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; </div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> From, <span class="keyword">typename</span> T&gt; </div>
<div class="line"><a name="l00352"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0"> 352</a></span>&#160; <span class="keyword">static</span> T <a class="code" href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0">clipT</a>(From value){</div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; From mv = <a class="code" href="classaudio__tools_1_1_number_converter.html#aa83040da5c51151a9bd3286ecfcfe413">maxValue</a>(<span class="keyword">sizeof</span>(T)*8);</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; </div>
<div class="line"><a name="l00352"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f"> 352</a></span>&#160; <span class="keyword">static</span> T <a class="code" href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f">clipT</a>(<span class="keywordtype">float</span> value){</div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; <span class="keywordtype">float</span> mv = maxValueT&lt;T&gt;();</div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160; <span class="keywordflow">if</span> (value &gt; mv){</div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; <span class="keywordflow">return</span> mv;</div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (value &lt; -mv){</div>
Expand Down Expand Up @@ -387,15 +387,15 @@
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> FromT, <span class="keyword">typename</span> ToT&gt; </div>
<div class="line"><a name="l00397"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_number_converter.html#ad847c72f19ba5bcd8ab8e2f4e138c592"> 397</a></span>&#160; <span class="keyword">static</span> ToT <a class="code" href="classaudio__tools_1_1_number_converter.html#ad847c72f19ba5bcd8ab8e2f4e138c592">convert</a>(FromT value){</div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160; int64_t value1 = value;</div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; <span class="keywordflow">return</span> clipT&lt;FromT,ToT&gt;(value1 * maxValueT&lt;ToT&gt;() / maxValueT&lt;FromT&gt;());</div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; <span class="keywordflow">return</span> clipT&lt;ToT&gt;(value1 * maxValueT&lt;ToT&gt;() / maxValueT&lt;FromT&gt;());</div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160; }</div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; </div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> FromT, <span class="keyword">typename</span> ToT&gt; </div>
<div class="line"><a name="l00404"></a><span class="lineno"><a class="line" href="classaudio__tools_1_1_number_converter.html#a50b655940dc86a223901230bf42c005e"> 404</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classaudio__tools_1_1_number_converter.html#a50b655940dc86a223901230bf42c005e">convertArray</a>(FromT* from, ToT*to, <span class="keywordtype">int</span> samples, <span class="keywordtype">float</span> vol=1.0f){</div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160; <span class="keywordtype">float</span> factor = <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(maxValueT&lt;ToT&gt;()) / maxValueT&lt;FromT&gt;();</div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; <span class="keywordtype">float</span> vol_factor = factor * vol;</div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j=0;j&lt;samples;j++){</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; to[j] = clipT&lt;FromT, ToT&gt;(vol_factor * from[j]);</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; to[j] = clipT&lt;ToT&gt;(vol_factor * from[j]);</div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160; }</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160; }</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; </div>
Expand Down Expand Up @@ -523,9 +523,9 @@
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html">audio_tools::NumberConverter</a></div><div class="ttdoc">Converts from a source to a target number with a different type.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:298</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_a3f0ef6fbe5231c08da00b3eba7d29c1a"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#a3f0ef6fbe5231c08da00b3eba7d29c1a">audio_tools::NumberConverter::toFloatT</a></div><div class="ttdeci">static float toFloatT(T value)</div><div class="ttdoc">Convert an integer integer autio type to a float (with max 1.0)</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:375</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_a429fbd4bd3a80cf04a3bcab71966935b"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#a429fbd4bd3a80cf04a3bcab71966935b">audio_tools::NumberConverter::fromFloatT</a></div><div class="ttdeci">static T fromFloatT(float value)</div><div class="ttdoc">Convert a float (with max 1.0) to an integer autio type.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:381</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_a4362cac4781628a59527a3b7fa069fa0"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0">audio_tools::NumberConverter::clipT</a></div><div class="ttdeci">static T clipT(From value)</div><div class="ttdoc">Clips the value to avoid any over or underflows.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:352</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_a50b655940dc86a223901230bf42c005e"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#a50b655940dc86a223901230bf42c005e">audio_tools::NumberConverter::convertArray</a></div><div class="ttdeci">static void convertArray(FromT *from, ToT *to, int samples, float vol=1.0f)</div><div class="ttdoc">Convert an array of int types.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:404</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_a74d41d3cbb14bdc5a5fe7e7cea5dd799"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#a74d41d3cbb14bdc5a5fe7e7cea5dd799">audio_tools::NumberConverter::toFloat</a></div><div class="ttdeci">static float toFloat(int32_t value, int bits)</div><div class="ttdoc">Convert an integer integer autio type to a float (with max 1.0)</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:386</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_a9b05fd540e9f1829c43659eef49e634f"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f">audio_tools::NumberConverter::clipT</a></div><div class="ttdeci">static T clipT(float value)</div><div class="ttdoc">Clips the value to avoid any over or underflows.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:352</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_number_converter_html_aa4e63512f3555b83ea59aaf4970abbfc"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#aa4e63512f3555b83ea59aaf4970abbfc">audio_tools::NumberConverter::fromFloat</a></div><div class="ttdeci">static int32_t fromFloat(float value, int bits)</div><div class="ttdoc">Convert a float (with max 1.0) to an integer autio type.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:391</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_ad847c72f19ba5bcd8ab8e2f4e138c592"><div class="ttname"><a href="classaudio__tools_1_1_number_converter.html#ad847c72f19ba5bcd8ab8e2f4e138c592">audio_tools::NumberConverter::convert</a></div><div class="ttdeci">static ToT convert(FromT value)</div><div class="ttdoc">Convert an int number from one type to another.</div><div class="ttdef"><b>Definition:</b> AudioTypes.h:397</div></div>
Expand Down
4 changes: 2 additions & 2 deletions _codec_l8_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">if</span> (!is_signed) {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; tmp -= 129;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> NumberConverter::clipT&lt;int32_t, int16_t&gt;(tmp * 258);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> NumberConverter::clipT&lt;int16_t&gt;(tmp * 258);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; }</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">virtual</span> <span class="keyword">operator</span> bool()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> p_print!=<span class="keyword">nullptr</span>; }</div>
Expand Down Expand Up @@ -188,7 +188,7 @@
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keyword">operator</span> bool()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> is_open; }</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; int16_t convertSample(int16_t sample) {</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; int16_t tmp = NumberConverter::clipT&lt;int16_t, int8_t&gt;(sample / 258);</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; int16_t tmp = NumberConverter::clipT&lt;int8_t&gt;(sample / 258);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keywordflow">if</span> (!is_signed) {</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; tmp += 129;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <span class="comment">// clip to range</span></div>
Expand Down
2 changes: 1 addition & 1 deletion _synthesizer_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="comment">// prevent divide by zero</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordtype">int</span> result = 0;</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keywordflow">if</span> (count&gt;0){</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; result = NumberConverter::clipT&lt;int, int16_t&gt;(total / count);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; result = NumberConverter::clipT&lt;int16_t&gt;(total / count);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; }</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; }</div>
Expand Down
2 changes: 1 addition & 1 deletion classaudio__tools_1_1_number_converter-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<p>This is the complete list of members for <a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html#ae33e08bd59b9edec2c91101cbaa8c1df">clip</a>(float value, int bits)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0">clipT</a>(From value)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f">clipT</a>(float value)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html#ad847c72f19ba5bcd8ab8e2f4e138c592">convert</a>(FromT value)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html#a50b655940dc86a223901230bf42c005e">convertArray</a>(FromT *from, ToT *to, int samples, float vol=1.0f)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html#aa4e63512f3555b83ea59aaf4970abbfc">fromFloat</a>(float value, int bits)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_number_converter.html">NumberConverter</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
Expand Down
10 changes: 5 additions & 5 deletions classaudio__tools_1_1_number_converter.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@
static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_number_converter.html#ae33e08bd59b9edec2c91101cbaa8c1df">clip</a> (float value, int bits)</td></tr>
<tr class="memdesc:ae33e08bd59b9edec2c91101cbaa8c1df"><td class="mdescLeft">&#160;</td><td class="mdescRight">clips a value <br /></td></tr>
<tr class="separator:ae33e08bd59b9edec2c91101cbaa8c1df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4362cac4781628a59527a3b7fa069fa0"><td class="memTemplParams" colspan="2"><a id="a4362cac4781628a59527a3b7fa069fa0"></a>
template&lt;typename From , typename T &gt; </td></tr>
<tr class="memitem:a4362cac4781628a59527a3b7fa069fa0"><td class="memTemplItemLeft" align="right" valign="top">static T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0">clipT</a> (From value)</td></tr>
<tr class="memdesc:a4362cac4781628a59527a3b7fa069fa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clips the value to avoid any over or underflows. <br /></td></tr>
<tr class="separator:a4362cac4781628a59527a3b7fa069fa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b05fd540e9f1829c43659eef49e634f"><td class="memTemplParams" colspan="2"><a id="a9b05fd540e9f1829c43659eef49e634f"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9b05fd540e9f1829c43659eef49e634f"><td class="memTemplItemLeft" align="right" valign="top">static T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f">clipT</a> (float value)</td></tr>
<tr class="memdesc:a9b05fd540e9f1829c43659eef49e634f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clips the value to avoid any over or underflows. <br /></td></tr>
<tr class="separator:a9b05fd540e9f1829c43659eef49e634f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad847c72f19ba5bcd8ab8e2f4e138c592"><td class="memTemplParams" colspan="2"><a id="ad847c72f19ba5bcd8ab8e2f4e138c592"></a>
template&lt;typename FromT , typename ToT &gt; </td></tr>
<tr class="memitem:ad847c72f19ba5bcd8ab8e2f4e138c592"><td class="memTemplItemLeft" align="right" valign="top">static ToT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_number_converter.html#ad847c72f19ba5bcd8ab8e2f4e138c592">convert</a> (FromT value)</td></tr>
Expand Down
2 changes: 1 addition & 1 deletion functions_c.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ <h3><a id="index_c"></a>- c -</h3><ul>
, <a class="el" href="classaudio__tools_1_1_number_converter.html#ae33e08bd59b9edec2c91101cbaa8c1df">NumberConverter</a>
</li>
<li>clipT()
: <a class="el" href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0">NumberConverter</a>
: <a class="el" href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f">NumberConverter</a>
</li>
<li>clipWave()
: <a class="el" href="classaudio__tools_1_1_modulation_base_class.html#a356c93980a95afc0003df929cd432c6d">ModulationBaseClass</a>
Expand Down
2 changes: 1 addition & 1 deletion functions_func_c.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h3><a id="index_c"></a>- c -</h3><ul>
, <a class="el" href="classaudio__tools_1_1_number_converter.html#ae33e08bd59b9edec2c91101cbaa8c1df">NumberConverter</a>
</li>
<li>clipT()
: <a class="el" href="classaudio__tools_1_1_number_converter.html#a4362cac4781628a59527a3b7fa069fa0">NumberConverter</a>
: <a class="el" href="classaudio__tools_1_1_number_converter.html#a9b05fd540e9f1829c43659eef49e634f">NumberConverter</a>
</li>
<li>clipWave()
: <a class="el" href="classaudio__tools_1_1_modulation_base_class.html#a356c93980a95afc0003df929cd432c6d">ModulationBaseClass</a>
Expand Down
Loading

0 comments on commit 9a1a09c

Please sign in to comment.