#jpegxl #api-bindings

jpegxl-rs

Safe Rust wrapper for JPEG XL reference implementation

25 releases

0.10.2+libjxl-0.10.2 Mar 21, 2024
0.9.0+libjxl-0.9.1 Jan 28, 2024
0.8.3+libjxl-0.8.2 Oct 13, 2023
0.8.2+libjxl-0.8.2 Jun 14, 2023
0.1.4 Aug 25, 2020

#68 in Images

Download history 27/week @ 2024-01-14 238/week @ 2024-01-21 413/week @ 2024-01-28 484/week @ 2024-02-04 263/week @ 2024-02-11 434/week @ 2024-02-18 340/week @ 2024-02-25 71/week @ 2024-03-03 214/week @ 2024-03-10 315/week @ 2024-03-17 155/week @ 2024-03-24 215/week @ 2024-03-31 167/week @ 2024-04-07 52/week @ 2024-04-14

617 downloads per month

GPL-3.0-or-later

150KB
3K SLoC

jpegxl-rs

Documentation Crates.io dependency status CI codecov License: GPL-3.0-or-later

A safe JPEGXL wrapper over libjxl library. Check out the original library and the bindings.

Building

If you wish to specify a custom library path, set the DEP_JXL_LIB environment variable.

Building libjxl and statically linking can be enabled by using the vendored feature.

If you don't want to depend on C++ standard library, disable the feature threads.

Usage

Currently, u8, u16, f16 and f32 are supported as pixel types.

Decoding

let mut decoder = decoder_builder().build()?;
let (Metadata { width, height, ..}, pixels) = decoder.decode(&sample)?;
match pixels {
    Pixels::Float(data) => { /* do something with Vec<f32> data */ },
    Pixels::Uint8(data) => { /* do something with Vec<u8> data */ },
    Pixels::Uint16(data) => { /* do something with Vec<u16> data */ },
    Pixels::Float16(data) => { /* do something with Vec<f16> data */ },
}

// Multi-threading
use jpegxl_rs::ThreadsRunner;
let runner = ThreadsRunner::default();
let mut decoder = decoder_builder()
                      .parallel_runner(&runner)
                      .build()?;

// Customize pixel format
let mut decoder = decoder_builder()
                      .pixel_format(PixelFormat {
                          num_channels: 3,
                          endianness: Endianness::Big,
                          align: 8
                      })
                      .build()?;

decoder.decode_with::<u8>(&sample);

// You can change the settings after initialization
decoder.skip_reorientation = Some(true);

// Reconstruct JPEG, fallback to pixels if JPEG reconstruction is not possible
// This operation is finished in on pass
let (metadata, data) = decoder.reconstruct(&sample)?;
match data {
    Data::Jpeg(jpeg) => {/* do something with the JPEG data */}
    Data::Pixels(pixels) => {/* do something with the pixels data */}
}

Encoding

use image::io::Reader as ImageReader;
let sample = ImageReader::open("../samples/sample.png")?.decode()?.to_rgba16();
let mut encoder = encoder_builder().build()?;
let buffer: EncoderResult<f32> = encoder.encode(&sample, sample.width(), sample.height())?;

Set encoder options

let mut encoder = encoder_builder()
                    .lossless(true)
                    .speed(EncoderSpeed::Falcon)
                    .build()?;
// You can change the settings after initialization
encoder.lossless = false;
encoder.quality = 3.0;

image crate integration

The integration is enabled by default. If you don't need it, disable image feature.

use jpegxl_rs::image::ToDynamic;
use jpegxl_rs::decoder_builder;
use image::DynamicImage;

let sample = std::fs::read("../samples/sample.jxl")?;
let mut decoder = decoder_builder().build()?;
let img = decoder.decode_to_image(&sample)?;
let img = decoder.decode_to_image_with::<f32>(&sample)?;

License: GPL-3.0-or-later

Dependencies

~11MB
~62K SLoC