PyDeskMates/animation_reader.py at main · DimaLeon2000/PyDeskMates · GitHub

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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# import os
import struct
# import time


class FASReader:
    def __init__(self, fas_path):
        # filename = os.path.splitext(os.path.basename(fas_path))[0]
        self.fas_file = open(fas_path, 'rb')
        self.header = self.read_header()
        self.bitmap_infos = []
        bitmap_infos_size = 0
        for i in range(self.header['doublepal_count'] * 2):
            bitmap_info_header_size = self.read_4_bytes(offset=self.header['header_size'] + bitmap_infos_size,
                                                        byte_format='I')
            bpp = self.read_2_bytes(offset=self.header['header_size'] + 14 + bitmap_infos_size)
            bitmap_info = struct.pack('<I', bitmap_info_header_size) + struct.pack('<i', self.header['width'])\
                          + struct.pack('<i', self.header['height']) +\
                          self.read_bytes_raw(offset=self.header['header_size'] + 12 + bitmap_infos_size,
                                              num_bytes=bitmap_info_header_size - 12 + (2 ** bpp)*4)
            self.bitmap_infos.append(bitmap_info)
            bitmap_infos_size += len(bitmap_info)
        if self.header['version'] >= 1:
            self.char_id = self.read_1_byte(offset=self.header['header_size'] + bitmap_infos_size)
            # the XOR of ASCII values of characters in the character name string in uppercase
            # (e.g. "MAEKA" = 0x4D ^ 0x41 ^ 0x45 ^ 0x4B ^ 0x41 = 0x43,
            # "JOHLEE" = 0x4A ^ ^ 0x4F ^ 0x48 ^ 0x4C ^ 0x45 ^ 0x45 = 0x01)
        if self.header['version'] >= 2:
            self.extra_sprite_files = self.read_extra_sprite_files(self.header['header_size'] + bitmap_infos_size
                                                                   + int(self.header['version'] >= 1))
        else:
            self.extra_sprite_files = {'size': 0, 'count': 0, 'files': []}  # Failsafe
        if self.header['version'] >= 3:  # get missing upper 2 bytes (high word) of the frame_size variable,
                                         # which has lower 2 bytes (low word)
            self.header['frame_size'] += self.read_2_bytes(offset=self.header['header_size'] + bitmap_infos_size
                                                           + int(self.header['version'] >= 1)
                                                           + int(self.header['version'] >= 2)
                                                           * self.extra_sprite_files['size']) << 16
        touch_colors = self.read_2_bytes(offset=self.header['header_size'] + bitmap_infos_size
                                         + int(self.header['version'] >= 1)
                                         + int(self.header['version'] >= 2) * self.extra_sprite_files['size']
                                         + int(self.header['version'] >= 3) * 2)
        if touch_colors >= 1:  # check for hotspots
            touch_width = self.read_2_bytes(offset=self.header['header_size'] + bitmap_infos_size
                                            + int(self.header['version'] >= 1) + touch_colors * 4 + 2
                                            + int(self.header['version'] >= 2) * self.extra_sprite_files['size']
                                            + int(self.header['version'] >= 3) * 2
                                            )
            self.touch = {
                'colors': [self.read_4_bytes(offset=self.header['header_size'] + bitmap_infos_size
                                             + int(self.header['version'] >= 1) + i * 4 + 2
                                             + int(self.header['version'] >= 2) * self.extra_sprite_files['size']
                                             + int(self.header['version'] >= 3) * 2, byte_format='I')
                           for i in range(touch_colors)],
                'width': touch_width,
                'bitmap': self.read_bytes_raw(offset=self.header['header_size'] + bitmap_infos_size
                                              + int(self.header['version'] >= 1) + touch_colors * 4 + 4
                                              + int(self.header['version'] >= 2) * self.extra_sprite_files['size']
                                              + int(self.header['version'] >= 3) * 2,
                                              num_bytes=touch_width * self.header['height'])
            }
            self.seq_offset = (self.header['header_size'] + bitmap_infos_size + int(self.header['version'] >= 1) + 2
                               + int(self.header['version'] >= 2) * self.extra_sprite_files['size']
                               + int(self.header['version'] >= 3) * 2
                               + (touch_colors >= 1) * (touch_colors * 4 + 2 + len(list(self.touch['bitmap']))))
        else:
            self.seq_offset = (self.header['header_size'] + bitmap_infos_size + int(self.header['version'] >= 1) + 2
                               + int(self.header['version'] >= 2) * self.extra_sprite_files['size']
                               + int(self.header['version'] >= 3) * 2)
        self.seq_header = self.read_seq_header(self.seq_offset)
        self.seq_directory = self.read_seq_directory(self.seq_offset + self.seq_header['header_size'])
        if self.header['version'] >= 1:  # checksum (format version >= 1)
            self.checksum = self.read_1_byte(self.seq_offset + self.seq_header['total_size'])
            # name_sum = 0
            # for i in range(len(filename)):
            #     name_sum += ord(filename.upper()[i])
            # name_sum %= 256
            # print('Checksum', 'OK!' if name_sum == checksum else 'FAILED!')
            # assert(name_sum == checksum)

        self.frames_header = self.read_frames_header(self.seq_offset + self.seq_header['total_size']
                                                     + (self.header['version'] >= 1))
        self.frames_bitmap = [self.read_bytes_raw(offset=self.seq_offset + self.seq_header['total_size']
                                                  + (self.header['version'] >= 1) + 4
                                                  + self.frames_header['count'] * 3 + i
                                                  * self.header['frame_size'],
                                                  num_bytes=self.header['frame_size'])
                              for i in range(self.frames_header['count'])]
        # [print(self.read_sequence(i)) for i in range(self.seq_header['seq_count'])]

    def read_extra_sprite_files(self, __offset):
        return {
            'size': max(6, self.read_4_bytes(offset=__offset)),
            'counts': self.read_2_bytes(offset=__offset+4),
            'files': self.read_string_list_iso(offset=__offset + 6,
                                               num_bytes=self.read_4_bytes(offset=__offset) - 6)[:-1]
        }

    def read_frames_header(self, __offset):
        return {
            'count': self.read_4_bytes(offset=__offset),
            'id': [self.read_2_bytes(offset=__offset + 4 + i * 2)
                   for i in range(self.read_4_bytes(offset=__offset))],
            'info': [self.read_1_byte(offset=__offset + 4 + self.read_4_bytes(offset=__offset) * 2 + i)
                     for i in range(self.read_4_bytes(offset=__offset))]
        }

    def read_sequence(self, __index):
        pointers = self.seq_directory[__index]
        name_offset = (pointers['name_offset'] + self.seq_header['header_size']
                       + self.seq_header['seq_count'] * 8 + self.seq_offset)
        seq_offset = (pointers['data_offset'] + self.seq_header['header_size']
                      + self.seq_header['seq_count'] * 8 + self.seq_offset)
        # print(hex(name_offset),hex(seq_offset))
        # seq_info = {
        #     'name': self.read_string(offset=name_offset, num_bytes=50),
        #     'sequence': self.read_string_iso(offset=seq_offset, num_bytes=4000)
        # }
        seq_info = {
            'name': self.read_string_null_terminated(offset=name_offset),
            'sequence': self.read_string_null_terminated_iso(offset=seq_offset)
        }
        # seq_info = {
        #     self.read_string_null_terminated(offset=name_offset): self.read_string_null_terminated_iso(offset=seq_offset)
        # }
        return seq_info

    def read_seq_directory(self, __offset):
        directory = []
        for i in range(self.seq_header['seq_count']):
            offset = __offset + i * 8
            sequence_offset = {
                'id': i,
                'name_offset': self.read_4_bytes(offset),
                'data_offset': self.read_4_bytes(offset + 4)
            }
            directory.append(sequence_offset)
        return directory

    def read_seq_header(self, __offset):
        return {
            'total_size': self.read_4_bytes(offset=__offset),
            'seq_count': self.read_4_bytes(offset=__offset + 4),
            'header_size': 8
        }

    def read_header(self):
        return {
            'name': self.read_string(offset=0, num_bytes=50),
            'version': self.read_2_bytes(offset=50),
            'first_frame': self.read_2_bytes(offset=52),
            'last_frame': self.read_2_bytes(offset=54),
            'width': self.read_4_bytes(offset=56, byte_format='i'),
            'height': self.read_4_bytes(offset=60, byte_format='i'),
            'frame_size': self.read_2_bytes(offset=64, byte_format='H'),
            'doublepal_count': self.read_2_bytes(offset=66),
            'header_size': 68
        }

    def read_1_byte(self, offset, byte_format='B'):
        # B - unsigned char, b - signed char
        return self.read_bytes(offset=offset, num_bytes=1, byte_format=byte_format)[0]

    def read_2_bytes(self, offset, byte_format='H'):
        # H - uint16, h - int16
        return self.read_bytes(offset=offset, num_bytes=2, byte_format=byte_format)[0]

    def read_4_bytes(self, offset, byte_format='i'):
        # I - uint32, i - int32
        return self.read_bytes(offset=offset, num_bytes=4, byte_format=byte_format)[0]

    def read_string_list_iso(self, offset, num_bytes):
        # c - char
        return ''.join(b.decode('iso_8859_1') for b in
                       self.read_bytes(offset, num_bytes, byte_format='c' * num_bytes)
                       ).split('\x00')

    def read_string_null_terminated_iso(self, offset):
        # c - char
        i, result = 0, b''
        while True:
            b = self.read_bytes_raw(offset=offset + i, num_bytes=1)
            if (b == b'\x00') or (b == b''):
                break
            result += b
            i += 1
        return result.decode('iso_8859_1')

    def read_string_null_terminated(self, offset):
        # c - char
        i, result = 0, b''
        while True:
            b = self.read_bytes_raw(offset=offset + i, num_bytes=1)
            if (b == b'\x00') or (b == b''):
                break
            if ord(b) in range(0, 128):
                result += b
            i += 1
        return result.decode('ascii')

    def read_string_iso(self, offset, num_bytes):
        # c - char
        return ''.join(b.decode('iso_8859_1') for b in
                       self.read_bytes(offset, num_bytes, byte_format='c' * num_bytes)
                       ).split('\x00')[0]

    def read_string(self, offset, num_bytes):
        # c - char
        return ''.join(b.decode('ascii') for b in
                       self.read_bytes(offset, num_bytes, byte_format='c' * num_bytes)
                       if ord(b) in range(0, 128)).split('\x00')[0]

    def read_bytes_raw(self, offset, num_bytes):
        self.fas_file.seek(offset)
        buffer = self.fas_file.read(num_bytes)
        return buffer

    def read_bytes(self, offset, num_bytes, byte_format):
        self.fas_file.seek(offset)
        buffer = self.fas_file.read(num_bytes)
        return struct.unpack(byte_format, buffer)

    def close(self):
        self.fas_file.close()