gstreamer_audio/auto/

audio_stream_align.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::ffi;
use glib::translate::*;

glib::wrapper! {
    /// [`AudioStreamAlign`][crate::AudioStreamAlign] provides a helper object that helps tracking audio
    /// stream alignment and discontinuities, and detects discontinuities if
    /// possible.
    ///
    /// See [`new()`][Self::new()] for a description of its parameters and
    /// [`process()`][Self::process()] for the details of the processing.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct AudioStreamAlign(Boxed<ffi::GstAudioStreamAlign>);

    match fn {
        copy => |ptr| ffi::gst_audio_stream_align_copy(ptr),
        free => |ptr| ffi::gst_audio_stream_align_free(ptr),
        type_ => || ffi::gst_audio_stream_align_get_type(),
    }
}

impl AudioStreamAlign {
    /// Allocate a new [`AudioStreamAlign`][crate::AudioStreamAlign] with the given configuration. All
    /// processing happens according to sample rate `rate`, until
    /// [`set_rate()`][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 [`set_alignment_threshold()`][Self::set_alignment_threshold()] and
    /// [`set_discont_wait()`][Self::set_discont_wait()].
    /// ## `rate`
    /// a sample rate
    /// ## `alignment_threshold`
    /// a alignment threshold in nanoseconds
    /// ## `discont_wait`
    /// discont wait in nanoseconds
    ///
    /// # Returns
    ///
    /// a new [`AudioStreamAlign`][crate::AudioStreamAlign]. free with `gst_audio_stream_align_free()`.
    #[doc(alias = "gst_audio_stream_align_new")]
    pub fn new(
        rate: i32,
        alignment_threshold: gst::ClockTime,
        discont_wait: gst::ClockTime,
    ) -> AudioStreamAlign {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gst_audio_stream_align_new(
                rate,
                alignment_threshold.into_glib(),
                discont_wait.into_glib(),
            ))
        }
    }

    /// Gets the currently configured alignment threshold.
    ///
    /// # Returns
    ///
    /// The currently configured alignment threshold
    #[doc(alias = "gst_audio_stream_align_get_alignment_threshold")]
    #[doc(alias = "get_alignment_threshold")]
    pub fn alignment_threshold(&self) -> gst::ClockTime {
        unsafe {
            try_from_glib(ffi::gst_audio_stream_align_get_alignment_threshold(
                self.to_glib_none().0,
            ))
            .expect("mandatory glib value is None")
        }
    }

    /// Gets the currently configured discont wait.
    ///
    /// # Returns
    ///
    /// The currently configured discont wait
    #[doc(alias = "gst_audio_stream_align_get_discont_wait")]
    #[doc(alias = "get_discont_wait")]
    pub fn discont_wait(&self) -> gst::ClockTime {
        unsafe {
            try_from_glib(ffi::gst_audio_stream_align_get_discont_wait(
                self.to_glib_none().0,
            ))
            .expect("mandatory glib value is None")
        }
    }

    /// Gets the currently configured sample rate.
    ///
    /// # Returns
    ///
    /// The currently configured sample rate
    #[doc(alias = "gst_audio_stream_align_get_rate")]
    #[doc(alias = "get_rate")]
    pub fn rate(&self) -> i32 {
        unsafe { ffi::gst_audio_stream_align_get_rate(self.to_glib_none().0) }
    }

    /// Returns the number of samples that were processed since the last
    /// discontinuity was detected.
    ///
    /// # Returns
    ///
    /// The number of samples processed since the last discontinuity.
    #[doc(alias = "gst_audio_stream_align_get_samples_since_discont")]
    #[doc(alias = "get_samples_since_discont")]
    pub fn samples_since_discont(&self) -> u64 {
        unsafe { ffi::gst_audio_stream_align_get_samples_since_discont(self.to_glib_none().0) }
    }

    /// Timestamp that was passed when a discontinuity was detected, i.e. the first
    /// timestamp after the discontinuity.
    ///
    /// # Returns
    ///
    /// The last timestamp at when a discontinuity was detected
    #[doc(alias = "gst_audio_stream_align_get_timestamp_at_discont")]
    #[doc(alias = "get_timestamp_at_discont")]
    pub fn timestamp_at_discont(&self) -> Option<gst::ClockTime> {
        unsafe {
            from_glib(ffi::gst_audio_stream_align_get_timestamp_at_discont(
                self.to_glib_none().0,
            ))
        }
    }

    /// Marks the next buffer as discontinuous and resets timestamp tracking.
    #[doc(alias = "gst_audio_stream_align_mark_discont")]
    pub fn mark_discont(&mut self) {
        unsafe {
            ffi::gst_audio_stream_align_mark_discont(self.to_glib_none_mut().0);
        }
    }

    /// Sets `alignment_treshold` as new alignment threshold for the following processing.
    /// ## `alignment_threshold`
    /// a new alignment threshold
    #[doc(alias = "gst_audio_stream_align_set_alignment_threshold")]
    pub fn set_alignment_threshold(&mut self, alignment_threshold: gst::ClockTime) {
        unsafe {
            ffi::gst_audio_stream_align_set_alignment_threshold(
                self.to_glib_none_mut().0,
                alignment_threshold.into_glib(),
            );
        }
    }

    /// Sets `alignment_treshold` as new discont wait for the following processing.
    /// ## `discont_wait`
    /// a new discont wait
    #[doc(alias = "gst_audio_stream_align_set_discont_wait")]
    pub fn set_discont_wait(&mut self, discont_wait: gst::ClockTime) {
        unsafe {
            ffi::gst_audio_stream_align_set_discont_wait(
                self.to_glib_none_mut().0,
                discont_wait.into_glib(),
            );
        }
    }

    /// 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
    #[doc(alias = "gst_audio_stream_align_set_rate")]
    pub fn set_rate(&mut self, rate: i32) {
        unsafe {
            ffi::gst_audio_stream_align_set_rate(self.to_glib_none_mut().0, rate);
        }
    }
}

unsafe impl Send for AudioStreamAlign {}
unsafe impl Sync for AudioStreamAlign {}