#![cfg_attr(not(feature = "std"), no_std)] #![deny(missing_docs)] #![doc = include_str!("../README.md")] use core::cmp::{max, min}; use core::fmt::{self, Debug, Display}; /// trait for IO errors /// /// we don't use [`std::io::Error`] /// so that this crate can be used in `no_std` environments. pub trait IOError: Sized + Display + Debug { /// does this error indicate an unexpected end-of-file? fn is_unexpected_eof(&self) -> bool; } #[cfg(feature = "std")] impl IOError for std::io::Error { fn is_unexpected_eof(&self) -> bool { self.kind() == std::io::ErrorKind::UnexpectedEof } } /// decoding error #[derive(Debug)] #[non_exhaustive] pub enum Error { /// IO error — these can only be produced /// by the underlying file/slice reader, not by /// `tiny-png` itself. IO(I), /// the buffer you provided is too small /// (i.e. it's smaller than [`ImageHeader::required_bytes()`]). BufferTooSmall, /// the size of the image data would not fit in a `usize` (so it could never be loaded into memory) TooLargeForUsize, /// this file is not a PNG file (missing PNG signature). NotPng, /// bad IHDR block (invalid PNG file) BadIhdr, /// unrecognized critical PNG chunk (invalid PNG file) UnrecognizedChunk([u8; 4]), /// bad ZLIB block type (invalid PNG file) BadBlockType, /// ZLIB LEN doesn't match NLEN (invalid PNG file) BadNlen, /// decompressed data is larger than it should be (invalid PNG file) TooMuchData, /// unexpected end of PNG block (invalid PNG file) UnexpectedEob, /// bad zlib header (invalid PNG file) BadZlibHeader, /// bad huffman code (invalid PNG file) BadCode, /// bad huffman dictionary definition (invalid PNG file) BadHuffmanDict, /// bad LZ77 back reference (invalid PNG file) BadBackReference, /// unsupported interlace method (Adam7 interlacing is not currently supported) UnsupportedInterlace, /// bad filter number (invalid PNG file) BadFilter, /// bad PLTE chunk (invalid PNG file) BadPlteChunk, /// bad tRNS chunk (invalid PNG file) BadTrnsChunk, /// missing IDAT chunk (invalid PNG file) NoIdat, /// Adler-32 checksum doesn't check out (invalid PNG file) BadAdlerChecksum, } impl From for Error { fn from(value: I) -> Self { Self::IO(value) } } impl Display for Error { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::IO(e) => write!(f, "{e}"), Self::NotPng => write!(f, "not a png file"), Self::BadIhdr => write!(f, "bad IHDR chunk"), Self::BufferTooSmall => write!(f, "provided buffer is too small"), Self::UnrecognizedChunk([a, b, c, d]) => { write!(f, "unrecognized chunk type: {a} {b} {c} {d}") } Self::BadBlockType => write!(f, "bad DEFLATE block type"), Self::TooMuchData => write!(f, "decompressed data is larger than it should be"), Self::UnexpectedEob => write!(f, "unexpected end of block"), Self::BadZlibHeader => write!(f, "bad zlib header"), Self::BadCode => write!(f, "bad code in DEFLATE data"), Self::BadHuffmanDict => write!(f, "bad Huffman dictionary definition"), Self::BadBackReference => { write!(f, "bad DEFLATE back reference (goes past start of stream)") } Self::TooLargeForUsize => write!(f, "decompressed data larger than usize::MAX bytes"), Self::UnsupportedInterlace => write!(f, "unsupported interlacing method"), Self::BadFilter => write!(f, "bad PNG filter"), Self::BadPlteChunk => write!(f, "bad PLTE chunk"), Self::BadTrnsChunk => write!(f, "bad tRNS chunk"), Self::NoIdat => write!(f, "missing IDAT chunk"), Self::BadNlen => write!(f, "LEN doesn't match NLEN"), Self::BadAdlerChecksum => write!(f, "bad adler-32 checksum"), } } } #[cfg(feature = "std")] impl std::error::Error for Error {} /// a trait similar to [`std::io::Read`], but suitable for `no_std` environments. /// /// note that this is implemented both for byte slices and [`std::io::BufReader`] /// (if `std` feature is enabled), so in most cases you won't need to implement it yourself. pub trait Read { /// associated error type type Error: IOError; /// read exactly `buf.len()` bytes into `buf`. /// /// if there are less than `buf.len()` bytes available, an error should be produced. fn read(&mut self, buf: &mut [u8]) -> Result<(), Self::Error>; /// skip `count` bytes. /// /// a default implementation is provided which just calls [`Read::read`] /// as needed, but in most cases a better implementation is possible. fn skip_bytes(&mut self, count: usize) -> Result<(), Self::Error> { let mut count = count; let mut buf = [0; 128]; while count > 0 { let c = min(buf.len(), count); self.read(&mut buf[..c])?; count -= c; } Ok(()) } } #[cfg(feature = "std")] impl Read for std::io::BufReader { type Error = std::io::Error; fn read(&mut self, buf: &mut [u8]) -> Result<(), Self::Error> { use std::io::Read; self.read_exact(buf) } fn skip_bytes(&mut self, bytes: usize) -> Result<(), Self::Error> { use std::io::Seek; self.seek(std::io::SeekFrom::Current(bytes as i64)) .map(|_| ()) } } /// indicates unexpected end of file #[derive(Debug)] pub struct UnexpectedEofError; impl core::fmt::Display for UnexpectedEofError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "unexpected EOF") } } #[cfg(feature = "std")] impl std::error::Error for UnexpectedEofError {} impl IOError for UnexpectedEofError { fn is_unexpected_eof(&self) -> bool { true } } impl<'a> Read for &'a [u8] { type Error = UnexpectedEofError; fn read(&mut self, buf: &mut [u8]) -> Result<(), Self::Error> { if self.len() < buf.len() { return Err(UnexpectedEofError); } buf.copy_from_slice(&self[..buf.len()]); *self = &self[buf.len()..]; Ok(()) } fn skip_bytes(&mut self, bytes: usize) -> Result<(), Self::Error> { if self.len() < bytes { return Err(UnexpectedEofError); } *self = &self[bytes..]; Ok(()) } } struct IdatReader<'a, R: Read> { inner: &'a mut R, bytes_left_in_block: usize, palette: &'a mut [[u8; 4]; 256], header: &'a ImageHeader, eof: bool, } impl IdatReader<'_, R> { fn read_partial(&mut self, buf: &mut [u8]) -> Result> { if self.bytes_left_in_block >= buf.len() { self.inner.read(buf)?; self.bytes_left_in_block -= buf.len(); Ok(buf.len()) } else { if self.bytes_left_in_block > 0 { self.inner.read(&mut buf[..self.bytes_left_in_block])?; } let bytes_read = self.bytes_left_in_block; // CRC self.inner.skip_bytes(4)?; match read_non_idat_chunks(self.inner, self.header, self.palette)? { None => { self.bytes_left_in_block = 0; self.eof = true; Ok(bytes_read) } Some(n) => { self.bytes_left_in_block = n; Ok(self.read_partial(&mut buf[bytes_read..])? + bytes_read) } } } } fn read(&mut self, buf: &mut [u8]) -> Result<(), Error> { let count = self.read_partial(buf)?; if count == buf.len() { Ok(()) } else { Err(Error::UnexpectedEob) } } fn read_to_end(&mut self) -> Result<(), Error> { if !self.eof { if self.bytes_left_in_block > 0 { self.inner.skip_bytes(self.bytes_left_in_block)?; } // CRC self.inner.skip_bytes(4)?; loop { match read_non_idat_chunks(self.inner, self.header, self.palette)? { None => break, Some(n) => self.inner.skip_bytes(n + 4)?, } } } self.eof = true; Ok(()) } } /// color bit depth #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[repr(u8)] pub enum BitDepth { /// 1 bit per pixel (only used with indexed images) One = 1, /// 2 bits per pixel (only used with indexed images) Two = 2, /// 4 bits per pixel (only used with indexed images) Four = 4, /// 8 bits per channel (most common) Eight = 8, /// 16 bits per channel Sixteen = 16, } /// color format #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum ColorType { /// grayscale Gray, /// grayscale + alpha GrayAlpha, /// RGB Rgb, /// RGBA Rgba, /// indexed color (each pixel is an index into [`ImageData::palette`]) Indexed, } impl BitDepth { fn from_byte(x: u8) -> Option { Some(match x { 1 => Self::One, 2 => Self::Two, 4 => Self::Four, 8 => Self::Eight, 16 => Self::Sixteen, _ => return None, }) } } impl ColorType { fn from_byte(x: u8) -> Option { Some(match x { 0 => Self::Gray, 2 => Self::Rgb, 3 => Self::Indexed, 4 => Self::GrayAlpha, 6 => Self::Rgba, _ => return None, }) } fn channels(self) -> u8 { match self { Self::Gray | Self::Indexed => 1, Self::GrayAlpha => 2, Self::Rgb => 3, Self::Rgba => 4, } } } /// image metadata found at the start of the PNG file. #[derive(Debug, Clone, Copy)] pub struct ImageHeader { width: u32, height: u32, bit_depth: BitDepth, color_type: ColorType, } impl ImageHeader { /// width of image in pixels pub fn width(&self) -> u32 { self.width } /// height of image in pixels pub fn height(&self) -> u32 { self.height } /// bits per sample of image pub fn bit_depth(&self) -> BitDepth { self.bit_depth } /// number and type of color channels pub fn color_type(&self) -> ColorType { self.color_type } fn checked_decompressed_size(&self) -> Option { let row_bytes = 1 + usize::try_from(self.width()) .ok()? .checked_mul(usize::from(self.bit_depth() as u8))? .checked_mul(usize::from(self.color_type().channels()))? .checked_add(7)? / 8; row_bytes.checked_mul(usize::try_from(self.height()).ok()?) } fn decompressed_size(&self) -> usize { self.checked_decompressed_size().unwrap() } fn checked_required_bytes(&self) -> Option { self.checked_decompressed_size() } /// number of bytes needed for [`read_png`] pub fn required_bytes(&self) -> usize { self.checked_required_bytes().unwrap() } /// number of bytes in a single row of pixels pub fn bytes_per_row(&self) -> usize { (self.width() as usize * usize::from(self.bit_depth() as u8) * usize::from(self.color_type().channels()) + 7) / 8 } fn data_size(&self) -> usize { let row_bytes = self.bytes_per_row(); row_bytes * self.height() as usize } } /// number of bits to read in each [`Read::read`] call. type ReadBits = u32; /// number of bits to store in the [`BitReader`] buffer. type Bits = u64; struct BitReader<'a, R: Read> { inner: IdatReader<'a, R>, bits: Bits, bits_left: u8, } impl<'a, R: Read> From> for BitReader<'a, R> { fn from(inner: IdatReader<'a, R>) -> Self { Self { inner, bits: 0, bits_left: 0, } } } impl BitReader<'_, R> { fn peek_bits(&mut self, count: u8) -> Result> { debug_assert!(count > 0 && u32::from(count) <= 31); if self.bits_left < count { // read more bits let mut new_bits = [0; ReadBits::BITS as usize / 8]; self.inner.read_partial(&mut new_bits)?; let new_bits = Bits::from(ReadBits::from_le_bytes(new_bits)); self.bits |= new_bits << self.bits_left; self.bits_left += ReadBits::BITS as u8; } Ok((self.bits as u32) & ((1 << count) - 1)) } fn read_bits(&mut self, count: u8) -> Result> { let bits = self.peek_bits(count)?; self.bits_left -= count; self.bits >>= count; Ok(bits) } /// at least `count` bits MUST have been peeked before calling this! fn skip_peeked_bits(&mut self, count: u8) { debug_assert!(self.bits_left >= count); self.bits_left -= count; self.bits >>= count; } fn read_bits_usize(&mut self, count: u8) -> Result> { debug_assert!(u32::from(count) <= usize::BITS); self.read_bits(count).map(|x| x as usize) } fn read_bits_u8(&mut self, count: u8) -> Result> { debug_assert!(count <= 8); self.read_bits(count).map(|x| x as u8) } fn read_bits_u16(&mut self, count: u8) -> Result> { debug_assert!(count <= 16); self.read_bits(count).map(|x| x as u16) } fn read_aligned_bytes(&mut self, buf: &mut [u8]) -> Result<(), Error> { debug_assert_eq!(self.bits_left % 8, 0); let mut i = 0; while self.bits_left > 0 && i < buf.len() { buf[i] = self.read_bits_u8(8)?; i += 1; } self.inner.read(&mut buf[i..]) } } #[derive(Debug)] struct DecompressedDataWriter<'a> { slice: &'a mut [u8], pos: usize, } impl<'a> From<&'a mut [u8]> for DecompressedDataWriter<'a> { fn from(slice: &'a mut [u8]) -> Self { Self { slice, pos: 0 } } } impl<'a> DecompressedDataWriter<'a> { fn write_byte(&mut self, byte: u8) -> Result<(), Error> { match self.slice.get_mut(self.pos) { None => return Err(Error::TooMuchData), Some(p) => *p = byte, } self.pos += 1; Ok(()) } fn copy(&mut self, distance: usize, length: usize) -> Result<(), Error> { if self.pos < distance { return Err(Error::BadBackReference); } let mut src = self.pos - distance; let mut dest = self.pos; if length > self.slice.len() - dest { return Err(Error::TooMuchData); } for _ in 0..length { self.slice[dest] = self.slice[src]; dest += 1; src += 1; } self.pos = dest; Ok(()) } } const HUFFMAN_MAX_CODES: usize = 286; const HUFFMAN_MAX_BITS: u8 = 15; const HUFFMAN_MAIN_TABLE_BITS: u8 = 10; const HUFFMAN_MAIN_TABLE_SIZE: usize = 1 << HUFFMAN_MAIN_TABLE_BITS; const HUFFMAN_SUBTABLE_SIZE: usize = 1 << (HUFFMAN_MAX_BITS - HUFFMAN_MAIN_TABLE_BITS); #[derive(Debug)] struct HuffmanTable { main_table: [i16; HUFFMAN_MAIN_TABLE_SIZE], subtables: [[u16; HUFFMAN_SUBTABLE_SIZE]; HUFFMAN_MAX_CODES + 1], subtables_used: i16, } impl Default for HuffmanTable { fn default() -> Self { Self { main_table: [0; HUFFMAN_MAIN_TABLE_SIZE], subtables: [[0; HUFFMAN_SUBTABLE_SIZE]; HUFFMAN_MAX_CODES + 1], // reserve "null" subtable subtables_used: 1, } } } impl HuffmanTable { fn assign(&mut self, code: u16, length: u8, value: u16) { if length == 0 { return; } // reverse code let code = code.reverse_bits() >> (16 - length); if length <= HUFFMAN_MAIN_TABLE_BITS { // just throw it in the main table for i in 0..1u16 << (HUFFMAN_MAIN_TABLE_BITS - length) { self.main_table[usize::from(i << length | code)] = value as i16 | i16::from(length) << 9; } } else { // put it in a subtable. let main_table_entry = usize::from(code) & (HUFFMAN_MAIN_TABLE_SIZE - 1); let subtable_index = if self.main_table[main_table_entry] == 0 { let i = self.subtables_used; self.main_table[main_table_entry] = -i; self.subtables_used += 1; i } else { debug_assert!(self.main_table[main_table_entry] < 0); -self.main_table[main_table_entry] }; let subtable = &mut self.subtables[subtable_index as usize]; for i in 0..1u16 << (HUFFMAN_MAX_BITS - length) { subtable[usize::from( i << (length - HUFFMAN_MAIN_TABLE_BITS) | code >> HUFFMAN_MAIN_TABLE_BITS, )] = value | u16::from(length) << 9; } } } fn from_code_lengths(code_lengths: &[u8]) -> Self { let mut bl_count = [0; HUFFMAN_MAX_BITS as usize + 1]; for l in code_lengths.iter().copied() { bl_count[usize::from(l)] += 1; } bl_count[0] = 0; let mut next_code = [0; HUFFMAN_MAX_BITS as usize + 1]; let mut code = 0; for bits in 1..=usize::from(HUFFMAN_MAX_BITS) { code = (code + bl_count[bits - 1]) << 1; next_code[bits] = code; } let mut table = HuffmanTable::default(); for (i, l) in code_lengths.iter().copied().enumerate() { table.assign(next_code[usize::from(l)], l, i as u16); next_code[usize::from(l)] += 1; } table } fn read_value(&self, reader: &mut BitReader<'_, R>) -> Result> { let code = reader.peek_bits(HUFFMAN_MAX_BITS)? as u16; let entry = self.main_table[usize::from(code) & (HUFFMAN_MAIN_TABLE_SIZE - 1)]; let entry = if entry > 0 { entry as u16 } else { self.subtables[(-entry) as usize][usize::from(code >> HUFFMAN_MAIN_TABLE_BITS)] }; let length = (entry >> 9) as u8; if length == 0 { return Err(Error::BadCode); } reader.skip_peeked_bits(length); Ok(entry & 0x1ff) } } /// image data #[derive(Debug)] pub struct ImageData<'a> { header: ImageHeader, buffer: &'a mut [u8], palette: [[u8; 4]; 256], } impl ImageData<'_> { /// get pixel values encoded as bytes. /// /// this is guaranteed to be a prefix of the buffer passed to [`read_png`]. pub fn pixels(&self) -> &[u8] { &self.buffer[..self.header.data_size()] } /// get color in palette at index. /// /// returns `[0, 0, 0, 255]` if `index` is out of range. pub fn palette(&self, index: u32) -> [u8; 4] { let Ok(index) = usize::try_from(index) else { return [0, 0, 0, 255]; }; self.palette.get(index).copied().unwrap_or([0, 0, 0, 255]) } /// image width in pixels pub fn width(&self) -> u32 { self.header.width } /// image height in pixels pub fn height(&self) -> u32 { self.header.height } /// bits per sample of image pub fn bit_depth(&self) -> BitDepth { self.header.bit_depth } /// number and type of color channels pub fn color_type(&self) -> ColorType { self.header.color_type } /// number of bytes in a single row of pixels pub fn bytes_per_row(&self) -> usize { self.header.bytes_per_row() } } /// read image metadata. /// /// this function only needs to read a few bytes from the start of the file, /// so it should be very fast. pub fn read_png_header(reader: &mut R) -> Result> { let mut signature = [0; 8]; match reader.read(&mut signature) { Ok(()) => {} Err(e) if e.is_unexpected_eof() => { // make sure we give a NotPng error signature = [0; 8]; } Err(e) => return Err(e.into()), } if signature != [137, 80, 78, 71, 13, 10, 26, 10] { return Err(Error::NotPng); } let mut ihdr = [0; 25]; reader.read(&mut ihdr)?; let ihdr_len = (u32::from_be_bytes([ihdr[0], ihdr[1], ihdr[2], ihdr[3]]) + 12) as usize; if &ihdr[4..8] != b"IHDR" || ihdr_len < ihdr.len() { return Err(Error::BadIhdr); } reader.skip_bytes(ihdr_len - ihdr.len())?; let width = u32::from_be_bytes([ihdr[8], ihdr[9], ihdr[10], ihdr[11]]); let height = u32::from_be_bytes([ihdr[12], ihdr[13], ihdr[14], ihdr[15]]); let bit_depth = BitDepth::from_byte(ihdr[16]).ok_or(Error::BadIhdr)?; let color_type = ColorType::from_byte(ihdr[17]).ok_or(Error::BadIhdr)?; let compression = ihdr[18]; let filter = ihdr[19]; let interlace = ihdr[20]; if compression != 0 || filter != 0 { return Err(Error::BadIhdr); } if interlace != 0 { return Err(Error::UnsupportedInterlace); } let hdr = ImageHeader { width, height, bit_depth, color_type, }; if hdr.checked_required_bytes().is_none() { return Err(Error::TooLargeForUsize); } Ok(hdr) } fn read_compressed_block( reader: &mut BitReader<'_, R>, writer: &mut DecompressedDataWriter, dynamic: bool, ) -> Result<(), Error> { let literal_length_table; let distance_table; if dynamic { let literal_length_code_lengths_count = reader.read_bits_usize(5)? + 257; let distance_code_lengths_count = reader.read_bits_usize(5)? + 1; let code_length_code_lengths_count = reader.read_bits_usize(4)? + 4; let mut code_length_code_lengths = [0; 19]; for i in 0..code_length_code_lengths_count { const ORDER: [u8; 19] = [ 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15, ]; code_length_code_lengths[usize::from(ORDER[i])] = reader.read_bits_u8(3)?; } let code_length_table = HuffmanTable::from_code_lengths(&code_length_code_lengths); let mut code_lengths = [0; 286 + 32]; let mut i = 0; let total_code_lengths = literal_length_code_lengths_count + distance_code_lengths_count; loop { let op = code_length_table.read_value(reader)? as u8; if op < 16 { code_lengths[i] = op; i += 1; } else if op == 16 { let rep = reader.read_bits_usize(2)? + 3; if i == 0 || i + rep > total_code_lengths { return Err(Error::BadHuffmanDict); } let l = code_lengths[i - 1]; for _ in 0..rep { code_lengths[i] = l; i += 1; } } else if op == 17 { let rep = reader.read_bits_usize(3)? + 3; if i + rep > total_code_lengths { return Err(Error::BadHuffmanDict); } for _ in 0..rep { code_lengths[i] = 0; i += 1; } } else if op == 18 { let rep = reader.read_bits_usize(7)? + 11; if i + rep > total_code_lengths { return Err(Error::BadHuffmanDict); } for _ in 0..rep { code_lengths[i] = 0; i += 1; } } else { // since we only assigned 0..=18 in the huffman table, // we should never get a value outside that range. debug_assert!(false, "should not be reachable"); } if i >= total_code_lengths { break; } } let literal_length_code_lengths = &code_lengths[0..literal_length_code_lengths_count]; let distance_code_lengths = &code_lengths[literal_length_code_lengths_count..total_code_lengths]; literal_length_table = HuffmanTable::from_code_lengths(literal_length_code_lengths); distance_table = HuffmanTable::from_code_lengths(distance_code_lengths); } else { let mut lit = HuffmanTable::default(); let mut dist = HuffmanTable::default(); for i in 0..=143 { lit.assign(0b00110000 + i, 8, i); } for i in 144..=255 { lit.assign(0b110010000 + (i - 144), 9, i); } for i in 256..=279 { lit.assign(i - 256, 7, i); } for i in 280..=287 { lit.assign(0b11000000 + (i - 280), 8, i); } for i in 0..30 { dist.assign(i, 5, i); } literal_length_table = lit; distance_table = dist; } loop { let literal_length = literal_length_table.read_value(reader)?; match literal_length { 0..=255 => { // literal writer.write_byte(literal_length as u8)?; } 256 => { // end of block break; } _ => { // length + distance let length = match literal_length { 257..=264 => literal_length - 254, 265..=284 => { const BASES: [u8; 20] = [ 11, 13, 15, 17, 19, 23, 27, 31, 35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, ]; let base: u16 = BASES[usize::from(literal_length - 265)].into(); let extra_bits = (literal_length - 261) as u8 / 4; let extra = reader.read_bits_u16(extra_bits)?; base + extra } 285 => 258, _ => return Err(Error::BadCode), }; let distance_code = distance_table.read_value(reader)?; let distance = match distance_code { 0..=3 => distance_code + 1, 4..=29 => { const BASES: [u16; 26] = [ 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193, 257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145, 8193, 12289, 16385, 24577, ]; let base = BASES[usize::from(distance_code - 4)]; let extra_bits = (distance_code - 2) as u8 / 2; let extra = reader.read_bits_u16(extra_bits)?; base + extra } _ => return Err(Error::BadCode), }; writer.copy(usize::from(distance), usize::from(length))?; } } } Ok(()) } fn read_idat( reader: IdatReader<'_, R>, writer: &mut DecompressedDataWriter, ) -> Result<(), Error> { let mut reader = BitReader::from(reader); // zlib header let cmf = reader.read_bits(8)?; let flags = reader.read_bits(8)?; // check zlib checksum if (cmf * 256 + flags) % 31 != 0 { return Err(Error::BadZlibHeader); } let compression_method = cmf & 0xf; let compression_info = cmf >> 4; if compression_method != 8 || compression_info > 7 { return Err(Error::BadZlibHeader); } if (flags & 0x100) != 0 { return Err(Error::BadZlibHeader); } let decompressed_size = reader.inner.header.decompressed_size(); while writer.pos < decompressed_size { let bfinal = reader.read_bits(1)?; let btype = reader.read_bits(2)?; if btype == 0 { // uncompressed block reader.bits >>= reader.bits_left % 8; reader.bits_left -= reader.bits_left % 8; let len = reader.read_bits_u16(16)?; let nlen = reader.read_bits_u16(16)?; if len ^ nlen != 0xffff { return Err(Error::BadNlen); } let len: usize = len.into(); if len > writer.slice.len() - writer.pos { return Err(Error::TooMuchData); } reader.read_aligned_bytes(&mut writer.slice[writer.pos..writer.pos + len])?; writer.pos += len; } else if btype == 1 || btype == 2 { // compressed block read_compressed_block(&mut reader, writer, btype == 2)?; } else { // 0b11 is not a valid block type return Err(Error::BadBlockType); } if bfinal != 0 { break; } } if cfg!(feature = "adler") { // Adler-32 checksum let padding = reader.bits_left % 8; if padding > 0 { reader.bits >>= padding; reader.bits_left -= padding; } // NOTE: currently `read_bits` doesn't support reads of 32 bits. let mut expected_adler = reader.read_bits(16)?; expected_adler |= reader.read_bits(16)? << 16; expected_adler = expected_adler.swap_bytes(); const BASE: u32 = 65521; let mut s1: u32 = 1; let mut s2: u32 = 0; for byte in writer.slice[..decompressed_size].iter().copied() { s1 += u32::from(byte); if s1 > BASE { s1 -= BASE; } s2 += s1; if s2 > BASE { s2 -= BASE; } } let got_adler = s2 << 16 | s1; if got_adler != expected_adler { return Err(Error::BadAdlerChecksum); } } // padding bytes reader.inner.read_to_end()?; Ok(()) } fn apply_filters(header: &ImageHeader, data: &mut [u8]) -> Result<(), Error> { let mut s = 0; let mut d = 0; let x_byte_offset = max( 1, usize::from(header.bit_depth as u8) * usize::from(header.color_type.channels()) / 8, ); let scanline_bytes = header.bytes_per_row(); for scanline in 0..header.height() { let filter = data[s]; const FILTER_NONE: u8 = 0; const FILTER_SUB: u8 = 1; const FILTER_UP: u8 = 2; const FILTER_AVG: u8 = 3; const FILTER_PAETH: u8 = 4; #[inline] fn paeth(a: u8, b: u8, c: u8) -> u8 { let p = i32::from(a) + i32::from(b) - i32::from(c); let pa = (p - i32::from(a)).abs(); let pb = (p - i32::from(b)).abs(); let pc = (p - i32::from(c)).abs(); if pa <= pb && pa <= pc { a } else if pb <= pc { b } else { c } } s += 1; data.copy_within(s..s + scanline_bytes, d); match (filter, scanline == 0) { (FILTER_NONE, _) | (FILTER_UP, true) => {} (FILTER_SUB, _) => { for i in d + x_byte_offset..d + scanline_bytes { data[i] = data[i].wrapping_add(data[i - x_byte_offset]); } } (FILTER_UP, false) => { for i in d..d + scanline_bytes { data[i] = data[i].wrapping_add(data[i - scanline_bytes]); } } (FILTER_AVG, false) => { for i in d..d + x_byte_offset { data[i] = data[i].wrapping_add(data[i - scanline_bytes] / 2); } for i in d + x_byte_offset..d + scanline_bytes { data[i] = data[i].wrapping_add( ((u32::from(data[i - scanline_bytes]) + u32::from(data[i - x_byte_offset])) / 2) as u8, ); } } (FILTER_AVG, true) => { for i in d + x_byte_offset..d + scanline_bytes { data[i] = data[i].wrapping_add(data[i - x_byte_offset] / 2); } } (FILTER_PAETH, false) => { for i in d..d + x_byte_offset { data[i] = data[i].wrapping_add(paeth(0, data[i - scanline_bytes], 0)); } for i in d + x_byte_offset..d + scanline_bytes { data[i] = data[i].wrapping_add(paeth( data[i - x_byte_offset], data[i - scanline_bytes], data[i - scanline_bytes - x_byte_offset], )); } } (FILTER_PAETH, true) => { for i in d + x_byte_offset..d + scanline_bytes { data[i] = data[i].wrapping_add(paeth(data[i - x_byte_offset], 0, 0)); } } (5.., _) => return Err(Error::BadFilter), } s += scanline_bytes; d += scanline_bytes; } Ok(()) } fn read_non_idat_chunks( reader: &mut R, header: &ImageHeader, palette: &mut [[u8; 4]; 256], ) -> Result, Error> { loop { let mut chunk_header = [0; 8]; reader.read(&mut chunk_header[..])?; let chunk_len = u32::from_be_bytes([ chunk_header[0], chunk_header[1], chunk_header[2], chunk_header[3], ]) as usize; let chunk_type = [ chunk_header[4], chunk_header[5], chunk_header[6], chunk_header[7], ]; if &chunk_type == b"IEND" { reader.skip_bytes(4)?; // CRC break; } else if &chunk_type == b"IDAT" { return Ok(Some(chunk_len)); } else if &chunk_type == b"PLTE" && header.color_type == ColorType::Indexed { if chunk_len > 256 * 3 || chunk_len % 3 != 0 { return Err(Error::BadPlteChunk); } let count = chunk_len / 3; let mut data = [0; 256 * 3]; reader.read(&mut data[..chunk_len])?; for i in 0..count { palette[i][0..3].copy_from_slice(&data[3 * i..3 * i + 3]); } // checksum reader.skip_bytes(4)?; } else if &chunk_type == b"tRNS" && header.color_type == ColorType::Indexed { if chunk_len > 256 { return Err(Error::BadTrnsChunk); } let mut data = [0; 256]; reader.read(&mut data[..chunk_len])?; for i in 0..chunk_len { palette[i][3] = data[i]; } // checksum reader.skip_bytes(4)?; } else if chunk_type[0].is_ascii_lowercase() || &chunk_type == b"PLTE" { // non-essential chunk reader.skip_bytes(chunk_len + 4)?; } else { return Err(Error::UnrecognizedChunk(chunk_type)); } } Ok(None) } /// read image data. /// /// if you are calling this after [`read_png_header`], be sure to pass the header you got /// into this function. otherwise, pass `None` for `header`. /// /// the only non-stack memory used by this function is `buf` — it should be at least /// [`ImageHeader::required_bytes()`] bytes long, otherwise an [`Error::BufferTooSmall`] /// will be returned. pub fn read_png<'a, R: Read>( reader: &mut R, header: Option<&ImageHeader>, buf: &'a mut [u8], ) -> Result, Error> { let header = match header { None => read_png_header(reader)?, Some(h) => *h, }; if buf.len() < header.required_bytes() { return Err(Error::BufferTooSmall); } let mut writer = DecompressedDataWriter::from(buf); let mut palette = [[0, 0, 0, 0]; 256]; let Some(idat_len) = read_non_idat_chunks(reader, &header, &mut palette)? else { return Err(Error::NoIdat); }; read_idat( IdatReader { inner: reader, bytes_left_in_block: idat_len, header: &header, palette: &mut palette, eof: false, }, &mut writer, )?; let buf = writer.slice; apply_filters(&header, buf)?; Ok(ImageData { buffer: buf, header, palette, }) } #[cfg(test)] mod tests { use super::*; #[cfg(feature = "std")] use std::fs::File; extern crate alloc; #[cfg(feature = "std")] fn test_file(path: &str) { let decoder = png::Decoder::new(File::open(path).expect("file not found")); let mut reader = decoder.read_info().unwrap(); let mut png_buf = alloc::vec![0; reader.output_buffer_size()]; let png_header = reader.next_frame(&mut png_buf).unwrap(); let png_bytes = &png_buf[..png_header.buffer_size()]; let mut r = std::io::BufReader::new(File::open(path).expect("file not found")); let tiny_header = read_png_header(&mut r).unwrap(); let mut tiny_buf = alloc::vec![0; tiny_header.required_bytes()]; let image = read_png(&mut r, Some(&tiny_header), &mut tiny_buf).unwrap(); let tiny_bytes = image.pixels(); assert_eq!(png_bytes.len(), tiny_bytes.len()); assert_eq!(png_bytes, tiny_bytes); } fn test_bytes(mut bytes: &[u8]) { let decoder = png::Decoder::new(bytes); let mut reader = decoder.read_info().unwrap(); let mut png_buf = alloc::vec![0; reader.output_buffer_size()]; let png_header = reader.next_frame(&mut png_buf).unwrap(); let png_bytes = &png_buf[..png_header.buffer_size()]; let tiny_header = read_png_header(&mut bytes).unwrap(); let mut tiny_buf = alloc::vec![0; tiny_header.required_bytes()]; let image = read_png(&mut bytes, Some(&tiny_header), &mut tiny_buf).unwrap(); let tiny_bytes = image.pixels(); assert_eq!(png_bytes.len(), tiny_bytes.len()); assert_eq!(png_bytes, tiny_bytes); } macro_rules! test_both { ($file:literal) => { #[cfg(feature = "std")] { test_file($file); } test_bytes(include_bytes!(concat!("../", $file))); }; } #[test] fn test_small() { test_both!("test/small.png"); } #[test] fn test_small_rgb() { test_both!("test/small_rgb.png"); } #[test] fn test_small_rgba() { test_both!("test/small_rgba.png"); } #[test] fn test_gray_alpha() { test_both!("test/gray_alpha.png"); } #[test] fn test_earth0() { test_both!("test/earth0.png"); } #[test] fn test_earth9() { test_both!("test/earth9.png"); } #[test] fn test_photograph() { test_both!("test/photograph.png"); } #[test] fn test_earth_palette() { test_both!("test/earth_palette.png"); } #[test] fn test_württemberg() { test_both!("test/württemberg.png"); } #[test] fn test_endsleigh() { test_both!("test/endsleigh.png"); } #[test] fn test_1qps() { test_both!("test/1QPS.png"); } #[test] fn test_rabbit() { test_both!("test/rabbit.png"); } #[test] fn test_basketball() { test_both!("test/basketball.png"); } #[test] fn test_triangle() { test_both!("test/triangle.png"); } #[test] fn test_iroquois() { test_both!("test/iroquois.png"); } #[test] fn test_canada() { test_both!("test/canada.png"); } #[test] fn test_berry() { test_both!("test/berry.png"); } #[test] fn test_adam() { test_both!("test/adam.png"); } #[test] fn test_nightingale() { test_both!("test/nightingale.png"); } #[test] fn test_ratatoskr() { test_both!("test/ratatoskr.png"); } #[test] fn test_cheerios() { test_both!("test/cheerios.png"); } #[test] fn test_cavendish() { test_both!("test/cavendish.png"); } #[test] fn test_ouroboros() { test_both!("test/ouroboros.png"); } #[test] fn test_bad_png() { let mut data = &b"hello"[..]; let err = read_png_header(&mut data).unwrap_err(); assert!(matches!(err, Error::NotPng)); } #[test] fn test_buffer_too_small() { let mut data = &include_bytes!("../test/ouroboros.png")[..]; let mut buffer = [0; 128]; let err = read_png(&mut data, None, &mut buffer[..]).unwrap_err(); assert!(matches!(err, Error::BufferTooSmall)); } }