gstreamer-rs/gstreamer/src/segment.rs
Jan Alexander Steffens (heftig) c05d2e24af
gstreamer/clock_time: Format Debug like Display
This allows us to drop `.to_string()` from the custom Debug
implementations, which now also no longer print as strings.
2021-09-23 02:19:41 +02:00

749 lines
24 KiB
Rust

// Take a look at the license at the top of the repository in the LICENSE file.
use crate::Format;
use crate::GenericFormattedValue;
use crate::SeekFlags;
use crate::SeekType;
use crate::{FormattedValue, FormattedValueIntrinsic};
use glib::translate::*;
use glib::StaticType;
use std::fmt;
use std::marker::PhantomData;
use std::mem;
use std::ptr;
pub type Segment = FormattedSegment<GenericFormattedValue>;
#[repr(transparent)]
#[doc(alias = "GstSegment")]
pub struct FormattedSegment<T: FormattedValueIntrinsic>(ffi::GstSegment, PhantomData<T>);
impl Segment {
pub fn reset_with_format(&mut self, format: Format) {
unsafe {
ffi::gst_segment_init(self.to_glib_none_mut().0, format.into_glib());
}
}
pub fn set_format(&mut self, format: Format) {
self.0.format = format.into_glib();
}
pub fn downcast<T: FormattedValueIntrinsic>(self) -> Result<FormattedSegment<T>, Self> {
if T::FormattedValueType::default_format() == Format::Undefined
|| T::FormattedValueType::default_format() == self.format()
{
Ok(FormattedSegment(self.0, PhantomData))
} else {
Err(self)
}
}
pub fn downcast_ref<T: FormattedValueIntrinsic>(&self) -> Option<&FormattedSegment<T>> {
if T::FormattedValueType::default_format() == Format::Undefined
|| T::FormattedValueType::default_format() == self.format()
{
Some(unsafe {
&*(self as *const FormattedSegment<GenericFormattedValue>
as *const FormattedSegment<T>)
})
} else {
None
}
}
pub fn downcast_mut<T: FormattedValueIntrinsic>(&mut self) -> Option<&mut FormattedSegment<T>> {
if T::FormattedValueType::default_format() == Format::Undefined
|| T::FormattedValueType::default_format() == self.format()
{
Some(unsafe {
&mut *(self as *mut FormattedSegment<GenericFormattedValue>
as *mut FormattedSegment<T>)
})
} else {
None
}
}
}
impl<T: FormattedValueIntrinsic> FormattedSegment<T> {
pub fn new() -> Self {
assert_initialized_main_thread!();
let segment = unsafe {
let mut segment = mem::MaybeUninit::zeroed();
ffi::gst_segment_init(
segment.as_mut_ptr(),
T::FormattedValueType::default_format().into_glib(),
);
segment.assume_init()
};
FormattedSegment(segment, PhantomData)
}
pub fn upcast(self) -> Segment {
FormattedSegment(self.0, PhantomData)
}
pub fn upcast_ref(&self) -> &Segment {
unsafe {
&*(self as *const FormattedSegment<T> as *const FormattedSegment<GenericFormattedValue>)
}
}
pub fn reset(&mut self) {
unsafe {
ffi::gst_segment_init(
&mut self.0,
T::FormattedValueType::default_format().into_glib(),
);
}
}
#[doc(alias = "gst_segment_clip")]
pub fn clip<V: Into<T::FormattedValueType>>(
&self,
start: V,
stop: V,
) -> Option<(T::FormattedValueType, T::FormattedValueType)> {
let start = start.into();
let stop = stop.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), start.format());
assert_eq!(self.format(), stop.format());
}
unsafe {
let mut clip_start = mem::MaybeUninit::uninit();
let mut clip_stop = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gst_segment_clip(
&self.0,
start.format().into_glib(),
start.into_raw_value() as u64,
stop.into_raw_value() as u64,
clip_start.as_mut_ptr(),
clip_stop.as_mut_ptr(),
));
if ret {
Some((
T::FormattedValueType::from_raw(self.format(), clip_start.assume_init() as i64),
T::FormattedValueType::from_raw(self.format(), clip_stop.assume_init() as i64),
))
} else {
None
}
}
}
#[allow(clippy::too_many_arguments)]
#[doc(alias = "gst_segment_do_seek")]
pub fn do_seek<V: Into<T::FormattedValueType>>(
&mut self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: V,
) -> Option<bool> {
skip_assert_initialized!();
let start = start.into();
let stop = stop.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), start.format());
assert_eq!(self.format(), stop.format());
}
unsafe {
let mut update = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gst_segment_do_seek(
&mut self.0,
rate,
self.format().into_glib(),
flags.into_glib(),
start_type.into_glib(),
start.into_raw_value() as u64,
stop_type.into_glib(),
stop.into_raw_value() as u64,
update.as_mut_ptr(),
));
if ret {
Some(from_glib(update.assume_init()))
} else {
None
}
}
}
#[doc(alias = "gst_segment_offset_running_time")]
pub fn offset_running_time(&mut self, offset: i64) -> Result<(), glib::BoolError> {
unsafe {
glib::result_from_gboolean!(
ffi::gst_segment_offset_running_time(
&mut self.0,
self.format().into_glib(),
offset,
),
"Offset is not in the segment"
)
}
}
#[doc(alias = "gst_segment_position_from_running_time")]
pub fn position_from_running_time<V: Into<T::FormattedValueType>>(
&self,
running_time: V,
) -> T::FormattedValueType {
let running_time = running_time.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), running_time.format());
}
unsafe {
T::FormattedValueType::from_raw(
self.format(),
ffi::gst_segment_position_from_running_time(
&self.0,
self.format().into_glib(),
running_time.into_raw_value() as u64,
) as i64,
)
}
}
#[doc(alias = "gst_segment_position_from_running_time_full")]
pub fn position_from_running_time_full<V: Into<T::FormattedValueType>>(
&self,
running_time: V,
) -> (i32, T::FormattedValueType) {
let running_time = running_time.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), running_time.format());
}
unsafe {
let mut position = mem::MaybeUninit::uninit();
let ret = ffi::gst_segment_position_from_running_time_full(
&self.0,
self.format().into_glib(),
running_time.into_raw_value() as u64,
position.as_mut_ptr(),
);
(
ret,
T::FormattedValueType::from_raw(self.format(), position.assume_init() as i64),
)
}
}
#[doc(alias = "gst_segment_position_from_stream_time")]
pub fn position_from_stream_time<V: Into<T::FormattedValueType>>(
&self,
stream_time: V,
) -> T::FormattedValueType {
let stream_time = stream_time.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), stream_time.format());
}
unsafe {
T::FormattedValueType::from_raw(
self.format(),
ffi::gst_segment_position_from_stream_time(
&self.0,
self.format().into_glib(),
stream_time.into_raw_value() as u64,
) as i64,
)
}
}
#[doc(alias = "gst_segment_position_from_stream_time_full")]
pub fn position_from_stream_time_full<V: Into<T::FormattedValueType>>(
&self,
stream_time: V,
) -> (i32, T::FormattedValueType) {
let stream_time = stream_time.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), stream_time.format());
}
unsafe {
let mut position = mem::MaybeUninit::uninit();
let ret = ffi::gst_segment_position_from_stream_time_full(
&self.0,
self.format().into_glib(),
stream_time.into_raw_value() as u64,
position.as_mut_ptr(),
);
(
ret,
T::FormattedValueType::from_raw(self.format(), position.assume_init() as i64),
)
}
}
#[doc(alias = "gst_segment_set_running_time")]
pub fn set_running_time<V: Into<T::FormattedValueType>>(
&mut self,
running_time: V,
) -> Result<(), glib::BoolError> {
let running_time = running_time.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), running_time.format());
}
unsafe {
glib::result_from_gboolean!(
ffi::gst_segment_set_running_time(
&mut self.0,
self.format().into_glib(),
running_time.into_raw_value() as u64,
),
"Running time is not in the segment"
)
}
}
#[doc(alias = "gst_segment_to_running_time")]
pub fn to_running_time<V: Into<T::FormattedValueType>>(
&self,
position: V,
) -> T::FormattedValueType {
let position = position.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), position.format());
}
unsafe {
T::FormattedValueType::from_raw(
self.format(),
ffi::gst_segment_to_running_time(
&self.0,
self.format().into_glib(),
position.into_raw_value() as u64,
) as i64,
)
}
}
#[doc(alias = "gst_segment_to_running_time_full")]
pub fn to_running_time_full<V: Into<T::FormattedValueType>>(
&self,
position: V,
) -> (i32, T::FormattedValueType) {
let position = position.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), position.format());
}
unsafe {
let mut running_time = mem::MaybeUninit::uninit();
let ret = ffi::gst_segment_to_running_time_full(
&self.0,
self.format().into_glib(),
position.into_raw_value() as u64,
running_time.as_mut_ptr(),
);
(
ret,
T::FormattedValueType::from_raw(self.format(), running_time.assume_init() as i64),
)
}
}
#[doc(alias = "gst_segment_to_stream_time")]
pub fn to_stream_time<V: Into<T::FormattedValueType>>(
&self,
position: V,
) -> T::FormattedValueType {
let position = position.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), position.format());
}
unsafe {
T::FormattedValueType::from_raw(
self.format(),
ffi::gst_segment_to_stream_time(
&self.0,
self.format().into_glib(),
position.into_raw_value() as u64,
) as i64,
)
}
}
#[doc(alias = "gst_segment_to_stream_time_full")]
pub fn to_stream_time_full<V: Into<T::FormattedValueType>>(
&self,
position: V,
) -> (i32, T::FormattedValueType) {
let position = position.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), position.format());
}
unsafe {
let mut stream_time = mem::MaybeUninit::uninit();
let ret = ffi::gst_segment_to_stream_time_full(
&self.0,
self.format().into_glib(),
position.into_raw_value() as u64,
stream_time.as_mut_ptr(),
);
(
ret,
T::FormattedValueType::from_raw(self.format(), stream_time.assume_init() as i64),
)
}
}
#[doc(alias = "get_flags")]
pub fn flags(&self) -> crate::SegmentFlags {
unsafe { from_glib(self.0.flags) }
}
pub fn set_flags(&mut self, flags: crate::SegmentFlags) {
self.0.flags = flags.into_glib();
}
#[doc(alias = "get_rate")]
pub fn rate(&self) -> f64 {
self.0.rate
}
#[allow(clippy::float_cmp)]
pub fn set_rate(&mut self, rate: f64) {
assert_ne!(rate, 0.0);
self.0.rate = rate;
}
#[doc(alias = "get_applied_rate")]
pub fn applied_rate(&self) -> f64 {
self.0.applied_rate
}
#[allow(clippy::float_cmp)]
pub fn set_applied_rate(&mut self, applied_rate: f64) {
assert_ne!(applied_rate, 0.0);
self.0.applied_rate = applied_rate;
}
#[doc(alias = "get_format")]
pub fn format(&self) -> Format {
unsafe { from_glib(self.0.format) }
}
#[doc(alias = "get_base")]
pub fn base(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.base as i64) }
}
pub fn set_base<V: Into<T::FormattedValueType>>(&mut self, base: V) {
let base = base.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), base.format());
}
self.0.base = unsafe { base.into_raw_value() } as u64;
}
#[doc(alias = "get_offset")]
pub fn offset(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.offset as i64) }
}
pub fn set_offset<V: Into<T::FormattedValueType>>(&mut self, offset: V) {
let offset = offset.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), offset.format());
}
self.0.offset = unsafe { offset.into_raw_value() } as u64;
}
#[doc(alias = "get_start")]
pub fn start(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.start as i64) }
}
pub fn set_start<V: Into<T::FormattedValueType>>(&mut self, start: V) {
let start = start.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), start.format());
}
self.0.start = unsafe { start.into_raw_value() } as u64;
}
#[doc(alias = "get_stop")]
pub fn stop(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.stop as i64) }
}
pub fn set_stop<V: Into<T::FormattedValueType>>(&mut self, stop: V) {
let stop = stop.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), stop.format());
}
self.0.stop = unsafe { stop.into_raw_value() } as u64;
}
#[doc(alias = "get_time")]
pub fn time(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.time as i64) }
}
pub fn set_time<V: Into<T::FormattedValueType>>(&mut self, time: V) {
let time = time.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), time.format());
}
self.0.time = unsafe { time.into_raw_value() } as u64;
}
#[doc(alias = "get_position")]
pub fn position(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.position as i64) }
}
pub fn set_position<V: Into<T::FormattedValueType>>(&mut self, position: V) {
let position = position.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), position.format());
}
self.0.position = unsafe { position.into_raw_value() } as u64;
}
#[doc(alias = "get_duration")]
pub fn duration(&self) -> T::FormattedValueType {
unsafe { T::FormattedValueType::from_raw(self.format(), self.0.duration as i64) }
}
pub fn set_duration<V: Into<T::FormattedValueType>>(&mut self, duration: V) {
let duration = duration.into();
if T::FormattedValueType::default_format() == Format::Undefined {
assert_eq!(self.format(), duration.format());
}
self.0.duration = unsafe { duration.into_raw_value() } as u64;
}
}
impl<T: FormattedValueIntrinsic> PartialEq for FormattedSegment<T> {
#[inline]
#[doc(alias = "gst_segment_is_equal")]
fn eq(&self, other: &Self) -> bool {
unsafe { from_glib(ffi::gst_segment_is_equal(&self.0, &other.0)) }
}
}
impl<T: FormattedValueIntrinsic> Eq for FormattedSegment<T> {}
unsafe impl<T: FormattedValueIntrinsic> Send for FormattedSegment<T> {}
unsafe impl<T: FormattedValueIntrinsic> Sync for FormattedSegment<T> {}
impl<T: FormattedValueIntrinsic> Clone for FormattedSegment<T> {
fn clone(&self) -> Self {
unsafe { FormattedSegment(ptr::read(&self.0), PhantomData) }
}
}
impl<T: FormattedValueIntrinsic> AsRef<Segment> for FormattedSegment<T> {
fn as_ref(&self) -> &Segment {
unsafe {
&*(self as *const FormattedSegment<T> as *const FormattedSegment<GenericFormattedValue>)
}
}
}
impl<T: FormattedValueIntrinsic> fmt::Debug for FormattedSegment<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
use crate::utils::Displayable;
let segment = self.as_ref();
match segment.format() {
Format::Undefined => f
.debug_struct("Segment")
.field("format", &Format::Undefined)
.finish(),
Format::Time => {
let segment = segment.downcast_ref::<crate::ClockTime>().unwrap();
f.debug_struct("Segment")
.field("format", &Format::Time)
.field("start", &segment.start().display())
.field("offset", &segment.offset().display())
.field("stop", &segment.stop().display())
.field("rate", &segment.rate())
.field("applied_rate", &segment.applied_rate())
.field("flags", &segment.flags())
.field("time", &segment.time().display())
.field("base", &segment.base().display())
.field("position", &segment.position().display())
.field("duration", &segment.duration().display())
.finish()
}
_ => f
.debug_struct("Segment")
.field("format", &segment.format())
.field("start", &segment.start())
.field("offset", &segment.offset())
.field("stop", &segment.stop())
.field("rate", &segment.rate())
.field("applied_rate", &segment.applied_rate())
.field("flags", &segment.flags())
.field("time", &segment.time())
.field("base", &segment.base())
.field("position", &segment.position())
.field("duration", &segment.duration())
.finish(),
}
}
}
impl<T: FormattedValueIntrinsic> Default for FormattedSegment<T> {
fn default() -> Self {
Self::new()
}
}
impl<T: FormattedValueIntrinsic> glib::types::StaticType for FormattedSegment<T> {
fn static_type() -> glib::types::Type {
unsafe { glib::translate::from_glib(ffi::gst_segment_get_type()) }
}
}
impl glib::value::ValueType for Segment {
type Type = Self;
}
#[doc(hidden)]
unsafe impl<'a> glib::value::FromValue<'a> for Segment {
type Checker = glib::value::GenericValueTypeOrNoneChecker<Self>;
unsafe fn from_value(value: &'a glib::Value) -> Self {
skip_assert_initialized!();
from_glib_none(
glib::gobject_ffi::g_value_get_boxed(value.to_glib_none().0) as *mut ffi::GstSegment
)
}
}
#[doc(hidden)]
impl<T: FormattedValueIntrinsic> glib::value::ToValue for FormattedSegment<T> {
fn to_value(&self) -> glib::Value {
let mut value = glib::Value::for_value_type::<Segment>();
unsafe {
glib::gobject_ffi::g_value_set_boxed(
value.to_glib_none_mut().0,
self.to_glib_none().0 as *mut _,
)
}
value
}
fn value_type(&self) -> glib::Type {
Self::static_type()
}
}
#[doc(hidden)]
impl<T: FormattedValueIntrinsic> glib::value::ToValueOptional for FormattedSegment<T> {
fn to_value_optional(s: Option<&Self>) -> glib::Value {
skip_assert_initialized!();
let mut value = glib::Value::for_value_type::<Segment>();
unsafe {
glib::gobject_ffi::g_value_set_boxed(
value.to_glib_none_mut().0,
s.to_glib_none().0 as *mut _,
)
}
value
}
}
#[doc(hidden)]
#[doc(hidden)]
impl<T: FormattedValueIntrinsic> glib::translate::GlibPtrDefault for FormattedSegment<T> {
type GlibType = *mut ffi::GstSegment;
}
#[doc(hidden)]
impl<'a, T: FormattedValueIntrinsic> glib::translate::ToGlibPtr<'a, *const ffi::GstSegment>
for FormattedSegment<T>
{
type Storage = &'a FormattedSegment<T>;
fn to_glib_none(&'a self) -> glib::translate::Stash<'a, *const ffi::GstSegment, Self> {
glib::translate::Stash(&self.0, self)
}
fn to_glib_full(&self) -> *const ffi::GstSegment {
unimplemented!()
}
}
#[doc(hidden)]
impl<'a, T: FormattedValueIntrinsic> glib::translate::ToGlibPtrMut<'a, *mut ffi::GstSegment>
for FormattedSegment<T>
{
type Storage = &'a mut FormattedSegment<T>;
#[inline]
fn to_glib_none_mut(&'a mut self) -> glib::translate::StashMut<'a, *mut ffi::GstSegment, Self> {
glib::translate::StashMut(&mut self.0, self)
}
}
#[doc(hidden)]
impl glib::translate::FromGlibPtrNone<*const ffi::GstSegment> for Segment {
#[inline]
unsafe fn from_glib_none(ptr: *const ffi::GstSegment) -> Self {
FormattedSegment(ptr::read(ptr), PhantomData)
}
}
#[doc(hidden)]
impl glib::translate::FromGlibPtrNone<*mut ffi::GstSegment> for Segment {
#[inline]
unsafe fn from_glib_none(ptr: *mut ffi::GstSegment) -> Self {
FormattedSegment(ptr::read(ptr), PhantomData)
}
}
#[doc(hidden)]
impl glib::translate::FromGlibPtrBorrow<*mut ffi::GstSegment> for Segment {
#[inline]
unsafe fn from_glib_borrow(ptr: *mut ffi::GstSegment) -> Borrowed<Self> {
Borrowed::new(FormattedSegment(ptr::read(ptr), PhantomData))
}
}
#[doc(hidden)]
impl glib::translate::FromGlibPtrFull<*mut ffi::GstSegment> for Segment {
#[inline]
unsafe fn from_glib_full(ptr: *mut ffi::GstSegment) -> Self {
let segment = from_glib_none(ptr);
glib::ffi::g_free(ptr as *mut _);
segment
}
}