bulk of the update for the next version

docs/content/loop.rst

@@ -1,7 +1,7 @@
 Loopers
 =======
 
-A simple "one-button" looper with a handful of effects.
+A "one-button" looper with a handful of effects. 
 
 .. image:: media/loopers.webp
    :width: 60%
@@ -12,7 +12,7 @@ A simple "one-button" looper with a handful of effects.
 
 The looper has four main states.
 
-   1. Idle
+   1. Idle (Cleared)
 
       a. Prepared
 
@@ -24,13 +24,35 @@ The looper has four main states.
 
    4. Fading Out
 
-Hitting the button (called ``looper record / fade out`` in the :ref:`bindings <Controller Bindings>`) 
+The ``looper record / fade out`` :ref:`binding <Controller Bindings>`) 
 advances the looper state from Idle to Prepared. Playing tuba advances from Prepared to Recording. 
 After 8 or 16 bars, once the tuba's envelope drops below the :ref:`noise gate <Envelope Crossfade>`, the looper automatically stops Recording 
 and starts Looping. Once the looper starts looping, the main signal path switches from Wobble to Solo. Hitting the ``looper record / fade out`` button a second time 
 prepares the looper to begin Fading Out when the loop repeats.
 
-Below the two loopers are the post-loop :ref:`Stutter, Tremolo, & Filters <Main Stutter Tremolo & Filters>`. The following :ref:`bindings <Controller Bindings>` are available:
+There're two loopers because they switch back and forth every loop, which was supposed to allow one looper to record while the other fades out, but I never use it that way.
+
+Below the looper status is a menu that sets the kind of fade out, with four options:
+
+   1. no fade
+
+   2. volude fade
+
+   3. highpass sweep up
+
+   4. lowpass sweep down
+
+The numberbox to the right of that menu sets the curvature of the volume fade.
+
+The toggle to the right of the numberbox sets wether the looper fadeout's beginning is quantized to one bar, or one loop.
+
+The toggle below the filter boost knob should be enabled if the stage volume overwhelms the noise gate.
+
+   0. After ``looper record / fade out`` pressed, wait until tuba starts playing to start recording. After 8/16 bars pass, wait until tuba stops playing to stop recording.
+
+   1. If stage volume too loud and noise gate's overwhelmed, start recording when looper button pressed, and stop recording 8/16 bars later.
+
+Below the loopers are the post-loop :ref:`Stutter, Tremolo, & Filters <Main Stutter Tremolo & Filters>`. The following :ref:`bindings <Controller Bindings>` are available:
 
 - ``Looper Stutter Enable``
 
@@ -51,7 +73,7 @@ Below the two loopers are the post-loop :ref:`Stutter, Tremolo, & Filters <Main
 Preferences
 -----------
 
-The toggles and menus at the botton of the looper window are preferences for how the looper should function. Mouseover the toggles to view tooltips describing their actions. From left to right, bottom to top:
+The toggles and menus at the botton of the looper window are preferences for how the looper should function. Mouseover the toggles to view tooltips describing their actions. From left to right, top to bottom:
 
 .. _risers:
 
@@ -65,7 +87,7 @@ The toggles and menus at the botton of the looper window are preferences for how
 
 - menu
 
-   When the looper finishes fading out, the main signal patch switches from Solo to Wobble. The "switch after tuba stops playing / switch immediately" menu decides wether the switch happens after the looper finishes fading out AND after the tuba stops playing, or if the switch happens immediately after the looper finishes fading out.
+   When the looper finishes fading out, the main signal path switches from Solo to Wobble. The "switch after tuba stops playing / switch immediately" menu decides wether the switch happens after the looper finishes fading out AND after the tuba stops playing, or if the switch happens immediately after the looper finishes fading out.
 
 - toggle 3
 
@@ -82,3 +104,11 @@ The toggles and menus at the botton of the looper window are preferences for how
 - toggle 5
 
    Plays a droplet sound effect through the metronome channel whenever the looper's prepped, done recording, or starts fading.
+
+- toggle 6
+
+   Enable to allow looper to record stutter.
+
+- auto switch / manual switch menu
+
+   Sets wether Solo FX is toggled automatically when the looper starts and stope looping, or manually with the ``Toggle SoloFX`` binding. 

docs/content/mainstutter.rst

@@ -41,12 +41,13 @@ The Looper's "Stutter Tremolo & Filters" effect uses the following bindings:
 Stutter
 -------
 
-Inspired by `Pioneer's Stutter FX <https://www.youtube.com/watch?v=hb0XLX0b4Y4&t=972s>`_.
+Inspired by `Pioneer <https://www.youtube.com/watch?v=hb0XLX0b4Y4&t=972s>`_, 
+and the `Boss RC-505 <https://discord.com/channels/702636659157499924/832889571020111923/1274884562065035376>`_
 
 Parameters
 ~~~~~~~~~~
 
-- stutter
+- No Stut / STUTTER
 
    Toggle stutter on and off. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Enable``
 
@@ -56,34 +57,46 @@ Parameters
    or always pass through regardless of if the stutter is occuring? 
    This may be hardcoded to change dynamically. Don't worry about it.
 
-- staircase
+- auto-pan
 
-   modulates the stutter's startpoint as accel increases.
+   How much the stutter should pan left and right.
 
-- toggle left of staircase
+- smol menu to the right of auto-pan
 
-   determines if the stutter's startpoint modulation amount decreases as accel decreases, or sticks to its maximum value.
+   Sets the easing function for the panning.
 
-- button 
+- button to the right of auto-pan, under smol menu 
 
    Selects a random subdivision. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Random Rhythm``
 
-- stutter volume
+- staircase
 
-   The volume of the stutter.
+   Modulates the stutter's startpoint as accel increases.
 
-- subdiv menu
+- smol toggle left of staircase
 
-   The rhythm of the subdivision. Attached to binding's subdivisions.
+   Determines if the stutter's startpoint modulation amount decreases as accel decreases, or sticks to accel's max value.
+
+- subdiv menu below staircase
+
+   Sets subdivision. Attached to binding's subdivisions.
 
 - sync
 
    Same as the subdiv menu.
 
+- stutter volume
+
+   The overall volume of the stutter.
+
 - accel
 
    Slow down and speed up the stutter FX. Upon returning to the default speed, the stutter will resync to the downbeat. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Accel`` or ``Looper Stutter Accel``.
 
+- button above accel
+
+   Enables "scatter", which never stops recording into the half-note buffer. Inspired by RC-505.
+
 - window
 
    Prevents clicks by quickly muting the stutter at the loop point. Determines how long muting should take.
@@ -96,13 +109,10 @@ Parameters
 
    Determines how much the stutter volume will decrease as the acceleration increases from neutral.
 
-- rightmost menu
+- top-right menu
 
    Multiplies the stutter's subdivision.
 
-- centermost menu
-
-   Adjusts the staircase's offset.
 
 
 Tremolo 

docs/content/octaver.rst

@@ -36,7 +36,7 @@ partially based on the `EHX Micro Synth <https://www.ehx.com/products/micro-synt
 
 |
 
-4. An octave synth put together by `Alexander Panos <https://alexanderpanos.com/about>`_ and modified by moi. 
+4. An octave synth made with help from `Alexander Panos <https://alexanderpanos.com/about>`_ 
 
 .. image:: media/octavecustom.webp
    :width: 50%
@@ -62,3 +62,23 @@ partially based on the `EHX Micro Synth <https://www.ehx.com/products/micro-synt
 - leftmost numboxes
 
 	Sets the frequency range (for the octave) within which the octave will sound. Generally, you don't need an octave below 30 Hz.
+
+- External / Internal menue
+
+   Sets wether the pitch detection is done within SousaFX or via external means.
+
+- active / bypass menu
+
+   Toggles a highpass filter.
+
+- filter boost
+
+   The filter is quiet and must be boosted ~11 dB.
+
+- freq
+
+   The HPF's frequency.
+
+- rez
+
+   The resonance of the filter, which allows the synth to increase in volume as it approaches the cutoff frequency from above.

docs/content/releasenotes.rst

@@ -1,6 +1,131 @@
 Release Notes
 =============
 
+0.10.2
+------
+
+Sousa​​​FX
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- :ref:`Stutter <Main Stutter Tremolo & Filters>`
+
+  - Add autopanner.
+
+  - Pressing same dpad button twice now reverses playback.
+
+  - Declick staircase param.
+
+  - Add scatter param, based on boss rc-505's beat scatter fx.
+
+  - Allow stutter to be effected by delays.
+
+
+- :ref:`Delay and Reverb Sends <Delay and Reverb Sends>`
+
+  - Allow delays to be effected by stutter.
+
+  - Allow int/ext fx to be set separately for each of the four delays. separate the input volume and feedback amount for the first delay to test separate bindings..
+
+  - Add delay send 1 fdbk amount binding.
+
+  - Add compressor post-delays.
+
+  - Don't require swirl to be enabled for max send to be greater than 1. also add input volume params.
+
+  - Move delay's wobble inputs post-compression.
+
+
+- :ref:`Controller Bindings <Controller Bindings>`
+
+  - Allow R1 & R1 + dpad to control four_plugin_selector selection.
+
+  - Allow SousaFX to launch streaming PC & apps via Wake On LAN.
+
+  - Boost noise gate by 0.2 after tuba's silent for more than 20 seconds. that way when you pick up the tuba after taking a break, the idle vfx animation won't disengage right when you pick up the tuba..
+
+  - Add octaver mute to controller bindings.
+
+  - Remove PCL background picture because it was using a bunch of ram.
+
+  - Fix PCL 'is control within deadzone' initialization.
+
+
+- :ref:`Looper <Loopers>`
+
+  - Allow looper fadeout trigger to quantize to either one bar or one loop.
+
+  - Add looper menu item for no fadeout, so it can be cleared immediately.
+
+  - Disallow tempo changes while looping.
+
+  - Allow soloFX to be toggled manually or automatically.
+
+  - Fix looper auto-play-after-overdub.
+
+  - Allow stutter into looper.
+
+  - Disallow stutter into looper at the beginning of the loop.
+
+
+- :ref:`Modulation Parameters <Modulation Parameters>`
+
+  - Add LFO Main Speed param, with phase-locked loop and consistent min & max speed regardless of bpm or subdivision.
+
+  - Quantize subdiv rate reset to quarter note instead of whole note.
+
+  - Fix low amp mod randomized phase offset issue.
+
+  - Lower min freq.
+
+  - Add squareness param to low amp mod lfos.
+
+  - Allow LPF freq to offset LPF rez.
+
+  - Link low amp mod to high freq mod main accel.
+
+
+- misc
+
+  - Add frequency weighting options to main envelope, and compressors.
+
+  - Add window layout preset system.
+
+  - Add volume param pre-compression.
+
+  - Allow talkback mic into main delay sends.
+
+  - Add video playback patcher for collabs.
+
+  - Adjust crossover's signal flow - allows lows signal path to either bypass LPF or sum LPF LR.
+
+  - Properly clip pitch detection.
+
+  - Improve octaver synth pitch detection.
+
+  - Add speedlim to try to prevent midi port from crashing once in a blue moon.
+
+  - Have mono compressor use the same UI template as the stereo compressor.
+
+  - Ensure main UI flashes green on auto-save.
+
+  - Fix metro auto-enable logic issue.
+
+
+Sousa​​​VFX
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Allow fx selection to load vfx presets.
+
+- Include env pause in vfx env rate-mult output.
+
+- Add polarkaleido implementations.
+
+- Add Poly Star, and Spiral ISF shaders.
+
+- Display twitch emotes via streamelements > obs > virtualcam.
+
+
+
 0.10.1
 ------
 
@@ -126,6 +251,8 @@ Past
 Known Bugs
 ----------
 
+- the "From Max 1" midi port crashes once in a blue moon, which prevents Max from sending midi to Live, and requires a reboot of SousaFX & SousaPlayback.
+
 - the :ref:`About SousaFX <Prestige System>` window shows "0 0" as install date on first boot.
 
 - if you :ref:`reinstantiate an effect <Selectable Effects>` after saving its first user preset without rebooting SousaFX, the effect will reload its default preset.

docs/content/xfade.rst

@@ -47,15 +47,17 @@ The Envelope Crossfade is post-:ref:`crossover<Crossover>`. It basically control
 
    This menu selects the easing function for the crossfade. The steeper the easing function, the more quickly the crossfade occurs.
 
-- gate
+- gate slider
 
    Sets SousaFX's main noise gate. Set it low for playing at home, and higher when performing live. The :ref:`Modulation Parameters' <Modulation Parameters>` envelope begins at the bottom of this gate, regardless of where it's set. Why is SousaFX's main noise gate in the Envelope Crossfade window? Because it's also used to...
 
-- improve envelope's attack
+- "improve envelope's attack" toggle
 
    \.\.\.improve the attack's transients by maxing out the envelope whenever it's below the noise gate.
 
-- low xfade offset
+.. note:: After a period of inactivity, the noise gate auto-increases a little, which prevents the gate from being triggered by simply picking up the tuba.
+
+- low xfade offset knob
 
    Offsets the crossfade's center for the low frequencies. 0 - 30 % is recommended. This makes the low amplitude modulation fade in before the high frequency modulation fades in, which sounds quite nice. Check out the :ref:`Mix Bus <Mix Bus>` to observe the effects of this parameter.