mirror of
https://github.com/HarbourMasters/Starship.git
synced 2025-01-23 13:35:11 +03:00
473 lines
18 KiB
Python
473 lines
18 KiB
Python
#!/usr/bin/env python3
|
|
|
|
import os
|
|
from subprocess import run
|
|
import struct
|
|
import argparse
|
|
import sys
|
|
|
|
file_table_dict = {"US 1.1":0xDE480, "US 1.0":0xD9A90, "JP 1.0":0xE93C0, "JP 1.1":0xF2A10, "EU 1.0":0xE0570, "AU 1.0":0xE0470, "LN 1.0":0xE44F0}
|
|
|
|
file_names_jp = [
|
|
"makerom", "main", "dma_table", "audio_seq", "audio_bank", "audio_table", "ast_common", "ast_bg_space", "ast_bg_planet",
|
|
"ast_arwing", "ast_landmaster", "ast_blue_marine", "ast_versus", "ast_enmy_planet", "ast_enmy_space", "ast_great_fox",
|
|
"ast_star_wolf", "ast_allies", "ast_corneria", "ast_meteo", "ast_titania", "ast_7_ti_2", "ast_8_ti", "ast_9_ti", "ast_A_ti",
|
|
"ast_7_ti_1", "ast_sector_x", "ast_sector_z", "ast_aquas", "ast_area_6", "ast_venom_1", "ast_venom_2", "ast_ve1_boss",
|
|
"ast_bolse", "ast_fortuna", "ast_sector_y", "ast_solar", "ast_zoness", "ast_katina", "ast_macbeth", "ast_warp_zone",
|
|
"ast_title", "ast_map", "ast_option", "ast_vs_menu", "ast_text", "ast_font_3d", "ast_andross", "ast_logo", "ast_ending",
|
|
"ast_ending_award_front", "ast_ending_award_back", "ast_ending_expert", "ast_training", "ovl_i1", "ovl_i2",
|
|
"ovl_i3", "ovl_i4", "ovl_i5", "ovl_i6", "ovl_menu", "ovl_ending", "ovl_unused"
|
|
]
|
|
|
|
file_names_us = [
|
|
"makerom", "main", "dma_table", "audio_seq", "audio_bank", "audio_table", "ast_common", "ast_bg_space", "ast_bg_planet",
|
|
"ast_arwing", "ast_landmaster", "ast_blue_marine", "ast_versus", "ast_enmy_planet", "ast_enmy_space", "ast_great_fox",
|
|
"ast_star_wolf", "ast_allies", "ast_corneria", "ast_meteo", "ast_titania", "ast_7_ti_2", "ast_8_ti", "ast_9_ti", "ast_A_ti",
|
|
"ast_7_ti_1", "ast_sector_x", "ast_sector_z", "ast_aquas", "ast_area_6", "ast_venom_1", "ast_venom_2", "ast_ve1_boss",
|
|
"ast_bolse", "ast_fortuna", "ast_sector_y", "ast_solar", "ast_zoness", "ast_katina", "ast_macbeth", "ast_warp_zone",
|
|
"ast_title", "ast_map", "ast_option", "ast_vs_menu", "ast_text", "ast_font_3d", "ast_andross", "ast_logo", "ast_ending",
|
|
"ast_ending_award_front", "ast_ending_award_back", "ast_ending_expert", "ast_training", "ast_radio", "ovl_i1", "ovl_i2",
|
|
"ovl_i3", "ovl_i4", "ovl_i5", "ovl_i6", "ovl_menu", "ovl_ending", "ovl_unused"
|
|
]
|
|
|
|
file_names_pal = [
|
|
"makerom", "main", "dma_table", "audio_seq", "audio_bank", "audio_table", "ast_common", "ast_bg_space", "ast_bg_planet",
|
|
"ast_arwing", "ast_landmaster", "ast_blue_marine", "ast_versus", "ast_enmy_planet", "ast_enmy_space", "ast_great_fox",
|
|
"ast_star_wolf", "ast_allies", "ast_corneria", "ast_meteo", "ast_titania", "ast_7_ti_2", "ast_8_ti", "ast_9_ti", "ast_A_ti",
|
|
"ast_7_ti_1", "ast_sector_x", "ast_sector_z", "ast_aquas", "ast_area_6", "ast_venom_1", "ast_venom_2", "ast_ve1_boss",
|
|
"ast_bolse", "ast_fortuna", "ast_sector_y", "ast_solar", "ast_zoness", "ast_katina", "ast_macbeth", "ast_warp_zone",
|
|
"ast_title", "ast_map", "ast_map_en", "ast_map_fr", "ast_map_de", "ast_option", "ast_option_en", "ast_option_fr",
|
|
"ast_option_de", "ast_vs_menu", "ast_vs_menu_en", "ast_vs_menu_fr", "ast_vs_menu_de", "ast_text", "ast_font_3d", "ast_andross","ast_logo", "ast_ending",
|
|
"ast_ending_award_front", "ast_ending_award_back", "ast_ending_expert", "ast_training", "ast_radio_de", "ovl_i1", "ovl_i2", "ovl_i3",
|
|
"ovl_i4", "ovl_i5", "ovl_i6", "ovl_menu", "ovl_ending", "ovl_unused", "ast_radio_en", "ast_radio_fr"
|
|
]
|
|
|
|
file_names_critical = ["makerom", "main", "dma_table", "audio_seq", "audio_bank", "audio_table"]
|
|
|
|
decomp_inds_ntsc = [0, 1, 2, 3, 4, 5, 15, 16, 21, 22, 23, 24, 48]
|
|
decomp_inds_pal = [0, 1, 2, 3, 4, 5, 15, 16, 21, 22, 23, 24, 57]
|
|
|
|
def get_version_info(ROM):
|
|
with open(ROM, "rb") as ROMfile:
|
|
ROMfile.seek(0x3E, 0)
|
|
region = ROMfile.read(1).decode()
|
|
rev =" 1.%d" % int.from_bytes(ROMfile.read(1), 'big')
|
|
|
|
|
|
if region == "J":
|
|
file_names = file_names_jp
|
|
decomp_inds = decomp_inds_ntsc
|
|
version = "JP"
|
|
elif region == "E" or region == "G":
|
|
file_names = file_names_us
|
|
decomp_inds = decomp_inds_ntsc
|
|
version = "LN" if region == "G" else "US"
|
|
elif region == "P" or region == "U":
|
|
file_names = file_names_pal
|
|
decomp_inds = decomp_inds_pal
|
|
version = "AU" if region == "U" else "EU"
|
|
else:
|
|
file_names = "file_%d_%X"
|
|
decomp_inds = None
|
|
version = "Unknown"
|
|
|
|
if version != "Unknown":
|
|
version += rev
|
|
|
|
return (version, file_names, decomp_inds)
|
|
|
|
def int32(x):
|
|
return x & 0xFFFFFFFF
|
|
|
|
|
|
def rol(i, b):
|
|
return int32((i << b) | (i >> (32 - b)))
|
|
|
|
|
|
def calculate_crcs(buffer: bytearray, seed=0xF8CA4DDC, start=0x1000, end=0x101000):
|
|
t1 = t2 = t3 = t4 = t5 = t6 = seed
|
|
|
|
for d, in struct.iter_unpack(">I", buffer[start:end]):
|
|
r = rol(d, d & 0x1F)
|
|
|
|
if int32(t6 + d) < t6:
|
|
t4 = int32(t4 + 1)
|
|
|
|
t3 ^= d
|
|
t6 = int32(t6 + d)
|
|
t2 ^= r if (t2 > d) else t6 ^ d
|
|
t5 = int32(t5 + r)
|
|
t1 = int32(t1 + (t5 ^ d))
|
|
|
|
return (t6 ^ t4 ^ t3, t5 ^ t2 ^ t1)
|
|
|
|
def fix_crc(rom):
|
|
with open(rom, 'r+b') as romfile:
|
|
crc1, crc2 = calculate_crcs(romfile.read())
|
|
|
|
romfile.seek(0x10)
|
|
romfile.write(crc1.to_bytes( 4, 'big'))
|
|
romfile.write(crc2.to_bytes( 4, 'big'))
|
|
return
|
|
|
|
|
|
def mio0_comp_bytes(decomp_bytes, mio0):
|
|
#possibly replace with a python implementation later
|
|
decomp_path = os.path.dirname(mio0) + '/TempComp.bin.mio0'
|
|
comp_path = os.path.dirname(mio0) + '/TempComp.bin'
|
|
|
|
with open(decomp_path, 'wb') as decomp_file:
|
|
decomp_file.write(decomp_bytes)
|
|
|
|
run([mio0, '-c', decomp_path, comp_path])
|
|
|
|
with open(comp_path, 'rb') as comp_file:
|
|
comp_bytes = comp_file.read()
|
|
|
|
run(['rm', decomp_path, comp_path])
|
|
|
|
return comp_bytes
|
|
|
|
def mio0_dec_bytes(comp_bytes, mio0):
|
|
#possibly replace with a python implementation later
|
|
decomp_path = os.path.dirname(mio0) + '/TempComp.bin.mio0'
|
|
comp_path = os.path.dirname(mio0) + '/TempComp.bin'
|
|
|
|
with open(comp_path, 'wb') as comp_file:
|
|
comp_file.write(comp_bytes)
|
|
|
|
run([mio0, '-d', comp_path, decomp_path])
|
|
|
|
with open(decomp_path, 'rb') as decomp_file:
|
|
decomp_bytes = decomp_file.read()
|
|
|
|
run(['rm', decomp_path, comp_path])
|
|
|
|
return decomp_bytes
|
|
|
|
swap_backup = False
|
|
|
|
def fix_byte_swap(ROM, outROM):
|
|
with open(ROM, 'rb') as ROMfile:
|
|
ROMfile.seek(0x20,0)
|
|
|
|
game_str = ROMfile.read(4).decode()
|
|
|
|
if game_str == "STAR":
|
|
print("Provided ROM is big endian.")
|
|
return ROM
|
|
|
|
ROMfile.seek(0,0)
|
|
|
|
ROM_bytes = ROMfile.read()
|
|
|
|
s = game_str.find("S")
|
|
t = game_str.find("T")
|
|
a = game_str.find("A")
|
|
r = game_str.find("R")
|
|
|
|
if(s == -1 or t == -1 or a == -1 or r==-1):
|
|
print('Name string absent. There may be a problem with your ROM.')
|
|
sys.exit(2)
|
|
|
|
if game_str == "RATS":
|
|
print("Provided ROM is little endian.")
|
|
byte_order = "LE"
|
|
suffix = ".LE.n64"
|
|
elif game_str == "TSRA":
|
|
print("Provided ROM is byteswapped.")
|
|
byte_order = "BS"
|
|
suffix = ".BS.v64"
|
|
else:
|
|
byte_order = "%d%d%d%d" % (s, t, a, r)
|
|
suffix = "." + byte_order + ".u64"
|
|
print("Provided ROM has unusual byte order " + byte_order)
|
|
if swap_backup:
|
|
backup = os.path.splitext(ROM)[0] + suffix
|
|
with open(backup, "wb") as bakfile:
|
|
print("Writing backup file " + backup)
|
|
bakfile.write(ROM_bytes)
|
|
outROM = ROM
|
|
|
|
ROM_array = [bytearray([ROM_bytes[4*x + s], ROM_bytes[4*x + t], ROM_bytes[4*x + a], ROM_bytes[4*x + r]])
|
|
for x in range(len(ROM_bytes) // 4)
|
|
]
|
|
|
|
with open(outROM, 'wb') as tempROMfile:
|
|
tempROMfile.write(b''.join(ROM_array))
|
|
|
|
return outROM
|
|
|
|
|
|
def find_file_table(ROM):
|
|
with open(ROM, 'rb') as ROMfile:
|
|
|
|
ROMfile.seek(0,0)
|
|
|
|
main_area = ROMfile.read()
|
|
|
|
file_table_start = main_area.find(b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x50\x00\x00\x00\x00')
|
|
if file_table_start == -1:
|
|
file_table_start = main_area.find(b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x60\x00\x00\x00\x00')
|
|
|
|
if file_table_start == -1:
|
|
print('File table not found.')
|
|
sys.exit(2)
|
|
elif file_table_start > 0x100000:
|
|
print("Warning: Detected file table offset 0x%X is larger than expected." % file_table_start)
|
|
# print(file_table_start)
|
|
|
|
return file_table_start
|
|
|
|
|
|
def compress(baserom, comprom, mio0, dma_table=None, verbose=False):
|
|
if dma_table:
|
|
file_table = int(dma_table, 0)
|
|
if verbose:
|
|
print("Using provided DMA table offset 0x%X" % file_table)
|
|
else:
|
|
file_table = find_file_table(baserom)
|
|
if verbose:
|
|
print("DMA table found at 0x%X" % file_table)
|
|
|
|
|
|
(version, file_names, decomp_inds) = get_version_info(baserom)
|
|
ft_version = file_table_dict.get(version)
|
|
|
|
if version == "Unknown":
|
|
print("Unknown version. Unable to determine compression scheme.")
|
|
sys.exit(2)
|
|
elif ft_version and ft_version != file_table:
|
|
print("Warning: No record of DMA table at 0x%X for %s" % (file_table, version))
|
|
elif verbose:
|
|
print("Detected ROM version is " + version)
|
|
|
|
# comp_const = 0xFFFEFFFFFE1E7FC0
|
|
|
|
with open(comprom, 'w+b') as compfile, open(baserom, 'rb') as basefile:
|
|
file_count = 0
|
|
p_file_begin = 0
|
|
|
|
while True:
|
|
file_entry = file_table + 0x10 * file_count
|
|
basefile.seek(file_entry + 4)
|
|
|
|
v_file_begin = int.from_bytes(basefile.read(4),'big')
|
|
v_file_end = int.from_bytes(basefile.read(4),'big')
|
|
|
|
v_file_size = v_file_end - v_file_begin
|
|
|
|
if v_file_begin == 0 and v_file_end == 0:
|
|
break
|
|
|
|
basefile.seek(v_file_begin)
|
|
compfile.truncate(p_file_begin)
|
|
|
|
file_bytes = basefile.read(v_file_size)
|
|
|
|
file_name = file_names[file_count]
|
|
|
|
if (file_count in decomp_inds) or (file_name in file_names_critical):
|
|
# if (1 << file_count) & comp_flags:
|
|
p_file_size = v_file_size
|
|
dec_msg = 'uncompressed'
|
|
comp_flag = 0
|
|
else:
|
|
file_bytes = mio0_comp_bytes(file_bytes, mio0)
|
|
dec_msg = 'compressed'
|
|
extra_bytes = len(file_bytes) % 0x10
|
|
|
|
if extra_bytes != 0:
|
|
file_bytes += bytes(0x10 - extra_bytes)
|
|
|
|
p_file_size = len(file_bytes)
|
|
comp_flag = 1
|
|
|
|
compfile.seek(0, 2)
|
|
if verbose:
|
|
print("File " + file_name + ": Writing 0x%X " + dec_msg + " bytes at 0x%X" % (p_file_size, compfile.tell()))
|
|
|
|
compfile.write(file_bytes)
|
|
|
|
p_file_end = p_file_begin + p_file_size
|
|
|
|
compfile.seek(file_entry + 4)
|
|
compfile.write(p_file_begin.to_bytes(4,'big'))
|
|
compfile.write(p_file_end.to_bytes(4,'big'))
|
|
compfile.write(int.to_bytes(comp_flag, 4, 'big'))
|
|
|
|
p_file_begin = p_file_end
|
|
|
|
file_count += 1
|
|
|
|
compfile.seek(0, 2)
|
|
|
|
extra_space = 0xC00000 - compfile.tell()
|
|
if extra_space > 0:
|
|
compfile.write(b'\xFF' * extra_space)
|
|
|
|
|
|
compfile.seek(0)
|
|
crc1, crc2 = calculate_crcs(compfile.read())
|
|
|
|
compfile.seek(0x10)
|
|
compfile.write(crc1.to_bytes( 4, 'big'))
|
|
compfile.write(crc2.to_bytes( 4, 'big'))
|
|
|
|
return
|
|
|
|
def decompress(baserom, decomprom, mio0, extract_dest=None, dma_table=None, print_inds=False, verbose=False):
|
|
baserom = fix_byte_swap(baserom, baserom + "zxqj")
|
|
|
|
if dma_table:
|
|
file_table = int(dma_table, 0)
|
|
print("Using provided DMA table offset 0x%X" % file_table)
|
|
else:
|
|
file_table = find_file_table(baserom)
|
|
print("DMA table found at 0x%X" % file_table)
|
|
|
|
(version, file_names, decomp_inds) = get_version_info(baserom)
|
|
ft_version = file_table_dict.get(version)
|
|
|
|
|
|
if version == "Unknown":
|
|
print("Could not detect version")
|
|
elif ft_version and ft_version != file_table:
|
|
print("Warning: No record of DMA table at 0x%X for %s" % (file_table, version))
|
|
else:
|
|
print("Detected ROM version is " + version)
|
|
|
|
with open(decomprom, 'w+b') as decompfile, open(baserom, 'rb') as basefile:
|
|
file_count = 0
|
|
decomp_file_inds = []
|
|
|
|
while True:
|
|
file_entry = file_table + 0x10 * file_count
|
|
basefile.seek(file_entry)
|
|
|
|
v_file_begin = int.from_bytes(basefile.read(4),'big')
|
|
p_file_begin = int.from_bytes(basefile.read(4),'big')
|
|
p_file_end = int.from_bytes(basefile.read(4),'big')
|
|
comp_flag = int.from_bytes(basefile.read(4),'big')
|
|
|
|
p_file_size = p_file_end - p_file_begin
|
|
|
|
#print(v_file_begin, p_file_begin, p_file_end, comp_flag)
|
|
|
|
if v_file_begin == 0 and p_file_end == 0:
|
|
break
|
|
|
|
decompfile.truncate(v_file_begin)
|
|
|
|
basefile.seek(p_file_begin)
|
|
|
|
file_bytes = basefile.read(p_file_size)
|
|
|
|
if comp_flag == 0:
|
|
v_file_size = p_file_size
|
|
decomp_file_inds += [file_count]
|
|
dec_msg = 'uncompressed'
|
|
|
|
elif comp_flag == 1:
|
|
file_bytes = mio0_dec_bytes(file_bytes, mio0)
|
|
dec_msg = 'compressed'
|
|
v_file_size = len(file_bytes)
|
|
else:
|
|
print('Invalid compression flag. There may be a problem with your ROM.')
|
|
sys.exit(2)
|
|
|
|
decompfile.seek(0, 2)
|
|
|
|
decompfile.write(file_bytes)
|
|
|
|
v_file_end = v_file_begin + v_file_size
|
|
|
|
if decomp_inds:
|
|
file_name = file_names[file_count]
|
|
else:
|
|
file_name = file_names % (file_count, v_file_begin)
|
|
|
|
if verbose:
|
|
print("name: " + file_name)
|
|
print("start: 0x%X" % v_file_begin)
|
|
# print("index", file_count, dec_msg, "; size: 0x%X" % v_file_size)
|
|
|
|
if extract_dest is not None:
|
|
if not os.path.exists(extract_dest):
|
|
os.mkdir(extract_dest)
|
|
|
|
if version == "Unknown":
|
|
suffix = "%X" % file_table
|
|
else:
|
|
suffix = version.replace(" 1.", ".rev").lower()
|
|
|
|
out_file_name = file_name + "." + suffix + ".bin"
|
|
with open(extract_dest + os.sep + out_file_name, 'wb') as extract_file:
|
|
extract_file.write(file_bytes)
|
|
|
|
decompfile.seek(file_entry + 4)
|
|
decompfile.write(v_file_begin.to_bytes(4,'big'))
|
|
decompfile.write(v_file_end.to_bytes(4,'big'))
|
|
decompfile.write(bytes(4))
|
|
|
|
file_count += 1
|
|
|
|
decompfile.seek(0)
|
|
crc1, crc2 = calculate_crcs(decompfile.read())
|
|
|
|
decompfile.seek(0x10)
|
|
decompfile.write(crc1.to_bytes(4, 'big'))
|
|
decompfile.write(crc2.to_bytes(4, 'big'))
|
|
print("Found %d files." % file_count)
|
|
if len(decomp_file_inds) == file_count:
|
|
print("Provided ROM was uncompressed.")
|
|
elif print_inds or verbose:
|
|
print("These file numbers were not compressed:")
|
|
print(decomp_file_inds)
|
|
elif decomp_file_inds != decomp_inds:
|
|
print("Warning: Unusual compression scheme. These files were uncompressed:")
|
|
print(decomp_file_inds)
|
|
|
|
if baserom.endswith("zxqj"):
|
|
run(["rm", baserom])
|
|
|
|
return
|
|
|
|
parser = argparse.ArgumentParser(description='Compress or decompress a Star Fox 64 ROM')
|
|
parser.add_argument('inROM', help="ROM file to process")
|
|
parser.add_argument('outROM', help="Output file for processed ROM.")
|
|
parser.add_argument('-c', action='store_true',help='Compress a big endian uncompressed Star Fox 64 ROM')
|
|
parser.add_argument('-d', action='store_true',help='Decompress a Star Fox 64 ROM. Use with -s to also make a big endian compressed ROM.')
|
|
parser.add_argument('-e', metavar='extract',dest='extract',help='Directory for extracted decompressed files. Use with -d')
|
|
parser.add_argument('-r', action="store_true",help='Fix crc of Star Fox 64 ROM without compressing or decompressing')
|
|
parser.add_argument('-s', action='store_true',help='Swap a Star Fox 64 ROM to big endian (.z64). Use . as second argument to swap in-place or .b to also make a backup')
|
|
parser.add_argument('-m', metavar='mio0',dest='mio0',help='Path to mio0 tool if not named "mio0" and in same directory')
|
|
parser.add_argument('-i', action='store_true',help='Print indices of uncompressed files during decompression.')
|
|
parser.add_argument('-v', action='store_true',help='Print details about the ROM files.')
|
|
parser.add_argument('-t', metavar='dma_table', dest='dma_table',help='Provide DMA table explicitly instead of autodetecting')
|
|
|
|
if __name__ == '__main__':
|
|
args = parser.parse_args()
|
|
|
|
if not args.mio0:
|
|
mio0 = os.path.dirname(__file__) + os.sep + 'mio0'
|
|
else:
|
|
mio0 = args.mio0
|
|
|
|
if args.r:
|
|
fix_crc(args.inROM)
|
|
elif args.c:
|
|
compress(args.inROM, args.outROM, mio0, dma_table=args.dma_table, verbose=args.v)
|
|
elif args.d or args.extract:
|
|
swap_backup = args.s
|
|
decompress(args.inROM, args.outROM, mio0, extract_dest=args.extract, dma_table=args.dma_table, print_inds=args.i, verbose=args.v)
|
|
elif args.s:
|
|
if args.outROM[0] == ".":
|
|
args.outRom = args.inRom
|
|
if args.outROM == ".b":
|
|
swap_backup = True
|
|
fix_byte_swap(args.inROM, args.outROM)
|
|
else:
|
|
print("No action specified. Use -c, -d, -e, -r, or -s to specify an action")
|
|
|