mpd226.py

#!/usr/bin/python
#
# Script decode/encode configuration files for the Akai MPD226
# (c) Simon Wood, 12 Dec 2018
#

from optparse import OptionParser
from construct import *

#--------------------------------------------------
# For interactive menus (optional)
# https://github.com/jeffrimko/Qprompt

try:
   import qprompt
   _hasQPrompt = True
except ImportError:
   _hasQPrompt = False
'''
_hasQPrompt = False
'''

#--------------------------------------------------
# For programming scales (optional)
# https://github.com/charlottepierce/music_essentials

try:
   from music_essentials import Note,Scale
   _hasME = True
except ImportError:
   _hasME = False
'''
_hasME = False
'''

#--------------------------------------------------
# Constants defining MP226 features

_PADS = 16
_PBANKS = 4
_PTOTAL = _PADS * _PBANKS

_DIALS = 4
_DBANKS = 3
_DTOTAL = _DIALS * _DBANKS

_FADERS = 4
_FBANKS = 3
_FTOTAL = _FADERS * _FBANKS

_SWITCHES = 4
_SBANKS = 3
_STOTAL = _SWITCHES * _SBANKS

#--------------------------------------------------
# Define file format using Construct (v2.9)
# https://github.com/construct/construct

Header = Struct(
    Const(b"\xf0"),                 # SysEx Begin
    Const(b"\x47\x00"),             # Mfg ID = Akai
    Const(b"\x35"),                 # Dev ID = MPD226
    Const(b"\x10"),                 # CMD = Dump/Load Preset
    Const(b"\x08\x33"),             # Len = 1075 bytes (7bit stuffed)

    "preset" / Byte,
    "name" / PaddedString(8, "ascii"),  # Pad with spaces!

    "un1" /Byte,
    "tempo" / ExprAdapter(Int16ub, # 7bit stuffed - each byte max 0x7F
        ((obj_ & 0x7f) + ((obj_ & 0x7f00) >> 1)),
        ((obj_ & 0x7f) + ((obj_ & 0x3f80) << 1)),
        ),
    "timedivisionswitch" / Enum(Byte,
        MOMENTARY = 0,
        TOGGLE = 1,
        ),
    "division" / Enum(Byte,
        DIV_1_4   = 0,
        DIV_1_4T  = 1,
        DIV_1_8   = 2,
        DIV_1_8T  = 3,
        DIV_1_16  = 4,
        DIV_1_16T = 5,
        DIV_1_32  = 6,
        DIV_1_32T = 7,
        ),
    "noterepeatswitch" / Enum(Byte,
        MOMENTARY = 0,
        TOGGLE = 1,
        ),
    "gate" /Byte,
    "swing" / Enum(Byte,            # This could be byte value
        SWING_OFF = 50,
        SWING_54  = 54,
        SWING_56  = 56,
        SWING_58  = 58,
        SWING_60  = 60,
        SWING_62  = 62,
        ),

    "un5" /Byte,
    "un6" /Byte,
    "un7" /Byte,
    "un8" /Byte,
    "un9" /Byte,
    "transport" / Enum(Byte,
        MCC       = 0,
        MCCMIDI   = 1,
        MIDI      = 2,
        CTRL      = 3,
        PTEX      = 4,
        ),
    )

Pad = Struct(
    "type" / Enum(Byte,
        NOTE = 0,
        PROG = 1,
        BANK = 2,
        ),
    "channel" / Byte,
    "note" /Byte,                   # NOTE only
    "midi2din" / Enum(Byte,
        OFF = 0,
        ON  = 1,
        ),
    "trigger" / Enum(Byte,          # NOTE only
        MOMENTARY = 0,
        TOGGLE = 1,
        ),
    "aftertouch" / Enum(Byte,       # NOTE only
        OFF = 0,
        CHANNEL = 1,
        POLY = 2,
        ),
    "program" / Byte,               # PROG only
    "msb" / Byte,                   # BANK only
    "lsb" /Byte,                    # BANK only

    "offcolor" / Enum(Byte,
        OFF = 0, RED = 1, ORANGE = 2, AMBER = 3, YELLOW = 4,
        GREEN = 5, GREENBLUE = 6, AQUA = 7, LTBLUE = 8,
        BLUE = 9, PURPLE = 10, PINK = 11, HOTPINK = 12,
        LTPURPLE = 13, LTGREEN = 14, LTPINK = 15, GREY = 16
        ),
    "oncolor" / Enum(Byte,
        OFF = 0, RED = 1, ORANGE = 2, AMBER = 3, YELLOW = 4,
        GREEN = 5, GREENBLUE = 6, AQUA = 7, LTBLUE = 8,
        BLUE = 9, PURPLE = 10, PINK = 11, HOTPINK = 12,
        LTPURPLE = 13, LTGREEN = 14, LTPINK = 15, GREY = 16
        ),
)

Dial = Struct(
    "type" / Enum(Byte,
        CC = 0,
        AFTERTOUCH = 1,
        INC_DEC_1 = 2,
        INC_DEC_2 = 3,
        ),
    "channel" / Byte,               # 0 = Common, A1..16, B1..16
    "midicc" /Byte,                 # CC and ID2 only
    "min" /Byte,                    # CC and AT only
    "max" /Byte,                    # CC and AT only

    "midi2din" / Enum(Byte,
        OFF = 0,
        ON  = 1,
        ),

    "msb" /Byte,                    # ID1 only
    "lsb" / Byte,                   # ID1 only
    "value" / Byte,                 # ID1 only
)

Fader = Struct(
    "type" / Enum(Byte,
        CC = 0,
        AFTERTOUCH = 1,
        ),
    "channel" / Byte,               # 0 = Common, A1..16, B1..16
    "midicc" /Byte,                 # CC only
    "min" /Byte,                    # CC/AFTERTOUCH
    "max" /Byte,                    # CC/AFTERTOUCH

    "midi2din" / Enum(Byte,
        OFF = 0,
        ON  = 1,
        ),
)

Switch = Struct(
    "type" / Enum(Byte,
        CC = 0,
        NOTE = 1,
        PROGRAM = 2,
        BANK = 3,
        KEY = 4,
        ),
    "channel" / Byte,               # 0 = Common, A1..16, B1..16
                                    # all but KEYSTROKE
    "midicc" /Byte,                 # CC
    "mode" / Enum(Byte,             # CC 
        MOMENTARY = 0,
        TOGGLE = 1,
        ),
    "prog" /Byte,                   # PROGRAM/BANK
    "msb" / Byte,                   # BANK
    "lsb" / Byte,                   # BANK

    "midi2din" / Enum(Byte,         # all but KEYSTROKE
        OFF = 0,
        ON  = 1,
        ),

    "note" / Byte,                  # NOTE
    "velo" / Byte,                  # NOTE

    "invert" / Enum(Byte,           # CC
        OFF = 0,
        ON  = 1,
        ),

    "key1" /Byte,                   # KEYSTROKE
    "key2" / Enum(Byte,             # KEYSTROKE
        NONE = 0, CTRL = 1, SHIFT = 2, ALT = 3, OPT = 4,
        CTRL_SHIFT = 5, CTRL_ALT = 6, CTRL_OPT = 7,
        SHIFT_ALT = 8, SHIFT_OPT = 9, ALT_OPT = 10,
        CTRL_ALT_OP = 11, CTRL_SH_ALT = 12, CTRL_SH_OPT = 13
        ),
)

Unknown = Struct(
    "unknown" /Bytes(12),
)

Footer = Struct(
    Const(b"\xf7"),                 # SysEx End
)

Mpd226 = Sequence(
    Header,
    Array(_PBANKS, Array(_PADS, Pad,)),
    Array(_DBANKS, Array(_DIALS, Dial,)),
    Array(_FBANKS, Array(_FADERS, Fader,)),
    Array(_SBANKS, Array(_SWITCHES, Switch,)),
    Unknown,
    Footer,
)

#--------------------------------------------------

config = None

def edit_division():
    global config

    menu = qprompt.Menu()
    for x,y in Header.division.subcon.ksymapping.items():
        menu.add(str(x),y)
        if config[0]['division'] == y:
            dft = str(x)
    config[0]['division'] = int(menu.show(msg="Division", dft=dft))

def edit_swing():
    global config

    menu = qprompt.Menu()
    for x,y in Header.swing.subcon.ksymapping.items():
        menu.add(str(x),y)
        if config[0]['swing'] == y:
            dft = str(x)
    config[0]['swing'] = int(menu.show(msg="Swing", dft=dft))

def edit_dial(dial):
    global config

    bank = int((dial-1) / _DIALS)
    subdial = dial-(_DIALS * bank)-1

    menu = qprompt.Menu()
    for x,y in Dial.type.subcon.ksymapping.items():
        menu.add(str(x),y)
        if config[2][bank][subdial]['type'] == y:
            dft = str(x)
    dtype = int(menu.show(hdr="Dial %d (Bank %s-%d):" % (dial, chr(65+bank), subdial+1),
        msg="Type", dft=dft))
    config[2][bank][subdial]['type'] = dtype

    config[2][bank][subdial]['channel'] = \
        qprompt.ask_int("Channel", vld=list(range(0,17)),
            dft=config[2][bank][subdial]['channel'])

    if dtype == 0 or dtype == 3:    # CC or ID2
        config[2][bank][subdial]['midicc'] = \
            qprompt.ask_int("MidiCC", vld=list(range(0,128)),
                dft=config[2][bank][subdial]['midicc'])

    if dtype == 0 or dtype == 1:    # CC or AT
        config[2][bank][subdial]['min'] = \
            qprompt.ask_int("Min", vld=list(range(0,128)),
                dft=config[2][bank][subdial]['min'])
        config[2][bank][subdial]['max'] = \
            qprompt.ask_int("Max", vld=list(range(0,128)),
                dft=config[2][bank][subdial]['max'])

    if dtype == 2:                    # ID1
        config[2][bank][subdial]['msb'] = \
            qprompt.ask_int("MSB", vld=list(range(0,128)),
                dft=config[2][bank][subdial]['msb'])
        config[2][bank][subdial]['lsb'] = \
            qprompt.ask_int("LSB", vld=list(range(0,128)),
                dft=config[2][bank][subdial]['lsb'])
        config[2][bank][subdial]['value'] = \
            qprompt.ask_int("Value", vld=list(range(0,128)),
                dft=config[2][bank][subdial]['value'])

def edit_pad(pad):
    global config

    bank = int((pad-1) / _PADS)
    subpad = pad-(_PADS * bank)-1

    menu = qprompt.Menu()
    for x,y in Pad.type.subcon.ksymapping.items():
        menu.add(str(x),y)
        if config[1][bank][subpad]['type'] == y:
            dft = str(x)
    ptype = menu.show(hdr="Pad %d (Bank %s-%d):" % (pad, chr(65+bank), subpad+1),
        msg="Type", dft=dft)
    config[1][bank][subpad]['type'] = int(ptype)

    config[1][bank][subpad]['channel'] = \
        qprompt.ask_int("Channel", vld=list(range(1,17)),
            dft=config[1][bank][subpad]['channel'])

    if ptype == '0':
        config[1][bank][subpad]['note'] = \
            qprompt.ask_int("Note", vld=list(range(0,128)),
                dft=config[1][bank][subpad]['note'])

        menu = qprompt.Menu()
        for x,y in Pad.trigger.subcon.ksymapping.items():
            menu.add(str(x),y)
            if config[1][bank][subpad]['trigger'] == y:
                dft = str(x)
        config[1][bank][subpad]['trigger'] = int(menu.show(msg="Trigger", dft=dft))

        menu = qprompt.Menu()
        for x,y in Pad.aftertouch.subcon.ksymapping.items():
            menu.add(str(x),y)
            if config[1][bank][subpad]['aftertouch'] == y:
                dft = str(x)
        config[1][bank][subpad]['aftertouch'] = int(menu.show(msg="Aftertouch", dft=dft))
    elif ptype == '1':
        config[1][bank][subpad]['program'] = \
            qprompt.ask_int("Program", vld=list(range(0,128)),
                dft=config[1][bank][subpad]['program'])
    else:
        config[1][bank][subpad]['msb'] = \
            qprompt.ask_int("MSB", vld=list(range(0,128)),
                dft=config[1][bank][subpad]['msb'])
        config[1][bank][subpad]['lsb'] = \
            qprompt.ask_int("LSB", vld=list(range(0,128)),
                dft=config[1][bank][subpad]['lsb'])

def edit_scale(pad, verbose):
    global config

    rbank = int((pad-1) / _PADS)
    rsubpad = pad-(_PADS * rbank)-1

    ptype = config[1][rbank][rsubpad]['type']
    if ptype == "BANK":
        qprompt.error("Pad %d (Bank %s-%d) is configured as a BANK" % (pad, chr(65+rbank), rsubpad+1))
        return

    menu = qprompt.Menu()
    x = 0
    for y in Scale._SCALE_PATTERNS:
        menu.add(str(x),y)
        x = x + 1
    stype = menu.show(hdr="Pad %d (Bank %s-%d):" % (pad, chr(65+rbank), rsubpad+1),
        msg="Scale", returns="desc")
    
    root = qprompt.ask_int("Note", vld=list(range(0,128)),
        dft=config[1][rbank][rsubpad]['note'])

    count = qprompt.ask_int("Count", vld=[0]+list(range(1,_PTOTAL+2-pad)), dft=0)

    same = qprompt.ask_yesno(msg="Config all as per Pad %d?" % pad, dft='N')

    scale = Scale.build_scale(Note.from_midi_num(root), stype)
    scale_lst = []
    for note in scale:
        scale_lst.append(note.midi_note_number())

    if count:
        while len(scale_lst) < count:
            root = scale_lst.pop()
            scale = Scale.build_scale(Note.from_midi_num(root), stype)
            for note in scale:
                scale_lst.append(note.midi_note_number())
    else:
        count = len(scale_lst)
        if pad + count > _PTOTAL:
            count = _PTOTAL + 1 - pad

    for note in scale_lst[:count]:
        bank = int((pad-1) / _PADS)
        subpad = pad-(_PADS * bank)-1

        if same and ptype == "NOTE":
            config[1][bank][subpad]['type'] = config[1][rbank][rsubpad]['type']
            config[1][bank][subpad]['channel'] = config[1][rbank][rsubpad]['channel']
            config[1][bank][subpad]['trigger'] = config[1][rbank][rsubpad]['trigger']
            config[1][bank][subpad]['aftertouch'] = config[1][rbank][rsubpad]['aftertouch']

        if same and ptype == "PROG":
            config[1][bank][subpad]['type'] = config[1][rbank][rsubpad]['type']
            config[1][bank][subpad]['channel'] = config[1][rbank][rsubpad]['channel']

        if ptype == "NOTE":
            config[1][bank][subpad]['note'] = note
        else:
            config[1][bank][subpad]['program'] = note

        if verbose:
            print("Setting Pad %d (Bank %s-%d) to %d (%s)" %
            (pad, chr(65+bank), subpad+1, note, Note.from_midi_num(note)))
        pad = pad + 1

def main():
    global config

    usage = "usage: %prog [options] FILENAME"
    parser = OptionParser(usage)
    parser.add_option("-o", "--output", dest="outfile",
        help="write data to OUTFILE")
    parser.add_option("-v", "--verbose",
        action="store_true", dest="verbose")
    parser.add_option("-d", "--dump",
        help="dump configuration to text",
        action="store_true", dest="dump")

    parser.add_option("-p", "--preset", dest="preset",
        help="change the profile number to PRESET" )
    parser.add_option("-t", "--tempo", dest="tempo",
        help="change the tempo to TEMPO" )
    parser.add_option("-n", "--name", dest="name",
        help="change the profile name to NAME")

    if _hasQPrompt:
        parser.add_option("-X", "--division",
            help="Interactively change the Division",
            action="store_true", dest="division")
        parser.add_option("-S", "--swing",
            help="Interactively change the Swing",
            action="store_true", dest="swing")
        parser.add_option("-D", "--dial", dest="dial",
            help="Interactively configure a Dial")
        parser.add_option("-P", "--pad", dest="pad",
            help="Interactively configure a Pad" )

        if _hasME:
            parser.add_option("-M", "--scale", dest="scale",
                help="Interactively configure multiple Pads as a scale" )

    (options, args) = parser.parse_args()

    if len(args) != 1:
        parser.error("input FILE not specified")

    if options.verbose:
        print("Reading %s..." % args[0])

    infile = open(args[0], "rb")
    if not infile:
        print("Unable to open file")
        quit(0)

    data = infile.read(2000)
    config = Mpd226.parse(data)
    infile.close()



    # Change stuff here...
    if options.preset:
        config[0]['preset'] = int(options.preset)
    if options.tempo:
        config[0]['tempo'] = int(options.tempo)
    if options.name:
        config[0]['name'] = (options.name + (" "*8))[:8]

    if _hasQPrompt:
        if options.division:
            edit_division()
        if options.swing:
            edit_swing()
        if options.dial:
            edit_dial(int(options.dial))
        if options.pad:
            edit_pad(int(options.pad))

        if _hasME:
            if options.scale:
                edit_scale(int(options.scale), options.verbose)


    if options.dump:
        print(config)

    if options.verbose:
        if options.outfile:
            print("writing %s..." % options.outfile)
        else:
            print("writing %s..." % args[0])

    '''
    if options.outfile:
        outfile = open(options.outfile, "wb")
    else:
        outfile = open(args[0], "wb")

    if not outfile:
        print("Unable to open output file")
    else:
        outfile.write(Mpd226.build(config))
    '''

if __name__ == "__main__":
    main()
