Skip to main content

StripeState

Struct StripeState 

Source
pub struct StripeState {
Show 13 fields pub no_motion_frame_count: u32, pub paint_over_sent: bool, 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 packet_buf: Vec<u8>, pub last_hash: u64, pub consecutive_changes: u32, pub in_damage_block: bool, pub damage_block_frames_remaining: i32, pub hash_at_block_start: u64,
}
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_buf hold the stripe’s YUV planes and packet_buf the encoded output, grown in place rather than reallocated per frame.
  • Encoder: h264_encoder is the stripe’s software H.264 instance — libx264 in a gpl build, OpenH264 otherwise — reused until its geometry (or, for x264, chroma format) changes.
  • Paint-over / recovery: no_motion_frame_count counts consecutive static frames, paint_over_sent guards against re-sending a high-quality repaint of a still region, and h264_burst_frames_remaining tracks a post-repaint or recovery streaming burst.
  • Content-hash damage (only for sources without external damage, i.e. X11): last_hash is the previous frame’s content hash, consecutive_changes counts changed frames toward the damage-block threshold, and in_damage_block / damage_block_frames_remaining / hash_at_block_start drive the sustained-motion damage block managed by content_dirty.

Fields§

§no_motion_frame_count: u32§paint_over_sent: bool§h264_encoder: Option<H264EncoderWrapper>§h264_burst_frames_remaining: i32§y_buf: Vec<u8>§u_buf: Vec<u8>§v_buf: Vec<u8>§packet_buf: Vec<u8>§last_hash: u64§consecutive_changes: u32§in_damage_block: bool§damage_block_frames_remaining: i32§hash_at_block_start: u64

Implementations§

Source§

impl StripeState

Source

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 once, at the end, 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:

  1. Inside a damage block: the stripe is treated as dirty without re-hashing, and the block’s remaining-frame counter is decremented. Only when the counter reaches zero is the stripe re-hashed — if it differs from the hash captured at block start the block is renewed for another duration frames, otherwise the block exits and the change counter resets. This keeps a continuously-moving region streaming for duration frames per re-check rather than hashing every frame.
  2. Outside a block: the stripe is hashed and compared to the previous frame. A change increments consecutive_changes, and reaching threshold consecutive 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

Source§

fn default() -> StripeState

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more