Fix SysEx payload display

rdoursenaud · rdoursenaud · commit 27a1997b37a6 · 2025-05-11T01:27:51.000+02:00
Show remaining undecoded payload
for Universal System Exclusive
messages.
diff --git a/pyproject.toml b/pyproject.toml
@@ -20,7 +20,7 @@ requires-python = '>=3.10'
 dependencies = [
     'dearpygui~=2.0.0',
     'dearpygui-ext~=2.0.0',
-    'midi_const~=0.1.0',
+    'midi_const~=0.1.2',
     'mido~=1.3.0', # FIXME: currently using custom 1.2.11a1 with EOX, running status and delta time support
     'python-rtmidi~=1.5.5', # While it's mido's default backend, we explicitly require it for some features.
     'pillow~=11.0.0',
diff --git a/src/midiexplorer/__main__.py b/src/midiexplorer/__main__.py
@@ -39,7 +39,7 @@ def main() -> None:
     Logger.log(f"Configuring app using init file: {INIT_FILENAME}")
     dpg.configure_app(
         # FIXME: upstream documentation is misleading.
-        load_init_file=INIT_FILENAME,  # Non-modifiable vendor init file
+        #load_init_file=INIT_FILENAME,  # Non-modifiable vendor init file
         docking=True,
         docking_space=True,
         docking_shift_only=False,
diff --git a/src/midiexplorer/gui/windows/mon/__init__.py b/src/midiexplorer/gui/windows/mon/__init__.py
@@ -704,35 +704,36 @@ def create() -> None:
         # System Exclusive
         # -----------------
         with dpg.collapsing_header(label="System Exclusive", default_open=not DEBUG):
-
-            with dpg.child_window(tag='mon_sysex_container', height=120, border=False):
-                with dpg.group():
-                    with dpg.group(horizontal=True):
-                        title = "ID"
-                        dpg.add_text(title)
-                        dpg.add_input_text(source='syx_id_region', readonly=True, width=200)
-                        tooltip_preconv(f"{title} (Region)", 'syx_id_region', 'syx_id_val')
-                        dpg.add_input_text(source='syx_id_group', readonly=True, width=200)
-                        tooltip_preconv(f"{title} (Group)", 'syx_id_group', 'syx_id_val')
-                        dpg.add_input_text(source='syx_id_name', readonly=True, width=200)
-                        tooltip_preconv(f"{title} (Name)", 'syx_id_name', 'syx_id_val')
-                    with dpg.group(horizontal=True):
-                        title = "Device ID"
-                        source = 'syx_device_id'
-                        dpg.add_text(title)
-                        dpg.add_input_text(source=source, readonly=True, width=50)
-                        tooltip_preconv(static_title=title, values_source=source)
-                    with dpg.group(horizontal=True, tag='syx_payload_container'):
-                        title = "Undecoded Payload"
-                        dpg.add_text(title)
-                        source = 'syx_payload'
-                        dpg.add_input_text(source=source, readonly=True, width=500)
-                        tooltip_preconv(static_title=title, values_source=source)
-
-                with dpg.group(tag='syx_decoded_payload', show=False):
-                    title = "Decoded Payload"
-                    dpg.add_text(title)
-                    tooltip_preconv(static_title=title, values_source='syx_payload')
+            # TODO: review height
+            dpg.add_child_window(tag='mon_sysex_container', height=200, border=False)
+
+        with dpg.group(parent='mon_sysex_container'):
+            with dpg.group(horizontal=True):
+                # FIXME: Option to display "Manufacturer’s ID" instead?
+                #        Only when an actual manufacturer’s ID is present?
+                title = "ID number"
+                dpg.add_text(title)
+                dpg.add_input_text(source='syx_id_region', readonly=True, width=200)
+                tooltip_preconv(f"{title} (Region)", 'syx_id_region', 'syx_id_val')
+                dpg.add_input_text(source='syx_id_group', readonly=True, width=200)
+                tooltip_preconv(f"{title} (Group)", 'syx_id_group', 'syx_id_val')
+                dpg.add_input_text(source='syx_id_name', readonly=True, width=200)
+                tooltip_preconv(f"{title} (Name)", 'syx_id_name', 'syx_id_val')
+            with dpg.group(horizontal=True):
+                title = "Device ID"
+                dpg.add_text(title)
+                source = 'syx_device_id'
+                dpg.add_input_text(source=source, readonly=True, width=50)
+                tooltip_preconv(static_title=title, values_source=source)
+            with dpg.group(tag='syx_decoded_payload', show=False):
+                title = "Decoded Payload:"
+                dpg.add_text(title)
+            with dpg.group(horizontal=True, tag='syx_payload_container'):
+                title = "Undecoded Payload"
+                dpg.add_text(title)
+                source = 'syx_payload'
+                dpg.add_input_text(source=source, readonly=True, width=500)
+                tooltip_preconv(static_title=title, values_source=source)
 
         # TODO: generate dynamically?
         with dpg.group(parent='syx_decoded_payload'):
diff --git a/src/midiexplorer/gui/windows/mon/blink.py b/src/midiexplorer/gui/windows/mon/blink.py
@@ -79,11 +79,11 @@ def get_supported_decoders() -> list:
         'syx_id_name',
         'syx_id_val',
         'syx_device_id',
-        'syx_payload',
         'syx_sub_id1_name',
         'syx_sub_id1_val',
         'syx_sub_id2_name',
         'syx_sub_id2_val',
+        'syx_payload',
     ]
     return decoders
 
diff --git a/src/midiexplorer/gui/windows/mon/data.py b/src/midiexplorer/gui/windows/mon/data.py
@@ -31,8 +31,11 @@ def _update_gui_sysex(decoded: DecodedSysEx):
     set_value_preconv('syx_id_val', decoded.identifier.value)
     set_value_preconv('syx_device_id', decoded.device_id)
     set_value_preconv('syx_payload', decoded.payload.value)
-    if isinstance(decoded.payload, DecodedUniversalSysExPayload):
+    if not len(decoded.payload.value):
         dpg.hide_item('syx_payload_container')
+    else:
+        dpg.show_item('syx_payload_container')
+    if isinstance(decoded.payload, DecodedUniversalSysExPayload):
         if decoded.payload.sub_id1_value:
             dpg.set_value('syx_sub_id1_name', decoded.payload.sub_id1_name)
             set_value_preconv('syx_sub_id1_val', decoded.payload.sub_id1_value if not None else "")
@@ -48,7 +51,6 @@ def _update_gui_sysex(decoded: DecodedSysEx):
         dpg.show_item('syx_decoded_payload')
     else:
         dpg.hide_item('syx_decoded_payload')
-        dpg.show_item('syx_payload_container')
 
 
 def update_gui_monitor(data: mido.Message, static: bool = False) -> None:
diff --git a/src/midiexplorer/midi/decoders/sysex.py b/src/midiexplorer/midi/decoders/sysex.py
@@ -23,17 +23,22 @@
 # TODO: decode MMC (page 58 + dedicated spec)
 
 import functools
+from collections import deque
 
 import midi_const
 import mido
 
-"""
-System exclusive ID decoder.
+from midiexplorer.gui import Logger
+
 
-Denoted "ID number" in the specification.
-Frequently referred to as "Manufacturer ID".
-"""
 class DecodedSysExId:
+    """
+    System exclusive ID decoder.
+
+    Denoted "ID number" in the specification.
+    Frequently referred to as "Manufacturer ID".
+    """
+
     def __init__(self, value: int | tuple[int]):
         length: int
         try:
@@ -77,7 +82,7 @@ def region(self) -> str:
             index = self._raw
         else:
             index = self._raw[1]
-        region = midi_const.SYSTEM_EXCLUSIVE_ID_REGIONS.get(index, "N.A.")
+        region = midi_const.SYSTEM_EXCLUSIVE_ID_REGIONS.get(index, "N/A")
         return region
 
     @functools.cached_property
@@ -98,21 +103,24 @@ def name(self) -> str:
 
 class DecodedSysExPayload:
     _id = int
-    _raw: int | tuple[int]
+    _raw: deque
 
     def __init__(self, identifier: DecodedSysExId, contents: int | tuple[int]):
         self._id = identifier
-        self._raw = contents
+        if isinstance(contents, int):
+            self._raw = deque([contents])
+        else:
+            self._raw = deque(contents)
 
     @property
     def value(self):
-        return self._raw
+        return tuple(self._raw)
 
     @staticmethod
     def get_decoder(identifier):
-        if identifier.value == 0x7E:
+        if midi_const.SYSTEM_EXCLUSIVE_ID.get(identifier.value) == "Non-Real Time":
             return DecodedUniversalNonRealTimeSysExPayload
-        if identifier.value == 0x7F:
+        if midi_const.SYSTEM_EXCLUSIVE_ID.get(identifier.value) == "Real Time":
             return DecodedUniversalRealTimeSysExPayload
         return DecodedSysExPayload
 
@@ -124,59 +132,66 @@ def __init__(self, identifier: DecodedSysExId, contents: int | tuple[int]):
 
 class DecodedUniversalNonRealTimeSysExPayload(DecodedUniversalSysExPayload):
     def __init__(self, identifier: DecodedSysExId, contents: int | tuple[int]):
-        if identifier.value != 0x7E:
+        if midi_const.SYSTEM_EXCLUSIVE_ID.get(identifier.value) != "Non-Real Time":
             raise ValueError
         super().__init__(identifier, contents)
-        next_byte: int = 0
-        self.sub_id1_value = self._raw[next_byte]
-        self.sub_id1_name = midi_const. \
-            DEFINED_UNIVERSAL_SYSTEM_EXCLUSIVE_MESSAGES_NON_REAL_TIME_SUB_ID_1.get(
-            self.sub_id1_value, "Undefined"
+        self.sub_id1_value = self._raw.popleft()
+        self.sub_id1_name = \
+            midi_const.DEFINED_UNIVERSAL_SYSTEM_EXCLUSIVE_MESSAGES_NON_REAL_TIME_SUB_ID_1.get(
+                self.sub_id1_value, "Undefined"
             )
         if self.sub_id1_value in midi_const.NON_REAL_TIME_SUB_ID_2_FROM_1:
-            next_byte += 1
-            self.sub_id2_value = self._raw[next_byte]
+            self.sub_id2_value = self._raw.popleft()
             self.sub_id2_name = midi_const.NON_REAL_TIME_SUB_ID_2_FROM_1.get(
                 self.sub_id1_value
-                ).get(
+            ).get(
                 self.sub_id2_value, "Undefined"
             )
 
 
 class DecodedUniversalRealTimeSysExPayload(DecodedUniversalSysExPayload):
     def __init__(self, identifier: DecodedSysExId, contents: int | tuple[int]):
-        if identifier.value != 0x7F:
+        if midi_const.SYSTEM_EXCLUSIVE_ID.get(identifier.value) != "Real Time":
             raise ValueError
         super().__init__(identifier, contents)
-        next_byte: int = 0
-        self.sub_id1_value = self._raw[next_byte]
-        self.sub_id1_name = midi_const. \
-            DEFINED_UNIVERSAL_SYSTEM_EXCLUSIVE_MESSAGES_REAL_TIME_SUB_ID_1.get(
-            self.sub_id1_value, "Undefined"
+        self.sub_id1_value = self._raw.popleft()
+        self.sub_id1_name = \
+            midi_const.DEFINED_UNIVERSAL_SYSTEM_EXCLUSIVE_MESSAGES_REAL_TIME_SUB_ID_1.get(
+                self.sub_id1_value, "Undefined"
             )
         if self.sub_id1_value in midi_const.REAL_TIME_SUB_ID_2_FROM_1:
-            next_byte += 1
-            self.sub_id2_value = self._raw[next_byte]
+            self.sub_id2_value = self._raw.popleft()
             self.sub_id2_name = midi_const.REAL_TIME_SUB_ID_2_FROM_1.get(
                 self.sub_id1_value
-                ).get(
+            ).get(
                 self.sub_id2_value, "Undefined"
             )
 
 
 class DecodedSysEx:
     def __init__(self, message: tuple):
         if len(message) < 3:
+            # We need at least 3 bytes:
+            # - 1 ID number byte
+            # - 1 device ID byte
+            # - 1 payload byte
             raise ValueError("Message too short (less than 3 bytes) to be a proper system exclusive message.")
+
         # Scrub EOX if present
         if message[-1] == mido.messages.specs.SYSEX_END:
+            Logger().log_warning("Scrubbing EOX from SysEx payload before decoding!")
             self._raw = message[:-1]
         else:
             self._raw = message
+
         # Determine ID length
         if self._raw[0] == 0x00:
             # 3-byte ID
-            if len(message) < 5:
+            if len(self._raw) < 5:
+                # We need at least 5 bytes:
+                # - 3 ID number bytes
+                # - 1 device ID byte
+                # - 1 payload byte
                 raise ValueError(
                     "Message too short (less than 5 bytes) to be a proper system exclusive message with a 3-byte ID."
                 )
@@ -196,6 +211,8 @@ def _payload(self) -> int | tuple[int]:
         return self._raw[self._device_id_byte + 1:]
 
     @functools.cached_property
-    def payload(self) -> DecodedSysExPayload | DecodedUniversalRealTimeSysExPayload | DecodedUniversalNonRealTimeSysExPayload:
+    def payload(
+            self
+    ) -> DecodedSysExPayload | DecodedUniversalRealTimeSysExPayload | DecodedUniversalNonRealTimeSysExPayload:
         decoder = DecodedSysExPayload.get_decoder(self.identifier)
         return decoder(self.identifier, self._payload)
