// 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::DiscovererResult;
use crate::DiscovererSerializeFlags;
use crate::DiscovererStreamInfo;
use glib::translate::*;

glib::wrapper! {
    /// Structure containing the information of a URI analyzed by [`crate::Discoverer`].
    ///
    /// # Implements
    ///
    /// [`trait@glib::object::ObjectExt`]
    pub struct DiscovererInfo(Object<ffi::GstDiscovererInfo>);

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

impl DiscovererInfo {
    ///
    /// # Returns
    ///
    /// A copy of the [`crate::DiscovererInfo`]
    #[doc(alias = "gst_discoverer_info_copy")]
    pub fn copy(&self) -> DiscovererInfo {
        unsafe { from_glib_full(ffi::gst_discoverer_info_copy(self.to_glib_none().0)) }
    }

    /// Finds all the [`crate::DiscovererAudioInfo`] contained in `self`
    ///
    /// # Returns
    ///
    /// A [`crate::glib::List`] of
    /// matching [`crate::DiscovererStreamInfo`]. The caller should free it with
    /// [`crate::DiscovererStreamInfo::list_free()`].
    #[doc(alias = "gst_discoverer_info_get_audio_streams")]
    #[doc(alias = "get_audio_streams")]
    pub fn audio_streams(&self) -> Vec<DiscovererStreamInfo> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_discoverer_info_get_audio_streams(
                self.to_glib_none().0,
            ))
        }
    }

    /// Finds all the [`crate::DiscovererContainerInfo`] contained in `self`
    ///
    /// # Returns
    ///
    /// A [`crate::glib::List`] of
    /// matching [`crate::DiscovererStreamInfo`]. The caller should free it with
    /// [`crate::DiscovererStreamInfo::list_free()`].
    #[doc(alias = "gst_discoverer_info_get_container_streams")]
    #[doc(alias = "get_container_streams")]
    pub fn container_streams(&self) -> Vec<DiscovererStreamInfo> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_discoverer_info_get_container_streams(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the duration of the URI in [`crate::gst::ClockTime`] (nanoseconds).
    #[doc(alias = "gst_discoverer_info_get_duration")]
    #[doc(alias = "get_duration")]
    pub fn duration(&self) -> gst::ClockTime {
        unsafe { from_glib(ffi::gst_discoverer_info_get_duration(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// whether the URI is live.
    #[cfg(any(feature = "v1_14", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_14")))]
    #[doc(alias = "gst_discoverer_info_get_live")]
    #[doc(alias = "get_live")]
    pub fn is_live(&self) -> bool {
        unsafe { from_glib(ffi::gst_discoverer_info_get_live(self.to_glib_none().0)) }
    }

    ///
    /// # Deprecated
    ///
    /// This functions is deprecated since version 1.4, use
    /// [`Self::get_missing_elements_installer_details`]
    ///
    /// # Returns
    ///
    /// Miscellaneous information stored as a [`crate::gst::Structure`]
    /// (for example: information about missing plugins). If you wish to use the
    /// [`crate::gst::Structure`] after the life-time of `self`, you will need to copy it.
    #[doc(alias = "gst_discoverer_info_get_misc")]
    #[doc(alias = "get_misc")]
    pub fn misc(&self) -> Option<gst::Structure> {
        unsafe { from_glib_none(ffi::gst_discoverer_info_get_misc(self.to_glib_none().0)) }
    }

    /// Get the installer details for missing elements
    ///
    /// # Returns
    ///
    /// An array of strings
    /// containing information about how to install the various missing elements
    /// for `self` to be usable. If you wish to use the strings after the life-time
    /// of `self`, you will need to copy them.
    #[doc(alias = "gst_discoverer_info_get_missing_elements_installer_details")]
    #[doc(alias = "get_missing_elements_installer_details")]
    pub fn missing_elements_installer_details(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(
                ffi::gst_discoverer_info_get_missing_elements_installer_details(
                    self.to_glib_none().0,
                ),
            )
        }
    }

    ///
    /// # Returns
    ///
    /// the result of the discovery as a [`crate::DiscovererResult`].
    #[doc(alias = "gst_discoverer_info_get_result")]
    #[doc(alias = "get_result")]
    pub fn result(&self) -> DiscovererResult {
        unsafe { from_glib(ffi::gst_discoverer_info_get_result(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// the whether the URI is seekable.
    #[doc(alias = "gst_discoverer_info_get_seekable")]
    #[doc(alias = "get_seekable")]
    pub fn is_seekable(&self) -> bool {
        unsafe { from_glib(ffi::gst_discoverer_info_get_seekable(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// the structure (or topology) of the URI as a
    /// [`crate::DiscovererStreamInfo`].
    /// This structure can be traversed to see the original hierarchy. Unref with
    /// `gst_discoverer_stream_info_unref()` after usage.
    #[doc(alias = "gst_discoverer_info_get_stream_info")]
    #[doc(alias = "get_stream_info")]
    pub fn stream_info(&self) -> Option<DiscovererStreamInfo> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_info_get_stream_info(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the list of
    /// all streams contained in the `info`. Free after usage
    /// with [`crate::DiscovererStreamInfo::list_free()`].
    #[doc(alias = "gst_discoverer_info_get_stream_list")]
    #[doc(alias = "get_stream_list")]
    pub fn stream_list(&self) -> Vec<DiscovererStreamInfo> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_discoverer_info_get_stream_list(
                self.to_glib_none().0,
            ))
        }
    }

    /// Finds the [`crate::DiscovererStreamInfo`] contained in `self` that match the
    /// given `streamtype`.
    /// ## `streamtype`
    /// a [`crate::glib::Type`] derived from [`crate::DiscovererStreamInfo`]
    ///
    /// # Returns
    ///
    /// A [`crate::glib::List`] of
    /// matching [`crate::DiscovererStreamInfo`]. The caller should free it with
    /// [`crate::DiscovererStreamInfo::list_free()`].
    #[doc(alias = "gst_discoverer_info_get_streams")]
    #[doc(alias = "get_streams")]
    pub fn streams(&self, streamtype: glib::types::Type) -> Vec<DiscovererStreamInfo> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_discoverer_info_get_streams(
                self.to_glib_none().0,
                streamtype.into_glib(),
            ))
        }
    }

    /// Finds all the [`crate::DiscovererSubtitleInfo`] contained in `self`
    ///
    /// # Returns
    ///
    /// A [`crate::glib::List`] of
    /// matching [`crate::DiscovererStreamInfo`]. The caller should free it with
    /// [`crate::DiscovererStreamInfo::list_free()`].
    #[doc(alias = "gst_discoverer_info_get_subtitle_streams")]
    #[doc(alias = "get_subtitle_streams")]
    pub fn subtitle_streams(&self) -> Vec<DiscovererStreamInfo> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_discoverer_info_get_subtitle_streams(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// all tags contained in the URI. If you wish to use
    /// the tags after the life-time of `self`, you will need to copy them.
    #[doc(alias = "gst_discoverer_info_get_tags")]
    #[doc(alias = "get_tags")]
    pub fn tags(&self) -> Option<gst::TagList> {
        unsafe { from_glib_none(ffi::gst_discoverer_info_get_tags(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// TOC contained in the URI. If you wish to use
    /// the TOC after the life-time of `self`, you will need to copy it.
    #[doc(alias = "gst_discoverer_info_get_toc")]
    #[doc(alias = "get_toc")]
    pub fn toc(&self) -> Option<gst::Toc> {
        unsafe { from_glib_none(ffi::gst_discoverer_info_get_toc(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// the URI to which this information corresponds to.
    /// Copy it if you wish to use it after the life-time of `self`.
    #[doc(alias = "gst_discoverer_info_get_uri")]
    #[doc(alias = "get_uri")]
    pub fn uri(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::gst_discoverer_info_get_uri(self.to_glib_none().0)) }
    }

    /// Finds all the [`crate::DiscovererVideoInfo`] contained in `self`
    ///
    /// # Returns
    ///
    /// A [`crate::glib::List`] of
    /// matching [`crate::DiscovererStreamInfo`]. The caller should free it with
    /// [`crate::DiscovererStreamInfo::list_free()`].
    #[doc(alias = "gst_discoverer_info_get_video_streams")]
    #[doc(alias = "get_video_streams")]
    pub fn video_streams(&self) -> Vec<DiscovererStreamInfo> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gst_discoverer_info_get_video_streams(
                self.to_glib_none().0,
            ))
        }
    }

    /// Serializes `self` to a [`crate::glib::Variant`] that can be parsed again
    /// through [`Self::from_variant()`].
    ///
    /// Note that any [`crate::gst::Toc`] (s) that might have been discovered will not be serialized
    /// for now.
    /// ## `flags`
    /// A combination of [`crate::DiscovererSerializeFlags`] to specify
    /// what needs to be serialized.
    ///
    /// # Returns
    ///
    /// A newly-allocated [`crate::glib::Variant`] representing `self`.
    #[doc(alias = "gst_discoverer_info_to_variant")]
    pub fn to_variant(
        &self,
        flags: DiscovererSerializeFlags,
    ) -> Result<glib::Variant, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_discoverer_info_to_variant(
                self.to_glib_none().0,
                flags.into_glib(),
            ))
            .ok_or_else(|| glib::bool_error!("Failed to serialize DiscovererInfo to Variant"))
        }
    }

    /// Parses a [`crate::glib::Variant`] as produced by [`Self::to_variant()`]
    /// back to a [`crate::DiscovererInfo`].
    /// ## `variant`
    /// A [`crate::glib::Variant`] to deserialize into a [`crate::DiscovererInfo`].
    ///
    /// # Returns
    ///
    /// A newly-allocated [`crate::DiscovererInfo`].
    #[doc(alias = "gst_discoverer_info_from_variant")]
    pub fn from_variant(variant: &glib::Variant) -> Result<DiscovererInfo, glib::BoolError> {
        assert_initialized_main_thread!();
        unsafe {
            Option::<_>::from_glib_full(ffi::gst_discoverer_info_from_variant(
                variant.to_glib_none().0,
            ))
            .ok_or_else(|| glib::bool_error!("Failed to deserialize DiscovererInfo from Variant"))
        }
    }
}

unsafe impl Send for DiscovererInfo {}
unsafe impl Sync for DiscovererInfo {}