Integrate Crunch64 for decompression

.gitignore

@@ -3,7 +3,6 @@ venv/
 .vscode/
 __pycache__/
 .mypy_cache/
-util/n64/Yay0decompress
 *.ld
 *.n64
 *.yaml

CHANGELOG.md

@@ -1,5 +1,11 @@
 # splat Release Notes
 
+### 0.20.1
+
+* splat now uses [crunch64](https://github.com/decompals/crunch64) as a dependency for handling decompression of various formats, starting with Yay0 and MIO0
+* Changed compression_type (and thus file extension) for the Mio0 segment to "MIO0" from "Mio0", accurately reflecting its true name
+* Removed utility cli Yay0decompress.py and Mio0decompress.py scripts; see crunch64-cli for a much more performant (de)compression CLI tool
+
 ### 0.20.0
 
 * Add a pad segment that advances the linker script instead of dumping a binary / generating an assembly file.

requirements.txt

@@ -8,3 +8,4 @@ spimdisasm>=1.18.0
 rabbitizer>=1.8.0
 pygfxd
 n64img>=0.1.4
+crunch64>=0.2.0

segtypes/common/decompressor.py

@@ -1,19 +1,10 @@
-from typing import Optional, Any
-
 from util import log, options
-from util.n64.decompressor import Decompressor
 
 from segtypes.n64.segment import N64Segment
 
 
 class CommonSegDecompressor(N64Segment):
-    decompressor: Decompressor
-    compression_type = ""  # "Mio0" -> filename.Mio0.o
-
     def split(self, rom_bytes):
-        if self.decompressor is None:
-            log.error("Decompressor is not a standalone segment type")
-
         out_dir = options.opts.asset_path / self.dir
         out_dir.mkdir(parents=True, exist_ok=True)
 
@@ -29,7 +20,7 @@ def split(self, rom_bytes):
 
             self.log(f"Decompressing {self.name}")
             compressed_bytes = rom_bytes[self.rom_start : self.rom_end]
-            decompressed_bytes = self.decompressor.decompress(compressed_bytes)
+            decompressed_bytes = self.decompress(compressed_bytes)
             f.write(decompressed_bytes)
         self.log(f"Wrote {self.name} to {out_path}")
 
@@ -42,9 +33,20 @@ def get_linker_entries(self):
                 [options.opts.asset_path / self.dir / f"{self.name}.bin"],
                 options.opts.asset_path
                 / self.dir
-                / f"{self.name}.{self.compression_type}",
+                / f"{self.name}.{self.compression_type}",  # "Mio0" -> filename.Mio0.o
                 self.get_linker_section_order(),
                 self.get_linker_section_linksection(),
                 self.is_noload(),
             )
         ]
+
+    @property
+    def compression_type(self) -> str:
+        log.error(
+            f"Segment {self.__class__.__name__} needs to define a compression type"
+        )
+
+    def decompress(self, compressed_bytes: bytes) -> bytes:
+        log.error(
+            f"Segment {self.__class__.__name__} needs to define a decompression method"
+        )

segtypes/gc/rarc.py

@@ -1,14 +1,13 @@
 import struct
 from enum import IntEnum
 from pathlib import Path
-
 from typing import List, Optional
 
-from util import options
-from util.gc.gcutil import read_string_from_bytes
-from util.n64.Yay0decompress import Yay0Decompressor
+import crunch64
 
 from segtypes.gc.segment import GCSegment
+from util import options
+from util.gc.gcutil import read_string_from_bytes
 
 
 # Represents the RARC archive format used by first-party Nintendo games.
@@ -56,7 +55,7 @@ def try_decompress_archive(self, file_bytes):
         # Yay0
         elif compression_scheme == 0x59617930:
             self.compression = "yay0"
-            return Yay0Decompressor.decompress(file_bytes)
+            return crunch64.yay0.decompress(file_bytes)
         # Not compressed!
         else:
             return file_bytes

segtypes/n64/mio0.py

@@ -1,10 +1,15 @@
-from util.n64.Mio0decompress import Mio0Decompressor
+import crunch64
 
 from segtypes.common.decompressor import CommonSegDecompressor
 
 
 class N64SegMio0(CommonSegDecompressor):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.decompressor = Mio0Decompressor()
-        self.compression_type = "Mio0"
+
+    @property
+    def compression_type(self):
+        return "MIO0"
+
+    def decompress(self, compressed_bytes: bytes) -> bytes:
+        return crunch64.mio0.decompress(compressed_bytes)

segtypes/n64/yay0.py

@@ -1,10 +1,15 @@
-from util.n64.Yay0decompress import Yay0Decompressor
+import crunch64
 
 from segtypes.common.decompressor import CommonSegDecompressor
 
 
 class N64SegYay0(CommonSegDecompressor):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.decompressor = Yay0Decompressor()
-        self.compression_type = "Yay0"
+
+    @property
+    def compression_type(self):
+        return "Yay0"
+
+    def decompress(self, compressed_bytes: bytes) -> bytes:
+        return crunch64.yay0.decompress(compressed_bytes)

split.py

@@ -24,7 +24,7 @@
 from segtypes.segment import Segment
 from util import log, options, palettes, symbols, relocs
 
-VERSION = "0.20.0"
+VERSION = "0.20.1"
 
 parser = argparse.ArgumentParser(
     description="Split a rom given a rom, a config, and output directory"