comb thru release notes and polish respective pages

jbaylies · jbaylies · commit bcc1fa606ab7 · 2025-01-28T18:20:05.000-05:00
diff --git a/docs/content/bindings.rst b/docs/content/bindings.rst
@@ -11,13 +11,13 @@ The controller bindings window allows gamepad inputs to be connected to effect p
 
 The bindings may be saved as presets. There are two factory preset slots, and five user preset slots. The factory presets can't be modified, but they may be copied to user presets by first selecting the factory preset, then selecting the empty user preset and saving.
 
-To create a binding, click one of the input's circles and drag the connection to an output's circle. To delete a binding, click on the connection and press the delete key. To save bindings, click "save / overwrite".
+To create a binding, click one of the input's circles and drag the connection to an output's circle. To delete a binding, click on the connection and press the delete key. To save bindings to the selected preset, click "save / overwrite".
 
-The gamepad's inputs are set up to be ergonomic for having the controller attached to the side of a tuba. The right bumper, right trigger, and left trigger all change which bindings the X A B Y buttons are assigned to. The left trigger also changes the dpad and LB's assignments, to allow for a second bank of subdivisions.
+The right bumper, right trigger, and left trigger all change which bindings the X A B Y buttons are assigned to. The left trigger also changes the dpad and LB's assignments, to allow for a second bank of subdivisions.
 
 Click the parameter labels to open their :ref:`control logic settings <Parameter Control Logic>`.
 
-Click to the right of the parameter labels to open the parameters window that they apply to.
+Click to the right of the parameter labels to open the effect window that they apply to.
 
 .. image:: media/bindings.webp
    :width: 100%
@@ -74,5 +74,18 @@ Click to the right of the parameter labels to open the parameters window that th
 
    These four bindings can select each of the first 16 :ref:`Main Presets <Main Window>`. Clicking them selects a preset, and holding them for more than 1 second sets the preset bank. Holding preset 1 sets preset bank 1 (presets 1 - 4), holding preset 2 sets preset bank 2 (presets 5 - 8), holding Preset 3 sets preset bank 3 (presets 9 - 12), and holding preset 4 sets preset bank 4 (presets 13 - 16).
 
+Hardcoded Bindings
+------------------
 
+The following bindings are set in stone:
+
+Holding RB allows the dpad to set the :ref:`Sustain FX <FX Banks>`.
+
+Holding RT allows the dpad to set the Attack FX.
+
+Holding RB & RT allows the dpad to set the Solo FX.
+
+Holding LT while pressing RT decreases the tempo. (not active while looper's looping)
+
+Holding LT while pressing RB increases the tempo. (not active while looper's looping)
 
diff --git a/docs/content/delay.rst b/docs/content/delay.rst
@@ -1,12 +1,14 @@
 Delay and Reverb Sends
 ======================
 
-The delay sends are :ref:`bound <Controller Bindings>` via "Main Input Delay Send 1 - 4", and "Looper Delay Send 1 - 4". The reverb send is bound via "Main Input Reverb Send"
+The delay sends are :ref:`bound <Controller Bindings>` via ``Main Input Delay Send 1 - 4``, and ``Looper Delay Send 1 - 4``. The reverb send is bound via ``Main Input Reverb Send``
 
-When a delay send is mapped to a joystick, the joystick controls both the input volume and the feedback amount, which is in the spirit of `dub <https://www.youtube.com/watch?v=nA8OBQMt9WY>`_. When a delay send is mapped to a button, the button only controls the input volume and does not increase the feedback amount. The delays themselves should have a short feedback amount if they're bound to a joystick, and a long feedback amount if they're bound to a button.
+When a delay send is bound to a joystick, the joystick controls both the input volume and the feedback amount, which is in the spirit of `dub <https://www.youtube.com/watch?v=nA8OBQMt9WY>`_. When a delay send is mapped to a button, the button only controls the input volume and does not increase the feedback amount. The delays themselves should have a short feedback amount if they're bound to a joystick, and a long feedback amount if they're bound to a button.
+
+Main Input Delay 1 is unique from the other 3 because its feedback amount is available as a separate binding called ``Main Input Delay 1 fdbk``.
 
 .. image:: media/sends.webp
-   :width: 70%
+   :width: 90%
    :align: center
    :alt: sends
 
@@ -24,7 +26,7 @@ When a delay send is mapped to a joystick, the joystick controls both the input
 
 	When delay sends are mapped to joysticks, the feedback loop is allowed to be slightly positive, which can increase the volume of the feedback over time. The "max send" parameter sets how slight that positive potential is. 
 
-- "RNBO/plugins" menu
+- "RNBO/plugins" menus
 
    Sets wether to use software delays, or hardware delays. The hardware delay inputs and outputs can be set in the :ref:`Audio IO Status <Audio IO Status>` window via "external delay send/receive 1 - 4". 
 
diff --git a/docs/content/fxbanks.rst b/docs/content/fxbanks.rst
@@ -22,7 +22,7 @@ The FX Banks are represented in the :ref:`main window <Main Window>` like so:
    :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 Attack and Sustain FX Banks operate in tandem through the :ref:`Envelope Crossfade <Envelope Crossfade>`, which can collectively be called the Wobble FX. The Solo FX Bank operates independently of the Wobble FX. SousaFX can auto-switch from the Wobble FX to the Solo FX while the looper's looping. This automation can be enabled using the :ref:`looper's <Loopers>` "auto switch / manual switch" menu.
 
 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.
 
@@ -46,4 +46,13 @@ The on/off toggle has two options for fx selection when unbypassing:
 
 These options, and plugin selections, are saved within the :ref:`Main Presets <Main Window>`.
 
-:ref:`Latency compensation <Latency Compensation>` varies depending on the currently selected plugins. This ensures the lowest possible latency.
+:ref:`Latency compensation <Latency Compensation>` varies depending on the currently selected plugins. This ensures the lowest possible latency.
+
+Hardcoded Bind​ings
+--------------------------
+
+Holding RB allows the dpad to set the Sustain FX.
+
+Holding RT allows the dpad to set the Attack FX.
+
+Holding RB & RT allows the dpad to set the Solo FX.
diff --git a/docs/content/hardreq.rst b/docs/content/hardreq.rst
@@ -4,15 +4,11 @@ Hardware
 Requirements
 ------------
 
-1. mac or windows computer:
+1. m-series mac:
 
-   Any m-series mac is recommended.
+   Any m-series mac is recommended. The min-spec m4 mac mini is a beast and only costs $530 with an edu discount. SousaFX is currently untested on Windows.
 
-   - m1 macbook pro, 8 cores: SousaFX takes two minutes to start, and idles around 4.8 GB RAM, 9% CPU.
-
-   - windows 11, DDR4 2666, i7-9700K, 8 cores: Five minutes to start, idles around 4.5 GB RAM, 14% CPU.
-
-   .. note:: To optimize your computer for audio performance, `check out these articles <https://help.ableton.com/hc/en-us/search?utf8=%E2%9C%93&query=optimize>`_.
+   .. note:: To optimize your mac for audio performance, `check out these articles <https://help.ableton.com/hc/en-us/search?utf8=%E2%9C%93&query=optimize>`_.
 
 |
 
@@ -34,6 +30,8 @@ Requirements
 
 4. XLR microphone, or Yamaha SilentBrass™ mute & PersonalStudio™:
 
+   I use the Audio-Technica Pro35 clip-on mic.
+   
    If you're using a `SilentBrass mute <https://usa.yamaha.com/products/musical_instruments/winds/silent_brass/silent_brass_sbj_series/index.html>`_ you'll need an `eighth inch TRS to dual quarter inch TS cable <https://www.sweetwater.com/store/search?s=3.5mm+trs+to+dual+1%2F4+ts>`_ to connect the PersonalStudio's headphone output to the audio interface's line inputs.
 
 |
diff --git a/docs/content/install.rst b/docs/content/install.rst
@@ -89,15 +89,15 @@ Installation
 
 |
 
-8. `Download sousastep-0.10.1's Source code (zip) <https://github.com/Sousastep/sousastep/releases/latest>`_ to your ``~/Documents/​Max 8/​Projects/`` folder. It contains SousaFX, SousaVFX, and SousaPlayback. 
+8. `Download sousastep-0.10.2's Source code (zip) <https://github.com/Sousastep/sousastep/releases/latest>`_ to your ``~/Documents/​Max 8/​Projects/`` folder. It contains SousaFX, SousaVFX, and SousaPlayback. If the ``Projects`` folder does not yet exist, create it.
 
 .. raw:: html
    
    <input type="checkbox">
 
 |
 
-9. Rename ``sousastep-0.10.1`` to ``sousastep``.
+9. Rename ``sousastep-0.10.2`` to ``sousastep``.
 
 .. note:: If you're familiar with `git <https://docs.github.com/en/get-started/using-git/about-git>`_ then cloning the repo to your Projects folder is recommended.
 
diff --git a/docs/content/loop.rst b/docs/content/loop.rst
@@ -111,4 +111,4 @@ The toggles and menus at the botton of the looper window are preferences for how
 
 - 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. 
+   Sets wether Solo FX is toggled automatically when the looper starts and stops looping, or manually with the ``Toggle SoloFX`` binding. 
diff --git a/docs/content/main.rst b/docs/content/main.rst
@@ -13,7 +13,7 @@ This window outlines SousaFX's audio signal flow, and links to the :ref:`audio e
 Main Presets
 ------------
 
-On the top-right are the main presets, which save the current state of the :ref:`modulation parameters <Modulation Parameters>`, and the :ref:`FX Banks' <FX Banks>` slot selections, bleed amount, and pitch amount. The main preset selection is accessible via "preset 1 - 4" in the :ref:`bindings <Controller Bindings>`. The button to the right of the preset number sets the initial preset number to load on startup.
+On the top-right are the main presets, which save the current state of the :ref:`modulation parameters <Modulation Parameters>`, and the :ref:`FX Banks' <FX Banks>` slot selections, bleed amount, and pitch amount. The button to the right of the preset number sets the initial preset number to load on startup.
 
 .. important:: Switching from one preset to another without saving will lose changes. Switching from one preset to a blank slot allows you to save the previous preset into the blank slot.
 
@@ -37,4 +37,9 @@ Peak Meters
 
 Many FX sport a peak meter that shows how loud the FX's output has gotten. Clicking the peak meter resets it. Pressing the backslash key resets all the peak meters.
 
+Window Layout Presets
+---------------------
+
+Near the bottom-right, window layouts can be loaded and saved. Adjust the numberbox to load presets. Type in the textbox to describe the window layout. Click the "save" button to save the current preset. Click the "set" button to set the current preset as the initial preset when SousaFX launches.
+
 
diff --git a/docs/content/mainenv.rst b/docs/content/mainenv.rst
@@ -36,11 +36,11 @@ Parameters
 
 - Main
 
-   Envelope sensitivity.
+   Adjusts the overall envelope sensitivity.
 
 - Freq
 
-   The frequency to boost.
+   Sets the frequency to boost.
 
 - Boost
 
@@ -50,4 +50,16 @@ Parameters
 
 - Q
 
-   The "quality" / resonance of the boost.
+   The bandwidth of the boost. 1 is the default, towards 0 it gets narrower, towards 2 it gets wider.
+
+- low cut
+
+   Sets the frequency of the low cut filter, so that excessive subbass frequencies don't trigger the envelope.
+
+- weighting menu
+
+   Applies `k-weighting <https://www.soundonsound.com/glossary/k-weighting>`_, or `ITU-R 468 <https://en.wikipedia.org/wiki/ITU-R_468_noise_weighting>`_ weighting filters.
+
+- dB / linear menu
+
+   determines wether the envelope is logarithmic (dB), or linear.
diff --git a/docs/content/media/SFX_ISF.webp b/docs/content/media/SFX_ISF.webp
diff --git a/docs/content/media/SFX_UI.webp b/docs/content/media/SFX_UI.webp
diff --git a/docs/content/media/SFX_mainfx.webp b/docs/content/media/SFX_mainfx.webp
diff --git a/docs/content/media/startup.webp b/docs/content/media/startup.webp
diff --git a/docs/content/media/vfxmap.webp b/docs/content/media/vfxmap.webp
diff --git a/docs/content/metro.rst b/docs/content/metro.rst
@@ -65,3 +65,13 @@ To set up this effect, SousaPlayback's "drum bus" track's "Risset Ext FX" device
 .. note::
    
    Two great examples of continuous decelerandos are `Autechre Fold4 Wrap5 <https://www.youtube.com/watch?v=vUioVGqfu6s>`_, and `Vijay Iyer Historicity <https://www.youtube.com/watch?v=PG6UwES2laU&t=371s>`_.
+
+Hard​coded Bindings
+--------------------------
+
+Holding LT while pressing RT decreases the tempo. 
+
+Holding LT while pressing RB increases the tempo.
+
+These bindings are not active while the looper is looping. 
+
diff --git a/docs/content/modparms.rst b/docs/content/modparms.rst
@@ -11,7 +11,11 @@ The following modulation parameters can be controlled via the :ref:`bindings <Co
    
    - ``LFO Ceiling Envelope Curve`` 
 
-      Sets the rate of change for the envelope that controls the High Freq Mod LFO's range. Visible in the Ceiling and Floor functions.
+      Sets the rate of change for the top of the envelope that controls the High Freq Mod LFO's range. Visible in the Ceiling function.
+
+   - ``LFO Floor Envelope Curve`` 
+
+      Sets the rate of change for the bottom of the envelope that controls the High Freq Mod LFO's range. Visible in the Floor functions.
    
    - ``LFO Duty Cycle``
 
@@ -41,6 +45,11 @@ The following modulation parameters can be controlled via the :ref:`bindings <Co
 
       Decreases how much the envelope affects the range of the LFO.
 
+   - ``LFO Main Speed``
+
+      Smoothly increase and decrease the speed of the LFO.
+
+
 .. image:: media/LPFmod.webp
    :width: 100%
    :align: center
diff --git a/docs/content/releasenotes.rst b/docs/content/releasenotes.rst
@@ -24,31 +24,45 @@ Sousa​​​FX
 
   - 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..
+  - Allow int/ext fx to be set separately for each of the four delays.
   
-  - Add delay send 1 fdbk amount binding.
+  - Add feedback amount binding for delay send 1.
+
+  - Allow talkback mic into main delay sends.
   
+  - Move wobble inputs post-compression.
+
   - 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.
+
+  - Don't require swirl to be enabled for max send to be >1. 
+
+  - Add input volume params.
 
 
 - :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.
+  - Allow R1 & R1 + dpad to control :ref:`FX Bank <FX Banks>` selection.
+    
+  - Boost noise gate by 0.2 after tuba's silent for more than 20 seconds. That way, after taking a break, the idle vfx animation won't disengage right when the tuba's picked up.
   
   - Remove PCL background picture because it was using a bunch of ram.
   
   - Fix PCL 'is control within deadzone' initialization.
 
+  - Removed Main Preset 1 - 4 bindings.
+
+  - Removed 16th quintuplet, and 32nd quintuplet.
+
+  - Add LFO Main Speed.
+
+  - Add LFO Floor Envelope Curve.
+
+  - Add Main Input Delay 1 fdbk.
+
+  - Add SoloFX Toggle.
+
+  - Add octaver mute.
+
 
 - :ref:`Looper <Loopers>`
   
@@ -70,46 +84,46 @@ Sousa​​​FX
 - :ref:`Modulation Parameters <Modulation Parameters>`
   
   - Add LFO Main Speed param, with phase-locked loop and consistent min & max speed regardless of bpm or subdivision.
+
+  - Add bindings for LFO Main Speed, and LFO Floor Envelope Curve.
   
-  - Quantize subdiv rate reset to quarter note instead of whole note.
+  - Quantize subdiv rate reset to quarter note instead of whole note, which makes dotted rhythms feel a bit better.
   
   - Fix low amp mod randomized phase offset issue.
   
-  - Lower min freq.
+  - Lower minimum frequency.
   
   - 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.
+  - Allow LPF frequency to offset LPF resonance.
 
 
 - misc
   
-  - Add frequency weighting options to main envelope, and compressors.
+  - Add frequency weighting options to :ref:`main envelope <Main Envelope>`, and compressors.
   
-  - Add window layout preset system.
+  - Add :ref:`window layout preset system <Window Layout Presets>`.
   
   - 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.
+  - Add speedlims 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.
 
+  - Add video playback patcher for collabs.
+
+  - Allow SousaFX Startup to launch streaming PC via Wake On LAN.
+
 
 Sousa​​​VFX
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/content/sousavfx.rst b/docs/content/sousavfx.rst
@@ -23,13 +23,6 @@ as SousaFX, but can be modified to run on a separate computer.
 
 SousaVFX has 5 types of VFX:
 
-.. figure:: media/SFX_mainfx.webp
-   :align: center
-   :width: 100%
-   :alt: SousaVFX UI
-
-|
-
 1. Scrolling text, which I don't use much anymore because people can't tell it's text unless I tell them that it's text.
 
 2. `That Primitive Action <https://youtu.be/oKRB-gu30C8>`_ "club-ready" shader by Dude837.
@@ -60,12 +53,7 @@ SousaVFX has 5 types of VFX:
 
 	j. `PlanetOfBaobabs <https://editor.isf.video/shaders/5e7a7fea7c113618206de6ea>`_
 
-|
-
-.. figure:: media/SFX_ISF.webp
-   :align: center
-   :width: 100%
-   :alt: SousaVFX UI
+	k. & more!
 
 |
 

Original file line number	Diff line number	Diff line change
`@@ -89,15 +89,15 @@ Installation`
`89`	`89`
`90`	`90`	`\|`
`91`	`91`
`92`		-8. `Download sousastep-0.10.1's Source code (zip) <https://github.com/Sousastep/sousastep/releases/latest>`_ to your ``~/Documents/Max 8/Projects/`` folder. It contains SousaFX, SousaVFX, and SousaPlayback.
	`92`	+8. `Download sousastep-0.10.2's Source code (zip) <https://github.com/Sousastep/sousastep/releases/latest>`_ to your ``~/Documents/Max 8/Projects/`` folder. It contains SousaFX, SousaVFX, and SousaPlayback. If the ``Projects`` folder does not yet exist, create it.
`93`	`93`
`94`	`94`	`.. raw:: html`
`95`	`95`
`96`	`96`	`<input type="checkbox">`
`97`	`97`
`98`	`98`	`\|`
`99`	`99`
`100`		-9. Rename ``sousastep-0.10.1`` to ``sousastep``.
	`100`	+9. Rename ``sousastep-0.10.2`` to ``sousastep``.
`101`	`101`
`102`	`102`	.. note:: If you're familiar with `git <https://docs.github.com/en/get-started/using-git/about-git>`_ then cloning the repo to your Projects folder is recommended.
`103`	`103`
Original file line number	Diff line number	Diff line change
`@@ -111,4 +111,4 @@ The toggles and menus at the botton of the looper window are preferences for how`
`111`	`111`
`112`	`112`	`- auto switch / manual switch menu`
`113`	`113`
`114`		- Sets wether Solo FX is toggled automatically when the looper starts and stope looping, or manually with the ``Toggle SoloFX`` binding.
	`114`	+ Sets wether Solo FX is toggled automatically when the looper starts and stops looping, or manually with the ``Toggle SoloFX`` binding.