cmapconv.py

#!/usr/bin/env python3
import sys

def parse_palette(name, name2=None):
    # galaga: the palette contains 32 8 bit rgb values. The first 16 are
    # used by sprites and the second 16 by tiles

    # if the name is a comma seperated list, the there are three seperate
    # files for r, g and b
    if len(name.split(",")) == 3:
        palettes = []
        for fname in name.split(","):
            f = open(fname, "rb")
            palettes.append(f.read())
            f.close()

        # convert into palette_data (array of tuples)
        palette_data = []
        for i in range(256):
            palette_data.append((palettes[0][i],palettes[1][i],palettes[2][i]))
    else:
        f = open(name, "rb")
        palette_data = f.read()
        f.close()

    if name2:
        f = open(name2, "rb")
        palette_data_2 = f.read()
        f.close()
    else:
        palette_data_2 = None

    # map to 16 bit rgb in swapped format for ili9341 display
    palette = []
    for idx in range(len(palette_data)):
        c = palette_data[idx]
        
        # palette_data may be an array of three files
        if not isinstance(c, int) and len(c) == 3:
            # the proms contain 4 bit data
            # convert to rgb 565 (5 bit red, 6 bit green, 5 bit blue)
            r = c[0] << 1
            g = c[1] << 2
            b = c[2] << 1
        else:

            # dkong uses two 4 bit color proms, so there's a second one
            if palette_data_2:
                c = (palette_data_2[idx] << 4) + c 

                # donkey kong rrrgggbb mapping
                r = 31 - 31*((c>>5) & 0x7)//7
                g = 63 - 63*((c>>2) & 0x7)//7
                b = 31 - 31*((c>>0) & 0x3)//3
            else:
                # galaga, pacman and frogger bbgggrrr mapping
            
                # This doesn't 100% match the weighting each bit has
                # on the real machine with 1000, 470 and 220 ohms resistors.
                #
                # Here the weighting is 4/7, 2/7 and 1/7 while on the
                # real thing it's 4.15/7, 1.94/7 and 0.91/7. So the
                # weighting of the lsb is slightly higher on the real
                # device.
                
                b = 31*((c>>6) & 0x3)//3
                g = 63*((c>>3) & 0x7)//7
                r = 31*((c>>0) & 0x7)//7

        rgb = (r << 11) + (g << 5) + b
        rgbs = ((rgb & 0xff00) >> 8) + ((rgb & 0xff) << 8)
        palette.append(rgbs)

    return palette

def parse_colormap_1942_tiles(id, inname, palette, outname):
    inname, mapname0, mapname1 = inname.split(",")
    f = open(inname, "rb")
    colormap_data = f.read()
    f.close()

    # load map parts
    f = open(mapname0, "rb");  map0 = f.read(); f.close()
    f = open(mapname1, "rb");  map1 = f.read(); f.close()
    
    map = []
    for i in range(len(map0)):
        # only use lower 2 bits of sb-2.d1
        map.append(map0[i] + 16*(map1[i]&3))

    # create 16 palettes with 16 entries each

    # output of colormap_data is 4 bit and goes into lower four
    # bits of sb-3/sb-2 map. The upper 4 bits come externally,
    # resulting in 16 tables with 32 x 8 color maps each
    tab = 0

    # write as c source
    f = open(outname, "w")
    print("const unsigned short "+id+"[][32][8] = {", file=f )

    tabs = []
    for tab in range(16):    
        colors = []
        for idx in range(32):
            c = colormap_data[8*idx:8*(idx+1)]
            # check if values are sane
            if ( c[0] < 0 or c[0] > 15 or c[0] < 0 or c[1] > 15 or
                 c[2] < 0 or c[2] > 15 or c[3] < 0 or c[3] > 15):
                raise ValueError("Color index out of range")
            colors.append("{" + ",".join([ hex(palette[map[16*tab+a]]) for a in c ]) +"}")
        tabs.append("{" + ",".join(colors) + "}")
    print(",\n".join(tabs), file=f)
    print("};", file=f)
    f.close()

        
def parse_colormap(id, inname, palette, outname):
    # inname may be three comma seperated files. These are 1942 tiles maps
    # with an additinal indirection
    if len(inname.split(",")) == 3:
        parse_colormap_1942_tiles(id, inname, palette, outname)
        return
    
    f = open(inname, "rb")
    colormap_data = f.read()
    f.close()
        
    # the colormaps contain 64*4 4-bit entries that point
    # to palette entries.
    if len(colormap_data) != 256:
        raise ValueError("Missing colormap data")
    
    # write as c source
    f = open(outname, "w")
    print("const unsigned short "+id+"[][4] = {", file=f )
    colors = []
    for idx in range(64):
        c = colormap_data[4*idx:4*(idx+1)]
        # check if values are sane
        if ( c[0] < 0 or c[0] > 15 or c[0] < 0 or c[1] > 15 or
             c[2] < 0 or c[2] > 15 or c[3] < 0 or c[3] > 15):
            raise ValueError("Color index out of range")
        colors.append("{" + ",".join([ hex(palette[a]) for a in c ]) +"}")

    print(",\n".join(colors), file=f)
    print("};", file=f)
    f.close()
    
def parse_colormap_dkong(id, inname, palette, outname):
    f = open(inname, "rb")
    colormap_data = f.read()
    f.close()

    if len(colormap_data) != 256:
        raise ValueError("Missing colormap data")
    
    # write as c source
    f = open(outname, "w")
    print("const unsigned short "+id+"[][256][4] = {", file=f )
    # four different screen setups
    screens = [ ]
    for s in range(4):    
        colors = []
        for idx in colormap_data:
            idx += 16*s
            c = [4*idx+0, 4*idx+1, 4*idx+2, 4*idx+3]
            colors.append("{" + ",".join([ hex(palette[a]) for a in c ]) +"}")

        screens.append("{" + ",\n".join(colors)+"}")
    print(",\n".join(screens), file=f)
        
    print("};", file=f)

    print("", file=f)
    print("", file=f)

    # create the four sprite colormap tables
    print("const unsigned short "+id+"_sprite[][16][4] = {", file=f )
    screens = [ ]
    for s in range(4):
        colors = []
        for i in range(16):
            idx = i + 16*s
            c = [4*idx+0, 4*idx+1, 4*idx+2, 4*idx+3]
            colors.append("{" + ",".join([ hex(palette[a]) for a in c ]) +"}")
        screens.append("{" + ",\n".join(colors)+"}")
    print(",\n".join(screens), file=f)
    print("};", file=f)
    
    f.close()

def dump_palette(id, outname, palette):
    # write as c source
    f = open(outname, "w")
    print("const unsigned short "+id+"[][4] = {", file=f )
    colors = []
    for idx in range(8):
        c = palette[4*idx:4*(idx+1)]
        colors.append("{" + ",".join([ hex(a) for a in c ]) +"}")
    
    print(",\n".join(colors), file=f)
    print("};", file=f)
    f.close()

if len(sys.argv) < 4 or len(sys.argv) == 5 or len(sys.argv) > 7:
    print("Usage:",sys.argv[0], "name <palettefiles> offset <tablefile> <outfile>")
    print("  Galaga sprites:", sys.argv[0], "galaga_colormap_sprites ../roms/prom-5.5n 0 ../roms/prom-3.1c ../galagino/galaga_cmap_sprites.h")
    print("  Galaga tiles:  ", sys.argv[0], "galaga_colormap_tiles ../roms/prom-5.5n 16 ../roms/prom-4.2n ../galagino/galaga_cmap_tiles.h")
    print("  Pacman:        ", sys.argv[0], "pacman_colormap ../roms/82s123.7f 0 ../roms/82s126.4a ../galagino/pacman_cmap.h")
    print("  Donkey Kong:   ", sys.argv[0], "dkong_colormap ../roms/c-2k.bpr ../roms/c-2j.bpr 0 ../roms/v-5e.bpr ../galagino/dkong_cmap.h")
    print("  Frogger:       ", sys.argv[0], "frogger_colormap ../roms/pr-91.6l ../galagino/frogger_cmap.h")
    print("  Digdug tiles:  ", sys.argv[0], "digdug_colormap_tiles ../roms/136007.113 0 ../roms/136007.112 ../galagino/digdug_cmap_tiles.h")
    print("  Digdug sprites:", sys.argv[0], "digdug_colormap_sprites ../roms/136007.113 16 ../roms/136007.111 ../galagino/digdug_cmap_sprites.h")
    print("  Digdug cmap:   ", sys.argv[0], "digdug_colormaps ../roms/136007.113 ../galagino/digdug_cmap.h")
    print("  1942 chars:    ", sys.argv[0], "_1942_colormap_chars ../roms/sb-5.e8,../roms/sb-6.e9,../roms/sb-7.e10 128 ../roms/sb-0.f1 ../galagino/1942_character_cmap.h")
    print("  1942 tiles:    ", sys.argv[0], "_1942_colormap_tiles ../roms/sb-5.e8,../roms/sb-6.e9,../roms/sb-7.e10 -1 ../roms/sb-4.d6,../roms/sb-3.d2,../roms/sb-2.d1 ../galagino/1942_tile_cmap.h")
    print("  1942 sprites:  ", sys.argv[0], "_1942_colormap_sprites ../roms/sb-5.e8,../roms/sb-6.e9,../roms/sb-7.e10 64 ../roms/sb-8.k3 ../galagino/1942_sprite_cmap.h")
    exit(-1)

if len(sys.argv) == 4:
    palette = parse_palette(sys.argv[2])
    dump_palette(sys.argv[1], sys.argv[3], palette)
elif len(sys.argv) == 6:
    palette = parse_palette(sys.argv[2])
    offset = int(sys.argv[3])
    if offset >= 0:
        parse_colormap(sys.argv[1], sys.argv[4], palette[offset:offset+16], sys.argv[5])
    else:
        parse_colormap(sys.argv[1], sys.argv[4], palette, sys.argv[5])
else:
    # len 7
    # dkong has the palette in two 4 bit roms
    palette = parse_palette(sys.argv[2], sys.argv[3])
    parse_colormap_dkong(sys.argv[1], sys.argv[5], palette, sys.argv[6])