Struct gstreamer_audio::AudioStreamAlign

pub struct AudioStreamAlign(_);

crate::AudioStreamAlign provides a helper object that helps tracking audio stream alignment and discontinuities, and detects discontinuities if possible.

See Self::new() for a description of its parameters and Self::process() for the details of the processing.

Implementations

impl AudioStreamAlign

pub fn new(
    rate: i32,
    alignment_threshold: ClockTime,
    discont_wait: ClockTime
) -> AudioStreamAlign

This is supported on crate feature v1_14 only.

Allocate a new crate::AudioStreamAlign with the given configuration. All processing happens according to sample rate rate, until Self::set_rate() is called with a new rate. A negative rate can be used for reverse playback.

alignment_threshold gives the tolerance in nanoseconds after which a timestamp difference is considered a discontinuity. Once detected, discont_wait nanoseconds have to pass without going below the threshold again until the output buffer is marked as a discontinuity. These can later be re-configured with Self::set_alignment_threshold() and Self::set_discont_wait().

rate

a sample rate

alignment_threshold

a alignment threshold in nanoseconds

discont_wait

discont wait in nanoseconds

Returns

a new crate::AudioStreamAlign. free with [Self::free()].

pub fn alignment_threshold(&self) -> ClockTime

This is supported on crate feature v1_14 only.

pub fn discont_wait(&self) -> ClockTime

This is supported on crate feature v1_14 only.

pub fn rate(&self) -> i32

This is supported on crate feature v1_14 only.

pub fn samples_since_discont(&self) -> u64

This is supported on crate feature v1_14 only.

pub fn timestamp_at_discont(&self) -> ClockTime

This is supported on crate feature v1_14 only.

pub fn mark_discont(&mut self)

This is supported on crate feature v1_14 only.

Marks the next buffer as discontinuous and resets timestamp tracking.

pub fn set_alignment_threshold(&mut self, alignment_threshold: ClockTime)

This is supported on crate feature v1_14 only.

Sets alignment_treshold as new alignment threshold for the following processing.

alignment_threshold

a new alignment threshold

pub fn set_discont_wait(&mut self, discont_wait: ClockTime)

This is supported on crate feature v1_14 only.

Sets alignment_treshold as new discont wait for the following processing.

discont_wait

a new discont wait

pub fn set_rate(&mut self, rate: i32)

This is supported on crate feature v1_14 only.

Sets rate as new sample rate for the following processing. If the sample rate differs this implicitly marks the next data as discontinuous.

rate

a new sample rate

impl AudioStreamAlign

pub fn process(
    &mut self,
    discont: bool,
    timestamp: ClockTime,
    n_samples: u32
) -> (bool, ClockTime, ClockTime, u64)

This is supported on crate feature v1_14 only.

Processes data with timestamp and n_samples, and returns the output timestamp, duration and sample position together with a boolean to signal whether a discontinuity was detected or not. All non-discontinuous data will have perfect timestamps and durations.

A discontinuity is detected once the difference between the actual timestamp and the timestamp calculated from the sample count since the last discontinuity differs by more than the alignment threshold for a duration longer than discont wait.

Note: In reverse playback, every buffer is considered discontinuous in the context of buffer flags because the last sample of the previous buffer is discontinuous with the first sample of the current one. However for this function they are only considered discontinuous in reverse playback if the first sample of the previous buffer is discontinuous with the last sample of the current one.

discont

if this data is considered to be discontinuous

timestamp

a crate::gst::ClockTime of the start of the data

n_samples

number of samples to process

out_timestamp

output timestamp of the data

out_duration

output duration of the data

out_sample_position

output sample position of the start of the data

Returns

true if a discontinuity was detected, false otherwise.

Trait Implementations

impl Clone for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn clone(&self) -> AudioStreamAlign

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn cmp(&self, other: &AudioStreamAlign) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<AudioStreamAlign> for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn eq(&self, other: &AudioStreamAlign) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AudioStreamAlign) -> bool

This method tests for !=.

impl PartialOrd<AudioStreamAlign> for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn partial_cmp(&self, other: &AudioStreamAlign) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AudioStreamAlign

This is supported on crate feature v1_14 only.

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AudioStreamAlign

This is supported on crate feature v1_14 only.

impl Send for AudioStreamAlign

This is supported on crate feature v1_14 only.

impl StructuralEq for AudioStreamAlign

This is supported on crate feature v1_14 only.

impl StructuralPartialEq for AudioStreamAlign

This is supported on crate feature v1_14 only.

impl Sync for AudioStreamAlign

This is supported on crate feature v1_14 only.