// 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 Bin;
use ChildProxy;
use Clock;
use ClockTime;
use Element;
use Object;
use ffi;
use glib;
use glib::object::Downcast;
use glib::object::IsA;
use glib::signal::SignalHandlerId;
use glib::signal::connect;
use glib::translate::*;
use glib_ffi;
use gobject_ffi;
use std::boxed::Box as Box_;
use std::mem;
use std::mem::transmute;
use std::ptr;

glib_wrapper! {
    /// A `Pipeline` is a special `Bin` used as the toplevel container for
    /// the filter graph. The `Pipeline` will manage the selection and
    /// distribution of a global `Clock` as well as provide a `Bus` to the
    /// application.
    ///
    /// `Pipeline::new` is used to create a pipeline. when you are done with
    /// the pipeline, use `GstObjectExt::unref` to free its resources including all
    /// added `Element` objects (if not otherwise referenced).
    ///
    /// Elements are added and removed from the pipeline using the `Bin`
    /// methods like `BinExt::add` and `BinExt::remove` (see `Bin`).
    ///
    /// Before changing the state of the `Pipeline` (see `Element`) a `Bus`
    /// can be retrieved with `Pipeline::get_bus`. This bus can then be
    /// used to receive `Message` from the elements in the pipeline.
    ///
    /// By default, a `Pipeline` will automatically flush the pending `Bus`
    /// messages when going to the NULL state to ensure that no circular
    /// references exist when no messages are read from the `Bus`. This
    /// behaviour can be changed with `PipelineExt::set_auto_flush_bus`.
    ///
    /// When the `Pipeline` performs the PAUSED to PLAYING state change it will
    /// select a clock for the elements. The clock selection algorithm will by
    /// default select a clock provided by an element that is most upstream
    /// (closest to the source). For live pipelines (ones that return
    /// `StateChangeReturn::NoPreroll` from the `ElementExt::set_state` call) this
    /// will select the clock provided by the live source. For normal pipelines
    /// this will select a clock provided by the sinks (most likely the audio
    /// sink). If no element provides a clock, a default `SystemClock` is used.
    ///
    /// The clock selection can be controlled with the `PipelineExt::use_clock`
    /// method, which will enforce a given clock on the pipeline. With
    /// `PipelineExt::auto_clock` the default clock selection algorithm can be
    /// restored.
    ///
    /// A `Pipeline` maintains a running time for the elements. The running
    /// time is defined as the difference between the current clock time and
    /// the base time. When the pipeline goes to READY or a flushing seek is
    /// performed on it, the running time is reset to 0. When the pipeline is
    /// set from PLAYING to PAUSED, the current clock time is sampled and used to
    /// configure the base time for the elements when the pipeline is set
    /// to PLAYING again. The effect is that the running time (as the difference
    /// between the clock time and the base time) will count how much time was spent
    /// in the PLAYING state. This default behaviour can be changed with the
    /// `ElementExt::set_start_time` method.
    ///
    /// # Implements
    ///
    /// [`PipelineExt`](trait.PipelineExt.html), [`BinExt`](trait.BinExt.html), [`ElementExt`](trait.ElementExt.html), [`GstObjectExt`](trait.GstObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ChildProxyExt`](trait.ChildProxyExt.html)
    pub struct Pipeline(Object<ffi::GstPipeline, ffi::GstPipelineClass>): Bin, Element, Object, ChildProxy;

    match fn {
        get_type => || ffi::gst_pipeline_get_type(),
    }
}

impl Pipeline {
    /// Create a new pipeline with the given name.
    /// ## `name`
    /// name of new pipeline
    ///
    /// # Returns
    ///
    /// newly created GstPipeline
    ///
    /// MT safe.
    pub fn new<'a, P: Into<Option<&'a str>>>(name: P) -> Pipeline {
        assert_initialized_main_thread!();
        let name = name.into();
        let name = name.to_glib_none();
        unsafe {
            Element::from_glib_none(ffi::gst_pipeline_new(name.0)).downcast_unchecked()
        }
    }
}

unsafe impl Send for Pipeline {}
unsafe impl Sync for Pipeline {}

/// Trait containing all `Pipeline` methods.
///
/// # Implementors
///
/// [`Pipeline`](struct.Pipeline.html)
pub trait PipelineExt {
    /// Let `self` select a clock automatically. This is the default
    /// behaviour.
    ///
    /// Use this function if you previous forced a fixed clock with
    /// `PipelineExt::use_clock` and want to restore the default
    /// pipeline clock selection algorithm.
    ///
    /// MT safe.
    fn auto_clock(&self);

    /// Check if `self` will automatically flush messages when going to
    /// the NULL state.
    ///
    /// # Returns
    ///
    /// whether the pipeline will automatically flush its bus when
    /// going from READY to NULL state or not.
    ///
    /// MT safe.
    fn get_auto_flush_bus(&self) -> bool;

    /// Get the configured delay (see `PipelineExt::set_delay`).
    ///
    /// # Returns
    ///
    /// The configured delay.
    ///
    /// MT safe.
    fn get_delay(&self) -> ClockTime;

    /// Gets the latency that should be configured on the pipeline. See
    /// `PipelineExt::set_latency`.
    ///
    /// # Returns
    ///
    /// Latency to configure on the pipeline or GST_CLOCK_TIME_NONE
    fn get_latency(&self) -> ClockTime;

    /// Gets the current clock used by `self`.
    ///
    /// Unlike `ElementExt::get_clock`, this function will always return a
    /// clock, even if the pipeline is not in the PLAYING state.
    ///
    /// # Returns
    ///
    /// a `Clock`, unref after usage.
    fn get_pipeline_clock(&self) -> Option<Clock>;

    /// Usually, when a pipeline goes from READY to NULL state, it automatically
    /// flushes all pending messages on the bus, which is done for refcounting
    /// purposes, to break circular references.
    ///
    /// This means that applications that update state using (async) bus messages
    /// (e.g. do certain things when a pipeline goes from PAUSED to READY) might
    /// not get to see messages when the pipeline is shut down, because they might
    /// be flushed before they can be dispatched in the main thread. This behaviour
    /// can be disabled using this function.
    ///
    /// It is important that all messages on the bus are handled when the
    /// automatic flushing is disabled else memory leaks will be introduced.
    ///
    /// MT safe.
    /// ## `auto_flush`
    /// whether or not to automatically flush the bus when
    /// the pipeline goes from READY to NULL state
    fn set_auto_flush_bus(&self, auto_flush: bool);

    /// Set the expected delay needed for all elements to perform the
    /// PAUSED to PLAYING state change. `delay` will be added to the
    /// base time of the elements so that they wait an additional `delay`
    /// amount of time before starting to process buffers and cannot be
    /// `GST_CLOCK_TIME_NONE`.
    ///
    /// This option is used for tuning purposes and should normally not be
    /// used.
    ///
    /// MT safe.
    /// ## `delay`
    /// the delay
    fn set_delay(&self, delay: ClockTime);

    /// Sets the latency that should be configured on the pipeline. Setting
    /// GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum
    /// latency from the LATENCY query. Setting this is usually not required and
    /// the pipeline will figure out an appropriate latency automatically.
    ///
    /// Setting a too low latency, especially lower than the minimum latency from
    /// the LATENCY query, will most likely cause the pipeline to fail.
    /// ## `latency`
    /// latency to configure
    fn set_latency(&self, latency: ClockTime);

    /// Force `self` to use the given `clock`. The pipeline will
    /// always use the given clock even if new clock providers are added
    /// to this pipeline.
    ///
    /// If `clock` is `None` all clocking will be disabled which will make
    /// the pipeline run as fast as possible.
    ///
    /// MT safe.
    /// ## `clock`
    /// the clock to use
    fn use_clock<'a, P: IsA<Clock> + 'a, Q: Into<Option<&'a P>>>(&self, clock: Q);

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

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

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

impl<O: IsA<Pipeline> + IsA<glib::object::Object>> PipelineExt for O {
    fn auto_clock(&self) {
        unsafe {
            ffi::gst_pipeline_auto_clock(self.to_glib_none().0);
        }
    }

    fn get_auto_flush_bus(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_pipeline_get_auto_flush_bus(self.to_glib_none().0))
        }
    }

    fn get_delay(&self) -> ClockTime {
        unsafe {
            from_glib(ffi::gst_pipeline_get_delay(self.to_glib_none().0))
        }
    }

    fn get_latency(&self) -> ClockTime {
        unsafe {
            from_glib(ffi::gst_pipeline_get_latency(self.to_glib_none().0))
        }
    }

    fn get_pipeline_clock(&self) -> Option<Clock> {
        unsafe {
            from_glib_full(ffi::gst_pipeline_get_pipeline_clock(self.to_glib_none().0))
        }
    }

    fn set_auto_flush_bus(&self, auto_flush: bool) {
        unsafe {
            ffi::gst_pipeline_set_auto_flush_bus(self.to_glib_none().0, auto_flush.to_glib());
        }
    }

    fn set_delay(&self, delay: ClockTime) {
        unsafe {
            ffi::gst_pipeline_set_delay(self.to_glib_none().0, delay.to_glib());
        }
    }

    fn set_latency(&self, latency: ClockTime) {
        unsafe {
            ffi::gst_pipeline_set_latency(self.to_glib_none().0, latency.to_glib());
        }
    }

    fn use_clock<'a, P: IsA<Clock> + 'a, Q: Into<Option<&'a P>>>(&self, clock: Q) {
        let clock = clock.into();
        let clock = clock.to_glib_none();
        unsafe {
            ffi::gst_pipeline_use_clock(self.to_glib_none().0, clock.0);
        }
    }

    fn connect_property_auto_flush_bus_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe {
            let f: Box_<Box_<Fn(&Self) + Send + Sync + 'static>> = Box_::new(Box_::new(f));
            connect(self.to_glib_none().0, "notify::auto-flush-bus",
                transmute(notify_auto_flush_bus_trampoline::<Self> as usize), Box_::into_raw(f) as *mut _)
        }
    }

    fn connect_property_delay_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe {
            let f: Box_<Box_<Fn(&Self) + Send + Sync + 'static>> = Box_::new(Box_::new(f));
            connect(self.to_glib_none().0, "notify::delay",
                transmute(notify_delay_trampoline::<Self> as usize), Box_::into_raw(f) as *mut _)
        }
    }

    fn connect_property_latency_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe {
            let f: Box_<Box_<Fn(&Self) + Send + Sync + 'static>> = Box_::new(Box_::new(f));
            connect(self.to_glib_none().0, "notify::latency",
                transmute(notify_latency_trampoline::<Self> as usize), Box_::into_raw(f) as *mut _)
        }
    }
}

unsafe extern "C" fn notify_auto_flush_bus_trampoline<P>(this: *mut ffi::GstPipeline, _param_spec: glib_ffi::gpointer, f: glib_ffi::gpointer)
where P: IsA<Pipeline> {
    let f: &&(Fn(&P) + Send + Sync + 'static) = transmute(f);
    f(&Pipeline::from_glib_borrow(this).downcast_unchecked())
}

unsafe extern "C" fn notify_delay_trampoline<P>(this: *mut ffi::GstPipeline, _param_spec: glib_ffi::gpointer, f: glib_ffi::gpointer)
where P: IsA<Pipeline> {
    let f: &&(Fn(&P) + Send + Sync + 'static) = transmute(f);
    f(&Pipeline::from_glib_borrow(this).downcast_unchecked())
}

unsafe extern "C" fn notify_latency_trampoline<P>(this: *mut ffi::GstPipeline, _param_spec: glib_ffi::gpointer, f: glib_ffi::gpointer)
where P: IsA<Pipeline> {
    let f: &&(Fn(&P) + Send + Sync + 'static) = transmute(f);
    f(&Pipeline::from_glib_borrow(this).downcast_unchecked())
}