Skip to content

feat: tiff support #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ananasmoe wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: tiff support #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
01860e6
feat: tiff support
ananasmoe Dec 25, 2025
7bc5075
style: disable rustfmt and reformat code style back to preferred style
THEGOLDENPRO Dec 25, 2025
c649308
feat: remove unused deps
THEGOLDENPRO Dec 25, 2025
b70a346
feat: set some formatting rules
THEGOLDENPRO Dec 25, 2025
4db1fa8
Merge branch 'main' into feat/tiff-support
THEGOLDENPRO Dec 28, 2025
7021a05
fix: missing imports, tiff test incorrect
THEGOLDENPRO Dec 28, 2025
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
4 changes: 2 additions & 2 deletions core/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ svg_metadata = "0.5.1"
kamadak-exif = "0.6.1"

# decoder backends
image = {version = "0.25.9", features = ["rayon", "png", "jpeg", "gif", "webp"], default-features = false}
image = {version = "0.25.9", features = ["rayon", "png", "jpeg", "gif", "webp", "tiff"], default-features = false}
zune-image = {version = "0.4.15", features = ["threads", "simd", "metadata", "png", "jpeg", "jpeg-xl"], default-features = false}

[dev-dependencies]
env_logger = "0.11"
env_logger = "0.11"
176 changes: 102 additions & 74 deletions core/src/backends/image_rs/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
use std::{collections::HashSet, io::BufReader};

use image::{AnimationDecoder, ImageDecoder, ImageError, codecs::{gif::GifDecoder, jpeg::JpegDecoder, png::PngDecoder, webp::WebPDecoder}};
use image::{
AnimationDecoder, ImageDecoder, ImageError, codecs::{
gif::GifDecoder, jpeg::JpegDecoder, png::PngDecoder, tiff::TiffDecoder, webp::WebPDecoder,
},
};
use log::debug;

use crate::{backends::{backend::DecodeBackend, image_rs::buffer_image::{BufferImage, BufferImageVariant}}, colour_type::{self, ImageColourType}, decoded_image::{DecodedImage, DecodedImageContent, ImageSize, Pixels}, error::{Error, Result}, format::ImageFormat, image_info::metadata::ImageMetadata, modifications::{ImageModification, ImageModifications}, reader::{ImageReader, ImageReaderData, ReadSeek}};
use crate::{
backends::{backend::DecodeBackend, image_rs::buffer_image::{BufferImage, BufferImageVariant}}, colour_type::ImageColourType, decoded_image::{DecodedImage, DecodedImageContent, ImageSize, Pixels}, error::{Error, Result}, format::ImageFormat, image_info::metadata::ImageMetadata, modifications::{ImageModification, ImageModifications}, reader::{ImageReader, ImageReaderData, ReadSeek}
};

mod colour;
mod buffer_image;
Expand All @@ -16,11 +22,12 @@ enum Decoder {
Jpeg(JpegDecoder<BufReader<Box<dyn ReadSeek>>>),
Webp(WebPDecoder<BufReader<Box<dyn ReadSeek>>>),
Gif(GifDecoder<BufReader<Box<dyn ReadSeek>>>),
Tiff(TiffDecoder<BufReader<Box<dyn ReadSeek>>>),
}

enum Buffer {
Image(BufferImage),
Animation((Vec<(BufferImage, f32)>, ImageSize, ImageColourType))
Animation((Vec<(BufferImage, f32)>, ImageSize, ImageColourType)),
}

enum Source {
Expand All @@ -41,28 +48,30 @@ impl DecodeBackend for ImageRSBackend {
ImageReaderData::BufReader(buf_reader) => {
log::debug!("Initializing image-rs backend decoders with buf reader...");

let error_func = |error: ImageError| {
Error::DecoderInitFailure { error: error.to_string() }
let error_func = |error: ImageError| Error::DecoderInitFailure {
error: error.to_string(),
};

let mut image_decoder = match image_reader.image_format {
ImageFormat::Gif => Decoder::Gif(GifDecoder::new(buf_reader).map_err(error_func)?),
ImageFormat::Png => Decoder::Png(PngDecoder::new(buf_reader).map_err(error_func)?),
ImageFormat::Jpeg => Decoder::Jpeg(JpegDecoder::new(buf_reader).map_err(error_func)?),
ImageFormat::Webp => Decoder::Webp(WebPDecoder::new(buf_reader).map_err(error_func)?),
unsupported_format => return Err(
Error::DecoderNotSupported {
ImageFormat::Tiff => Decoder::Tiff(TiffDecoder::new(buf_reader).map_err(error_func)?),
unsupported_format => {
return Err(Error::DecoderNotSupported {
image_format: unsupported_format.to_string(),
backend: String::from("image-rs")
}
)
backend: String::from("image-rs"),
});
}
};

let exif_chunk = match &mut image_decoder {
Decoder::Png(png_decoder) => png_decoder.exif_metadata(),
Decoder::Jpeg(jpeg_decoder) => jpeg_decoder.exif_metadata(),
Decoder::Webp(web_pdecoder) => web_pdecoder.exif_metadata(),
Decoder::Gif(gif_decoder) => gif_decoder.exif_metadata(),
Decoder::Tiff(tiff_decoder) => tiff_decoder.exif_metadata(),
}.map_err(|error| Error::DecoderRetrieveExifFailure { error: error.to_string() })?;

Ok(
Expand All @@ -83,7 +92,7 @@ impl DecodeBackend for ImageRSBackend {
let image_buffer = BufferImage::from_u8_pixels(
pixels,
decoded_image.size,
decoded_image.colour_type
decoded_image.colour_type,
)?;

Ok(
Expand All @@ -103,7 +112,7 @@ impl DecodeBackend for ImageRSBackend {
let image_buffer = BufferImage::from_u8_pixels(
pixels,
decoded_image.size,
decoded_image.colour_type
decoded_image.colour_type,
)?;

animated_buffers.push((image_buffer, delay));
Expand All @@ -112,91 +121,101 @@ impl DecodeBackend for ImageRSBackend {
Ok(
Self {
source: Source::Buffer(
Buffer::Animation(
(animated_buffers, decoded_image.size, decoded_image.colour_type)
)
Buffer::Animation((
animated_buffers,
decoded_image.size,
decoded_image.colour_type
))
),
modifications: HashSet::new(),
image_exif_chunk: None,
image_format: image_reader.image_format
}
)
},
}
}
},
}
}
}

fn modify<I>(&mut self, modifications: I)
where
I: IntoIterator<Item = ImageModification>
I: IntoIterator<Item = ImageModification>,
{
self.modifications.extend(modifications);
}

fn decode(self) -> Result<DecodedImage> {
match self.source {
Source::Decoder(decoder) => {
match decoder {
Decoder::Png(png_decoder) => {
let has_animation = png_decoder.is_apng().map_err(
|error| Error::DecoderAnimationCheckFailure {
error: error.to_string()
}
)?;
Source::Decoder(decoder) => match decoder {
Decoder::Png(png_decoder) => {
let has_animation = png_decoder.is_apng().map_err(|error| {
Error::DecoderAnimationCheckFailure {
error: error.to_string(),
}
})?;

match has_animation {
true => {
let apng_decoder = png_decoder.apng()
.expect("We should have been given the image-rs APNG Decoder but we weren't!");

Self::decode_animated_image(
apng_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
)
},
false => Self::decode_image(
png_decoder,
match has_animation {
true => {
let apng_decoder = png_decoder.apng()
.expect("We should have been given the image-rs APNG Decoder but we weren't!");

Self::decode_animated_image(
apng_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
)
}
},
Decoder::Webp(webp_decoder) => {
match webp_decoder.has_animation() {
true => Self::decode_animated_image(
webp_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
false => Self::decode_image(
webp_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
}
},
Decoder::Gif(gif_decoder) => Self::decode_animated_image(
gif_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
Decoder::Jpeg(jpeg_decoder) => Self::decode_image(
jpeg_decoder,
},
false => Self::decode_image(
png_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
)
}
},
Decoder::Webp(webp_decoder) => {
match webp_decoder.has_animation() {
true => Self::decode_animated_image(
webp_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
false => Self::decode_image(
webp_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
}
},
Decoder::Gif(gif_decoder) => Self::decode_animated_image(
gif_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
Decoder::Jpeg(jpeg_decoder) => Self::decode_image(
jpeg_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
Decoder::Tiff(tiff_decoder) => {
Self::decode_image(
tiff_decoder,
self.modifications,
self.image_format,
self.image_exif_chunk
),
)
}
},
Source::Buffer(buffer) => {
log::debug!("Image already decoded and constructed as image-rs image buffer, applying modifications...");
log::debug!(
"Image already decoded and constructed as image-rs image buffer, applying modifications..."
);

match buffer {
Buffer::Image(mut buffer_image) => {
Expand All @@ -220,7 +239,10 @@ impl DecodeBackend for ImageRSBackend {
for (index, (mut buffer_image, delay)) in buffer_image_frames.into_iter().enumerate() {
debug!("Applying modifications to frame {}...", index);

Self::apply_modifications_to_buffer_image(self.modifications.clone(), &mut buffer_image);
Self::apply_modifications_to_buffer_image(
self.modifications.clone(),
&mut buffer_image,
);

let (pixels, _, _) = buffer_image.to_u8_pixels();

Expand Down Expand Up @@ -264,8 +286,11 @@ impl ImageRSBackend {
let frame = frame_result.map_err(
// NOTE: I might change this to a less generic error.
|error| Error::DecodingFailure {
error: format!("Image-rs decoder failed to decode animated frame: {}", error.to_string())
}
error: format!(
"Image-rs decoder failed to decode animated frame: {}",
error.to_string()
),
},
)?;

let (numerator, denominator) = frame.delay().numer_denom_ms();
Expand Down Expand Up @@ -328,8 +353,11 @@ impl ImageRSBackend {
return Err(
// NOTE: I might change this to a less generic error.
Error::DecodingFailure {
error: format!("Image-rs decoder failed to decode image to pixels: {}", error.to_string()),
}
error: format!(
"Image-rs decoder failed to decode image to pixels: {}",
error.to_string()
),
},
);
}

Expand Down Expand Up @@ -395,4 +423,4 @@ impl ImageRSBackend {
None => ImageMetadata::default(),
}
}
}
}
Loading