Skip to main content

JxlDecoder

Struct JxlDecoder 

Source
pub struct JxlDecoder;
Expand description

JPEG-XL decoder.

Decodes JPEG-XL files (both bare codestream and ISOBMFF container format) into raw pixel data.

Implementations§

Source§

impl JxlDecoder

Source

pub fn new() -> Self

Create a new JPEG-XL decoder.

Source

pub fn is_jxl(data: &[u8]) -> bool

Check if the data starts with a valid JXL signature.

Returns true for both bare codestream (0xFF 0x0A) and container format signatures.

Source

pub fn is_codestream(data: &[u8]) -> bool

Check for bare codestream signature.

Source

pub fn is_container(data: &[u8]) -> bool

Check for ISOBMFF container signature.

Source

pub fn decode(&self, data: &[u8]) -> CodecResult<DecodedImage>

Decode a JPEG-XL file from bytes.

§Errors

Returns error if:

  • The data does not have a valid JXL signature
  • The header is malformed
  • The image data is corrupt
  • Unsupported features are encountered
Source

pub fn read_header(&self, data: &[u8]) -> CodecResult<JxlHeader>

Read only the header from a JPEG-XL file without fully decoding.

§Errors

Returns error if the signature or header is invalid.

Source

pub fn decode_animated(&self, data: &[u8]) -> CodecResult<Vec<JxlFrame>>

Decode an animated JPEG-XL codestream into a sequence of frames.

If the codestream is not animated, returns a single frame with duration_ticks = 0 and is_last = true.

§Errors

Returns error if the codestream is invalid.

Source

pub fn is_animated(&self, data: &[u8]) -> CodecResult<bool>

Check if a codestream is animated by reading just the header.

§Errors

Returns error if the header is invalid.

Source

pub fn read_animation_header( &self, data: &[u8], ) -> CodecResult<Option<JxlAnimation>>

Read the animation header from a JPEG-XL file.

Returns None if the file is not animated.

§Errors

Returns error if the header is invalid.

Trait Implementations§

Source§

impl Default for JxlDecoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.