Struct PeakBucket 

pub struct PeakBucket {
    pub bps: u32,
    pub vbv: u32,
    fps: f64,
    fill: f64,
    pub binding: bool,
    at_floor: u32,
}

A leaky bucket of a capped constant quality’s peak (RateSettings::capped), its buffer the session’s VBV, for an encoder whose constant quality takes no cap of its own: the session codes as an uncapped one while the bucket holds what it codes, binds to the peak through its constant rate, never finer than its quality, from the frame that overflows the bucket, and lets go once RELEASE_FRAMES frames in a row come out at that quality with the bucket back within its buffer, which says the content fits under the peak again: a rate control that takes the peak with its buffer full codes at the quality for a while whatever the content. The frame that overflows has already gone out: the cap holds the frames after it.

Fields

bps: u32

vbv: u32

fps: f64

fill: f64

The bits the bucket holds.

binding: bool

at_floor: u32

Frames in a row the constant rate coded at the quality while binding.

Implementations

impl PeakBucket

pub const RELEASE_FRAMES: u32 = 30

pub fn new(bps: u32, vbv: u32, fps: f64) -> Self

pub fn follow(&mut self, bps: u32, vbv: u32, fps: f64)

Take a live peak, buffer, and frame rate.

pub fn note(&mut self, bits: f64, at_floor: Option<bool>) -> Option<bool>

Fold in a frame of bits, at_floor saying whether the rate control coded it at the session’s quality (None for a held frame, whose quantizer is not the rate control’s): Some(true) to bind the session to the peak, Some(false) to release it.

Trait Implementations

impl Clone for PeakBucket

fn clone(&self) -> PeakBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PeakBucket

impl Debug for PeakBucket

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

Formats the value using the given formatter.