desmack 0.3.0

Extracts the assets of a SMK ROM (SNES)
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

use anyhow::{Context, bail};

/// Unpacks one compressed stream, stopping at its `0xFF` end byte. A copy from outside the output
/// reads whatever RAM held in the game, so those bytes come out as 0; Bowser Castle's road tiles
/// copy 2 such bytes, into a tile no course uses.
pub fn decompress(src: &[u8]) -> anyhow::Result<Vec<u8>> {
	let mut input = src.iter().copied();
	let mut next = || input.next().context("compressed stream ends early");
	let mut out: Vec<u8> = Vec::new();
	loop {
		let v = next()?;
		if v == 0xFF {
			return Ok(out);
		}
		let (command, count) = if v >> 5 == 7 {
			(
				(v >> 2) & 7,
				(usize::from(v & 3) << 8 | usize::from(next()?)) + 1,
			)
		} else {
			(v >> 5, usize::from(v & 0x1F) + 1)
		};
		match command {
			0 => {
				for _ in 0..count {
					out.push(next()?);
				}
			}
			1 => {
				let b = next()?;
				out.extend(std::iter::repeat_n(b, count));
			}
			2 => {
				let pair = [next()?, next()?];
				out.extend((0..count).map(|i| pair[i % 2]));
			}
			3 => {
				let b = next()?;
				out.extend((0..count).map(|i| b.wrapping_add(i as u8)));
			}
			4..=6 => {
				let (base, back) = match command {
					6 => (out.len(), usize::from(next()?)),
					_ => (usize::from(u16::from_le_bytes([next()?, next()?])), 0),
				};
				let xor = if command == 5 { 0xFF } else { 0 };
				for i in 0..count {
					let b = (base + i).checked_sub(back).and_then(|at| out.get(at));
					out.push(b.copied().unwrap_or(0) ^ xor);
				}
			}
			_ => bail!("unknown compression command {command}"),
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::rom::{Region, Rom};

	#[test]
	fn decompress_runs_every_command() {
		let src = [
			0x02, 1, 2, 3, // literal
			0x22, 9, // repeat
			0x43, 4, 5, // alternate
			0x62, 0xFE, // increment
			0x81, 0, 0, // absolute copy
			0xA1, 1, 0, // inverted absolute copy
			0xC2, 3, // relative copy
			0xFF,
		];
		assert_eq!(
			decompress(&src).unwrap(),
			[
				1, 2, 3, 9, 9, 9, 4, 5, 4, 5, 0xFE, 0xFF, 0, 1, 2, 0xFD, 0xFC, 2, 0xFD, 0xFC
			]
		);
	}

	#[test]
	fn decompress_reads_long_headers() {
		// Command 1, count 0x100 + 1.
		let out = decompress(&[0xE5, 0x00, 7, 0xFF]).unwrap();
		assert_eq!(out, vec![7; 0x101]);
	}

	#[test]
	fn decompress_refuses_broken_streams() {
		assert!(decompress(&[0x01, 1]).is_err());
		assert!(decompress(&[0xFC, 0, 0xFF]).is_err());
	}

	#[test]
	fn decompress_copies_zeros_from_outside_its_output() {
		let src = [0x00, 7, 0xA1, 0, 1, 0xC2, 4, 0xFF];
		assert_eq!(decompress(&src).unwrap(), [7, 0xFF, 0xFF, 0, 7, 0xFF]);
	}

	#[test]
	fn smk_rom_course_0_decompresses_twice() {
		let Ok(path) = std::env::var("SMK_ROM") else {
			return;
		};
		let rom = Rom::parse(std::fs::read(path).unwrap()).unwrap();
		let pointer = |at: usize| {
			let b = &rom.data[at..at + 3];
			usize::from(b[2] & 0x0F) << 16 | usize::from(b[1]) << 8 | usize::from(b[0])
		};
		let list = pointer(match rom.region {
			Region::Japan => 0x1E74D,
			Region::Usa => 0x1E749,
			Region::Europe => 0x1E738,
		});
		let course = pointer(list);
		let packed = &rom.data[course..course + 3372];
		assert!(decompress(&packed[..3371]).is_err());
		let once = decompress(packed).unwrap();
		assert_eq!(once.len(), 5871);
		assert_eq!(decompress(&once).unwrap().len(), 16384);
	}
}