Deployed 2998a67 with MkDocs version: 1.5.3

howto/plotting/index.html

@@ -1528,11 +1528,11 @@ <h2 id="output">Output</h2>
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-09T16:28:07+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-09</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:54:12+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:
-        <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-09T16:28:07+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-09</span>
+        <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:54:12+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
 
   </small>

library/buffer/segmentplayer/index.html

@@ -1481,7 +1481,7 @@
 
 <p><a href="../../">Reference library</a> &gt; <a href="../">Buffer</a> &gt; <a href="./">SegmentPlayer</a></p>
 <h1 id="segmentplayer">SegmentPlayer</h1>
-<div class="highlight"><pre><span></span><code><span class="n">SegmentPlayer</span><span class="p">(</span><span class="n">buffer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">onsets</span><span class="o">=</span><span class="p">{})</span>
+<div class="highlight"><pre><span></span><code><span class="n">SegmentPlayer</span><span class="p">(</span><span class="n">buffer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">onsets</span><span class="o">=</span><span class="p">{},</span> <span class="n">index</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rate</span><span class="o">=</span><span class="mf">1.0</span><span class="p">)</span>
 </code></pre></div>
 <p>Trigger segments of a buffer at the given onset positions.</p>
 
@@ -1490,7 +1490,7 @@ <h1 id="segmentplayer">SegmentPlayer</h1>
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-03T21:39:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-03</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:49:57+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:

library/index.html

@@ -1727,7 +1727,7 @@ <h2 id="processors-distortion">Processors: Distortion</h2>
 <li><strong><a href="processors/distortion/resample/">Resample</a></strong>: Resampler and bit crusher. <code>sample_rate</code> is in Hz, <code>bit_rate</code> is an integer between 0 and 16.</li>
 <li><strong><a href="processors/distortion/sampleandhold/">SampleAndHold</a></strong>: Samples and holds the input each time a trigger is received on <code>clock</code>.</li>
 <li><strong><a href="processors/distortion/squiz/">Squiz</a></strong>: Implementation of Dan Stowell's Squiz algorithm, a kind of downsampler.</li>
-<li><strong><a href="processors/distortion/waveshaper/">WaveShaper</a></strong>: Applies wave-shaping as described in <code>buffer</code>.</li>
+<li><strong><a href="processors/distortion/waveshaper/">WaveShaper</a></strong>: Applies wave-shaping as described in the WaveShaperBuffer <code>buffer</code>.</li>
 </ul>
 <hr />
 <h2 id="processors-dynamics">Processors: Dynamics</h2>
@@ -1791,7 +1791,7 @@ <h2 id="stochastic">Stochastic</h2>
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-03T21:39:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-03</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:47:13+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:

library/oscillators/sinelfo/index.html

@@ -1511,7 +1511,7 @@ <h3 id="examples">Examples</h3>
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-03T21:46:38+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-03</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:49:57+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:

library/processors/distortion/index.html

@@ -1503,15 +1503,15 @@ <h1 id="processors-distortion">Processors: Distortion</h1>
 <li><strong><a href="resample/">Resample</a></strong>: Resampler and bit crusher. <code>sample_rate</code> is in Hz, <code>bit_rate</code> is an integer between 0 and 16.</li>
 <li><strong><a href="sampleandhold/">SampleAndHold</a></strong>: Samples and holds the input each time a trigger is received on <code>clock</code>.</li>
 <li><strong><a href="squiz/">Squiz</a></strong>: Implementation of Dan Stowell's Squiz algorithm, a kind of downsampler.</li>
-<li><strong><a href="waveshaper/">WaveShaper</a></strong>: Applies wave-shaping as described in <code>buffer</code>.</li>
+<li><strong><a href="waveshaper/">WaveShaper</a></strong>: Applies wave-shaping as described in the WaveShaperBuffer <code>buffer</code>.</li>
 </ul>
 
   <hr>
 <div class="md-source-file">
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-03T21:03:36+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-03</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:47:13+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:

library/processors/distortion/waveshaper/example-0.py

@@ -0,0 +1,11 @@
+from signalflow import *
+graph = AudioGraph()
+
+#-------------------------------------------------------------------------------
+# Create a waveshaper buffer that silences any samples with amplitude < 0.5
+#-------------------------------------------------------------------------------
+buf = WaveShaperBuffer(lambda n: 0 if abs(n) < 0.5 else n)
+sine = SineOscillator(120)
+waveshaper = WaveShaper(sine, buf)
+attenuated = waveshaper * 0.1
+attenuated.play()

library/processors/distortion/waveshaper/example-1.py

@@ -0,0 +1,29 @@
+from signalflow import *
+graph = AudioGraph()
+
+#-------------------------------------------------------------------------------
+# Create a range of different waveshaper buffers, and iterate through them.
+#-------------------------------------------------------------------------------
+import time
+import math
+import random
+
+sin_buf = WaveShaperBuffer(lambda n: math.sin(n * math.pi / 2))
+cos_buf = WaveShaperBuffer(lambda n: math.cos(n * math.pi / 2))
+tan_buf = WaveShaperBuffer(lambda n: math.tan(n * math.pi / 2))
+tanh_buf = WaveShaperBuffer(lambda n: math.tanh(n * 20))
+sinx_buf = WaveShaperBuffer(lambda n: math.sin(256 * n * math.pi / 2))
+invert_buf = WaveShaperBuffer(lambda n: 1 - n if n > 0 else -1 - n)
+noise_buf = WaveShaperBuffer(lambda n: random.uniform(0, n))
+bufs = [sin_buf, cos_buf, tan_buf, tanh_buf, sinx_buf, invert_buf, noise_buf]
+
+sine = SineOscillator(120)
+waveshaper = WaveShaper(sine, sin_buf)
+attenuated = waveshaper * 0.1
+attenuated.play()
+
+for buf in bufs:
+    waveshaper.set_buffer("buffer", buf)
+    time.sleep(1.0)
+
+attenuated.stop()

library/processors/distortion/waveshaper/index.html

@@ -6,7 +6,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
 
-        <meta name="description" content="WaveShaper: Applies wave-shaping as described in `buffer`.">
+        <meta name="description" content="WaveShaper: Applies wave-shaping as described in the WaveShaperBuffer `buffer`.">
 
 
 
@@ -1463,6 +1463,21 @@
 
 
 
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#examples" class="md-nav__link">
+    Examples
+  </a>
+
+</li>
+
+    </ul>
+
 </nav>
                   </div>
                 </div>
@@ -1483,14 +1498,51 @@
 <h1 id="waveshaper">WaveShaper</h1>
 <div class="highlight"><pre><span></span><code><span class="n">WaveShaper</span><span class="p">(</span><span class="nb">input</span><span class="o">=</span><span class="mf">0.0</span><span class="p">,</span> <span class="n">buffer</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </code></pre></div>
-<p>Applies wave-shaping as described in <code>buffer</code>.</p>
+<p>Applies wave-shaping as described in the WaveShaperBuffer <code>buffer</code>.</p>
+<h3 id="examples">Examples</h3>
+<div class="highlight"><pre><span></span><code><span class="c1">#-------------------------------------------------------------------------------</span>
+<span class="c1"># Create a waveshaper buffer that silences any samples with amplitude &lt; 0.5</span>
+<span class="c1">#-------------------------------------------------------------------------------</span>
+<span class="n">buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="mi">0</span> <span class="k">if</span> <span class="nb">abs</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mf">0.5</span> <span class="k">else</span> <span class="n">n</span><span class="p">)</span>
+<span class="n">sine</span> <span class="o">=</span> <span class="n">SineOscillator</span><span class="p">(</span><span class="mi">120</span><span class="p">)</span>
+<span class="n">waveshaper</span> <span class="o">=</span> <span class="n">WaveShaper</span><span class="p">(</span><span class="n">sine</span><span class="p">,</span> <span class="n">buf</span><span class="p">)</span>
+<span class="n">attenuated</span> <span class="o">=</span> <span class="n">waveshaper</span> <span class="o">*</span> <span class="mf">0.1</span>
+<span class="n">attenuated</span><span class="o">.</span><span class="n">play</span><span class="p">()</span>
+</code></pre></div>
+<div class="highlight"><pre><span></span><code><span class="c1">#-------------------------------------------------------------------------------</span>
+<span class="c1"># Create a range of different waveshaper buffers, and iterate through them.</span>
+<span class="c1">#-------------------------------------------------------------------------------</span>
+<span class="kn">import</span> <span class="nn">time</span>
+<span class="kn">import</span> <span class="nn">math</span>
+<span class="kn">import</span> <span class="nn">random</span>
+
+<span class="n">sin_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="n">math</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">n</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
+<span class="n">cos_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="n">math</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">n</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
+<span class="n">tan_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="n">math</span><span class="o">.</span><span class="n">tan</span><span class="p">(</span><span class="n">n</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
+<span class="n">tanh_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="n">math</span><span class="o">.</span><span class="n">tanh</span><span class="p">(</span><span class="n">n</span> <span class="o">*</span> <span class="mi">20</span><span class="p">))</span>
+<span class="n">sinx_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="n">math</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="mi">256</span> <span class="o">*</span> <span class="n">n</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="mi">2</span><span class="p">))</span>
+<span class="n">invert_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">n</span> <span class="k">if</span> <span class="n">n</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="k">else</span> <span class="o">-</span><span class="mi">1</span> <span class="o">-</span> <span class="n">n</span><span class="p">)</span>
+<span class="n">noise_buf</span> <span class="o">=</span> <span class="n">WaveShaperBuffer</span><span class="p">(</span><span class="k">lambda</span> <span class="n">n</span><span class="p">:</span> <span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">n</span><span class="p">))</span>
+<span class="n">bufs</span> <span class="o">=</span> <span class="p">[</span><span class="n">sin_buf</span><span class="p">,</span> <span class="n">cos_buf</span><span class="p">,</span> <span class="n">tan_buf</span><span class="p">,</span> <span class="n">tanh_buf</span><span class="p">,</span> <span class="n">sinx_buf</span><span class="p">,</span> <span class="n">invert_buf</span><span class="p">,</span> <span class="n">noise_buf</span><span class="p">]</span>
+
+<span class="n">sine</span> <span class="o">=</span> <span class="n">SineOscillator</span><span class="p">(</span><span class="mi">120</span><span class="p">)</span>
+<span class="n">waveshaper</span> <span class="o">=</span> <span class="n">WaveShaper</span><span class="p">(</span><span class="n">sine</span><span class="p">,</span> <span class="n">sin_buf</span><span class="p">)</span>
+<span class="n">attenuated</span> <span class="o">=</span> <span class="n">waveshaper</span> <span class="o">*</span> <span class="mf">0.1</span>
+<span class="n">attenuated</span><span class="o">.</span><span class="n">play</span><span class="p">()</span>
+
+<span class="k">for</span> <span class="n">buf</span> <span class="ow">in</span> <span class="n">bufs</span><span class="p">:</span>
+    <span class="n">waveshaper</span><span class="o">.</span><span class="n">set_buffer</span><span class="p">(</span><span class="s2">&quot;buffer&quot;</span><span class="p">,</span> <span class="n">buf</span><span class="p">)</span>
+    <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">1.0</span><span class="p">)</span>
+
+<span class="n">attenuated</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
+</code></pre></div>
 
   <hr>
 <div class="md-source-file">
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-03T21:39:19+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-03</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:47:13+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:

planning/NAMING/index.html

@@ -1552,11 +1552,11 @@ <h2 id="nodes">NODES</h2>
   <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-09T16:28:20+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-09</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:54:26+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
         <br>
         Created:
-        <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2023-12-09T16:28:20+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-12-09</span>
+        <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-01-03T20:54:26+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-01-03</span>
 
 
   </small>