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

((~) * info (ResolveVideoInfoMethod t VideoInfo), MethodInfo * info VideoInfo p) => IsLabel t (VideoInfo -> p)

Methods

fromLabel :: Proxy# Symbol t -> VideoInfo -> p

((~) * info (ResolveVideoInfoMethod t VideoInfo), MethodInfo * info VideoInfo p) => IsLabelProxy t (VideoInfo -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> VideoInfo -> p

HasAttributeList * VideoInfo

((~) * signature (m Caps), MonadIO m) => MethodInfo * VideoInfoToCapsMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoToCapsMethodInfo VideoInfo -> signature -> s

((~) * signature (VideoFormat -> Word32 -> Word32 -> m ()), MonadIO m) => MethodInfo * VideoInfoSetFormatMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoSetFormatMethodInfo VideoInfo -> signature -> s

((~) * signature (VideoInfo -> m Bool), MonadIO m) => MethodInfo * VideoInfoIsEqualMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoIsEqualMethodInfo VideoInfo -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoInfoInitMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoInitMethodInfo VideoInfo -> signature -> s

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * VideoInfoFromCapsMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoFromCapsMethodInfo VideoInfo -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoInfoFreeMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoFreeMethodInfo VideoInfo -> signature -> s

((~) * signature (m VideoInfo), MonadIO m) => MethodInfo * VideoInfoCopyMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoCopyMethodInfo VideoInfo -> signature -> s

((~) * signature (Format -> Int64 -> Format -> Int64 -> m Bool), MonadIO m) => MethodInfo * VideoInfoConvertMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoConvertMethodInfo VideoInfo -> signature -> s

((~) * signature (VideoAlignment -> m ()), MonadIO m) => MethodInfo * VideoInfoAlignMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoAlignMethodInfo VideoInfo -> signature -> s

type AttributeList VideoInfo

type AttributeList VideoInfo

newZeroVideoInfo :: MonadIO m => m VideoInfo

Construct a VideoInfo struct initialized to zero.

noVideoInfo :: Maybe VideoInfo

Methods

align

data VideoInfoAlignMethodInfo

Instances

((~) * signature (VideoAlignment -> m ()), MonadIO m) => MethodInfo * VideoInfoAlignMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoAlignMethodInfo VideoInfo -> signature -> s

videoInfoAlign

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> VideoAlignment

align: alignment parameters

-> m ()

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

data VideoInfoConvertMethodInfo

Instances

((~) * signature (Format -> Int64 -> Format -> Int64 -> m Bool), MonadIO m) => MethodInfo * VideoInfoConvertMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoConvertMethodInfo VideoInfo -> signature -> s

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

data VideoInfoCopyMethodInfo

Instances

((~) * signature (m VideoInfo), MonadIO m) => MethodInfo * VideoInfoCopyMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoCopyMethodInfo VideoInfo -> signature -> s

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

data VideoInfoFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoInfoFreeMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoFreeMethodInfo VideoInfo -> signature -> s

videoInfoFree

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> m ()

Free a GstVideoInfo structure previously allocated with videoInfoNew or videoInfoCopy.

Since: 1.6

fromCaps

data VideoInfoFromCapsMethodInfo

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * VideoInfoFromCapsMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoFromCapsMethodInfo VideoInfo -> signature -> s

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

data VideoInfoInitMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * VideoInfoInitMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoInitMethodInfo VideoInfo -> signature -> s

videoInfoInit

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> m ()

Initialize info with default values.

isEqual

data VideoInfoIsEqualMethodInfo

Instances

((~) * signature (VideoInfo -> m Bool), MonadIO m) => MethodInfo * VideoInfoIsEqualMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoIsEqualMethodInfo VideoInfo -> signature -> s

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

data VideoInfoSetFormatMethodInfo

Instances

((~) * signature (VideoFormat -> Word32 -> Word32 -> m ()), MonadIO m) => MethodInfo * VideoInfoSetFormatMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoSetFormatMethodInfo VideoInfo -> signature -> s

videoInfoSetFormat

Arguments

:: (HasCallStack, MonadIO m)

=> VideoInfo

info: a VideoInfo

-> VideoFormat

format: the format

-> Word32

width: a width

-> Word32

height: a height

-> m ()

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

data VideoInfoToCapsMethodInfo

Instances

((~) * signature (m Caps), MonadIO m) => MethodInfo * VideoInfoToCapsMethodInfo VideoInfo signature

Methods

overloadedMethod :: MethodProxy VideoInfoToCapsMethodInfo VideoInfo -> signature -> s

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 ()

videoInfo_chromaSite :: AttrLabelProxy "chromaSite"

colorimetry

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

videoInfo_colorimetry :: AttrLabelProxy "colorimetry"

finfo

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

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

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

videoInfo_finfo :: AttrLabelProxy "finfo"

flags

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

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

videoInfo_flags :: AttrLabelProxy "flags"

fpsD

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

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

videoInfo_fpsD :: AttrLabelProxy "fpsD"

fpsN

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

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

videoInfo_fpsN :: AttrLabelProxy "fpsN"

height

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

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

videoInfo_height :: AttrLabelProxy "height"

interlaceMode

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

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

videoInfo_interlaceMode :: AttrLabelProxy "interlaceMode"

parD

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

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

videoInfo_parD :: AttrLabelProxy "parD"

parN

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

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

videoInfo_parN :: AttrLabelProxy "parN"

size

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

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

videoInfo_size :: AttrLabelProxy "size"

views

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

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

videoInfo_views :: AttrLabelProxy "views"

width

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

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

videoInfo_width :: AttrLabelProxy "width"