Refactored BitStream into read-only and write-only versions.

captureviewer.pyw

@@ -18,7 +18,7 @@ import amf3
 import viewer
 import ldf
 from structparser import StructParser
-from pyraknet.bitstream import BitStream, c_bit, c_bool, c_float, c_int, c_int64, c_ubyte, c_uint, c_uint64, c_ushort
+from pyraknet.bitstream import c_bit, c_bool, c_float, c_int, c_int64, c_ubyte, c_uint, c_uint64, c_ushort, ReadStream
 
 component_name = OrderedDict()
 component_name[108] = "Component 108",
@@ -202,28 +202,28 @@ class CaptureViewer(viewer.Viewer):
 					print("Parsing creations")
 					creations = [i for i in files if "[24]" in i]
 					for packet_name in creations:
-						packet = BitStream(capture.read(packet_name))
+						packet = ReadStream(capture.read(packet_name))
 						self.parse_creation(packet_name, packet)
 
 				if self.parse_serializations.get():
 					print("Parsing serializations")
 					serializations = [i for i in files if "[27]" in i]
 					for packet_name in serializations:
-						packet = BitStream(capture.read(packet_name)[1:])
+						packet = ReadStream(capture.read(packet_name)[1:])
 						self.parse_serialization_packet(packet_name, packet)
 
 				if self.parse_game_messages.get():
 					print("Parsing game messages")
 					game_messages = [i for i in files if "[53-05-00-0c]" in i or "[53-04-00-05]" in i]
 					for packet_name in game_messages:
-						packet = BitStream(capture.read(packet_name)[8:])
+						packet = ReadStream(capture.read(packet_name)[8:])
 						self.parse_game_message(packet_name, packet)
 
 				if self.parse_normal_packets.get():
 					print("Parsing normal packets")
 					packets = [i for i in files if "[24]" not in i and "[27]" not in i and "[53-05-00-0c]" not in i and "[53-04-00-05]" not in i]
 					for packet_name in packets:
-						packet = BitStream(capture.read(packet_name))
+						packet = ReadStream(capture.read(packet_name))
 						self.parse_normal_packet(packet_name, packet)
 
 	def object_id_handler(self, stream):
@@ -254,7 +254,7 @@ class CaptureViewer(viewer.Viewer):
 			assert len(uncompressed) == uncompressed_size
 		else:
 			uncompressed = stream.read(bytes, length=size)
-		return ldf.from_ldf(BitStream(uncompressed))
+		return ldf.from_ldf(ReadStream(uncompressed))
 
 	def parse_creation(self, packet_name, packet, retry_with_components=[]):
 		packet.skip_read(1)
@@ -294,7 +294,7 @@ class CaptureViewer(viewer.Viewer):
 		else:
 			lot_name, parsers, error = self.lot_data[lot]
 		id_ = packet.read(str, length_type=c_ubyte) + " " + lot_name
-		packet._read_offset = 0
+		packet.read_offset = 0
 		parser_output = ParserOutput()
 		with parser_output:
 			parser_output.append(self.creation_header_parser.parse(packet))
@@ -319,7 +319,7 @@ class CaptureViewer(viewer.Viewer):
 					if retry_with_components:
 						print("retrying with", retry_with_components, packet_name)
 						del self.lot_data[lot]
-						packet._read_offset = 0
+						packet.read_offset = 0
 						self.parse_creation(packet_name, packet, retry_with_components)
 						return
 
@@ -333,7 +333,7 @@ class CaptureViewer(viewer.Viewer):
 			parser_output.text += "\n"+name+"\n\n"
 			parser_output.append(parser.parse(packet, {"creation":is_creation}))
 		if not packet.all_read():
-			raise IndexError("Not completely read, %i bytes unread" % (len(packet) - math.ceil(packet._read_offset / 8)))
+			raise IndexError("Not completely read, %i bytes unread" % (len(packet) - math.ceil(packet.read_offset / 8)))
 
 	def parse_serialization_packet(self, packet_name, packet):
 		network_id = packet.read(c_ushort)

ldf.py

@@ -1,8 +1,8 @@
-from pyraknet.bitstream import BitStream, c_bool, c_float, c_int, c_int64, c_ubyte, c_uint
+from pyraknet.bitstream import c_bool, c_float, c_int, c_int64, c_ubyte, c_uint, ReadStream
 
 def from_ldf(ldf):
 	ldf_dict = {}
-	if isinstance(ldf, BitStream):
+	if isinstance(ldf, ReadStream):
 		for _ in range(ldf.read(c_uint)):
 			encoded_key = ldf.read(bytes, length=ldf.read(c_ubyte))
 			key = encoded_key.decode("utf-16-le")

luzviewer.pyw

@@ -9,7 +9,7 @@ import tkinter.messagebox as messagebox
 from tkinter import END, Menu
 
 import viewer
-from pyraknet.bitstream import BitStream, c_bool, c_float, c_int, c_int64, c_ubyte, c_uint, c_uint64, c_ushort
+from pyraknet.bitstream import c_bool, c_float, c_int, c_int64, c_ubyte, c_uint, c_uint64, c_ushort, ReadStream
 
 class PathType(enum.IntEnum):
 	Movement = 0
@@ -53,7 +53,7 @@ class LUZViewer(viewer.Viewer):
 		self.tree.set_children("")
 		print("Loading", luz_path)
 		with open(luz_path, "rb") as file:
-			stream = BitStream(file.read())
+			stream = ReadStream(file.read())
 
 		version = stream.read(c_uint)
 		assert version in (36, 38, 39, 40, 41), version
@@ -85,7 +85,7 @@ class LUZViewer(viewer.Viewer):
 				with open(lvl_path, "rb") as lvl:
 					print("Loading lvl", filename)
 					try:
-						self.parse_lvl(BitStream(lvl.read()), scene)
+						self.parse_lvl(ReadStream(lvl.read()), scene)
 					except Exception:
 						import traceback
 						traceback.print_exc()
@@ -115,7 +115,7 @@ class LUZViewer(viewer.Viewer):
 				self.tree.insert(scene_transition, END, text="Transition Point", values=(transition_point_scene_id, transition_point_position))
 
 		remaining_length = stream.read(c_uint)
-		assert len(stream) - stream._read_offset//8 == remaining_length
+		assert len(stream) - stream.read_offset//8 == remaining_length
 		assert stream.read(c_uint) == 1
 
 		### paths
@@ -231,16 +231,16 @@ class LUZViewer(viewer.Viewer):
 			# newer lvl file structure
 			# chunk based
 			while not stream.all_read():
-				assert stream._read_offset//8 % 16 == 0 # seems everything is aligned like this?
-				start_pos = stream._read_offset//8
+				assert stream.read_offset//8 % 16 == 0 # seems everything is aligned like this?
+				start_pos = stream.read_offset//8
 				assert stream.read(bytes, length=4) == b"CHNK"
 				chunk_type = stream.read(c_uint)
 				assert stream.read(c_ushort) == 1
 				assert stream.read(c_ushort) in (1, 2)
 				chunk_length = stream.read(c_uint)
 				data_pos = stream.read(c_uint)
-				stream._read_offset = data_pos * 8
-				assert stream._read_offset//8 % 16 == 0
+				stream.read_offset = data_pos * 8
+				assert stream.read_offset//8 % 16 == 0
 				if chunk_type == 1000:
 					pass
 				elif chunk_type == 2000:
@@ -249,7 +249,7 @@ class LUZViewer(viewer.Viewer):
 					self.lvl_parse_chunk_type_2001(stream, scene)
 				elif chunk_type == 2002:
 					pass
-				stream._read_offset = (start_pos + chunk_length) * 8 # go to the next CHNK
+				stream.read_offset = (start_pos + chunk_length) * 8 # go to the next CHNK
 		else:
 			self.parse_old_lvl_header(stream)
 			self.lvl_parse_chunk_type_2001(stream, scene)

pkviewer.pyw

@@ -10,7 +10,7 @@ from tkinter.ttk import Entry, Scrollbar, Treeview
 
 import decompress_sd0
 import viewer
-from pyraknet.bitstream import BitStream, c_bool, c_int, c_ubyte, c_uint
+from pyraknet.bitstream import c_bool, c_int, c_ubyte, c_uint, ReadStream
 
 class PKViewer(viewer.Viewer):
 	def __init__(self):
@@ -79,7 +79,7 @@ class PKViewer(viewer.Viewer):
 	def load_pki(self, path):
 		# unused, alternate way to get the list of pks
 		with open(path, "rb") as file:
-			stream = BitStream(file.read())
+			stream = ReadStream(file.read())
 
 		assert stream.read(c_uint) == 3
 		pack_files = []
@@ -101,7 +101,7 @@ class PKViewer(viewer.Viewer):
 			if unknown != 0:
 				print(unknown, path)
 			file.seek(number_of_records_address)
-			data = BitStream(file.read()[:-8])
+			data = ReadStream(file.read()[:-8])
 
 		number_of_records = data.read(c_uint)
 		for _ in range(number_of_records):

structparser.py

@@ -5,7 +5,7 @@ import argparse
 import re
 from collections import namedtuple
 
-from pyraknet.bitstream import BitStream, c_bit, c_float, c_double, c_int8, c_uint8, c_int16, c_uint16, c_int32, c_uint32, c_int64, c_uint64
+from pyraknet.bitstream import c_bit, c_float, c_double, c_int8, c_uint8, c_int16, c_uint16, c_int32, c_uint32, c_int64, c_uint64, ReadStream
 
 VAR_CHARS = r"[^ \t\[\]]+"
 
@@ -88,10 +88,10 @@ class StructParser:
 		if variables is None:
 			variables = {}
 		self._variables = variables
-		if isinstance(data, BitStream):
+		if isinstance(data, ReadStream):
 			stream = data
 		else:
-			stream = BitStream(data)
+			stream = ReadStream(data)
 		yield from self._parse_struct_occurrences(stream, self.defs)
 
 	def _to_tree(self, def_iter, stack_level=0, start_def=None):