X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fmidi%2Fpd.py;fp=decoders%2Fmidi%2Fpd.py;h=ccbca34c7ef726dfe673bc4cdcc90a50b0daa610;hp=1616af10ce6188e8090740796e0a9268db6e4b8d;hb=b0fc934add3394f7e753db6bcac23a2362bf7149;hpb=d66d47eda43be865ca6775fe4f02cdd0824b6abb

diff --git a/decoders/midi/pd.py b/decoders/midi/pd.py
index 1616af1..ccbca34 100644
--- a/decoders/midi/pd.py
+++ b/decoders/midi/pd.py
@@ -51,6 +51,12 @@ class Decoder(srd.Decoder):
     def putx(self, data):
         self.put(self.ss_block, self.es_block, self.out_ann, data)
 
+    def get_note_name(self, channel, note):
+        if channel != 10:
+            return chromatic_notes[note]
+        else:
+            return 'assuming ' + percussion_notes.get(note, 'undefined')
+
     def handle_channel_msg_0x80(self):
         # Note off: 8n kk vv
         # n = channel, kk = note, vv = velocity
@@ -59,8 +65,9 @@ class Decoder(srd.Decoder):
             return
         self.es_block = self.es
         msg, chan, note, velocity = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[1], c[2]
-        self.putx([0, ['Channel %d: %s (note = %d, velocity = %d)' % \
-                  (chan, status_bytes[msg], note, velocity)]])
+        note_name = self.get_note_name(chan, note)
+        self.putx([0, ['Channel %d: %s (note = %d \'%s\', velocity = %d)' % \
+                  (chan, status_bytes[msg], note, note_name, velocity)]])
         self.cmd, self.state = [], 'IDLE'
 
     def handle_channel_msg_0x90(self):
@@ -73,14 +80,23 @@ class Decoder(srd.Decoder):
         self.es_block = self.es
         msg, chan, note, velocity = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[1], c[2]
         s = 'note off' if (velocity == 0) else status_bytes[msg]
-        self.putx([0, ['Channel %d: %s (note = %d, velocity = %d)' % \
-                  (chan, s, note, velocity)]])
+        note_name = self.get_note_name(chan, note)
+        self.putx([0, ['Channel %d: %s (note = %d \'%s\', velocity = %d)' % \
+                  (chan, s, note, note_name, velocity)]])
         self.cmd, self.state = [], 'IDLE'
 
     def handle_channel_msg_0xa0(self):
         # Polyphonic key pressure / aftertouch: An kk vv
         # n = channel, kk = polyphonic key pressure, vv = pressure value
-        pass # TODO
+        c = self.cmd
+        if len(c) < 3:
+            return
+        self.es_block = self.es
+        msg, chan, note, pressure = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[1], c[2]
+        note_name = self.get_note_name(chan, note)
+        self.putx([0, ['Channel %d: %s (note = %d \'%s\', pressure = %d)' % \
+                  (chan, status_bytes[msg], note, note_name, pressure)]])
+        self.cmd, self.state = [], 'IDLE'
 
     def handle_controller_0x44(self):
         # Legato footswitch: Bn 44 vv
@@ -94,27 +110,57 @@ class Decoder(srd.Decoder):
         # Portamento control (PTC): Bn 54 kk
         # n = channel, kk = source note for pitch reference
         chan, kk = (self.cmd[0] & 0x0f) + 1, self.cmd[2]
+        kk_name = self.get_note_name(chan, kk)
         self.putx([0, ['Channel %d: control function \'%s\' (source note ' \
-                  '= %d)' % (chan, control_functions[0x54], kk)]])
+                  '= %d / %s)' % \
+                  (chan, control_functions[0x54], kk, kk_name)]])
 
     def handle_controller_generic(self):
         c = self.cmd
         chan, fn, param = (c[0] & 0x0f) + 1, c[1], c[2]
-        ctrl_fn = control_functions.get(fn, 'undefined')
+        default_name = 'undefined'
+        ctrl_fn = control_functions.get(fn, default_name)
+        if ctrl_fn == default_name:
+            ctrl_fn = '%s 0x%02x' % (default_name, fn)
         self.putx([0, ['Channel %d: control change to function \'%s\' ' \
                   '(param = 0x%02x)' % (chan, ctrl_fn, param)]])
 
+    def handle_channel_mode(self):
+        # Channel Mode: Bn mm vv
+        # n = channel, mm = mode number (120 - 127), vv = value
+        c = self.cmd
+        chan, mm, vv = (c[0] & 0x0f) + 1, c[1], c[2]
+        mode_fn = control_functions.get(mm, 'undefined')
+        # Decode the value based on the mode number.
+        vv_string = ''
+        if mm == 122:           # mode = local control?
+            if vv == 0:
+                vv_string = 'off'
+            elif vv == 127:     # mode = poly mode on?
+                vv_string = 'on'
+            else:
+                vv_string = '(non-standard param value of 0x%02x)' % vv
+        elif mm == 126:         # mode = mono mode on?
+            if vv != 0:
+                vv_string = '(%d channels)' % vv
+            else:
+                vv_string = '(channels \'basic\' through 16)'
+        elif vv != 0: # All other channel mode messages expect vv == 0.
+            vv_string = '(non-standard param value of 0x%02x)' % vv
+        self.putx([0, ['Channel %d: mode message \'%s\' %s' % \
+            (chan, mode_fn, vv_string)]])
+        self.cmd, self.state = [], 'IDLE'
+
     def handle_channel_msg_0xb0(self):
         # Control change (or channel mode messages): Bn cc vv
         # n = channel, cc = control number (0 - 119), vv = control value
         c = self.cmd
-        if (len(c) >= 2) and (c[1] in range(0x78, 0x7f + 1)):
-            # This is not a control change, but rather a channel mode message.
-            # TODO: Handle channel mode messages.
-            return
         if len(c) < 3:
             return
         self.es_block = self.es
+        if c[1] in range(0x78, 0x7f + 1):
+            self.handle_channel_mode()
+            return
         handle_ctrl = getattr(self, 'handle_controller_0x%02x' % c[1],
                               self.handle_controller_generic)
         handle_ctrl()
@@ -123,22 +169,55 @@ class Decoder(srd.Decoder):
     def handle_channel_msg_0xc0(self):
         # Program change: Cn pp
         # n = channel, pp = program number (0 - 127)
-        pass # TODO
+        c = self.cmd
+        if len(c) < 2:
+            return
+        self.es_block = self.es
+        msg, chan, pp = self.cmd[0] & 0xf0, (self.cmd[0] & 0x0f) + 1, \
+                        self.cmd[1] + 1
+        change_type = 'instrument'
+        name = ''
+        if chan != 10:  # channel != percussion
+            name = gm_instruments.get(pp, 'undefined')
+        else:
+            change_type = 'drum kit'
+            name = drum_kit.get(pp, 'undefined')
+        self.putx([0, ['Channel %d: %s to %s %d (assuming %s)' % \
+            (chan, status_bytes[msg], change_type, pp, name)]])
+        self.cmd, self.state = [], 'IDLE'
 
     def handle_channel_msg_0xd0(self):
         # Channel pressure / aftertouch: Dn vv
         # n = channel, vv = pressure value
-        pass # TODO
+        c = self.cmd
+        if len(c) < 2:
+            return
+        self.es_block = self.es
+        msg, chan, vv = self.cmd[0] & 0xf0, (self.cmd[0] & 0x0f) + 1, self.cmd[1]
+        self.putx([0, ['Channel %d: %s %d' % (chan, status_bytes[msg], vv)]])
+        self.cmd, self.state = [], 'IDLE'
 
     def handle_channel_msg_0xe0(self):
         # Pitch bend change: En ll mm
         # n = channel, ll = pitch bend change LSB, mm = pitch bend change MSB
-        pass # TODO
+        c = self.cmd
+        if len(c) < 3:
+            return
+        self.es_block = self.es
+        msg, chan, ll, mm = self.cmd[0] & 0xf0, (self.cmd[0] & 0x0f) + 1, \
+                            self.cmd[1], self.cmd[2]
+        decimal = (mm << 7) + ll
+        self.putx([0, ['Channel %d: %s 0x%02x 0x%02x (%d)' % \
+            (chan, status_bytes[msg], ll, mm, decimal)]])
+        self.cmd, self.state = [], 'IDLE'
 
     def handle_channel_msg_generic(self):
+        # TODO: It should not be possible to hit this code.
+        # It currently can not be unit tested.
         msg_type = self.cmd[0] & 0xf0
+        self.es_block = self.es
         self.putx([0, ['Unknown channel message type: 0x%02x' % msg_type]])
-        # TODO: Handle properly.
+        self.cmd, self.state = [], 'IDLE'
 
     def handle_channel_msg(self, newbyte):
         self.cmd.append(newbyte)
@@ -148,17 +227,108 @@ class Decoder(srd.Decoder):
         handle_msg()
 
     def handle_sysex_msg(self, newbyte):
-        # SysEx message: 1 status byte, x data bytes, EOX byte
+        # SysEx message: 1 status byte, 1-3 manuf. bytes, x data bytes, EOX byte
         self.cmd.append(newbyte)
         if newbyte != 0xf7: # EOX
             return
         self.es_block = self.es
-        # TODO: Get message ID, vendor ID, message contents, etc.
-        self.putx([0, ['SysEx message']])
+        # Note: Unlike other methods, this code pops bytes out of self.cmd
+        # to isolate the data.
+        msg, eox = self.cmd.pop(0), self.cmd.pop()
+        if len(self.cmd) < 1:
+            self.putx([0, ['SysEx: truncated manufacturer code (<1 bytes)']])
+            self.cmd, self.state = [], 'IDLE'
+            return
+        # Extract the manufacturer name (or SysEx realtime or non-realtime).
+        m1 = self.cmd.pop(0)
+        manu = (m1,)
+        if m1 == 0x00:  # If byte == 0, then 2 more manufacturer bytes follow.
+            if len(self.cmd) < 2:
+                self.putx([0, ['SysEx: truncated manufacturer code (<3 bytes)']])
+                self.cmd, self.state = [], 'IDLE'
+                return
+            manu = (m1, self.cmd.pop(0), self.cmd.pop(0))
+        default_name = 'undefined'
+        manu_name = sysex_manufacturer_ids.get(manu, default_name)
+        if manu_name == default_name:
+            if len(manu) == 3:
+                manu_name = '%s (0x%02x 0x%02x 0x%02x)' % \
+                            (default_name, manu[0], manu[1], manu[2])
+            else:
+                manu_name = '%s (0x%02x)' % (default_name, manu[0])
+        # Extract the payload.
+        # TODO: Write methods to decode SysEx realtime & non-realtime payloads.
+        payload = ''
+        while len(self.cmd) > 0:
+            payload += '0x%02x ' % (self.cmd.pop(0))
+        if payload == '':
+            payload = '<empty>'
+        self.putx([0, ['SysEx: for \'%s\' with payload %s' % \
+                       (manu_name, payload)]])
+        self.cmd, self.state = [], 'IDLE'
+
+    def handle_syscommon_midi_time_code_quarter_frame_msg(self, newbyte):
+        # MIDI time code quarter frame: F1 nd
+        # n = message type
+        # d = values
+        c = self.cmd
+        if len(c) < 2:
+            return
+        msg = self.cmd[0]
+        nn, dd = (self.cmd[1] & 0x70) >> 4, self.cmd[1] & 0x0f
+        group = 'System Common'
+        self.es_block = self.es
+        if nn != 7: # If message type does not contain SMPTE type.
+            self.putx([0, ['%s: %s of %s, value 0x%01x' % \
+                (group, status_bytes[msg], quarter_frame_type[nn], dd)]])
+            self.cmd, self.state = [], 'IDLE'
+            return
+        tt = (dd & 0x6) >> 1
+        self.putx([0, ['%s: %s of %s, value 0x%01x for %s' % \
+                       (group, status_bytes[msg], quarter_frame_type[nn], \
+                       dd, smpte_type[tt])]])
         self.cmd, self.state = [], 'IDLE'
 
     def handle_syscommon_msg(self, newbyte):
-        pass # TODO
+        # System common messages
+        #
+        # There are 5 simple formats (which are directly handled here) and
+        # 1 complex one called MIDI time code quarter frame.
+        #
+        # Note: While the MIDI lists 0xf7 as a "system common" message, it
+        # is actually only used with SysEx messages so it is processed there.
+        self.cmd.append(newbyte)
+        msg = self.cmd[0]
+        c = self.cmd
+        group = 'System Common'
+        if msg == 0xf1:
+            # MIDI time code quarter frame
+            self.handle_syscommon_midi_time_code_quarter_frame_msg(newbyte)
+            return
+        elif msg == 0xf2:
+            # Song position pointer: F2 ll mm
+            # ll = LSB position, mm = MSB position
+            if len(c) < 3:
+                return
+            ll, mm = self.cmd[1], self.cmd[2]
+            decimal = (mm << 7) + ll
+            self.es_block = self.es
+            self.putx([0, ['%s: %s 0x%02x 0x%02x (%d)' % \
+                (group, status_bytes[msg], ll, mm, decimal)]])
+        elif msg == 0xf3:
+            # Song select: F3 ss
+            # ss = song selection number
+            if len(c) < 2:
+                return
+            ss = self.cmd[1]
+            self.es_block = self.es
+            self.putx([0, ['%s: %s number %d' % (group, status_bytes[msg], ss)]])
+        elif msg == 0xf4 or msg == 0xf5 or msg == 0xf6:
+            # Undefined 0xf4, Undefined 0xf5, and Tune Request (respectively).
+            # All are only 1 byte long with no data bytes.
+            self.es_block = self.es
+            self.putx([0, ['%s: %s' % (group, status_bytes[msg])]])
+        self.cmd, self.state = [], 'IDLE'
 
     def handle_sysrealtime_msg(self, newbyte):
         # System realtime message: 0b11111ttt (t = message type)
@@ -193,9 +363,9 @@ class Decoder(srd.Decoder):
             self.ss_block = ss
             if pdata in range(0x80, 0xef + 1):
                 self.state = 'HANDLE CHANNEL MSG'
-            elif pdata == 0xf0:
+            elif pdata == 0xf0 or pdata == 0xf7:
                 self.state = 'HANDLE SYSEX MSG'
-            elif pdata in range(0xf1, 0xf7 + 1):
+            elif pdata in range(0xf1, 0xf7):
                 self.state = 'HANDLE SYSCOMMON MSG'
             elif pdata in range(0xf8, 0xff + 1):
                 self.state = 'HANDLE SYSREALTIME MSG'