// 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, Caps, Object, StreamFlags, StreamType, TagList};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A high-level object representing a single stream. It might be backed, or
    /// not, by an actual flow of data in a pipeline ([`Pad`][crate::Pad]).
    ///
    /// A [`Stream`][crate::Stream] does not care about data changes (such as decoding, encoding,
    /// parsing,...) as long as the underlying data flow corresponds to the same
    /// high-level flow (ex: a certain audio track).
    ///
    /// A [`Stream`][crate::Stream] contains all the information pertinent to a stream, such as
    /// stream-id, tags, caps, type, ...
    ///
    /// Elements can subclass a [`Stream`][crate::Stream] for internal usage (to contain information
    /// pertinent to streams of data).
    ///
    /// ## Properties
    ///
    ///
    /// #### `caps`
    ///  The [`Caps`][crate::Caps] of the [`Stream`][crate::Stream].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `stream-flags`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `stream-id`
    ///  The unique identifier of the [`Stream`][crate::Stream]. Can only be set at construction
    /// time.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `stream-type`
    ///  The [`StreamType`][crate::StreamType] of the [`Stream`][crate::Stream]. Can only be set at construction time.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `tags`
    ///  The [`TagList`][crate::TagList] of the [`Stream`][crate::Stream].
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `name`
    ///  Readable | Writeable | Construct
    ///
    ///
    /// #### `parent`
    ///  The parent of the object. Please note, that when changing the 'parent'
    /// property, we don't emit [`notify`][struct@crate::glib::Object#notify] and [`deep-notify`][struct@crate::Object#deep-notify]
    /// signals due to locking issues. In some cases one can use
    /// [`element-added`][struct@crate::Bin#element-added] or [`element-removed`][struct@crate::Bin#element-removed] signals on the parent to
    /// achieve a similar effect.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`GstObjectExt`][trait@crate::prelude::GstObjectExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GstStream")]
    pub struct Stream(Object<ffi::GstStream, ffi::GstStreamClass>) @extends Object;

    match fn {
        type_ => || ffi::gst_stream_get_type(),
    }
}

impl Stream {
    /// Create a new [`Stream`][crate::Stream] for the given `stream_id`, `caps`, `type_`
    /// and `flags`
    /// ## `stream_id`
    /// the id for the new stream. If [`None`],
    /// a new one will be automatically generated
    /// ## `caps`
    /// the [`Caps`][crate::Caps] of the stream
    /// ## `type_`
    /// the [`StreamType`][crate::StreamType] of the stream
    /// ## `flags`
    /// the [`StreamFlags`][crate::StreamFlags] of the stream
    ///
    /// # Returns
    ///
    /// The new [`Stream`][crate::Stream]
    #[doc(alias = "gst_stream_new")]
    pub fn new(
        stream_id: Option<&str>,
        caps: Option<&Caps>,
        type_: StreamType,
        flags: StreamFlags,
    ) -> Stream {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gst_stream_new(
                stream_id.to_glib_none().0,
                caps.to_glib_none().0,
                type_.into_glib(),
                flags.into_glib(),
            ))
        }
    }

    /// Retrieve the caps for `self`, if any
    ///
    /// # Returns
    ///
    /// The [`Caps`][crate::Caps] for `self`
    #[doc(alias = "gst_stream_get_caps")]
    #[doc(alias = "get_caps")]
    pub fn caps(&self) -> Option<Caps> {
        unsafe { from_glib_full(ffi::gst_stream_get_caps(self.to_glib_none().0)) }
    }

    /// Retrieve the current stream flags for `self`
    ///
    /// # Returns
    ///
    /// The [`StreamFlags`][crate::StreamFlags] for `self`
    #[doc(alias = "gst_stream_get_stream_flags")]
    #[doc(alias = "get_stream_flags")]
    #[doc(alias = "stream-flags")]
    pub fn stream_flags(&self) -> StreamFlags {
        unsafe { from_glib(ffi::gst_stream_get_stream_flags(self.to_glib_none().0)) }
    }

    /// Returns the stream ID of `self`.
    ///
    /// # Returns
    ///
    /// the stream ID of `self`. Only valid
    /// during the lifetime of `self`.
    #[doc(alias = "gst_stream_get_stream_id")]
    #[doc(alias = "get_stream_id")]
    #[doc(alias = "stream-id")]
    pub fn stream_id(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::gst_stream_get_stream_id(self.to_glib_none().0)) }
    }

    /// Retrieve the stream type for `self`
    ///
    /// # Returns
    ///
    /// The [`StreamType`][crate::StreamType] for `self`
    #[doc(alias = "gst_stream_get_stream_type")]
    #[doc(alias = "get_stream_type")]
    #[doc(alias = "stream-type")]
    pub fn stream_type(&self) -> StreamType {
        unsafe { from_glib(ffi::gst_stream_get_stream_type(self.to_glib_none().0)) }
    }

    /// Retrieve the tags for `self`, if any
    ///
    /// # Returns
    ///
    /// The [`TagList`][crate::TagList] for `self`
    #[doc(alias = "gst_stream_get_tags")]
    #[doc(alias = "get_tags")]
    pub fn tags(&self) -> Option<TagList> {
        unsafe { from_glib_full(ffi::gst_stream_get_tags(self.to_glib_none().0)) }
    }

    /// Set the caps for the [`Stream`][crate::Stream]
    /// ## `caps`
    /// a [`Caps`][crate::Caps]
    #[doc(alias = "gst_stream_set_caps")]
    #[doc(alias = "caps")]
    pub fn set_caps(&self, caps: Option<&Caps>) {
        unsafe {
            ffi::gst_stream_set_caps(self.to_glib_none().0, caps.to_glib_none().0);
        }
    }

    /// Set the `flags` for the `self`.
    /// ## `flags`
    /// the flags to set on `self`
    #[doc(alias = "gst_stream_set_stream_flags")]
    #[doc(alias = "stream-flags")]
    pub fn set_stream_flags(&self, flags: StreamFlags) {
        unsafe {
            ffi::gst_stream_set_stream_flags(self.to_glib_none().0, flags.into_glib());
        }
    }

    /// Set the stream type of `self`
    /// ## `stream_type`
    /// the type to set on `self`
    #[doc(alias = "gst_stream_set_stream_type")]
    #[doc(alias = "stream-type")]
    pub fn set_stream_type(&self, stream_type: StreamType) {
        unsafe {
            ffi::gst_stream_set_stream_type(self.to_glib_none().0, stream_type.into_glib());
        }
    }

    /// Set the tags for the [`Stream`][crate::Stream]
    /// ## `tags`
    /// a [`TagList`][crate::TagList]
    #[doc(alias = "gst_stream_set_tags")]
    #[doc(alias = "tags")]
    pub fn set_tags(&self, tags: Option<&TagList>) {
        unsafe {
            ffi::gst_stream_set_tags(self.to_glib_none().0, tags.to_glib_none().0);
        }
    }

    #[doc(alias = "caps")]
    pub fn connect_caps_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_caps_trampoline<F: Fn(&Stream) + Send + Sync + 'static>(
            this: *mut ffi::GstStream,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::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(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_caps_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "stream-flags")]
    pub fn connect_stream_flags_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_stream_flags_trampoline<
            F: Fn(&Stream) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstStream,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::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::stream-flags\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_stream_flags_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "stream-type")]
    pub fn connect_stream_type_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_stream_type_trampoline<
            F: Fn(&Stream) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstStream,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::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::stream-type\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_stream_type_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "tags")]
    pub fn connect_tags_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_tags_trampoline<F: Fn(&Stream) + Send + Sync + 'static>(
            this: *mut ffi::GstStream,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::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::tags\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_tags_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

unsafe impl Send for Stream {}
unsafe impl Sync for Stream {}