ReverseBox 0.19.2__tar.gz → 0.19.4__tar.gz

{reversebox-0.19.2 → reversebox-0.19.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ReverseBox
-Version: 0.19.2
+Version: 0.19.4
 Summary: A set of functions useful in reverse engineering.
 Home-page: https://github.com/bartlomiejduda/ReverseBox
 Author: Bartlomiej Duda
@@ -229,9 +229,9 @@ or software researchers).
   - PS2 Palette Swizzling/Twiddling ✔️
   - PS4 Swizzling/Twiddling ✔️
   - PSP Swizzling/Twiddling ✔️
+  - PS Vita Swizzling/Twiddling ✔️
   - XBOX 360 Swizzling/Twiddling ✔️
   - GameCube/WII Swizzling/Twiddling ✔️
-  - PSVITA Swizzling/Twiddling ✔️
   - Switch Swizzling/Twiddling ✔️
   - XBOX/PS3 Swizzling/Twiddling (Morton Order) ✔️
   - Dreamcast Swizzling/Twiddling (Morton Order) ✔️
@@ -367,3 +367,6 @@ Check out list of tools written using ReverseBox:
 - [TPL Parser](https://github.com/bartlomiejduda/Tools/tree/master/NEW%20Tools/Mario%20Kart%20WII/TPL%20Parser)
 - [ImageHeat](https://github.com/bartlomiejduda/ImageHeat)
 - and more...
+
+# Badges
+![PyPI Downloads](https://static.pepy.tech/badge/reversebox)

{reversebox-0.19.2 → reversebox-0.19.4}/README.md

@@ -194,9 +194,9 @@ or software researchers).
   - PS2 Palette Swizzling/Twiddling ✔️
   - PS4 Swizzling/Twiddling ✔️
   - PSP Swizzling/Twiddling ✔️
+  - PS Vita Swizzling/Twiddling ✔️
   - XBOX 360 Swizzling/Twiddling ✔️
   - GameCube/WII Swizzling/Twiddling ✔️
-  - PSVITA Swizzling/Twiddling ✔️
   - Switch Swizzling/Twiddling ✔️
   - XBOX/PS3 Swizzling/Twiddling (Morton Order) ✔️
   - Dreamcast Swizzling/Twiddling (Morton Order) ✔️
@@ -332,3 +332,6 @@ Check out list of tools written using ReverseBox:
 - [TPL Parser](https://github.com/bartlomiejduda/Tools/tree/master/NEW%20Tools/Mario%20Kart%20WII/TPL%20Parser)
 - [ImageHeat](https://github.com/bartlomiejduda/ImageHeat)
 - and more...
+
+# Badges
+![PyPI Downloads](https://static.pepy.tech/badge/reversebox)

{reversebox-0.19.2 → reversebox-0.19.4}/ReverseBox.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ReverseBox
-Version: 0.19.2
+Version: 0.19.4
 Summary: A set of functions useful in reverse engineering.
 Home-page: https://github.com/bartlomiejduda/ReverseBox
 Author: Bartlomiej Duda
@@ -229,9 +229,9 @@ or software researchers).
   - PS2 Palette Swizzling/Twiddling ✔️
   - PS4 Swizzling/Twiddling ✔️
   - PSP Swizzling/Twiddling ✔️
+  - PS Vita Swizzling/Twiddling ✔️
   - XBOX 360 Swizzling/Twiddling ✔️
   - GameCube/WII Swizzling/Twiddling ✔️
-  - PSVITA Swizzling/Twiddling ✔️
   - Switch Swizzling/Twiddling ✔️
   - XBOX/PS3 Swizzling/Twiddling (Morton Order) ✔️
   - Dreamcast Swizzling/Twiddling (Morton Order) ✔️
@@ -367,3 +367,6 @@ Check out list of tools written using ReverseBox:
 - [TPL Parser](https://github.com/bartlomiejduda/Tools/tree/master/NEW%20Tools/Mario%20Kart%20WII/TPL%20Parser)
 - [ImageHeat](https://github.com/bartlomiejduda/ImageHeat)
 - and more...
+
+# Badges
+![PyPI Downloads](https://static.pepy.tech/badge/reversebox)

{reversebox-0.19.2 → reversebox-0.19.4}/ReverseBox.egg-info/SOURCES.txt

@@ -78,11 +78,10 @@ reversebox/image/swizzling/swizzle_cmpr.py
 reversebox/image/swizzling/swizzle_gamecube.py
 reversebox/image/swizzling/swizzle_gst.py
 reversebox/image/swizzling/swizzle_morton.py
-reversebox/image/swizzling/swizzle_morton_dreamcast.py
 reversebox/image/swizzling/swizzle_morton_ps4.py
 reversebox/image/swizzling/swizzle_ps2.py
 reversebox/image/swizzling/swizzle_psp.py
-reversebox/image/swizzling/swizzle_psvita.py
+reversebox/image/swizzling/swizzle_psvita_dreamcast.py
 reversebox/image/swizzling/swizzle_switch.py
 reversebox/image/swizzling/swizzle_x360.py
 reversebox/io_files/__init__.py

{reversebox-0.19.2 → reversebox-0.19.4}/reversebox/image/common.py

@@ -73,7 +73,7 @@ def get_bpp_for_image_format(image_format: ImageFormats) -> int:
     if image_format in (ImageFormats.RGB121,
                         ImageFormats.N64_CMPR,
                         ImageFormats.N64_I4,
-                        ImageFormats.DXT1) or "pal4" in image_format.value.lower():
+                        ImageFormats.BC1_DXT1) or "pal4" in image_format.value.lower():
         return 4
     elif image_format in (ImageFormats.RGBX2222,
                           ImageFormats.RGBA2222,
@@ -83,8 +83,8 @@ def get_bpp_for_image_format(image_format: ImageFormats) -> int:
                           ImageFormats.GRAY8,
                           ImageFormats.N64_I8,
                           ImageFormats.N64_IA4,
-                          ImageFormats.DXT3,
-                          ImageFormats.DXT5) or "pal8" in image_format.value.lower():
+                          ImageFormats.BC2_DXT3,
+                          ImageFormats.BC3_DXT5) or "pal8" in image_format.value.lower():
         return 8
     elif image_format in (ImageFormats.GRAY8A,
                           ImageFormats.GRAY16,

{reversebox-0.19.2 → reversebox-0.19.4}/reversebox/image/image_decoder.py

@@ -243,13 +243,13 @@ class ImageDecoder:
 
     def _decode_bgrx8888_pixel(self, pixel_int: int) -> bytes:
         p = bytearray(4)
-        p[0] = (pixel_int >> 8) & 0xff
-        p[1] = (pixel_int >> 16) & 0xff
-        p[2] = (pixel_int >> 24) & 0xff
+        p[0] = (pixel_int >> 16) & 0xFF
+        p[1] = (pixel_int >> 8) & 0xFF
+        p[2] = (pixel_int >> 0) & 0xFF
         p[3] = 0xFF
         return p
 
-    def _decode_bgra8888_pixel(self, pixel_int: int) -> bytes:
+    def _decode_bgra8888_pixel(self, pixel_int: int) -> bytes:  # TODO - fix this?
         p = bytearray(4)
         p[0] = (pixel_int >> 16) & 0xff
         p[1] = (pixel_int >> 8) & 0xff
@@ -275,13 +275,9 @@ class ImageDecoder:
 
     def _decode_xrgb8888_pixel(self, pixel_int: int) -> bytes:
         p = bytearray(4)
-        R = (pixel_int >> 16) & 0xFF
-        G = (pixel_int >> 8) & 0xFF
-        B = pixel_int & 0xFF
-
-        p[0] = R
-        p[1] = G
-        p[2] = B
+        p[0] = (pixel_int >> 8) & 0xff
+        p[1] = (pixel_int >> 16) & 0xff
+        p[2] = (pixel_int >> 24) & 0xff
         p[3] = 0xFF
         return p
 
@@ -534,9 +530,9 @@ class ImageDecoder:
 
     compressed_data_formats = {
         # image format: (decoder_name, decoder_arg)
-        ImageFormats.DXT1: ("bcn", 1),
-        ImageFormats.DXT3: ("bcn", 2),
-        ImageFormats.DXT5: ("bcn", 3)
+        ImageFormats.BC1_DXT1: ("bcn", 1),
+        ImageFormats.BC2_DXT3: ("bcn", 2),
+        ImageFormats.BC3_DXT5: ("bcn", 3)
     }
 
     gst_data_formats = {

{reversebox-0.19.2 → reversebox-0.19.4}/reversebox/image/image_formats.py

@@ -50,14 +50,14 @@ class ImageFormats(Enum):
     BGR888 = "bgr888"  # PIX_FMT_BGR24  / packed RGB 8:8:8, 24bpp, BGRBGR
 
     # 32-bit
-    RGBA8888 = "rgba8888"  # PIX_FMT_RGBA / packed RGBA 8:8:8:8, 32bpp, RGBARGBA
-    BGRA8888 = "bgra8888"  # PIX_FMT_BGRA / packed BGRA 8:8:8:8, 32bpp, BGRABGRA
+    RGBA8888 = "rgba8888"  # PIX_FMT_RGBA / packed RGBA 8:8:8:8, 32bpp, RGBARGBA  (R8G8B8A8_UNORM)
+    BGRA8888 = "bgra8888"  # PIX_FMT_BGRA / packed BGRA 8:8:8:8, 32bpp, BGRABGRA  (B8G8R8A8_UNORM)
     ARGB8888 = "argb8888"  # PIX_FMT_ARGB / packed ARGB 8:8:8:8, 32bpp, ARGBARGB
     ABGR8888 = "abgr8888"  # PIX_FMT_ABGR / packed ABGR 8:8:8:8, 32bpp, ABGRABGR
     XRGB8888 = "xrgb8888"  # PIX_FMT_0RGB / packed RGB 8:8:8, 32bpp, 0RGB0RGB...
     RGBX8888 = "rgbx8888"  # PIX_FMT_RGB0 / packed RGB 8:8:8, 32bpp, RGB0RGB0...
     XBGR8888 = "xbgr8888"  # PIX_FMT_0BGR / packed BGR 8:8:8, 32bpp, 0BGR0BGR...
-    BGRX8888 = "bgrx8888"  # PIX_FMT_BGR0 / packed BGR 8:8:8, 32bpp, BGR0BGR0...
+    BGRX8888 = "bgrx8888"  # PIX_FMT_BGR0 / packed BGR 8:8:8, 32bpp, BGR0BGR0...  (B8G8R8X8_UNORM)
 
     # 48-bit
     RGB48 = "rgb48"  # PIX_FMT_RGB48LE / PIX_FMT_RGB48BE / packed RGB 16:16:16, 48bpp, 16R, 16G, 16B
@@ -108,10 +108,12 @@ class ImageFormats(Enum):
     N64_IA4 = "n64_ia4"  # GRAY+ALPHA, 8bpp
     N64_IA8 = "n64_ia8"  # GRAY+ALPHA, 16bpp
 
-    # DXT Formats
-    DXT1 = "dxt1"  # BC1
-    DXT3 = "dxt3"  # BC2
-    DXT5 = "dxt5"  # BC3
+    # compressed Formats
+    BC1_DXT1 = "bc1_dxt1"
+    # BC2_DXT2 = "bc2_dxt2"  # TODO - implement this
+    BC2_DXT3 = "bc2_dxt3"
+    # BC3_DXT4 = "bc3_dxt4"  # TODO - implement this
+    BC3_DXT5 = "bc3_dxt5"
 
     # PS2 GS Texture Formats
     GST121 = "gst121"

reversebox-0.19.2/reversebox/image/swizzling/swizzle_psvita.py → reversebox-0.19.4/reversebox/image/swizzling/swizzle_psvita_dreamcast.py

@@ -5,6 +5,17 @@ License: GPL-3.0 License
 
 # fmt: off
 
+# Morton Order Texture Swizzling (+ rotated by 90 degrees for console's CPU)
+# https://en.wikipedia.org/wiki/Z-order_curve
+# https://dreamcast.wiki/Twiddling
+
+# Same algorithm is used in Dreamcast and PS Vita consoles
+# I've seen it used in Dreamcast DTEX files and in PS Vita GXT files
+# example games:
+# - Danganronpa: Trigger Happy Havoc (PS Vita) (*.GXT)
+# - Danganronpa 2: Goodbye Despair (PS Vita) (*.GXT)
+# - Senran Kagura: Shinovi Versus (PS Vita) (*.GXT)
+
 
 def bsr(x: int) -> int:
     """bit scan reverse"""
@@ -23,7 +34,7 @@ def align(value: int, alignment: int) -> int:
     return (value + (alignment - 1)) & ~(alignment - 1)
 
 
-def get_morton_index_psvita(x: int, y: int, width: int, height: int) -> int:
+def get_morton_index_psvita_dreamcast(x: int, y: int, width: int, height: int) -> int:
     logW = bsr(width)
     logH = bsr(height)
     d = min(logW, logH)
@@ -40,10 +51,10 @@ def get_morton_index_psvita(x: int, y: int, width: int, height: int) -> int:
     return index
 
 
-def _convert_psvita_4bpp(pixel_data: bytes, img_width: int, img_height: int, swizzle_flag: bool) -> bytes:
+def _convert_psvita_dreamcast_4bpp(pixel_data: bytes, img_width: int, img_height: int, swizzle_flag: bool) -> bytes:
     converted_data: bytearray = bytearray(len(pixel_data))
-    mx = get_morton_index_psvita(img_width - 1, 0, img_width, img_height)
-    my = get_morton_index_psvita(0, img_height - 1, img_width, img_height)
+    mx = get_morton_index_psvita_dreamcast(img_width - 1, 0, img_width, img_height)
+    my = get_morton_index_psvita_dreamcast(0, img_height - 1, img_width, img_height)
 
     line_stride = align(img_width, 2)
 
@@ -73,13 +84,13 @@ def _convert_psvita_4bpp(pixel_data: bytes, img_width: int, img_height: int, swi
     return converted_data
 
 
-def _convert_psvita(pixel_data: bytes, img_width: int, img_height: int, bpp: int, swizzle_flag: bool) -> bytes:
+def _convert_psvita_dreamcast(pixel_data: bytes, img_width: int, img_height: int, bpp: int, swizzle_flag: bool) -> bytes:
     converted_data: bytearray = bytearray(len(pixel_data))
     width_pow2 = enclosing_power_of_2(img_width)
     height_pow2 = enclosing_power_of_2(img_height)
 
-    mx = get_morton_index_psvita(width_pow2 - 1, 0, width_pow2, height_pow2)
-    my = get_morton_index_psvita(0, height_pow2 - 1, width_pow2, height_pow2)
+    mx = get_morton_index_psvita_dreamcast(width_pow2 - 1, 0, width_pow2, height_pow2)
+    my = get_morton_index_psvita_dreamcast(0, height_pow2 - 1, width_pow2, height_pow2)
 
     pixel_size = bpp // 8
 
@@ -100,13 +111,13 @@ def _convert_psvita(pixel_data: bytes, img_width: int, img_height: int, bpp: int
     return converted_data
 
 
-def unswizzle_psvita(pixel_data: bytes, img_width: int, img_height: int, bpp: int) -> bytes:
+def unswizzle_psvita_dreamcast(pixel_data: bytes, img_width: int, img_height: int, bpp: int) -> bytes:
     if bpp == 4:
-        return _convert_psvita_4bpp(pixel_data, img_width, img_height, False)
-    return _convert_psvita(pixel_data, img_width, img_height, bpp, False)
+        return _convert_psvita_dreamcast_4bpp(pixel_data, img_width, img_height, False)
+    return _convert_psvita_dreamcast(pixel_data, img_width, img_height, bpp, False)
 
 
-def swizzle_psvita(pixel_data: bytes, img_width: int, img_height: int, bpp: int) -> bytes:
+def swizzle_psvita_dreamcast(pixel_data: bytes, img_width: int, img_height: int, bpp: int) -> bytes:
     if bpp == 4:
-        return _convert_psvita_4bpp(pixel_data, img_width, img_height, True)
-    return _convert_psvita(pixel_data, img_width, img_height, bpp, True)
+        return _convert_psvita_dreamcast_4bpp(pixel_data, img_width, img_height, True)
+    return _convert_psvita_dreamcast(pixel_data, img_width, img_height, bpp, True)

{reversebox-0.19.2 → reversebox-0.19.4}/setup.py

@@ -7,7 +7,7 @@ import os
 
 import setuptools
 
-VERSION_NUM = "0.19.2"
+VERSION_NUM = "0.19.4"
 
 
 def get_long_description() -> str:

reversebox-0.19.2/reversebox/image/swizzling/swizzle_morton_dreamcast.py

@@ -1,90 +0,0 @@
-"""
-Copyright © 2024  Bartłomiej Duda
-License: GPL-3.0 License
-"""
-
-from reversebox.image.common import convert_bpp_to_bytes_per_pixel
-
-# Morton Order Texture Swizzling (+ rotated by 90 degrees for Dreamcast CPU)
-# https://en.wikipedia.org/wiki/Z-order_curve
-# https://dreamcast.wiki/Twiddling
-# Used in Dreamcast games
-
-# fmt: off
-
-
-def calculate_morton_index_dreamcast(p: int, w: int, h: int) -> int:
-    ddx = 1
-    ddy = w
-    q = 0
-
-    for i in range(16):
-        h >>= 1
-        if h:
-            if p & 1:
-                q |= ddy
-            p >>= 1
-        ddy <<= 1
-        if w >> 1:
-            if p & 1:
-                q |= ddx
-            p >>= 1
-        ddx <<= 1
-
-    return q
-
-
-def _convert_morton_dreamcast(image_data: bytes, img_width: int, img_height: int, bpp: int, swizzle_flag: bool) -> bytes:
-    converted_data = bytearray(len(image_data))
-    bytes_per_pixel: int = convert_bpp_to_bytes_per_pixel(bpp)
-    source_index: int = 0
-
-    for t in range(img_width * img_height):
-        index = calculate_morton_index_dreamcast(t, img_width, img_height)
-        destination_index = bytes_per_pixel * index
-
-        if not swizzle_flag:
-            converted_data[destination_index: destination_index + bytes_per_pixel] = image_data[source_index: source_index + bytes_per_pixel]
-        else:
-            converted_data[source_index: source_index + bytes_per_pixel] = image_data[destination_index: destination_index + bytes_per_pixel]
-        source_index += bytes_per_pixel
-
-    return converted_data
-
-
-def _convert_morton_dreamcast_4bit(input_buffer: bytes, width: int, height: int, bpp: int, swizzle_flag: bool) -> bytes:
-    converted_data: bytearray = bytearray(len(input_buffer))
-    input_pixels_8bpp = bytearray(width * height)
-    buffer_byte_size = (width * height + 1) // 2
-
-    # unpack 4bpp pixels to 8bpp
-    for i in range(buffer_byte_size):
-        byte_value = input_buffer[i]
-        nybble_low = byte_value & 0xF
-        nybble_high = byte_value >> 4
-        input_pixels_8bpp[i * 2] = nybble_low
-        input_pixels_8bpp[i * 2 + 1] = nybble_high
-
-    # swizzle/unswizzle for 8bpp
-    output_pixels_8bpp = _convert_morton_dreamcast(input_pixels_8bpp, width, height, bpp, swizzle_flag)
-
-    # repack 8bpp pixels to 4bpp
-    for i in range(buffer_byte_size):
-        nybble_low = output_pixels_8bpp[i * 2]
-        nybble_high = output_pixels_8bpp[i * 2 + 1]
-        byte_value = (nybble_high << 4) | nybble_low
-        converted_data[i] = byte_value
-
-    return converted_data
-
-
-def unswizzle_morton_dreamcast(image_data: bytes, img_width: int, img_height: int, bpp: int) -> bytes:
-    if bpp == 4:
-        return _convert_morton_dreamcast_4bit(image_data, img_width, img_height, bpp, False)
-    return _convert_morton_dreamcast(image_data, img_width, img_height, bpp, False)
-
-
-def swizzle_morton_dreamcast(image_data: bytes, img_width: int, img_height: int, bpp: int) -> bytes:
-    if bpp == 4:
-        return _convert_morton_dreamcast_4bit(image_data, img_width, img_height, bpp, True)
-    return _convert_morton_dreamcast(image_data, img_width, img_height, bpp, True)