Regen docs

Added Mozzi logo Correct doc regen Correct doxygen
sensorium · Nov 28, 2024 · 091c319 · 091c319
1 parent c1cba1c
commit 091c319
Show file tree

Hide file tree

Showing 99 changed files with 2,233 additions and 2,136 deletions.
diff --git a/AudioDelayFeedback.h b/AudioDelayFeedback.h
@@ -32,7 +32,7 @@ with the input, do it in your sketch. AudioDelayFeedback uses more processing an
 than a plain AudioDelay, but allows for more dramatic effects with feedback.
 @tparam INTERP_TYPE a choice of LINEAR (default) or ALLPASS interpolation.  LINEAR is better
 for sweeping delay times, ALLPASS may be better for reverb-like effects.
-@tparam the type of numbers to use for the signal in the delay.  The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2.
+@tparam su the type of numbers to use for the signal in the delay.  The default is int8_t, but int16_t could be useful. Larger types (int32_t) might produce overflows as of v2.0.2.
 */
 template <uint16_t NUM_BUFFER_SAMPLES, int8_t INTERP_TYPE = LINEAR, typename su=int8_t>
 class AudioDelayFeedback

diff --git a/extras/doc/html/09_8_delays_2_audio_delay_2_audio_delay_8ino-example.html b/extras/doc/html/09_8_delays_2_audio_delay_2_audio_delay_8ino-example.html
@@ -149,7 +149,7 @@
 <div class="line">}</div>
 <div class="line"> </div>
 <div class="line">AudioOutput updateAudio(){</div>
-<div class="line">  char asig = aDel.next(aTriangle.next(), del_samps);</div>
+<div class="line">  int8_t asig = aDel.next(aTriangle.next(), del_samps);</div>
 <div class="line">  return MonoOutput::from8Bit(asig);</div>
 <div class="line">}</div>
 </div><!-- fragment --> </div><!-- contents -->

diff --git a/extras/doc/html/09_8_delays_2_audio_delay_feedback_2_audio_delay_feedback_8ino-example.html b/extras/doc/html/09_8_delays_2_audio_delay_feedback_2_audio_delay_feedback_8ino-example.html
@@ -160,7 +160,7 @@
 <div class="line"> </div>
 <div class="line"> </div>
 <div class="line">AudioOutput updateAudio(){</div>
-<div class="line">  char asig = aTriangle.next(); // get this so it can be used twice without calling next() again</div>
+<div class="line">  int8_t asig = aTriangle.next(); // get this so it can be used twice without calling next() again</div>
 <div class="line">  //return asig/8 + aDel.next(asig, (uint16_t) del_samps); // mix some straight signal with the delayed signal</div>
 <div class="line">  //return aDel.next(aTriangle.next(), (uint16_t) del_samps); // instead of the previous 2 lines for only the delayed signal</div>
 <div class="line">  return MonoOutput::fromAlmostNBit(9, (asig &gt;&gt; 3) + aDel.next(asig, deltime)); // mix some straight signal with the delayed signal</div>

diff --git a/extras/doc/html/_audio_delay_8h_source.html b/extras/doc/html/_audio_delay_8h_source.html
@@ -164,7 +164,7 @@
 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; </div>
 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <span class="comment">// why does delay jump if I read it before writing?</span></div>
 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        delay_array[_write_pos] = in_value;         <span class="comment">// write to buffer</span></div>
-<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        int8_t delay_sig = delay_array[read_pos] ;  <span class="comment">// read the delay buffer</span></div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        T delay_sig = delay_array[read_pos] ;   <span class="comment">// read the delay buffer</span></div>
 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        <span class="keywordflow">return</span> (T)delay_sig;</div>
 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    }</div>

diff --git a/extras/doc/html/_audio_delay_feedback_8h_source.html b/extras/doc/html/_audio_delay_feedback_8h_source.html
diff --git a/extras/doc/html/_meta_oscil_8h_source.html b/extras/doc/html/_meta_oscil_8h_source.html
diff --git a/extras/doc/html/class_audio_delay_feedback-members.html b/extras/doc/html/class_audio_delay_feedback-members.html
@@ -96,27 +96,27 @@
 
 <div class="header">
   <div class="headertitle">
-<div class="title">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt; Member List</div>  </div>
+<div class="title">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt; Member List</div>  </div>
 </div><!--header-->
 <div class="contents">
 
-<p>This is the complete list of members for <a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a>, including all inherited members.</p>
+<p>This is the complete list of members for <a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a6e6352413ac4ee9b2bc03684b072fdc7">AudioDelayFeedback</a>()</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a7d038aff13126acbca484b74b1ee5620">AudioDelayFeedback</a>(uint16_t delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a54d7f001d6a99bd3955fb7dab94fbfe8">AudioDelayFeedback</a>(uint16_t delaytime_cells, int8_t feedback_level)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a5a702d1a0a9b104beb0b18c80422500e">next</a>(int8_t input)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a7c7745dd84f01dbdc9b6552a4c427f0b">next</a>(int8_t input, uint16_t delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#af9cc2cf135fa0f1a1f0d50ca7d9f89ea">next</a>(int8_t input, Q16n16 delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a77508ec1d8da719edbc7c34173c9d7cb">read</a>(Q16n16 delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a8b6cefa45ecaa174320effe25b9ce6c5">read</a>()</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#abcf71a86083db5a48ef71c1397247886">setDelayTimeCells</a>(uint16_t delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a8e8344af6962ea061da8f70ed119b2bd">setDelayTimeCells</a>(Q16n16 delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a7c54b49ae9f25baaf8714528295c53e2">setDelayTimeCells</a>(float delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a2cd87a7dc91187ed439a8ec1d7e00d29">setFeedbackLevel</a>(int8_t feedback_level)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#aa3232fec9e7f90169e8d8eab85f39394">write</a>(int8_t input)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#aeeec669071403fc0a294724e775e3812">write</a>(int8_t input, uint16_t offset)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a27e773a0ae0c2cee895fbcf18c1351e1">writeFeedback</a>(int8_t input)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#adbc1ecd0dffe273cac87b8fc888e28f0">AudioDelayFeedback</a>()</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a0412c5d62f72a881d95504d9d0018245">AudioDelayFeedback</a>(uint16_t delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a61f3c90f752d8b15c0f7a19e03bc4f03">AudioDelayFeedback</a>(uint16_t delaytime_cells, int8_t feedback_level)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a566593f5ea6d2d8bac9c45aa592f40fb">next</a>(su input)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a335ce266a8b40173f3279b96f9c6c050">next</a>(su input, uint16_t delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#af94a6f68bc932e4e2ce99b3a43713825">next</a>(su input, Q16n16 delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#adb77aac1acba3b0a31428345342a5205">read</a>(Q16n16 delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#aabcade306904f5f6ac43d12bb00606e6">read</a>()</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a3f49d5e601799487237266621245c7a4">setDelayTimeCells</a>(uint16_t delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a2c5c805eb4d62e4650b08400409863a9">setDelayTimeCells</a>(Q16n16 delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#ab6fb7260a540416018ebfac7aeac32f1">setDelayTimeCells</a>(float delaytime_cells)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a1408da9125a0d6c38ce89b11d7d93113">setFeedbackLevel</a>(int8_t feedback_level)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a5197399a986922eee160a455069dc93e">write</a>(su input)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="class_audio_delay_feedback.html#a93231df73010a40da2d4092b94a99f9d">write</a>(su input, uint16_t offset)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_audio_delay_feedback.html#ae83d67ec86483bae489a6a17e8d0e5e3">writeFeedback</a>(su input)</td><td class="entry"><a class="el" href="class_audio_delay_feedback.html">AudioDelayFeedback&lt; NUM_BUFFER_SAMPLES, INTERP_TYPE, su &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <div id="nav-path" class="navpath">