// 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::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::Value;
use glib_sys;
use gobject_sys;
use gst;
use gst_app_sys;
use gst_base;
use std::boxed::Box as Box_;
use std::mem::transmute;

glib_wrapper! {
    /// Appsink is a sink plugin that supports many different methods for making
    /// the application get a handle on the GStreamer data in a pipeline. Unlike
    /// most GStreamer elements, Appsink provides external API functions.
    ///
    /// appsink can be used by linking to the gstappsink.h header file to access the
    /// methods or by using the appsink action signals and properties.
    ///
    /// The normal way of retrieving samples from appsink is by using the
    /// `AppSink::pull_sample` and `AppSink::pull_preroll` methods.
    /// These methods block until a sample becomes available in the sink or when the
    /// sink is shut down or reaches EOS. There are also timed variants of these
    /// methods, `AppSink::try_pull_sample` and `AppSink::try_pull_preroll`,
    /// which accept a timeout parameter to limit the amount of time to wait.
    ///
    /// Appsink will internally use a queue to collect buffers from the streaming
    /// thread. If the application is not pulling samples fast enough, this queue
    /// will consume a lot of memory over time. The "max-buffers" property can be
    /// used to limit the queue size. The "drop" property controls whether the
    /// streaming thread blocks or if older buffers are dropped when the maximum
    /// queue size is reached. Note that blocking the streaming thread can negatively
    /// affect real-time performance and should be avoided.
    ///
    /// If a blocking behaviour is not desirable, setting the "emit-signals" property
    /// to `true` will make appsink emit the "new-sample" and "new-preroll" signals
    /// when a sample can be pulled without blocking.
    ///
    /// The "caps" property on appsink can be used to control the formats that
    /// appsink can receive. This property can contain non-fixed caps, the format of
    /// the pulled samples can be obtained by getting the sample caps.
    ///
    /// If one of the pull-preroll or pull-sample methods return `None`, the appsink
    /// is stopped or in the EOS state. You can check for the EOS state with the
    /// "eos" property or with the `AppSink::is_eos` method.
    ///
    /// The eos signal can also be used to be informed when the EOS state is reached
    /// to avoid polling.
    ///
    /// # Implements
    ///
    /// [`gst_base::BaseSinkExt`](../gst_base/trait.BaseSinkExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`gst::URIHandlerExt`](../gst/trait.URIHandlerExt.html)
    pub struct AppSink(Object<gst_app_sys::GstAppSink, gst_app_sys::GstAppSinkClass, AppSinkClass>) @extends gst_base::BaseSink, gst::Element, gst::Object, @implements gst::URIHandler;

    match fn {
        get_type => || gst_app_sys::gst_app_sink_get_type(),
    }
}

impl AppSink {
    /// Check if `self` supports buffer lists.
    ///
    /// Feature: `v1_12`
    ///
    ///
    /// # Returns
    ///
    /// `true` if `self` supports buffer lists.
    #[cfg(any(feature = "v1_12", feature = "dox"))]
    pub fn get_buffer_list_support(&self) -> bool {
        unsafe {
            from_glib(gst_app_sys::gst_app_sink_get_buffer_list_support(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the configured caps on `self`.
    ///
    /// # Returns
    ///
    /// the `gst::Caps` accepted by the sink. `gst_caps_unref` after usage.
    pub fn get_caps(&self) -> Option<gst::Caps> {
        unsafe { from_glib_full(gst_app_sys::gst_app_sink_get_caps(self.to_glib_none().0)) }
    }

    /// Check if `self` will drop old buffers when the maximum amount of queued
    /// buffers is reached.
    ///
    /// # Returns
    ///
    /// `true` if `self` is dropping old buffers when the queue is
    /// filled.
    pub fn get_drop(&self) -> bool {
        unsafe { from_glib(gst_app_sys::gst_app_sink_get_drop(self.to_glib_none().0)) }
    }

    /// Check if appsink will emit the "new-preroll" and "new-sample" signals.
    ///
    /// # Returns
    ///
    /// `true` if `self` is emiting the "new-preroll" and "new-sample"
    /// signals.
    pub fn get_emit_signals(&self) -> bool {
        unsafe {
            from_glib(gst_app_sys::gst_app_sink_get_emit_signals(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the maximum amount of buffers that can be queued in `self`.
    ///
    /// # Returns
    ///
    /// The maximum amount of buffers that can be queued.
    pub fn get_max_buffers(&self) -> u32 {
        unsafe { gst_app_sys::gst_app_sink_get_max_buffers(self.to_glib_none().0) }
    }

    /// Check if `self` will wait for all buffers to be consumed when an EOS is
    /// received.
    ///
    /// # Returns
    ///
    /// `true` if `self` will wait for all buffers to be consumed when an
    /// EOS is received.
    pub fn get_wait_on_eos(&self) -> bool {
        unsafe {
            from_glib(gst_app_sys::gst_app_sink_get_wait_on_eos(
                self.to_glib_none().0,
            ))
        }
    }

    /// Check if `self` is EOS, which is when no more samples can be pulled because
    /// an EOS event was received.
    ///
    /// This function also returns `true` when the appsink is not in the PAUSED or
    /// PLAYING state.
    ///
    /// # Returns
    ///
    /// `true` if no more samples can be pulled and the appsink is EOS.
    pub fn is_eos(&self) -> bool {
        unsafe { from_glib(gst_app_sys::gst_app_sink_is_eos(self.to_glib_none().0)) }
    }

    /// Get the last preroll sample in `self`. This was the sample that caused the
    /// appsink to preroll in the PAUSED state.
    ///
    /// This function is typically used when dealing with a pipeline in the PAUSED
    /// state. Calling this function after doing a seek will give the sample right
    /// after the seek position.
    ///
    /// Calling this function will clear the internal reference to the preroll
    /// buffer.
    ///
    /// Note that the preroll sample will also be returned as the first sample
    /// when calling `AppSink::pull_sample`.
    ///
    /// If an EOS event was received before any buffers, this function returns
    /// `None`. Use gst_app_sink_is_eos () to check for the EOS condition.
    ///
    /// This function blocks until a preroll sample or EOS is received or the appsink
    /// element is set to the READY/NULL state.
    ///
    /// # Returns
    ///
    /// a `gst::Sample` or NULL when the appsink is stopped or EOS.
    ///  Call `gst_sample_unref` after usage.
    pub fn pull_preroll(&self) -> Result<gst::Sample, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_app_sys::gst_app_sink_pull_preroll(
                self.to_glib_none().0,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to pull preroll sample"))
        }
    }

    /// This function blocks until a sample or EOS becomes available or the appsink
    /// element is set to the READY/NULL state.
    ///
    /// This function will only return samples when the appsink is in the PLAYING
    /// state. All rendered buffers will be put in a queue so that the application
    /// can pull samples at its own rate. Note that when the application does not
    /// pull samples fast enough, the queued buffers could consume a lot of memory,
    /// especially when dealing with raw video frames.
    ///
    /// If an EOS event was received before any buffers, this function returns
    /// `None`. Use gst_app_sink_is_eos () to check for the EOS condition.
    ///
    /// # Returns
    ///
    /// a `gst::Sample` or NULL when the appsink is stopped or EOS.
    ///  Call `gst_sample_unref` after usage.
    pub fn pull_sample(&self) -> Result<gst::Sample, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(gst_app_sys::gst_app_sink_pull_sample(
                self.to_glib_none().0,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to pull sample"))
        }
    }

    /// Instruct `self` to enable or disable buffer list support.
    ///
    /// For backwards-compatibility reasons applications need to opt in
    /// to indicate that they will be able to handle buffer lists.
    ///
    /// Feature: `v1_12`
    ///
    /// ## `enable_lists`
    /// enable or disable buffer list support
    #[cfg(any(feature = "v1_12", feature = "dox"))]
    pub fn set_buffer_list_support(&self, enable_lists: bool) {
        unsafe {
            gst_app_sys::gst_app_sink_set_buffer_list_support(
                self.to_glib_none().0,
                enable_lists.to_glib(),
            );
        }
    }

    //pub fn set_callbacks(&self, callbacks: /*Ignored*/&mut AppSinkCallbacks, user_data: /*Unimplemented*/Option<Fundamental: Pointer>) {
    //    unsafe { TODO: call gst_app_sys:gst_app_sink_set_callbacks() }
    //}

    /// Set the capabilities on the appsink element. This function takes
    /// a copy of the caps structure. After calling this method, the sink will only
    /// accept caps that match `caps`. If `caps` is non-fixed, or incomplete,
    /// you must check the caps on the samples to get the actual used caps.
    /// ## `caps`
    /// caps to set
    pub fn set_caps(&self, caps: Option<&gst::Caps>) {
        unsafe {
            gst_app_sys::gst_app_sink_set_caps(self.to_glib_none().0, caps.to_glib_none().0);
        }
    }

    /// Instruct `self` to drop old buffers when the maximum amount of queued
    /// buffers is reached.
    /// ## `drop`
    /// the new state
    pub fn set_drop(&self, drop: bool) {
        unsafe {
            gst_app_sys::gst_app_sink_set_drop(self.to_glib_none().0, drop.to_glib());
        }
    }

    /// Make appsink emit the "new-preroll" and "new-sample" signals. This option is
    /// by default disabled because signal emission is expensive and unneeded when
    /// the application prefers to operate in pull mode.
    /// ## `emit`
    /// the new state
    pub fn set_emit_signals(&self, emit: bool) {
        unsafe {
            gst_app_sys::gst_app_sink_set_emit_signals(self.to_glib_none().0, emit.to_glib());
        }
    }

    /// Set the maximum amount of buffers that can be queued in `self`. After this
    /// amount of buffers are queued in appsink, any more buffers will block upstream
    /// elements until a sample is pulled from `self`.
    /// ## `max`
    /// the maximum number of buffers to queue
    pub fn set_max_buffers(&self, max: u32) {
        unsafe {
            gst_app_sys::gst_app_sink_set_max_buffers(self.to_glib_none().0, max);
        }
    }

    /// Instruct `self` to wait for all buffers to be consumed when an EOS is received.
    /// ## `wait`
    /// the new state
    pub fn set_wait_on_eos(&self, wait: bool) {
        unsafe {
            gst_app_sys::gst_app_sink_set_wait_on_eos(self.to_glib_none().0, wait.to_glib());
        }
    }

    /// Get the last preroll sample in `self`. This was the sample that caused the
    /// appsink to preroll in the PAUSED state.
    ///
    /// This function is typically used when dealing with a pipeline in the PAUSED
    /// state. Calling this function after doing a seek will give the sample right
    /// after the seek position.
    ///
    /// Calling this function will clear the internal reference to the preroll
    /// buffer.
    ///
    /// Note that the preroll sample will also be returned as the first sample
    /// when calling `AppSink::pull_sample`.
    ///
    /// If an EOS event was received before any buffers or the timeout expires,
    /// this function returns `None`. Use gst_app_sink_is_eos () to check for the EOS
    /// condition.
    ///
    /// This function blocks until a preroll sample or EOS is received, the appsink
    /// element is set to the READY/NULL state, or the timeout expires.
    ///
    /// Feature: `v1_10`
    ///
    /// ## `timeout`
    /// the maximum amount of time to wait for the preroll sample
    ///
    /// # Returns
    ///
    /// a `gst::Sample` or NULL when the appsink is stopped or EOS or the timeout expires.
    ///  Call `gst_sample_unref` after usage.
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    pub fn try_pull_preroll(&self, timeout: gst::ClockTime) -> Option<gst::Sample> {
        unsafe {
            from_glib_full(gst_app_sys::gst_app_sink_try_pull_preroll(
                self.to_glib_none().0,
                timeout.to_glib(),
            ))
        }
    }

    /// This function blocks until a sample or EOS becomes available or the appsink
    /// element is set to the READY/NULL state or the timeout expires.
    ///
    /// This function will only return samples when the appsink is in the PLAYING
    /// state. All rendered buffers will be put in a queue so that the application
    /// can pull samples at its own rate. Note that when the application does not
    /// pull samples fast enough, the queued buffers could consume a lot of memory,
    /// especially when dealing with raw video frames.
    ///
    /// If an EOS event was received before any buffers or the timeout expires,
    /// this function returns `None`. Use gst_app_sink_is_eos () to check for the EOS
    /// condition.
    ///
    /// Feature: `v1_10`
    ///
    /// ## `timeout`
    /// the maximum amount of time to wait for a sample
    ///
    /// # Returns
    ///
    /// a `gst::Sample` or NULL when the appsink is stopped or EOS or the timeout expires.
    /// Call `gst_sample_unref` after usage.
    #[cfg(any(feature = "v1_10", feature = "dox"))]
    pub fn try_pull_sample(&self, timeout: gst::ClockTime) -> Option<gst::Sample> {
        unsafe {
            from_glib_full(gst_app_sys::gst_app_sink_try_pull_sample(
                self.to_glib_none().0,
                timeout.to_glib(),
            ))
        }
    }

    pub fn get_property_buffer_list(&self) -> bool {
        unsafe {
            let mut value = Value::from_type(<bool as StaticType>::static_type());
            gobject_sys::g_object_get_property(
                self.as_ptr() as *mut gobject_sys::GObject,
                b"buffer-list\0".as_ptr() as *const _,
                value.to_glib_none_mut().0,
            );
            value
                .get()
                .expect("Return Value for property `buffer-list` getter")
                .unwrap()
        }
    }

    pub fn set_property_buffer_list(&self, buffer_list: bool) {
        unsafe {
            gobject_sys::g_object_set_property(
                self.as_ptr() as *mut gobject_sys::GObject,
                b"buffer-list\0".as_ptr() as *const _,
                Value::from(&buffer_list).to_glib_none().0,
            );
        }
    }

    pub fn get_property_eos(&self) -> bool {
        unsafe {
            let mut value = Value::from_type(<bool as StaticType>::static_type());
            gobject_sys::g_object_get_property(
                self.as_ptr() as *mut gobject_sys::GObject,
                b"eos\0".as_ptr() as *const _,
                value.to_glib_none_mut().0,
            );
            value
                .get()
                .expect("Return Value for property `eos` getter")
                .unwrap()
        }
    }

    /// Signal that the end-of-stream has been reached. This signal is emitted from
    /// the streaming thread.
    pub fn connect_eos<F: Fn(&AppSink) + Send + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn eos_trampoline<F: Fn(&AppSink) + Send + 'static>(
            this: *mut gst_app_sys::GstAppSink,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"eos\0".as_ptr() as *const _,
                Some(transmute(eos_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_buffer_list_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_buffer_list_trampoline<
            F: Fn(&AppSink) + Send + Sync + 'static,
        >(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::buffer-list\0".as_ptr() as *const _,
                Some(transmute(notify_buffer_list_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_caps_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_caps_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::caps\0".as_ptr() as *const _,
                Some(transmute(notify_caps_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_drop_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_drop_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::drop\0".as_ptr() as *const _,
                Some(transmute(notify_drop_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_emit_signals_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_emit_signals_trampoline<
            F: Fn(&AppSink) + Send + Sync + 'static,
        >(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::emit-signals\0".as_ptr() as *const _,
                Some(transmute(notify_emit_signals_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_eos_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_eos_trampoline<F: Fn(&AppSink) + Send + Sync + 'static>(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::eos\0".as_ptr() as *const _,
                Some(transmute(notify_eos_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_max_buffers_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_buffers_trampoline<
            F: Fn(&AppSink) + Send + Sync + 'static,
        >(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::max-buffers\0".as_ptr() as *const _,
                Some(transmute(notify_max_buffers_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_wait_on_eos_notify<F: Fn(&AppSink) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_wait_on_eos_trampoline<
            F: Fn(&AppSink) + Send + Sync + 'static,
        >(
            this: *mut gst_app_sys::GstAppSink,
            _param_spec: glib_sys::gpointer,
            f: glib_sys::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::wait-on-eos\0".as_ptr() as *const _,
                Some(transmute(notify_wait_on_eos_trampoline::<F> as usize)),
                Box_::into_raw(f),
            )
        }
    }
}

unsafe impl Send for AppSink {}
unsafe impl Sync for AppSink {}