Skip to main content

FragmentWriter

Struct FragmentWriter 

Source
pub struct FragmentWriter<W: Write> {
    out: W,
    seq: u32,
    wrote_init: bool,
    pending: Option<PendingSample>,
    last_dts: Option<u64>,
    durations: Vec<u32>,
    audio: Option<AudioTrackConfig>,
    audio_pending: Vec<(Vec<u8>, u32)>,
    audio_batch_dts: u64,
    audio_next_dts: u64,
    stats: Mp4Stats,
}
Expand description

Codec-agnostic fMP4 fragment writer: ftyp+moov once, then one moof+mdat pair per video sample, each anchored at its wall-clock decode time via tfdt, and one per batch of audio samples.

Fields§

§out: W§seq: u32§wrote_init: bool§pending: Option<PendingSample>§last_dts: Option<u64>§durations: Vec<u32>

Every flushed inter-frame duration, kept so the final buffered sample (whose successor never arrives) can close on the MEDIAN — damage-driven capture makes the last observed delta an outlier as often as not (a long static gap, a burst pair).

§audio: Option<AudioTrackConfig>§audio_pending: Vec<(Vec<u8>, u32)>

Pending audio packets with their durations; contiguous from audio_batch_dts.

§audio_batch_dts: u64§audio_next_dts: u64§stats: Mp4Stats

Implementations§

Source§

impl<W: Write> FragmentWriter<W>

Source

pub fn new(out: W) -> Self

Source

pub fn with_audio(self, cfg: AudioTrackConfig) -> Self

Declare the audio track; must precede write_init.

Source

pub fn init_written(&self) -> bool

Source

pub fn stats(&self) -> Mp4Stats

Counters for the fragments written so far (the buffered pending sample is not yet included; finish folds it in).

Source

pub fn write_init(&mut self, cfg: &TrackConfig) -> Result<()>

Write ftyp + moov (the video track, the audio track when declared, and the mvex/trex marking the movie fragmented). Must be called once, before the first sample.

Source

pub fn push_sample( &mut self, data: Vec<u8>, sync: bool, pts_us: u64, ) -> Result<()>

Queue one sample at pts_us (wall-clock microseconds since recording start), flushing the previously buffered sample with its now-known duration. Timestamps are clamped strictly monotonic so a repeated or reordered clock can never emit a zero/negative duration.

Source

fn median_duration(&self) -> u32

Median of the observed inter-frame durations (default 1/30 s when fewer than two frames were pushed), used to close the final sample.

Source

fn write_fragment(&mut self, s: &PendingSample, duration: u32) -> Result<()>

Source

pub fn push_audio(&mut self, data: Vec<u8>, dts: u64) -> Result<()>

Queue one audio packet decoding at dts on the 48 kHz clock. A packet that does not follow the pending ones directly (a gap in the stream) closes their fragment first, so every fragment’s samples are contiguous from its tfdt.

Source

fn flush_audio(&mut self) -> Result<()>

Write the pending audio packets as one fragment of track 2, every sample a sync sample with its own duration and size.

Source

pub fn finish(self) -> Result<Mp4Stats>

Flush the pending audio and the final buffered video sample, closed with the MEDIAN observed inter-frame duration (its successor never arrives), and return the aggregate counters.

Auto Trait Implementations§

§

impl<W> Freeze for FragmentWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for FragmentWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for FragmentWriter<W>
where W: Send,

§

impl<W> Sync for FragmentWriter<W>
where W: Sync,

§

impl<W> Unpin for FragmentWriter<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for FragmentWriter<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for FragmentWriter<W>
where W: UnwindSafe,

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.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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<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> 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