Struct HwFrameDecision 

pub struct HwFrameDecision {
    pub send: bool,
    pub force_idr: bool,
    pub target_qp: u32,
    pub hold_qp: Option<u32>,
    pub hold_band: Option<(f64, f64)>,
    pub measure: bool,
    pub cap: Option<usize>,
    pub refine: Option<Refinement>,
    pub constant: Option<Vec<bool>>,
    pub refresh: Option<BlockPlan>,
    pub defer: Option<BlockPlan>,
}

Outcome of the full-frame send decision produced by decide_hw_fullframe.

Fields

send: bool

force_idr: bool

target_qp: u32

The session quality index the frame is encoded at.

hold_qp: Option<u32>

The quality index this frame is held at whatever the rate control: the cleanup of a still screen, handed to the encoder’s hold_quantizer.

hold_band: Option<(f64, f64)>

The share of the picture, from and to in raster order, hold_qp covers, the rest of the frame held at the coarsest quantizer; None for the whole picture.

measure: bool

Whether the encoder is asked to measure this frame’s reconstruction (FrameEncoder::measure).

cap: Option<usize>

The bytes a still screen’s cleanup frame may come to (FrameEncoder::cap).

refine: Option<Refinement>

The blocks this frame refines (plan_refinement).

constant: Option<Vec<bool>>

The blocks this frame may code as skips without analysis, in raster order (plan_refinement, BlockLedger::constant); None where none may be.

refresh: Option<BlockPlan>

The coarse blocks of a capped constant quality whose peak let go that this frame codes again at the session’s own quality, and the ones left for later frames, which it holds as skips (BlockLedger::refresh, FrameEncoder::defer_blocks).

defer: Option<BlockPlan>

Implementations

impl HwFrameDecision

pub(crate) fn cleanup_quality(&self, normal: u32) -> Option<u32>

The quality the whole frame is coded at in place of the session’s normal one: a quantizer held for it, or a constant quality’s paint-over one.

pub fn prepare(&self, encoder: &mut FrameEncoder)

Tell encoder what the decision asks of the frame it is about to code: the quantizer it is held at and whether its reconstruction is measured.