Files
PythonLib/pythonlib/games/ToolsTOR.py

1034 lines
40 KiB
Python
Raw Normal View History

2023-05-19 07:30:53 -05:00
import io
2023-07-27 22:04:50 -05:00
import pyjson5 as json
import re
2023-05-19 07:30:53 -05:00
import shutil
import struct
from dataclasses import dataclass
from itertools import tee
from pathlib import Path
2023-08-23 00:50:55 -05:00
import datetime
2023-05-19 07:30:53 -05:00
import lxml.etree as etree
import pandas as pd
import pycdlib
2023-05-19 07:30:53 -05:00
from tqdm import tqdm
2023-05-27 17:10:21 -05:00
from pythonlib.formats.FileIO import FileIO
from pythonlib.formats.pak import Pak
from pythonlib.formats.scpk import Scpk
2023-05-19 07:30:53 -05:00
import pythonlib.utils.comptolib as comptolib
import pythonlib.formats.pak2 as pak2lib
from pythonlib.formats.theirsce import Theirsce
from pythonlib.formats.theirsce_instructions import (AluOperation, InstructionType,
2023-05-19 07:30:53 -05:00
TheirsceBaseInstruction)
from .ToolsTales import ToolsTales
2023-08-08 00:46:47 -05:00
import subprocess
2023-01-06 22:45:40 -05:00
@dataclass
class LineEntry:
names: list[str]
text: str
offset: int
@dataclass
class NameEntry:
index: int
offsets: list[int]
VARIABLE_NAME = "[VARIABLE]"
class ToolsTOR(ToolsTales):
POINTERS_BEGIN = 0xD76B0 # Offset to DAT.BIN pointer list start in SLPS_254.50 file
POINTERS_END = 0xE60C8 # Offset to DAT.BIN pointer list end in SLPS_254.50 file
HIGH_BITS = 0xFFFFFFC0
LOW_BITS = 0x3F
2023-08-05 15:47:18 -05:00
2023-09-04 20:08:15 -05:00
def __init__(self, project_file: Path, insert_mask: list[str]) -> None:
base_path = project_file.parent
self.jsonTblTags = {}
self.ijsonTblTags = {}
with open(project_file, encoding="utf-8") as f:
jsonRaw = json.load(f)
self.paths: dict[str, Path] = {k: base_path / v for k, v in jsonRaw["paths"].items()}
self.main_exe_name = jsonRaw["main_exe_name"]
2023-08-08 00:46:47 -05:00
self.asm_file = jsonRaw["asm_file"]
# super().__init__("TOR", str(self.paths["encoding_table"]), "Tales-Of-Rebirth")
with open(self.paths["encoding_table"], encoding="utf-8") as f:
jsonRaw = json.load(f)
for k, v in jsonRaw.items():
self.jsonTblTags[k] = {int(k2, 16): v2 for k2, v2 in v.items()}
for k, v in self.jsonTblTags.items():
self.ijsonTblTags[k] = {v2: k2 for k2, v2 in v.items()}
self.id = 1
2023-05-19 07:30:53 -05:00
# byteCode
2022-02-18 15:42:52 -05:00
self.story_byte_code = b"\xF8"
self.string_opcode = InstructionType.STRING
2023-09-04 20:08:15 -05:00
self.list_status_insertion: list[str] = ['Done']
2023-09-05 06:06:45 -05:00
self.list_status_insertion.extend(insert_mask)
# Extract the story files
def extract_all_story(self, replace=False) -> None:
print("Extracting Story files...")
2022-12-21 19:10:18 -05:00
2023-06-10 20:38:48 -05:00
folder_path = self.paths["story_xml"]
folder_path.mkdir(exist_ok=True)
scpk_path = self.paths["extracted_files"] / "DAT" / "SCPK"
2023-05-19 10:14:55 -05:00
for file in tqdm(list(scpk_path.glob("*.scpk"))):
2023-05-22 20:49:45 -05:00
theirsce = Theirsce(Scpk.from_path(file).rsce)
xml_text = self.get_xml_from_theirsce(theirsce, "Story")
2022-07-04 16:10:43 -04:00
self.id = 1
with open(folder_path / file.with_suffix(".xml").name, "wb") as xml:
xml.write(xml_text)
# Extract all the skits files
2023-05-19 08:23:47 -05:00
def extract_all_skits(self, replace=False) -> None:
print("Extracting Skit files...")
2023-06-10 20:38:48 -05:00
folder_path = self.paths["skit_xml"]
folder_path.mkdir(exist_ok=True)
pak2_path = self.paths["extracted_files"] / "DAT" / "PAK2"
2023-05-19 10:14:55 -05:00
for file in tqdm(list(pak2_path.glob("*.pak2"))):
with open(file, "rb") as pak:
theirsce = pak2lib.get_theirsce_from_pak2(pak.read())
xml_text = self.get_xml_from_theirsce(Theirsce(theirsce), "Skits")
2023-05-22 22:37:41 -05:00
xml_name = file.name.split(".")[0] + ".xml"
with open(folder_path / xml_name, "wb") as xml:
xml.write(xml_text)
# Extract THEIRSCE to XML
def get_xml_from_theirsce(self, rsce: Theirsce, section: str) -> bytes:
#Create the XML file
2023-01-06 22:45:40 -05:00
# root = etree.Element('SceneText')
# etree.SubElement(root, "OriginalName").text = file_name
2023-01-06 22:45:40 -05:00
#pointers_offset, texts_offset = self.extract_Story_Pointers(rsce)
names, lines = self.extract_lines_with_speaker(rsce)
for i, (k, v) in enumerate(names.items(), -1):
names[k] = NameEntry(i, v)
2022-02-11 21:16:19 -05:00
#Remove duplicates
2022-07-04 16:10:43 -04:00
#list_informations = self.remove_duplicates(["Story"] * len(pointers_offset), pointers_offset, text_list)
2023-01-06 22:45:40 -05:00
# list_lines = ( ['Story', line.offset, line.text] for line in lines)
# list_names = ( ['Story', line.offset, line.text] for i, (k, v) in enumerate(found_names.items()))
#Build the XML Structure with the information
2023-01-06 22:45:40 -05:00
root = etree.Element("SceneText")
speakers_node = etree.SubElement(root, 'Speakers')
2023-01-07 22:00:46 -05:00
etree.SubElement(speakers_node, 'Section').text = "Speaker"
2023-01-06 22:45:40 -05:00
strings_node = etree.SubElement(root, 'Strings')
etree.SubElement(strings_node, 'Section').text = section
self.make_speakers_section(speakers_node, names)
self.make_strings_section(strings_node, lines, names)
2022-02-18 15:42:52 -05:00
# Return XML string
return etree.tostring(root, encoding="UTF-8", pretty_print=True)
2022-12-21 19:10:18 -05:00
2023-01-06 22:45:40 -05:00
def make_strings_section(self, root, lines: list[LineEntry], names: dict[str, NameEntry]):
pass
for line in lines:
entry_node = etree.SubElement(root, "Entry")
etree.SubElement(entry_node,"PointerOffset").text = str(line.offset)
text_split = list(filter(None, re.split(self.COMMON_TAG, line.text)))
if len(text_split) > 1 and text_split[0].startswith("<voice:"):
etree.SubElement(entry_node,"VoiceId").text = text_split[0][1:-1].split(":")[1]
etree.SubElement(entry_node, "JapaneseText").text = ''.join(text_split[1:])
else:
etree.SubElement(entry_node, "JapaneseText").text = line.text
etree.SubElement(entry_node,"EnglishText")
etree.SubElement(entry_node,"Notes")
2022-12-21 19:10:18 -05:00
2023-01-06 22:45:40 -05:00
if line.names:
etree.SubElement(entry_node,"SpeakerId").text = ','.join([str(names[n].index) for n in line.names])
etree.SubElement(entry_node,"Id").text = str(self.id)
self.id = self.id + 1
if line.text == '':
statusText = 'Done'
else:
statusText = 'To Do'
etree.SubElement(entry_node,"Status").text = statusText
def make_speakers_section(self, root, names: dict[str, NameEntry]):
for k, v in names.items():
entry_node = etree.SubElement(root, "Entry")
2023-01-06 23:16:52 -05:00
if v.offsets:
etree.SubElement(entry_node,"PointerOffset").text = ",".join([str(off) for off in v.offsets])
else:
etree.SubElement(entry_node,"PointerOffset")
2023-01-06 22:45:40 -05:00
etree.SubElement(entry_node,"JapaneseText").text = str(k)
etree.SubElement(entry_node,"EnglishText")
etree.SubElement(entry_node,"Notes")
etree.SubElement(entry_node,"Id").text = str(v.index)
etree.SubElement(entry_node,"Status").text = "To Do"
def extract_lines_with_speaker(self, theirsce: Theirsce):
# This will do a bit of everything thanks to the "nice"
# architecture of the Theirsce class :)
# Debug
# sections = []
# for _, section in enumerate(theirsce.sections):
# for _, sub in enumerate(section):
# sections.append(sub.off)
# Setup three-way opcode generator
d = TheirsceBaseInstruction(); d.type = InstructionType.INVALID
a,b,c = tee(theirsce.walk_code(), 3)
next(a, d)
next(b, d); next(b, d)
next(c, d); next(c, d); next(c, d)
# Helper function, in the future I'll
# just use a list of opcodes
def skip():
next(a, d); next(a, d)
next(b, d); next(b, d)
next(c, d); next(c, d)
names = {VARIABLE_NAME: []}
lines = []
params = []
used = False
for op1, op2, op3 in zip(a,b,c):
# Debug
# if theirsce.tell() in sections:
# print()
# print("SECTION: ")
# BREAK marks start of a local function
# so local params are no longer in scope
if op1.type is InstructionType.BREAK:
if used == False:
for param in params:
text = self.bytes_to_text(theirsce, param.offset + theirsce.strings_offset)
lines.append(LineEntry([], text, op1.position + 1))
params.clear()
continue
# This sequence mark the simple act of assigning
# a string to a local variable, so we can detect
# when they are used later in a function call
if (op1.type is InstructionType.REFERENCE
and op2.type is InstructionType.STRING
and op3.type is InstructionType.ALU
and op3.operation == AluOperation.ASSIGNMENT
):
params.append(op2)
skip()
continue
# This sequence represents the textbox call with
# the name being a variable (NPCs do this)
if (op1.type is InstructionType.REFERENCE
and op2.type is InstructionType.STRING
and op3.type is InstructionType.SYSCALL
and op3.function_index == 0x45
):
if len(params) >= 1:
name = [self.bytes_to_text(theirsce, p.offset + theirsce.strings_offset) for p in params]
[names.setdefault(n, []).append(p.position + 1) for n, p in zip(name, params)]
elif len(params) == 0:
name = []
text = self.bytes_to_text(theirsce, op2.offset + theirsce.strings_offset)
lines.append(LineEntry(name, text, op2.position + 1))
#print(f"{params}: {text}")
used = True
skip()
continue
# This sequence represents the textbox call with
# the text being a variable (Notice boxes do this)
if (op1.type is InstructionType.STRING
and op2.type is InstructionType.REFERENCE
and op3.type is InstructionType.SYSCALL
and op3.function_index == 0x45
):
name = [self.bytes_to_text(theirsce, op1.offset + theirsce.strings_offset)]
names.setdefault(name[0], []).append(op1.position + 1)
for param in params:
text = self.bytes_to_text(theirsce, param.offset + theirsce.strings_offset)
lines.append(LineEntry(name, text, param.position + 1))
#print(f"{text}: {name}")
used = True
params.clear()
skip()
continue
# This sequence represents a regular textbox call
# where both fields are an string (everything else, save for skits)
if (op1.type is InstructionType.STRING
and op2.type is InstructionType.STRING
and op3.type is InstructionType.SYSCALL
and op3.function_index == 0x45
):
name = [self.bytes_to_text(theirsce, op1.offset + theirsce.strings_offset)]
names.setdefault(name[0], []).append(op1.position + 1)
text = self.bytes_to_text(theirsce, op2.offset + theirsce.strings_offset)
lines.append(LineEntry(name, text, op2.position + 1))
#print(f"{name}: {text}")
skip()
continue
# Any other string in assorted code calls
if op1.type is InstructionType.STRING:
#print(theirsce.read_string_at(op1.offset + theirsce.strings_offset))
text = self.bytes_to_text(theirsce, op1.offset + theirsce.strings_offset)
lines.append(LineEntry([], text, op1.position + 1))
continue
return names, lines
def extract_story_pointers_plain(self, theirsce: Theirsce):
pointers_offset = []; texts_offset = []
for opcode in theirsce.walk_code():
2023-01-06 22:45:40 -05:00
if opcode.type == self.string_opcode:
pointers_offset.append(theirsce.tell() - 2) # Maybe check this later
texts_offset.append(opcode.offset + theirsce.strings_offset)
return pointers_offset, texts_offset
2023-08-08 00:46:59 -05:00
#Convert a bytes object to text using TAGS and TBL in the json file
def bytes_to_text(self, src: FileIO, offset: int = -1) -> str:
finalText = ""
tags = self.jsonTblTags['TAGS']
chars = self.jsonTblTags['TBL']
if (offset > 0):
2023-05-27 17:10:21 -05:00
src.seek(offset, 0)
while True:
2023-05-27 17:10:21 -05:00
b = src.read(1)
if b == b"\x00": break
b = ord(b)
# Custom Encoded Text
if (0x99 <= b <= 0x9F) or (0xE0 <= b <= 0xEB):
2023-05-27 17:10:21 -05:00
c = (b << 8) | src.read_uint8()
finalText += chars.get(c, "{%02X}{%02X}" % (c >> 8, c & 0xFF))
continue
if b == 0x1:
finalText += ("\n")
continue
2023-07-27 22:01:28 -05:00
if b == 0x2:
finalText += "<" + tags.get(b, f"{b:02X}") + ">"
continue
# ASCII text
if chr(b) in self.PRINTABLE_CHARS:
finalText += chr(b)
continue
# cp932 text
if 0xA0 < b < 0xE0:
finalText += struct.pack("B", b).decode("cp932")
continue
if b == 0x81:
2023-05-27 17:10:21 -05:00
next_b = src.read(1)
if next_b == b"\x40":
finalText += " "
else:
finalText += "{%02X}" % b
finalText += "{%02X}" % ord(next_b)
continue
# Simple Tags
if 0x3 <= b <= 0xF:
2023-05-27 17:10:21 -05:00
parameter = src.read_uint32()
tag_name = tags.get(b, f"{b:02X}")
tag_param = self.jsonTblTags.get(tag_name.upper(), {}).get(parameter, None)
if tag_param is not None:
2023-05-27 17:10:21 -05:00
finalText += f"<{tag_param}>"
else:
finalText += f"<{tag_name}:{parameter:X}>"
continue
# Variable tags (same as above but using rsce bytecode as parameter)
if 0x13 <= b <= 0x1A:
tag_name = f"unk{b:02X}"
2023-05-27 17:10:21 -05:00
parameter = "".join([f"{c:02X}" for c in Theirsce.read_tag_bytes(src)])
finalText += f"<{tag_name}:{parameter}>"
continue
# None of the above
finalText += "{%02X}" % b
2023-01-06 22:45:40 -05:00
return finalText
2023-08-08 00:46:59 -05:00
def get_node_bytes(self, entry_node) -> bytes:
#Grab the fields from the Entry in the XML
status = entry_node.find("Status").text
japanese_text = entry_node.find("JapaneseText").text
english_text = entry_node.find("EnglishText").text
#Use the values only for Status = Done and use English if non empty
final_text = ''
if (status in self.list_status_insertion):
2023-09-03 22:39:59 -05:00
final_text = english_text or ''
else:
final_text = japanese_text or ''
2022-10-22 21:18:01 -04:00
voiceId_node = entry_node.find("VoiceId")
if (voiceId_node != None):
final_text = '<voice:{}>'.format(voiceId_node.text) + final_text
#Convert the text values to bytes using TBL, TAGS, COLORS, ...
bytes_entry = self.text_to_bytes(final_text)
return bytes_entry
2023-05-22 12:53:52 -05:00
def get_new_theirsce(self, theirsce: Theirsce, xml: Path) -> Theirsce:
#To store the new text_offset and pointers to update
new_text_offsets = dict()
#Read the XML for the corresponding THEIRSCE
2022-07-04 16:10:43 -04:00
2023-05-22 12:53:52 -05:00
tree = etree.parse(xml)
root = tree.getroot()
2022-06-28 21:47:33 -04:00
#Go at the start of the dialog
#Loop on every Entry and reinsert
2023-05-22 12:53:52 -05:00
theirsce.seek(theirsce.strings_offset + 1)
theirsce.truncate()
nodes = [ele for ele in root.iter('Entry') if ele.find('Id').text != "-1"]
nodes = [ele for ele in nodes if ele.find('PointerOffset').text != "-1"]
for entry_node in nodes:
#Add the PointerOffset and TextOffset
new_text_offsets[entry_node.find("PointerOffset").text] = theirsce.tell()
#Use the node to get the new bytes
2023-05-22 12:53:52 -05:00
bytes_entry = self.get_node_bytes(entry_node)
#Write to the file
theirsce.write(bytes_entry + b'\x00')
2022-06-28 21:47:33 -04:00
#Update the pointers based on the new text_offset of the entries
for pointer_offset, text_offset in new_text_offsets.items():
2022-02-18 15:42:52 -05:00
pointers_list = pointer_offset.split(",")
2023-05-22 12:53:52 -05:00
new_value = text_offset - theirsce.strings_offset
2022-02-18 15:42:52 -05:00
for pointer in pointers_list:
theirsce.seek(int(pointer))
2022-06-28 21:31:01 -04:00
theirsce.write( struct.pack("<H", new_value))
return theirsce
2023-05-22 13:02:07 -05:00
def pack_all_skits(self):
print("Recreating Skit files...")
2022-12-21 19:10:18 -05:00
out_path = self.paths["temp_files"] / "DAT" / "PAK2"
out_path.mkdir(parents=True, exist_ok=True)
2023-06-10 20:38:48 -05:00
xml_path = self.paths["skit_xml"]
pak2_path = self.paths["extracted_files"] / "DAT" / "PAK2"
2023-05-22 13:02:07 -05:00
for file in (pbar:= tqdm(list(pak2_path.glob("*.pak2")))):
pbar.set_description_str(file.name)
2023-05-22 13:02:07 -05:00
with open(file, "rb") as f:
pak2_data = f.read()
pak2_obj = pak2lib.get_data(pak2_data)
old_rsce = Theirsce(pak2_obj.chunks.theirsce)
2023-05-22 22:37:41 -05:00
xml_name = file.name.split(".")[0] + ".xml"
new_rsce = self.get_new_theirsce(old_rsce, xml_path / xml_name)
2023-05-22 13:02:07 -05:00
new_rsce.seek(0)
2023-05-22 22:37:41 -05:00
pak2_obj.chunks.theirsce = new_rsce.read()
2023-05-22 13:02:07 -05:00
with open(out_path / file.name, "wb") as f:
f.write(pak2lib.create_pak2(pak2_obj))
2022-12-21 19:10:18 -05:00
def get_datbin_file_data(self) -> list[tuple[int, int]]:
slps_path = self.paths["original_files"] / self.main_exe_name
with open(slps_path, "rb") as elf:
elf.seek(self.POINTERS_BEGIN, 0)
blob = elf.read(self.POINTERS_END-self.POINTERS_BEGIN)
pointers = struct.unpack(f"<{len(blob)//4}I", blob)
file_data: list[tuple[int, int]] = []
2023-05-19 07:48:01 -05:00
for c, n in zip(pointers, pointers[1:]):
remainder = c & self.LOW_BITS
start = c & self.HIGH_BITS
end = (n & self.HIGH_BITS) - remainder
file_data.append((start, end - start))
2023-05-19 07:48:01 -05:00
return file_data
2023-08-08 00:46:59 -05:00
2023-05-19 07:48:01 -05:00
# Extract the file DAT.BIN to the different directorties
def extract_main_archive(self) -> None:
dat_bin_path = self.paths["extracted_files"] / "DAT"
2023-08-11 22:54:55 -05:00
dat_bin_path.mkdir(exist_ok=True)
2022-02-18 15:42:52 -05:00
2023-07-27 22:00:32 -05:00
self.clean_folder(dat_bin_path)
print("Extracting DAT.BIN files...")
2023-07-27 22:02:02 -05:00
with open(self.paths["original_files"] / "DAT.BIN", "rb") as f:
for i, (offset, size) in enumerate(tqdm(self.get_datbin_file_data(), desc="Extracting files", unit="file")):
2023-05-19 07:48:01 -05:00
# Ignore 0 byte files
2023-05-19 07:48:01 -05:00
if size == 0:
continue
f.seek(offset, 0)
data = f.read(size)
if comptolib.is_compressed(data):
c_type = struct.unpack("<b", data[:1])[0]
data = comptolib.decompress_data(data)
extension = self.get_extension(data)
fname = f"{i:05d}.{c_type}.{extension}"
else:
extension = self.get_extension(data)
fname = f"{i:05d}.{extension}"
final_path = dat_bin_path / extension.upper()
final_path.mkdir(exist_ok=True)
2023-05-19 07:48:01 -05:00
with open(final_path / fname, "wb") as output:
output.write(data)
2023-05-27 17:10:21 -05:00
def get_style_pointers(self, file: FileIO, ptr_range: tuple[int, int], base_offset: int, style: str) -> tuple[list[int], list[int]]:
2023-07-27 22:04:50 -05:00
file.seek(ptr_range[0])
2023-07-27 22:04:50 -05:00
pointers_offset: list[int] = []
pointers_value: list[int] = []
2023-08-15 02:15:54 -05:00
split: list[str] = [ele for ele in re.split(r'([PT])|(\d+)', style) if ele]
2023-05-27 17:10:21 -05:00
while file.tell() < ptr_range[1]:
2023-05-27 17:10:21 -05:00
for step in split:
if step == "P":
2023-07-27 22:04:50 -05:00
off = file.read_uint32()
if base_offset != 0 and off == 0: continue
2023-07-27 22:04:50 -05:00
pointers_offset.append(file.tell() - 4)
pointers_value.append(off - base_offset)
2023-08-15 02:15:54 -05:00
elif step == "T":
off = file.tell()
pointers_offset.append(off)
pointers_value.append(off)
2023-05-27 17:10:21 -05:00
else:
file.read(int(step))
return pointers_offset, pointers_value
def extract_all_menu(self) -> None:
print("Extracting Menu Files...")
xml_path = self.paths["menu_xml"]
2023-05-27 17:10:21 -05:00
xml_path.mkdir(exist_ok=True)
# Read json descriptor file
with open(self.paths["menu_table"], encoding="utf-8") as f:
menu_json = json.load(f)
for entry in tqdm(menu_json):
if entry["file_path"] == "${main_exe}":
file_path = self.paths["original_files"] / self.main_exe_name
else:
2023-07-29 13:47:01 -05:00
file_path = self.paths["extracted_files"] / entry["file_path"]
2023-05-27 17:10:21 -05:00
if entry["is_pak"]:
pak = Pak.from_path(file_path, int(entry["pak_type"]))
for p_file in entry["files"]:
f_index = int(p_file["file"])
with FileIO(pak[f_index].data, "rb") as f:
xml_data = self.extract_menu_file(p_file, f)
2023-08-12 22:06:09 -05:00
with open(xml_path / (p_file["friendly_name"] + ".xml"), "wb") as xmlFile:
2023-05-27 17:10:21 -05:00
xmlFile.write(xml_data)
else:
with FileIO(file_path, "rb") as f:
2023-05-27 17:10:21 -05:00
xml_data = self.extract_menu_file(entry, f)
2023-08-12 22:06:09 -05:00
with open(xml_path / (entry["friendly_name"] + ".xml"), "wb") as xmlFile:
2023-05-27 17:10:21 -05:00
xmlFile.write(xml_data)
self.id = 1
2023-05-27 17:10:21 -05:00
def extract_menu_file(self, file_def, f: FileIO) -> bytes:
2023-05-27 17:10:21 -05:00
base_offset = file_def["base_offset"]
xml_root = etree.Element("MenuText")
2023-05-27 17:10:21 -05:00
# Collect the canonical pointer for the embedded pairs
2023-07-27 22:04:50 -05:00
emb = dict()
for pair in file_def["embedded"]:
f.seek(pair["HI"][0] - base_offset)
2023-07-27 22:04:50 -05:00
hi = f.read_uint16() << 0x10
f.seek(pair["LO"][0] - base_offset)
2023-07-27 22:04:50 -05:00
lo = f.read_int16()
2023-09-03 22:37:32 -05:00
if ((hi + lo) - base_offset) in emb:
emb[(hi + lo) - base_offset][0].append(*pair["HI"])
emb[(hi + lo) - base_offset][1].append(*pair["LO"])
else:
emb[(hi + lo) - base_offset] = [pair["HI"], pair["LO"]]
2023-07-27 22:04:50 -05:00
2023-05-27 17:10:21 -05:00
for section in file_def['sections']:
2023-08-15 02:15:54 -05:00
max_len = 0
2023-07-27 22:04:50 -05:00
pointers_start = int(section["pointers_start"])
pointers_end = int(section["pointers_end"])
2023-05-27 17:10:21 -05:00
# Extract Pointers list out of the file
pointers_offset, pointers_value = self.get_style_pointers(f, (pointers_start, pointers_end), base_offset, section['style'])
2023-05-27 17:10:21 -05:00
# Make a list, we also merge the emb pointers with the
# other kind in the case they point to the same text
2023-07-27 22:04:50 -05:00
temp = dict()
for off, val in zip(pointers_offset, pointers_value):
text = self.bytes_to_text(f, val)
temp.setdefault(text, dict()).setdefault("ptr", []).append(off)
if val in emb:
temp[text]["emb"] = emb.pop(val, None)
2023-05-27 17:10:21 -05:00
# Remove duplicates
2023-07-27 22:04:50 -05:00
list_informations = [(k, str(v['ptr'])[1:-1], v.setdefault('emb', None)) for k, v in temp.items()]
2023-05-27 17:10:21 -05:00
# Build the XML Structure with the information
2023-08-15 02:15:54 -05:00
if section['style'][0] == "T": max_len = int(section['style'][1:])
self.create_Node_XML(xml_root, list_informations, section['section'], max_len)
2023-07-27 22:04:50 -05:00
# Write the embedded pointers section last
temp = dict()
for k, v in emb.items():
text = self.bytes_to_text(f, k)
2023-09-03 22:37:32 -05:00
if text not in temp:
temp[text] = dict()
temp[text]["ptr"] = []
if "emb" in temp[text]:
temp[text]["emb"][0].append(*v[0])
temp[text]["emb"][1].append(*v[1])
else:
temp[text]["emb"] = v
2023-07-27 22:04:50 -05:00
#Remove duplicates
#list_informations = self.remove_duplicates(section_list, pointers_offset_list, texts)
list_informations = [(k, str(v['ptr'])[1:-1], v.setdefault('emb', None)) for k, v in temp.items()]
#Build the XML Structure with the information
2023-08-15 02:15:54 -05:00
if len(list_informations) != 0:
self.create_Node_XML(xml_root, list_informations, "MIPS PTR TEXT")
2023-07-27 22:04:50 -05:00
2023-05-27 17:10:21 -05:00
#Write to XML file
return etree.tostring(xml_root, encoding="UTF-8", pretty_print=True)
2023-08-08 00:44:12 -05:00
2023-07-29 13:47:01 -05:00
def pack_all_menu(self) -> None:
print("Packing Menu Files...")
xml_path = self.paths["menu_xml"]
out_path = self.paths["temp_files"]
# Read json descriptor file
with open(self.paths["menu_table"], encoding="utf-8") as f:
menu_json = json.load(f)
for entry in tqdm(menu_json):
if entry["file_path"] == "${main_exe}":
file_path = self.paths["original_files"] / self.main_exe_name
2023-08-08 00:44:12 -05:00
file_last = self.main_exe_name
2023-07-29 13:47:01 -05:00
else:
file_path = self.paths["extracted_files"] / entry["file_path"]
2023-08-08 00:44:12 -05:00
file_last = entry["file_path"]
2023-07-29 13:47:01 -05:00
if entry["is_pak"]:
pak = Pak.from_path(file_path, int(entry["pak_type"]))
for p_file in entry["files"]:
2023-08-08 00:44:12 -05:00
f_index = p_file["file"]
base_offset = p_file["base_offset"]
# Create pools of valid free spots
pools: list[list[int]] = [[x[0] - base_offset, x[1]-x[0]] for x in p_file["safe_areas"]]
2023-07-29 13:47:01 -05:00
pools.sort(key=lambda x: x[1])
2023-08-08 00:44:12 -05:00
# Get the xml
2023-08-12 22:06:09 -05:00
with open(xml_path / (p_file["friendly_name"] + ".xml"), "r", encoding='utf-8') as xmlFile:
2023-07-29 13:47:01 -05:00
root = etree.fromstring(xmlFile.read(), parser=etree.XMLParser(recover=True))
2023-08-08 00:44:12 -05:00
2023-07-29 13:47:01 -05:00
with FileIO(pak[f_index].data, "rb") as f:
2023-08-08 00:44:12 -05:00
self.pack_menu_file(root, pools, base_offset, f)
2023-07-29 13:47:01 -05:00
f.seek(0)
pak[f_index].data = f.read()
2023-08-08 00:44:12 -05:00
(out_path / file_last).parent.mkdir(parents=True, exist_ok=True)
with open(out_path / file_last, "wb") as f:
f.write(pak.to_bytes(entry["pak_type"]))
2023-07-29 13:47:01 -05:00
else:
2023-08-08 00:44:12 -05:00
base_offset = entry["base_offset"]
pools: list[list[int]] = [[x[0] - base_offset, x[1]-x[0]] for x in entry["safe_areas"]]
2023-07-29 13:47:01 -05:00
pools.sort(key=lambda x: x[1])
2023-08-08 00:44:12 -05:00
2023-08-12 22:06:09 -05:00
with open(xml_path / (entry["friendly_name"] + ".xml"), "r", encoding='utf-8') as xmlFile:
2023-07-29 13:47:01 -05:00
root = etree.fromstring(xmlFile.read(), parser=etree.XMLParser(recover=True))
with open(file_path, "rb") as f:
file_b = f.read()
with FileIO(file_b, "wb") as f:
2023-08-08 00:44:12 -05:00
self.pack_menu_file(root, pools, base_offset, f)
2023-07-29 13:47:01 -05:00
f.seek(0)
2023-08-08 00:44:12 -05:00
(out_path / file_last).parent.mkdir(parents=True, exist_ok=True)
with open(out_path / file_last, "wb") as g:
2023-07-29 13:47:01 -05:00
g.write(f.read())
2023-08-08 00:44:12 -05:00
def pack_menu_file(self, root, pools: list[list[int]], base_offset: int, f: FileIO) -> None:
for line in root.iter("Entry"):
hi = []
lo = []
flat_ptrs = []
p = line.find("EmbedOffset")
if p is not None:
hi = [int(x) - base_offset for x in p.find("hi").text.split(",")]
lo = [int(x) - base_offset for x in p.find("lo").text.split(",")]
poff = line.find("PointerOffset")
if poff.text is not None:
flat_ptrs = [int(x) for x in poff.text.split(",")]
2023-08-15 02:15:54 -05:00
mlen = line.find("MaxLength")
if mlen is not None:
max_len = int(mlen.text)
f.seek(flat_ptrs[0])
text_bytes = self.get_node_bytes(line) + b"\x00"
if len(text_bytes) > max_len:
tqdm.write(f"Line id {line.find('Id').text} ({line.find('JapaneseText').text}) too long, truncating...")
f.write(text_bytes[:max_len-1] + b"\x00")
else:
f.write(text_bytes + (b"\x00" * (max_len-len(text_bytes))))
continue
2023-08-08 00:44:12 -05:00
text_bytes = self.get_node_bytes(line) + b"\x00"
for pool in pools:
l = len(text_bytes)
if l <= pool[1]:
str_pos = pool[0]
pool[0] += l; pool[1] -= l
break
else:
raise ValueError("Ran out of space")
f.seek(str_pos)
f.write(text_bytes)
virt_pos = str_pos + base_offset
for off in flat_ptrs:
f.write_uint32_at(off, virt_pos)
for _h, _l in zip(hi, lo):
val_hi = (virt_pos >> 0x10) & 0xFFFF
val_lo = (virt_pos) & 0xFFFF
# can't encode the lui+addiu directly
if val_lo >= 0x8000: val_hi += 1
f.write_uint16_at(_h, val_hi)
f.write_uint16_at(_l, val_lo)
2023-07-27 22:04:50 -05:00
2023-08-08 00:46:47 -05:00
def patch_binaries(self):
subprocess.run(
[
str(self.paths["tools"] / "asm" / "armips.exe"),
str(self.paths["tools"] / "asm" / self.asm_file),
"-strequ",
"__SLPS_PATH__",
str(self.paths["temp_files"] / self.main_exe_name),
]
)
2023-08-15 02:15:54 -05:00
def create_Node_XML(self, root, list_informations, section, max_len = 0) -> None:
strings_node = etree.SubElement(root, 'Strings')
etree.SubElement(strings_node, 'Section').text = section
2023-07-27 22:04:50 -05:00
for text, pointers_offset, emb in list_informations:
2023-08-15 02:15:54 -05:00
self.create_Entry(strings_node, pointers_offset, text, emb, max_len)
2023-05-19 08:23:47 -05:00
def pack_main_archive(self):
sectors: list[int] = [0]
remainders: list[int] = []
buffer = 0
# Copy the original SLPS to Disc/New
2023-07-29 13:47:01 -05:00
# shutil.copy(self.elf_original, self.elf_new)
2022-07-04 16:10:43 -04:00
print("Packing DAT.BIN files...")
output_dat_path = self.paths["final_files"] / "DAT.BIN"
original_files = self.paths["extracted_files"] / "DAT"
total_files = (self.POINTERS_END - self.POINTERS_BEGIN) // 4
# Get all original DAT.BIN files
file_list: dict[int, Path] = {}
for file in original_files.glob("*/*"):
file_index = int(file.name[:5])
file_list[file_index] = file
# Overlay whatever we have compiled
2023-07-29 13:47:01 -05:00
# file_list: dict[int, Path] = {}
for file in (self.paths["temp_files"] / "DAT").glob("*/*"):
file_index = int(file.name[:5])
file_list[file_index] = file
with open(output_dat_path, "wb") as output_dat:
for i in tqdm(range(total_files)):
file = file_list.get(i)
if not file:
remainders.append(0); sectors.append(buffer)
continue
with open(file, "rb") as f2:
data = f2.read()
2022-02-18 15:42:52 -05:00
comp_type = re.search(self.VALID_FILE_NAME, file.name).group(2)
2022-02-18 15:42:52 -05:00
if comp_type != None:
data = comptolib.compress_data(data, version=int(comp_type))
output_dat.write(data)
size = len(data)
remainder = 0x40 - (size % 0x40)
if remainder == 0x40: remainder = 0
2022-02-18 15:42:52 -05:00
output_dat.write(b"\x00" * remainder)
remainders.append(remainder)
buffer += size + remainder
sectors.append(buffer)
2022-08-05 15:22:45 -04:00
#Use the new SLPS updated and update the pointers for the SCPK
2023-07-29 13:47:01 -05:00
# original_slps = self.paths["original_files"] / self.main_exe_name
original_slps = self.paths["temp_files"] / self.main_exe_name
patched_slps = self.paths["final_files"] / self.main_exe_name
with open(original_slps, "rb") as f:
slps = f.read()
with open(patched_slps, "wb") as f:
f.write(slps)
f.seek(self.POINTERS_BEGIN)
for sector, remainder in zip(sectors, remainders):
f.write(struct.pack("<I", sector + remainder))
2022-02-18 15:42:52 -05:00
2022-02-18 15:42:52 -05:00
2023-05-22 12:53:52 -05:00
def pack_all_story(self):
print("Recreating Story files...")
2023-07-29 13:47:01 -05:00
2023-07-28 08:00:44 -05:00
out_path = self.paths["temp_files"] / "DAT" / "SCPK"
out_path.mkdir(parents=True, exist_ok=True)
xml_path = self.paths["story_xml"]
scpk_path = self.paths["extracted_files"] / "DAT" / "SCPK"
2023-05-22 12:53:52 -05:00
for file in (pbar:= tqdm(list(scpk_path.glob("*.scpk")))):
pbar.set_description_str(file.name)
2023-05-22 20:48:10 -05:00
curr_scpk = Scpk.from_path(file)
2023-05-22 12:53:52 -05:00
old_rsce = Theirsce(curr_scpk.rsce)
new_rsce = self.get_new_theirsce(old_rsce, xml_path / file.with_suffix(".xml").name)
new_rsce.seek(0)
curr_scpk.rsce = new_rsce.read()
with open(out_path / file.name, "wb") as f:
f.write(curr_scpk.to_bytes())
2022-02-18 15:42:52 -05:00
def insert_All(self):
#Updates SCPK based on XMLs data
self.pack_main_archive()
def extract_Iso(self, umd_iso: Path) -> None:
print("Extracting ISO files...")
iso = pycdlib.PyCdlib()
iso.open(str(umd_iso))
extract_to = self.paths["original_files"]
2023-07-27 22:00:32 -05:00
self.clean_folder(extract_to)
files = []
for dirname, _, filelist in iso.walk(iso_path="/"):
files += [dirname + x for x in filelist]
for file in files:
out_path = extract_to / file[1:]
out_path.parent.mkdir(parents=True, exist_ok=True)
with iso.open_file_from_iso(iso_path=file) as f, open(str(out_path).split(";")[0], "wb+") as output:
with tqdm(total=f.length(), desc=f"Extracting {file[1:].split(';')[0]}", unit="B", unit_divisor=1024, unit_scale=True) as pbar:
while data := f.read(2048):
output.write(data)
pbar.update(len(data))
2023-07-27 22:00:32 -05:00
iso.close()
def make_iso(self, umd_iso: Path) -> None:
print("Creating new iso...")
# We now pack the iso using every shortcut imaginable
# because realistically we won't really touch anything
# apart from the DAT.BIN and SLPS files
# The logic was basically taken from PS2 Iso Rebuilder
# Let's clean old build (if they exists)
self.clean_builds(self.paths["game_builds"])
# Set up new iso name
2023-08-23 00:50:55 -05:00
n: datetime.datetime = datetime.datetime.now()
new_iso = self.paths["game_builds"]
new_iso /= f"TalesOfRebirth_{n.year:02d}{n.month:02d}{n.day:02d}{n.hour:02d}{n.minute:02d}.iso"
with FileIO(new_iso, "wb+") as new:
# 1st copy the relevant contents from the original iso
# as we don't touch anything before the DAT.BIN that means
# copying the first 847549 LBAs from the original iso
with open(umd_iso, "rb") as og:
og_sz = 847549 * 0x800
with tqdm(total=og_sz, desc=f"Copying unchanged data", unit="B", unit_divisor=1024, unit_scale=True) as pbar:
for _ in range(og_sz // 0xCEEBD):
new.write(og.read(0xCEEBD))
pbar.update(0xCEEBD)
# Now we grab the 2nd Anchor from the original iso too
# it's at the end of the image, so just grab the last LBA
og.seek(-0x800, 2)
anchor_save = og.read(0x800)
# Now we plop the new DAT.BIN in its legitimate spot
with open(self.paths["final_files"] / "DAT.BIN", "rb") as dt:
dt.seek(0, 2)
dat_sz = dt.tell()
dt.seek(0)
with tqdm(total=dat_sz, desc=f"Inserting DAT.BIN", unit="B", unit_divisor=1024, unit_scale=True) as pbar:
while data := dt.read(0x8000):
new.write(data)
pbar.update(len(data))
# Align to nearest LBA
new.write_padding(0x800)
# get FIELD.BIN LBA
fld_lba = new.tell() // 0x800
# Now we plop FIELD.BIN in its legitimate spot
with open(self.paths["original_files"] / "FLD.BIN", "rb") as dt:
dt.seek(0, 2)
fld_sz = dt.tell()
dt.seek(0)
with tqdm(total=fld_sz, desc=f"Inserting FLD.BIN", unit="B", unit_divisor=1024, unit_scale=True) as pbar:
while data := dt.read(0x8000):
new.write(data)
pbar.update(len(data))
2023-08-29 21:26:15 -05:00
# Align file
new.write_padding(0x8000)
# Add the 20MiB pad cdvdgen adds
new.write_padding(0x13F_F800)
# get end of volume spot
2023-08-29 21:26:15 -05:00
end = new.tell()
end_lba = end // 0x800
# Put the Anchor in place
new.write(anchor_save)
# Now we update the file entries, DAT.BIN only need updated
# size, FLD.BIN size and LBA, also update the PVD size
2023-08-22 18:43:02 -05:00
new.write_int32_at(0x82992, dat_sz)
new.write_int32_at(0x829C2, fld_lba)
new.write_int32_at(0x8050, end_lba)
2023-08-29 21:26:15 -05:00
new.write_int32_at(end + 0xC, end_lba)
new.set_endian("big")
2023-08-22 18:43:02 -05:00
new.write_int32_at(0x82996, dat_sz)
new.write_int32_at(0x829C6, fld_lba)
new.write_int32_at(0x8054, end_lba)
new.set_endian("little")
# Finally, the SLPS, it's at the same location and size
# so no problems for us
with open(self.paths["final_files"] / "SLPS_254.50", "rb") as sl:
new.seek(0x89000)
new.write(sl.read())
2023-07-27 22:00:32 -05:00
def clean_folder(self, path: Path) -> None:
target_files = list(path.iterdir())
if len(target_files) != 0:
print("Cleaning folder...")
for file in target_files:
if file.is_dir():
shutil.rmtree(file)
elif file.name.lower() != ".gitignore":
file.unlink(missing_ok=False)
def clean_builds(self, path: Path) -> None:
2023-08-22 18:43:02 -05:00
target_files = sorted(list(path.glob("*.iso")), key=lambda x: x.name)[:-4]
if len(target_files) != 0:
print("Cleaning builds folder...")
for file in target_files:
2023-08-22 18:43:02 -05:00
print(f"deleting {str(file.name)}...")
file.unlink()