Reimplemented Ableton port as a User Remote Script because previously used script wasn't feature complete

Author: Maboroshy

docs/ableton.md

@@ -4,11 +4,11 @@ of Ableton Live without getting into rewriting its complex built-in MIDI remote
 MIDI Scripter has two ways to communicate directly with Ableton Live internals. 
 Both has own limitations, so some use cases may require to use both.
 
-## 1. Ableton MIDI Remote Script
+## 1. Ableton MIDI User Remote Script
 
-The idea behind this method is to use the existing Ableton Live remote 
+The idea behind this method is to use Ableton Live user remote 
 script and communicate with it by MIDI. 
-[Special remote script](https://github.com/Maboroshy/midi-scripter/tree/master/extra/Ableton%20Remote%20Script) should be 
+[Pre-mapped user remote script](https://github.com/Maboroshy/midi-scripter/tree/master/extra/Ableton%20Remote%20Script) should be 
 installed to Ableton Live and assigned to virtual MIDI ports in its settings.
 
 The script has its raw MIDI messages mapped to 
@@ -19,9 +19,9 @@ All available events are listed in [API documentation][midiscripter.AbletonEvent
 
 The messages are received and sent by [`AbletonIn`][midiscripter.AbletonIn] and 
 [`AbletonOut`][midiscripter.AbletonOut] ports that are wrappers for virtual 
-MIDI ports used for communication.
+MIDI ports used for communication. The script uses MIDI channel 15.
 
-These ports should be declared with virtual MIDI port name as an argument.
+These ports should be declared with virtual MIDI port name as an argument. 
 
 Example: [Select armed track script with Ableton MIDI Remote Script](https://github.com/Maboroshy/midi-scripter/blob/master/examples/ableton_select_armed_track_with_remote_script)
 

examples/ableton_select_armed_track_with_remote_script/readme.md

@@ -1,7 +1,7 @@
 # Select Armed Track in Ableton Live with Remote Script
 
 This script uses Ableton Live Remote script to select the armed track in 
-Ableton Live.
+Ableton Live. The script uses MIDI channel 15.
 
 ## Prerequisites
 - Install [Ableton Live Remote Script](https://github.com/Maboroshy/midi-scripter/tree/master/extra/Ableton%20Remote%20Script).

extra/Ableton Remote Script/Ableton Remote Script.zip

@@ -1,20 +1,16 @@
-# Ableton Remote Script
+Re# Ableton User Remote Script
 
-This script is a remote script for Ableton with MIDI messages pre-mapped to 
+This script is a user remote script for Ableton with MIDI messages pre-mapped to 
 corresponding types of `AbletonMsg`.
 
-This script is based on [Ableton Live Custom Remote Script by
-laidlaw42](https://github.com/laidlaw42/ableton-live-midi-remote-scripts) 
-with minimal changes.
-
 ## Installation
 
 1. Download [the .zip file](Ableton%20Remote%20Script.zip).
 2. Create two virtual MIDI ports - for input and for output.
 3. Install the script following 
-   [the official guide](https://help.ableton.com/hc/en-us/articles/209072009-Installing-third-party-remote-scripts):
-   copy the folder from .zip file to your Ableton Live User Library, assign 
-   virtual MIDI ports and enable the script.
+   [the official guide](https://help.ableton.com/hc/en-us/articles/206240184-Creating-your-own-Control-Surface-script):
+   copy the folder from .zip file to your User Remote Scripts folder, 
+   assign virtual MIDI ports and enable the script.
 
 ## Usage
 

extra/Ableton Remote Script/readme.md

@@ -8,36 +8,34 @@
 
 
 class AbletonEvent(midiscripter.base.msg_base.AttrEnum):
-    CLIP_LAUNCH = 'CLIP_LAUNCH'
-    """Clip launch by (x, y) index"""
-    CUE_LEVEL = 'CUE_LEVEL'
+    CUE_VOL = 'CUE_VOL'
     """Cue level control"""
     CROSSFADER = 'CROSSFADER'
     """Crossfader control"""
 
     DEVICE_BANK = 'DEVICE_BANK'
-    """Select Device bank by index"""
+    """Select device encoder bank by index"""
+    DEVICE_BANK_NEXT = 'DEVICE_BANK_NEXT'
+    """Select next device encoder bank"""
+    DEVICE_BANK_PREV = 'DEVICE_BANK_PREV'
+    """Select previous device encoder bank"""
     DEVICE_LOCK = 'DEVICE_LOCK'
     """Device lock (lock "blue hand")"""
-    DEVICE_NAV_LEFT = 'DEVICE_NAV_LEFT'
-    """Device nav left"""
-    DEVICE_NAV_RIGHT = 'DEVICE_NAV_RIGHT'
-    """Device nav right"""
-    DEVICE_BANK_NAV_LEFT = 'DEVICE_BANK_NAV_LEFT'
-    """Device bank nav left"""
-    DEVICE_BANK_NAV_RIGHT = 'DEVICE_BANK_NAV_RIGHT'
-    """Device bank nav right"""
     DEVICE_TOGGLE = 'DEVICE_TOGGLE'
     """Toggle selected device on/off"""
-    DRUM_PAD = 'DRUM_PAD'
-    """Drum pad Trigger by index"""
+
+    ENCODER = 'ENCODER'
+    """Parameters control"""
+
+    FORWARD = 'FORWARD'
+    """Fast forward"""
 
     LOOP = 'LOOP'
     """Loop on/off"""
 
     MASTER_SEL = 'MASTER_SEL'
     """Master track select"""
-    MASTER_VOLUME = 'MASTER_VOLUME'
+    MASTER_VOL = 'MASTER_VOL'
     """Master track volume"""
     METRONOME = 'METRONOME'
     """Metronome on/off"""
@@ -50,8 +48,6 @@ class AbletonEvent(midiscripter.base.msg_base.AttrEnum):
     OVERDUB = 'OVERDUB'
     """Overdub on/off"""
 
-    PARAM_CONTROL = 'PARAM_CONTROL'
-    """Parameters control"""
     PLAY = 'PLAY'
     """Global play"""
     PUNCH_IN = 'PUNCH_IN'
@@ -61,47 +57,13 @@ class AbletonEvent(midiscripter.base.msg_base.AttrEnum):
 
     REC = 'REC'
     """Global record"""
-    REC_QUANT_TOGGLE = 'REC_QUANT_TOGGLE'
-    """Record quantization on/off"""
-    REDO = 'REDO'
-    """Redo"""
-
-    SCENE_UP = 'SCENE_UP'
-    """Scene down"""
-    SCENE_DOWN = 'SCENE_DOWN'
-    """Scene up"""
-    SCENE_LAUNCH = 'SCENE_LAUNCH'
-    """Scene launch by index"""
-
-    SEEK_FWD = 'SEEK_FWD'
-    """Seek forward"""
-    SEEK_RWD = 'SEEK_RWD'
-    """Seek rewind"""
-
-    SESSION_LEFT = 'SESSION_LEFT'
-    """Session left"""
-    SESSION_RIGHT = 'SESSION_RIGHT'
-    """Session right"""
-    SESSION_UP = 'SESSION_UP'
-    """Session up"""
-    SESSION_DOWN = 'SESSION_DOWN'
-    """Session down"""
-
-    SEL_CLIP_LAUNCH = 'SEL_CLIP_LAUNCH'
-    """Selected clip launch"""
-    SEL_SCENE_LAUNCH = 'SEL_SCENE_LAUNCH'
-    """Selected scene launch"""
-    SEL_TRACK_MUTE = 'SEL_TRACK_MUTE'
-    """Mute Selected Track"""
-    SEL_TRACK_REC = 'SEL_TRACK_REC'
-    """Arm Selected Track"""
-    SEL_TRACK_SOLO = 'SEL_TRACK_SOLO'
-    """Solo Selected Track"""
+    REWIND = 'REWIND'
+    """Rewind"""
 
+    SESSION_REC = 'SESSION_REC'
+    """Session record"""
     STOP = 'STOP'
     """Global stop"""
-    STOP_ALL_CLIPS = 'STOP_ALL_CLIPS'
-    """Stop all clips"""
 
     TAP_TEMPO = 'TAP_TEMPO'
     """Tap tempo"""
@@ -116,36 +78,23 @@ class AbletonEvent(midiscripter.base.msg_base.AttrEnum):
     """Track right"""
     TRACK_MUTE = 'TRACK_MUTE'
     """Track On/Off by index"""
-    TRACK_PAN = 'TRACK_PAN'
-    """Track Pan"""
+    TRACK_NEXT_8 = 'TRACK_NEXT_8'
+    """Select next 8 tracks to control with track controls"""
+    TRACK_PREV_8 = 'TRACK_PREV_8'
+    """Select previous 8 tracks to control with track controls"""
     TRACK_SELECT = 'TRACK_SELECT'
     """Track select by index"""
-    TRACK_SEND = 'TRACK_SEND'
-    """Track Send"""
+    TRACK_SEND_A = 'TRACK_SEND_A'
+    """Track Send A"""
+    TRACK_SEND_B = 'TRACK_SEND_B'
+    """Track Send B"""
     TRACK_SOLO = 'TRACK_SOLO'
     """Track solo by index"""
     TRACK_STOP = 'TRACK_STOP'
     """Track clip stop by track index"""
     TRACK_VOL = 'TRACK_VOL'
     """Track Volume"""
 
-    UNDO = 'UNDO'
-    """Undo"""
-
-    VIEW_DETAIL = 'VIEW_DETAIL'
-    """Detail view switch"""
-    VIEW_CLIPTRACK = 'VIEW_CLIPTRACK'
-    """Clip/Track view switch"""
-
-    ZOOM_UP = 'ZOOM_UP'
-    """Session Zoom up"""
-    ZOOM_DOWN = 'ZOOM_DOWN'
-    """Session Zoom down"""
-    ZOOM_LEFT = 'ZOOM_LEFT'
-    """Session Zoom left"""
-    ZOOM_RIGHT = 'ZOOM_RIGHT'
-    """Session Zoom right"""
-
 
 class AbletonMsg(midiscripter.base.msg_base.Msg):
     """Ableton Live remote script event message"""

midiscripter/ableton_remote/ableton_msg.py

@@ -1,22 +1,18 @@
 from typing import overload, TYPE_CHECKING
 
-import midiscripter.midi
+from midiscripter.midi import MidiIn, MidiOut, ChannelMsg
 from midiscripter.base.port_base import Input
 from midiscripter.logger import log
 from midiscripter.ableton_remote.ableton_msg import AbletonEvent, AbletonMsg
-from midiscripter.ableton_remote.remote_script_midi_mapping import (
-    ableton_event_to_midi_map,
-    midi_to_ableton_button_map,
-    midi_to_ableton_slider_map,
-)
+from midiscripter.ableton_remote.remote_script_midi_mapping import ableton_event_to_midi_map, midi_to_ableton_button_map, midi_to_ableton_slider_map
 
 if TYPE_CHECKING:
     from collections.abc import Container, Callable
     from midiscripter.base.msg_base import Msg
 
 
 # noinspection PyMethodOverriding
-class AbletonIn(midiscripter.midi.MidiIn):
+class AbletonIn(MidiIn):
     """Receives MIDI messages from Ableton Live remote script
     and produces [`AbletonMsg`][midiscripter.AbletonMsg] objects.
     """
@@ -68,7 +64,7 @@ def subscribe(
         return Input.subscribe(self, type, index, value)  # bypassing MidiIn method
 
 
-class AbletonOut(midiscripter.midi.MidiOut):
+class AbletonOut(MidiOut):
     """Sends [`AbletonMsg`][midiscripter.AbletonMsg] objects
     as MIDI message to Ableton Live remote script.
     """
@@ -81,17 +77,20 @@ def __init__(self, proxy_midi_port_name: str, *, virtual: bool = False):
         """
         super().__init__(proxy_midi_port_name, virtual=virtual)
 
-    def send(self, msg: AbletonMsg) -> None:
+    def send(self, msg: AbletonMsg | ChannelMsg) -> None:
         """Send message to Ableton remote script.
 
         Args:
             msg: object to send
         """
+        if isinstance(msg, ChannelMsg):
+            super().send(msg)
+            super()._log_msg_sent(msg)
+            return
+
         try:
             if msg.index is None:
                 midi_lead_attrs = ableton_event_to_midi_map[msg.type]
-            elif isinstance(msg.index, tuple) and len(msg.index) == 2:
-                midi_lead_attrs = ableton_event_to_midi_map[msg.type][msg.index[0]][msg.index[1]]
             else:
                 midi_lead_attrs = ableton_event_to_midi_map[msg.type][msg.index]
 
@@ -102,7 +101,7 @@ def send(self, msg: AbletonMsg) -> None:
             else:
                 value = msg.value
 
-            super().send(midiscripter.midi.ChannelMsg(*midi_lead_attrs, value))
+            super().send(ChannelMsg(*midi_lead_attrs, value))
             super()._log_msg_sent(msg)
 
         except (IndexError, KeyError):