Skip to main content

TwoPassStateTracker

Struct TwoPassStateTracker 

Source
pub struct TwoPassStateTracker { /* private fields */ }
Expand description

Lightweight two-pass VBR state tracker.

Provides a simplified API for recording per-frame complexity values during the first pass and computing per-frame bitrate targets during the second pass.

§Usage

use oximedia_codec::vbr_twopass::TwoPassStateTracker;

let mut state = TwoPassStateTracker::new();
state.record_first_pass(1.5); // frame 0
state.record_first_pass(0.8); // frame 1
state.record_first_pass(2.3); // frame 2

let bits_frame0 = state.compute_bitrate(1.5, 4_000_000);
assert!(bits_frame0 > 0);

Implementations§

Source§

impl TwoPassStateTracker

Source

pub fn new() -> Self

Create a new, empty state tracker.

Source

pub fn record_first_pass(&mut self, complexity: f32)

Record a complexity value for one frame during the first pass.

complexity must be a non-negative floating-point value. Typical values are SAD-normalised intra/inter costs in the range 0.1 – 20.0.

Source

pub fn compute_bitrate(&self, complexity: f32, budget: u32) -> u32

Compute the per-frame bitrate target for a frame with the given complexity.

Uses complexity-proportional allocation:

target_bits = budget * complexity / sum(all_complexities)

If the accumulated first-pass data is empty the entire budget is returned (no-op case).

§Parameters
  • complexity – complexity value of the current frame (should have been recorded via Self::record_first_pass).
  • budget – total bit budget for the session (bits).
§Returns

Target number of bits for this frame, as a u32. Clamped to at least 1 and at most budget.

Source

pub fn frame_count(&self) -> usize

Returns the number of frames recorded in the first pass.

Source

pub fn total_complexity(&self) -> f32

Returns the total accumulated complexity.

Source

pub fn mean_complexity(&self) -> f32

Returns the average complexity per frame.

Trait Implementations§

Source§

impl Clone for TwoPassStateTracker

Source§

fn clone(&self) -> TwoPassStateTracker

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 TwoPassStateTracker

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TwoPassStateTracker

Source§

fn default() -> TwoPassStateTracker

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.