Skip to content

Commit

Permalink
Increase PNG compression level (#817)
Browse files Browse the repository at this point in the history
This commit increases the compression level for when we encode PNG
images. We do this for Llanfair files (Gered and original) were the
images are uncompressed and also for when we encounter BMP images in
LiveSplit files or we scale down images. Increasing the compression
level doesn't seem to really take much more time, but has a decent
impact on the size of the images.
  • Loading branch information
CryZe authored Jun 14, 2024
1 parent a33c167 commit 7786111
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 18 deletions.
4 changes: 2 additions & 2 deletions src/run/parser/llanfair.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use crate::{
};
use core::{result::Result as StdResult, str};
#[cfg(feature = "std")]
use image::{codecs::png, ExtendedColorType, ImageBuffer, ImageEncoder, Rgba};
use image::{ExtendedColorType, ImageBuffer, ImageEncoder, Rgba};
use snafu::{OptionExt, ResultExt};

/// The Error type for splits files that couldn't be parsed by the Llanfair
Expand Down Expand Up @@ -187,7 +187,7 @@ pub fn parse(source: &[u8]) -> Result<Run> {
#[cfg(feature = "std")]
if let Some(image) = ImageBuffer::<Rgba<u8>, _>::from_raw(width, height, _image_data) {
buf.clear();
if png::PngEncoder::new(&mut buf)
if crate::util::image::create_reencoder(&mut buf)
.write_image(image.as_ref(), width, height, ExtendedColorType::Rgba8)
.is_ok()
{
Expand Down
4 changes: 2 additions & 2 deletions src/run/parser/llanfair_gered.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::{
RealTime, Run, Segment, Time, TimeSpan,
};
#[cfg(feature = "std")]
use image::{codecs::png, ExtendedColorType, ImageEncoder};
use image::{ExtendedColorType, ImageEncoder};
#[cfg(feature = "std")]
use snafu::OptionExt;

Expand Down Expand Up @@ -123,7 +123,7 @@ where
})?;

png_buf.clear();
png::PngEncoder::new(&mut *png_buf)
crate::util::image::create_reencoder(&mut *png_buf)
.write_image(image, width, height, ExtendedColorType::Rgba8)
.map_err(|_| Error::Image)?;

Expand Down
7 changes: 5 additions & 2 deletions src/settings/image/shrinking.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use alloc::borrow::Cow;
use image::{guess_format, load_from_memory_with_format, ImageEncoder, ImageFormat};

use crate::util::image::get_dimensions;
use crate::util::image::{create_reencoder, get_dimensions};

fn shrink_inner(data: &[u8], max_dim: u32) -> Option<Cow<'_, [u8]>> {
let format = guess_format(data).ok()?;
Expand All @@ -27,15 +27,18 @@ fn shrink_inner(data: &[u8], max_dim: u32) -> Option<Cow<'_, [u8]>> {
if is_too_large {
image = image.thumbnail(max_dim, max_dim);
}

let mut data = Vec::new();
image::codecs::png::PngEncoder::new(&mut data)

create_reencoder(&mut data)
.write_image(
image.as_bytes(),
image.width(),
image.height(),
image.color().into(),
)
.ok()?;

data.into()
} else {
data.into()
Expand Down
23 changes: 15 additions & 8 deletions src/util/image.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
use std::io::Cursor;
use image::codecs::png::{CompressionType, FilterType, PngEncoder};

use bytemuck_derive::{Pod, Zeroable};
use image::{
codecs::{bmp, farbfeld, hdr, ico, jpeg, pnm, tga, tiff, webp},
ImageDecoder, ImageFormat,
};
pub fn create_reencoder(target_buf: &mut Vec<u8>) -> PngEncoder<&mut Vec<u8>> {
PngEncoder::new_with_quality(target_buf, CompressionType::Best, FilterType::default())
}

#[cfg(any(feature = "image-shrinking", feature = "svg-rendering"))]
pub fn get_dimensions(format: image::ImageFormat, data: &[u8]) -> Option<(u32, u32)> {
use std::io::Cursor;

use bytemuck_derive::{Pod, Zeroable};
use image::{
codecs::{bmp, farbfeld, hdr, ico, jpeg, pnm, tga, tiff, webp},
ImageDecoder, ImageFormat,
};

use crate::util::byte_parsing::{big_endian::U32, strip_pod};
use crate::util::byte_parsing::{big_endian::U32, strip_pod};

pub fn get_dimensions(format: ImageFormat, data: &[u8]) -> Option<(u32, u32)> {
Some(match format {
ImageFormat::Png => {
// We encounter a lot of PNG images in splits files and decoding
Expand Down
2 changes: 1 addition & 1 deletion src/util/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pub(crate) mod ascii_set;
pub(crate) mod byte_parsing;
pub(crate) mod caseless;
mod clear_vec;
#[cfg(any(feature = "image-shrinking", feature = "svg-rendering"))]
#[cfg(feature = "std")]
pub(crate) mod image;
pub(crate) mod not_nan;
pub mod ordered_map;
Expand Down
6 changes: 3 additions & 3 deletions tests/rendering.rs
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ fn all_components() {
&image_cache,
[300, 800],
"7e7aa83a3b80e1da",
"39b5d1923053c5d9",
"fa3c0357219389d8",
"all_components",
);

Expand All @@ -263,7 +263,7 @@ fn all_components() {
&image_cache,
[150, 800],
"97afa51bfd8a8597",
"82b26ae781d58b78",
"eda169eec3995eeb",
"all_components_thin",
);
}
Expand Down Expand Up @@ -308,7 +308,7 @@ fn dark_layout() {
&layout.state(&mut image_cache, &timer.snapshot()),
&image_cache,
"a47c590792c1bab5",
"3f8dfb2da2d43648",
"91a89f563eb4f43d",
"dark_layout",
);
}
Expand Down

0 comments on commit 7786111

Please sign in to comment.