Struct SvtAv1Encoder 

pub struct SvtAv1Encoder { /* private fields */ }

One SVT-AV1 session for one capture.

Implementations

impl SvtAv1Encoder

pub fn new(settings: &RustCaptureSettings, rgba: bool) -> Result<Self, String>

Open a session on host frames; rgba names the byte order they arrive in.

pub fn codec(&self) -> Codec

pub fn library(&self) -> &'static str

The library behind the session, as the logs name it.

pub fn is_fullcolor(&self) -> bool

pub fn bit_depth(&self) -> u32

The bits per sample the session codes.

pub fn is_full_range(&self) -> bool

pub fn last_reference(&self) -> Reference

pub fn holds_quantizer(&self) -> bool

Whether hold_quantizer holds a frame at its quantizer: at a constant rate where the release takes a new target with a picture. A constant-quantizer session is cleaned up through its own quality instead (pipeline::decide_constant_quality): a per-picture quantizer (use_qp_file) drops the library’s key-frame and layer offsets from every picture it names, and a cleanup key frame held that way came out at 49.6 dB where the session’s own key frame at the paint-over quality reached 61.0.

pub fn last_quality(&self) -> Option<u32>

The quality index the rate control last coded a frame at, held frames aside.

pub fn invalidate_reference(&mut self, frame_id: u16) -> bool

Leave frame frame_id and every frame after it out of the predictions where the session names its references; refused otherwise, so the caller codes a key frame.

pub fn acknowledge_reference(&mut self, frame_id: u16, held: bool)

Every consumer holds frame frame_id, or where not held was sent it (ReferenceSlots::acknowledge), where the session names its references.

pub fn hold_quantizer(&mut self, crf: u32)

Encode the next frame at the quantizer the quality index crf selects, leaving the session’s own quantizer for the frame after: the cleanup of a still screen, at a constant rate, where a held key picture is planned with a raised target (holds_quantizer). A constant-quantizer session codes the frame at its own quantizer.

pub fn reconfigure_rate( &mut self, settings: &RustCaptureSettings, ) -> Result<(), String>

Apply a rate or frame-rate change: a new bitrate with the next picture where the library takes one live, since the VBV it holds spans the same time at any bitrate; anything else re-opens the encoder.

pub fn encode_host( &mut self, pixels: &[u8], stride: usize, rgba: bool, frame_number: u64, crf: u32, force_idr: bool, ) -> Result<Vec<u8>, String>

Encode one packed host frame at the quality index crf, as a key frame when force_idr.

Trait Implementations

impl Drop for SvtAv1Encoder

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for SvtAv1Encoder