PublicMirrors/Starship
1
0
Fork 0
mirror of https://github.com/HarbourMasters/Starship.git synced 2025-01-23 13:35:11 +03:00
Code Issues Actions Packages Projects Releases 1 Wiki Activity

decompression also prints file offsets for yaml (#240)

Browse Source 
* verbose

* indices
This commit is contained in:
petrie911 2024-05-12 10:45:33 -05:00 committed by GitHub
parent ea3a09909f
commit 7168299be4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 77 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Makefile
View File

@ -122,12 +122,10 @@ BUILD_DEFINES ?=
ifeq ($(VERSION),us) ifeq ($(VERSION),us)
BUILD_DEFINES += -DVERSION_US=1 BUILD_DEFINES += -DVERSION_US=1
# else
# $(error Invalid VERSION variable detected. Please use 'us')
endif endif
ifeq ($(VERSION),jap) ifeq ($(VERSION),jp)
BUILD_DEFINES += -DVERSION_JAP=1 BUILD_DEFINES += -DVERSION_JP=1
endif endif
ifeq ($(NON_MATCHING),1) ifeq ($(NON_MATCHING),1)
@ -419,11 +417,11 @@ endif
decompress: $(BASEROM) decompress: $(BASEROM)
@echo "Decompressing ROM..." @echo "Decompressing ROM..."
@$(PYTHON) $(COMPTOOL) -die $(COMPTOOL_DIR) -m $(MIO0) $(BASEROM) $(BASEROM_UNCOMPRESSED) @$(PYTHON) $(COMPTOOL) $(DECOMPRESS_OPT) -de $(COMPTOOL_DIR) -m $(MIO0) $(BASEROM) $(BASEROM_UNCOMPRESSED)
compress: $(BASEROM) compress: $(BASEROM)
@echo "Compressing ROM..." @echo "Compressing ROM..."
@$(PYTHON) $(COMPTOOL) -c -m $(MIO0) $(ROM) $(ROMC) @$(PYTHON) $(COMPTOOL) $(COMPRESS_OPT) -c -m $(MIO0) $(ROM) $(ROMC)
extract: extract:
@$(RM) -r asm/$(VERSION)/$(REV) bin/$(VERSION)/$(REV) @$(RM) -r asm/$(VERSION)/$(REV) bin/$(VERSION)/$(REV)

100
tools/comptool.py
View File

@ -6,9 +6,9 @@ import struct
import argparse import argparse
import sys import sys
file_table_dict = {0xDE480:"US1.1", 0xD9A90:"US1.0"} file_table_dict = {0xDE480:"US1.1", 0xD9A90:"US1.0", 0xE93C0:"JP1.0"}
file_names = [ file_names_us = [
"makerom", "main", "dma_table", "audio_seq", "audio_bank", "audio_table", "ast_common", "ast_bg_space", "ast_bg_planet", "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_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_star_wolf", "ast_allies", "ast_corneria", "ast_meteo", "ast_titania", "ast_7_ti_2", "ast_8_ti", "ast_9_ti", "ast_A_ti",
@ -19,6 +19,19 @@ file_names = [
"ovl_i3", "ovl_i4", "ovl_i5", "ovl_i6", "ovl_menu", "ovl_ending", "ovl_unused" "ovl_i3", "ovl_i4", "ovl_i5", "ovl_i6", "ovl_menu", "ovl_ending", "ovl_unused"
] ]
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_font", "ast_font_3d", "ast_andross", "ast_logo", "ast_ending",
"ast_ending_award_front", "ast_ending_award_back", "ast_reward", "ast_training", "ovl_i1", "ovl_i2",
"ovl_i3", "ovl_i4", "ovl_i5", "ovl_i6", "ovl_menu", "ovl_ending", "ovl_unused"
]
file_names_critical = {"makerom", "main", "dma_table", "audio_seq", "audio_bank", "audio_table"}
def int32(x): def int32(x):
return x & 0xFFFFFFFF return x & 0xFFFFFFFF
@ -108,8 +121,15 @@ def find_file_table(ROM):
decomp_inds = [0, 1, 2, 3, 4, 5, 15, 16, 21, 22, 23, 24, 48] decomp_inds = [0, 1, 2, 3, 4, 5, 15, 16, 21, 22, 23, 24, 48]
def compress(baserom, comprom, mio0, extract_dest=None): def compress(baserom, comprom, mio0, dma_table=None, verbose=False):
file_table = find_file_table(baserom) 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)
print("Detected ROM version is " + file_table_dict.get(file_table, "Unknown"))
# comp_const = 0xFFFEFFFFFE1E7FC0 # comp_const = 0xFFFEFFFFFE1E7FC0
@ -134,8 +154,13 @@ def compress(baserom, comprom, mio0, extract_dest=None):
compfile.truncate(p_file_begin) compfile.truncate(p_file_begin)
file_bytes = basefile.read(v_file_size) file_bytes = basefile.read(v_file_size)
if file_table_dict.get(file_table).startswith("JP"):
file_name = file_names_jp[file_count]
else:
file_name = file_names_us[file_count]
if (file_count in decomp_inds) or (file_count <= 5): if (file_count in decomp_inds) or (file_name in file_names_critical):
# if (1 << file_count) & comp_flags: # if (1 << file_count) & comp_flags:
p_file_size = v_file_size p_file_size = v_file_size
dec_msg = 'uncompressed' dec_msg = 'uncompressed'
@ -152,8 +177,8 @@ def compress(baserom, comprom, mio0, extract_dest=None):
comp_flag = 1 comp_flag = 1
compfile.seek(0, 2) compfile.seek(0, 2)
if verbose:
# print("File " + str(file_count) + ": Writing " + format(p_file_size, 'X') + " bytes at " + format(compfile.tell(),'X')) print("File " + file_name + ": Writing 0x%X " + dec_msg + " bytes at 0x%X" % (p_file_size, compfile.tell()))
compfile.write(file_bytes) compfile.write(file_bytes)
@ -184,12 +209,20 @@ def compress(baserom, comprom, mio0, extract_dest=None):
return return
def decompress(baserom, decomprom, mio0, extract_dest=None, print_inds=False): def decompress(baserom, decomprom, mio0, extract_dest=None, dma_table=None, print_inds=False, verbose=False):
file_table = find_file_table(baserom) if dma_table:
file_table = int(dma_table, 0)
print("File table found at 0x%X" % file_table) print("Using provided DMA table offset 0x%X" % file_table)
print("Detected ROM version is " + file_table_dict.get(file_table, "Unknown")) else:
file_table = find_file_table(baserom)
print("DMA table found at 0x%X" % file_table)
if file_table_dict.get(file_table):
version = file_table_dict.get(file_table)
print("Detected ROM version is " + version)
else:
print("Could not detect version.")
version = "Unknown"
with open(decomprom, 'w+b') as decompfile, open(baserom, 'rb') as basefile: with open(decomprom, 'w+b') as decompfile, open(baserom, 'rb') as basefile:
file_count = 0 file_count = 0
@ -226,7 +259,7 @@ def decompress(baserom, decomprom, mio0, extract_dest=None, print_inds=False):
dec_msg = 'compressed' dec_msg = 'compressed'
v_file_size = len(file_bytes) v_file_size = len(file_bytes)
else: else:
print('Invalid compression flag. Invalid ROM? Make sure ROM version is US v1.1 (REV A)') print('Invalid compression flag. There may be a problem with your ROM.')
sys.exit(2) sys.exit(2)
decompfile.seek(0, 2) decompfile.seek(0, 2)
@ -235,16 +268,26 @@ def decompress(baserom, decomprom, mio0, extract_dest=None, print_inds=False):
v_file_end = v_file_begin + v_file_size v_file_end = v_file_begin + v_file_size
file_name = file_names[file_count] + '.bin' if file_table_dict.get(file_table).startswith("JP"):
file_name = file_names_jp[file_count]
else:
file_name = file_names_us[file_count]
print("name: " + file_name) if(verbose):
print("start: 0x%X" % v_file_begin) print("name: " + file_name)
print("start: 0x%X" % v_file_begin)
if extract_dest is not None: if extract_dest is not None:
if not os.path.exists(extract_dest): if not os.path.exists(extract_dest):
os.mkdir(extract_dest) os.mkdir(extract_dest)
with open(extract_dest + os.sep + file_name, 'wb') as extract_file: 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) extract_file.write(file_bytes)
decompfile.seek(file_entry + 4) decompfile.seek(file_entry + 4)
@ -260,8 +303,10 @@ def decompress(baserom, decomprom, mio0, extract_dest=None, print_inds=False):
decompfile.seek(0x10) decompfile.seek(0x10)
decompfile.write(crc1.to_bytes(4, 'big')) decompfile.write(crc1.to_bytes(4, 'big'))
decompfile.write(crc2.to_bytes(4, 'big')) decompfile.write(crc2.to_bytes(4, 'big'))
print("Decompressed %d files." % file_count) print("Found %d files." % file_count)
if print_inds: 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("These file numbers were not compressed:")
print(decomp_file_inds) print(decomp_file_inds)
elif decomp_file_inds != decomp_inds: elif decomp_file_inds != decomp_inds:
@ -272,14 +317,15 @@ def decompress(baserom, decomprom, mio0, extract_dest=None, print_inds=False):
parser = argparse.ArgumentParser(description='Compress or decompress a Star Fox 64 ROM') parser = argparse.ArgumentParser(description='Compress or decompress a Star Fox 64 ROM')
parser.add_argument('inROM', help="ROM file to compress or decompress") parser.add_argument('inROM', help="ROM file to compress or decompress")
parser.add_argument('outROM', help="output file for processed ROM.") parser.add_argument('outROM', help="output file for processed ROM.")
parser.add_argument('-e', metavar='extract',dest='extract',help='directory for extracted decompressed files. Use with -d')
parser.add_argument('-c', action='store_true',help='compress provided ROM') parser.add_argument('-c', action='store_true',help='compress provided ROM')
parser.add_argument('-d', action='store_true',help='decompress provided ROM') parser.add_argument('-d', action='store_true',help='decompress provided ROM')
parser.add_argument('-m', metavar='mio0',dest='mio0',help='Path to mio0 tool if not in same directory') 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 without compressing or decompressing') parser.add_argument('-r', action="store_true",help='Fix crc without compressing or decompressing')
parser.add_argument('-m', metavar='mio0',dest='mio0',help='Path to mio0 tool if not in same directory')
parser.add_argument('-i', action='store_true',help='Print indices of uncompressed files during decompression.') parser.add_argument('-i', action='store_true',help='Print indices of uncompressed files during decompression.')
parser.add_argument('-v', action='store_true',help='Print file names and offsets of decompressed files.') parser.add_argument('-v', action='store_true',help='Print details about the ROM files.')
# parser.add_argument('-v', action='store_true',help='show what changes are made') parser.add_argument('-t', metavar='dma_table', dest='dma_table',help='Provide DMA table explicitly instead of autodetecting')
if __name__ == '__main__': if __name__ == '__main__':
args = parser.parse_args() args = parser.parse_args()
@ -292,9 +338,9 @@ if __name__ == '__main__':
if args.r: if args.r:
fix_crc(args.inROM) fix_crc(args.inROM)
elif args.c: elif args.c:
compress(args.inROM, args.outROM, mio0) compress(args.inROM, args.outROM, mio0, dma_table=args.dma_table, verbose=args.v)
elif args.d or args.extract: elif args.d or args.extract:
decompress(args.inROM, args.outROM, mio0, args.extract, args.i) decompress(args.inROM, args.outROM, mio0, extract_dest=args.extract, dma_table=args.dma_table, print_inds=args.i, verbose=args.v)
else: else:
print("Something went wrong.") print("Something went wrong.")