#png #codec #encoder #decoder #cargo-toml #encoding

lodepng

Reading and writing PNG files without system dependencies. Pure Rust port of LodePNG.

43 stable releases

3.10.1 Jan 22, 2024
3.9.2 Nov 20, 2023
3.7.2 Oct 12, 2022
3.7.0 Jun 26, 2022
0.3.1 Feb 8, 2015

#44 in Images

Download history 7077/week @ 2024-01-31 7515/week @ 2024-02-07 8829/week @ 2024-02-14 10880/week @ 2024-02-21 8680/week @ 2024-02-28 9315/week @ 2024-03-06 6711/week @ 2024-03-13 6665/week @ 2024-03-20 5673/week @ 2024-03-27 6536/week @ 2024-04-03 7382/week @ 2024-04-10 5937/week @ 2024-04-17 6187/week @ 2024-04-24 7764/week @ 2024-05-01 6014/week @ 2024-05-08 5403/week @ 2024-05-15

26,406 downloads per month
Used in 62 crates (35 directly)

Zlib license

225KB
5K SLoC

Rust rewrite of LodePNG

This is a pure Rust PNG image decoder and encoder. Allows easy reading and writing of PNG files without any system dependencies.

To use the lodepng crate, add to your Cargo.toml:

[dependencies]
lodepng = "3.8"

See the API reference for details. Requires Rust 1.64 or later.

Loading image example

There are more examples in the examples/ dir.

let image = lodepng::decode32_file("in.png")?;

returns image of type lodepng::Bitmap<lodepng::RGBA<u8>> with fields .width, .height, and .buffer (the buffer is a Vec).

The RGB/RGBA pixel types are from the RGB crate, which you can import separately to use the same pixel struct throughout the program, without casting. But if you want to read the image buffer as bunch of raw bytes, ignoring the RGB(A) pixel structure, use:

[dependencies]
rgb = "0.8"
use rgb::*;let bytes: &[u8] = image.buffer.as_bytes();

Saving image example

lodepng::encode32_file("out.png", &buffer, width, height)?

The RGBA buffer can be a slice of any type, as long as it has 4 bytes per element (e.g. struct RGBA or [u8; 4]) and implements the Pod trait.

Advanced

let mut state = lodepng::Decoder::new();
state.remember_unknown_chunks(true);

match state.decode("in.png") {
    Ok(lodepng::Image::RGB(image)) => {}
    Ok(lodepng::Image::RGBA(image)) => {}
    Ok(lodepng::Image::RGBA16(image)) => {}
    Ok(lodepng::Image::Grey(image)) => {}
    Ok(_) => {}
    Err(err) => {}
}

for chunk in state.info_png().unknown_chunks(ChunkPosition::IHDR) {
    println!("{:?} = {:?}", chunk.name(), chunk.data());
}

// Color profile (to be used with e.g. LCMS2)
let icc_data = state.get_icc();

See load_image crate for an example how to use lodepng with color profiles.

Upgrading from 2.x

  • C FFI still exists, but is no longer ABI-compatible with the original C lodepng due to layout changes in structs.
  • Structs use bool where appropriate instead of 0/1 int.
  • Custom zlib callbacks use io::Write instead of malloc-ed buffers (remember to use write_all, not write!)
  • ffi::Error has been renamed to ffi::ErrorCode.
  • Compression level is set via set_level() function instead of individual CompressConfig fields.

Upgrading from 1.x

  • CVec has been replaced with a regular Vec. Delete extra .as_ref() that the compiler may complain about.
  • LCT_* constants have been changed to ColorType::*.
  • Chunk/Chunks renamed to ChunkRef/ChunksIter.
  • auto_convert is a boolean.
  • bitdepth has a getter/setter.
  • There is no C any more!

It's a ship of Theseus

This codebase has been derived from the C LodePNG by Lode Vandevenne. It has been converted to Rust using Citrus C to Rust converter, and then significanlty refactored to be more idiomatic Rust. As a result, it's now a different library, with some of the original API.

Dependencies

~0.3–1.1MB
~18K SLoC