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>
This commit is contained in:
Paul Lipscomb
+120
@@ -0,0 +1,120 @@
|
||||
= Advanced settings dialog
|
||||
|
||||
[[advanced-settings-dialog]]
|
||||
CAUTION: Expert level!
|
||||
|
||||
This dialog allows access to advanced configuration by entering text in the https://en.wikipedia.org/wiki/YAML[YAML] configuration language.
|
||||
It can be opened using the xref:user-interface/mapping-panel/top-section.adoc#advanced-settings[] of the mapping panel.
|
||||
|
||||
== The YAML language
|
||||
|
||||
This is not a programming language, so you can't write loops, conditions or anything like that.
|
||||
Instead, think of it as a language for writing configuration.
|
||||
Do you know INI files?
|
||||
REAPER uses INI files to save configuration.
|
||||
YAML is a bit like that, just much more expressive because it allows you to not only express flat key-value pairs (e.g. `edit_fontsize=29`) but also deeply nested configuration data and lists.
|
||||
|
||||
[IMPORTANT]
|
||||
.YAML is indentation-sensitive
|
||||
====
|
||||
Indentation matters!
|
||||
The bright side of this is that it always looks clean.
|
||||
The dark side is that ReaLearn will refuse to save your settings if you messed up the indentation.
|
||||
|
||||
Therefore: Be consistent with your indentation (e.g. use always an indentation of 2 spaces for nesting) and have an utmost attention to detail when doing copy and paste from the examples in this section!
|
||||
====
|
||||
|
||||
[IMPORTANT]
|
||||
.Verbatim text is not saved
|
||||
====
|
||||
When you close the text editor and ReaLearn saves your advanced settings as part of the mapping, it will not save the text that you have entered _verbatim_.
|
||||
It will save a structural representation of what you entered.
|
||||
Plus, it will strip comments!.
|
||||
That means if you open the advanced settings again, your text could look a bit different, in particular it can have a different formatting.
|
||||
But don't worry, it _means_ exactly the same to ReaLearn.
|
||||
====
|
||||
|
||||
== Supported configuration properties
|
||||
|
||||
In this section you will find examples that cover all currently supported configuration properties.
|
||||
You can copy and paste the stuff you need to the link:https://en.wikipedia.org/wiki/Text_editor[text editor], remove the parts that you don't need and adjust the rest.
|
||||
Comments (lines starting with `#`) will be removed automatically.
|
||||
|
||||
[#mapping-lifecycle-actions]
|
||||
=== Mapping lifecycle actions
|
||||
|
||||
ReaLearn allows you to define MIDI messages to be sent to the output whenever a mapping turns active or inactive.
|
||||
See xref:further-concepts/mapping.adoc#mapping-activation-state[].
|
||||
|
||||
Example use cases:
|
||||
|
||||
* Accessing device-specific features via system-exclusive MIDI messages.
|
||||
* Choosing a different LED color/style depending on the active mapping.
|
||||
* Initializing a sys-ex-controllable display with some mapping-specific text (more difficult).
|
||||
|
||||
These are the available configuration properties:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
# Contains stuff to be done whenever this mapping becomes active.
|
||||
on_activate:
|
||||
# A list of MIDI messages to be sent to the output when this mapping becomes active.
|
||||
#
|
||||
# At the moment, only messages of type "raw" are supported. Although this covers all possible types
|
||||
# of MIDI messages, it's a bit hard to express e.g. simple NOTE ON or CC messages with this notation.
|
||||
# In particular, you would need to know how MIDI messages are presented as byte sequences. Future ReaLearn
|
||||
# versions will provide more convenient ways to describe simple MIDI messages.
|
||||
send_midi_feedback:
|
||||
# This is an example of a system-exclusive message ("SysEx"). It's usually expressed in hexadecimal string
|
||||
# notation. Make sure to include the leading F0 and trailing F7, which is the begin and end marker of all
|
||||
# system-exclusive messages!
|
||||
- raw: F0 00 20 6B 7F 42 02 00 10 77 01 F7
|
||||
# Instead of above hexadecimal string notation, you could also use an array of decimal numbers to describe a raw
|
||||
# message. The following is a NOTE ON of note 74 on channel 1 with velocity 100.
|
||||
- raw:
|
||||
# NOTE ON on channel 1
|
||||
- 144
|
||||
# Note number 74
|
||||
- 74
|
||||
# Note velocity 100
|
||||
- 100
|
||||
|
||||
# Contains stuff to be done whenever this mapping becomes inactive.
|
||||
on_deactivate:
|
||||
# A list of MIDI messages to be sent to the output when this mapping becomes inactive.
|
||||
send_midi_feedback:
|
||||
# Supports exactly the same kinds of messages as described above in "on_activate".
|
||||
- raw: F0 00 20 6B 7F 42 02 00 10 77 14 F7
|
||||
----
|
||||
|
||||
Please remember that YAML comments (e.g. `# The following line does this and that`) _will not be saved_!
|
||||
In case you want to explain something, you need to write it as YAML property, such as in the following example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
comment: "The following configuration makes the rightmost pad of the MiniLab mkII light up in red color."
|
||||
on_activate:
|
||||
send_midi_feedback:
|
||||
- raw: F0 00 20 6B 7F 42 02 00 10 77 01 F7
|
||||
----
|
||||
|
||||
ReaLearn will ignore any unknown properties.
|
||||
|
||||
TIP: If you use input xref:user-interface/main-panel/input-output-section.adoc#fx-input[] and find that MIDI lifecycle messages aren't sent, no matter what, make sure "Send feedback only if track armed" is disabled (see xref:user-interface/main-panel/menu-bar.adoc#unit-options[])!
|
||||
|
||||
WARNING: Disabling the complete ReaLearn instance will cause all mappings in all units of that instance to deactivate.
|
||||
However, sending MIDI messages on deactivation in this case will only work if the output is a device!
|
||||
If it is xref:user-interface/main-panel/input-output-section.adoc#fx-output[], it will not send anything because REAPER will not give that ReaLearn instance any chance to output MIDI messages once it's disabled.
|
||||
Instead, the MIDI message will queue up and be sent once you enable that instance again ... which is probably not what you want.
|
||||
|
||||
== Open in text editor button (Windows and Linux only)
|
||||
|
||||
Opens the settings in the system link:https://en.wikipedia.org/wiki/Text_editor[text editor] or whatever program is associated with YAML files.
|
||||
It depends on your system setup if this works or not.
|
||||
If it does and if your link:https://en.wikipedia.org/wiki/Text_editor[text editor] is good, this can make editing larger YAML snippets more convenient (e.g. by providing syntax highlighting).
|
||||
|
||||
As soon as you save the file and close the editor, the text will automatically appear in the "Advanced settings" text area.
|
||||
|
||||
== Help button
|
||||
|
||||
Will open an online version of the user guide section that describes the available configuration properties.
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
= Bottom section
|
||||
|
||||
image:realearn/screenshots/mapping-panel-bottom.png[Screenshot]
|
||||
|
||||
The section at the bottom has the following functions:
|
||||
|
||||
- To provide context-sensitive help for the glue section
|
||||
- To provide control information, feedback information and error reporting
|
||||
- To provide navigation and general mapping control
|
||||
|
||||
== Help
|
||||
|
||||
Context-sensitive help for the glue section.
|
||||
Whenever you touch a setting in the glue section, some text will appear which explains what this element does, both for the _control_ and for the
|
||||
_feedback_ direction (if applicable).
|
||||
|
||||
== Activity info area
|
||||
|
||||
The left text area shows information about how an incoming control value was handled and possible target control errors.
|
||||
|
||||
NOTE: If the target supports MIDI real-time control and the source is a MIDI source, this currently only works if "Log target control" is enabled (see xref:user-interface/main-panel/menu-bar.adoc#logging[]).
|
||||
|
||||
The right text area shows information about which feedback values are sent from the glue section to the source.
|
||||
|
||||
[#beep-on-success]
|
||||
== Beep on success checkbox
|
||||
|
||||
Makes the mapping play a sound whenever the target has been invoked successfully.
|
||||
Nice for trigger-like targets such as xref:targets/realearn/take-mapping-snapshot.adoc[] for which there's no other good way to know if it worked.
|
||||
|
||||
[#previous]
|
||||
== Previous button
|
||||
|
||||
Allows you to jump to the previous mapping.
|
||||
Considers only mappings that are currently visible in the mapping rows panel.
|
||||
|
||||
[#next]
|
||||
== Next button
|
||||
|
||||
Allows you to jump to the next mapping.
|
||||
Considers only mappings that are currently visible in the mapping rows panel.
|
||||
|
||||
[#enabled]
|
||||
== Enabled checkbox
|
||||
|
||||
Enables or disables the mapping as a whole.
|
||||
+643
@@ -0,0 +1,643 @@
|
||||
= Glue section
|
||||
:control: Control →
|
||||
:feedback: Feedback ←
|
||||
:momentary-button: Momentary button
|
||||
:velocity-sensitive-button: Velocity-sensitive button (key, pad, ...)
|
||||
:incremental-velocity-sensitive-button: Incremental velocity-sensitive button (key, pad, ...)
|
||||
:incremental-button: Incremental button
|
||||
:range-element: Range element (fader, knob, ...)
|
||||
:encoder: Rotary endless encoder
|
||||
:led: LED
|
||||
:value-indicator: Value indicator (LED ring, motor fader, ...)
|
||||
|
||||
image:realearn/screenshots/mapping-panel-glue.png[Screenshot]
|
||||
|
||||
The xref:key-concepts.adoc#glue[] section is divided into several subsections some of which make sense for all kinds of sources and others only for some.
|
||||
Having so many settings available at the same time can be a bit daunting.
|
||||
ReaLearn helps you by hiding settings that don't make sense in the current context.
|
||||
|
||||
It shows or hides them based on criteria like this:
|
||||
|
||||
* Is control and/or feedback enabled for the mapping?
|
||||
* What are the characteristics of the source and target?
|
||||
* What's the current setting of <<absolute-mode>> and <<make-absolute>>?
|
||||
|
||||
== Reset to defaults button
|
||||
|
||||
Resets the settings to some sensible defaults.
|
||||
|
||||
[#reverse]
|
||||
== Reverse checkbox
|
||||
|
||||
{control}::
|
||||
include::partial$glue/reverse/control.txt[]
|
||||
|
||||
{feedback}::
|
||||
include::partial$glue/reverse/feedback.txt[]
|
||||
|
||||
include::partial$glue/usage-dependent-effect.adoc[]
|
||||
|
||||
|{momentary-button}
|
||||
|{control}
|
||||
|Switches the target off when pressed and on when released
|
||||
|
||||
|{range-element}
|
||||
|{control}
|
||||
|The higher the fader position, the lower the target value
|
||||
|
||||
|{incremental-button}
|
||||
|{control}
|
||||
|Decreases the target value on press instead of increasing it
|
||||
|
||||
|{encoder}
|
||||
|{control}
|
||||
|Decreases the target value when turning clockwise and decreases it when turning counter-clockwise
|
||||
|
||||
|{led}
|
||||
|{feedback}
|
||||
|Uses *off* LED color if target is on and *on* LED color if target is off
|
||||
|
||||
|{value-indicator}
|
||||
|{feedback}
|
||||
|The higher the target value, the lower the indicated value
|
||||
|
||||
|===
|
||||
|
||||
[#target-min-max]
|
||||
== Target Min/Max controls
|
||||
|
||||
{control}::
|
||||
include::partial$glue/target-min-max/control.txt[]
|
||||
|
||||
{feedback}::
|
||||
include::partial$glue/target-min-max/feedback.txt[]
|
||||
|
||||
.Squeezing the track volume value range
|
||||
====
|
||||
If you set this to "-6 dB to 0 dB" for a _Track volume_ target, the volume will always stay within that dB range when controlled via this mapping.
|
||||
However, it wouldn't prevent the volume from exceeding that range if changed e.g. in REAPER itself.
|
||||
====
|
||||
|
||||
This setting can be used with all targets that work with xref:further-concepts/mapping.adoc#absolute-control-value[absolute control values] (all targets except xref:targets/project/invoke-reaper-action.adoc[] with relative xref:targets/project/invoke-reaper-action.adoc#invocation-type[]).
|
||||
|
||||
[#value-sequence]
|
||||
== Value sequence field
|
||||
|
||||
{control}::
|
||||
include::partial$glue/value-sequence/control.txt[]
|
||||
|
||||
Allows you to define a xref:further-concepts/glue.adoc#target-value-sequence[].
|
||||
All values are entered comma-separated using the target unit specified with the xref:user-interface/mapping-panel/target-section.adoc#display-unit[].
|
||||
|
||||
You can provide only one of <<target-min-max>> or <<value-sequence>>.
|
||||
|
||||
[#group-interaction]
|
||||
== Group interaction
|
||||
|
||||
{control}::
|
||||
include::partial$glue/group-interaction/control.txt[]
|
||||
|
||||
See xref:further-concepts/mapping.adoc#group[].
|
||||
|
||||
TIP: If you want to control _other_ mappings only and not _this_ mapping, just pick a target that doesn't have any effect, for example the xref:targets/realearn/dummy.adoc[].
|
||||
|
||||
None::
|
||||
Switches group interaction off.
|
||||
This is the default.
|
||||
Incoming control events will just affect _this_
|
||||
mapping, not others.
|
||||
|
||||
[[same-control]] Same control::
|
||||
This will broadcast any incoming control value to all other mappings in the same group.
|
||||
The glue section of this mapping will be ignored when controlling the other mappings.
|
||||
The glue sections of the other mappings will be respected, including the <<source-min-max>>.
|
||||
|
||||
[[same-target-value]] Same target value::
|
||||
This will set the target value of each other mapping in the same group to the target value of this mapping.
|
||||
Nice: It will respect the <<target-min-max>> of both this mapping and the other mappings.
|
||||
All other settings of the glue section will not be processed.
|
||||
Needless to say, this kind of control is always absolute, which means it can lead to parameter jumps.
|
||||
Therefore, it's most suited for on/off targets.
|
||||
If you don't like this, choose <<same-control>> instead.
|
||||
|
||||
[[inverse-control]] Inverse control::
|
||||
This is like <<same-control>> but broadcasts the _inverse_ of the incoming control value.
|
||||
|
||||
[[inverse-target-value]] Inverse target value::
|
||||
This is like <<same-target-value>> but sets the target values of the other mappings to the
|
||||
_inverse_ value.
|
||||
This is very useful in practice with buttons because it essentially gives you exclusivity within one group.
|
||||
It's a great alternative to the xref:user-interface/mapping-panel/target-section.adoc#exclusive[] which is available for some targets.
|
||||
Unlike the latter, <<inverse-target-value>> allows for exclusivity between completely different target types and completely custom groupings - independent of e.g. organization of tracks into folders.
|
||||
|
||||
Inverse target value (on only)::
|
||||
Variation of <<inverse-target-value>> that applies the inverse only when the target value is > 0%.
|
||||
|
||||
Inverse target value (off only)::
|
||||
Variation of <<inverse-target-value>> that applies the inverse only when the target value is 0%.
|
||||
|
||||
[[feedback-type-controls]]
|
||||
== Feedback type controls
|
||||
|
||||
{feedback}::
|
||||
include::partial$glue/feedback-type/feedback.txt[]
|
||||
|
||||
See xref:further-concepts/glue.adoc#feedback-type[].
|
||||
|
||||
[#feedback-style]
|
||||
== Feedback style menu (...)
|
||||
|
||||
The ... button provides options to change the _feedback style_.
|
||||
At the moment, it's all about setting colors.
|
||||
|
||||
TIP: If you use xref:further-concepts/glue.adoc#dynamic-feedback[], changes made here don't have any effect because you are supposed to provide style properties as part of the Luau script result (which is much more flexible).
|
||||
|
||||
Color / Background color::
|
||||
With this you can define the color and background color of the displayed text.
|
||||
Of course this will only work if the source supports it!
|
||||
|
||||
<Default color>:::
|
||||
Chooses the default color, that is the one which is preferred for the corresponding controller and display type.
|
||||
|
||||
<Pick color...>:::
|
||||
Opens a color picker so you can choose the color of your choice.
|
||||
|
||||
_Property name_::: Maybe you don't want a fixed color but a dynamic one that changes whenever your target changes.
|
||||
Choose one of the properties to make that happen.
|
||||
Do a full-text search in the reference to learn about the meaning of the property.
|
||||
|
||||
[[source-min-max]]
|
||||
== Source Min/Max controls
|
||||
|
||||
{control}::
|
||||
include::partial$glue/source-min-max/control.txt[]
|
||||
|
||||
{feedback}::
|
||||
include::partial$glue/source-min-max/feedback.txt[]
|
||||
|
||||
Doesn't have an effect on xref:further-concepts/mapping.adoc#relative-control-value[relative control values].
|
||||
|
||||
include::partial$glue/usage-dependent-effect.adoc[]
|
||||
|
||||
|{momentary-button}
|
||||
|{control}
|
||||
|If min > 0 and <<out-of-range-behavior>> is <<out-of-range-behavior-ignore>>, button releases are ignored.
|
||||
Because this also affects {feedback}, it's usually better to use the <<button-filter>> instead!
|
||||
|
||||
|{velocity-sensitive-button}
|
||||
|{control}
|
||||
|Defines the observed velocity range, for example to react to only the lower velocity layer of a key press.
|
||||
|
||||
|{range-element}
|
||||
|{control}
|
||||
|Defines the observed value range.
|
||||
For example to react only to the upper half of a fader.
|
||||
|
||||
|{led}
|
||||
|{feedback}
|
||||
|On many controllers which support colored LEDs, *Min* sets the *off* color and *Max* sets the *on* color.
|
||||
|
||||
|{value-indicator}
|
||||
|{feedback}
|
||||
|Sets the lowest/highest indicated value.
|
||||
|
||||
|===
|
||||
|
||||
By restricting that range, you basically tell ReaLearn to or only the lower velocity layer of a key press.
|
||||
|
||||
This range also determines the minimum and maximum xref:key-concepts.adoc#feedback[] value.
|
||||
|
||||
[#out-of-range-behavior]
|
||||
== Out-of-range behavior menu
|
||||
|
||||
{control}::
|
||||
include::partial$glue/out-of-range-behavior/control.txt[]
|
||||
|
||||
{feedback}::
|
||||
include::partial$glue/out-of-range-behavior/feedback.txt[]
|
||||
|
||||
See <<source-min-max>> and <<target-min-max>>.
|
||||
|
||||
There are the following options:
|
||||
|
||||
[cols="h,d,d"]
|
||||
|===
|
||||
| | {control} | {feedback}
|
||||
|
||||
| Min or max | If the source value is < _Source Min_, ReaLearn will behave as if _Source Min_ was received (or 0% if _Source Min_ = _Source Max_).
|
||||
|
||||
If the source value is > _Source Max_, ReaLearn will behave as if _Source Max_ was received (or 100% if _Source Min_ = _Source Max_). | If the target value is < _Target Min_, ReaLearn will behave as if _Target Min_ was detected (or 0% if _Target Min_ = _Target Max_).
|
||||
|
||||
If the target value is > _Target Max_, ReaLearn will behave as if _Target Max_ was detected (or 100% if _Target Min_ = _Target Max_).
|
||||
|
||||
| Min | ReaLearn will behave as if _Source Min_ was received (or 0% if _Source Min_ = _Source Max_). | ReaLearn will behave as if _Target Min_ was detected (or 0% if _Target Min_ = _Target Max_). Useful for getting radio-button-like feedback.
|
||||
|
||||
|[[out-of-range-behavior-ignore,Ignore]] Ignore | Target value won't be touched. | No feedback will be sent.
|
||||
|===
|
||||
|
||||
[[absolute-mode]]
|
||||
== Mode ("Absolute mode") menu
|
||||
|
||||
{control}::
|
||||
include::partial$glue/absolute-mode/control.txt[]
|
||||
|
||||
TIP: Not all modes make sense at all times!
|
||||
It mostly depends on the character of the source.
|
||||
If a mode doesn't make sense given the current source, it will be marked as `NOT APPLICABLE`.
|
||||
In this case, you should choose another mode or change the source.
|
||||
|
||||
[[absolute-mode-normal]] Normal::
|
||||
|
||||
Takes and optionally transforms absolute source control values _the normal way_. _Normal_ means that the current target value is irrelevant and the target will just be set to whatever absolute control value is coming in (potentially transformed).
|
||||
|
||||
[[incremental-button,Incremental button mode]] Incremental button::
|
||||
With this you can "go relative" with buttons instead of encoders in a "previous/next fashion".
|
||||
+
|
||||
Let's assume you use the _MIDI Note velocity_ and select _Incremental button_ mode.
|
||||
Then it works like this: Each time you press the key, the target value will increase, according to the mode's settings.
|
||||
You can even make the amount of change velocity-sensitive!
|
||||
If you want the target value to decrease, just check the <<reverse>>.
|
||||
|
||||
[[toggle-button-mode,Toggle button mode]]
|
||||
Toggle button::
|
||||
Toggle button mode is used to toggle a target between on and off states.
|
||||
It only makes sense for momentary buttons (which fire a value > 0 on each press).
|
||||
+
|
||||
Here's how it works in detail:
|
||||
+
|
||||
* If the current target value is within the first half of the target min/max range, it's considered as _off_ and will therefore be switched _on_ (set to _target max_).
|
||||
If it's within the second half, it's considered as _on_ and will therefore be switched _off_ (set to _target min_).
|
||||
* It works a bit differently if _target min_ and _target max_ have the same value (which is a common technique to set the target to a specific value on the press of a button).
|
||||
Instead of toggling between _target min_ and _target max_, this mode now toggles between this specific value (= _target min_ = _target max_) and 0%.
|
||||
This is useful whenever you have a set of buttons each of which sets the same target to a different value, and you want them to toggle between the specified value and an initial value (0%).
|
||||
+
|
||||
This mode is not supported for controller mappings that have a virtual target.
|
||||
+
|
||||
[TIP]
|
||||
====
|
||||
Sometimes the controller itself provides a toggle mode for buttons. *Don't use it!*
|
||||
|
||||
Always set up your controller buttons to work in momentary mode!
|
||||
It's impossible for the controller to know which state (on/off) a target currently has.
|
||||
Therefore, if you use the controller's built-in toggle function, it's quite likely that it gets out of sync with the actual target state at some point.
|
||||
|
||||
ReaLearn's own toggle mode has a clear advantage here.
|
||||
====
|
||||
|
||||
[[make-relative]] Make relative::
|
||||
This converts incoming absolute fader/knob movements into relative adjustments of the target value.
|
||||
It somewhat resembles takeover mode <<takeover-mode-parallel>> but has important differences:
|
||||
|
||||
- It's guaranteed that a full fader/knob swipe from 0% to 100% always results in a swipe over the full target range (assuming the target was at 0% initially).
|
||||
- It doesn't need to know the current target value.
|
||||
Which means it also works for mappings with xref:further-concepts/target.adoc#virtual-target[virtual targets].
|
||||
|
||||
[[performance-control]] Performance control::
|
||||
This mode emulates the behavior of a typical soft synth modulation matrix mapping: It uses the target value that has been set in REAPER (not via this ReaLearn mapping) as an offset and starts changing it from there.
|
||||
|
||||
[#round-target-value]
|
||||
== Round target value checkbox
|
||||
|
||||
{control}::
|
||||
include::partial$glue/round-target-value/control.txt[]
|
||||
|
||||
Only a few targets support that, such as xref::targets/project/set-tempo.adoc[].
|
||||
|
||||
[#takeover-mode]
|
||||
== Takeover mode menu
|
||||
|
||||
{control}::
|
||||
include::partial$glue/takeover-mode/control.txt[]
|
||||
|
||||
If you are not using motorized faders, absolute mode is inherently prone to parameter jumps.
|
||||
A parameter jump occurs if you touch a control element (e.g. fader) whose position in no way reflects the current target value.
|
||||
This can result in audible jumps because the value is changed abruptly instead of continuously.
|
||||
You can deal with this by setting the right takeover mode.
|
||||
|
||||
ReaLearn provides multiple takeover modes that decide how to deal with situations when a target parameter jump would occur.
|
||||
|
||||
Off::
|
||||
|
||||
The default setting: Jumps allowed.
|
||||
|
||||
[[pick-up]] Pick up::
|
||||
This is the same as _Soft takeover_ in REAPER's built-in MIDI learn.
|
||||
It prevents jumps by not changing the target value until your control element reaches it.
|
||||
+
|
||||
In certain cases, this mode can cause the target value to get stuck.
|
||||
This happens with faders/knobs that cause jumps themselves when moved very rapidly.
|
||||
If you don't like that, you might want to try <<pick-up-tolerant>>.
|
||||
|
||||
[[pick-up-tolerant]] Pick up (tolerant)::
|
||||
This is like <<pick-up>> but makes extra sure that the target value doesn't get stuck.
|
||||
+
|
||||
However, unlike <<pick-up>>, this mode will jump if you cause a jump on your controller!
|
||||
Imagine using a touch strip.
|
||||
This kind of control element allows you to jump to arbitrary values at any time.
|
||||
Tolerant mode will not prevent this kind of jumps!
|
||||
|
||||
Long time no see::
|
||||
This is similar to <<pick-up>> with the difference that the current target value will gradually "come your way".
|
||||
This results in seamless and fast reunification of control and target value, but it can feel weird because the target value can temporarily move in the opposite direction of the fader movement.
|
||||
In older ReaLearn versions this was called "Slowly approach if jump too big".
|
||||
|
||||
[[takeover-mode-parallel]] Parallel::
|
||||
With this mode, the target will simply follow your fader moves, in exactly the same tempo - without any scaling.
|
||||
Reunification only happens when both control and target value meet at the "borders".
|
||||
|
||||
Catch up::
|
||||
This mode is sometimes called "Proportional" or "Value scaling" mode.
|
||||
It's like "Parallel" mode but the target value is allowed to move slower than the control value - hence the control can catch up (converge) faster.
|
||||
|
||||
[#control-transformation]
|
||||
== Control transformation (EEL) field
|
||||
|
||||
{control}::
|
||||
include::partial$glue/control-transformation/control.txt[]
|
||||
|
||||
This feature allows you to write a formula that transforms incoming control values.
|
||||
While very powerful because it allows for arbitrary transformations (velocity curves, random values - you name it), it's not everybody's cup of tea to write something like that.
|
||||
The formula must be written in the language https://www.cockos.com/EEL2/[EEL2].
|
||||
Some REAPER power users might be familiar with it because REAPER's JSFX uses the same language.
|
||||
|
||||
Luckily, ReaLearn has a fancy editor which visualizes the formula and has some predefined templates built-in (available on Windows and macOS only at the moment).
|
||||
Press the "*...*" button to open the editor.
|
||||
Code changes are applied immediately.
|
||||
|
||||
The most simple formula is `y = x`, which means there will be no transformation at all. `y = x / 2` means that incoming control values will be halved.
|
||||
You get the idea: `y` represents the desired target control value (= output value) and `x` the incoming source control value (= input value).
|
||||
Both are 64-bit floating point numbers between 0.0 (0%) and 1.0 (100%).
|
||||
|
||||
The script can be much more complicated than the mentioned examples and make use of all built-in EEL2 language features.
|
||||
The important thing is to assign the desired value to `y` at some point.
|
||||
|
||||
The following variables/functions are available in the formula:
|
||||
|
||||
`y`:: Initially contains the _current_ target value.
|
||||
You can use that value in order to calculate the new value.
|
||||
With this, you can essentially craft your own relative mode!
|
||||
|
||||
`y_type`:: This contains the type of the produced output value.
|
||||
By default, it's 0. The following types are currently supported:
|
||||
|
||||
`0`::: Absolute continuous value (a value between 0.0 and 1.0)
|
||||
`1`::: Relative discrete value (an integer, e.g. -5 for 5 decrements)
|
||||
|
||||
`realearn_timestamp`:: This contains the precise timestamp of the incoming control event in seconds.
|
||||
This can be used to calculate the delta time between two consecutive control events, which in turn can be used to simulate encoder acceleration, for example.
|
||||
+
|
||||
The timestamp has audio block precision.
|
||||
For MIDI events, it even takes the intra-block offset into account - which is as precise as it can get, even if you use a high audio buffer size in the REAPER audio device settings.
|
||||
|
||||
`y_last`:: This contains the last value of the target before it was affected by this particular mapping.
|
||||
+
|
||||
Allows you to come up with a performance control mode typical for synth parameter mappings, just like the built-in <<performance-control>> mode but more customizable.
|
||||
Try this for example: `y = y_last + x * (1 - y_last)`
|
||||
|
||||
`rel_time`:: This contains the number of milliseconds since this mapping has last been triggered with a control message coming from the source.
|
||||
+
|
||||
As soon as you use this and a control message comes in, ReaLearn will start invoking your formula _repeatedly_!
|
||||
That means, this variable is your entrance ticket to smooth transitions and continuous parameter modulation.
|
||||
+
|
||||
A few examples:
|
||||
+
|
||||
* Smooth transition from current value to control value: `rel_time; y = abs(x - y) < 0.05 ? stop : y + 0.1 * (x - y)`
|
||||
* Sinus LFO: `y = (sin(rel_time / 500) + 1) / 2`
|
||||
* Linear transition to control value (1 second): `y = abs(x - y) < 0.05 ? stop : x * min(rel_time / 500, 1)`
|
||||
* 2 seconds chaos: `y = rel_time < 2000 ? rand(1) : stop`
|
||||
* Setting a value with delay: `y = rel_time < 2000 ? none : stop(0.5)`
|
||||
|
||||
`stop` and `stop(...)`::
|
||||
In combination with `rel_time`, this stops repeated invocation of the formula until the mapping is triggered again.
|
||||
+
|
||||
Good for building transitions with a defined end.
|
||||
+
|
||||
Stopping the invocation at some point is also important if the same parameter should be controlled by other mappings as well.
|
||||
Otherwise, if multiple mappings continuously change the target parameter, only the last one wins.
|
||||
+
|
||||
This also exists as a function, which lets you do both, returning a target value *and* stopping the transition.
|
||||
Pass the desired value in the parentheses, e.g. `stop(0.5)`.
|
||||
|
||||
`none`::
|
||||
Usually, each repeated (see `rel_time`) invocation always results in a target invocation (unless the target is not retriggerable and already has the desired value).
|
||||
Sometimes this is not desired.
|
||||
In this case, one can return `none`, in which case the target will not be touched.
|
||||
+
|
||||
Good for transitions that are not continuous, especially if other mappings want to control the parameter as well from time to time.
|
||||
|
||||
`realearn_last_feedback_value`::
|
||||
Contains the last numeric feedback value sent through this mapping.
|
||||
Before that, it's zero.
|
||||
This can come in handy for mappings with xref:further-concepts/target.adoc#virtual-target[], for which the variable `y` is always zero because virtual targets don't know the concept of a current value.
|
||||
+
|
||||
WARNING: This variable is experimental, better don't rely on it!
|
||||
|
||||
`realearn_dbg()`::
|
||||
This is a function which takes a floating-point value as parameter.
|
||||
It prints that floating-point value to `stdout` (*not* the ReaScript debug console!).
|
||||
Useful for debugging.
|
||||
|
||||
Learn more about the order in which ReaLearn processes the elements in the glue section by looking at the xref:glue-signal-flow.adoc[] diagrams.
|
||||
|
||||
[#step-size-min-max]
|
||||
== Step size Min/Max controls
|
||||
|
||||
{control}::
|
||||
include::partial$glue/step-size-min-max/control.txt[]
|
||||
|
||||
When you deal with relative adjustments of target values in terms of increments/decrements, then you have great flexibility because you can influence the _amount_ of those increments/decrements.
|
||||
This is done via the _Step size_ setting, which is available for all
|
||||
_continuous_ targets.
|
||||
|
||||
Step size Min:: Specifies how much to increase/decrease the target value when an increment/decrement is received.
|
||||
+
|
||||
include::partial$glue/usage-dependent-effect.adoc[]
|
||||
|
||||
|{incremental-button}
|
||||
|{control}
|
||||
|Sets the target value change amount when button pressed
|
||||
|
||||
|{incremental-velocity-sensitive-button}
|
||||
|{control}
|
||||
|Sets the target value change amount when button pressed with the lowest velocity
|
||||
|
||||
|{encoder}
|
||||
|{control}
|
||||
|Sets the target value change amount for an incoming non-accelerated increment/decrement
|
||||
|
||||
|{encoder} with <<make-absolute>>
|
||||
|{control}
|
||||
|Sets the amount added/subtracted to calculate the simulated absolute value from an incoming non-accelerated increment/decrement
|
||||
|
||||
|===
|
||||
|
||||
Step size Max:: Sets the maximum amount by which to increase/decrease the target value with one interaction. If you set this to the same value as _Min_, encoder acceleration or changes in velocity will have no effect on the incrementation/decrementation amount.
|
||||
If you set it to 100%, the effect is maximized.
|
||||
+
|
||||
include::partial$glue/usage-dependent-effect.adoc[]
|
||||
|
||||
|{incremental-velocity-sensitive-button}
|
||||
|{control}
|
||||
|Sets the target value change amount when button pressed with the highest velocity
|
||||
|
||||
|{encoder}
|
||||
|{control}
|
||||
|If the hardware encoder supports acceleration, this sets the target value change amount for the most accelerated increment/decrement
|
||||
|
||||
|===
|
||||
|
||||
[#speed-min-max]
|
||||
== Speed Min/Max controls
|
||||
|
||||
{control}::
|
||||
include::partial$glue/speed-min-max/control.txt[]
|
||||
|
||||
When you choose a target with a xref:further-concepts/target.adoc#discrete-value-range[], the <<step-size-min-max>> label will change into
|
||||
_Speed_.
|
||||
If a target is discrete, it cannot have arbitrarily small step sizes.
|
||||
It rather has one predefined atomic step size.
|
||||
Allowing arbitrary step size adjustment wouldn't make sense.
|
||||
That's why _Speed_ allows you to _multiply_ (positive numbers) or _"divide"_ (negative numbers) value increments with a factor instead.
|
||||
Negative numbers are most useful for rotary encoders because they will essentially lower their sensitivity.
|
||||
Virtual targets are always discrete.
|
||||
|
||||
.Speed example
|
||||
====
|
||||
Let's assume you selected the discrete xref:targets/fx/browse-presets.adoc[], which is considered discrete because an FX with for example 5 presets has 6 well-defined possible values (including the <no preset> option), there's nothing inbetween.
|
||||
And let's also assume that you have a controller like Midi Fighter Twister whose rotary encoders don't support built-in acceleration.
|
||||
|
||||
Now you slightly move an encoder clock-wise and your controller sends an increment +1. If the _Speed Min_ slider was at 1 (default), this will just navigate to the next preset (+1).
|
||||
If the _Speed Min_ slider was at 2, this will jump to the 2nd-next preset (+2).
|
||||
And so on.
|
||||
====
|
||||
|
||||
Remarks:
|
||||
|
||||
* There are FX plug-ins out there which report their parameter as discrete with an insanely small step size (e.g. some Native Instrument plug-ins).
|
||||
This kind of defeats the purpose of discrete parameters and one can argue that those parameters should actually be continuous.
|
||||
In such a case, moving your rotary encoder might need _a lot_ of turning even if you set _Speed_ to the apparent maximum of 100! In this case you will be happy to know that the text field next to the slider allows you to enter values higher than 100.
|
||||
* You can set the "Speed" slider to a negative value, e.g. -2. This is the opposite.
|
||||
It means you need to make your encoder send 2 increments in order to move to the next preset.
|
||||
Or -5: You need to make your encoder send 5 increments to move to the next preset.
|
||||
This is like slowing down the encoder movement.
|
||||
|
||||
[#encoder-filter]
|
||||
== Encoder filter menu
|
||||
|
||||
{control}::
|
||||
include::partial$glue/encoder-filter/control.txt[]
|
||||
|
||||
For example, if you want to invoke one action on clockwise movement and another one on counter-clockwise movement.
|
||||
Or if you want to use different step sizes for different movements.
|
||||
|
||||
Increment & decrement:: ReaLearn will process both increments and decrements.
|
||||
Increment only:: ReaLearn will ignore decrements.
|
||||
Decrement only:: ReaLearn will ignore increments.
|
||||
|
||||
[#wrap]
|
||||
== Wrap checkbox
|
||||
|
||||
{control}::
|
||||
include::partial$glue/wrap/control.txt[]
|
||||
|
||||
If unchecked, the target value will not change anymore if there's an incoming decrement but the target already reached its minimum value.
|
||||
If checked, the target value will jump to its maximum value instead.
|
||||
It works analogously if there's an incoming increment and the target already reached its maximum value.
|
||||
|
||||
If this flag is enabled for controller mappings which have a virtual target, every main mapping controlled by that virtual control element will wrap - even if the main mapping itself doesn't have <<wrap>> enabled.
|
||||
|
||||
[[make-absolute]]
|
||||
== Make absolute
|
||||
|
||||
{control}::
|
||||
include::partial$glue/make-absolute/control.txt[]
|
||||
|
||||
This is useful if you have configured your controller to be relative all the way (which is good!) but you want to use a control transformation EEL formula - which is not possible if you change the target with relative increments.
|
||||
It works by keeping an internal absolute value, incrementing or decrementing it accordingly and then processing it just like normal absolute control values.
|
||||
|
||||
By checking this box:
|
||||
|
||||
* You lose the possibility to be perfectly free of parameter jumps (but you can try to mitigate that loss by using the jump settings).
|
||||
* You gain support for control-direction EEL transformation, non-continuous target value sequences and source range.
|
||||
* You can still use some of the relative-only features: Step size and rotate!
|
||||
|
||||
[#fire-mode]
|
||||
== Fire mode menu
|
||||
|
||||
{control}::
|
||||
include::partial$glue/fire-mode/control.txt[]
|
||||
|
||||
Normally, when a button gets pressed, it controls the target immediately.
|
||||
However, by using this dropdown and by changing the values below it, you can change this behavior.
|
||||
This dropdown provides different fire modes that decide how exactly ReaLearn should cope with button presses.
|
||||
|
||||
Fire on press (or release if > 0 ms)::
|
||||
This mode is essential in order to be able to distinguish between different press durations.
|
||||
+
|
||||
* *Min* and *Max* decide how long a button needs to be pressed to have an effect.
|
||||
* By default, both min and max will be at 0 ms, which means that the duration doesn't matter and both press (> 0%) and release (0%) will be instantly forwarded.
|
||||
If you change _Min_ to e.g. 1000 ms and _Max_ to 5000 ms, it will behave as follows:
|
||||
* If you press the control element and instantly release it, nothing will happen.
|
||||
* If you press the control element, wait for a maximum of 5 seconds and then release it, the control value of the press (> 0%) will be forwarded.
|
||||
* It will never forward the control value of a release (0%), so this is probably only useful for targets with trigger character.
|
||||
* The main use case of this setting is to assign multiple functions to one control element, depending on how long it has been pressed.
|
||||
For this, use settings like the following:
|
||||
* Short press: 0 ms - 250 ms
|
||||
* Long press: 250 ms - 5000 ms
|
||||
|
||||
Fire after timeout::
|
||||
This mode is more "satisfying" because it will let ReaLearn "fire" immediately once a certain time has passed since the press of the button.
|
||||
However, obviously it doesn't have the concept of a "Maximum" press duration, so it can't be used to execute different things depending on different press durations (or only as the last part in the press duration chain, so to say).
|
||||
|
||||
Timeout::: Sets the timeout in milliseconds.
|
||||
If this is zero, everything will behave as usual.
|
||||
|
||||
[[fire-after-timeout-keep-firing]]Fire after timeout, keep firing (turbo)::
|
||||
Welcome to turbo mode.
|
||||
It will keep hitting your target (always with the initial button press velocity) at a specific rate.
|
||||
Optionally with an initial delay.
|
||||
Epic!
|
||||
|
||||
Timeout::: This is the initial delay before anything happens.
|
||||
Can be zero, then turbo stage is entered instantly on press.
|
||||
|
||||
Rate::: This is how frequently the target will be hit once the timeout has passed.
|
||||
In practice, it won't happen more frequently than once every 30 ms (REAPER's main thread loop frequency).
|
||||
|
||||
Fire on double press::
|
||||
This reacts to double presses of a button (analog to double-clicks with the mouse).
|
||||
|
||||
Fire after single press (if hold < Max ms)::
|
||||
|
||||
If you want to do something in response to a double press, chances are that you want to do something _else_ in response to just a single press.
|
||||
The _Normal_ fire mode will fire no matter what!
|
||||
That's why there's an additional _Single press_ mode that will not respond to double presses.
|
||||
The response happens _slightly_ delayed - because ReaLearn needs to wait a bit to see if it's going to be a double press or not.
|
||||
|
||||
Max::: With this, it's even possible to distinguish between single, double _and_ long press.
|
||||
In order to do that, you must set the _Max_ value of the _Single press_ mapping to a value that is lower than the _Timeout_ value of your _After timeout_ mapping.
|
||||
That way you can use one button for 3 different actions!
|
||||
+
|
||||
====
|
||||
* Mapping 1 "Single press" with Max = 499ms
|
||||
* Mapping 2 "Double press"
|
||||
* Mapping 3 "After timeout" with Timeout = 500ms
|
||||
====
|
||||
|
||||
[#button-filter]
|
||||
== Button filter menu
|
||||
|
||||
{control}::
|
||||
include::partial$glue/button-filter/control.txt[]
|
||||
|
||||
Press & release::
|
||||
ReaLearn will process both button presses (control value = 0%) and button releases (control value > 0%).
|
||||
This is the default.
|
||||
|
||||
[[press-only,press-only]] Press only::
|
||||
Makes ReaLearn ignore the release of the button.
|
||||
The same thing can be achieved by setting
|
||||
_Source Min_ to 1. However, doing so would also affect the feedback direction, which is often undesirable because it will mess with the button LED color or on/off state.
|
||||
|
||||
Release only:: Makes ReaLearn ignore the press of the button (just processing its release).
|
||||
Rare, but possible.
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
= Source section
|
||||
|
||||
image:realearn/screenshots/mapping-panel-source.png[Screenshot]
|
||||
|
||||
All xref:sources.adoc[] share the following UI elements.
|
||||
|
||||
[#learn]
|
||||
== Learn button
|
||||
|
||||
Starts or stops learning the xref:key-concepts.adoc#source[] of this mapping.
|
||||
|
||||
[#category]
|
||||
== Category menu
|
||||
|
||||
Lets you choose the source category.
|
||||
|
||||
[#type]
|
||||
== Type menu
|
||||
|
||||
Lets you choose the source type within that category.
|
||||
See xref:sources.adoc[].
|
||||
+140
@@ -0,0 +1,140 @@
|
||||
= Target section
|
||||
|
||||
image:realearn/screenshots/mapping-panel-target.png[Screenshot]
|
||||
|
||||
All xref:targets.adoc[] share the following UI elements.
|
||||
|
||||
[#learn]
|
||||
== Learn button
|
||||
|
||||
Starts or stops learning the target of this mapping.
|
||||
|
||||
[#menu]
|
||||
== Menu
|
||||
|
||||
Opens a small menu related to the target section:
|
||||
|
||||
Pick recently touched target (by type)::
|
||||
Gives you a list of recently touched parameters or executed actions in REAPER.
|
||||
When you click one of it, the target will be populated accordingly.
|
||||
It's an alternative to btn:[Learn].
|
||||
+
|
||||
Please note that not all targets can be picked that way, some have to be configured manually.
|
||||
|
||||
Go there (if supported):: If applicable, this makes the target of this mapping visible in REAPER.
|
||||
E.g. if the target is a track FX parameter, the corresponding track FX window will be displayed.
|
||||
|
||||
[#category]
|
||||
== Category menu
|
||||
|
||||
Lets you choose the target category.
|
||||
|
||||
[#type]
|
||||
== Type menu
|
||||
|
||||
Lets you choose a target type within that category.
|
||||
See xref:targets.adoc[].
|
||||
|
||||
[#current-value]
|
||||
== Value section and field
|
||||
|
||||
Reflects the current value of this mapping target and lets you change it (either via slider and text field or via buttons, depending on the target character).
|
||||
|
||||
If the target can't be resolved at the moment, it will show "Target currently inactive!" instead.
|
||||
|
||||
[[display-unit]]
|
||||
== Display unit button
|
||||
|
||||
On the right side of the current value you will see a button with a label such as `1. dB (%)`.
|
||||
This button displays the currently selected target unit (unrelated to the xref:key-concepts.adoc#unit[] concept) which is used for displaying and entering target values.
|
||||
|
||||
The number in the parentheses denotes the unit which is used for displaying and entering target step sizes.
|
||||
|
||||
Clicking the button switches between available target units.
|
||||
Currently, there are two options:
|
||||
|
||||
(1) Use native target units::
|
||||
Uses the target-specific unit, e.g. dB for volume targets.
|
||||
If the target doesn't have any specific units, it will be displayed as `1. - (-)`.
|
||||
|
||||
(2) Use percentages::
|
||||
Uses percentages for everything, which can be nice to get a uniform way of displaying/entering values instead of having to deal with the sometimes clunky target-specific units.
|
||||
|
||||
== Common elements for track targets
|
||||
|
||||
When choosing a track, the following additional elements are available.
|
||||
|
||||
[[track-must-be-selected]]
|
||||
=== Track must be selected checkbox
|
||||
|
||||
If checked, this mapping will be active only if the track set in _Track_ is currently selected.
|
||||
See xref:further-concepts/target.adoc#target-activation-condition[].
|
||||
|
||||
=== Selection ganging checkbox
|
||||
|
||||
If checked and if the track in question is selected, all other selected tracks will be adjusted as well.
|
||||
This uses REAPER's built-in selection-ganging feature and therefore should behave exactly like it.
|
||||
|
||||
=== Respect grouping checkbox
|
||||
|
||||
If checked, track grouping will be taken into account when adjusting the value.
|
||||
This uses REAPER's built-in track grouping feature and therefore should behave exactly like it.
|
||||
|
||||
NOTE: In older REAPER versions (< 6.69+dev1102), this can only be enabled together with selection ganging when using it on volume, pan or width targets.
|
||||
|
||||
== Common elements for on/off targets
|
||||
|
||||
Targets which control an on/off-style property of tracks (e.g. xref:targets/track/solo-unsolo.adoc[]) additionally provide the following elements.
|
||||
|
||||
[[exclusive]]
|
||||
=== Exclusive menu
|
||||
|
||||
By default, this is set to <<exclusive-no>>.
|
||||
|
||||
[[exclusive-no]] No:: Makes the track target affect just this track.
|
||||
Within project:: Switches the property on (off) for this track and off (on) for all other tracks in the project.
|
||||
Within folder:: Switches the property on (off) for this track and off (on) for all other tracks in the same folder and same level.
|
||||
Within project (on only):: Variation of _Within project_ that applies exclusivity only when switching the property on for this track.
|
||||
In other words, it never switches the property on for other tracks.
|
||||
Within folder (on only):: Variation of _Within folder_ that applies exclusivity only when switching the property on for this track.
|
||||
In other words, it never switches the property on for other tracks.
|
||||
|
||||
== Common elements for FX targets
|
||||
|
||||
The following elements and selectors are available for targets associated with a particular FX instance.
|
||||
|
||||
=== FX section
|
||||
|
||||
The FX instance associated with this target.
|
||||
ReaLearn will search for the FX in the output or input FX chain of the above selected track.
|
||||
|
||||
=== Input FX checkbox
|
||||
|
||||
If unchecked, the _FX_ dropdown will show FX instances in the track's normal FX chain.
|
||||
If checked, it will show FX instances in the track's input FX chain.
|
||||
|
||||
=== Monitoring FX checkbox
|
||||
|
||||
This appears instead of the input FX checkbox if you select track `<Master>`.
|
||||
If you check this, you can target FX instances on REAPER's global monitoring FX chain.
|
||||
|
||||
WARNING: Because of a limitation in the REAPER API, learning and feedback for monitoring FX doesn't work!
|
||||
|
||||
[[fx-must-have-focus]]
|
||||
=== FX must have focus checkbox
|
||||
|
||||
If checked, this mapping will be active only if the selected FX instance is currently _focused_.
|
||||
|
||||
If the FX instance is displayed in a floating window, _focused_ means that the floating window is active.
|
||||
If it's displayed within the FX chain window, _focused_ means that the FX chain window is currently open and the FX instance is the currently selected FX in that FX chain.
|
||||
|
||||
Of course, this flag doesn't have any effect if you chose the xref:further-concepts/target.adoc#fx-focused-selector[].
|
||||
|
||||
== Common elements for pollable targets
|
||||
|
||||
The following elements are available only for the few targets that might need polling (= regular value querying) in order to support automatic feedback in all cases.
|
||||
|
||||
=== Poll for feedback checkbox
|
||||
|
||||
Enables or disables xref:further-concepts/target.adoc#target-value-polling[].
|
||||
In the probably rare case that the polling causes performance issues, you can untick this checkbox.
|
||||
+87
@@ -0,0 +1,87 @@
|
||||
= Top section
|
||||
|
||||
image:realearn/screenshots/mapping-panel-general.png[Screenshot]
|
||||
|
||||
This section provides the following mapping-related elements.
|
||||
|
||||
[#name]
|
||||
== Name field
|
||||
|
||||
Here you can enter a descriptive name for the mapping.
|
||||
This is especially useful in combination with the search function if there are many mappings to keep track of.
|
||||
|
||||
If you clear the name, ReaLearn will name the mapping automatically based on its target.
|
||||
|
||||
[#tags]
|
||||
== Tags field
|
||||
|
||||
Use this to assign arbitrary xref:further-concepts/mapping.adoc#mapping-tag[mapping tags] to this mapping (comma-separated).
|
||||
|
||||
[#control-enabled]
|
||||
== Control-enabled checkbox (→)
|
||||
|
||||
Use this to enable/disable control for this mapping.
|
||||
|
||||
[#feedback-enabled]
|
||||
== Feedback-enabled checkbox (←)
|
||||
|
||||
Use this to enable/disable feedback for this mapping.
|
||||
|
||||
Disabling both control and feedback has the same effect as disabling the mapping as a whole.
|
||||
|
||||
[#active]
|
||||
== Active menu
|
||||
|
||||
This dropdown can be used to enable xref:further-concepts/mapping.adoc#conditional-activation[] for this mapping.
|
||||
|
||||
[#feedback-mode]
|
||||
== Feedback menu
|
||||
|
||||
Normal::
|
||||
Makes ReaLearn send feedback whenever the target value changes.
|
||||
This is the recommended option in most cases.
|
||||
|
||||
Prevent echo feedback::
|
||||
This option mainly exists for motorized faders that don't like getting feedback while being moved.
|
||||
If checked, ReaLearn won't send feedback if the target value change was caused by incoming source events of this mapping.
|
||||
However, it will still send feedback if the target value change was caused by something else, e.g. a mouse action within REAPER itself.
|
||||
+
|
||||
Since ReaLearn 2.16.12, this also works in controller mappings with virtual targets.
|
||||
|
||||
Send feedback after control::
|
||||
This checkbox mainly exists for "fixing" controllers which allow their LEDs to be controlled via incoming MIDI/OSC _but at the same time_ insist on controlling these LEDs themselves.
|
||||
For example, some Behringer X-Touch Compact buttons exhibit this behavior in MIDI mode.
|
||||
Such a behavior can lead to wrong LED states which don't reflect the actual state in REAPER.
|
||||
+
|
||||
If this option is not selected (the normal case and recommended for most controllers), ReaLearn will send feedback to the controller _only_ if the target value has changed.
|
||||
For example, if you use a button to toggle a target value on and off, the target value will change only when pressing the button, not when releasing it.
|
||||
As a consequence, feedback will be sent only when pressing the button, not when releasing it.
|
||||
+
|
||||
If this option is selected, ReaLearn will send feedback even after releasing the button - although the target value has not been changed by it.
|
||||
+
|
||||
Another case where this option comes in handy is if you use a target which doesn't support proper feedback because REAPER doesn't notify ReaLearn about value changes (e.g. "Track FX all enable"), and you have "Poll for feedback" disabled.
|
||||
By choosing this option, ReaLearn will send feedback whenever the target value change was caused by ReaLearn itself, which improves the situation at least a bit.
|
||||
|
||||
[#show-in-projection]
|
||||
== Show in projection checkbox
|
||||
|
||||
When unticked, this mapping will not show up in xref:further-concepts/unit.adoc#projection[].
|
||||
Useful e.g. for feedback-only mappings or buttons with multiple assignments.
|
||||
|
||||
[[advanced-settings]]
|
||||
== Advanced settings button
|
||||
|
||||
This button is for experts.
|
||||
There are some advanced mapping-related settings in ReaLearn that are not adjustable via its graphical user interface but only by writing text-based configuration.
|
||||
Pressing this button should open a small window in which you can write the configuration for this mapping.
|
||||
|
||||
If the button label ends with a number, that number denotes the number of top-level configuration properties set for that mapping.
|
||||
That way you can immediately see if a mapping has advanced settings or not.
|
||||
|
||||
You can learn more about the available properties in the section
|
||||
xref:user-interface/mapping-panel/advanced-settings-dialog.adoc[].
|
||||
|
||||
[#find-in-mapping-list]
|
||||
== Find in mapping list button
|
||||
|
||||
Scrolls the mapping rows panel so that the corresponding mapping row for this mapping gets visible.
|
||||
Reference in New Issue
Block a user