Struct re_video::decode::FrameInfo

pub struct FrameInfo {
    pub is_sync: Option<bool>,
    pub sample_idx: Option<usize>,
    pub frame_nr: Option<usize>,
    pub presentation_timestamp: Time,
    pub duration: Time,
    pub latest_decode_timestamp: Option<Time>,
}

Meta information about a decoded video frame, as reported by the decoder.

Fields

is_sync: Option<bool>

The start of a new crate::demux::GroupOfPictures?

This probably means this is a keyframe, and that and entire frame can be decoded from only this one sample (though I’m not 100% sure).

None = unknown.

sample_idx: Option<usize>

Which sample in the video is this from?

In MP4, one sample is one frame, but we may be reordering samples when decoding.

This is the order of which the samples appear in the container, which is usually ordered by Self::latest_decode_timestamp.

None = unknown.

frame_nr: Option<usize>

Which frame is this?

This is on the assumption that each sample produces a single frame, which is true for MP4.

This is the index of frames ordered by Self::presentation_timestamp.

None = unknown.

presentation_timestamp: Time

The presentation timestamp of the frame.

duration: Time

How long the frame is valid.

latest_decode_timestamp: Option<Time>

The decode timestamp of the last chunk that was needed to decode this frame.

None = unknown.

Implementations

impl FrameInfo

pub fn presentation_time_range(&self) -> Range<Time>

Presentation timestamp range in which this frame is valid.

Trait Implementations

impl Clone for FrameInfo

fn clone(&self) -> FrameInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrameInfo

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

Formats the value using the given formatter.