moar updates for next version

docs/content/duck.rst

@@ -1,7 +1,7 @@
 Kick Ducker
 ===========
 
-This allows the tuba to duck out of the way of the kick drum.
+This allows the tuba's sound to duck out of the way of the kick drum. This FX is not recorded into the looper.
 
 For this to work, :ref:`SousaPlayback's drum bus's <Main Track List>` external output 
 must be routed to SousaFX's :ref:`"drum tracks L/R" inputs <Audio IO Status>`.
@@ -15,25 +15,7 @@ must be routed to SousaFX's :ref:`"drum tracks L/R" inputs <Audio IO Status>`.
 
    Available in the :ref:`bindings <Controller Bindings>` as ``toggle sidechained kick``.
 
-   The ducker affects the loopers, delays & reverb, 
-   and main input separately. When this parameter 
-   is enabled, all three duckers are enabled, 
-   except for the main input's when the 
-   looper status is "looping" or "fading out".
-
-   looper status - activated duckers:
-
-      1. Idle -       looper, delays & reverb, main input
-
-      2. Prepared -   looper, delays & reverb, main input
-
-      3. Recording -  looper, delays & reverb, main input
-
-      4. Looping -    looper, delays & reverb
-
-      5. Fading Out - looper, delays & reverb
-
-- function
+- function bottom-right
 
    Click and drag the points to change the volume envelope shape. clicks create points. shift-click deletes points. option-click-drag curves lines.
 
@@ -55,4 +37,13 @@ must be routed to SousaFX's :ref:`"drum tracks L/R" inputs <Audio IO Status>`.
 
 - disable sidechain kick when drum clip stutter enabled
 
-   I must not've liked how the drum clip stutter sounded with the ducker enabled.
+   When the drum clips are effected by the :ref:`stutter <Main Stutter Tremolo & Filters>`, disable the ducker.
+
+- smooth
+
+   smooths the duck so it doesn't click when retriggered in the middle of ducking.
+
+- mix dials
+
+   Adjusts the amount of ducking for the wobble, :ref:`delays & reverb <Delay and Reverb Sends>`, and :ref:`looper <Loopers>`.
+

docs/content/fxbanks.rst

@@ -17,13 +17,13 @@ The FX Banks are represented in the :ref:`main window <Main Window>` like so:
 
 |
 
-.. _postxfadefx:
-
-.. image:: media/postxfadebank.webp
+.. image:: media/solofxbank.webp
    :width: 60%
    :align: center
    :alt: postxfadebank
 
+SousaFX auto-switches between the Wobble FX and the Solo FX when the :ref:`looper <Loopers>` finishes recording, and finishes fading out.
+
 The "bleed" dial allows the Attack FX's output into the Sustain FX's output and vice-versa. A little bit goes a long way.
 
 The "pitch amount" dials mix external audio into the Attack and Sustain FX paths, and are only visible if the "harmonizer" inputs in the :ref:`Audio IO Status window <Audio IO Status>` are enabled. 

docs/content/install.rst

@@ -139,7 +139,16 @@ Installation
 
 .. note:: If the :ref:`Black Octopus Drum Loops are installed <blackoctopus>` then drum clips will be available in session view, but if they're missing then feel free to delete them and add your own.
 
-.. important:: `Live Link <https://help.ableton.com/hc/en-us/articles/209072789-Enabling-Link-in-Live>`_ should auto-enable thanks to the M4L device in the :ref:`"tempo" track <autolink>`, but unfortunately Live Link is not super stable, so if your audio interface has an available `loopback <https://www.sweetwater.com/insync/loopback-explained-what-is-audio-loopback/>`_ channel then setting up SousaPlayback's :ref:`sync track <syncsig>` is recommended.
+.. important:: 
+
+    `Live Link <https://help.ableton.com/hc/en-us/articles/209072789-Enabling-Link-in-Live>`_ 
+    should auto-enable thanks to the M4L device in the 
+    :ref:`"tempo" track <autolink>`. However, 
+    one of Link's Max objects glitches during discontinuous 
+    tempo changes, and although SousaPlayback has no discontinuous tempo changes by default, setting up 
+    SousaPlayback's :ref:`sync track <syncsig>` 
+    is recommended if your audio interface has an available 
+    `loopback <https://www.sweetwater.com/insync/loopback-explained-what-is-audio-loopback/>`_ channel.
 
 |
 

docs/content/loop.rst

@@ -26,8 +26,8 @@ The looper has four main states.
 
 Hitting the button (called ``looper record / fade out`` in the :ref:`bindings <Controller Bindings>`) 
 advances the looper state from Idle to Prepared. Playing tuba advances from Prepared to Recording. 
-After 8 bars or so, once the tuba's envelope drops below the :ref:`noise gate <Envelope Crossfade>`, the looper automatically stops Recording 
-and starts Looping. Hitting the button a second time 
+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 patch switches from Wobble to Solo. Hitting the 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:
@@ -48,13 +48,37 @@ Below the two loopers are the post-loop :ref:`Stutter, Tremolo, & Filters <Main
 
 - ``mute loopers``
 
+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:
+
 .. _risers:
 
-Enabling the toggle on the bottom-left makes Ableton play 
-a random riser clip whenever the looper starts fading out.
+- toggle 1
+
+   Makes :ref:`SousaPlayback <SousaPlayback>` play a random riser clip whenever the looper starts fading out.
+
+- toggle 2 
+
+   Makes the looper auto-record after the tuba drops below the :ref:`noise gate <Envelope Crossfade>` a certain number of times /after/ the looper finishes fading out.
+
+- 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.
+
+- toggle 3
+
+   Makes :ref:`SousaPlayback <SousaPlayback>` automatically change tempo during the fadeout after the looper has recorded a certain number of loops. The tempos are 128, 140, 156, and 172.
+
+- toggle 4
+
+   Auto-adjust looper length. when tempo > 150, use 16 bars. When tempo < 150, use 8 bars.
+
+- menu
 
-The toggle to the right of the aformentioned toggle makes the looper auto-record after the tuba drops below the :ref:`noise gate <Envelope Crossfade>` a certain number of times /after/ the looper finishes fading out.
+   When toggle 4's off, this menu sets the looper length.
 
-.. _cliptrigger:
+- toggle 5
 
-The menu on the bottom-right chooses how to trigger drum clips in :ref:`SousaPlayback <SousaPlayback>` after the looper fades out.
+   Plays a droplet sound effect through the metronome channel whenever the looper's prepped, done recording, or starts fading.

docs/content/mainstutter.rst

@@ -1,7 +1,7 @@
 Main Stutter Tremolo & Filters
 ==============================
 
-The "Stutter Tremolo & Filters" effect is available for three separate signal paths: Wobble Bass, Dry Solo, and Looper. All of the stutter and tremolo's subdivisions are attached to the binding's subdivisions.
+The "Stutter Tremolo & Filters" effect is available for three separate signal paths: Wobble Bass, Dryish Solo, and Looper. The stutter and tremolo's subdivisions are attached to the :ref:`binding's <Controller Bindings>` subdivisions.
 
 The following bindings affect both the Wobble Bass and Dry Solo's "Stutter Tremolo & Filters" effect:
 
@@ -50,25 +50,23 @@ Parameters
 
    Toggle stutter on and off. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Enable``
 
-- button 
-
-   Selects a random subdivision. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Random Rhythm``
-
-- vol dip
+- gated or thru
 
-   Determines how much the stutter volume will decrease as the acceleration increases from neutral.
+   Should the input be gated by the stutter, 
+   or always pass through regardless of if the stutter is occuring? 
+   This may be hardcoded to change dynamically. Don't worry about it.
 
-- offset
+- staircase
 
-   Positive offset can improve transients at the beginning of the loop by shifting them outside of the declick window.
+   modulates the stutter's startpoint as accel increases.
 
-- window
+- toggle left of staircase
 
-   Prevents clicks by quickly muting the stutter at the loop point. Determines how long muting should take.
+   determines if the stutter's startpoint modulation amount decreases as accel decreases, or sticks to its maximum value.
 
-- accel
+- button 
 
-   Slow down and speed up the stutter FX. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Accel``
+   Selects a random subdivision. :ref:`Bound <Controller Bindings>` to ``Main Input Stutter Random Rhythm``
 
 - stutter volume
 
@@ -82,19 +80,30 @@ Parameters
 
    Same as the subdiv menu.
 
-- gated or thru
+- accel
 
-   Should the input be gated by the stutter, 
-   or always pass through regardless of if the stutter is occuring? 
-   This may be hardcoded to change dynamically. Don't worry about it.
+   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``.
 
-- staircase
+- window
 
-   modulates the stutter's startpoint as accel increases.
+   Prevents clicks by quickly muting the stutter at the loop point. Determines how long muting should take.
 
-- toggle left of staircase
+- offset
+
+   Positive offset can improve transients at the beginning of the loop by shifting them outside of the declick window.
+
+- vol dip
+
+   Determines how much the stutter volume will decrease as the acceleration increases from neutral.
+
+- rightmost menu
+
+   Multiplies the stutter's subdivision.
+
+- centermost menu
+
+   Adjusts the staircase's offset.
 
-   determines if the stutter's startpoint modulation amount decreases as accel decreases, or sticks to its maximum value.
 
 Tremolo 
 -------
@@ -131,10 +140,14 @@ Parameters
 
    The max amount of volume boost when depth/mix is at 100%.
 
+- rightmost menu
+
+   Multiplies the tremolo's subdivision.
+
 Filter
 ------
 
-Also inspired by Pioneer, a DJ filter.
+Also inspired by `Pioneer <https://www.pioneerdj.com/en/product/features/mixer/filter-fx/>`_, a HP/LP filter.
 
 Parameters
 ~~~~~~~~~~
@@ -147,7 +160,9 @@ Parameters
 
    Smooths the filter frequency modulation. If mapped to a joystick, lower values follow the joystick more closely, while higher values glide towards the joystick.
 
+- filter boost
 
+   Boosts the volume of the filters.
 
 
 

docs/content/midi.rst

@@ -3,6 +3,8 @@ MIDI Preferences
 
 These are set correctly by default, and correspond to :ref:`SousaPlayback's MIDI mappings <sousaPlaybackMIDI>`.
 
+If you're using an `RME <https://www.rme-usa.com/>`_ audio interface, then the toggle near the bottom right can auto-trigger the first Snapshot in TotalMix when SousaFX loads. Ensure that the MIDI port is the same as the one selected in TotalMix > menubar > Options > Settings... > MIDI > MIDI Connections > Input Port, and under Mackie Control Options check Enable Protocol Support. 
+
 .. image:: media/midi.webp
    :width: 100%
    :align: center