Struct jxl_frame::header::FrameHeader

pub struct FrameHeader {

    pub frame_type: FrameType,
    pub encoding: Encoding,
    pub flags: FrameFlags,
    pub do_ycbcr: bool,
    pub jpeg_upsampling: [u32; 3],
    pub upsampling: u32,
    pub ec_upsampling: Vec<u32>,
    pub group_size_shift: u32,
    pub x_qm_scale: u32,
    pub b_qm_scale: u32,
    pub passes: Passes,
    pub lf_level: u32,
    pub have_crop: bool,
    pub x0: i32,
    pub y0: i32,
    pub width: u32,
    pub height: u32,
    pub blending_info: BlendingInfo,
    pub ec_blending_info: Vec<BlendingInfo>,
    pub duration: u32,
    pub timecode: u32,
    pub is_last: bool,
    pub save_as_reference: u32,
    pub resets_canvas: bool,
    pub save_before_ct: bool,
    pub name: Name,
    pub restoration_filter: RestorationFilter,
    pub extensions: Extensions,
    pub bit_depth: BitDepth,
    /* private fields */
}

Frame header.

Fields

frame_type: FrameType

encoding: Encoding

flags: FrameFlags

do_ycbcr: bool

jpeg_upsampling: [u32; 3]

upsampling: u32

ec_upsampling: Vec<u32>

group_size_shift: u32

x_qm_scale: u32

b_qm_scale: u32

passes: Passes

lf_level: u32

have_crop: bool

x0: i32

y0: i32

width: u32

height: u32

blending_info: BlendingInfo

ec_blending_info: Vec<BlendingInfo>

duration: u32

timecode: u32

is_last: bool

save_as_reference: u32

resets_canvas: bool

save_before_ct: bool

name: Name

restoration_filter: RestorationFilter

extensions: Extensions

bit_depth: BitDepth

Implementations

impl FrameHeader

pub fn is_keyframe(&self) -> bool

Returns whether this frame is a keyframe that should be displayed.

pub fn can_reference(&self) -> bool

pub fn sample_width(&self, upsampling: u32) -> u32

pub fn sample_height(&self, upsampling: u32) -> u32

pub fn color_sample_width(&self) -> u32

pub fn color_sample_height(&self) -> u32

pub fn encoded_color_channels(&self) -> usize

Returns the number of channels actually encoded in the frame.

pub fn num_groups(&self) -> u32

pub fn num_lf_groups(&self) -> u32

pub fn group_dim(&self) -> u32

pub fn groups_per_row(&self) -> u32

pub fn lf_group_dim(&self) -> u32

pub fn lf_groups_per_row(&self) -> u32

pub fn group_size_for(&self, group_idx: u32) -> (u32, u32)

pub fn lf_group_size_for(&self, lf_group_idx: u32) -> (u32, u32)

pub fn lf_group_idx_from_group_idx(&self, group_idx: u32) -> u32

pub fn is_group_collides_region( &self, group_idx: u32, region: (u32, u32, u32, u32), ) -> bool

pub fn is_lf_group_collides_region( &self, lf_group_idx: u32, region: (u32, u32, u32, u32), ) -> bool

Trait Implementations

impl Bundle<&FrameHeader> for Splines

type Error = Error

fn parse(bitstream: &mut Bitstream<'_>, header: &FrameHeader) -> Result<Self>

Parses a value from the bitstream with the given context.

impl Bundle<&FrameHeader> for Toc

type Error = Error

fn parse(bitstream: &mut Bitstream<'_>, ctx: &FrameHeader) -> Result<Self>

Parses a value from the bitstream with the given context.

impl Bundle<&ImageHeader> for FrameHeader

type Error = Error

fn parse( bitstream: &mut Bitstream<'_>, headers: &ImageHeader, ) -> Result<Self, Self::Error>

where Self: Sized,

Parses a value from the bitstream with the given context.

impl BundleDefault<&ImageHeader> for FrameHeader

fn default_with_context(headers: &ImageHeader) -> Self

where Self: Sized,

Creates a default value with the given context.

impl Debug for FrameHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.