summaryrefslogtreecommitdiff
path: root/tools/assets/extract/extase_oot64/misc_resources.py
blob: 3bb576a104a036884018016ba6ca9ecb411c6290 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# SPDX-FileCopyrightText: © 2025 ZeldaRET
# SPDX-License-Identifier: CC0-1.0

import struct

from ..extase import (
    RESOURCE_PARSE_SUCCESS,
    File,
    Resource,
)

from tools import csdis


class CutsceneResource(Resource, can_size_be_unknown=True):

    def __init__(self, file: File, range_start: int, name: str):
        super().__init__(file, range_start, None, name)

    def try_parse_data(self, memory_context):
        assert self.file.data is not None
        assert self.range_start % 4 == 0
        data = self.file.data[self.range_start :]
        num_bytes = len(data)
        if num_bytes % 4 != 0:
            data = data[: -(num_bytes % 4)]
        data_words = [unpacked[0] for unpacked in struct.iter_unpack(">I", data)]
        size_words, cs_source = csdis.disassemble_cutscene(data_words)
        self.range_end = self.range_start + 4 * size_words
        self.cs_source = cs_source
        return RESOURCE_PARSE_SUCCESS

    def get_c_reference(self, resource_offset: int):
        if resource_offset == 0:
            return self.symbol_name
        else:
            raise ValueError

    extracted_path_suffix = ".inc.c"

    def get_filename_stem(self):
        return f"{self.name}.csdata"

    def write_extracted(self, memory_context):
        with self.extract_to_path.open("w") as f:
            if not self.braces_in_source:
                f.write("{\n")
            f.write(self.cs_source)
            if not self.braces_in_source:
                f.write("}\n")

    def get_c_declaration_base(self):
        return f"CutsceneData {self.symbol_name}[]"

    def get_c_includes(self):
        return (
            "cutscene_commands.h",
            # TODO these are not always needed:
            "ocarina.h", # for OCARINA_ACTION_*
            "player.h", # for PLAYER_CUEID_*
        )

    def get_h_includes(self):
        return ("cutscene.h",)