GI.GstVideo.Structs.VideoInfo

Information describing image properties. This information can be filled in from GstCaps with videoInfoFromCaps. The information is also used to store the specific video info when mapping a video frame with videoFrameMap.

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

Exported types

newtype VideoInfo

Constructors

VideoInfo (ManagedPtr VideoInfo)

Instances

BoxedObject VideoInfo

Methods

boxedType :: VideoInfo -> IO GType

(~) AttrOpTag tag AttrSet => Constructible VideoInfo tag

Methods

new :: MonadIO m => (ManagedPtr VideoInfo -> VideoInfo) -> [AttrOp VideoInfo tag] -> m VideoInfo

newZeroVideoInfo :: MonadIO m => m VideoInfo

Construct a VideoInfo struct initialized to zero.

noVideoInfo :: Maybe VideoInfo

Methods

align

videoInfoAlign

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> VideoAlignment

align: alignment parameters

-> m Bool

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)

Adjust the offset and stride fields in info 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.

convert

videoInfoConvert

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> Format

srcFormat: Format of the srcValue

-> Int64

srcValue: value to convert

-> Format

destFormat: Format of the destValue

-> Int64

destValue: pointer to destination value

-> m Bool

Returns: TRUE if the conversion was successful.

Converts among various 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.

copy

videoInfoCopy

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> m VideoInfo

Returns: a new VideoInfo. free with gst_video_info_free.

Copy a GstVideoInfo structure.

Since: 1.6

free

videoInfoFree

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> m ()

Free a GstVideoInfo structure previously allocated with videoInfoNew or videoInfoCopy.

Since: 1.6

fromCaps

videoInfoFromCaps

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> Caps

caps: a Caps

-> m Bool

Returns: TRUE if caps could be parsed

Parse caps and update info.

init

videoInfoInit

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> m ()

Initialize info with default values.

isEqual

videoInfoIsEqual

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> VideoInfo

other: a VideoInfo

-> m Bool

Returns: True if info and other are equal, else False.

Compares two VideoInfo and returns whether they are equal or not

new

videoInfoNew

Arguments

:: (HasCallStack, MonadIO m)

=> m VideoInfo

Returns: a new VideoInfo. free with videoInfoFree.

Allocate a new VideoInfo that is also initialized with videoInfoInit.

Since: 1.6

setFormat

videoInfoSetFormat

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> VideoFormat

format: the format

-> Word32

width: a width

-> Word32

height: a height

-> m Bool

Returns: False if the returned video info is invalid, e.g. because the size of a frame can't be represented as a 32 bit integer (Since: 1.12)

Set the default info for a video frame of format and width and height.

Note: This initializes info first, no values are preserved. This function does not set the offsets correctly for interlaced vertically subsampled formats.

toCaps

videoInfoToCaps

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> m Caps

Returns: a new Caps containing the info of info.

Convert the values of info into a Caps.

Properties

chromaSite

getVideoInfoChromaSite :: MonadIO m => VideoInfo -> m [VideoChromaSite]

setVideoInfoChromaSite :: MonadIO m => VideoInfo -> [VideoChromaSite] -> m ()

colorimetry

getVideoInfoColorimetry :: MonadIO m => VideoInfo -> m VideoColorimetry

finfo

clearVideoInfoFinfo :: MonadIO m => VideoInfo -> m ()

getVideoInfoFinfo :: MonadIO m => VideoInfo -> m (Maybe VideoFormatInfo)

setVideoInfoFinfo :: MonadIO m => VideoInfo -> Ptr VideoFormatInfo -> m ()

flags

getVideoInfoFlags :: MonadIO m => VideoInfo -> m [VideoFlags]

setVideoInfoFlags :: MonadIO m => VideoInfo -> [VideoFlags] -> m ()

fpsD

getVideoInfoFpsD :: MonadIO m => VideoInfo -> m Int32

setVideoInfoFpsD :: MonadIO m => VideoInfo -> Int32 -> m ()

fpsN

getVideoInfoFpsN :: MonadIO m => VideoInfo -> m Int32

setVideoInfoFpsN :: MonadIO m => VideoInfo -> Int32 -> m ()

height

getVideoInfoHeight :: MonadIO m => VideoInfo -> m Int32

setVideoInfoHeight :: MonadIO m => VideoInfo -> Int32 -> m ()

interlaceMode

getVideoInfoInterlaceMode :: MonadIO m => VideoInfo -> m VideoInterlaceMode

setVideoInfoInterlaceMode :: MonadIO m => VideoInfo -> VideoInterlaceMode -> m ()

parD

getVideoInfoParD :: MonadIO m => VideoInfo -> m Int32

setVideoInfoParD :: MonadIO m => VideoInfo -> Int32 -> m ()

parN

getVideoInfoParN :: MonadIO m => VideoInfo -> m Int32

setVideoInfoParN :: MonadIO m => VideoInfo -> Int32 -> m ()

size

getVideoInfoSize :: MonadIO m => VideoInfo -> m Word64

setVideoInfoSize :: MonadIO m => VideoInfo -> Word64 -> m ()

views

getVideoInfoViews :: MonadIO m => VideoInfo -> m Int32

setVideoInfoViews :: MonadIO m => VideoInfo -> Int32 -> m ()

width

getVideoInfoWidth :: MonadIO m => VideoInfo -> m Int32

setVideoInfoWidth :: MonadIO m => VideoInfo -> Int32 -> m ()