chore: Allow encoder assignment configs to define an `encoderValueNam…

…e` to display in place of the Cubase-builtin name

src/index.ts

@@ -2,6 +2,7 @@
 // organize-imports-ignore
 import "core-js/actual/array/iterator";
 import "core-js/actual/array/from";
+import "core-js/actual/array/includes";
 import "core-js/actual/array/reverse";
 import "core-js/actual/array/flat-map";
 import "core-js/actual/string/pad-start";

src/mapping/encoders/EncoderMapper.ts

@@ -3,6 +3,7 @@ import { LedButton } from "/decorators/surface-elements/LedButton";
 import { ChannelSurfaceElements, ControlSectionSurfaceElements } from "/device-configs";
 import { Device, MainDevice } from "/devices";
 import { SegmentDisplayManager } from "/midi/managers/SegmentDisplayManager";
+import { ChannelTextManager } from "/midi/managers/lcd/ChannelTextManager";
 import { GlobalState } from "/state";
 import { ContextVariable } from "/util";
 
@@ -29,6 +30,7 @@ export type EncoderMappingConfig = Array<{
 
 export class EncoderMapper {
   private readonly channelElements: ChannelSurfaceElements[];
+  private readonly channelTextManagers: ChannelTextManager[];
 
   /** An array containing the control buttons of each main device */
   private readonly deviceButtons: ControlSectionSurfaceElements["buttons"][];
@@ -47,6 +49,7 @@ export class EncoderMapper {
     private readonly globalState: GlobalState,
   ) {
     this.channelElements = devices.flatMap((device) => device.channelElements);
+    this.channelTextManagers = devices.flatMap((device) => device.lcdManager.channelTextManagers);
     this.mainDevices = devices.filter((device) => device instanceof MainDevice) as MainDevice[];
     this.deviceButtons = this.mainDevices.map(
       (device) => (device as MainDevice).controlSectionElements.buttons,
@@ -96,6 +99,7 @@ export class EncoderMapper {
         this.deviceButtons,
         this.channelElements,
         this.mixerBankChannels,
+        this.channelTextManagers,
         this.segmentDisplayManager,
         this.globalState,
       );

src/mapping/encoders/EncoderPage.ts

@@ -4,11 +4,18 @@ import { LedButton } from "/decorators/surface-elements/LedButton";
 import { EncoderDisplayMode, LedPushEncoder } from "/decorators/surface-elements/LedPushEncoder";
 import { ChannelSurfaceElements, ControlSectionButtons } from "/device-configs";
 import { SegmentDisplayManager } from "/midi/managers/SegmentDisplayManager";
+import { ChannelTextManager } from "/midi/managers/lcd/ChannelTextManager";
 import { GlobalState } from "/state";
 import { ContextVariable } from "/util";
 
 export interface EncoderAssignmentConfig {
   encoderValue?: MR_HostValue;
+
+  /**
+   * A custom string to display as the encoder's title instead of the one provided by Cubase
+   */
+  encoderValueName?: string;
+
   displayMode: EncoderDisplayMode;
   pushToggleValue?: MR_HostValue;
 
@@ -67,6 +74,7 @@ export class EncoderPage implements EncoderPageConfig {
     private readonly deviceButtons: ControlSectionButtons[],
     private readonly channelElements: ChannelSurfaceElements[],
     private readonly mixerBankChannels: MR_MixerBankChannel[],
+    private readonly channelTextManagers: ChannelTextManager[],
     private readonly segmentDisplayManager: SegmentDisplayManager,
     private readonly globalState: GlobalState,
   ) {
@@ -259,10 +267,16 @@ export class EncoderPage implements EncoderPageConfig {
     this.setActivatorButtonLeds(context, 1);
 
     for (const [encoderIndex, { encoder }] of this.channelElements.entries()) {
-      encoder.displayMode.set(
-        context,
-        this.assignments[encoderIndex]?.displayMode ?? EncoderDisplayMode.SingleDot,
-      );
+      const assignment = this.assignments[encoderIndex] as EncoderAssignmentConfig | undefined;
+      encoder.displayMode.set(context, assignment?.displayMode ?? EncoderDisplayMode.SingleDot);
+      if (assignment?.encoderValueName) {
+        this.channelTextManagers[encoderIndex].setParameterNameOverride(
+          context,
+          assignment.encoderValueName,
+        );
+      } else {
+        this.channelTextManagers[encoderIndex].clearParameterNameOverride(context);
+      }
     }
 
     this.globalState.isValueDisplayModeActive.set(context, false);

src/mapping/index.ts

@@ -66,8 +66,6 @@ export function makeHostMapping(
       return channel;
     });
 
-  bindEncoders(page, devices, mixerBankChannels, segmentDisplayManager, globalState);
-
   for (const device of devices) {
     if (device instanceof MainDevice) {
       const controlSectionElements = device.controlSectionElements;
@@ -97,6 +95,8 @@ export function makeHostMapping(
     }
   }
 
+  bindEncoders(page, devices, mixerBankChannels, segmentDisplayManager, globalState);
+
   lifecycleCallbacks.addActivationCallback((context) => {
     globalState.areMotorsActive.set(context, true);
   });

src/midi/index.ts

@@ -116,7 +116,7 @@ function bindChannelElements(device: Device, globalState: GlobalState) {
     }
 
     // Scribble Strip
-    const channelTextManager = device.lcdManager.getChannelTextManager(channelIndex);
+    const channelTextManager = device.lcdManager.channelTextManagers[channelIndex];
 
     channel.encoder.mOnEncoderValueTitleChange.addCallback((context, _title1, title2) => {
       channelTextManager.setParameterName(context, title2);

src/midi/managers/lcd/ChannelTextManager.ts

@@ -117,6 +117,7 @@ export class ChannelTextManager {
   private uniqueManagerId = ChannelTextManager.nextManagerId++;
 
   private parameterName = new ContextVariable("");
+  private parameterNameOverride = new ContextVariable<string | undefined>(undefined);
   private parameterValue = new ContextVariable("");
   private channelName = new ContextVariable("");
   private isLocalValueModeActive = new ContextVariable(false);
@@ -175,7 +176,7 @@ export class ChannelTextManager {
       this.isLocalValueModeActive.get(context) ||
         this.globalState.isValueDisplayModeActive.get(context)
         ? this.parameterValue.get(context)
-        : this.parameterName.get(context),
+        : this.parameterNameOverride.get(context) ?? this.parameterName.get(context),
     );
   }
 
@@ -215,6 +216,21 @@ export class ChannelTextManager {
     this.updateNameValueDisplay(context);
   }
 
+  /**
+   * Sets a parameter name string that replaces the one set via `setParameterName()` until
+   * `clearParameterNameOverride()` is invoked.
+   */
+  setParameterNameOverride(context: MR_ActiveDevice, name: string) {
+    this.parameterNameOverride.set(
+      context,
+      ChannelTextManager.centerString(ChannelTextManager.abbreviateString(name)),
+    );
+  }
+
+  clearParameterNameOverride(context: MR_ActiveDevice) {
+    this.parameterNameOverride.set(context, undefined);
+  }
+
   setParameterValue(context: MR_ActiveDevice, value: string) {
     value = ChannelTextManager.translateParameterValue(value);
 

src/midi/managers/lcd/LcdManager.ts

@@ -16,14 +16,14 @@ export class LcdManager {
     return Array(length + 1).join(" ");
   }
 
-  private channels: ChannelTextManager[];
+  channelTextManagers: ChannelTextManager[];
 
   constructor(
     private device: Device,
     globalState: GlobalState,
     timerUtils: TimerUtils,
   ) {
-    this.channels = createElements(
+    this.channelTextManagers = createElements(
       8,
       (channelIndex) =>
         new ChannelTextManager(
@@ -51,10 +51,6 @@ export class LcdManager {
     this.sendText(context, row * 56 + (channelIndex % 8) * 7, text);
   }
 
-  getChannelTextManager(channelIndex: number) {
-    return this.channels[channelIndex];
-  }
-
   clearDisplays(context: MR_ActiveDevice) {
     this.sendText(context, 0, LcdManager.makeSpaces(112));
   }