// 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::GString;
use glib_sys;
use gst_sys;
use std::boxed::Box as Box_;
use std::mem::transmute;
use Caps;
use Element;
use Object;
use Structure;

glib_wrapper! {
    /// `Device` are objects representing a device, they contain
    /// relevant metadata about the device, such as its class and the `Caps`
    /// representing the media types it can produce or handle.
    ///
    /// `Device` are created by `DeviceProvider` objects which can be
    /// aggregated by `DeviceMonitor` objects.
    ///
    /// # Implements
    ///
    /// [`DeviceExt`](trait.DeviceExt.html), [`GstObjectExt`](trait.GstObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
    pub struct Device(Object<gst_sys::GstDevice, gst_sys::GstDeviceClass, DeviceClass>) @extends Object;

    match fn {
        get_type => || gst_sys::gst_device_get_type(),
    }
}

unsafe impl Send for Device {}
unsafe impl Sync for Device {}

pub const NONE_DEVICE: Option<&Device> = None;

/// Trait containing all `Device` methods.
///
/// # Implementors
///
/// [`Device`](struct.Device.html)
pub trait DeviceExt: 'static {
    /// Creates the element with all of the required parameters set to use
    /// this device.
    /// ## `name`
    /// name of new element, or `None` to automatically
    /// create a unique name.
    ///
    /// # Returns
    ///
    /// a new `Element` configured to use
    /// this device
    fn create_element(&self, name: Option<&str>) -> Result<Element, glib::BoolError>;

    /// Getter for the `Caps` that this device supports.
    ///
    /// # Returns
    ///
    /// The `Caps` supported by this device. Unref with
    /// `gst_caps_unref` when done.
    fn get_caps(&self) -> Option<Caps>;

    /// Gets the "class" of a device. This is a "/" separated list of
    /// classes that represent this device. They are a subset of the
    /// classes of the `DeviceProvider` that produced this device.
    ///
    /// # Returns
    ///
    /// The device class. Free with `g_free` after use.
    fn get_device_class(&self) -> GString;

    /// Gets the user-friendly name of the device.
    ///
    /// # Returns
    ///
    /// The device name. Free with `g_free` after use.
    fn get_display_name(&self) -> GString;

    /// Gets the extra properties of a device.
    ///
    /// # Returns
    ///
    /// The extra properties or `None` when there are none.
    ///  Free with `Structure::free` after use.
    fn get_properties(&self) -> Option<Structure>;

    /// Check if `self` matches all of the given classes
    /// ## `classes`
    /// a "/"-separated list of device classes to match, only match if
    ///  all classes are matched
    ///
    /// # Returns
    ///
    /// `true` if `self` matches.
    fn has_classes(&self, classes: &str) -> bool;

    /// Check if `factory` matches all of the given classes
    /// ## `classes`
    /// a `None` terminated array of classes
    ///  to match, only match if all classes are matched
    ///
    /// # Returns
    ///
    /// `true` if `self` matches.
    fn has_classesv(&self, classes: &[&str]) -> bool;

    /// Tries to reconfigure an existing element to use the device. If this
    /// function fails, then one must destroy the element and create a new one
    /// using `DeviceExt::create_element`.
    ///
    /// Note: This should only be implemented for elements can change their
    /// device in the PLAYING state.
    /// ## `element`
    /// a `Element`
    ///
    /// # Returns
    ///
    /// `true` if the element could be reconfigured to use this device,
    /// `false` otherwise.
    fn reconfigure_element<P: IsA<Element>>(
        &self,
        element: &P,
    ) -> Result<(), glib::error::BoolError>;

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

impl<O: IsA<Device>> DeviceExt for O {
    fn create_element(&self, name: Option<&str>) -> Result<Element, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_none(gst_sys::gst_device_create_element(
                self.as_ref().to_glib_none().0,
                name.to_glib_none().0,
            ))
            .ok_or_else(|| glib_bool_error!("Failed to create element for device"))
        }
    }

    fn get_caps(&self) -> Option<Caps> {
        unsafe { from_glib_full(gst_sys::gst_device_get_caps(self.as_ref().to_glib_none().0)) }
    }

    fn get_device_class(&self) -> GString {
        unsafe {
            from_glib_full(gst_sys::gst_device_get_device_class(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_display_name(&self) -> GString {
        unsafe {
            from_glib_full(gst_sys::gst_device_get_display_name(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn get_properties(&self) -> Option<Structure> {
        unsafe {
            from_glib_full(gst_sys::gst_device_get_properties(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn has_classes(&self, classes: &str) -> bool {
        unsafe {
            from_glib(gst_sys::gst_device_has_classes(
                self.as_ref().to_glib_none().0,
                classes.to_glib_none().0,
            ))
        }
    }

    fn has_classesv(&self, classes: &[&str]) -> bool {
        unsafe {
            from_glib(gst_sys::gst_device_has_classesv(
                self.as_ref().to_glib_none().0,
                classes.to_glib_none().0,
            ))
        }
    }

    fn reconfigure_element<P: IsA<Element>>(
        &self,
        element: &P,
    ) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib_result_from_gboolean!(
                gst_sys::gst_device_reconfigure_element(
                    self.as_ref().to_glib_none().0,
                    element.as_ref().to_glib_none().0
                ),
                "Failed to reconfigure the element to use this device"
            )
        }
    }

    fn connect_removed<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn removed_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut gst_sys::GstDevice,
            f: glib_sys::gpointer,
        ) where
            P: IsA<Device>,
        {
            let f: &F = &*(f as *const F);
            f(&Device::from_glib_borrow(this).unsafe_cast())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"removed\0".as_ptr() as *const _,
                Some(transmute(removed_trampoline::<Self, F> as usize)),
                Box_::into_raw(f),
            )
        }
    }
}