// 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 std::fmt; use std::marker::PhantomData; use std::mem; use std::ops; use std::ptr; use std::slice; use std::u64; use std::usize; use meta::*; use miniobject::*; use BufferFlags; use ClockTime; use Memory; use MemoryRef; use glib; use glib::translate::{from_glib, from_glib_full, FromGlib, FromGlibPtrFull, ToGlib}; use glib_sys; use gst_sys; pub enum Readable {} pub enum Writable {} gst_define_mini_object_wrapper!( Buffer, BufferRef, gst_sys::GstBuffer, [Debug, PartialEq, Eq,], || gst_sys::gst_buffer_get_type() ); pub struct BufferMap<'a, T> { buffer: &'a BufferRef, map_info: gst_sys::GstMapInfo, phantom: PhantomData, } pub struct MappedBuffer { buffer: Option, map_info: gst_sys::GstMapInfo, phantom: PhantomData, } impl Buffer { pub fn new() -> Self { assert_initialized_main_thread!(); unsafe { from_glib_full(gst_sys::gst_buffer_new()) } } pub fn with_size(size: usize) -> Result { assert_initialized_main_thread!(); unsafe { Option::<_>::from_glib_full(gst_sys::gst_buffer_new_allocate( ptr::null_mut(), size, ptr::null_mut(), )) .ok_or_else(|| glib_bool_error!("Failed to allocate buffer")) } } unsafe extern "C" fn drop_box(vec: glib_sys::gpointer) { let slice: Box = Box::from_raw(vec as *mut T); drop(slice); } pub fn from_mut_slice + Send + 'static>(slice: T) -> Self { assert_initialized_main_thread!(); unsafe { let mut b = Box::new(slice); let (size, data) = { let slice = (*b).as_mut(); (slice.len(), slice.as_mut_ptr()) }; let user_data = Box::into_raw(b); from_glib_full(gst_sys::gst_buffer_new_wrapped_full( 0, data as glib_sys::gpointer, size, 0, size, user_data as glib_sys::gpointer, Some(Self::drop_box::), )) } } pub fn from_slice + Send + 'static>(slice: T) -> Self { assert_initialized_main_thread!(); unsafe { let b = Box::new(slice); let (size, data) = { let slice = (*b).as_ref(); (slice.len(), slice.as_ptr()) }; let user_data = Box::into_raw(b); from_glib_full(gst_sys::gst_buffer_new_wrapped_full( gst_sys::GST_MEMORY_FLAG_READONLY, data as glib_sys::gpointer, size, 0, size, user_data as glib_sys::gpointer, Some(Self::drop_box::), )) } } pub fn into_mapped_buffer_readable(self) -> Result, Self> { unsafe { let mut map_info = mem::MaybeUninit::zeroed(); let res: bool = from_glib(gst_sys::gst_buffer_map( self.as_mut_ptr(), map_info.as_mut_ptr(), gst_sys::GST_MAP_READ, )); if res { Ok(MappedBuffer { buffer: Some(self), map_info: map_info.assume_init(), phantom: PhantomData, }) } else { Err(self) } } } pub fn into_mapped_buffer_writable(self) -> Result, Self> { unsafe { let mut map_info = mem::MaybeUninit::zeroed(); let res: bool = from_glib(gst_sys::gst_buffer_map( self.as_mut_ptr(), map_info.as_mut_ptr(), gst_sys::GST_MAP_READWRITE, )); if res { Ok(MappedBuffer { buffer: Some(self), map_info: map_info.assume_init(), phantom: PhantomData, }) } else { Err(self) } } } pub fn append(buffer: Self, other: Self) -> Self { skip_assert_initialized!(); unsafe { from_glib_full(gst_sys::gst_buffer_append( buffer.into_ptr(), other.into_ptr(), )) } } } impl Default for Buffer { fn default() -> Self { Self::new() } } impl BufferRef { pub fn map_readable(&self) -> Result, glib::BoolError> { unsafe { let mut map_info = mem::MaybeUninit::zeroed(); let res = gst_sys::gst_buffer_map( self.as_mut_ptr(), map_info.as_mut_ptr(), gst_sys::GST_MAP_READ, ); if res == glib_sys::GTRUE { Ok(BufferMap { buffer: self, map_info: map_info.assume_init(), phantom: PhantomData, }) } else { Err(glib_bool_error!("Failed to map buffer readable")) } } } pub fn map_writable(&mut self) -> Result, glib::BoolError> { unsafe { let mut map_info = mem::MaybeUninit::zeroed(); let res = gst_sys::gst_buffer_map( self.as_mut_ptr(), map_info.as_mut_ptr(), gst_sys::GST_MAP_READWRITE, ); if res == glib_sys::GTRUE { Ok(BufferMap { buffer: self, map_info: map_info.assume_init(), phantom: PhantomData, }) } else { Err(glib_bool_error!("Failed to map buffer writable")) } } } pub fn copy_region( &self, flags: ::BufferCopyFlags, offset: usize, size: Option, ) -> Result { let size_real = size.unwrap_or(usize::MAX); unsafe { Option::<_>::from_glib_full(gst_sys::gst_buffer_copy_region( self.as_mut_ptr(), flags.to_glib(), offset, size_real, )) .ok_or_else(|| glib_bool_error!("Failed to copy region of buffer")) } } pub fn copy_into( &self, dest: &mut BufferRef, flags: ::BufferCopyFlags, offset: usize, size: Option, ) -> Result<(), glib::BoolError> { let size_real = size.unwrap_or(usize::MAX); unsafe { glib_result_from_gboolean!( gst_sys::gst_buffer_copy_into( dest.as_mut_ptr(), self.as_mut_ptr(), flags.to_glib(), offset, size_real, ), "Failed to copy into destination buffer", ) } } pub fn copy_from_slice(&mut self, offset: usize, slice: &[u8]) -> Result<(), usize> { let maxsize = self.get_maxsize(); let size = slice.len(); assert!(maxsize >= offset && maxsize - offset >= size); let copied = unsafe { let src = slice.as_ptr(); gst_sys::gst_buffer_fill( self.as_mut_ptr(), offset, src as glib_sys::gconstpointer, size, ) }; if copied == size { Ok(()) } else { Err(copied) } } pub fn copy_to_slice(&self, offset: usize, slice: &mut [u8]) -> Result<(), usize> { let maxsize = self.get_size(); let size = slice.len(); assert!(maxsize >= offset && maxsize - offset >= size); let copied = unsafe { let dest = slice.as_mut_ptr(); gst_sys::gst_buffer_extract(self.as_mut_ptr(), offset, dest as glib_sys::gpointer, size) }; if copied == size { Ok(()) } else { Err(copied) } } pub fn copy_deep(&self) -> Result { unsafe { Option::<_>::from_glib_full(gst_sys::gst_buffer_copy_deep(self.as_ptr())) .ok_or_else(|| glib_bool_error!("Failed to deep copy buffer")) } } pub fn get_size(&self) -> usize { unsafe { gst_sys::gst_buffer_get_size(self.as_mut_ptr()) } } pub fn get_maxsize(&self) -> usize { unsafe { let mut maxsize = mem::MaybeUninit::uninit(); gst_sys::gst_buffer_get_sizes_range( self.as_mut_ptr(), 0, -1, ptr::null_mut(), maxsize.as_mut_ptr(), ); maxsize.assume_init() } } pub fn set_size(&mut self, size: usize) { assert!(self.get_maxsize() >= size); unsafe { gst_sys::gst_buffer_set_size(self.as_mut_ptr(), size as isize); } } pub fn get_offset(&self) -> u64 { self.0.offset } pub fn set_offset(&mut self, offset: u64) { self.0.offset = offset; } pub fn get_offset_end(&self) -> u64 { self.0.offset_end } pub fn set_offset_end(&mut self, offset_end: u64) { self.0.offset_end = offset_end; } pub fn get_pts(&self) -> ClockTime { from_glib(self.0.pts) } pub fn set_pts(&mut self, pts: ClockTime) { self.0.pts = pts.to_glib(); } pub fn get_dts(&self) -> ClockTime { from_glib(self.0.dts) } pub fn set_dts(&mut self, dts: ClockTime) { self.0.dts = dts.to_glib(); } pub fn get_dts_or_pts(&self) -> ClockTime { let val = self.get_dts(); if val.is_none() { self.get_pts() } else { val } } pub fn get_duration(&self) -> ClockTime { from_glib(self.0.duration) } pub fn set_duration(&mut self, duration: ClockTime) { self.0.duration = duration.to_glib(); } pub fn get_flags(&self) -> BufferFlags { BufferFlags::from_bits_truncate(self.0.mini_object.flags) } pub fn set_flags(&mut self, flags: BufferFlags) { self.0.mini_object.flags |= flags.bits(); } pub fn unset_flags(&mut self, flags: BufferFlags) { self.0.mini_object.flags &= !flags.bits(); } pub fn get_meta(&self) -> Option> { unsafe { let meta = gst_sys::gst_buffer_get_meta(self.as_mut_ptr(), T::get_meta_api().to_glib()); if meta.is_null() { None } else { Some(T::from_ptr(self, meta as *const ::GstType)) } } } pub fn get_meta_mut(&mut self) -> Option> { unsafe { let meta = gst_sys::gst_buffer_get_meta(self.as_mut_ptr(), T::get_meta_api().to_glib()); if meta.is_null() { None } else { Some(T::from_mut_ptr(self, meta as *mut ::GstType)) } } } pub fn iter_meta(&self) -> MetaIter { MetaIter::new(self) } pub fn iter_meta_mut(&mut self) -> MetaIterMut { MetaIterMut::new(self) } pub fn append_memory(&mut self, mem: Memory) { unsafe { gst_sys::gst_buffer_append_memory(self.as_mut_ptr(), mem.into_ptr()) } } pub fn find_memory(&self, offset: usize, size: Option) -> Option<(u32, u32, usize)> { unsafe { let mut idx = mem::MaybeUninit::uninit(); let mut length = mem::MaybeUninit::uninit(); let mut skip = mem::MaybeUninit::uninit(); let res = from_glib(gst_sys::gst_buffer_find_memory( self.as_mut_ptr(), offset, size.unwrap_or(usize::MAX), idx.as_mut_ptr(), length.as_mut_ptr(), skip.as_mut_ptr(), )); if res { Some((idx.assume_init(), length.assume_init(), skip.assume_init())) } else { None } } } pub fn get_all_memory(&self) -> Option { unsafe { let res = gst_sys::gst_buffer_get_all_memory(self.as_mut_ptr()); if res.is_null() { None } else { Some(from_glib_full(res)) } } } pub fn get_max_memory() -> u32 { unsafe { gst_sys::gst_buffer_get_max_memory() } } pub fn get_memory(&self, idx: u32) -> Option { if idx >= self.n_memory() { None } else { unsafe { let res = gst_sys::gst_buffer_get_memory(self.as_mut_ptr(), idx); if res.is_null() { None } else { Some(from_glib_full(res)) } } } } pub fn get_memory_range(&self, idx: u32, length: Option) -> Option { assert!(idx + length.unwrap_or(0) < self.n_memory()); unsafe { let res = gst_sys::gst_buffer_get_memory_range( self.as_mut_ptr(), idx, match length { Some(val) => val as i32, None => -1, }, ); if res.is_null() { None } else { Some(from_glib_full(res)) } } } pub fn insert_memory(&mut self, idx: Option, mem: Memory) { unsafe { gst_sys::gst_buffer_insert_memory( self.as_mut_ptr(), match idx { Some(val) => val as i32, None => -1, }, mem.into_ptr(), ) } } pub fn is_all_memory_writable(&self) -> bool { unsafe { from_glib(gst_sys::gst_buffer_is_all_memory_writable( self.as_mut_ptr(), )) } } pub fn is_memory_range_writable(&self, idx: u32, length: Option) -> bool { unsafe { from_glib(gst_sys::gst_buffer_is_memory_range_writable( self.as_mut_ptr(), idx, match length { Some(val) => val as i32, None => -1, }, )) } } pub fn n_memory(&self) -> u32 { unsafe { gst_sys::gst_buffer_n_memory(self.as_ptr() as *mut _) } } pub fn peek_memory(&self, idx: u32) -> &MemoryRef { assert!(idx < self.n_memory()); unsafe { MemoryRef::from_ptr(gst_sys::gst_buffer_peek_memory(self.as_mut_ptr(), idx)) } } pub fn prepend_memory(&mut self, mem: Memory) { unsafe { gst_sys::gst_buffer_prepend_memory(self.as_mut_ptr(), mem.into_ptr()) } } pub fn remove_all_memory(&mut self) { unsafe { gst_sys::gst_buffer_remove_all_memory(self.as_mut_ptr()) } } pub fn remove_memory(&mut self, idx: u32) { assert!(idx < self.n_memory()); unsafe { gst_sys::gst_buffer_remove_memory(self.as_mut_ptr(), idx) } } pub fn remove_memory_range(&mut self, idx: u32, length: Option) { assert!(idx + length.unwrap_or(0) < self.n_memory()); unsafe { gst_sys::gst_buffer_remove_memory_range( self.as_mut_ptr(), idx, match length { Some(val) => val as i32, None => -1, }, ) } } pub fn replace_all_memory(&mut self, mem: Memory) { unsafe { gst_sys::gst_buffer_replace_all_memory(self.as_mut_ptr(), mem.into_ptr()) } } pub fn replace_memory(&mut self, idx: u32, mem: Memory) { assert!(idx < self.n_memory()); unsafe { gst_sys::gst_buffer_replace_memory(self.as_mut_ptr(), idx, mem.into_ptr()) } } pub fn replace_memory_range(&mut self, idx: u32, length: Option, mem: Memory) { assert!(idx + length.unwrap_or(0) < self.n_memory()); unsafe { gst_sys::gst_buffer_replace_memory_range( self.as_mut_ptr(), idx, match length { Some(val) => val as i32, None => -1, }, mem.into_ptr(), ) } } } macro_rules! define_iter( ($name:ident, $typ:ty, $mtyp:ty, $prepare_buffer:expr, $from_ptr:expr) => { #[derive(Debug)] pub struct $name<'a, T: MetaAPI + 'a> { buffer: $typ, state: glib_sys::gpointer, meta_api: glib::Type, items: PhantomData<$mtyp>, } impl<'a, T: MetaAPI> $name<'a, T> { fn new(buffer: $typ) -> $name<'a, T> { skip_assert_initialized!(); $name { buffer, state: ptr::null_mut(), meta_api: T::get_meta_api(), items: PhantomData, } } } impl<'a, T: MetaAPI> Iterator for $name<'a, T> { type Item = $mtyp; fn next(&mut self) -> Option { loop { unsafe { let meta = gst_sys::gst_buffer_iterate_meta(self.buffer.as_mut_ptr(), &mut self.state); if meta.is_null() { return None; } else if self.meta_api == glib::Type::Invalid || glib::Type::from_glib((*(*meta).info).api) == self.meta_api { // FIXME: Workaround for a lifetime issue with the mutable iterator only let buffer = $prepare_buffer(self.buffer.as_mut_ptr()); let item = $from_ptr(buffer, meta); return Some(item); } } } } } impl<'a, T: MetaAPI> ExactSizeIterator for $name<'a, T> {} } ); define_iter!( MetaIter, &'a BufferRef, MetaRef<'a, T>, |buffer: *const gst_sys::GstBuffer| BufferRef::from_ptr(buffer), |buffer, meta| T::from_ptr(buffer, meta as *const ::GstType) ); define_iter!( MetaIterMut, &'a mut BufferRef, MetaRefMut<'a, T, ::meta::Iterated>, |buffer: *mut gst_sys::GstBuffer| BufferRef::from_mut_ptr(buffer), |buffer: &'a mut BufferRef, meta| T::from_mut_ptr(buffer, meta as *mut ::GstType) ); impl fmt::Debug for BufferRef { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { use std::cell::RefCell; struct DebugIter(RefCell); impl fmt::Debug for DebugIter where I::Item: fmt::Debug, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_list().entries(&mut *self.0.borrow_mut()).finish() } } f.debug_struct("Buffer") .field("ptr", unsafe { &self.as_ptr() }) .field("pts", &self.get_pts().to_string()) .field("dts", &self.get_dts().to_string()) .field("duration", &self.get_duration().to_string()) .field("size", &self.get_size()) .field("offset", &self.get_offset()) .field("offset_end", &self.get_offset_end()) .field("flags", &self.get_flags()) .field( "metas", &DebugIter(RefCell::new( self.iter_meta::<::Meta>().map(|m| m.get_api()), )), ) .finish() } } impl PartialEq for BufferRef { fn eq(&self, other: &BufferRef) -> bool { if self.get_size() != other.get_size() { return false; } let self_map = self.map_readable(); let other_map = other.map_readable(); match (self_map, other_map) { (Ok(self_map), Ok(other_map)) => self_map.as_slice().eq(other_map.as_slice()), _ => false, } } } impl Eq for BufferRef {} impl<'a, T> BufferMap<'a, T> { pub fn get_size(&self) -> usize { self.map_info.size } pub fn get_buffer(&self) -> &BufferRef { self.buffer } pub fn as_slice(&self) -> &[u8] { unsafe { slice::from_raw_parts(self.map_info.data as *const u8, self.map_info.size) } } } impl<'a> BufferMap<'a, Writable> { pub fn as_mut_slice(&mut self) -> &mut [u8] { unsafe { slice::from_raw_parts_mut(self.map_info.data as *mut u8, self.map_info.size) } } } impl<'a, T> AsRef<[u8]> for BufferMap<'a, T> { fn as_ref(&self) -> &[u8] { self.as_slice() } } impl<'a> AsMut<[u8]> for BufferMap<'a, Writable> { fn as_mut(&mut self) -> &mut [u8] { self.as_mut_slice() } } impl<'a, T> ops::Deref for BufferMap<'a, T> { type Target = [u8]; fn deref(&self) -> &[u8] { self.as_slice() } } impl<'a> ops::DerefMut for BufferMap<'a, Writable> { fn deref_mut(&mut self) -> &mut [u8] { self.as_mut_slice() } } impl<'a, T> fmt::Debug for BufferMap<'a, T> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_tuple("BufferMap") .field(&self.get_buffer()) .finish() } } impl<'a, T> PartialEq for BufferMap<'a, T> { fn eq(&self, other: &BufferMap<'a, T>) -> bool { self.as_slice().eq(other.as_slice()) } } impl<'a, T> Eq for BufferMap<'a, T> {} impl<'a, T> Drop for BufferMap<'a, T> { fn drop(&mut self) { unsafe { gst_sys::gst_buffer_unmap(self.buffer.as_mut_ptr(), &mut self.map_info); } } } impl MappedBuffer { pub fn as_slice(&self) -> &[u8] { unsafe { slice::from_raw_parts(self.map_info.data as *const u8, self.map_info.size) } } pub fn get_size(&self) -> usize { self.map_info.size } pub fn get_buffer(&self) -> &BufferRef { self.buffer.as_ref().unwrap().as_ref() } pub fn into_buffer(mut self) -> Buffer { let buffer = self.buffer.take().unwrap(); unsafe { gst_sys::gst_buffer_unmap(buffer.as_mut_ptr(), &mut self.map_info); } buffer } } impl MappedBuffer { pub fn as_mut_slice(&mut self) -> &mut [u8] { unsafe { slice::from_raw_parts_mut(self.map_info.data as *mut u8, self.map_info.size) } } } impl AsRef<[u8]> for MappedBuffer { fn as_ref(&self) -> &[u8] { self.as_slice() } } impl AsMut<[u8]> for MappedBuffer { fn as_mut(&mut self) -> &mut [u8] { self.as_mut_slice() } } impl ops::Deref for MappedBuffer { type Target = [u8]; fn deref(&self) -> &[u8] { self.as_slice() } } impl ops::DerefMut for MappedBuffer { fn deref_mut(&mut self) -> &mut [u8] { self.as_mut_slice() } } impl Drop for MappedBuffer { fn drop(&mut self) { if let Some(ref buffer) = self.buffer { unsafe { gst_sys::gst_buffer_unmap(buffer.as_mut_ptr(), &mut self.map_info); } } } } impl fmt::Debug for MappedBuffer { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.debug_tuple("MappedBuffer") .field(&self.get_buffer()) .finish() } } impl PartialEq for MappedBuffer { fn eq(&self, other: &MappedBuffer) -> bool { self.as_slice().eq(other.as_slice()) } } impl Eq for MappedBuffer {} unsafe impl Send for MappedBuffer {} lazy_static! { pub static ref BUFFER_COPY_METADATA: ::BufferCopyFlags = ::BufferCopyFlags::FLAGS | ::BufferCopyFlags::TIMESTAMPS | ::BufferCopyFlags::META; pub static ref BUFFER_COPY_ALL: ::BufferCopyFlags = *BUFFER_COPY_METADATA | ::BufferCopyFlags::MEMORY; } #[cfg(test)] mod tests { use super::*; #[test] fn test_fields() { ::init().unwrap(); let mut buffer = Buffer::new(); { let buffer = buffer.get_mut().unwrap(); buffer.set_pts(1.into()); buffer.set_dts(2.into()); buffer.set_offset(3); buffer.set_offset_end(4); buffer.set_duration(5.into()); } assert_eq!(buffer.get_pts(), 1.into()); assert_eq!(buffer.get_dts(), 2.into()); assert_eq!(buffer.get_offset(), 3); assert_eq!(buffer.get_offset_end(), 4); assert_eq!(buffer.get_duration(), 5.into()); } #[test] fn test_writability() { ::init().unwrap(); let mut buffer = Buffer::from_slice(vec![1, 2, 3, 4]); { let data = buffer.map_readable().unwrap(); assert_eq!(data.as_slice(), vec![1, 2, 3, 4].as_slice()); } assert_ne!(buffer.get_mut(), None); { let buffer = buffer.get_mut().unwrap(); buffer.set_pts(1.into()); } let mut buffer2 = buffer.clone(); assert_eq!(buffer.get_mut(), None); unsafe { assert_eq!(buffer2.as_ptr(), buffer.as_ptr()); } { let buffer2 = buffer2.make_mut(); unsafe { assert_ne!(buffer2.as_ptr(), buffer.as_ptr()); } buffer2.set_pts(2.into()); let mut data = buffer2.map_writable().unwrap(); assert_eq!(data.as_slice(), vec![1, 2, 3, 4].as_slice()); data.as_mut_slice()[0] = 0; } assert_eq!(buffer.get_pts(), 1.into()); assert_eq!(buffer2.get_pts(), 2.into()); { let data = buffer.map_readable().unwrap(); assert_eq!(data.as_slice(), vec![1, 2, 3, 4].as_slice()); let data = buffer2.map_readable().unwrap(); assert_eq!(data.as_slice(), vec![0, 2, 3, 4].as_slice()); } } }