// Copyright (C) 2016-2017 Sebastian Dröge // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. use caps_features::*; use miniobject::*; use std::fmt; use std::ptr; use std::str; use structure::*; use CapsIntersectMode; use glib; use glib::translate::{from_glib, from_glib_full, ToGlib, ToGlibPtr}; use glib::value::ToSendValue; use gst_sys; gst_define_mini_object_wrapper!( Caps, CapsRef, gst_sys::GstCaps, [Debug, PartialEq, Eq,], || gst_sys::gst_caps_get_type() ); impl Caps { pub fn builder(name: &str) -> Builder { assert_initialized_main_thread!(); Builder::new(name) } pub fn new_empty() -> Self { assert_initialized_main_thread!(); unsafe { from_glib_full(gst_sys::gst_caps_new_empty()) } } pub fn new_any() -> Self { assert_initialized_main_thread!(); unsafe { from_glib_full(gst_sys::gst_caps_new_any()) } } pub fn new_simple(name: &str, values: &[(&str, &ToSendValue)]) -> Self { assert_initialized_main_thread!(); let mut caps = Caps::new_empty(); let structure = Structure::new(name, values); caps.get_mut().unwrap().append_structure(structure); caps } pub fn from_string(value: &str) -> Option { assert_initialized_main_thread!(); unsafe { from_glib_full(gst_sys::gst_caps_from_string(value.to_glib_none().0)) } } pub fn fixate(caps: Self) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_fixate(caps.into_ptr())) } } pub fn merge(caps: Self, other: Self) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_merge(caps.into_ptr(), other.into_ptr())) } } pub fn merge_structure(caps: Self, structure: Structure) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_merge_structure( caps.into_ptr(), structure.into_ptr(), )) } } pub fn merge_structure_full( caps: Self, structure: Structure, features: Option, ) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_merge_structure_full( caps.into_ptr(), structure.into_ptr(), features.map(|f| f.into_ptr()).unwrap_or(ptr::null_mut()), )) } } pub fn normalize(caps: Self) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_normalize(caps.into_ptr())) } } pub fn simplify(caps: Self) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_simplify(caps.into_ptr())) } } pub fn truncate(caps: Self) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_truncate(caps.into_ptr())) } } } impl str::FromStr for Caps { type Err = (); fn from_str(s: &str) -> Result { skip_assert_initialized!(); Caps::from_string(s).ok_or(()) } } impl fmt::Display for Caps { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { self.0.fmt(f) } } impl CapsRef { pub fn set_simple(&mut self, values: &[(&str, &ToSendValue)]) { for &(name, value) in values { let value = value.to_value(); unsafe { gst_sys::gst_caps_set_value( self.as_mut_ptr(), name.to_glib_none().0, value.to_glib_none().0, ); } } } pub fn to_string(&self) -> String { unsafe { from_glib_full(gst_sys::gst_caps_to_string(self.as_ptr())) } } pub fn get_structure(&self, idx: u32) -> Option<&StructureRef> { if idx >= self.get_size() { return None; } unsafe { let structure = gst_sys::gst_caps_get_structure(self.as_ptr(), idx); if structure.is_null() { return None; } Some(StructureRef::from_glib_borrow(structure)) } } pub fn get_mut_structure(&mut self, idx: u32) -> Option<&mut StructureRef> { if idx >= self.get_size() { return None; } unsafe { let structure = gst_sys::gst_caps_get_structure(self.as_ptr(), idx); if structure.is_null() { return None; } Some(StructureRef::from_glib_borrow_mut(structure)) } } pub fn get_features(&self, idx: u32) -> Option<&CapsFeaturesRef> { if idx >= self.get_size() { return None; } unsafe { let features = gst_sys::gst_caps_get_features(self.as_ptr(), idx); Some(CapsFeaturesRef::from_glib_borrow(features)) } } pub fn get_mut_features(&mut self, idx: u32) -> Option<&mut CapsFeaturesRef> { if idx >= self.get_size() { return None; } unsafe { let features = gst_sys::gst_caps_get_features(self.as_ptr(), idx); Some(CapsFeaturesRef::from_glib_borrow_mut(features)) } } pub fn set_features(&mut self, idx: u32, features: Option) { assert!(idx < self.get_size()); unsafe { gst_sys::gst_caps_set_features( self.as_mut_ptr(), idx, features.map(|f| f.into_ptr()).unwrap_or(ptr::null_mut()), ) } } #[cfg(any(feature = "v1_16", feature = "dox"))] pub fn set_features_simple(&mut self, features: Option) { unsafe { gst_sys::gst_caps_set_features_simple( self.as_mut_ptr(), features.map(|f| f.into_ptr()).unwrap_or(ptr::null_mut()), ) } } pub fn get_size(&self) -> u32 { unsafe { gst_sys::gst_caps_get_size(self.as_ptr()) } } pub fn iter(&self) -> Iter { Iter::new(self) } pub fn iter_mut(&mut self) -> IterMut { IterMut::new(self) } pub fn iter_with_features(&self) -> IterFeatures { IterFeatures::new(self) } pub fn iter_with_features_mut(&mut self) -> IterFeaturesMut { IterFeaturesMut::new(self) } pub fn append_structure(&mut self, structure: Structure) { unsafe { gst_sys::gst_caps_append_structure(self.as_mut_ptr(), structure.into_ptr()) } } pub fn append_structure_full(&mut self, structure: Structure, features: Option) { unsafe { gst_sys::gst_caps_append_structure_full( self.as_mut_ptr(), structure.into_ptr(), features.map(|f| f.into_ptr()).unwrap_or(ptr::null_mut()), ) } } pub fn remove_structure(&mut self, idx: u32) { unsafe { gst_sys::gst_caps_remove_structure(self.as_mut_ptr(), idx) } } pub fn append(&mut self, other: Caps) { unsafe { gst_sys::gst_caps_append(self.as_mut_ptr(), other.into_ptr()) } } pub fn can_intersect(&self, other: &Self) -> bool { unsafe { from_glib(gst_sys::gst_caps_can_intersect( self.as_ptr(), other.as_ptr(), )) } } pub fn intersect(&self, other: &Self) -> Caps { unsafe { from_glib_full(gst_sys::gst_caps_intersect( self.as_mut_ptr(), other.as_mut_ptr(), )) } } pub fn intersect_with_mode(&self, other: &Self, mode: CapsIntersectMode) -> Caps { unsafe { from_glib_full(gst_sys::gst_caps_intersect_full( self.as_mut_ptr(), other.as_mut_ptr(), mode.to_glib(), )) } } pub fn is_always_compatible(&self, other: &Self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_always_compatible( self.as_ptr(), other.as_ptr(), )) } } pub fn is_any(&self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_any(self.as_ptr())) } } pub fn is_empty(&self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_empty(self.as_ptr())) } } pub fn is_fixed(&self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_fixed(self.as_ptr())) } } pub fn is_equal_fixed(&self, other: &Self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_equal_fixed( self.as_ptr(), other.as_ptr(), )) } } pub fn is_strictly_equal(&self, other: &Self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_strictly_equal( self.as_ptr(), other.as_ptr(), )) } } pub fn is_subset(&self, superset: &Self) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_subset( self.as_ptr(), superset.as_ptr(), )) } } pub fn is_subset_structure(&self, structure: &StructureRef) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_subset_structure( self.as_ptr(), structure.as_ptr(), )) } } pub fn is_subset_structure_full( &self, structure: &StructureRef, features: Option<&CapsFeaturesRef>, ) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_subset_structure_full( self.as_ptr(), structure.as_ptr(), features.map(|f| f.as_ptr()).unwrap_or(ptr::null()), )) } } pub fn subtract(&self, other: &Self) -> Caps { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_caps_subtract( self.as_mut_ptr(), other.as_mut_ptr(), )) } } } macro_rules! define_iter( ($name:ident, $typ:ty, $styp:ty, $get_item:expr) => { #[derive(Debug)] pub struct $name<'a> { caps: $typ, idx: u32, n_structures: u32, } impl<'a> $name<'a> { fn new(caps: $typ) -> $name<'a> { skip_assert_initialized!(); let n_structures = caps.get_size(); $name { caps: caps, idx: 0, n_structures: n_structures, } } } impl<'a> Iterator for $name<'a> { type Item = $styp; fn next(&mut self) -> Option { if self.idx >= self.n_structures { return None; } unsafe { let item = $get_item(self.caps, self.idx)?; self.idx += 1; Some(item) } } fn size_hint(&self) -> (usize, Option) { if self.idx == self.n_structures { return (0, Some(0)); } let remaining = (self.n_structures - self.idx) as usize; (remaining, Some(remaining)) } } impl<'a> DoubleEndedIterator for $name<'a> { fn next_back(&mut self) -> Option { if self.idx == self.n_structures { return None; } self.n_structures -= 1; unsafe { $get_item(self.caps, self.n_structures) } } } impl<'a> ExactSizeIterator for $name<'a> {} } ); define_iter!( Iter, &'a CapsRef, &'a StructureRef, |caps: &CapsRef, idx| { let ptr = gst_sys::gst_caps_get_structure(caps.as_ptr(), idx); if ptr.is_null() { None } else { Some(StructureRef::from_glib_borrow( ptr as *const gst_sys::GstStructure, )) } } ); define_iter!( IterMut, &'a mut CapsRef, &'a mut StructureRef, |caps: &CapsRef, idx| { let ptr = gst_sys::gst_caps_get_structure(caps.as_ptr(), idx); if ptr.is_null() { None } else { Some(StructureRef::from_glib_borrow_mut( ptr as *mut gst_sys::GstStructure, )) } } ); define_iter!( IterFeatures, &'a CapsRef, (&'a StructureRef, &'a CapsFeaturesRef), |caps: &CapsRef, idx| { let ptr1 = gst_sys::gst_caps_get_structure(caps.as_ptr(), idx); let ptr2 = gst_sys::gst_caps_get_features(caps.as_ptr(), idx); if ptr1.is_null() || ptr2.is_null() { None } else { Some(( StructureRef::from_glib_borrow(ptr1 as *const gst_sys::GstStructure), CapsFeaturesRef::from_glib_borrow(ptr2 as *const gst_sys::GstCapsFeatures), )) } } ); define_iter!( IterFeaturesMut, &'a mut CapsRef, (&'a mut StructureRef, &'a mut CapsFeaturesRef), |caps: &CapsRef, idx| { let ptr1 = gst_sys::gst_caps_get_structure(caps.as_ptr(), idx); let ptr2 = gst_sys::gst_caps_get_features(caps.as_ptr(), idx); if ptr1.is_null() || ptr2.is_null() { None } else { Some(( StructureRef::from_glib_borrow_mut(ptr1 as *mut gst_sys::GstStructure), CapsFeaturesRef::from_glib_borrow_mut(ptr2 as *mut gst_sys::GstCapsFeatures), )) } } ); impl fmt::Debug for CapsRef { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_tuple("Caps").field(&self.to_string()).finish() } } impl fmt::Display for CapsRef { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.write_str(&self.to_string()) } } impl PartialEq for CapsRef { fn eq(&self, other: &CapsRef) -> bool { unsafe { from_glib(gst_sys::gst_caps_is_equal(self.as_ptr(), other.as_ptr())) } } } impl Eq for CapsRef {} #[derive(Debug)] pub struct Builder<'a> { s: ::Structure, features: Option<&'a [&'a str]>, any_features: bool, } impl<'a> Builder<'a> { fn new<'b>(name: &'b str) -> Builder<'a> { Builder { s: ::Structure::new_empty(name), features: None, any_features: false, } } pub fn field<'b, V: ToSendValue>(mut self, name: &'b str, value: &'b V) -> Self { self.s.set(name, value); self } pub fn features(mut self, features: &'a [&'a str]) -> Self { self.features = Some(features); self } pub fn any_features(mut self) -> Self { self.any_features = true; self } pub fn build(self) -> Caps { let mut caps = Caps::new_empty(); let features = if self.any_features { Some(CapsFeatures::new_any()) } else { self.features.map(|f| CapsFeatures::new(f)) }; caps.get_mut() .unwrap() .append_structure_full(self.s, features); caps } } #[cfg(test)] mod tests { use super::*; use Array; use Fraction; #[test] fn test_simple() { ::init().unwrap(); let mut caps = Caps::new_simple( "foo/bar", &[ ("int", &12), ("bool", &true), ("string", &"bla"), ("fraction", &Fraction::new(1, 2)), ("array", &Array::new(&[&1, &2])), ], ); assert_eq!( caps.to_string(), "foo/bar, int=(int)12, bool=(boolean)true, string=(string)bla, fraction=(fraction)1/2, array=(int)< 1, 2 >" ); { let s = caps.get_structure(0).unwrap(); assert_eq!( s, Structure::new( "foo/bar", &[ ("int", &12), ("bool", &true), ("string", &"bla"), ("fraction", &Fraction::new(1, 2)), ("array", &Array::new(&[&1, &2])), ], ) .as_ref() ); } assert!(caps .get_features(0) .unwrap() .is_equal(::CAPS_FEATURES_MEMORY_SYSTEM_MEMORY.as_ref())); { let caps = caps.get_mut().unwrap(); caps.set_features(0, Some(CapsFeatures::new(&["foo:bla"]))); } assert!(caps .get_features(0) .unwrap() .is_equal(CapsFeatures::new(&["foo:bla"]).as_ref())); } #[test] fn test_builder() { ::init().unwrap(); let caps = Caps::builder("foo/bar") .field("int", &12) .field("bool", &true) .field("string", &"bla") .field("fraction", &Fraction::new(1, 2)) .field("array", &Array::new(&[&1, &2])) .build(); assert_eq!( caps.to_string(), "foo/bar, int=(int)12, bool=(boolean)true, string=(string)bla, fraction=(fraction)1/2, array=(int)< 1, 2 >" ); let caps = Caps::builder("foo/bar") .field("int", &12) .any_features() .build(); assert_eq!(caps.to_string(), "foo/bar(ANY), int=(int)12"); let caps = Caps::builder("foo/bar") .field("int", &12) .features(&["foo:bla", "foo:baz"]) .build(); assert_eq!(caps.to_string(), "foo/bar(foo:bla, foo:baz), int=(int)12"); } }