commit fabcc7e5516e666fc2affc3f17e3c414e9f210dd
parent 474c7b7cc3c77b400471a814d7f83e3ddcee14af
Author: fundamental <mark.d.mccurry@gmail.com>
Date: Sun, 23 Jul 2017 11:07:20 -0400
Fix Parameter Automation Doc Formatting
Diffstat:
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/doc/automation-proposal/parameter-automation-documentation.txt b/doc/automation-proposal/parameter-automation-documentation.txt
@@ -1,5 +1,5 @@
An Introduction to the ZynAddSubFX Macro System
-============================================================================
+===============================================
:author: Mark McCurry, Spencer Jackson
:toc:
@@ -14,12 +14,12 @@ ZynAddSubFX within their preferred VST host. This was a combination of:
1. Hosts providing a poor workflow for sending MIDI CC events compared to VST
parameters
2. Confusion with the use of MIDI learn within Zyn
-3. Issues regarding saving/loading parameters exposed through MIDI learn
+3. Issues regarding saving/loading parameters exposed through MIDI learn
4. Parameter resolution for MIDI CCs
5. Some parameters only produce updates on the next note
This feature attempts to address points 1, 2, & 3. Issue 4 is a large undertaking
-but is expected to become complete for the 3.1.x release. Issue 5 is being fixed
+but is expected to become complete for the 3.1.x release. Issue 5 is being fixed
one set of parameters at a time and should be addressed in the 3.0.x series.
Overview & Terminology
@@ -35,7 +35,7 @@ What is an automation?
image::automation1.png[]
- A single parameter, e.g. the addsynth base frequency in part 1, kit 1
-- A gain and offset to adjust the range of values the automation will reach
+- A gain and offset to adjust the range of values the automation will reach
(e.g. -50 cents to +150 cents)
- A mapping function (currently only linear, log, custom, etc coming soon)
@@ -45,9 +45,9 @@ What is a macro?
- A group of automations that get assigned to an automation slot
All automations in the macro are operated together. Thus turning one knob on
-your MIDI controller or a single automation lane in a DAW can change up to
+your MIDI controller or a single automation lane in a DAW can change up to
4 parameters (see <<FAQ>>)
-at a time. Using the automation mappings allows for all the parameters to be adjusted
+at a time. Using the automation mappings allows for all the parameters to be adjusted
in different amounts and/or directions, but they are all moved by actuating the macro.
Macros are assembled by adding automations to a macro slot.
@@ -61,19 +61,19 @@ What is a macro slot?
In Zynaddsubfx 3.0.2 all macro slots are global. This means that loading new
instruments does not switch the automations in any way. Only loading and saving
Zyn master files will allow you to quickly switch between macro slot configurations.
-In future versions there
-will be global macro slots and instrument macro slots that can be saved
-and loaded independently.
+In future versions there
+will be global macro slots and instrument macro slots that can be saved
+and loaded independently.
The global macro slots are exposed to VST/LV2 hosts.
This keeps the total number of parameters exposed to a host somewhat
-reasonable: 16 slots for automation of up to 64 parameters.
+reasonable: 16 slots for automation of up to 64 parameters.
At the level of a Zyn master file (.xmz) the automation slots
-can be bound to MIDI CCs; loading the file will reload the midi bindings.
+can be bound to MIDI CCs; loading the file will reload the midi bindings.
Zyn MIDI-learn files (.xlz) can store the MIDI CC+Channel linkage to all
-automation slots.
+automation slots.
The Macros View
---------------
@@ -83,10 +83,10 @@ image::macro_view.png[]
The Macro view shows:
. List of Slots
-.. Slot state (active, inactive) - currently this button is disabled, all slots are always active
+.. Slot state (active, inactive) - currently this button is disabled, all slots are always active
.. A "clear slot" button (the x) - removes all automations in the slot
.. Slot name - click name to edit
-. Macro selector buttons
+. Macro selector buttons
.. highlighted button is the slot currently selected
.. use these when macro learning to select which slot to add to
. Macro sliders - (green bars under names)
@@ -137,14 +137,14 @@ Automating a parameter in plugin mode
Binding parameters to MIDI in standalone mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-. Learn mode should be set to Normal Learn (this is the default)
+. Learn mode should be set to Normal Learn (this is the default)
. Use CTRL or click the [Learn] button to start learning an automation
. Click on one or more controls (knobs/sliders/buttons) to assign them to
automation slots
.. After clicking, each control is allocated to the next free Master
automation slot
.. Each automation slot is then placed into the "MIDI learn" mode, watching for
- the next unbound MIDI CC that arrives in standalone mode
+ the next unbound MIDI CC that arrives in standalone mode
(MIDI CCs are identified by Channel+CC# in Master automation slots)
. The user optionally sends CCs to be bound by wiggling the controls on their
physical (or virtual) MIDI device
@@ -193,7 +193,7 @@ Q: Why only 4 automations to a slot?
A: Limiting it to only 4 allowed for an easier design in the UI. There is no
limitation in the software and if many users request more capability, we will
-extend it to more.
+extend it to more.
Q: What happens if a single parameter is in multiple automation slots?
