Repository navigation
Expand file tree
/
Copy pathEndianBinaryReader.py
More file actions
370 lines (291 loc) · 12.2 KB
/
Copy pathEndianBinaryReader.py
File metadata and controls
370 lines (291 loc) · 12.2 KB
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
from __future__ import annotations
import re
from abc import ABC, ABCMeta, abstractmethod
from io import BytesIO, IOBase
from struct import Struct, unpack
from typing import BinaryIO, List, Optional, Union
from ._defines import TYPE_PARAM_SIZE_LIST, Endianess
reNot0 = re.compile(b"(.*?)\x00", re.S)
class EndianBinaryReader(ABC, metaclass=ABCMeta):
endian: Endianess
Length: int
Position: int
BaseOffset: int
def __new__(
cls,
item: Union[bytes, bytearray, memoryview, BytesIO, str, IOBase],
endian: Endianess = ">",
offset: int = 0,
):
"""
Creates a new instance of EndianBinaryReader, choosing the appropriate subclass based on the type of the input.
Args:
item: The data source (bytes, memoryview, file path, or stream).
endian: Endianness to use for reading data ('>' for big-endian, '<' for little-endian).
offset: Initial offset to set for reading.
Returns:
An instance of either EndianBinaryReader_Memoryview or EndianBinaryReader_Streamable.
Raises:
ValueError: If the provided `item` type is unsupported.
"""
if isinstance(item, (bytes, bytearray, memoryview)):
# Handle in-memory binary data
obj = super().__new__(EndianBinaryReader_Memoryview)
elif isinstance(item, IOBase): # Includes BufferedIOBase
# Handle stream-like objects
obj = super().__new__(EndianBinaryReader_Streamable)
elif isinstance(item, str):
# Handle file paths as input
try:
item = open(item, "rb")
obj = super().__new__(EndianBinaryReader_Streamable)
except FileNotFoundError as e:
raise ValueError(f"File not found: {item}") from e
elif isinstance(item, EndianBinaryReader):
# Wrap another EndianBinaryReader instance
new_item = (
item.stream
if isinstance(item, EndianBinaryReader_Streamable)
else item.view
)
return cls(new_item, endian, offset)
elif hasattr(item, "read"):
# Handle generic objects with a `read` method
if hasattr(item, "seek"):
obj = super().__new__(EndianBinaryReader_Streamable)
else:
item = item.read()
obj = super().__new__(EndianBinaryReader_Memoryview)
else:
raise ValueError(f"Unsupported input type: {type(item).__name__}")
# Initialize the chosen subclass
obj.__init__(item, endian)
return obj
def __init__(self, item, endian=">", offset=0):
self.endian = endian
self.BaseOffset = offset
self.Position = 0
def seek(self, offset: int, whence: int = 0) -> int:
if whence == 0:
self.Position = offset
elif whence == 1:
self.Position += offset
elif whence == 2:
self.Position = self.Length + offset
else:
raise ValueError("Invalid whence")
return self.Position
def tell(self) -> int:
return self.Position
def get_bytes(self) -> bytes:
return self.bytes
@abstractmethod
def create_sub_reader(self, offset: int, length: int) -> EndianBinaryReader:
pass
@property
def bytes(self):
raise NotImplementedError(f"{self.__class__.__name__}.read not implemented!")
def read(self, *args):
raise NotImplementedError(f"{self.__class__.__name__}.read not implemented!")
def read_byte(self) -> int:
return unpack(self.endian + "b", self.read(1))[0]
def read_u_byte(self) -> int:
return unpack(self.endian + "B", self.read(1))[0]
def read_bytes(self, num) -> bytes:
return self.read(num)
def read_short(self) -> int:
return unpack(self.endian + "h", self.read(2))[0]
def read_int(self) -> int:
return unpack(self.endian + "i", self.read(4))[0]
def read_long(self) -> int:
return unpack(self.endian + "q", self.read(8))[0]
def read_u_short(self) -> int:
return unpack(self.endian + "H", self.read(2))[0]
def read_u_int(self) -> int:
return unpack(self.endian + "I", self.read(4))[0]
def read_u_long(self) -> int:
return unpack(self.endian + "Q", self.read(8))[0]
def read_float(self) -> float:
return unpack(self.endian + "f", self.read(4))[0]
def read_double(self) -> float:
return unpack(self.endian + "d", self.read(8))[0]
def read_boolean(self) -> bool:
return bool(unpack(self.endian + "?", self.read(1))[0])
def read_string_to_null(self, max_length=32767) -> str:
ret = []
c = b""
while c != b"\0" and len(ret) < max_length and self.Position != self.Length:
ret.append(c)
c = self.read(1)
if not c:
raise ValueError("Unterminated string: %r" % ret)
return b"".join(ret).decode("utf8", "surrogateescape")
def read_string(self, size: Optional[int] = None, encoding: str = "utf8") -> str:
length = size if size is not None else self.read_int()
if 0 < length <= self.Length - self.Position:
string_data = bytes(self.read_bytes(length))
result = string_data.decode(encoding, "surrogateescape")
return result
return ""
def read_aligned_string(self) -> str:
ret = self.read_string()
self.align_stream()
return ret
def align_stream(self, alignment=4):
self.Position += (alignment - self.Position % alignment) % alignment
return self.Position
def read_byte_array(self) -> bytes:
return self.read(self.read_int())
def read_array(self, command, length: int) -> list:
return [command() for _ in range(length)]
def read_array_struct(self, param: str, length: int = None) -> list:
if length is None:
length = self.read_int()
struct = Struct(f"{self.endian}{length}{param}")
return struct.unpack(self.read(struct.size))
def read_boolean_array(self, length: int = None) -> List[bool]:
return self.read_array_struct("?", length)
def read_u_byte_array(self, length: int = None) -> List[int]:
return self.read_array_struct("B", length)
def read_u_short_array(self, length: int = None) -> List[int]:
return self.read_array_struct("h", length)
def read_short_array(self, length: int = None) -> List[int]:
return self.read_array_struct("H", length)
def read_int_array(self, length: int = None) -> List[int]:
return self.read_array_struct("i", length)
def read_u_int_array(self, length: int = None) -> List[int]:
return self.read_array_struct("I", length)
def read_long_array(self, length: int = None) -> List[int]:
return self.read_array_struct("q", length)
def read_u_long_array(self, length: int = None) -> List[int]:
return self.read_array_struct("Q", length)
def read_float_array(self, length: int = None) -> List[float]:
return self.read_array_struct("f", length)
def read_double_array(self, length: int = None) -> List[float]:
return self.read_array_struct("d", length)
def real_offset(self) -> int:
"""Returns offset in the underlying file.
(Not working with unpacked streams.)
"""
return self.BaseOffset + self.Position
def read_the_rest(self, obj_start: int, obj_size: int) -> bytes:
"""Returns the rest of the current reader bytes."""
return self.read_bytes(obj_size - (self.Position - obj_start))
def unpack_array(self, string: str, count: int) -> list:
struct = Struct(f"{self.endian}{string}")
return list(struct.iter_unpack(self.read(count * struct.size)))
class EndianBinaryReader_Memoryview(EndianBinaryReader):
__slots__ = ("view", "_endian", "BaseOffset", "Position", "Length")
view: memoryview
def __init__(self, view, endian=">", offset=0):
self._endian = ""
super().__init__(view, endian=endian, offset=offset)
self.view = memoryview(view)
self.Length = len(view)
@property
def endian(self):
return self._endian
@endian.setter
def endian(self, value):
if value not in ("<", ">"):
raise ValueError("Invalid endian")
if value != self._endian:
for typ, _, _ in TYPE_PARAM_SIZE_LIST:
func_name_e = f"read_{value}_{typ}"
func_name = f"read_{typ}"
setattr(self, func_name, getattr(self, func_name_e))
self._endian = value
@property
def bytes(self):
return self.view
def dispose(self):
self.view.release()
def read(self, length: int):
if not length:
return b""
ret = self.view[self.Position : self.Position + length]
self.Position += length
return ret
def read_aligned_string(self):
length = self.read_int()
if 0 < length <= self.Length - self.Position:
string_data = self.read_bytes(length)
result = bytes(string_data).decode("utf8", "surrogateescape")
self.align_stream()
return result
return ""
def read_string_to_null(self, max_length=32767) -> str:
match = reNot0.search(self.view, self.Position, self.Position + max_length)
if not match:
if self.Position + max_length >= self.Length:
raise Exception("String not terminated")
else:
return bytes(self.read_bytes(max_length)).decode(
"utf8", "surrogateescape"
)
ret = match[1].decode("utf8", "surrogateescape")
self.Position = match.end()
return ret
def create_sub_reader(self, offset: int, length: int) -> EndianBinaryReader:
return EndianBinaryReader_Memoryview(
self.view, self.endian, self.BaseOffset + offset
)
class EndianBinaryReader_Streamable(EndianBinaryReader):
__slots__ = ("stream", "_endian", "BaseOffset")
stream: BinaryIO
def __init__(self, stream, endian=">", offset=0):
self._endian = ""
self.stream = stream
super().__init__(stream, endian=endian, offset=offset)
self.read = self.stream.read
def get_position(self):
return self.stream.tell()
def set_position(self, value):
self.stream.seek(value + self.BaseOffset)
@property
def endian(self):
return self._endian
@endian.setter
def endian(self, value):
if value not in ("<", ">"):
raise ValueError("Invalid endian")
if value != self._endian:
for typ, _, _ in TYPE_PARAM_SIZE_LIST:
func_name_e = f"read_{value}_{typ}"
func_name = f"read_{typ}"
setattr(self, func_name, getattr(self, func_name_e))
self._endian = value
@property
def Length(self):
pos = self.Position
length = self.stream.seek(0, 2) - self.BaseOffset
self.Position = pos
return length
Position = property(get_position, set_position)
@property
def bytes(self):
last_pos = self.Position
self.Position = 0
ret = self.read(self.Length)
self.Position = last_pos
return ret
def dispose(self):
self.stream.close()
pass
def create_sub_reader(self, offset: int, length: int) -> EndianBinaryReader:
return EndianBinaryReader_Streamable(self.stream, self.endian, offset)
# generate endianed functions
for endian_s in Endianess.__args__:
for typ, param, _ in TYPE_PARAM_SIZE_LIST:
def generate_funcs():
func_name = f"read_{endian_s}_{typ}"
struct = Struct(f"{endian_s}{param}")
def mv_func(self: EndianBinaryReader_Memoryview):
value = struct.unpack_from(self.view, self.Position)[0]
self.Position += struct.size
return value
def st_func(self: EndianBinaryReader_Streamable):
return struct.unpack(self.stream)[0]
setattr(EndianBinaryReader_Memoryview, func_name, mv_func)
setattr(EndianBinaryReader_Streamable, func_name, st_func)
generate_funcs()