Struct gstreamer_video::VideoInfo

pub struct VideoInfo(_);

Information describing image properties. This information can be filled in from GstCaps with Self::from_caps(). The information is also used to store the specific video info when mapping a video frame with [crate::VideoFrame::map()].

Use the provided macros to access the info in this structure.

Implementations

impl VideoInfo

pub fn builder<'a>(
    format: VideoFormat,
    width: u32,
    height: u32
) -> VideoInfoBuilder<'a>

pub fn is_valid(&self) -> bool

pub fn from_caps(caps: &CapsRef) -> Result<Self, BoolError>

Parse caps and update self.

caps

a crate::gst::Caps

Returns

TRUE if caps could be parsed

pub fn to_caps(&self) -> Result<Caps, BoolError>

Convert the values of self into a crate::gst::Caps.

Returns

a new crate::gst::Caps containing the info of self.

pub fn format(&self) -> VideoFormat

pub fn format_info(&self) -> VideoFormatInfo

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn field_height(&self) -> u32

This is supported on crate feature v1_16 only.

pub fn interlace_mode(&self) -> VideoInterlaceMode

pub fn flags(&self) -> VideoFlags

pub fn size(&self) -> usize

pub fn views(&self) -> u32

pub fn chroma_site(&self) -> VideoChromaSite

pub fn colorimetry(&self) -> VideoColorimetry

pub fn par(&self) -> Fraction

pub fn fps(&self) -> Fraction

pub fn offset(&self) -> &[usize]

pub fn stride(&self) -> &[i32]

pub fn multiview_mode(&self) -> VideoMultiviewMode

pub fn multiview_flags(&self) -> VideoMultiviewFlags

pub fn field_order(&self) -> VideoFieldOrder

This is supported on crate feature v1_12 only.

pub fn has_alpha(&self) -> bool

pub fn is_gray(&self) -> bool

pub fn is_rgb(&self) -> bool

pub fn is_yuv(&self) -> bool

pub fn is_interlaced(&self) -> bool

pub fn n_planes(&self) -> u32

pub fn n_components(&self) -> u32

pub fn convert<V: Into<GenericFormattedValue>, U: SpecificFormattedValue>(
    &self,
    src_val: V
) -> Option<U>

Converts among various crate::gst::Format types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw video, GST_FORMAT_DEFAULT corresponds to video frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT.

src_format

crate::gst::Format of the src_value

src_value

value to convert

dest_format

crate::gst::Format of the dest_value

dest_value

pointer to destination value

Returns

TRUE if the conversion was successful.

pub fn convert_generic<V: Into<GenericFormattedValue>>(
    &self,
    src_val: V,
    dest_fmt: Format
) -> Option<GenericFormattedValue>

pub fn align(&mut self, align: &mut VideoAlignment) -> Result<(), BoolError>

Adjust the offset and stride fields in self so that the padding and stride alignment in align is respected.

Extra padding will be added to the right side when stride alignment padding is required and align will be updated with the new padding values.

align

alignment parameters

Returns

false if alignment could not be applied, e.g. because the size of a frame can’t be represented as a 32 bit integer (Since: 1.12)

pub fn align_full(
    &mut self,
    align: &mut VideoAlignment
) -> Result<[usize; 4], BoolError>

This is supported on crate feature v1_18 only.

This variant of Self::align() provides the updated size, in bytes, of each video plane after the alignment, including all horizontal and vertical paddings.

In case of GST_VIDEO_INTERLACE_MODE_ALTERNATE info, the returned sizes are the ones used to hold a single field, not the full frame.

align

alignment parameters

plane_size

array used to store the plane sizes

Returns

false if alignment could not be applied, e.g. because the size of a frame can’t be represented as a 32 bit integer

pub fn range_offsets(&self, range: VideoColorRange) -> ([i32; 4], [i32; 4])

Trait Implementations

impl Clone for VideoInfo

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VideoInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<VideoInfo> for VideoInfo

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StaticType for VideoInfo

fn static_type() -> Type

Returns the type identifier of Self.

impl ValueType for VideoInfo

type Type = Self

Type to get the Type from.

impl Eq for VideoInfo

impl Send for VideoInfo

impl Sync for VideoInfo