pub struct StripeState {Show 34 fields
pub no_motion_frame_count: u32,
pub paint_over_sent: bool,
pub dirty_run: u32,
pub change_mass: f32,
pub unclean_frames: u32,
pub motion: f32,
pub burst_held: bool,
pub clean_quality: bool,
pub rc_bytes: usize,
pub idle_frames: u32,
pub over_frames: u32,
pub same_frames: u32,
pub finest: Option<u32>,
pub finest_frames: u32,
pub settled: bool,
pub fine_frames: u32,
pub measured: Option<f32>,
pub measuring: bool,
pub level_checks: u32,
pub measure_in: u32,
pub sweep: Option<(f64, f64)>,
pub sweep_frames: u32,
pub sweep_coarser: u32,
pub h264_encoder: Option<H264EncoderWrapper>,
pub h264_burst_frames_remaining: i32,
pub y_buf: Vec<u8>,
pub u_buf: Vec<u8>,
pub v_buf: Vec<u8>,
pub yuv16: [Vec<u16>; 3],
pub packet_buf: Vec<u8>,
pub last_hash: u64,
pub consecutive_changes: u32,
pub in_damage_block: bool,
pub damage_block_frames_remaining: i32,
}Expand description
Everything one horizontal stripe must remember between frames: its reused buffers, its own live encoder, and the motion / paint-over / damage bookkeeping that drives its send decision.
The frame is striped so independent screen regions can encode in parallel and an unchanged region can be skipped on its own, and that only works if each stripe carries its own cross-frame history. So one instance lives per stripe for the whole session and nothing per-stripe is rebuilt or recomputed from scratch each frame:
- Reused buffers:
y_buf/u_buf/v_bufhold the stripe’s YUV planes andpacket_bufthe encoded output, grown in place rather than reallocated per frame. - Encoder:
h264_encoderis the stripe’s software H.264 instance — libx264 in agplbuild, OpenH264 otherwise — reused until its geometry (or, for x264, chroma format) changes. - Cleanup / recovery:
no_motion_frame_countcounts consecutive static frames,paint_over_sentrecords that the region was cleaned up since it last changed,h264_burst_frames_remainingtracks a post-cleanup or recovery streaming burst (held at the paint-over quantizer whereburst_held), anddirty_run,change_mass,unclean_frames, andmotion(the share of recent frames in motion) are whatpipeline::cleanup_dueweighs to pick the cleanup’s moment and kind;clean_qualitykeeps a constant-quality session at the paint-over quality from a cleanup until the region changes again;rc_bytes(the bytes of the stripe’s last frame under its rate control),idle_frames(a constant-rate cleanup’s run of small frames short of the paint-over quality, of empty ones for x264),same_frames(of frames the size of the one before),finestandfinest_frames(the finest quality index its rate control has coded at and the frames since), andover_frames(its run of frames overpipeline::OVERSHOOT_BUDGETS) tell a cleanup that runs through the rate control when it has converged, stalled, or been pinned at its coarsest quantizer,fine_framescounts its run of frames at the paint-over quantizer or finer,measured,measuring,level_checks, andmeasure_inare the last measurement of the picture it is refining, whether the frame before was measured, the measurements in a row that found it level, and the frames to the next (pipeline::plateau),settledrecords that such a cleanup ran its course under a rate control it cannot hold a quantizer under, so no other starts before the region moves, andsweep(the next band’s start and the last band’s size, as shares of the picture) carries the band sweep a full-frame refresh falls back to (pipeline::decide_hw_fullframe),sweep_framesits bands so far andsweep_coarserthe steps they are coded coarser than the refresh. - Content-hash damage (only for sources without external damage, i.e. X11):
last_hashis the previous frame’s content hash,consecutive_changescounts changed frames toward the damage-block threshold, andin_damage_block/damage_block_frames_remainingdrive the sustained-motion damage block managed bycontent_dirty.
Fields§
§no_motion_frame_count: u32§paint_over_sent: bool§dirty_run: u32§change_mass: f32§unclean_frames: u32§motion: f32§burst_held: bool§clean_quality: bool§rc_bytes: usize§idle_frames: u32§over_frames: u32§same_frames: u32§finest: Option<u32>§finest_frames: u32§settled: bool§fine_frames: u32§measured: Option<f32>§measuring: bool§level_checks: u32§measure_in: u32§sweep: Option<(f64, f64)>§sweep_frames: u32§sweep_coarser: u32§h264_encoder: Option<H264EncoderWrapper>§h264_burst_frames_remaining: i32§y_buf: Vec<u8>§u_buf: Vec<u8>§v_buf: Vec<u8>§yuv16: [Vec<u16>; 3]The planes of a 10-bit stripe, as 16-bit samples.
packet_buf: Vec<u8>§last_hash: u64§consecutive_changes: u32§in_damage_block: bool§damage_block_frames_remaining: i32Implementations§
Source§impl StripeState
impl StripeState
Sourcepub fn content_dirty(
&mut self,
bytes: &[u8],
threshold: u32,
duration: i32,
) -> bool
pub fn content_dirty( &mut self, bytes: &[u8], threshold: u32, duration: i32, ) -> bool
Stand in for the compositor damage that X11 capture does not provide: hash this stripe to decide whether it changed since last frame, and once it is clearly in motion, stop re-hashing it every frame by committing to a sustained-motion “damage block”.
The hash is not free, and a region that changes every frame would otherwise be re-hashed
forever while always reporting dirty anyway. So after threshold consecutive changes the
stripe enters a damage block that just reports dirty for duration frames and re-hashes only
on its last two frames, to decide whether to extend the block or let it lapse — trading a
little extra sending for far fewer hashes on exactly the regions that need them least:
- Inside a damage block: the stripe is treated as dirty without re-hashing, and the
block’s remaining-frame counter is decremented. The stripe is hashed on the block’s last
two frames: if they differ the region is still moving and the block is renewed for
another
durationframes, otherwise the block exits and the change counter resets, so motion that stopped inside a block is read as stopped when that block ends, not a block later. This keeps a continuously-moving region streaming fordurationframes per re-check rather than hashing every frame. - Outside a block: the stripe is hashed and compared to the previous frame. A change
increments
consecutive_changes, and reachingthresholdconsecutive changes opens a new damage block; an unchanged frame resets the counter to zero.
Returns true whenever the stripe is considered dirty (always true while inside a block).
Trait Implementations§
Source§impl Default for StripeState
impl Default for StripeState
Source§fn default() -> StripeState
fn default() -> StripeState
Auto Trait Implementations§
impl !Sync for StripeState
impl Freeze for StripeState
impl RefUnwindSafe for StripeState
impl Send for StripeState
impl Unpin for StripeState
impl UnsafeUnpin for StripeState
impl UnwindSafe for StripeState
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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§impl<T> NoneValue for Twhere
T: Default,
impl<T> NoneValue for Twhere
T: Default,
type NoneType = T
§fn null_value() -> T
fn null_value() -> T
§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().