('text-verbose', 'Human-readable text (verbose)'),
)
- def __init__(self, **kwargs):
+ def __init__(self):
self.cmd = []
self.state = 'IDLE'
self.ss = None
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
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][0], note, note_name, velocity),
+ 'ch %d: %s %d, velocity = %d' % \
+ (chan, status_bytes[msg][1], note, velocity),
+ '%d: %s %d, vel %d' % \
+ (chan, status_bytes[msg][2], note, velocity)]])
self.cmd, self.state = [], 'IDLE'
def handle_channel_msg_0x90(self):
c = self.cmd
if len(c) < 3:
return
- self.es_block = self.ss
+ 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)]])
+ s = status_bytes[0x80] if (velocity == 0) else status_bytes[msg]
+ note_name = self.get_note_name(chan, note)
+ self.putx([0, ['Channel %d: %s (note = %d \'%s\', velocity = %d)' % \
+ (chan, s[0], note, note_name, velocity),
+ 'ch %d: %s %d, velocity = %d' % \
+ (chan, s[1], note, velocity),
+ '%d: %s %d, vel %d' % \
+ (chan, s[2], note, 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 of %d for note = %d \'%s\'' % \
+ (chan, status_bytes[msg][0], pressure, note, note_name),
+ 'ch %d: %s %d for note %d' % \
+ (chan, status_bytes[msg][1], pressure, note),
+ '%d: %s %d, N %d' % \
+ (chan, status_bytes[msg][2], pressure, note)]])
+ self.cmd, self.state = [], 'IDLE'
def handle_controller_0x44(self):
# Legato footswitch: Bn 44 vv
# n = channel, vv = value (<= 0x3f: normal, > 0x3f: legato)
- chan, vv = (self.cmd[0] & 0x0f) + 1, self.cmd[2]
- t = 'normal' if vv <= 0x3f else 'legato'
- self.putx([0, ['Channel %d: control function \'%s\' = %s' % \
- (chan, control_functions[0x44], t)]])
+ c = self.cmd
+ msg, chan, vv = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[2]
+ t = ('normal', 'no') if vv <= 0x3f else ('legato', 'yes')
+ self.putx([0, ['Channel %d: %s \'%s\' = %s' % \
+ (chan, status_bytes[msg][0],
+ control_functions[0x44][0], t[0]),
+ 'ch %d: %s \'%s\' = %s' % \
+ (chan, status_bytes[msg][1],
+ control_functions[0x44][1], t[0]),
+ '%d: %s \'%s\' = %s' % \
+ (chan, status_bytes[msg][2],
+ control_functions[0x44][2], t[1])]])
def handle_controller_0x54(self):
# Portamento control (PTC): Bn 54 kk
# n = channel, kk = source note for pitch reference
- chan, kk = (self.cmd[0] & 0x0f) + 1, self.cmd[2]
- self.putx([0, ['Channel %d: control function \'%s\' (source note ' \
- '= %d)' % (chan, control_functions[0x54], kk)]])
+ c = self.cmd
+ msg, chan, kk = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[2]
+ kk_name = self.get_note_name(chan, kk)
+ self.putx([0, ['Channel %d: %s \'%s\' (source note = %d / %s)' % \
+ (chan, status_bytes[msg][0],
+ control_functions[0x54][0], kk, kk_name),
+ 'ch %d: %s \'%s\' (source note = %d)' % \
+ (chan, status_bytes[msg][1],
+ control_functions[0x54][1], kk),
+ '%d: %s \'%s\' (src N %d)' % \
+ (chan, status_bytes[msg][2],
+ control_functions[0x54][2], kk)]])
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')
- self.putx([0, ['Channel %d: control change to function \'%s\' ' \
- '(param = 0x%02x)' % (chan, ctrl_fn, param)]])
+ msg, chan, fn, param = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[1], c[2]
+ default_name = 'undefined'
+ ctrl_fn = control_functions.get(fn, default_name)
+ if ctrl_fn == default_name:
+ ctrl_fn = ('undefined 0x%02x' % fn, 'undef 0x%02x' % fn, '0x%02x' % fn)
+ self.putx([0, ['Channel %d: %s \'%s\' (param = 0x%02x)' % \
+ (chan, status_bytes[msg][0], ctrl_fn[0], param),
+ 'ch %d: %s \'%s\' (param = 0x%02x)' % \
+ (chan, status_bytes[msg][1], ctrl_fn[1], param),
+ '%d: %s \'%s\' is 0x%02x' % \
+ (chan, status_bytes[msg][2], ctrl_fn[2], param)]])
+
+ def handle_channel_mode(self):
+ # Channel Mode: Bn mm vv
+ # n = channel, mm = mode number (120 - 127), vv = value
+ c = self.cmd
+ msg, chan, mm, vv = c[0] & 0xf0, (c[0] & 0x0f) + 1, c[1], c[2]
+ mode_fn = control_functions.get(mm, ('undefined', 'undef', 'undef'))
+ # Decode the value based on the mode number.
+ vv_string = ('', '')
+ if mm == 122: # mode = local control?
+ if vv == 0:
+ vv_string = ('off', 'off')
+ elif vv == 127: # mode = poly mode on?
+ vv_string = ('on', 'on')
+ else:
+ vv_string = ('(non-standard param value of 0x%02x)' % vv,
+ '0x%02x' % vv)
+ elif mm == 126: # mode = mono mode on?
+ if vv != 0:
+ vv_string = ('(%d channels)' % vv, '(%d ch)' % vv)
+ else:
+ vv_string = ('(channels \'basic\' through 16)',
+ '(ch \'basic\' thru 16)')
+ elif vv != 0: # All other channel mode messages expect vv == 0.
+ vv_string = ('(non-standard param value of 0x%02x)' % vv,
+ '0x%02x' % vv)
+ self.putx([0, ['Channel %d: %s \'%s\' %s' % \
+ (chan, status_bytes[msg][0], mode_fn[0], vv_string[0]),
+ 'ch %d: %s \'%s\' %s' % \
+ (chan, status_bytes[msg][1], mode_fn[1], vv_string[1]),
+ '%d: %s \'%s\' %s' % \
+ (chan, status_bytes[msg][2], mode_fn[2], vv_string[1])]])
+ 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()
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][0], change_type, pp, name),
+ 'ch %d: %s to %s %d' % \
+ (chan, status_bytes[msg][1], change_type, pp),
+ '%d: %s %d' % \
+ (chan, status_bytes[msg][2], pp)]])
+ 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][0], vv),
+ 'ch %d: %s %d' % (chan, status_bytes[msg][1], vv),
+ '%d: %s %d' % (chan, status_bytes[msg][2], 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][0], ll, mm, decimal),
+ 'ch %d: %s 0x%02x 0x%02x (%d)' % \
+ (chan, status_bytes[msg][1], ll, mm, decimal),
+ '%d: %s (%d)' % \
+ (chan, status_bytes[msg][2], 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)
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, ['%s: truncated manufacturer code (<1 bytes)' % \
+ status_bytes[msg][0],
+ '%s: truncated manufacturer (<1 bytes)' % \
+ status_bytes[msg][1],
+ '%s: trunc. manu.' % status_bytes[msg][2]]])
+ 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, ['%s: truncated manufacturer code (<3 bytes)' % \
+ status_bytes[msg][0],
+ '%s: truncated manufacturer (<3 bytes)' % \
+ status_bytes[msg][1],
+ '%s: trunc. manu.' % status_bytes[msg][2]]])
+ 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]),
+ default_name)
+ else:
+ manu_name = ('%s (0x%02x)' % (default_name, manu[0]),
+ default_name)
+ else:
+ manu_name = (manu_name, manu_name)
+ # Extract the payload, display in 1 of 2 formats
+ # TODO: Write methods to decode SysEx realtime & non-realtime payloads.
+ payload0 = ''
+ payload1 = ''
+ while len(self.cmd) > 0:
+ byte = self.cmd.pop(0)
+ payload0 += '0x%02x ' % (byte)
+ payload1 += '%02x ' % (byte)
+ if payload0 == '':
+ payload0 = '<empty>'
+ payload1 = '<>'
+ payload = (payload0, payload1)
+ self.putx([0, ['%s: for \'%s\' with payload %s' % \
+ (status_bytes[msg][0], manu_name[0], payload[0]),
+ '%s: \'%s\', payload %s' % \
+ (status_bytes[msg][1], manu_name[1], payload[1]),
+ '%s: \'%s\', payload %s' % \
+ (status_bytes[msg][2], manu_name[1], payload[1])]])
+ 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', 'SysCom', 'SC')
+ 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[0], status_bytes[msg][0],
+ quarter_frame_type[nn][0], dd),
+ '%s: %s of %s, value 0x%01x' % \
+ (group[1], status_bytes[msg][1],
+ quarter_frame_type[nn][1], dd),
+ '%s: %s of %s, value 0x%01x' % \
+ (group[2], status_bytes[msg][2],
+ quarter_frame_type[nn][1], dd)]])
+ self.cmd, self.state = [], 'IDLE'
+ return
+ tt = (dd & 0x6) >> 1
+ self.putx([0, ['%s: %s of %s, value 0x%01x for %s' % \
+ (group[0], status_bytes[msg][0], \
+ quarter_frame_type[nn][0], dd, smpte_type[tt]),
+ '%s: %s of %s, value 0x%01x for %s' % \
+ (group[1], status_bytes[msg][1], \
+ quarter_frame_type[nn][1], dd, smpte_type[tt]),
+ '%s: %s of %s, value 0x%01x for %s' % \
+ (group[2], status_bytes[msg][2], \
+ quarter_frame_type[nn][1], 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', 'SysCom', 'SC')
+ 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[0], status_bytes[msg][0], ll, mm, decimal),
+ '%s: %s 0x%02x 0x%02x (%d)' % \
+ (group[1], status_bytes[msg][1], ll, mm, decimal),
+ '%s: %s (%d)' % \
+ (group[2], status_bytes[msg][2], 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[0], status_bytes[msg][0], ss),
+ '%s: %s number %d' % \
+ (group[1], status_bytes[msg][1], ss),
+ '%s: %s # %d' % \
+ (group[2], status_bytes[msg][2], 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[0], status_bytes[msg][0]),
+ '%s: %s' % (group[1], status_bytes[msg][1]),
+ '%s: %s' % (group[2], status_bytes[msg][2])]])
+ self.cmd, self.state = [], 'IDLE'
def handle_sysrealtime_msg(self, newbyte):
# System realtime message: 0b11111ttt (t = message type)
- self.es_block = self.ss
- self.putx([0, ['System realtime message: %s' % status_bytes[newbyte]]])
+ self.es_block = self.es
+ group = ('System Realtime', 'SysReal', 'SR')
+ self.putx([0, ['%s: %s' % (group[0], status_bytes[newbyte][0]),
+ '%s: %s' % (group[1], status_bytes[newbyte][1]),
+ '%s: %s' % (group[2], status_bytes[newbyte][2])]])
self.cmd, self.state = [], 'IDLE'
def decode(self, ss, es, data):
self.ss, self.es = ss, es
+ # We're only interested in the byte value (not individual bits).
+ pdata = pdata[0]
+
# Short MIDI overview:
# - Status bytes are 0x80-0xff, data bytes are 0x00-0x7f.
# - Most messages: 1 status byte, 1-2 data bytes.
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'
self.handle_syscommon_msg(pdata)
elif self.state == 'HANDLE SYSREALTIME MSG':
self.handle_sysrealtime_msg(pdata)
-
projects / libsigrokdecode.git / blobdiff