rominfo.py

"""
    Rom description of Insiders '94.'
"""

FILES = ['ICS', 'IDS', 'ISS', 'IS2', 'ALD', 'AMD', 'BKD', 'CPU', 'DAT1', "DAT2",
         'DAT3', 'DAT4', 'DAT5', 'DAT6', 'DAT7', 'DAT8', 'BOOK', 'IPYR', 'FDD',
         'FRT', 'GAL', 'HMD', 'KGD', 'MAJ1', 'MAJ2', 'MAJ3', 'MAJ4', 'MAJ5',
         'MAJ6', 'MAJ7', 'MAJ8', 'PBD', 'PRG', 'RAM', 'TIP', 'VRM', 'ZND']

# The above, but not ICS
FILES_TO_DUMP = FILES = ['IDS', 'ISS', 'IS2', 'ALD', 'AMD', 'BKD', 'CPU', 'DAT1', "DAT2",
         'DAT3', 'DAT4', 'DAT5', 'DAT6', 'DAT7', 'DAT8', 'BOOK', 'IPYR', 'FDD',
         'FRT', 'GAL', 'HMD', 'KGD', 'MAJ1', 'MAJ2', 'MAJ3', 'MAJ4', 'MAJ5',
         'MAJ6', 'MAJ7', 'MAJ8', 'PBD', 'PRG', 'RAM', 'TIP', 'VRM', 'ZND']


UNCOMPRESSED_FILES = ['BOOK', 'ICS']

FILE_BLOCKS = {
    "IDS": [
        (0x3081, 0x30a5),
        (0x3310, 0x336b),
        (0x33a0, 0x33d0),  # SYSTEM
        (0x3400, 0x3431),
        (0x3436, 0x3477),
        (0x3478, 0x347f),
        (0x3480, 0x36dd),  # Lots of UU blocks that should be broken up
        (0xb080, 0xb14e),  # First non-scrolling text after "Start Game"
        (0xb160, 0xb21a),
        (0xb230, 0xb2e2),
        (0xb300, 0xb353),
        (0xb401, 0xb6c2),
        (0xb800, 0xba36), # Console text upon first launch
        (0xba80, 0xbc3f),  # Lots of UU blocks here too
    ],

    "ISS": [
        (0x8000, 0x81d7),
        (0x8401, 0x8e4a),
        (0x9001, 0x95c3),
        (0x9c01, 0xa26a),
        (0xac00, 0xb0db),
    ],

    "IS2": [
        (0x4a01, 0x4e50),
        (0x5d01, 0x62c1),
        (0x6901, 0x6f69),
        (0x7901, 0x7c1c),
        (0xa080, 0xa5a5),
        (0xa882, 0xabec),
        (0xac80, 0xaf55),
        (0xc4c1, 0xc4e4),
        (0xc4f0, 0xc937),
    ],

    "ALD": [
        (0x90, 0x1aa),
        (0x1b0, 0x1f7),
        (0x200, 0x234),
        (0x240, 0x263),
        (0x280, 0x30e),
        (0x310, 0x346),
        (0x600, 0x700),
        (0x800, 0x8e5),
    ],

    "AMD": [
        (0x80, 0xa8),
        (0x100, 0x187),
        (0x200, 0x664),
    ],

    "BKD": [
        (0x100, 0x1ff),
        (0x281, 0x2a4),
        (0x2a8, 0x2d5),
        (0x2d9, 0x2f0),
        (0x300, 0x314),
        (0x318, 0x338),
        (0x340, 0x34a),
        (0x350, 0x374),
        (0x380, 0x389),
        (0x390, 0x3b2),
        (0x3b8, 0x3d8),
    ],

    "CPU": [
        (0x101, 0x303),
    ],

    "DAT1": [
        (0xb1, 0xc9),
        (0x801, 0x15d4),
    ],

    "DAT2": [
        (0x800, 0x1759),
    ],

    "DAT3": [
        (0x801, 0x1710),
    ],

    "DAT4": [
        (0x801, 0xdfb),
        (0x1000, 0x1fcd),
    ],

    "DAT5": [
        (0x500, 0x5c3),
        (0x800, 0x97e),
        (0x1000, 0x1ff0),
    ],

    "DAT6": [
        (0x100, 0x190),
        (0x200, 0x331),
        (0x801, 0xc7b),
        (0x1001, 0x1ffe),
    ],

    "DAT7": [
        (0x200, 0x209),
        (0x210, 0x21d),
        (0x800, 0xa52),
        (0x1001, 0x1fcc),
    ],

    "DAT8": [
        (0x81, 0x9c),
        (0x800, 0x14d8),
    ],

    "BOOK": [
        (0x0, 0xec),
        (0x100, 0x1ea),
        (0x200, 0x2de),
        (0x300, 0x3a6),
        (0x400, 0x4ce),
        (0x500, 0x5d4),
        (0x600, 0x8cf),
        (0x900, 0x9cb),
        (0xa00, 0xae7),
        (0xb00, 0xbce),
    ],

    "IPYR": [
        (0xe2, 0xf2),
        (0x2e0, 0x300),
    ],

    "FDD": [
        (0x100, 0x19a),
        (0x200, 0x436),
        (0x680, 0x691),
        (0x6a0, 0x6c0),
        (0x700, 0x7ef),
    ],

    "FRT": [
        (0x0, 0x5bb),
    ],

    "GAL": [
        (0x0, 0x22b),
        (0x380, 0x3e8),
    ],

    "HMD": [
        (0x0, 0x5),
        (0x50, 0x61),
        (0x81, 0xa9),
        (0xb1, 0xfb),
        (0x101, 0x121),
        (0x128, 0x13b),
        (0x140, 0x14d),
        (0x151, 0x18d),
        (0x190, 0x1b8),
        (0x1c2, 0x1d0),
        (0x1d8, 0x1f7),
        (0x1f9, 0x211),
        (0x218, 0x23d),
        (0x241, 0x251),
        (0x259, 0x261),
        (0x269, 0x27a),
        (0x601, 0xdf9),
    ],

    "KGD": [
        (0x120, 0x1a5),
        (0x200, 0x6c5),
    ],

    "MAJ1": [
        (0x12, 0x20),
        (0x32, 0x5e),
        (0x1b2, 0x1c0),
        (0x1d0, 0x204),
        (0x352, 0x35d),
        (0x370, 0x3b0),
        (0x4f2, 0x500),
        (0x510, 0x53e),
        (0x9f2, 0x9fe),
        (0xa10, 0xa3e),
        (0xc72, 0xc78),
        (0xc90, 0xcb0),
    ],

    "MAJ2": [
        (0x12, 0x1f),
        (0x30, 0x37),
        (0x42, 0x52),
        (0x70, 0x76),
        (0x6d2, 0x6e0),
        (0x702, 0x712),
        (0x730, 0x739),
        (0xd92, 0xd98),
        (0xdb0, 0xdbe),
        (0xdc1, 0xdd2),
    ],

    "MAJ3": [
        (0x12, 0x18),
        (0x41, 0x5e),
        (0x70, 0x74),
        (0x6d2, 0x6dc),
        (0x702, 0x71e),
        (0x730, 0x737),
        (0xd92, 0xd9b),
        (0xdc1, 0xdde),
        (0xdf0, 0xdfb),
    ],

    "MAJ4": [
        (0x12, 0x1e),
        (0x41, 0x52),
        (0x70, 0x79),
        (0x6d2, 0x6e0),
        (0x701, 0x712),
        (0x730, 0x739),
        (0xd92, 0xd9e),
        (0xdc2, 0xdd2),
        (0xdf0, 0xdf8),
    ],

    "MAJ5": [
        (0x12, 0x1a),
        (0x41, 0x5e),
        (0x70, 0x7a),
        (0x6d2, 0x6de),
        (0x702, 0x712),
        (0x730, 0x73d),
        (0xd92, 0xd9c),
        (0xdc1, 0xdd2),
        (0xdf0, 0xdf9),
    ],

    "MAJ6": [
        (0x12, 0x1e),
        (0x41, 0x5e),
        (0x70, 0x77),
        (0x6d2, 0x6de),
        (0x701, 0x71e),
        (0x730, 0x738),
        (0xdc1, 0xde4),
    ],

    "MAJ7": [
        (0x12, 0x1a),
        (0x30, 0x37),
        (0x41, 0x58),
        (0x70, 0x7c),
        (0x6d2, 0x6dc),
        (0x6f0, 0x6f9),
        (0x701, 0x718),
        (0xd92, 0xd9a),
        (0xdb0, 0xdb7),
        (0xdc1, 0xdd8),
        (0xdf0, 0xdf7),
    ],

    "MAJ8": [
        (0x12, 0x18),
        (0x30, 0x36),
        (0x41, 0x64),
        (0x70, 0x75),
        (0xcd2, 0xcda),
        (0xcf0, 0xd24),
        (0xd30, 0xd36),
        (0x1992, 0x1998),
        (0x19b0, 0x19bc),
        (0x19c1, 0x19e4),
        (0x19f0, 0x19f5),
    ],

    "MAJ9": [
        (0x12, 0x16),
        (0x30, 0x37),
        (0x41, 0x4c),
        (0x70, 0x78),
        (0xdc2, 0xdcc),
        (0xcf0, 0xcf7),
        (0xd01, 0xd0c),
        (0xd30, 0xd3a),
        (0x1992, 0x1998),
        (0x19b0, 0x19b7),
        (0x19c1, 0x19cc),
        (0x19f0, 0x19f6),
    ],

    "MAJA": [
        (0x12, 0x14),
        (0x30, 0x39),
        (0x41, 0x54),
        (0x70, 0x73),
        (0xcd2, 0xcdc),
        (0xcf0, 0xcf9),
        (0xd01, 0xd14),
        (0xd30, 0xd3a),
        (0x1992, 0x199c),
        (0x19b0, 0x19b9),
        (0x19c1, 0x19d4),
        (0x19f0, 0x19fe),
    ],

    "MAJB": [
        (0x12, 0x16),
        (0x30, 0x3f),
        (0x41, 0x54),
        (0x70, 0x74),
    ],

    "MAJC": [
        (0x12, 0x1c),
        (0x30, 0x3c),
        (0x41, 0x4e),
        (0x70, 0x77),
        (0x1092, 0x109c),
        (0x10b0, 0x10bd),
        (0x10c1, 0x10ce),
        (0x10f0, 0x10f7),
        (0x2112, 0x211c),
        (0x2130, 0x213f),
        (0x2141, 0x214e),
        (0x2170, 0x2177),
    ],

    "MAJD": [
        (0x12, 0x17),
        (0x30, 0x3d),
        (0x40, 0x52),
    ],

    "PBD": [
        (0x80, 0xac),
        (0xb0, 0xdc),
        (0x100, 0x19d),
        (0x200, 0x4c0),
        (0x540, 0xfb2),
    ],

    "PRG": [
        (0x0, 0x2d6),
    ],

    "RAM": [
        (0x101, 0x606),
    ],

    "TIP": [
        (0x80, 0xaa),
        (0xb0, 0xc2),
        (0x100, 0x621),
    ],

    "VRM": [
        (0x40, 0x69),
        (0x70, 0x93),
        (0x101, 0x5e9),
    ],

    "ZND": [
        (0x100, 0x443),
        (0x540, 0xb95),
        (0xba0, 0xd38),
        (0xd40, 0xda2),
        (0xdb0, 0xe46),
        (0xe50, 0xec4),
        (0xed0, 0xf81),
    ],
}

CONTROL_CODES = {
  #b'[LN]': b'/',
  #b'[WAIT1]': B_CONTROL_CODES[b'w'] + b'01',
  #b'[WAIT2]': B_CONTROL_CODES[b'w'] + b'02',
  #b'[00]': bytes([0x00]),
  #b'[BLANK]': b'',
  #b'[ee]': bytes([0xee]),
  b'[LN]': b'\x0a\x0d', # \x0a\x0d
  b'[DELAY]': b'\x0e',
}