Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ the RNC unpacker work for any console. The interface may change before 1.0.
## Use

```bash
uv add "decompassets @ https://github.com/RetroReversing/decomp-assets/archive/refs/tags/v0.1.0.tar.gz"
uv add "decompassets @ https://github.com/RetroReversing/decomp-assets/archive/refs/tags/v0.2.0.tar.gz"
```

```python
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "decompassets"
version = "0.1.0"
version = "0.2.0"
description = "Find and preview game assets (textures, audio banks, models, fonts) inside cartridge and disc images by their structure, with no per-game offsets."
readme = "README.md"
license = "AGPL-3.0-only"
Expand Down
2 changes: 1 addition & 1 deletion src/decompassets/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
Everything here reads bytes and returns plain dicts. It never writes a game file, runs a tool or downloads.
"""

__version__ = "0.1.0"
__version__ = "0.2.0"
26 changes: 20 additions & 6 deletions src/decompassets/n64/textures.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The source-assisted layout is three indexed blocks: an eight-byte format record,
bitmap frames and palettes. No title, release address or source file is needed at runtime.
A later version of the engine adds a fourth block holding the texture's source file name
("BUSH01.GIF"), NUL-terminated and zero-padded; that name becomes the bank's label.
CI4/CI8, RGBA32 and the fixed six-level RGBA16 mipmap layout are checked separately.
"""
from __future__ import annotations
Expand All @@ -14,7 +16,8 @@
MAX_BANK = 4 * 1024 * 1024
MAX_EXPANDED = 64 * 1024 * 1024
MAX_BLOCKS = 16384
RAW_HEADER = re.compile(rb'\x00\x00\x00\x03\x00\x00\x00\x18')
RAW_HEADER = re.compile(rb'\x00\x00\x00[\x03\x04]\x00\x00\x00\x18')
MAX_NAME = 64


def _blocks(data, start, end, *, empty=False):
Expand All @@ -34,10 +37,19 @@ def _blocks(data, start, end, *, empty=False):
MIP_BYTES = 2744


def _name(data, start, end):
"""The fourth block: printable text, one NUL, then only padding to the eight-byte block size."""
text, nul, rest = data[start:end].partition(b'\0')
if not nul or not 0 < len(text) <= MAX_NAME or any(not 32 <= c < 127 for c in text) or rest.strip(b'\0'):return None
return text.decode('ascii')


def bank_layout(data):
"""Require all independently indexed frames/palettes to fit the format record."""
outer = _blocks(data, 0, len(data))
if not outer or len(outer) != 3 or outer[0] != (24,32):return None
if not outer or len(outer) not in (3,4) or outer[0] != (24,32):return None
name = _name(data, *outer[3]) if len(outer) == 4 else ''
if name is None:return None
fmt, speed, width_shift, height_shift, effect, mode, pad1, pad2 = data[24:32]
if fmt not in (0,1,2,3,4) or not 0 <= width_shift <= 10 or not 0 <= height_shift <= 10:return None
if pad1 or pad2 or mode > 3:return None
Expand Down Expand Up @@ -66,7 +78,7 @@ def bank_layout(data):
for i,(start,end) in enumerate(frames)):return None
settings = dict(format=pixel_format,width=width,height=height,offset=frames[0][0])
if palettes:settings.update(palette_offset=palettes[0][0],palette_format='ia16' if fmt == 3 else 'rgba5551-be')
return dict(preview_settings=settings,frames=len(frames),palettes=len(palettes),
return dict(preview_settings=settings,frames=len(frames),name=name,palettes=len(palettes),
palette_entries=palette_entries,frame_offsets=[start for start,end in frames],palette_offsets=[start for start,end in palettes],
levels=levels,layout='mipmap-rgba16' if fmt == 4 else 'row-major',playback_speed=speed)

Expand Down Expand Up @@ -148,8 +160,10 @@ def regions(image, *, check=lambda: None, progress=lambda _: None):
extent = 18+packed
contained_end = offset+extent
else:
if offset+20 > len(image):continue
extent = int.from_bytes(image[offset+16:offset+20],'big')
if offset+24 > len(image):continue
# The last offset of the outer index is the bank's length.
at = 4+4*int.from_bytes(image[offset:offset+4],'big')
extent = int.from_bytes(image[offset+at:offset+at+4],'big')
if not 32 <= extent <= MAX_BANK or offset+extent > len(image):continue
data = image[offset:offset+extent]
found = bank_layout(data)
Expand All @@ -161,7 +175,7 @@ def regions(image, *, check=lambda: None, progress=lambda _: None):
if 'palette_offset' in settings:settings['palette_offset']+=offset
found['frame_offsets']=[offset+at for at in found['frame_offsets']]
found['palette_offsets']=[offset+at for at in found['palette_offsets']]
results.append(dict(offset=offset,size=extent,kind='image',label='Texture bank',confidence='validated',
results.append(dict(offset=offset,size=extent,kind='image',label=found['name'] or 'Texture bank',confidence='validated',
reason='Source-assisted indexed-set structure: all frame extents match dimensions and all palette extents match the format.'+
(' Both RNC checksums passed.' if compressed else '')+
' Runtime use is not established.',
Expand Down
23 changes: 23 additions & 0 deletions tests/test_native_textures.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,26 @@ def test_ci8_rejects_missing_colours_and_unsupported_palette_extents():
broken=bytearray(raw);broken[offset]=16;assert textures.bank_layout(broken) is None
bad=indexed_set([bytes([0,1,3,3,255,0,0,0]),indexed_set([bytes(64)]),indexed_set([bytes(64)])])
assert textures.bank_layout(bad) is None


def named_bank(name=b'BUSH01.GIF'):
"""A later engine version appends the texture's source file name as a fourth block."""
raw=bank();inner=textures._blocks(raw,0,len(raw))
return indexed_set([raw[a:b] for a,b in inner]+[(name+b'\0').ljust((len(name)+8)//8*8,b'\0')])


@pytest.mark.parametrize('pack',[lambda x:x,literal_block,literal2])
def test_fourth_block_names_the_bank(pack):
payload=pack(named_bank());found=textures.regions(bytes(16)+payload)
assert [asset['label'] for asset in found]==['BUSH01.GIF']
assert found[0]['name']=='BUSH01.GIF' and found[0]['preview_settings']['format']=='ci4'
data=textures.decode(payload)[0] if payload[:3]==b'RNC' else bytes(16)+payload
assert textures.preview(data,found[0],{})['details']['frame']==0
# Three-block banks keep the generic label.
assert [asset['label'] for asset in textures.regions(bank())]==['Texture bank']


@pytest.mark.parametrize('block',[b'\0'*8,b'BUSH\x01.GIF\0\0\0\0\0\0',b'BUSH01.GIF\0\0\0\0\0X',b'NOTERMIN',b'A'*72+b'\0'*8])
def test_fourth_block_that_is_not_a_name_is_not_a_bank(block):
raw=bank();inner=textures._blocks(raw,0,len(raw))
assert textures.bank_layout(indexed_set([raw[a:b] for a,b in inner]+[block])) is None
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading