refactor(doc): read Group 3 TIFF rows through craft-stream-codecs

group3_tiff_rgba decodes each strip or tile with
craft_stream_codecs::decode_ccitt_raw instead of hayro-ccitt; the error
messages stay as they were. vectorcraft-engine's group3_reference test
keeps the hayro-ccitt reader as the reference: over 190 Group 3 TIFFs and
5,500 cut or edited copies the pixels and refusals match, except that a
strip or tile wider than MAX_CCITT_COLUMNS (2^20) is refused as an
overflow where hayro-ccitt ran out of data. Needs craft-libs#1772.
This commit is contained in:
FredApps
2026-11-16 01:56:14 +01:00
parent 58174c6642
commit 273dd79442
5 changed files with 301 additions and 71 deletions
+4 -3
View File
@@ -116,9 +116,9 @@ flate2 = { version = "1", default-features = false, features = ["rust_backend"]
rustix = { version = "1.1", default-features = false }
# Zstandard decoder (pure Rust, builds for wasm32 too): the editing copy an EPS carries of its art.
ruzstd = { version = "0.9.1", default-features = false, features = ["std"] }
# vectorcraft-doc's CMYK TIFF reader and writer (src/cmyk.rs) and its Group 3 TIFF reader still use
# `tiff` and `hayro-ccitt`; `zune-jpeg` is only the reference vectorcraft-doc's tests compare
# craft-image-codecs' CMYK JPEG inks with.
# vectorcraft-doc's CMYK TIFF reader and writer (src/cmyk.rs) still use `tiff`. `zune-jpeg` and
# `hayro-ccitt` are only the references tests compare craft-image-codecs' CMYK JPEG inks and
# craft-stream-codecs' Group 3 rows with (vectorcraft-doc's and vectorcraft-engine's dev-dependencies).
tiff = "0.11"
zune-jpeg = "0.5"
hayro-ccitt = "0.3"
@@ -193,3 +193,4 @@ eframe = { git = "https://github.com/storytold/egui.git", rev = "6d518fc79968157
egui_demo_lib = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" }
egui_inspection = { git = "https://github.com/storytold/egui.git", rev = "6d518fc799681571963842f95b55a6b68431b15a" }
winit = { git = "https://github.com/storytold/winit.git", rev = "a517b3846ee8457d84ee4975110bfda6797c44dc" }
+1 -1
View File
@@ -21,7 +21,7 @@ image = { workspace = true }
craft-image-codecs = { workspace = true }
tiff = { workspace = true }
# 1-bit TIFFs compressed with CCITT Group 3 (Compression 2 and 3).
hayro-ccitt = { workspace = true }
craft-stream-codecs = { workspace = true }
serde = { workspace = true }
serde_json = { workspace = true }
thiserror = { workspace = true }
+52 -67
View File
@@ -1073,9 +1073,20 @@ pub enum Group3Error {
TooLarge { w: u32, h: u32 },
/// A strip or tile ends before its last row or can't be decoded (it holds a code the decoder
/// doesn't read, such as T.4's uncompressed mode, or a row of the wrong width), or a tile is
/// larger than [`crate::MAX_RASTER_ALLOC`] allows as RGBA.
#[error("could not decode image: {0}")]
Damaged(hayro_ccitt::DecodeError),
/// larger than [`crate::MAX_RASTER_ALLOC`] allows as RGBA, or is wider than
/// [`craft_stream_codecs::MAX_CCITT_COLUMNS`].
#[error("could not decode image: {}", damage(*.0))]
Damaged(craft_stream_codecs::CcittErrorKind),
}
/// What went wrong in a Group 3 strip or tile, as [`Group3Error::Damaged`] says it.
fn damage(kind: craft_stream_codecs::CcittErrorKind) -> &'static str {
use craft_stream_codecs::CcittErrorKind as K;
match kind {
K::UnexpectedEof => "unexpected end of input",
K::Overflow => "arithmetic overflow in position calculation",
K::InvalidData => "invalid CCITT code sequence",
}
}
/// The pixels of a 1-bit TIFF compressed with CCITT Group 3, which the image decoder doesn't read,
@@ -1090,7 +1101,7 @@ pub enum Group3Error {
/// an error when the pixels would take more than [`crate::MAX_RASTER_ALLOC`] as RGBA, a tile is
/// larger than that allowance, or a strip or tile can't be decoded or ends before its last row.
pub fn group3_tiff_rgba(bytes: &[u8]) -> Option<Result<image::RgbaImage, Group3Error>> {
use hayro_ccitt::{DecodeError, DecodeSettings, DecoderContext, EncodingMode};
use craft_stream_codecs::{CcittErrorKind as DecodeError, CcittParams, decode_ccitt_raw};
use tiff::tags::Tag;
let (kind, mut d) = tiff(bytes)?;
let compression = d.find_tag_unsigned::<u16>(Tag::Compression).ok().flatten()?;
@@ -1109,12 +1120,8 @@ pub fn group3_tiff_rgba(bytes: &[u8]) -> Option<Result<image::RgbaImage, Group3E
}
let t4_options = d.find_tag_unsigned::<u32>(Tag::Unknown(292)).ok().flatten().unwrap_or(0);
let lsb_first = d.find_tag_unsigned::<u16>(Tag::FillOrder).ok().flatten() == Some(2);
let encoding = if compression == 3 && t4_options & 1 != 0 {
// Each row's tag bit says how it is coded.
EncodingMode::Group3_2D { k: 2 }
} else {
EncodingMode::Group3_1D
};
// Each row's tag bit says how it is coded (K above 0), or every row is one-dimensional (K 0).
let k = if compression == 3 && t4_options & 1 != 0 { 2 } else { 0 };
// The width and height of each strip or tile, and the tags of their offsets and byte counts.
let tiled = d.get_chunk_type() == tiff::decoder::ChunkType::Tile;
let (cw, ch, offsets, counts) = if tiled {
@@ -1148,76 +1155,54 @@ pub fn group3_tiff_rgba(bytes: &[u8]) -> Option<Result<image::RgbaImage, Group3E
budget -= len;
let data = bytes.get(start..start + len)?;
let data: std::borrow::Cow<[u8]> = if lsb_first { data.iter().map(|b| b.reverse_bits()).collect() } else { data.into() };
let settings = DecodeSettings {
columns: cw,
// A tile is coded whole; the last strip only has the image's remaining rows.
rows: if tiled { ch } else { ch.min(h - y0) },
end_of_block: compression == 3,
// A tile is coded whole; the last strip only has the image's remaining rows.
let rows = if tiled { ch } else { ch.min(h - y0) };
let params = CcittParams {
k,
columns: i64::from(cw),
rows: i64::from(rows),
end_of_line: compression == 3,
rows_are_byte_aligned: compression == 2,
encoding,
invert_black: false,
encoded_byte_align: compression == 2,
end_of_block: compression == 3,
// 1 bits are black runs, 0 bits white ones.
black_is_1: true,
};
let mut rows = Rows { out: &mut gray, width: w, height: h, x0, y0, x: 0, y: 0, zero };
if let Err(e) = hayro_ccitt::decode(&data, &mut rows, &mut DecoderContext::new(settings)) {
let Ok(out) = decode_ccitt_raw(&data, &params, rows) else {
// Wider than the decoder reads.
return damaged(DecodeError::Overflow);
};
if let Some(e) = out.error {
return damaged(e);
}
// The data ended, or six EOL codes came, before the strip's or tile's last row.
if rows.y < settings.rows {
if out.rows_decoded < rows {
return damaged(DecodeError::UnexpectedEof);
}
put_rows(&mut gray, (w, h), (x0, y0), cw, &out.data, zero);
}
let gray = image::GrayImage::from_raw(w, h, gray)?;
Some(Ok(image::DynamicImage::ImageLuma8(gray).to_rgba8()))
}
/// Where a strip or tile of a Group 3 TIFF ([`group3_tiff_rgba`]) puts its decoded pixels: `out`
/// holds the image's levels row by row, `width` × `height`, and the strip or tile starts at (`x0`,
/// `y0`). Pixels past the image's right or bottom edge (a tile's padding) are dropped.
struct Rows<'a> {
out: &'a mut [u8],
width: u32,
height: u32,
x0: u32,
y0: u32,
/// The next pixel in the strip or tile.
x: u64,
y: u32,
/// The level of a white run.
zero: u8,
}
impl Rows<'_> {
/// The next `n` pixels of the row, a white run's or a black run's.
fn run(&mut self, white: bool, n: u64) {
let level = if white { self.zero } else { u8::MAX - self.zero };
let row = u64::from(self.y0) + u64::from(self.y);
let left = u64::from(self.x0) + self.x;
let right = left.saturating_add(n).min(u64::from(self.width));
if row < u64::from(self.height) && left < right {
let at = row * u64::from(self.width);
if let (Ok(a), Ok(b)) = (usize::try_from(at + left), usize::try_from(at + right))
&& let Some(px) = self.out.get_mut(a..b)
{
px.fill(level);
}
/// The decoded rows `packed` of a strip or tile of a Group 3 TIFF ([`group3_tiff_rgba`]), `columns`
/// wide, one bit a pixel (1 a black run's), put into `out`, the image's levels row by row, `size`
/// (width, height), from (`x0`, `y0`): a 0 bit as `zero` (the level of a white run), a 1 bit as the
/// other level. Pixels past the image's right or bottom edge (a tile's padding) are dropped.
fn put_rows(out: &mut [u8], size: (u32, u32), (x0, y0): (u32, u32), columns: u32, packed: &[u8], zero: u8) {
let (width, height) = (size.0 as usize, size.1 as usize);
let (x0, y0, columns) = (x0 as usize, y0 as usize, columns as usize);
let stride = columns.div_ceil(8);
if stride == 0 {
return;
}
let across = columns.min(width.saturating_sub(x0));
for (y, row) in packed.chunks(stride).enumerate() {
let Some(at) = (y0 + y < height).then(|| (y0 + y) * width + x0) else { break };
let Some(px) = out.get_mut(at..at + across) else { break };
for (x, p) in px.iter_mut().enumerate() {
let black = row.get(x / 8).is_some_and(|b| b & (0x80 >> (x % 8)) != 0);
*p = if black { u8::MAX - zero } else { zero };
}
self.x = self.x.saturating_add(n);
}
}
impl hayro_ccitt::Decoder for Rows<'_> {
fn push_pixel(&mut self, white: bool) {
self.run(white, 1);
}
fn push_pixel_chunk(&mut self, white: bool, chunk_count: u32) {
self.run(white, u64::from(chunk_count) * 8);
}
fn next_line(&mut self) {
self.y = self.y.saturating_add(1);
self.x = 0;
}
}
+5
View File
@@ -70,6 +70,11 @@ rustix = { workspace = true, features = ["std", "process"] }
same-file = "1.0.6"
[dev-dependencies]
# vectorcraft-doc's Group 3 TIFF reader before craft-stream-codecs, the reference
# tests/group3_reference.rs compares it with.
hayro-ccitt = { workspace = true }
tiff = { workspace = true }
craft-stream-codecs = { workspace = true }
vectorcraft-affinity = { workspace = true, features = ["synth"] }
crc32fast = { workspace = true }
vectorcraft-testkit = { workspace = true }
+239
View File
@@ -0,0 +1,239 @@
//! vectorcraft-doc's Group 3 TIFF reader (`cmyk::group3_tiff_rgba`) reads CCITT data through
//! craft-stream-codecs; this keeps the reader it had on hayro-ccitt as the reference it matches.
use vectorcraft_doc::cmyk::{Group3Error, group3_tiff_rgba};
use vectorcraft_testkit::tiff::{Group3, group3};
/// What the reference refused a file for, as [`Group3Error`] says it.
#[derive(Debug, PartialEq)]
enum Refused {
TooLarge,
Damaged(craft_stream_codecs::CcittErrorKind),
}
fn kind_of(e: hayro_ccitt::DecodeError) -> craft_stream_codecs::CcittErrorKind {
use craft_stream_codecs::CcittErrorKind as K;
match e {
hayro_ccitt::DecodeError::UnexpectedEof => K::UnexpectedEof,
hayro_ccitt::DecodeError::Overflow => K::Overflow,
_ => K::InvalidData,
}
}
/// `group3_tiff_rgba` as it read before craft-stream-codecs.
fn reference(bytes: &[u8]) -> Option<Result<image::RgbaImage, Refused>> {
use hayro_ccitt::{DecodeError, DecodeSettings, DecoderContext, EncodingMode};
use tiff::tags::Tag;
if !(bytes.starts_with(b"II*\0") || bytes.starts_with(b"MM\0*")) || vectorcraft_doc::cmyk::oversized_tiff(bytes).is_some() {
return None;
}
let mut d = tiff::decoder::Decoder::new(std::io::Cursor::new(bytes)).ok()?;
let kind = d.colortype().ok()?;
let compression = d.find_tag_unsigned::<u16>(Tag::Compression).ok().flatten()?;
let (w, h) = d.dimensions().ok()?;
if kind != tiff::ColorType::Gray(1) || !matches!(compression, 2 | 3) || w == 0 || h == 0 {
return None;
}
// The level of a 0 bit (a white run): white when white is zero (0), black when black is zero (1).
let zero = match d.find_tag_unsigned::<u16>(Tag::PhotometricInterpretation).ok().flatten() {
Some(0) => u8::MAX,
Some(1) => 0,
_ => return None,
};
if u64::from(w) * u64::from(h) > vectorcraft_doc::MAX_RASTER_ALLOC / 4 {
return Some(Err(Refused::TooLarge));
}
let t4_options = d.find_tag_unsigned::<u32>(Tag::Unknown(292)).ok().flatten().unwrap_or(0);
let lsb_first = d.find_tag_unsigned::<u16>(Tag::FillOrder).ok().flatten() == Some(2);
let encoding = if compression == 3 && t4_options & 1 != 0 {
// Each row's tag bit says how it is coded.
EncodingMode::Group3_2D { k: 2 }
} else {
EncodingMode::Group3_1D
};
// The width and height of each strip or tile, and the tags of their offsets and byte counts.
let tiled = d.get_chunk_type() == tiff::decoder::ChunkType::Tile;
let (cw, ch, offsets, counts) = if tiled {
let tw = d.find_tag_unsigned::<u32>(Tag::TileWidth).ok().flatten().filter(|&v| v > 0)?;
let th = d.find_tag_unsigned::<u32>(Tag::TileLength).ok().flatten().filter(|&v| v > 0)?;
(tw, th, Tag::TileOffsets, Tag::TileByteCounts)
} else {
let rows = d.find_tag_unsigned::<u32>(Tag::RowsPerStrip).ok().flatten().filter(|&v| v > 0).map_or(h, |r| r.min(h));
(w, rows, Tag::StripOffsets, Tag::StripByteCounts)
};
let damaged = |e: DecodeError| Some(Err(Refused::Damaged(kind_of(e))));
// A tile is held to the allowance the image is held to; a strip is no larger than the image.
if u64::from(cw) * u64::from(ch) > vectorcraft_doc::MAX_RASTER_ALLOC / 4 {
return damaged(DecodeError::Overflow);
}
let offsets = d.find_tag_unsigned_vec::<u64>(offsets).ok().flatten().unwrap_or_default();
let counts = d.find_tag_unsigned_vec::<u64>(counts).ok().flatten().unwrap_or_default();
let across = w.div_ceil(cw);
let chunks = u64::from(across) * u64::from(h.div_ceil(ch));
if chunks > offsets.len().min(counts.len()) as u64 {
return damaged(DecodeError::UnexpectedEof);
}
let mut gray = vec![zero; usize::try_from(u64::from(w) * u64::from(h)).ok()?];
let mut budget = bytes.len();
for (i, (&offset, &count)) in (0..chunks).zip(offsets.iter().zip(&counts)) {
let (x0, y0) = (u32::try_from(i % u64::from(across)).ok()? * cw, u32::try_from(i / u64::from(across)).ok()? * ch);
let Some(start) = usize::try_from(offset).ok().filter(|&s| s <= bytes.len()) else {
return damaged(DecodeError::UnexpectedEof);
};
let len = usize::try_from(count).unwrap_or(usize::MAX).min(bytes.len() - start).min(budget);
budget -= len;
let data = bytes.get(start..start + len)?;
let data: std::borrow::Cow<[u8]> = if lsb_first { data.iter().map(|b| b.reverse_bits()).collect() } else { data.into() };
let settings = DecodeSettings {
columns: cw,
// A tile is coded whole; the last strip only has the image's remaining rows.
rows: if tiled { ch } else { ch.min(h - y0) },
end_of_block: compression == 3,
end_of_line: compression == 3,
rows_are_byte_aligned: compression == 2,
encoding,
invert_black: false,
};
let mut rows = Rows { out: &mut gray, width: w, height: h, x0, y0, x: 0, y: 0, zero };
if let Err(e) = hayro_ccitt::decode(&data, &mut rows, &mut DecoderContext::new(settings)) {
return damaged(e);
}
// The data ended, or six EOL codes came, before the strip's or tile's last row.
if rows.y < settings.rows {
return damaged(DecodeError::UnexpectedEof);
}
}
let gray = image::GrayImage::from_raw(w, h, gray)?;
Some(Ok(image::DynamicImage::ImageLuma8(gray).to_rgba8()))
}
/// Where a strip or tile of a Group 3 TIFF ([`group3_tiff_rgba`]) puts its decoded pixels: `out`
/// holds the image's levels row by row, `width` × `height`, and the strip or tile starts at (`x0`,
/// `y0`). Pixels past the image's right or bottom edge (a tile's padding) are dropped.
struct Rows<'a> {
out: &'a mut [u8],
width: u32,
height: u32,
x0: u32,
y0: u32,
/// The next pixel in the strip or tile.
x: u64,
y: u32,
/// The level of a white run.
zero: u8,
}
impl Rows<'_> {
/// The next `n` pixels of the row, a white run's or a black run's.
fn run(&mut self, white: bool, n: u64) {
let level = if white { self.zero } else { u8::MAX - self.zero };
let row = u64::from(self.y0) + u64::from(self.y);
let left = u64::from(self.x0) + self.x;
let right = left.saturating_add(n).min(u64::from(self.width));
if row < u64::from(self.height) && left < right {
let at = row * u64::from(self.width);
if let (Ok(a), Ok(b)) = (usize::try_from(at + left), usize::try_from(at + right))
&& let Some(px) = self.out.get_mut(a..b)
{
px.fill(level);
}
}
self.x = self.x.saturating_add(n);
}
}
impl hayro_ccitt::Decoder for Rows<'_> {
fn push_pixel(&mut self, white: bool) {
self.run(white, 1);
}
fn push_pixel_chunk(&mut self, white: bool, chunk_count: u32) {
self.run(white, u64::from(chunk_count) * 8);
}
fn next_line(&mut self) {
self.y = self.y.saturating_add(1);
self.x = 0;
}
}
fn read(bytes: &[u8]) -> Option<Result<image::RgbaImage, Refused>> {
group3_tiff_rgba(bytes).map(|r| {
r.map_err(|e| match e {
Group3Error::TooLarge { .. } => Refused::TooLarge,
Group3Error::Damaged(k) => Refused::Damaged(k),
})
})
}
/// Group 3 TIFFs of every kind the reader takes: Compression 2 and 3, one- and two-dimensional
/// rows, fill bits, each byte's lowest bit first, white or black as zero, strips of a few rows
/// or one, tiles, with and without six EOLs at the end; their rows of many patterns and widths.
fn samples() -> Vec<Vec<u8>> {
let mut files = Vec::new();
for (width, height) in [(1usize, 1usize), (7, 3), (40, 6), (64, 17), (131, 9)] {
let rows: Vec<Vec<bool>> = (0..height).map(|y| (0..width).map(|x| (x * (y + 1) / 3 + y + x / 7) % 4 < 2).collect()).collect();
for (compression, t4_options) in [(2u16, 0u32), (3, 0), (3, 1), (3, 4), (3, 5)] {
for (photometric, fill_order) in [(0u16, 1u16), (1, 2)] {
for (rows_per_strip, tile) in [(1u32, None), (2, None), (64, None), (64, Some((16u32, 16u32)))] {
if tile.is_some() && compression == 2 {
continue;
}
let rtc = compression == 3 && rows_per_strip != 2;
let g = Group3 { rows: &rows, compression, t4_options, photometric, fill_order, rows_per_strip, tile, rtc };
files.push(group3(&g));
}
}
}
}
files
}
/// Every sample, and every sample cut short or with bytes changed, reads to the same pixels or is
/// refused for the same reason as with the reference; strips or tiles wider than
/// `craft_stream_codecs::MAX_CCITT_COLUMNS` (2^20) are refused as an overflow where the reference
/// gave another reason.
#[test]
fn group3_tiffs_read_as_the_hayro_reader_read_them() {
let files = samples();
use craft_stream_codecs::CcittErrorKind::Overflow;
let (mut same, mut refused, mut checked, mut wider) = (0, 0, 0, 0);
for (n, file) in files.iter().enumerate() {
let theirs = reference(file);
assert!(theirs.as_ref().is_some_and(|r| r.is_ok()), "sample {n} reads");
let mut variants = vec![file.clone()];
for cut in [file.len() - 1, file.len() - 3, file.len() * 3 / 4, file.len() / 2] {
variants.push(file[..cut].to_vec());
}
for k in 0..24usize {
let mut v = file.clone();
let at = (k * 2_654_435_761 + n * 97) % v.len();
v[at] ^= 1 << (k % 8);
variants.push(v);
}
for v in variants {
let (ours, theirs) = (read(&v), reference(&v));
match (&ours, &theirs) {
(Some(Ok(a)), Some(Ok(b))) => {
assert!(a == b, "sample {n}: other pixels");
same += 1;
}
_ => {
let (ours, theirs) = (ours.map(|r| r.err()), theirs.map(|r| r.err()));
// A strip or tile wider than craft-stream-codecs reads (MAX_CCITT_COLUMNS)
// is refused as an overflow before decoding; hayro-ccitt ran out of data or
// found a bad code in it instead.
let wide = matches!((&ours, &theirs), (Some(Some(Refused::Damaged(Overflow))), Some(Some(Refused::Damaged(_)))));
assert!(ours == theirs || wide, "sample {n}: {ours:?}, reference {theirs:?}");
wider += usize::from(ours != theirs);
refused += 1;
}
}
checked += 1;
}
}
assert!(
same > files.len() && refused > files.len() && wider < refused / 10,
"{same} read, {refused} refused ({wider} as wider than read) of {checked}"
);
}