gstreamer/

caps_features.rs

// Take a look at the license at the top of the repository in the LICENSE file.

use std::{
    borrow::{Borrow, BorrowMut, ToOwned},
    fmt,
    marker::PhantomData,
    mem,
    ops::{Deref, DerefMut},
    ptr, str,
};

use crate::{IdStr, ffi};
use cfg_if::cfg_if;
use glib::{prelude::*, translate::*};
use std::sync::LazyLock;

/// [`CapsFeatures`][crate::CapsFeatures] can optionally be set on a [`Caps`][crate::Caps] to add requirements
/// for additional features for a specific [`Structure`][crate::Structure]. Caps structures with
/// the same name but with a non-equal set of caps features are not compatible.
/// If a pad supports multiple sets of features it has to add multiple equal
/// structures with different feature sets to the caps.
///
/// Empty [`CapsFeatures`][crate::CapsFeatures] are equivalent with the [`CapsFeatures`][crate::CapsFeatures] that only
/// contain `GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY`. ANY [`CapsFeatures`][crate::CapsFeatures] as
/// created by [`new_any()`][Self::new_any()] are equal to any other [`CapsFeatures`][crate::CapsFeatures]
/// and can be used to specify that any [`CapsFeatures`][crate::CapsFeatures] would be supported, e.g.
/// for elements that don't touch buffer memory. [`Caps`][crate::Caps] with ANY [`CapsFeatures`][crate::CapsFeatures]
/// are considered non-fixed and during negotiation some [`CapsFeatures`][crate::CapsFeatures] have
/// to be selected.
///
/// Examples for caps features would be the requirement of a specific [`Memory`][crate::Memory]
/// types or the requirement of having a specific `GstMeta` on the buffer. Features
/// are given as a string of the format `memory:GstMemoryTypeName` or
/// `meta:GstMetaAPIName`.
#[doc(alias = "GstCapsFeatures")]
#[repr(transparent)]
pub struct CapsFeatures(ptr::NonNull<ffi::GstCapsFeatures>);
unsafe impl Send for CapsFeatures {}
unsafe impl Sync for CapsFeatures {}

impl CapsFeatures {
    /// Creates a new [`CapsFeatures`][crate::CapsFeatures] with the given features.
    /// The last argument must be [`None`].
    /// ## `feature1`
    /// name of first feature to set
    ///
    /// # Returns
    ///
    /// a new, empty [`CapsFeatures`][crate::CapsFeatures]
    #[doc(alias = "gst_caps_features_new")]
    pub fn new<S: IntoGStr>(features: impl IntoIterator<Item = S>) -> Self {
        skip_assert_initialized!();
        let mut f = Self::new_empty();

        for feature in features {
            f.add(feature);
        }

        f
    }

    #[doc(alias = "gst_caps_features_new_static_str")]
    pub fn new_from_static<S: AsRef<glib::GStr> + 'static>(
        features: impl IntoIterator<Item = S>,
    ) -> Self {
        skip_assert_initialized!();
        let mut f = Self::new_empty();

        for feature in features {
            f.add_from_static(feature);
        }

        f
    }

    #[doc(alias = "gst_caps_features_new_id_str")]
    pub fn new_from_id<S: AsRef<IdStr>>(features: impl IntoIterator<Item = S>) -> Self {
        skip_assert_initialized!();
        let mut f = Self::new_empty();

        for feature in features {
            f.add_from_id(feature);
        }

        f
    }

    #[deprecated = "use `new_by_id()` instead"]
    #[allow(deprecated)]
    #[doc(alias = "gst_caps_features_new_id")]
    pub fn from_quarks(features: impl IntoIterator<Item = glib::Quark>) -> Self {
        skip_assert_initialized!();
        let mut f = Self::new_empty();

        for feature in features.into_iter() {
            f.add_from_quark(feature);
        }

        f
    }

    /// Creates a new, empty [`CapsFeatures`][crate::CapsFeatures].
    ///
    /// # Returns
    ///
    /// a new, empty [`CapsFeatures`][crate::CapsFeatures]
    #[doc(alias = "gst_caps_features_new_empty")]
    pub fn new_empty() -> Self {
        assert_initialized_main_thread!();
        unsafe {
            CapsFeatures(ptr::NonNull::new_unchecked(
                ffi::gst_caps_features_new_empty(),
            ))
        }
    }

    /// Creates a new, ANY [`CapsFeatures`][crate::CapsFeatures]. This will be equal
    /// to any other [`CapsFeatures`][crate::CapsFeatures] but caps with these are
    /// unfixed.
    ///
    /// # Returns
    ///
    /// a new, ANY [`CapsFeatures`][crate::CapsFeatures]
    #[doc(alias = "gst_caps_features_new_any")]
    pub fn new_any() -> Self {
        assert_initialized_main_thread!();
        unsafe { CapsFeatures(ptr::NonNull::new_unchecked(ffi::gst_caps_features_new_any())) }
    }
}

impl IntoGlibPtr<*mut ffi::GstCapsFeatures> for CapsFeatures {
    #[inline]
    fn into_glib_ptr(self) -> *mut ffi::GstCapsFeatures {
        let s = mem::ManuallyDrop::new(self);
        s.0.as_ptr()
    }
}

impl Deref for CapsFeatures {
    type Target = CapsFeaturesRef;

    #[inline]
    fn deref(&self) -> &CapsFeaturesRef {
        unsafe { &*(self.0.as_ref() as *const ffi::GstCapsFeatures as *const CapsFeaturesRef) }
    }
}

impl DerefMut for CapsFeatures {
    #[inline]
    fn deref_mut(&mut self) -> &mut CapsFeaturesRef {
        unsafe { &mut *(self.0.as_mut() as *mut ffi::GstCapsFeatures as *mut CapsFeaturesRef) }
    }
}

impl AsRef<CapsFeaturesRef> for CapsFeatures {
    #[inline]
    fn as_ref(&self) -> &CapsFeaturesRef {
        self.deref()
    }
}

impl AsMut<CapsFeaturesRef> for CapsFeatures {
    #[inline]
    fn as_mut(&mut self) -> &mut CapsFeaturesRef {
        self.deref_mut()
    }
}

impl Clone for CapsFeatures {
    #[inline]
    fn clone(&self) -> Self {
        unsafe {
            let ptr = ffi::gst_caps_features_copy(self.0.as_ref());
            debug_assert!(!ptr.is_null());
            CapsFeatures(ptr::NonNull::new_unchecked(ptr))
        }
    }
}

impl Drop for CapsFeatures {
    #[inline]
    fn drop(&mut self) {
        unsafe { ffi::gst_caps_features_free(self.0.as_mut()) }
    }
}

impl fmt::Debug for CapsFeatures {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_tuple("CapsFeatures")
            .field(&self.to_string())
            .finish()
    }
}

impl fmt::Display for CapsFeatures {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        // Need to make sure to not call ToString::to_string() here, which
        // we have because of the Display impl. We need CapsFeaturesRef::to_string()
        f.write_str(&CapsFeaturesRef::to_string(self.as_ref()))
    }
}

impl str::FromStr for CapsFeatures {
    type Err = glib::BoolError;

    #[doc(alias = "gst_caps_features_from_string")]
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        assert_initialized_main_thread!();
        unsafe {
            let ptr = s.run_with_gstr(|s| ffi::gst_caps_features_from_string(s.as_ptr()));
            if ptr.is_null() {
                return Err(glib::bool_error!(
                    "Failed to parse caps features from string"
                ));
            }

            Ok(Self(ptr::NonNull::new_unchecked(ptr)))
        }
    }
}

impl Borrow<CapsFeaturesRef> for CapsFeatures {
    #[inline]
    fn borrow(&self) -> &CapsFeaturesRef {
        self.as_ref()
    }
}

impl BorrowMut<CapsFeaturesRef> for CapsFeatures {
    #[inline]
    fn borrow_mut(&mut self) -> &mut CapsFeaturesRef {
        self.as_mut()
    }
}

impl glib::types::StaticType for CapsFeatures {
    #[inline]
    fn static_type() -> glib::types::Type {
        unsafe { from_glib(ffi::gst_caps_features_get_type()) }
    }
}

impl<'a> ToGlibPtr<'a, *const ffi::GstCapsFeatures> for CapsFeatures {
    type Storage = PhantomData<&'a Self>;

    #[inline]
    fn to_glib_none(&'a self) -> Stash<'a, *const ffi::GstCapsFeatures, Self> {
        unsafe { Stash(self.0.as_ref(), PhantomData) }
    }

    #[inline]
    fn to_glib_full(&self) -> *const ffi::GstCapsFeatures {
        unsafe { ffi::gst_caps_features_copy(self.0.as_ref()) }
    }
}

impl<'a> ToGlibPtr<'a, *mut ffi::GstCapsFeatures> for CapsFeatures {
    type Storage = PhantomData<&'a Self>;

    #[inline]
    fn to_glib_none(&'a self) -> Stash<'a, *mut ffi::GstCapsFeatures, Self> {
        unsafe {
            Stash(
                self.0.as_ref() as *const ffi::GstCapsFeatures as *mut ffi::GstCapsFeatures,
                PhantomData,
            )
        }
    }

    #[inline]
    fn to_glib_full(&self) -> *mut ffi::GstCapsFeatures {
        unsafe { ffi::gst_caps_features_copy(self.0.as_ref()) }
    }
}

impl<'a> ToGlibPtrMut<'a, *mut ffi::GstCapsFeatures> for CapsFeatures {
    type Storage = PhantomData<&'a mut Self>;

    #[inline]
    fn to_glib_none_mut(&'a mut self) -> StashMut<'a, *mut ffi::GstCapsFeatures, Self> {
        unsafe { StashMut(self.0.as_mut(), PhantomData) }
    }
}

impl FromGlibPtrNone<*const ffi::GstCapsFeatures> for CapsFeatures {
    #[inline]
    unsafe fn from_glib_none(ptr: *const ffi::GstCapsFeatures) -> Self {
        unsafe {
            debug_assert!(!ptr.is_null());
            let ptr = ffi::gst_caps_features_copy(ptr);
            debug_assert!(!ptr.is_null());
            CapsFeatures(ptr::NonNull::new_unchecked(ptr))
        }
    }
}

impl FromGlibPtrNone<*mut ffi::GstCapsFeatures> for CapsFeatures {
    #[inline]
    unsafe fn from_glib_none(ptr: *mut ffi::GstCapsFeatures) -> Self {
        unsafe {
            debug_assert!(!ptr.is_null());
            let ptr = ffi::gst_caps_features_copy(ptr);
            debug_assert!(!ptr.is_null());
            CapsFeatures(ptr::NonNull::new_unchecked(ptr))
        }
    }
}

impl FromGlibPtrFull<*const ffi::GstCapsFeatures> for CapsFeatures {
    #[inline]
    unsafe fn from_glib_full(ptr: *const ffi::GstCapsFeatures) -> Self {
        unsafe {
            debug_assert!(!ptr.is_null());
            CapsFeatures(ptr::NonNull::new_unchecked(
                ptr as *mut ffi::GstCapsFeatures,
            ))
        }
    }
}

impl FromGlibPtrFull<*mut ffi::GstCapsFeatures> for CapsFeatures {
    #[inline]
    unsafe fn from_glib_full(ptr: *mut ffi::GstCapsFeatures) -> Self {
        unsafe {
            debug_assert!(!ptr.is_null());
            CapsFeatures(ptr::NonNull::new_unchecked(ptr))
        }
    }
}

impl glib::value::ValueType for CapsFeatures {
    type Type = Self;
}

impl glib::value::ValueTypeOptional for CapsFeatures {}

unsafe impl<'a> glib::value::FromValue<'a> for CapsFeatures {
    type Checker = glib::value::GenericValueTypeOrNoneChecker<Self>;

    unsafe fn from_value(value: &'a glib::Value) -> Self {
        unsafe {
            skip_assert_initialized!();
            from_glib_none(glib::gobject_ffi::g_value_get_boxed(value.to_glib_none().0)
                as *mut ffi::GstCapsFeatures)
        }
    }
}

impl glib::value::ToValue for CapsFeatures {
    fn to_value(&self) -> glib::Value {
        let mut value = glib::Value::for_value_type::<Self>();
        unsafe {
            glib::gobject_ffi::g_value_set_boxed(
                value.to_glib_none_mut().0,
                ToGlibPtr::<*mut ffi::GstCapsFeatures>::to_glib_none(self).0 as *mut _,
            )
        }
        value
    }

    fn value_type(&self) -> glib::Type {
        Self::static_type()
    }
}

impl glib::value::ToValueOptional for CapsFeatures {
    fn to_value_optional(s: Option<&Self>) -> glib::Value {
        skip_assert_initialized!();
        let mut value = glib::Value::for_value_type::<Self>();
        unsafe {
            glib::gobject_ffi::g_value_set_boxed(
                value.to_glib_none_mut().0,
                ToGlibPtr::<*mut ffi::GstCapsFeatures>::to_glib_none(&s).0 as *mut _,
            )
        }
        value
    }
}

impl From<CapsFeatures> for glib::Value {
    fn from(v: CapsFeatures) -> glib::Value {
        skip_assert_initialized!();
        let mut value = glib::Value::for_value_type::<CapsFeatures>();
        unsafe {
            glib::gobject_ffi::g_value_take_boxed(
                value.to_glib_none_mut().0,
                IntoGlibPtr::<*mut ffi::GstCapsFeatures>::into_glib_ptr(v) as *mut _,
            )
        }
        value
    }
}

impl GlibPtrDefault for CapsFeatures {
    type GlibType = *mut ffi::GstCapsFeatures;
}

unsafe impl TransparentPtrType for CapsFeatures {}

#[repr(transparent)]
#[doc(alias = "GstCapsFeatures")]
pub struct CapsFeaturesRef(ffi::GstCapsFeatures);

impl CapsFeaturesRef {
    #[inline]
    pub unsafe fn from_glib_borrow<'a>(ptr: *const ffi::GstCapsFeatures) -> &'a CapsFeaturesRef {
        unsafe {
            debug_assert!(!ptr.is_null());

            &*(ptr as *mut CapsFeaturesRef)
        }
    }

    #[inline]
    pub unsafe fn from_glib_borrow_mut<'a>(
        ptr: *mut ffi::GstCapsFeatures,
    ) -> &'a mut CapsFeaturesRef {
        unsafe {
            debug_assert!(!ptr.is_null());

            &mut *(ptr as *mut CapsFeaturesRef)
        }
    }

    #[inline]
    pub fn as_ptr(&self) -> *const ffi::GstCapsFeatures {
        self as *const Self as *const ffi::GstCapsFeatures
    }

    #[inline]
    pub fn as_mut_ptr(&self) -> *mut ffi::GstCapsFeatures {
        self as *const Self as *mut ffi::GstCapsFeatures
    }

    pub fn is_empty(&self) -> bool {
        self.size() == 0 && !self.is_any()
    }

    #[doc(alias = "gst_caps_features_is_any")]
    pub fn is_any(&self) -> bool {
        unsafe { from_glib(ffi::gst_caps_features_is_any(self.as_ptr())) }
    }

    #[doc(alias = "gst_caps_features_contains")]
    pub fn contains(&self, feature: impl IntoGStr) -> bool {
        unsafe {
            feature.run_with_gstr(|feature| {
                from_glib(ffi::gst_caps_features_contains(
                    self.as_ptr(),
                    feature.as_ptr(),
                ))
            })
        }
    }

    #[doc(alias = "gst_caps_features_contains_id_str")]
    pub fn contains_by_id(&self, feature: impl AsRef<IdStr>) -> bool {
        unsafe {
            cfg_if! {
                if #[cfg(feature = "v1_26")] {
                    from_glib(ffi::gst_caps_features_contains_id_str(
                        self.as_ptr(),
                        feature.as_ref().as_ptr(),
                    ))
                } else {
                    from_glib(ffi::gst_caps_features_contains(
                        self.as_ptr(),
                        feature.as_ref().as_gstr().as_ptr(),
                    ))
                }
            }
        }
    }

    #[deprecated = "use `contains_by_id()` instead"]
    #[doc(alias = "gst_caps_features_contains_id")]
    pub fn contains_quark(&self, feature: glib::Quark) -> bool {
        unsafe {
            from_glib(ffi::gst_caps_features_contains_id(
                self.as_ptr(),
                feature.into_glib(),
            ))
        }
    }

    #[doc(alias = "get_size")]
    #[doc(alias = "gst_caps_features_get_size")]
    pub fn size(&self) -> usize {
        unsafe { ffi::gst_caps_features_get_size(self.as_ptr()) as usize }
    }

    #[doc(alias = "get_nth")]
    #[doc(alias = "gst_caps_features_get_nth")]
    pub fn nth(&self, idx: usize) -> Option<&glib::GStr> {
        if idx >= self.size() {
            return None;
        }

        unsafe {
            let feature = ffi::gst_caps_features_get_nth(self.as_ptr(), idx as u32);
            if feature.is_null() {
                return None;
            }

            Some(glib::GStr::from_ptr(feature))
        }
    }

    #[cfg(feature = "v1_26")]
    #[doc(alias = "get_nth_by_id")]
    #[doc(alias = "gst_caps_features_get_nth_id_str")]
    pub fn nth_id(&self, idx: usize) -> Option<&IdStr> {
        if idx >= self.size() {
            return None;
        }

        unsafe {
            let feature = ffi::gst_caps_features_get_nth_id_str(self.as_ptr(), idx as u32);
            if feature.is_null() {
                return None;
            }

            Some(&*(feature as *const IdStr))
        }
    }

    #[deprecated = "use `nth_by_id()` instead"]
    #[doc(alias = "gst_caps_features_get_nth_id")]
    pub fn nth_quark(&self, idx: usize) -> Option<glib::Quark> {
        if idx >= self.size() {
            return None;
        }

        unsafe {
            let feature = ffi::gst_caps_features_get_nth_id(self.as_ptr(), idx as u32);
            Some(from_glib(feature))
        }
    }

    #[doc(alias = "gst_caps_features_add")]
    pub fn add(&mut self, feature: impl IntoGStr) {
        unsafe {
            feature.run_with_gstr(|feature| {
                ffi::gst_caps_features_add(self.as_mut_ptr(), feature.as_ptr())
            })
        }
    }

    #[doc(alias = "gst_caps_features_add_static_str")]
    pub fn add_from_static(&mut self, feature: impl AsRef<glib::GStr> + 'static) {
        unsafe {
            cfg_if! {
                if #[cfg(feature = "v1_26")] {
                    ffi::gst_caps_features_add_static_str(self.as_mut_ptr(), feature.as_ref().as_ptr())
                } else {
                    ffi::gst_caps_features_add(self.as_mut_ptr(), feature.as_ref().as_ptr())
                }
            }
        }
    }

    #[doc(alias = "gst_caps_features_add_id_str")]
    pub fn add_from_id(&mut self, feature: impl AsRef<IdStr>) {
        unsafe {
            cfg_if! {
                if #[cfg(feature = "v1_26")] {
                    ffi::gst_caps_features_add_id_str(self.as_mut_ptr(), feature.as_ref().as_ptr())
                } else {
                    ffi::gst_caps_features_add(self.as_mut_ptr(), feature.as_ref().as_gstr().as_ptr())
                }
            }
        }
    }

    #[doc(alias = "gst_caps_features_remove")]
    pub fn remove(&mut self, feature: impl IntoGStr) {
        unsafe {
            feature.run_with_gstr(|feature| {
                ffi::gst_caps_features_remove(self.as_mut_ptr(), feature.as_ptr())
            })
        }
    }

    #[doc(alias = "gst_caps_features_remove_id_str")]
    pub fn remove_by_id(&mut self, feature: impl AsRef<IdStr>) {
        unsafe {
            cfg_if! {
                if #[cfg(feature = "v1_26")] {
                    ffi::gst_caps_features_remove_id_str(self.as_mut_ptr(), feature.as_ref().as_ptr())
                } else {
                    ffi::gst_caps_features_remove(self.as_mut_ptr(), feature.as_ref().as_gstr().as_ptr())
                }
            }
        }
    }

    #[deprecated = "use `add_by_id()` instead"]
    #[doc(alias = "gst_caps_features_add_id")]
    pub fn add_from_quark(&mut self, feature: glib::Quark) {
        unsafe { ffi::gst_caps_features_add_id(self.as_mut_ptr(), feature.into_glib()) }
    }

    #[deprecated = "use `remove_by_id()` instead"]
    #[doc(alias = "gst_caps_features_remove_id")]
    pub fn remove_by_quark(&mut self, feature: glib::Quark) {
        unsafe { ffi::gst_caps_features_remove_id(self.as_mut_ptr(), feature.into_glib()) }
    }

    pub fn iter(&self) -> Iter<'_> {
        Iter::new(self)
    }

    // This is not an equivalence relation with regards to ANY. Everything is equal to ANY
    #[doc(alias = "gst_caps_features_is_equal")]
    pub fn is_equal(&self, other: &CapsFeaturesRef) -> bool {
        unsafe {
            from_glib(ffi::gst_caps_features_is_equal(
                self.as_ptr(),
                other.as_ptr(),
            ))
        }
    }
}

impl glib::types::StaticType for CapsFeaturesRef {
    #[inline]
    fn static_type() -> glib::types::Type {
        unsafe { from_glib(ffi::gst_structure_get_type()) }
    }
}

impl<'a> std::iter::Extend<&'a str> for CapsFeaturesRef {
    fn extend<T: IntoIterator<Item = &'a str>>(&mut self, iter: T) {
        iter.into_iter().for_each(|f| self.add(f));
    }
}

impl<'a> std::iter::Extend<&'a glib::GStr> for CapsFeaturesRef {
    fn extend<T: IntoIterator<Item = &'a glib::GStr>>(&mut self, iter: T) {
        iter.into_iter().for_each(|f| self.add(f));
    }
}

impl std::iter::Extend<String> for CapsFeaturesRef {
    fn extend<T: IntoIterator<Item = String>>(&mut self, iter: T) {
        iter.into_iter().for_each(|f| self.add(&f));
    }
}

impl std::iter::Extend<glib::GString> for CapsFeaturesRef {
    fn extend<T: IntoIterator<Item = glib::GString>>(&mut self, iter: T) {
        iter.into_iter().for_each(|f| self.add(&f));
    }
}

impl<Id: AsRef<IdStr>> std::iter::Extend<Id> for CapsFeaturesRef {
    fn extend<T: IntoIterator<Item = Id>>(&mut self, iter: T) {
        iter.into_iter().for_each(|f| self.add_from_id(f));
    }
}

impl std::iter::Extend<glib::Quark> for CapsFeaturesRef {
    #[allow(deprecated)]
    fn extend<T: IntoIterator<Item = glib::Quark>>(&mut self, iter: T) {
        iter.into_iter().for_each(|f| self.add_from_quark(f));
    }
}

unsafe impl<'a> glib::value::FromValue<'a> for &'a CapsFeaturesRef {
    type Checker = glib::value::GenericValueTypeOrNoneChecker<Self>;

    unsafe fn from_value(value: &'a glib::Value) -> Self {
        unsafe {
            skip_assert_initialized!();
            &*(glib::gobject_ffi::g_value_get_boxed(value.to_glib_none().0)
                as *const CapsFeaturesRef)
        }
    }
}

impl glib::value::ToValue for CapsFeaturesRef {
    fn to_value(&self) -> glib::Value {
        let mut value = glib::Value::for_value_type::<CapsFeatures>();
        unsafe {
            glib::gobject_ffi::g_value_set_boxed(
                value.to_glib_none_mut().0,
                self.as_mut_ptr() as *mut _,
            )
        }
        value
    }

    fn value_type(&self) -> glib::Type {
        Self::static_type()
    }
}

impl glib::value::ToValueOptional for CapsFeaturesRef {
    fn to_value_optional(s: Option<&Self>) -> glib::Value {
        skip_assert_initialized!();
        let mut value = glib::Value::for_value_type::<CapsFeatures>();
        unsafe {
            glib::gobject_ffi::g_value_set_boxed(
                value.to_glib_none_mut().0,
                s.map(|s| s.as_mut_ptr()).unwrap_or(ptr::null_mut()) as *mut _,
            )
        }
        value
    }
}

crate::utils::define_fixed_size_iter!(
    Iter,
    &'a CapsFeaturesRef,
    &'a glib::GStr,
    |collection: &CapsFeaturesRef| collection.size(),
    |collection: &CapsFeaturesRef, idx: usize| unsafe {
        let feature = ffi::gst_caps_features_get_nth(collection.as_ptr(), idx as u32);
        glib::GStr::from_ptr(feature)
    }
);

impl<'a> IntoIterator for &'a CapsFeaturesRef {
    type IntoIter = Iter<'a>;
    type Item = &'a glib::GStr;

    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}

impl<'a> From<&'a str> for CapsFeatures {
    fn from(value: &'a str) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        features.add(value);

        features
    }
}

impl<'a> From<&'a glib::GStr> for CapsFeatures {
    fn from(value: &'a glib::GStr) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        features.add(value);

        features
    }
}

impl<Id: AsRef<IdStr>> From<Id> for CapsFeatures {
    fn from(value: Id) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        features.add_from_id(value);

        features
    }
}

impl From<glib::Quark> for CapsFeatures {
    #[allow(deprecated)]
    fn from(value: glib::Quark) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        features.add_from_quark(value);

        features
    }
}

impl<'a, const N: usize> From<[&'a str; N]> for CapsFeatures {
    fn from(value: [&'a str; N]) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        value.into_iter().for_each(|f| features.add(f));

        features
    }
}

impl<'a, const N: usize> From<[&'a glib::GStr; N]> for CapsFeatures {
    fn from(value: [&'a glib::GStr; N]) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        value.into_iter().for_each(|f| features.add(f));

        features
    }
}

impl<const N: usize> From<[String; N]> for CapsFeatures {
    fn from(value: [String; N]) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        value.into_iter().for_each(|f| features.add(&f));

        features
    }
}

impl<const N: usize> From<[glib::GString; N]> for CapsFeatures {
    fn from(value: [glib::GString; N]) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        value.into_iter().for_each(|f| features.add(&f));

        features
    }
}

impl<const N: usize, Id: AsRef<IdStr>> From<[Id; N]> for CapsFeatures {
    fn from(value: [Id; N]) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        value.into_iter().for_each(|f| features.add_from_id(f));

        features
    }
}

impl<const N: usize> From<[glib::Quark; N]> for CapsFeatures {
    #[allow(deprecated)]
    fn from(value: [glib::Quark; N]) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        value.into_iter().for_each(|f| features.add_from_quark(f));

        features
    }
}

impl<'a> std::iter::FromIterator<&'a str> for CapsFeatures {
    fn from_iter<T: IntoIterator<Item = &'a str>>(iter: T) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        iter.into_iter().for_each(|f| features.add(f));

        features
    }
}

impl<'a> std::iter::FromIterator<&'a glib::GStr> for CapsFeatures {
    fn from_iter<T: IntoIterator<Item = &'a glib::GStr>>(iter: T) -> Self {
        assert_initialized_main_thread!();

        let mut features = CapsFeatures::new_empty();

        iter.into_iter().for_each(|f| features.add(f));

        features
    }
}

impl std::iter::FromIterator<String> for CapsFeatures {
    fn from_iter<T: IntoIterator<Item = String>>(iter: T) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        iter.into_iter().for_each(|f| features.add(&f));

        features
    }
}

impl std::iter::FromIterator<glib::GString> for CapsFeatures {
    fn from_iter<T: IntoIterator<Item = glib::GString>>(iter: T) -> Self {
        assert_initialized_main_thread!();

        let mut features = CapsFeatures::new_empty();

        iter.into_iter().for_each(|f| features.add(&f));

        features
    }
}

impl<Id: AsRef<IdStr>> std::iter::FromIterator<Id> for CapsFeatures {
    #[allow(deprecated)]
    fn from_iter<T: IntoIterator<Item = Id>>(iter: T) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        iter.into_iter().for_each(|f| features.add_from_id(f));

        features
    }
}

impl std::iter::FromIterator<glib::Quark> for CapsFeatures {
    #[allow(deprecated)]
    fn from_iter<T: IntoIterator<Item = glib::Quark>>(iter: T) -> Self {
        skip_assert_initialized!();
        let mut features = CapsFeatures::new_empty();

        iter.into_iter().for_each(|f| features.add_from_quark(f));

        features
    }
}

impl fmt::Debug for CapsFeaturesRef {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_tuple("CapsFeatures")
            .field(&self.to_string())
            .finish()
    }
}

impl fmt::Display for CapsFeaturesRef {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let s = unsafe {
            glib::GString::from_glib_full(ffi::gst_caps_features_to_string(self.as_ptr()))
        };
        f.write_str(&s)
    }
}

impl ToOwned for CapsFeaturesRef {
    type Owned = CapsFeatures;

    #[inline]
    fn to_owned(&self) -> CapsFeatures {
        unsafe { from_glib_full(ffi::gst_caps_features_copy(self.as_ptr() as *const _) as *mut _) }
    }
}

impl std::hash::Hash for CapsFeaturesRef {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        use std::hash::{DefaultHasher, Hasher};

        // re-implement gst_hash_caps_features so the hashing is not depending on the features order.
        if self.is_any() {
            "ANY".hash(state);
        } else if self.is_empty() {
            "EMPTY".hash(state);
        } else {
            let mut features_hash = 0;
            for f in self.iter() {
                let mut field_hasher = DefaultHasher::new();
                f.hash(&mut field_hasher);

                features_hash ^= field_hasher.finish();
            }
            features_hash.hash(state);
        }
    }
}

impl std::hash::Hash for CapsFeatures {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.as_ref().hash(state);
    }
}

unsafe impl Sync for CapsFeaturesRef {}
unsafe impl Send for CapsFeaturesRef {}

pub static CAPS_FEATURE_MEMORY_SYSTEM_MEMORY: &glib::GStr =
    unsafe { glib::GStr::from_utf8_with_nul_unchecked(ffi::GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY) };
pub static CAPS_FEATURES_MEMORY_SYSTEM_MEMORY: LazyLock<CapsFeatures> =
    LazyLock::new(|| CapsFeatures::new([CAPS_FEATURE_MEMORY_SYSTEM_MEMORY]));

#[cfg(test)]
mod tests {
    use super::*;
    use glib::gstr;

    #[test]
    fn test_from_value_optional() {
        use glib::value::ToValue;

        crate::init().unwrap();

        let a = None::<CapsFeatures>.to_value();
        assert!(a.get::<Option<CapsFeatures>>().unwrap().is_none());
        let b = glib::value::Value::from(&CapsFeatures::new_empty());
        assert!(b.get::<Option<CapsFeatures>>().unwrap().is_some());
    }

    #[test]
    fn trait_impls() {
        crate::init().unwrap();

        let cf = CapsFeatures::from(gstr!("memory:DMABuf"));
        assert!(cf.contains(gstr!("memory:DMABuf")));

        let cf = CapsFeatures::from([
            gstr!("memory:DMABuf"),
            gstr!("meta:GstVideoOverlayComposition"),
        ]);

        assert!(cf.contains(gstr!("memory:DMABuf")));
        assert!(cf.contains("meta:GstVideoOverlayComposition"));
        assert!(!cf.contains("memory:GLMemory"));

        let cf = CapsFeatures::from_iter(vec![
            gstr!("memory:DMABuf"),
            gstr!("meta:GstVideoOverlayComposition"),
        ]);

        assert!(cf.contains(gstr!("memory:DMABuf")));
        assert!(cf.contains("meta:GstVideoOverlayComposition"));
        assert!(!cf.contains("memory:GLMemory"));

        let mut cf = CapsFeatures::new_empty();
        cf.extend([
            gstr!("memory:DMABuf"),
            gstr!("meta:GstVideoOverlayComposition"),
        ]);

        assert!(cf.contains(gstr!("memory:DMABuf")));
        assert!(cf.contains("meta:GstVideoOverlayComposition"));
        assert!(!cf.contains("memory:GLMemory"));
    }

    #[test]
    fn trait_impls_from_id() {
        crate::init().unwrap();

        let cf = CapsFeatures::from(idstr!("memory:DMABuf"));
        assert!(cf.contains_by_id(idstr!("memory:DMABuf")));

        let cf = CapsFeatures::from([
            idstr!("memory:DMABuf"),
            idstr!("meta:GstVideoOverlayComposition"),
        ]);

        assert!(cf.contains_by_id(idstr!("memory:DMABuf")));
        assert!(cf.contains("meta:GstVideoOverlayComposition"));
        assert!(!cf.contains("memory:GLMemory"));

        let cf = CapsFeatures::from_iter(vec![
            idstr!("memory:DMABuf"),
            idstr!("meta:GstVideoOverlayComposition"),
        ]);

        assert!(cf.contains_by_id(idstr!("memory:DMABuf")));
        assert!(cf.contains("meta:GstVideoOverlayComposition"));
        assert!(!cf.contains("memory:GLMemory"));

        let mut cf = CapsFeatures::new_empty();
        cf.extend([
            idstr!("memory:DMABuf"),
            idstr!("meta:GstVideoOverlayComposition"),
        ]);

        assert!(cf.contains_by_id(idstr!("memory:DMABuf")));
        assert!(cf.contains("meta:GstVideoOverlayComposition"));
        assert!(!cf.contains("memory:GLMemory"));
    }

    #[test]
    fn trait_impls_from_ref_id() {
        crate::init().unwrap();

        let dma_buf = idstr!("memory:DMABuf");
        let overlay_comp = idstr!("meta:GstVideoOverlayComposition");

        let cf = CapsFeatures::from(&dma_buf);
        assert!(cf.contains_by_id(&dma_buf));

        let cf = CapsFeatures::from([&dma_buf, &overlay_comp]);

        assert!(cf.contains_by_id(&dma_buf));
        assert!(cf.contains_by_id(&overlay_comp));
        assert!(!cf.contains("memory:GLMemory"));

        let cf = CapsFeatures::from_iter(vec![&dma_buf, &overlay_comp]);

        assert!(cf.contains_by_id(&dma_buf));
        assert!(cf.contains_by_id(&overlay_comp));
        assert!(!cf.contains("memory:GLMemory"));

        let mut cf = CapsFeatures::new_empty();
        cf.extend([&dma_buf, &overlay_comp]);

        assert!(cf.contains_by_id(dma_buf));
        assert!(cf.contains_by_id(overlay_comp));
        assert!(!cf.contains("memory:GLMemory"));
    }

    #[test]
    fn test_hash() {
        crate::init().unwrap();

        use std::hash::BuildHasher;
        let bh = std::hash::RandomState::new();

        let any = CapsFeatures::new_any();
        let empty = CapsFeatures::new_empty();
        assert_eq!(bh.hash_one(&any), bh.hash_one(&any));
        assert_eq!(bh.hash_one(&empty), bh.hash_one(&empty));
        assert_ne!(bh.hash_one(&any), bh.hash_one(&empty));

        // Different names
        let cf1 = CapsFeatures::from(gstr!("memory:DMABuf"));
        let cf2 = CapsFeatures::from(gstr!("memory:GLMemory"));
        assert_eq!(bh.hash_one(&cf1), bh.hash_one(&cf1));
        assert_eq!(bh.hash_one(&cf2), bh.hash_one(&cf2));
        assert_ne!(bh.hash_one(&cf1), bh.hash_one(&cf2));

        // Same features, different order
        let cf1 = CapsFeatures::from([
            gstr!("memory:DMABuf"),
            gstr!("meta:GstVideoOverlayComposition"),
        ]);
        let cf2 = CapsFeatures::from([
            gstr!("meta:GstVideoOverlayComposition"),
            gstr!("memory:DMABuf"),
        ]);
        assert_eq!(bh.hash_one(&cf1), bh.hash_one(&cf1));
        assert_eq!(bh.hash_one(&cf2), bh.hash_one(&cf2));
        assert_eq!(bh.hash_one(&cf1), bh.hash_one(&cf2));
    }
}