Struct jpegxl_rs::image::JxlImageDecoder

pub struct JxlImageDecoder<T: PixelType> { /* fields omitted */ }

JPEG XL decoder representation for image crate.
Note: Since image only supports 8-bit and 16-bit pixel depth, you can only create u8 and u16 buffer.

Example

let sample = std::fs::read("test/sample.jxl")?;
let decoder: JxlImageDecoder<u16> = JxlImageDecoder::new(&sample)?;
let img = image::DynamicImage::from_decoder(decoder)?;       

Implementations

impl<T: PixelType> JxlImageDecoder<T>

pub fn new(input: &[u8]) -> ImageResult<JxlImageDecoder<T>>

Create a new JPEG XL Decoder.

Errors

Return an image::ImageError with wrapped DecodeError

Trait Implementations

impl<'a> ImageDecoder<'a> for JxlImageDecoder<u8>

type Reader = Cursor<Vec<u8>>

The type of reader produced by into_reader.

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image

fn into_reader(self) -> ImageResult<Self::Reader>

Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least scanline_bytes from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering.

pub fn original_color_type(&self) -> ExtendedColorType

Retuns the color type of the image file before decoding

pub fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

pub fn scanline_bytes(&self) -> u64

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().

pub fn read_image(self, buf: &mut [u8]) -> Result<(), ImageError>

Returns all the bytes in the image.

pub fn read_image_with_progress<F>(
    self,
    buf: &mut [u8],
    progress_callback: F
) -> Result<(), ImageError> where
    F: Fn(Progress), 

Same as read_image but periodically calls the provided callback to give updates on loading progress.

impl<'a> ImageDecoder<'a> for JxlImageDecoder<u16>

type Reader = Cursor<Vec<u8>>

The type of reader produced by into_reader.

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image

fn into_reader(self) -> ImageResult<Self::Reader>

Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least scanline_bytes from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering.

pub fn original_color_type(&self) -> ExtendedColorType

Retuns the color type of the image file before decoding

pub fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

pub fn scanline_bytes(&self) -> u64

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().

pub fn read_image(self, buf: &mut [u8]) -> Result<(), ImageError>

Returns all the bytes in the image.

pub fn read_image_with_progress<F>(
    self,
    buf: &mut [u8],
    progress_callback: F
) -> Result<(), ImageError> where
    F: Fn(Progress), 

Same as read_image but periodically calls the provided callback to give updates on loading progress.