Vendor helgoboss/helgobox (ReaLearn) as basis for custom UI fork

Stripped upstream git history; starting point for replacing the native SWELL/Win32 mapping UI with something more suited to bulk editing. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-15 17:38:29 -04:00
parent 583ed77a67
commit e58f06d9fa
2232 changed files with 685575 additions and 1 deletions
@@ -0,0 +1,97 @@
+= Target "FX parameter: Set value"
+
+Sets the value of a particular track FX parameter.
+
+== Parameter controls
+
+Use them to set the parameter to be controlled.
+
+Please note that both xref:further-concepts/target.adoc#particular-fx-selector[] and xref:further-concepts/target.adoc#at-position-selector[] address the FX by its position in the FX chain.
+The difference between the two is that xref:further-concepts/target.adoc#particular-selector[] shows a dropdown containing the available parameters and xref:further-concepts/target.adoc#at-position-selector[] lets you enter the position as a number in a text field.
+The latter is useful if at the time of choosing the position, the FX is not available.
+
+== Retrigger checkbox
+
+By default, ReaLearn doesn't set the parameter if it already has the desired value. That prevents unnecessary invocations.
+
+However, some FX parameters are more like triggers. They don't actually have a value and are just used to trigger some action within that FX. In this case, it's important to enable _Retrigger_, which sets the parameter no matter what.
+
+== Real-time checkbox
+
+=== Main thread vs. real-time thread
+
+By default, ReaLearn does FX parameter value adjustments from the so-called _main_ thread instead of the _real-time_ thread. That means, in the worst case, we get latency as long as one main loop cycle. One main loop cycle is usually around 30 ms.
+
+In many control scenarios, this is completely acceptable. Basically, all control surface solutions including REAPER's built-in control surfaces, CSI and DrivenByMoss adjust FX parameters in the _main_ thread. Imagine you adjust a volume with a knob for mixing purposes. Such adjustments are usually rather slow and gradual, so it won't matter if the effect comes in 5 ms or 30 ms later.
+
+However, ReaLearn is a tool not just for mixing, also for performing. And in performing, there's sometimes demand for low latencies and fast responses, even when controlling FX parameters.
+
+=== Enabling real-time
+
+If you enable this checkbox, ReaLearn will **under certain conditions** control the FX parameter from a _real-time_ thread, enabling much lower latencies. In particular, the latency will correspond to the configured audio device block size -- the same thing that influences how fast virtual instruments respond when you press a note.
+
+The conditions are as follows:
+
+Condition 1: Same track:: The controlled FX must be on the **same track** as the ReaLearn instance.
+
+Condition 2: FX input:: The xref:key-concepts.adoc#input-port[] must be set to xref:user-interface/main-panel/input-output-section.adoc#fx-input[], **not** to a particular device.
+
+In all other circumstances, ReaLearn will fall back to adjusting the FX parameter from the _main_ thread.
+
+== Target-specific properties
+
+This target supports the following additional xref:further-concepts/target.adoc#target-property[target properties].
+
+[cols="m,1,3"]
+|===
+|Name|Type|Description
+
+|
+target.fx_parameter.index
+|
+Integer
+|
+Zero-based index of the resolved FX parameter.
+
+|
+target.fx_parameter.name
+|
+String
+|
+Name of the resolved FX parameter.
+
+|
+target.fx_parameter.macro.name
+|
+String
+|
+Name of the corresponding Pot macro parameter. Only works if this parameter is part of a preset loaded via Pot.
+
+|
+target.fx_parameter.macro.section.name
+|
+String
+|
+Name of the corresponding Pot macro parameter section. Only works if this parameter is part of a preset loaded via Pot.
+
+|
+target.fx_parameter.macro.section.index
+|
+Integer
+|
+Zero-based index of the corresponding Pot macro parameter section (within the current bank). Only works if this parameter is part of a preset loaded via Pot.
+
+|
+target.fx_parameter.macro.new_section.name
+|
+String
+|
+Name of the corresponding Pot macro parameter section, but only if this parameter marks the start of a new section. Only works if this parameter is part of a preset loaded via Pot.
+
+|
+target.fx_parameter.macro.bank.name
+|
+String
+|
+Name of the corresponding Pot macro parameter bank. Only works if this parameter is part of a preset loaded via Pot.
+|===