gstreamer-rs/gstreamer-video/src/video_info.rs

1132 lines
34 KiB
Rust
Raw Normal View History

2020-12-15 10:53:31 +00:00
// Take a look at the license at the top of the repository in the LICENSE file.
2017-08-11 09:29:23 +00:00
use glib::translate::*;
2018-04-01 08:30:03 +00:00
use gst::prelude::*;
2017-08-11 09:29:23 +00:00
2018-04-01 08:30:03 +00:00
use std::fmt;
2017-08-11 09:29:23 +00:00
use std::mem;
use std::ptr;
use std::str;
pub const VIDEO_MAX_PLANES: usize = ffi::GST_VIDEO_MAX_PLANES as usize;
2019-06-18 05:27:58 +00:00
#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Clone, Copy)]
#[non_exhaustive]
#[doc(alias = "GstVideoColorRange")]
2017-08-11 09:29:23 +00:00
pub enum VideoColorRange {
#[doc(alias = "GST_VIDEO_COLOR_RANGE_UNKNOWN")]
2017-08-11 09:29:23 +00:00
Unknown,
#[doc(alias = "GST_VIDEO_COLOR_RANGE_0_255")]
Range0_255,
#[doc(alias = "GST_VIDEO_COLOR_RANGE_16_235")]
Range16_235,
#[doc(hidden)]
__Unknown(i32),
2017-08-11 09:29:23 +00:00
}
#[doc(hidden)]
impl IntoGlib for VideoColorRange {
type GlibType = ffi::GstVideoColorRange;
2017-08-11 09:29:23 +00:00
fn into_glib(self) -> ffi::GstVideoColorRange {
match self {
Self::Unknown => ffi::GST_VIDEO_COLOR_RANGE_UNKNOWN,
Self::Range0_255 => ffi::GST_VIDEO_COLOR_RANGE_0_255,
Self::Range16_235 => ffi::GST_VIDEO_COLOR_RANGE_16_235,
Self::__Unknown(value) => value,
2017-08-11 09:29:23 +00:00
}
}
}
#[doc(hidden)]
impl FromGlib<ffi::GstVideoColorRange> for VideoColorRange {
unsafe fn from_glib(value: ffi::GstVideoColorRange) -> Self {
2017-08-11 09:29:23 +00:00
skip_assert_initialized!();
match value {
0 => Self::Unknown,
1 => Self::Range0_255,
2 => Self::Range16_235,
value => Self::__Unknown(value),
2017-08-11 09:29:23 +00:00
}
}
}
impl StaticType for VideoColorRange {
2017-08-11 09:29:23 +00:00
fn static_type() -> glib::Type {
unsafe { from_glib(ffi::gst_video_color_range_get_type()) }
2017-08-11 09:29:23 +00:00
}
}
2021-04-20 07:19:02 +00:00
impl glib::value::ValueType for VideoColorRange {
type Type = Self;
2017-08-11 09:29:23 +00:00
}
2021-04-20 07:19:02 +00:00
unsafe impl<'a> glib::value::FromValue<'a> for VideoColorRange {
type Checker = glib::value::GenericValueTypeChecker<Self>;
unsafe fn from_value(value: &'a glib::Value) -> Self {
2021-04-20 07:19:02 +00:00
skip_assert_initialized!();
from_glib(glib::gobject_ffi::g_value_get_enum(value.to_glib_none().0))
2017-08-11 09:29:23 +00:00
}
}
impl ToValue for VideoColorRange {
2021-04-20 07:19:02 +00:00
fn to_value(&self) -> glib::Value {
let mut value = glib::Value::for_value_type::<Self>();
unsafe { glib::gobject_ffi::g_value_set_enum(value.to_glib_none_mut().0, self.into_glib()) }
2021-04-20 07:19:02 +00:00
value
}
fn value_type(&self) -> glib::Type {
Self::static_type()
2017-08-11 09:29:23 +00:00
}
}
#[doc(alias = "GstVideoColorimetry")]
#[derive(Copy, Clone)]
pub struct VideoColorimetry(ffi::GstVideoColorimetry);
2017-08-11 09:29:23 +00:00
impl VideoColorimetry {
pub fn new(
range: crate::VideoColorRange,
matrix: crate::VideoColorMatrix,
transfer: crate::VideoTransferFunction,
primaries: crate::VideoColorPrimaries,
2017-08-11 09:29:23 +00:00
) -> Self {
assert_initialized_main_thread!();
2017-08-11 09:29:23 +00:00
let colorimetry = ffi::GstVideoColorimetry {
range: range.into_glib(),
matrix: matrix.into_glib(),
transfer: transfer.into_glib(),
primaries: primaries.into_glib(),
2017-08-11 09:29:23 +00:00
};
Self(colorimetry)
2017-08-11 09:29:23 +00:00
}
pub fn range(&self) -> crate::VideoColorRange {
unsafe { from_glib(self.0.range) }
2019-01-26 23:42:53 +00:00
}
pub fn matrix(&self) -> crate::VideoColorMatrix {
unsafe { from_glib(self.0.matrix) }
2019-01-26 23:42:53 +00:00
}
pub fn transfer(&self) -> crate::VideoTransferFunction {
unsafe { from_glib(self.0.transfer) }
2019-01-26 23:42:53 +00:00
}
pub fn primaries(&self) -> crate::VideoColorPrimaries {
unsafe { from_glib(self.0.primaries) }
2019-01-26 23:42:53 +00:00
}
2017-08-11 09:29:23 +00:00
}
impl PartialEq for VideoColorimetry {
#[doc(alias = "gst_video_colorimetry_is_equal")]
2017-08-11 09:29:23 +00:00
fn eq(&self, other: &Self) -> bool {
unsafe { from_glib(ffi::gst_video_colorimetry_is_equal(&self.0, &other.0)) }
2017-08-11 09:29:23 +00:00
}
}
impl Eq for VideoColorimetry {}
impl str::FromStr for crate::VideoColorimetry {
type Err = glib::error::BoolError;
2017-08-11 09:29:23 +00:00
#[doc(alias = "gst_video_colorimetry_from_string")]
2020-11-28 11:34:36 +00:00
fn from_str(s: &str) -> Result<Self, Self::Err> {
assert_initialized_main_thread!();
unsafe {
let mut colorimetry = mem::MaybeUninit::zeroed();
let valid: bool = from_glib(ffi::gst_video_colorimetry_from_string(
colorimetry.as_mut_ptr(),
s.to_glib_none().0,
));
if valid {
2020-11-28 11:34:36 +00:00
Ok(Self(colorimetry.assume_init()))
} else {
Err(glib::bool_error!("Invalid colorimetry info"))
}
}
2017-08-11 09:29:23 +00:00
}
}
impl fmt::Debug for crate::VideoColorimetry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("VideoColorimetry")
.field("range", &self.0.range)
.field("matrix", &self.0.matrix)
.field("transfer", &self.0.transfer)
.field("primaries", &self.0.primaries)
.finish()
2017-08-11 09:29:23 +00:00
}
}
impl fmt::Display for crate::VideoColorimetry {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let s =
unsafe { glib::GString::from_glib_full(ffi::gst_video_colorimetry_to_string(&self.0)) };
f.write_str(&s)
2017-08-11 09:29:23 +00:00
}
}
impl crate::VideoChromaSite {
#[doc(alias = "gst_video_chroma_site_to_string")]
#[doc(alias = "gst_video_chroma_to_string")]
pub fn to_str(self) -> glib::GString {
assert_initialized_main_thread!();
unsafe {
cfg_if::cfg_if! {
if #[cfg(feature = "v1_20")] {
from_glib_full(ffi::gst_video_chroma_site_to_string(self.into_glib()))
} else {
from_glib_none(ffi::gst_video_chroma_to_string(self.into_glib()))
}
}
}
}
}
impl str::FromStr for crate::VideoChromaSite {
2020-08-11 07:04:09 +00:00
type Err = glib::error::BoolError;
#[doc(alias = "gst_video_chroma_from_string")]
2020-11-28 11:34:36 +00:00
fn from_str(s: &str) -> Result<Self, Self::Err> {
2020-11-24 09:11:35 +00:00
skip_assert_initialized!();
2020-08-11 07:04:09 +00:00
2020-11-24 09:11:35 +00:00
cfg_if::cfg_if! {
if #[cfg(feature = "v1_20")] {
2020-11-24 09:11:35 +00:00
let chroma_site = Self::from_string(s);
2020-08-11 07:04:09 +00:00
} else {
2020-11-24 09:11:35 +00:00
assert_initialized_main_thread!();
let chroma_site: Self =
unsafe { from_glib(ffi::gst_video_chroma_from_string(s.to_glib_none().0)) };
2020-08-11 07:04:09 +00:00
}
2020-11-24 09:11:35 +00:00
};
if chroma_site.is_empty() {
Err(glib::bool_error!("Invalid chroma site"))
2020-11-24 09:11:35 +00:00
} else {
Ok(chroma_site)
2020-08-11 07:04:09 +00:00
}
}
}
impl From<crate::VideoMultiviewFramePacking> for crate::VideoMultiviewMode {
fn from(v: crate::VideoMultiviewFramePacking) -> Self {
2020-03-22 14:18:47 +00:00
skip_assert_initialized!();
unsafe { from_glib(v.into_glib()) }
}
}
impl TryFrom<crate::VideoMultiviewMode> for crate::VideoMultiviewFramePacking {
type Error = glib::BoolError;
fn try_from(v: crate::VideoMultiviewMode) -> Result<Self, glib::BoolError> {
2020-03-22 14:18:47 +00:00
skip_assert_initialized!();
let v2 = unsafe { from_glib(v.into_glib()) };
if let Self::__Unknown(_) = v2 {
Err(glib::bool_error!("Invalid frame packing mode"))
} else {
Ok(v2)
}
}
}
#[doc(alias = "GstVideoInfo")]
#[derive(Clone)]
pub struct VideoInfo(pub(crate) ffi::GstVideoInfo);
2017-08-11 09:29:23 +00:00
2017-11-06 12:20:50 +00:00
impl fmt::Debug for VideoInfo {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let mut b = f.debug_struct("VideoInfo");
b.field("format", &self.format())
.field("format-info", &self.format_info())
2017-11-06 12:20:50 +00:00
.field("width", &self.width())
.field("height", &self.height())
.field("interlace_mode", &self.interlace_mode())
.field("flags", &self.flags())
2017-11-06 12:20:50 +00:00
.field("size", &self.size())
.field("views", &self.views())
.field("chroma_site", &self.chroma_site())
.field("colorimetry", &self.colorimetry())
.field("par", &self.par())
.field("fps", &self.fps())
.field("offset", &self.offset())
.field("stride", &self.stride())
.field("multiview_mode", &self.multiview_mode())
.field("multiview_flags", &self.multiview_flags());
#[cfg(any(feature = "v1_12", feature = "dox"))]
b.field("field_order", &self.field_order());
b.finish()
2017-11-06 12:20:50 +00:00
}
}
#[derive(Debug)]
2017-08-11 09:29:23 +00:00
pub struct VideoInfoBuilder<'a> {
format: crate::VideoFormat,
2017-08-11 09:29:23 +00:00
width: u32,
height: u32,
interlace_mode: Option<crate::VideoInterlaceMode>,
flags: Option<crate::VideoFlags>,
2017-08-11 09:29:23 +00:00
size: Option<usize>,
views: Option<u32>,
chroma_site: Option<crate::VideoChromaSite>,
colorimetry: Option<&'a crate::VideoColorimetry>,
2017-08-11 09:29:23 +00:00
par: Option<gst::Fraction>,
fps: Option<gst::Fraction>,
offset: Option<&'a [usize]>,
stride: Option<&'a [i32]>,
multiview_mode: Option<crate::VideoMultiviewMode>,
multiview_flags: Option<crate::VideoMultiviewFlags>,
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
field_order: Option<crate::VideoFieldOrder>,
2017-08-11 09:29:23 +00:00
}
impl<'a> VideoInfoBuilder<'a> {
pub fn build(self) -> Result<VideoInfo, glib::error::BoolError> {
2017-08-11 09:29:23 +00:00
unsafe {
let mut info = mem::MaybeUninit::uninit();
2017-08-11 09:29:23 +00:00
cfg_if::cfg_if! {
if #[cfg(feature = "v1_16")] {
let res: bool = {
from_glib(if let Some(interlace_mode) = self.interlace_mode {
ffi::gst_video_info_set_interlaced_format(
info.as_mut_ptr(),
self.format.into_glib(),
interlace_mode.into_glib(),
self.width,
self.height,
)
} else {
ffi::gst_video_info_set_format(
info.as_mut_ptr(),
self.format.into_glib(),
self.width,
self.height,
)
})
};
} else if #[cfg(feature = "v1_12")] {
let res: bool = {
let res = from_glib(ffi::gst_video_info_set_format(
info.as_mut_ptr(),
self.format.into_glib(),
self.width,
self.height,
));
if res {
if let Some(interlace_mode) = self.interlace_mode {
let info = info.as_mut_ptr();
(*info).interlace_mode = interlace_mode.into_glib();
}
}
res
};
} else {
let res: bool = {
// The bool return value is new with 1.11.1, see
// https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/commit/17cdd369e6f2f73329d27dfceb50011f40f1ceb0
let res = if gst::version() < (1, 11, 1, 0) {
ffi::gst_video_info_set_format(
info.as_mut_ptr(),
self.format.into_glib(),
self.width,
self.height,
);
true
} else {
from_glib(ffi::gst_video_info_set_format(
info.as_mut_ptr(),
self.format.into_glib(),
self.width,
self.height,
))
};
if res {
if let Some(interlace_mode) = self.interlace_mode {
let info = info.as_mut_ptr();
(*info).interlace_mode = interlace_mode.into_glib();
}
}
res
};
}
}
if !res {
return Err(glib::bool_error!("Failed to build VideoInfo"));
}
2017-08-11 09:29:23 +00:00
let mut info = info.assume_init();
if info.finfo.is_null() || info.width <= 0 || info.height <= 0 {
return Err(glib::bool_error!("Failed to build VideoInfo"));
2017-08-11 09:29:23 +00:00
}
if let Some(flags) = self.flags {
info.flags = flags.into_glib();
2017-08-11 09:29:23 +00:00
}
if let Some(size) = self.size {
info.size = size;
}
if let Some(views) = self.views {
info.views = views as i32;
}
if let Some(chroma_site) = self.chroma_site {
info.chroma_site = chroma_site.into_glib();
2017-08-11 09:29:23 +00:00
}
if let Some(colorimetry) = self.colorimetry {
ptr::write(&mut info.colorimetry, ptr::read(&colorimetry.0));
}
if let Some(par) = self.par {
info.par_n = par.numer();
info.par_d = par.denom();
2017-08-11 09:29:23 +00:00
}
if let Some(fps) = self.fps {
info.fps_n = fps.numer();
info.fps_d = fps.denom();
2017-08-11 09:29:23 +00:00
}
if let Some(offset) = self.offset {
if offset.len() != ((*info.finfo).n_planes as usize) {
return Err(glib::bool_error!("Failed to build VideoInfo"));
2017-08-11 09:29:23 +00:00
}
let n_planes = (*info.finfo).n_planes as usize;
info.offset[..n_planes].copy_from_slice(&offset[..n_planes]);
2017-08-11 09:29:23 +00:00
}
if let Some(stride) = self.stride {
if stride.len() != ((*info.finfo).n_planes as usize) {
return Err(glib::bool_error!("Failed to build VideoInfo"));
2017-08-11 09:29:23 +00:00
}
let n_planes = (*info.finfo).n_planes as usize;
info.stride[..n_planes].copy_from_slice(&stride[..n_planes]);
2017-08-11 09:29:23 +00:00
}
if let Some(multiview_mode) = self.multiview_mode {
let ptr = &mut info.ABI._gst_reserved as *mut _ as *mut i32;
ptr::write(ptr.offset(0), multiview_mode.into_glib());
2017-08-11 09:29:23 +00:00
}
if let Some(multiview_flags) = self.multiview_flags {
let ptr = &mut info.ABI._gst_reserved as *mut _ as *mut u32;
ptr::write(ptr.offset(1), multiview_flags.into_glib());
2017-08-11 09:29:23 +00:00
}
#[cfg(any(feature = "v1_12", feature = "dox"))]
if let Some(field_order) = self.field_order {
let ptr = &mut info.ABI._gst_reserved as *mut _ as *mut i32;
ptr::write(ptr.offset(2), field_order.into_glib());
2017-08-11 09:29:23 +00:00
}
Ok(VideoInfo(info))
2017-08-11 09:29:23 +00:00
}
}
pub fn interlace_mode(self, interlace_mode: crate::VideoInterlaceMode) -> VideoInfoBuilder<'a> {
2017-08-11 09:29:23 +00:00
Self {
interlace_mode: Some(interlace_mode),
..self
}
}
pub fn flags(self, flags: crate::VideoFlags) -> Self {
2017-08-11 09:29:23 +00:00
Self {
flags: Some(flags),
..self
}
}
pub fn size(self, size: usize) -> Self {
Self {
size: Some(size),
..self
}
}
pub fn views(self, views: u32) -> Self {
Self {
views: Some(views),
..self
}
}
pub fn chroma_site(self, chroma_site: crate::VideoChromaSite) -> Self {
2017-08-11 09:29:23 +00:00
Self {
chroma_site: Some(chroma_site),
..self
}
}
pub fn colorimetry(self, colorimetry: &'a crate::VideoColorimetry) -> VideoInfoBuilder<'a> {
2017-08-11 09:29:23 +00:00
Self {
colorimetry: Some(colorimetry),
..self
}
}
pub fn par<T: Into<gst::Fraction>>(self, par: T) -> Self {
2017-08-11 09:29:23 +00:00
Self {
par: Some(par.into()),
2017-08-11 09:29:23 +00:00
..self
}
}
pub fn fps<T: Into<gst::Fraction>>(self, fps: T) -> Self {
2017-08-11 09:29:23 +00:00
Self {
fps: Some(fps.into()),
2017-08-11 09:29:23 +00:00
..self
}
}
pub fn offset(self, offset: &'a [usize]) -> VideoInfoBuilder<'a> {
Self {
offset: Some(offset),
..self
}
}
pub fn stride(self, stride: &'a [i32]) -> VideoInfoBuilder<'a> {
Self {
stride: Some(stride),
..self
}
}
pub fn multiview_mode(self, multiview_mode: crate::VideoMultiviewMode) -> Self {
2017-08-11 09:29:23 +00:00
Self {
multiview_mode: Some(multiview_mode),
..self
}
}
pub fn multiview_flags(self, multiview_flags: crate::VideoMultiviewFlags) -> Self {
2017-08-11 09:29:23 +00:00
Self {
multiview_flags: Some(multiview_flags),
..self
}
}
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
pub fn field_order(self, field_order: crate::VideoFieldOrder) -> Self {
2017-08-11 09:29:23 +00:00
Self {
field_order: Some(field_order),
..self
}
}
}
impl VideoInfo {
pub fn builder<'a>(
format: crate::VideoFormat,
width: u32,
height: u32,
) -> VideoInfoBuilder<'a> {
assert_initialized_main_thread!();
cfg_if::cfg_if! {
if #[cfg(any(feature = "v1_12", feature = "dox"))] {
VideoInfoBuilder {
format,
width,
height,
interlace_mode: None,
flags: None,
size: None,
views: None,
chroma_site: None,
colorimetry: None,
par: None,
fps: None,
offset: None,
stride: None,
multiview_mode: None,
multiview_flags: None,
field_order: None,
}
} else {
VideoInfoBuilder {
format,
width,
height,
interlace_mode: None,
flags: None,
size: None,
views: None,
chroma_site: None,
colorimetry: None,
par: None,
fps: None,
offset: None,
stride: None,
multiview_mode: None,
multiview_flags: None,
}
2017-08-11 09:29:23 +00:00
}
}
}
pub fn is_valid(&self) -> bool {
!self.0.finfo.is_null() && self.0.width > 0 && self.0.height > 0 && self.0.size > 0
}
#[doc(alias = "gst_video_info_from_caps")]
pub fn from_caps(caps: &gst::CapsRef) -> Result<Self, glib::error::BoolError> {
2017-08-30 11:39:09 +00:00
skip_assert_initialized!();
2017-08-11 09:29:23 +00:00
unsafe {
let mut info = mem::MaybeUninit::uninit();
if from_glib(ffi::gst_video_info_from_caps(
info.as_mut_ptr(),
2019-03-19 07:58:20 +00:00
caps.as_ptr(),
)) {
Ok(Self(info.assume_init()))
2017-08-11 09:29:23 +00:00
} else {
Err(glib::bool_error!("Failed to create VideoInfo from caps"))
2017-08-11 09:29:23 +00:00
}
}
}
#[doc(alias = "gst_video_info_to_caps")]
pub fn to_caps(&self) -> Result<gst::Caps, glib::error::BoolError> {
2019-03-19 07:58:20 +00:00
unsafe {
let result = from_glib_full(ffi::gst_video_info_to_caps(&self.0 as *const _ as *mut _));
match result {
Some(c) => Ok(c),
None => Err(glib::bool_error!("Failed to create caps from VideoInfo")),
}
2019-03-19 07:58:20 +00:00
}
2017-08-11 09:29:23 +00:00
}
pub fn format(&self) -> crate::VideoFormat {
if self.0.finfo.is_null() {
return crate::VideoFormat::Unknown;
}
2017-08-11 09:29:23 +00:00
unsafe { from_glib((*self.0.finfo).format) }
}
pub fn format_info(&self) -> crate::VideoFormatInfo {
crate::VideoFormatInfo::from_format(self.format())
2017-08-11 09:29:23 +00:00
}
pub fn width(&self) -> u32 {
self.0.width as u32
}
pub fn height(&self) -> u32 {
self.0.height as u32
}
#[cfg(any(feature = "v1_16", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_16")))]
pub fn field_height(&self) -> u32 {
if self.0.interlace_mode == ffi::GST_VIDEO_INTERLACE_MODE_ALTERNATE {
(self.0.height as u32 + 1) / 2
} else {
self.0.height as u32
}
}
pub fn interlace_mode(&self) -> crate::VideoInterlaceMode {
unsafe { from_glib(self.0.interlace_mode) }
2017-08-11 09:29:23 +00:00
}
pub fn flags(&self) -> crate::VideoFlags {
unsafe { from_glib(self.0.flags) }
2017-08-11 09:29:23 +00:00
}
pub fn size(&self) -> usize {
self.0.size
}
pub fn views(&self) -> u32 {
self.0.views as u32
}
pub fn chroma_site(&self) -> crate::VideoChromaSite {
unsafe { from_glib(self.0.chroma_site) }
2017-08-11 09:29:23 +00:00
}
pub fn colorimetry(&self) -> VideoColorimetry {
unsafe { VideoColorimetry(ptr::read(&self.0.colorimetry)) }
}
pub fn par(&self) -> gst::Fraction {
gst::Fraction::new(self.0.par_n, self.0.par_d)
}
pub fn fps(&self) -> gst::Fraction {
gst::Fraction::new(self.0.fps_n, self.0.fps_d)
}
pub fn offset(&self) -> &[usize] {
&self.0.offset[0..(self.format_info().n_planes() as usize)]
}
pub fn stride(&self) -> &[i32] {
&self.0.stride[0..(self.format_info().n_planes() as usize)]
}
pub fn multiview_mode(&self) -> crate::VideoMultiviewMode {
2017-08-11 09:29:23 +00:00
unsafe {
let ptr = &self.0.ABI._gst_reserved as *const _ as *const i32;
from_glib(ptr::read(ptr.offset(0)))
2017-08-11 09:29:23 +00:00
}
}
pub fn multiview_flags(&self) -> crate::VideoMultiviewFlags {
2017-08-11 09:29:23 +00:00
unsafe {
let ptr = &self.0.ABI._gst_reserved as *const _ as *const u32;
from_glib(ptr::read(ptr.offset(1)))
2017-08-11 09:29:23 +00:00
}
}
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
pub fn field_order(&self) -> crate::VideoFieldOrder {
2017-08-11 09:29:23 +00:00
unsafe {
let ptr = &self.0.ABI._gst_reserved as *const _ as *const i32;
from_glib(ptr::read(ptr.offset(2)))
2017-08-11 09:29:23 +00:00
}
}
pub fn has_alpha(&self) -> bool {
self.format_info().has_alpha()
}
pub fn is_gray(&self) -> bool {
self.format_info().is_gray()
}
pub fn is_rgb(&self) -> bool {
self.format_info().is_rgb()
}
pub fn is_yuv(&self) -> bool {
self.format_info().is_yuv()
}
pub fn is_interlaced(&self) -> bool {
self.interlace_mode() != crate::VideoInterlaceMode::Progressive
}
pub fn n_planes(&self) -> u32 {
self.format_info().n_planes()
}
pub fn n_components(&self) -> u32 {
self.format_info().n_components()
}
2017-08-11 09:54:01 +00:00
#[doc(alias = "gst_video_info_convert")]
pub fn convert<V: Into<gst::GenericFormattedValue>, U: gst::SpecificFormattedValue>(
2017-08-11 09:54:01 +00:00
&self,
src_val: V,
) -> Option<U> {
skip_assert_initialized!();
let src_val = src_val.into();
unsafe {
let mut dest_val = mem::MaybeUninit::uninit();
if from_glib(ffi::gst_video_info_convert(
&self.0 as *const _ as *mut _,
src_val.format().into_glib(),
2021-04-28 22:29:13 +00:00
src_val.into_raw_value(),
U::default_format().into_glib(),
dest_val.as_mut_ptr(),
)) {
2021-04-20 10:24:17 +00:00
Some(U::from_raw(U::default_format(), dest_val.assume_init()))
} else {
None
}
}
}
pub fn convert_generic<V: Into<gst::GenericFormattedValue>>(
&self,
src_val: V,
dest_fmt: gst::Format,
) -> Option<gst::GenericFormattedValue> {
skip_assert_initialized!();
let src_val = src_val.into();
2017-08-11 09:54:01 +00:00
unsafe {
let mut dest_val = mem::MaybeUninit::uninit();
if from_glib(ffi::gst_video_info_convert(
2017-08-11 09:54:01 +00:00
&self.0 as *const _ as *mut _,
src_val.format().into_glib(),
2021-04-28 22:29:13 +00:00
src_val.into_raw_value(),
dest_fmt.into_glib(),
dest_val.as_mut_ptr(),
2017-08-11 09:54:01 +00:00
)) {
Some(gst::GenericFormattedValue::new(
dest_fmt,
dest_val.assume_init(),
))
2017-08-11 09:54:01 +00:00
} else {
None
}
}
}
2019-06-17 11:24:11 +00:00
#[doc(alias = "gst_video_info_align")]
pub fn align(&mut self, align: &mut crate::VideoAlignment) -> Result<(), glib::BoolError> {
cfg_if::cfg_if! {
if #[cfg(feature = "v1_12")] {
unsafe {
glib::result_from_gboolean!(ffi::gst_video_info_align(
&mut self.0,
&mut align.0,
), "Failed to align VideoInfo")
}
} else {
unsafe {
// The bool return value is new with 1.11.1, see
// https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/commit/17cdd369e6f2f73329d27dfceb50011f40f1ceb0
if gst::version() < (1, 11, 1, 0) {
ffi::gst_video_info_align(&mut self.0, &mut align.0);
Ok(())
} else {
glib::result_from_gboolean!(ffi::gst_video_info_align(
&mut self.0,
&mut align.0,
), "Failed to align VideoInfo")
}
}
}
}
2019-06-17 11:24:11 +00:00
}
2020-12-03 10:56:23 +00:00
#[cfg(any(feature = "v1_18", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
#[doc(alias = "gst_video_info_align_full")]
2020-12-03 10:56:23 +00:00
pub fn align_full(
&mut self,
align: &mut crate::VideoAlignment,
) -> Result<([usize; crate::VIDEO_MAX_PLANES]), glib::BoolError> {
let mut plane_size = [0; crate::VIDEO_MAX_PLANES];
unsafe {
glib::result_from_gboolean!(
2020-12-03 10:56:23 +00:00
ffi::gst_video_info_align_full(&mut self.0, &mut align.0, plane_size.as_mut_ptr()),
"Failed to align VideoInfo"
)?;
}
Ok(plane_size)
}
#[doc(alias = "gst_video_color_range_offsets")]
pub fn range_offsets(&self, range: crate::VideoColorRange) -> ([i32; 4], [i32; 4]) {
self.format_info().range_offsets(range)
}
2017-08-11 09:29:23 +00:00
}
impl PartialEq for VideoInfo {
#[doc(alias = "gst_video_info_is_equal")]
2017-08-11 09:29:23 +00:00
fn eq(&self, other: &Self) -> bool {
unsafe { from_glib(ffi::gst_video_info_is_equal(&self.0, &other.0)) }
2017-08-11 09:29:23 +00:00
}
}
impl Eq for VideoInfo {}
unsafe impl Send for VideoInfo {}
unsafe impl Sync for VideoInfo {}
2017-08-11 09:29:23 +00:00
impl glib::types::StaticType for VideoInfo {
fn static_type() -> glib::types::Type {
unsafe { glib::translate::from_glib(ffi::gst_video_info_get_type()) }
2017-08-11 09:29:23 +00:00
}
}
2021-04-20 07:19:02 +00:00
impl glib::value::ValueType for VideoInfo {
type Type = Self;
}
2017-08-11 09:29:23 +00:00
#[doc(hidden)]
2021-04-20 07:19:02 +00:00
unsafe impl<'a> glib::value::FromValue<'a> for VideoInfo {
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::GstVideoInfo
)
2017-08-11 09:29:23 +00:00
}
}
#[doc(hidden)]
2021-04-20 07:19:02 +00:00
impl glib::value::ToValue for VideoInfo {
fn to_value(&self) -> glib::Value {
let mut value = glib::Value::for_value_type::<Self>();
2021-04-20 07:19:02 +00:00
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()
2017-08-11 09:29:23 +00:00
}
}
#[doc(hidden)]
2021-04-20 07:19:02 +00:00
impl glib::value::ToValueOptional for VideoInfo {
fn to_value_optional(s: Option<&Self>) -> glib::Value {
skip_assert_initialized!();
let mut value = glib::Value::for_value_type::<Self>();
2021-04-20 07:19:02 +00:00
unsafe {
glib::gobject_ffi::g_value_set_boxed(
value.to_glib_none_mut().0,
s.to_glib_none().0 as *mut _,
)
}
value
2017-08-11 09:29:23 +00:00
}
}
#[doc(hidden)]
impl glib::translate::Uninitialized for VideoInfo {
unsafe fn uninitialized() -> Self {
mem::zeroed()
}
}
#[doc(hidden)]
impl glib::translate::GlibPtrDefault for VideoInfo {
type GlibType = *mut ffi::GstVideoInfo;
2017-08-11 09:29:23 +00:00
}
#[doc(hidden)]
impl<'a> glib::translate::ToGlibPtr<'a, *const ffi::GstVideoInfo> for VideoInfo {
type Storage = &'a Self;
2017-08-11 09:29:23 +00:00
fn to_glib_none(&'a self) -> glib::translate::Stash<'a, *const ffi::GstVideoInfo, Self> {
2017-08-11 09:29:23 +00:00
glib::translate::Stash(&self.0, self)
}
fn to_glib_full(&self) -> *const ffi::GstVideoInfo {
2017-08-11 09:29:23 +00:00
unimplemented!()
}
}
#[doc(hidden)]
impl glib::translate::FromGlibPtrNone<*mut ffi::GstVideoInfo> for VideoInfo {
2017-08-11 09:29:23 +00:00
#[inline]
unsafe fn from_glib_none(ptr: *mut ffi::GstVideoInfo) -> Self {
Self(ptr::read(ptr))
2017-08-11 09:29:23 +00:00
}
}
#[doc(hidden)]
impl glib::translate::FromGlibPtrFull<*mut ffi::GstVideoInfo> for VideoInfo {
2017-08-11 09:29:23 +00:00
#[inline]
unsafe fn from_glib_full(ptr: *mut ffi::GstVideoInfo) -> Self {
2017-08-11 09:29:23 +00:00
let info = from_glib_none(ptr);
glib::ffi::g_free(ptr as *mut _);
2017-08-11 09:29:23 +00:00
info
}
}
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
impl crate::VideoFieldOrder {
#[doc(alias = "gst_video_field_order_to_string")]
pub fn to_str<'a>(self) -> &'a str {
2020-11-24 09:11:35 +00:00
use std::ffi::CStr;
if self == Self::Unknown {
return "UNKNOWN";
}
2019-03-19 07:58:20 +00:00
unsafe {
CStr::from_ptr(
ffi::gst_video_field_order_to_string(self.into_glib())
.as_ref()
.expect("gst_video_field_order_to_string returned NULL"),
)
.to_str()
.expect("gst_video_field_order_to_string returned an invalid string")
2019-03-19 07:58:20 +00:00
}
2017-08-11 11:55:31 +00:00
}
}
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
impl str::FromStr for crate::VideoFieldOrder {
type Err = glib::error::BoolError;
2017-08-11 11:55:31 +00:00
2020-11-28 11:34:36 +00:00
fn from_str(s: &str) -> Result<Self, Self::Err> {
skip_assert_initialized!();
let fmt = Self::from_string(s);
if fmt == Self::Unknown {
Err(glib::bool_error!(
"Failed to parse video field order from string"
))
} else {
Ok(fmt)
}
2017-08-11 11:55:31 +00:00
}
}
impl str::FromStr for crate::VideoInterlaceMode {
type Err = glib::error::BoolError;
2017-08-11 11:55:31 +00:00
2020-11-28 11:34:36 +00:00
fn from_str(s: &str) -> Result<Self, Self::Err> {
skip_assert_initialized!();
let fmt = Self::from_string(s);
Ok(fmt)
2017-08-11 11:55:31 +00:00
}
}
2017-08-11 09:29:23 +00:00
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_new() {
gst::init().unwrap();
let info = VideoInfo::builder(crate::VideoFormat::I420, 320, 240)
2017-08-11 09:29:23 +00:00
.build()
.unwrap();
assert_eq!(info.format(), crate::VideoFormat::I420);
2017-08-11 09:29:23 +00:00
assert_eq!(info.width(), 320);
assert_eq!(info.height(), 240);
assert_eq!(info.size(), 320 * 240 + 2 * 160 * 120);
assert_eq!(info.multiview_mode(), crate::VideoMultiviewMode::None);
2017-08-11 09:29:23 +00:00
assert_eq!(&info.offset(), &[0, 320 * 240, 320 * 240 + 160 * 120]);
assert_eq!(&info.stride(), &[320, 160, 160]);
let offsets = [0, 640 * 240 + 16, 640 * 240 + 16 + 320 * 120 + 16];
let strides = [640, 320, 320];
let info = VideoInfo::builder(crate::VideoFormat::I420, 320, 240)
2017-08-11 09:29:23 +00:00
.offset(&offsets)
.stride(&strides)
.size(640 * 240 + 16 + 320 * 120 + 16 + 320 * 120 + 16)
.multiview_mode(crate::VideoMultiviewMode::SideBySide)
2017-08-11 09:29:23 +00:00
.build()
.unwrap();
assert_eq!(info.format(), crate::VideoFormat::I420);
2017-08-11 09:29:23 +00:00
assert_eq!(info.width(), 320);
assert_eq!(info.height(), 240);
assert_eq!(
info.size(),
640 * 240 + 16 + 320 * 120 + 16 + 320 * 120 + 16
);
assert_eq!(info.multiview_mode(), crate::VideoMultiviewMode::SideBySide);
2017-08-11 09:29:23 +00:00
assert_eq!(
&info.offset(),
&[0, 640 * 240 + 16, 640 * 240 + 16 + 320 * 120 + 16]
);
assert_eq!(&info.stride(), &[640, 320, 320]);
}
#[test]
fn test_from_to_caps() {
gst::init().unwrap();
let caps = gst::Caps::builder("video/x-raw")
.field("format", "I420")
.field("width", 320)
.field("height", 240)
.field("framerate", gst::Fraction::new(30, 1))
.field("pixel-aspect-ratio", gst::Fraction::new(1, 1))
.field("interlace-mode", "progressive")
.field("chroma-site", "mpeg2")
.field("colorimetry", "bt709")
.build();
2017-08-11 09:29:23 +00:00
let info = VideoInfo::from_caps(&caps).unwrap();
assert_eq!(info.format(), crate::VideoFormat::I420);
2017-08-11 09:29:23 +00:00
assert_eq!(info.width(), 320);
assert_eq!(info.height(), 240);
assert_eq!(info.fps(), gst::Fraction::new(30, 1));
assert_eq!(
info.interlace_mode(),
crate::VideoInterlaceMode::Progressive
);
assert_eq!(info.chroma_site(), crate::VideoChromaSite::MPEG2);
2017-08-11 09:29:23 +00:00
assert_eq!(info.colorimetry(), "bt709".parse().unwrap());
let caps2 = info.to_caps().unwrap();
assert_eq!(caps, caps2);
let info2 = VideoInfo::from_caps(&caps2).unwrap();
assert!(info == info2);
}
2019-06-17 11:24:11 +00:00
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
2019-06-17 11:24:11 +00:00
#[test]
fn test_video_align() {
gst::init().unwrap();
let mut info = crate::VideoInfo::builder(crate::VideoFormat::Nv16, 1920, 1080)
2019-06-17 11:24:11 +00:00
.build()
.expect("Failed to create VideoInfo");
assert_eq!(info.stride(), [1920, 1920]);
assert_eq!(info.offset(), [0, 2_073_600]);
2019-06-17 11:24:11 +00:00
let mut align = crate::VideoAlignment::new(0, 0, 0, 8, &[0; VIDEO_MAX_PLANES]);
info.align(&mut align).unwrap();
2019-06-17 11:24:11 +00:00
assert_eq!(info.stride(), [1928, 1928]);
assert_eq!(info.offset(), [0, 2_082_240]);
2020-12-03 10:56:23 +00:00
#[cfg(feature = "v1_18")]
{
let mut info = crate::VideoInfo::builder(crate::VideoFormat::Nv16, 1920, 1080)
.build()
.expect("Failed to create VideoInfo");
let mut align = crate::VideoAlignment::new(0, 0, 0, 8, &[0; VIDEO_MAX_PLANES]);
let plane_size = info.align_full(&mut align).unwrap();
assert_eq!(plane_size, [2082240, 2082240, 0, 0]);
}
2019-06-17 11:24:11 +00:00
}
#[cfg(any(feature = "v1_12", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
#[test]
fn test_display() {
gst::init().unwrap();
format!("{}", "sRGB".parse::<crate::VideoColorimetry>().unwrap());
format!("{}", crate::VideoFieldOrder::TopFieldFirst);
format!("{}", crate::VideoInterlaceMode::Progressive);
}
2017-08-11 09:29:23 +00:00
}