Struct FrameStats

Source

pub struct FrameStats {Show 14 fields
    pub frame_num: u64,
    pub frame_type: FrameType,
    pub bits: u64,
    pub qp: u8,
    pub qp_f: f32,
    pub spatial_complexity: f32,
    pub temporal_complexity: f32,
    pub complexity: f32,
    pub psnr: Option<f32>,
    pub ssim: Option<f32>,
    pub scene_cut: bool,
    pub target_bits: u64,
    pub bit_accuracy: f32,
    pub encode_time_us: u64,
}

Expand description

Statistics for a single encoded frame.

Fields§

§frame_num: u64

Frame number (display order).

§frame_type: FrameType

Frame type (I/P/B).

§bits: u64

Bits used for this frame.

§qp: u8

QP used for this frame.

§qp_f: f32

QP as floating point for averaging.

§spatial_complexity: f32

Spatial complexity estimate.

§temporal_complexity: f32

Temporal complexity estimate (motion).

§complexity: f32

Combined complexity metric.

§psnr: Option<f32>

PSNR if calculated.

§ssim: Option<f32>

SSIM if calculated.

§scene_cut: bool

Was this frame a scene cut.

§target_bits: u64

Target bits for this frame.

§bit_accuracy: f32

Actual bits / target bits ratio.

§encode_time_us: u64

Encoding time in microseconds.

Implementations§

Source §

impl FrameStats

Source

pub fn new(frame_num: u64, frame_type: FrameType) -> Self

Create new frame statistics.

Source

pub fn bits_per_pixel(&self, width: u32, height: u32) -> f32

Calculate bits per pixel.

Source

pub fn exceeded_target(&self, threshold: f32) -> bool

Check if frame exceeded target significantly.

Source

pub fn under_target(&self, threshold: f32) -> bool

Check if frame was under target significantly.

Trait Implementations§

Source §

impl Clone for FrameStats

Source §

fn clone(&self) -> FrameStats

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for FrameStats

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for FrameStats

Source §

fn default() -> FrameStats

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

Auto Trait Implementations§

§

impl UnwindSafe for FrameStats

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §