add support for VQ-compressed PVR

Author: malucard

kidfile/src/image.rs

@@ -9,11 +9,11 @@ pub enum PixelFormat {
 	Bgra,
 	Bgrx,
 	Bgr,
-	Rgba16,
-	Rgb16,
+	Rgba5551,
+	Rgb565,
 	Rgba4444,
-	Bgra16,
-	Bgr16,
+	Bgra5551,
+	Bgr565,
 	Bgra4444,
 	RgbaClut8,
 	RgbxClut8,
@@ -29,41 +29,12 @@ pub enum PixelFormat {
 	BgrClut4,
 	PsxClut4,
 	PsxClut8,
-	Psx
-}
-
-impl PixelFormat {
-	pub fn bpp(self) -> usize {
-		match self {
-			PixelFormat::Rgba => 32,
-			PixelFormat::Rgbx => 32,
-			PixelFormat::Rgb => 24,
-			PixelFormat::Bgra => 32,
-			PixelFormat::Bgrx => 32,
-			PixelFormat::Bgr => 24,
-			PixelFormat::Rgba16 => 16,
-			PixelFormat::Rgb16 => 16,
-			PixelFormat::Rgba4444 => 16,
-			PixelFormat::Bgra16 => 16,
-			PixelFormat::Bgr16 => 16,
-			PixelFormat::Bgra4444 => 16,
-			PixelFormat::RgbaClut8 => 8,
-			PixelFormat::RgbxClut8 => 8,
-			PixelFormat::RgbClut8 => 8,
-			PixelFormat::BgraClut8 => 8,
-			PixelFormat::BgrxClut8 => 8,
-			PixelFormat::BgrClut8 => 8,
-			PixelFormat::RgbaClut4 => 4,
-			PixelFormat::RgbxClut4 => 4,
-			PixelFormat::RgbClut4 => 4,
-			PixelFormat::BgraClut4 => 4,
-			PixelFormat::BgrxClut4 => 4,
-			PixelFormat::BgrClut4 => 4,
-			PixelFormat::PsxClut4 => 4,
-			PixelFormat::PsxClut8 => 8,
-			PixelFormat::Psx => 16
-		}
-	}
+	Psx,
+	Bgra5551Vq8,
+	Bgr565Vq8,
+	Bgra4444Vq8,
+	Gray8,
+	Gray4
 }
 
 impl<'a> From<&png::Info<'a>> for PixelFormat {
@@ -87,11 +58,11 @@ impl Display for PixelFormat {
 			Self::Bgra => write!(f, "BGRA"),
 			Self::Bgrx => write!(f, "BGRX"),
 			Self::Bgr => write!(f, "BGR"),
-			Self::Rgba16 => write!(f, "RGBA5551"),
-			Self::Rgb16 => write!(f, "RGB565"),
+			Self::Rgba5551 => write!(f, "RGBA5551"),
+			Self::Rgb565 => write!(f, "RGB565"),
 			Self::Rgba4444 => write!(f, "RGBA4444"),
-			Self::Bgra16 => write!(f, "BGRA5551"),
-			Self::Bgr16 => write!(f, "BGR565"),
+			Self::Bgra5551 => write!(f, "BGRA5551"),
+			Self::Bgr565 => write!(f, "BGR565"),
 			Self::Bgra4444 => write!(f, "BGRA4444"),
 			Self::RgbaClut8 => write!(f, "RGBA clut8"),
 			Self::RgbxClut8 => write!(f, "RGBX clut8"),
@@ -105,9 +76,14 @@ impl Display for PixelFormat {
 			Self::BgraClut4 => write!(f, "BGRA clut4"),
 			Self::BgrxClut4 => write!(f, "BGRX clut4"),
 			Self::BgrClut4 => write!(f, "BGR clut4"),
-			PixelFormat::PsxClut4 => write!(f, "PSX clut4"),
-			PixelFormat::PsxClut8 => write!(f, "PSX clut8"),
-			PixelFormat::Psx => write!(f, "PSX 16-bit")
+			Self::PsxClut4 => write!(f, "PSX clut4"),
+			Self::PsxClut8 => write!(f, "PSX clut8"),
+			Self::Psx => write!(f, "PSX 16-bit"),
+			Self::Bgra5551Vq8 => write!(f, "BGRA5551 vq8"),
+			Self::Bgr565Vq8 => write!(f, "BGR565 vq8"),
+			Self::Bgra4444Vq8 => write!(f, "BGRA4444 vq8"),
+			Self::Gray8 => write!(f, "gray8"),
+			Self::Gray4 => write!(f, "gray4")
 		}
 	}
 }
@@ -128,6 +104,16 @@ pub struct Frame {
 	pub pixels: Box<[Pixel]>
 }
 
+fn bits_2_to_8(x: u8) -> u8 {
+	let x = x & 0x3;
+	x | x << 2 | x << 4 | x << 6
+}
+
+fn bits_3_to_8(x: u8) -> u8 {
+	let x = x & 0x7;
+	x << 5 | x << 2 | x >> 1
+}
+
 fn bits_4_to_8(x: u8) -> u8 {
 	x << 4 | (x & 0xF)
 }
@@ -140,7 +126,7 @@ fn bits_6_to_8(x: u8) -> u8 {
 	x << 2 | (x & 1) << 1 | (x & 1)
 }
 
-fn bit_twiddle(x: usize) -> usize {
+pub fn bit_twiddle(x: usize) -> usize {
 	(x & 1) | (x & 2) << 1 | (x & 4) << 2 | (x & 8) << 3 | (x & 16) << 4 | (x & 32) << 5 | (x & 64) << 6 | (x & 128) << 7 | (x & 256) << 8 | (x & 512) << 9
 }
 
@@ -162,12 +148,12 @@ impl Frame {
 		}
 	}
 
-	pub fn from_rgba16(width: u32, height: u32, buf: &[u8]) -> Self {
+	pub fn from_rgba5551(width: u32, height: u32, buf: &[u8]) -> Self {
 		let needed_size = width * height * 2;
 		assert!(buf.len() as u32 >= needed_size);
 		let buf = &buf[0..needed_size as usize];
 		Self {
-			width, height, og_fmt: PixelFormat::Rgba16,
+			width, height, og_fmt: PixelFormat::Rgba5551,
 			pixels: buf.chunks_exact(2).map(|x| Pixel {
 				r: bits_5_to_8(x[0]),
 				g: bits_5_to_8(x[0] >> 5 | x[1] << 3),
@@ -177,12 +163,12 @@ impl Frame {
 		}
 	}
 
-	pub fn from_bgra16(width: u32, height: u32, buf: &[u8]) -> Self {
+	pub fn from_bgra5551(width: u32, height: u32, buf: &[u8]) -> Self {
 		let needed_size = width * height * 2;
 		assert!(buf.len() as u32 >= needed_size);
 		let buf = &buf[0..needed_size as usize];
 		Self {
-			width, height, og_fmt: PixelFormat::Bgra16,
+			width, height, og_fmt: PixelFormat::Bgra5551,
 			pixels: buf.chunks_exact(2).map(|x| Pixel {
 				r: bits_5_to_8(x[1] >> 3),
 				g: bits_5_to_8(x[0] >> 5 | x[1] << 3),
@@ -227,7 +213,7 @@ impl Frame {
 		assert!(buf.len() as u32 >= needed_size);
 		let buf = &buf[0..needed_size as usize];
 		Self {
-			width, height, og_fmt: PixelFormat::Rgb16,
+			width, height, og_fmt: PixelFormat::Rgb565,
 			pixels: buf.chunks_exact(2).map(|x| Pixel {
 				r: bits_5_to_8(x[0]),
 				g: bits_6_to_8(x[0] >> 5 | x[1] << 3),
@@ -237,12 +223,12 @@ impl Frame {
 		}
 	}
 
-	pub fn from_bgr16(width: u32, height: u32, buf: &[u8]) -> Self {
+	pub fn from_bgr565(width: u32, height: u32, buf: &[u8]) -> Self {
 		let needed_size = width * height * 2;
 		assert!(buf.len() as u32 >= needed_size);
 		let buf = &buf[0..needed_size as usize];
 		Self {
-			width, height, og_fmt: PixelFormat::Bgr16,
+			width, height, og_fmt: PixelFormat::Bgr565,
 			pixels: buf.chunks_exact(2).map(|x| Pixel {
 				r: bits_5_to_8(x[1] >> 3),
 				g: bits_6_to_8(x[0] >> 5 | x[1] << 3),
@@ -440,6 +426,35 @@ impl Frame {
 		}
 	}
 
+	pub fn from_gray8(width: u32, height: u32, buf: &[u8]) -> Self {
+		let needed_size = width * height;
+		assert!(buf.len() as u32 >= needed_size);
+		let buf = &buf[0..needed_size as usize];
+		Self {
+			width, height, og_fmt: PixelFormat::Gray8,
+			pixels: buf.iter().map(|&x| Pixel {
+				r: bits_3_to_8(x >> 5),
+				g: bits_3_to_8(x >> 2),
+				b: bits_2_to_8(x),
+				a: 255
+			}).collect()
+		}
+	}
+
+	pub fn from_gray4(width: u32, height: u32, buf: &[u8]) -> Self {
+		let needed_size = width * height / 2;
+		assert!(buf.len() as u32 >= needed_size);
+		let buf = &buf[0..needed_size as usize];
+		Self {
+			width, height, og_fmt: PixelFormat::Bgra,
+			pixels: buf.iter().map(|&x| {
+				let a = bits_4_to_8(x);
+				let b = bits_4_to_8(x >> 4);
+				[Pixel {r: a, g: a, b: a, a: 255}, Pixel {r: b, g: b, b: b, a: 255}]
+			}).flatten().collect()
+		}
+	}
+
 	pub fn with_og_fmt(mut self, og_fmt: PixelFormat) -> Self {
 		self.og_fmt = og_fmt;
 		self
@@ -556,4 +571,4 @@ impl Frame {
 
 pub struct Image {
 	pub frames: Box<[Frame]>
-}
+}

kidfile/src/image_formats/gim.rs

@@ -69,7 +69,7 @@ pub const ENTRY_GIM: Decoder<Image> = Decoder {
 				};
 				let frame = match format {
 					0 => Frame::from_rgb16(aligned_width, height, &pixel_data),
-					1 => Frame::from_rgba16(aligned_width, height, &pixel_data),
+					1 => Frame::from_rgba5551(aligned_width, height, &pixel_data),
 					3 => Frame::from_rgba(aligned_width, height, &pixel_data),
 					4 => Frame::from_rgba_clut4(aligned_width, height, cur_palette, &pixel_data),
 					5 => Frame::from_rgba_clut8(aligned_width, height, cur_palette, &pixel_data),
@@ -85,4 +85,4 @@ pub const ENTRY_GIM: Decoder<Image> = Decoder {
 			Ok(Image {frames: frames.into_boxed_slice()})
 		}
 	}
-};
+};

kidfile/src/image_formats/ogdt.rs

@@ -23,7 +23,7 @@ pub const ENTRY_OGDT: Decoder<Image> = Decoder {
 			),
 			Some(1) => if buf.len() < 32 + frame_count * tile_width * tile_height * 3 {
 				(
-					PixelFormat::Rgba16,
+					PixelFormat::Rgba5551,
 					tile_width * tile_height * 2,
 					Cow::Borrowed(&[] as &[u8])
 				)
@@ -56,7 +56,7 @@ pub const ENTRY_OGDT: Decoder<Image> = Decoder {
 			let tile = match fmt {
 				PixelFormat::Rgba => Frame::from_rgba(tile_width as u32, tile_height as u32, frame_bytes).with_double_alpha(),
 				PixelFormat::Rgb => Frame::from_rgb(tile_width as u32, tile_height as u32, frame_bytes),
-				PixelFormat::Rgba16 => Frame::from_rgba16(tile_width as u32, tile_height as u32, frame_bytes),
+				PixelFormat::Rgba5551 => Frame::from_rgba5551(tile_width as u32, tile_height as u32, frame_bytes),
 				PixelFormat::RgbaClut8 => Frame::from_rgba_clut8(tile_width as u32, tile_height as u32, &clut, frame_bytes).with_double_alpha(),
 				PixelFormat::RgbaClut4 => Frame::from_rgba_clut4(tile_width as u32, tile_height as u32, &clut, frame_bytes).with_double_alpha(),
 				_ => unreachable!()
@@ -90,4 +90,4 @@ fn fix_clut(clut: &[u8]) -> Vec<u8> {
 	}
 
 	bytemuck::cast_vec(out)
-}
+}

kidfile/src/image_formats/pvr.rs

@@ -1,4 +1,6 @@
-use crate::{byte_slice::ByteSlice, image::{Frame, Image}, Certainty, Decoder};
+use std::{fs::File, io::{Read, Seek, SeekFrom}};
+
+use crate::{Certainty, Decoder, byte_slice::ByteSlice, image::{Frame, Image, PixelFormat, bit_twiddle}};
 
 // https://www.fabiensanglard.net/Mykaruga/tools/segaPVRFormat.txt
 // https://dreamcast.wiki/Twiddling
@@ -31,36 +33,76 @@ pub const ENTRY_PVR: Decoder<Image> = Decoder {
 		let width = buf.read_u16(12)? as usize;
 		let height = buf.read_u16(14)? as usize;
 		let mut frame = match pixel_fmt {
-			0 => Frame::from_bgra16(width as u32, height as u32, buf.get(16..16 + width * height * 2).ok_or("not enough pixel data for BGRA5551")?),
-			1 => Frame::from_bgr16(width as u32, height as u32, buf.get(16..16 + width * height * 2).ok_or("not enough pixel data for BGR565")?),
-			2 => Frame::from_bgra4444(width as u32, height as u32, buf.get(16..16 + width * height * 2).ok_or("not enough pixel data for BGRA4444")?),
+			0 | 1 | 2 => {
+				if twiddle_type == 3 { // vq compression
+					let codebook = buf.get(16..16 + 2048).ok_or("not enough 16-bit VQ codebook data")?;
+					let indices = buf.get(16 + 2048..16 + 2048 + width * height / 4).ok_or("not enough VQ index data")?;
+					let mut pixels = vec![0u8; width * height * 2];
+					for block_y in 0..height / 2 {
+						let twiddled_block_y = bit_twiddle(block_y);
+						for block_x in 0..width / 2 {
+							let twiddled_block_idx = twiddled_block_y | bit_twiddle(block_x) << 1;
+							let codebook_pos = indices[twiddled_block_idx] as usize * 8;
+							let x = block_x * 2;
+							let y = block_y * 2;
+							pixels[(y * width + x) * 2] = codebook[codebook_pos];
+							pixels[(y * width + x) * 2 + 1] = codebook[codebook_pos + 1];
+							pixels[(y * width + x + 1) * 2] = codebook[codebook_pos + 4];
+							pixels[(y * width + x + 1) * 2 + 1] = codebook[codebook_pos + 5];
+							pixels[((y + 1) * width + x) * 2] = codebook[codebook_pos + 2];
+							pixels[((y + 1) * width + x) * 2 + 1] = codebook[codebook_pos + 3];
+							pixels[((y + 1) * width + x + 1) * 2] = codebook[codebook_pos + 6];
+							pixels[((y + 1) * width + x + 1) * 2 + 1] = codebook[codebook_pos + 7];
+						}
+					}
+					if pixel_fmt == 0 {
+						Frame::from_bgra5551(width as u32, height as u32, &pixels).with_og_fmt(PixelFormat::Bgra5551Vq8)
+					} else if pixel_fmt == 1 {
+						Frame::from_bgr565(width as u32, height as u32, &pixels).with_og_fmt(PixelFormat::Bgr565Vq8)
+					} else {
+						Frame::from_bgra4444(width as u32, height as u32, &pixels).with_og_fmt(PixelFormat::Bgra4444Vq8)
+					}
+				} else {
+					if pixel_fmt == 0 {
+						Frame::from_bgra5551(width as u32, height as u32, buf.get(16..16 + width * height * 2).ok_or("not enough pixel data for BGRA5551")?)
+					} else if pixel_fmt == 1 {
+						Frame::from_bgr565(width as u32, height as u32, buf.get(16..16 + width * height * 2).ok_or("not enough pixel data for BGR565")?)
+					} else {
+						Frame::from_bgra4444(width as u32, height as u32, buf.get(16..16 + width * height * 2).ok_or("not enough pixel data for BGRA4444")?)
+					}
+				}
+			}
 			5 => {
-				if palette_bytes.is_empty() {
+				if twiddle_type == 7 {
+					return Err("file needs external palette, unimplemented".into());
+				} else if palette_bytes.is_empty() {
 					Frame::from_bgra_clut4(
 						width as u32, height as u32,
 						buf.get(16..16 + 1024).ok_or("not enough palette data for BGRA clut4")?,
-						buf.get(16 + 1024..16 + 1024 + width * height / 2).ok_or("not enough pixel data for BGRA clut4")?
+						buf.get(16 + 1024..16 + 1024 + width * height / 2).ok_or("not enough index data for BGRA clut4")?
 					)
 				} else {
 					Frame::from_bgra_clut4(
 						width as u32, height as u32,
 						&palette_bytes,
-						buf.get(16..16 + width * height / 2).ok_or("not enough pixel data for BGRA clut4")?
+						buf.get(16..16 + width * height / 2).ok_or("not enough data for BGRA clut4")?
 					)
 				}
 			}
 			6 => {
-				if palette_bytes.is_empty() {
+				if twiddle_type == 7 {
+					return Err("file needs external palette, unimplemented".into());
+				} else if palette_bytes.is_empty() {
 					Frame::from_bgra_clut8(
 						width as u32, height as u32,
 						buf.get(16..16 + 1024).ok_or("not enough palette data for BGRA clut8")?,
-						buf.get(16 + 1024..16 + 1024 + width * height).ok_or("not enough pixel data for BGRA clut8")?
+						buf.get(16 + 1024..16 + 1024 + width * height).ok_or("not enough index data for BGRA clut8")?
 					)
 				} else {
 					Frame::from_bgra_clut8(
 						width as u32, height as u32,
 						&palette_bytes,
-						buf.get(16..16 + width * height).ok_or("not enough pixel data for BGRA clut8")?
+						buf.get(16..16 + width * height).ok_or("not enough data for BGRA clut8")?
 					)
 				}
 			}
@@ -71,4 +113,4 @@ pub const ENTRY_PVR: Decoder<Image> = Decoder {
 		}
 		Ok(Image {frames: Box::new([frame])})
 	}
-};
+};

kidfile/src/image_formats/tim2.rs

@@ -17,7 +17,7 @@ pub const ENTRY_TIM2: Decoder<Image> = Decoder {
 					tim2::Format::Indexed8 => PixelFormat::RgbaClut8,
 					tim2::Format::Rgb888 => PixelFormat::Rgb,
 					tim2::Format::Rgba8888 => PixelFormat::Rgba,
-					tim2::Format::Abgr1555 => PixelFormat::Rgba16
+					tim2::Format::Abgr1555 => PixelFormat::Rgba5551
 				};
 				if matches!(frame.og_fmt, PixelFormat::RgbaClut4 | PixelFormat::RgbaClut8 | PixelFormat::Rgba) {
 					Some(frame.with_double_alpha())
@@ -32,4 +32,4 @@ pub const ENTRY_TIM2: Decoder<Image> = Decoder {
 			Ok(Image {frames})
 		}
 	}
-};
+};