// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use glib;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib_sys;
use gst;
use gst_audio_sys;
use std::boxed::Box as Box_;
use std::mem;
use std::mem::transmute;
use AudioInfo;

glib_wrapper! {
    /// This base class is for audio decoders turning encoded data into
    /// raw audio samples.
    ///
    /// GstAudioDecoder and subclass should cooperate as follows.
    ///
    /// ## Configuration
    ///
    ///  * Initially, GstAudioDecoder calls `start` when the decoder element
    ///  is activated, which allows subclass to perform any global setup.
    ///  Base class (context) parameters can already be set according to subclass
    ///  capabilities (or possibly upon receive more information in subsequent
    ///  `set_format`).
    ///  * GstAudioDecoder calls `set_format` to inform subclass of the format
    ///  of input audio data that it is about to receive.
    ///  While unlikely, it might be called more than once, if changing input
    ///  parameters require reconfiguration.
    ///  * GstAudioDecoder calls `stop` at end of all processing.
    ///
    /// As of configuration stage, and throughout processing, GstAudioDecoder
    /// provides various (context) parameters, e.g. describing the format of
    /// output audio data (valid when output caps have been set) or current parsing state.
    /// Conversely, subclass can and should configure context to inform
    /// base class of its expectation w.r.t. buffer handling.
    ///
    /// ## Data processing
    ///  * Base class gathers input data, and optionally allows subclass
    ///  to parse this into subsequently manageable (as defined by subclass)
    ///  chunks. Such chunks are subsequently referred to as 'frames',
    ///  though they may or may not correspond to 1 (or more) audio format frame.
    ///  * Input frame is provided to subclass' `handle_frame`.
    ///  * If codec processing results in decoded data, subclass should call
    ///  `AudioDecoder::finish_frame` to have decoded data pushed
    ///  downstream.
    ///  * Just prior to actually pushing a buffer downstream,
    ///  it is passed to `pre_push`. Subclass should either use this callback
    ///  to arrange for additional downstream pushing or otherwise ensure such
    ///  custom pushing occurs after at least a method call has finished since
    ///  setting src pad caps.
    ///  * During the parsing process GstAudioDecoderClass will handle both
    ///  srcpad and sinkpad events. Sink events will be passed to subclass
    ///  if `event` callback has been provided.
    ///
    /// ## Shutdown phase
    ///
    ///  * GstAudioDecoder class calls `stop` to inform the subclass that data
    ///  parsing will be stopped.
    ///
    /// Subclass is responsible for providing pad template caps for
    /// source and sink pads. The pads need to be named "sink" and "src". It also
    /// needs to set the fixed caps on srcpad, when the format is ensured. This
    /// is typically when base class calls subclass' `set_format` function, though
    /// it might be delayed until calling `AudioDecoder::finish_frame`.
    ///
    /// In summary, above process should have subclass concentrating on
    /// codec data processing while leaving other matters to base class,
    /// such as most notably timestamp handling. While it may exert more control
    /// in this area (see e.g. `pre_push`), it is very much not recommended.
    ///
    /// In particular, base class will try to arrange for perfect output timestamps
    /// as much as possible while tracking upstream timestamps.
    /// To this end, if deviation between the next ideal expected perfect timestamp
    /// and upstream exceeds `AudioDecoder:tolerance`, then resync to upstream
    /// occurs (which would happen always if the tolerance mechanism is disabled).
    ///
    /// In non-live pipelines, baseclass can also (configurably) arrange for
    /// output buffer aggregation which may help to redue large(r) numbers of
    /// small(er) buffers being pushed and processed downstream. Note that this
    /// feature is only available if the buffer layout is interleaved. For planar
    /// buffers, the decoder implementation is fully responsible for the output
    /// buffer size.
    ///
    /// On the other hand, it should be noted that baseclass only provides limited
    /// seeking support (upon explicit subclass request), as full-fledged support
    /// should rather be left to upstream demuxer, parser or alike. This simple
    /// approach caters for seeking and duration reporting using estimated input
    /// bitrates.
    ///
    /// Things that subclass need to take care of:
    ///
    ///  * Provide pad templates
    ///  * Set source pad caps when appropriate
    ///  * Set user-configurable properties to sane defaults for format and
    ///  implementing codec at hand, and convey some subclass capabilities and
    ///  expectations in context.
    ///
    ///  * Accept data in `handle_frame` and provide encoded results to
    ///  `AudioDecoder::finish_frame`. If it is prepared to perform
    ///  PLC, it should also accept NULL data in `handle_frame` and provide for
    ///  data for indicated duration.
    ///
    /// # Implements
    ///
    /// [`AudioDecoderExt`](trait.AudioDecoderExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AudioDecoderExtManual`](prelude/trait.AudioDecoderExtManual.html)
    pub struct AudioDecoder(Object<gst_audio_sys::GstAudioDecoder, gst_audio_sys::GstAudioDecoderClass, AudioDecoderClass>) @extends gst::Element, gst::Object;

    match fn {
        get_type => || gst_audio_sys::gst_audio_decoder_get_type(),
    }
}

unsafe impl Send for AudioDecoder {}
unsafe impl Sync for AudioDecoder {}

pub const NONE_AUDIO_DECODER: Option<&AudioDecoder> = None;

/// Trait containing all `AudioDecoder` methods.
///
/// # Implementors
///
/// [`AudioDecoder`](struct.AudioDecoder.html)
pub trait AudioDecoderExt: 'static {
    /// Helper function that allocates a buffer to hold an audio frame
    /// for `self`'s current output format.
    /// ## `size`
    /// size of the buffer
    ///
    /// # Returns
    ///
    /// allocated buffer
    fn allocate_output_buffer(&self, size: usize) -> Result<gst::Buffer, glib::BoolError>;

    ///
    /// # Returns
    ///
    /// a `AudioInfo` describing the input audio format
    fn get_audio_info(&self) -> Option<AudioInfo>;

    ///
    /// # Returns
    ///
    /// currently configured decoder delay
    fn get_delay(&self) -> i32;

    /// Queries decoder drain handling.
    ///
    /// # Returns
    ///
    /// TRUE if drainable handling is enabled.
    ///
    /// MT safe.
    fn get_drainable(&self) -> bool;

    ///
    /// # Returns
    ///
    /// currently configured byte to time conversion setting
    fn get_estimate_rate(&self) -> i32;

    /// Sets the variables pointed to by `min` and `max` to the currently configured
    /// latency.
    /// ## `min`
    /// a pointer to storage to hold minimum latency
    /// ## `max`
    /// a pointer to storage to hold maximum latency
    fn get_latency(&self) -> (gst::ClockTime, gst::ClockTime);

    ///
    /// # Returns
    ///
    /// currently configured decoder tolerated error count.
    fn get_max_errors(&self) -> i32;

    /// Queries decoder's latency aggregation.
    ///
    /// # Returns
    ///
    /// aggregation latency.
    ///
    /// MT safe.
    fn get_min_latency(&self) -> gst::ClockTime;

    /// Queries decoder required format handling.
    ///
    /// # Returns
    ///
    /// TRUE if required format handling is enabled.
    ///
    /// MT safe.
    fn get_needs_format(&self) -> bool;

    /// Return current parsing (sync and eos) state.
    /// ## `sync`
    /// a pointer to a variable to hold the current sync state
    /// ## `eos`
    /// a pointer to a variable to hold the current eos state
    fn get_parse_state(&self) -> (bool, bool);

    /// Queries decoder packet loss concealment handling.
    ///
    /// # Returns
    ///
    /// TRUE if packet loss concealment is enabled.
    ///
    /// MT safe.
    fn get_plc(&self) -> bool;

    ///
    /// # Returns
    ///
    /// currently configured plc handling
    fn get_plc_aware(&self) -> i32;

    /// Queries current audio jitter tolerance threshold.
    ///
    /// # Returns
    ///
    /// decoder audio jitter tolerance threshold.
    ///
    /// MT safe.
    fn get_tolerance(&self) -> gst::ClockTime;

    /// Sets the audio decoder tags and how they should be merged with any
    /// upstream stream tags. This will override any tags previously-set
    /// with `AudioDecoderExt::merge_tags`.
    ///
    /// Note that this is provided for convenience, and the subclass is
    /// not required to use this and can still do tag handling on its own.
    /// ## `tags`
    /// a `gst::TagList` to merge, or NULL
    /// ## `mode`
    /// the `gst::TagMergeMode` to use, usually `gst::TagMergeMode::Replace`
    fn merge_tags(&self, tags: Option<&gst::TagList>, mode: gst::TagMergeMode);

    /// Returns caps that express `caps` (or sink template caps if `caps` == NULL)
    /// restricted to rate/channels/... combinations supported by downstream
    /// elements.
    /// ## `caps`
    /// initial caps
    /// ## `filter`
    /// filter caps
    ///
    /// # Returns
    ///
    /// a `gst::Caps` owned by caller
    fn proxy_getcaps(&self, caps: Option<&gst::Caps>, filter: Option<&gst::Caps>) -> gst::Caps;

    /// Sets a caps in allocation query which are different from the set
    /// pad's caps. Use this function before calling
    /// `AudioDecoder::negotiate`. Setting to `None` the allocation
    /// query will use the caps from the pad.
    ///
    /// Feature: `v1_10`
    ///
    /// ## `allocation_caps`
    /// a `gst::Caps` or `None`
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    fn set_allocation_caps(&self, allocation_caps: Option<&gst::Caps>);

    /// Configures decoder drain handling. If drainable, subclass might
    /// be handed a NULL buffer to have it return any leftover decoded data.
    /// Otherwise, it is not considered so capable and will only ever be passed
    /// real data.
    ///
    /// MT safe.
    /// ## `enabled`
    /// new state
    fn set_drainable(&self, enabled: bool);

    /// Allows baseclass to perform byte to time estimated conversion.
    /// ## `enabled`
    /// whether to enable byte to time conversion
    fn set_estimate_rate(&self, enabled: bool);

    /// Sets decoder latency.
    /// ## `min`
    /// minimum latency
    /// ## `max`
    /// maximum latency
    fn set_latency(&self, min: gst::ClockTime, max: gst::ClockTime);

    /// Sets numbers of tolerated decoder errors, where a tolerated one is then only
    /// warned about, but more than tolerated will lead to fatal error. You can set
    /// -1 for never returning fatal errors. Default is set to
    /// GST_AUDIO_DECODER_MAX_ERRORS.
    /// ## `num`
    /// max tolerated errors
    fn set_max_errors(&self, num: i32);

    /// Sets decoder minimum aggregation latency.
    ///
    /// MT safe.
    /// ## `num`
    /// new minimum latency
    fn set_min_latency(&self, num: gst::ClockTime);

    /// Configures decoder format needs. If enabled, subclass needs to be
    /// negotiated with format caps before it can process any data. It will then
    /// never be handed any data before it has been configured.
    /// Otherwise, it might be handed data without having been configured and
    /// is then expected being able to do so either by default
    /// or based on the input data.
    ///
    /// MT safe.
    /// ## `enabled`
    /// new state
    fn set_needs_format(&self, enabled: bool);

    /// Enable or disable decoder packet loss concealment, provided subclass
    /// and codec are capable and allow handling plc.
    ///
    /// MT safe.
    /// ## `enabled`
    /// new state
    fn set_plc(&self, enabled: bool);

    /// Indicates whether or not subclass handles packet loss concealment (plc).
    /// ## `plc`
    /// new plc state
    fn set_plc_aware(&self, plc: bool);

    /// Configures decoder audio jitter tolerance threshold.
    ///
    /// MT safe.
    /// ## `tolerance`
    /// new tolerance
    fn set_tolerance(&self, tolerance: gst::ClockTime);

    /// Lets `AudioDecoder` sub-classes decide if they want the sink pad
    /// to use the default pad query handler to reply to accept-caps queries.
    ///
    /// By setting this to true it is possible to further customize the default
    /// handler with `GST_PAD_SET_ACCEPT_INTERSECT` and
    /// `GST_PAD_SET_ACCEPT_TEMPLATE`
    /// ## `use_`
    /// if the default pad accept-caps query handling should be used
    fn set_use_default_pad_acceptcaps(&self, use_: bool);

    #[cfg(any(feature = "v1_18", feature = "dox"))]
    fn connect_property_max_errors_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    fn connect_property_min_latency_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    fn connect_property_plc_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    fn connect_property_tolerance_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;
}

impl<O: IsA<AudioDecoder>> AudioDecoderExt for O {
    fn allocate_output_buffer(&self, size: usize) -> Result<gst::Buffer, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_audio_sys::gst_audio_decoder_allocate_output_buffer(
                self.as_ref().to_glib_none().0,
                size,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to allocate output buffer"))
        }
    }

    fn get_audio_info(&self) -> Option<AudioInfo> {
        unsafe {
            from_glib_full(gst_audio_sys::gst_audio_decoder_get_audio_info(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_delay(&self) -> i32 {
        unsafe { gst_audio_sys::gst_audio_decoder_get_delay(self.as_ref().to_glib_none().0) }
    }

    fn get_drainable(&self) -> bool {
        unsafe {
            from_glib(gst_audio_sys::gst_audio_decoder_get_drainable(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_estimate_rate(&self) -> i32 {
        unsafe {
            gst_audio_sys::gst_audio_decoder_get_estimate_rate(self.as_ref().to_glib_none().0)
        }
    }

    fn get_latency(&self) -> (gst::ClockTime, gst::ClockTime) {
        unsafe {
            let mut min = mem::MaybeUninit::uninit();
            let mut max = mem::MaybeUninit::uninit();
            gst_audio_sys::gst_audio_decoder_get_latency(
                self.as_ref().to_glib_none().0,
                min.as_mut_ptr(),
                max.as_mut_ptr(),
            );
            let min = min.assume_init();
            let max = max.assume_init();
            (from_glib(min), from_glib(max))
        }
    }

    fn get_max_errors(&self) -> i32 {
        unsafe { gst_audio_sys::gst_audio_decoder_get_max_errors(self.as_ref().to_glib_none().0) }
    }

    fn get_min_latency(&self) -> gst::ClockTime {
        unsafe {
            from_glib(gst_audio_sys::gst_audio_decoder_get_min_latency(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_needs_format(&self) -> bool {
        unsafe {
            from_glib(gst_audio_sys::gst_audio_decoder_get_needs_format(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_parse_state(&self) -> (bool, bool) {
        unsafe {
            let mut sync = mem::MaybeUninit::uninit();
            let mut eos = mem::MaybeUninit::uninit();
            gst_audio_sys::gst_audio_decoder_get_parse_state(
                self.as_ref().to_glib_none().0,
                sync.as_mut_ptr(),
                eos.as_mut_ptr(),
            );
            let sync = sync.assume_init();
            let eos = eos.assume_init();
            (from_glib(sync), from_glib(eos))
        }
    }

    fn get_plc(&self) -> bool {
        unsafe {
            from_glib(gst_audio_sys::gst_audio_decoder_get_plc(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_plc_aware(&self) -> i32 {
        unsafe { gst_audio_sys::gst_audio_decoder_get_plc_aware(self.as_ref().to_glib_none().0) }
    }

    fn get_tolerance(&self) -> gst::ClockTime {
        unsafe {
            from_glib(gst_audio_sys::gst_audio_decoder_get_tolerance(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn merge_tags(&self, tags: Option<&gst::TagList>, mode: gst::TagMergeMode) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_merge_tags(
                self.as_ref().to_glib_none().0,
                tags.to_glib_none().0,
                mode.to_glib(),
            );
        }
    }

    fn proxy_getcaps(&self, caps: Option<&gst::Caps>, filter: Option<&gst::Caps>) -> gst::Caps {
        unsafe {
            from_glib_full(gst_audio_sys::gst_audio_decoder_proxy_getcaps(
                self.as_ref().to_glib_none().0,
                caps.to_glib_none().0,
                filter.to_glib_none().0,
            ))
        }
    }

    #[cfg(any(feature = "v1_10", feature = "dox"))]
    fn set_allocation_caps(&self, allocation_caps: Option<&gst::Caps>) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_allocation_caps(
                self.as_ref().to_glib_none().0,
                allocation_caps.to_glib_none().0,
            );
        }
    }

    fn set_drainable(&self, enabled: bool) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_drainable(
                self.as_ref().to_glib_none().0,
                enabled.to_glib(),
            );
        }
    }

    fn set_estimate_rate(&self, enabled: bool) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_estimate_rate(
                self.as_ref().to_glib_none().0,
                enabled.to_glib(),
            );
        }
    }

    fn set_latency(&self, min: gst::ClockTime, max: gst::ClockTime) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_latency(
                self.as_ref().to_glib_none().0,
                min.to_glib(),
                max.to_glib(),
            );
        }
    }

    fn set_max_errors(&self, num: i32) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_max_errors(self.as_ref().to_glib_none().0, num);
        }
    }

    fn set_min_latency(&self, num: gst::ClockTime) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_min_latency(
                self.as_ref().to_glib_none().0,
                num.to_glib(),
            );
        }
    }

    fn set_needs_format(&self, enabled: bool) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_needs_format(
                self.as_ref().to_glib_none().0,
                enabled.to_glib(),
            );
        }
    }

    fn set_plc(&self, enabled: bool) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_plc(
                self.as_ref().to_glib_none().0,
                enabled.to_glib(),
            );
        }
    }

    fn set_plc_aware(&self, plc: bool) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_plc_aware(
                self.as_ref().to_glib_none().0,
                plc.to_glib(),
            );
        }
    }

    fn set_tolerance(&self, tolerance: gst::ClockTime) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_tolerance(
                self.as_ref().to_glib_none().0,
                tolerance.to_glib(),
            );
        }
    }

    fn set_use_default_pad_acceptcaps(&self, use_: bool) {
        unsafe {
            gst_audio_sys::gst_audio_decoder_set_use_default_pad_acceptcaps(
                self.as_ref().to_glib_none().0,
                use_.to_glib(),
            );
        }
    }

    #[cfg(any(feature = "v1_18", feature = "dox"))]
    fn connect_property_max_errors_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_errors_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut gst_audio_sys::GstAudioDecoder,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) where
            P: IsA<AudioDecoder>,
        {
            let f: &F = &*(f as *const F);
            f(&AudioDecoder::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::max-errors\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_max_errors_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_property_min_latency_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_min_latency_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut gst_audio_sys::GstAudioDecoder,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) where
            P: IsA<AudioDecoder>,
        {
            let f: &F = &*(f as *const F);
            f(&AudioDecoder::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::min-latency\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_min_latency_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_property_plc_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_plc_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut gst_audio_sys::GstAudioDecoder,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) where
            P: IsA<AudioDecoder>,
        {
            let f: &F = &*(f as *const F);
            f(&AudioDecoder::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::plc\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_plc_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_property_tolerance_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_tolerance_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut gst_audio_sys::GstAudioDecoder,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) where
            P: IsA<AudioDecoder>,
        {
            let f: &F = &*(f as *const F);
            f(&AudioDecoder::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::tolerance\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_tolerance_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}