GstVideoFormatInfo

Information for a video format.

Members

name (const gchar *) –

string representation of the format

description (const gchar *) –

use readable description of the format

bits (guint) –

The number of bits used to pack data items. This can be less than 8 when multiple pixels are stored in a byte. for values > 8 multiple bytes should be read according to the endianness flag before applying the shift and mask.

n_components (guint) –

the number of components in the video format.

shift (guint *) –

the number of bits to shift away to get the component data

depth (guint *) –

the depth in bits for each component

pixel_stride (gint *) –

the pixel stride of each component. This is the amount of bytes to the pixel immediately to the right. When bits < 8, the stride is expressed in bits. For 24-bit RGB, this would be 3 bytes, for example, while it would be 4 bytes for RGBx or ARGB.

n_planes (guint) –

the number of planes for this format. The number of planes can be less than the amount of components when multiple components are packed into one plane.

plane (guint *) –

the plane number where a component can be found

poffset (guint *) –

the offset in the plane where the first pixel of the components can be found.

w_sub (guint *) –

subsampling factor of the width for the component. Use GST_VIDEO_SUB_SCALE to scale a width.

h_sub (guint *) –

subsampling factor of the height for the component. Use GST_VIDEO_SUB_SCALE to scale a height.

unpack_format (GstVideoFormat) –

the format of the unpacked pixels. This format must have the GST_VIDEO_FORMAT_FLAG_UNPACK flag set.

pack_lines (gint) –

the amount of lines that will be packed

tile_mode (GstVideoTileMode) –

The tiling mode

tile_ws (guint) –

The width of a tile, in bytes, represented as a shift

tile_hs (guint) –

The height of a tile, in bytes, represented as a shift


GstVideoFormatInfo

Information for a video format.

Members

name (String) –

string representation of the format

description (String) –

use readable description of the format

bits (Number) –

The number of bits used to pack data items. This can be less than 8 when multiple pixels are stored in a byte. for values > 8 multiple bytes should be read according to the endianness flag before applying the shift and mask.

n_components (Number) –

the number of components in the video format.

shift ([ Number ]) –

the number of bits to shift away to get the component data

depth ([ Number ]) –

the depth in bits for each component

pixel_stride ([ Number ]) –

the pixel stride of each component. This is the amount of bytes to the pixel immediately to the right. When bits < 8, the stride is expressed in bits. For 24-bit RGB, this would be 3 bytes, for example, while it would be 4 bytes for RGBx or ARGB.

n_planes (Number) –

the number of planes for this format. The number of planes can be less than the amount of components when multiple components are packed into one plane.

plane ([ Number ]) –

the plane number where a component can be found

poffset ([ Number ]) –

the offset in the plane where the first pixel of the components can be found.

w_sub ([ Number ]) –

subsampling factor of the width for the component. Use GST_VIDEO_SUB_SCALE to scale a width.

h_sub ([ Number ]) –

subsampling factor of the height for the component. Use GST_VIDEO_SUB_SCALE to scale a height.

unpack_format (GstVideoFormat) –

the format of the unpacked pixels. This format must have the GST_VIDEO_FORMAT_FLAG_UNPACK flag set.

pack_lines (Number) –

the amount of lines that will be packed

tile_mode (GstVideoTileMode) –

The tiling mode

tile_ws (Number) –

The width of a tile, in bytes, represented as a shift

tile_hs (Number) –

The height of a tile, in bytes, represented as a shift


GstVideoFormatInfo

Information for a video format.

Members

name (str) –

string representation of the format

description (str) –

use readable description of the format

bits (int) –

The number of bits used to pack data items. This can be less than 8 when multiple pixels are stored in a byte. for values > 8 multiple bytes should be read according to the endianness flag before applying the shift and mask.

n_components (int) –

the number of components in the video format.

shift ([ int ]) –

the number of bits to shift away to get the component data

depth ([ int ]) –

the depth in bits for each component

pixel_stride ([ int ]) –

the pixel stride of each component. This is the amount of bytes to the pixel immediately to the right. When bits < 8, the stride is expressed in bits. For 24-bit RGB, this would be 3 bytes, for example, while it would be 4 bytes for RGBx or ARGB.

n_planes (int) –

the number of planes for this format. The number of planes can be less than the amount of components when multiple components are packed into one plane.

plane ([ int ]) –

the plane number where a component can be found

poffset ([ int ]) –

the offset in the plane where the first pixel of the components can be found.

w_sub ([ int ]) –

subsampling factor of the width for the component. Use GST_VIDEO_SUB_SCALE to scale a width.

h_sub ([ int ]) –

subsampling factor of the height for the component. Use GST_VIDEO_SUB_SCALE to scale a height.

unpack_format (GstVideoFormat) –

the format of the unpacked pixels. This format must have the GST_VIDEO_FORMAT_FLAG_UNPACK flag set.

pack_lines (int) –

the amount of lines that will be packed

tile_mode (GstVideoTileMode) –

The tiling mode

tile_ws (int) –

The width of a tile, in bytes, represented as a shift

tile_hs (int) –

The height of a tile, in bytes, represented as a shift


Methods

gst_video_format_info_component

gst_video_format_info_component (const GstVideoFormatInfo * info,
                                 guint plane,
                                 gint * components)

Fill components with the number of all the components packed in plane p for the format info. A value of -1 in components indicates that no more components are packed in the plane.

Parameters:

plane

a plane number

components ( [out] ) –

array used to store component numbers

Since : 1.18


GstVideo.VideoFormatInfo.prototype.component

function GstVideo.VideoFormatInfo.prototype.component(plane: Number): {
    // javascript wrapper for 'gst_video_format_info_component'
}

Fill components with the number of all the components packed in plane p for the format info. A value of -1 in components indicates that no more components are packed in the plane.

Parameters:

plane ( Number ) –

a plane number

Since : 1.18


GstVideo.VideoFormatInfo.component

def GstVideo.VideoFormatInfo.component (self, plane):
    #python wrapper for 'gst_video_format_info_component'

Fill components with the number of all the components packed in plane p for the format info. A value of -1 in components indicates that no more components are packed in the plane.

Parameters:

plane ( int ) –

a plane number

Since : 1.18


Functions

gst_video_format_from_fourcc

GstVideoFormat
gst_video_format_from_fourcc (guint32 fourcc)

Converts a FOURCC value into the corresponding GstVideoFormat. If the FOURCC cannot be represented by GstVideoFormat, GST_VIDEO_FORMAT_UNKNOWN is returned.

Parameters:

fourcc

a FOURCC value representing raw YUV video

Returns

the GstVideoFormat describing the FOURCC value


GstVideo.VideoFormat.prototype.from_fourcc

function GstVideo.VideoFormat.prototype.from_fourcc(fourcc: Number): {
    // javascript wrapper for 'gst_video_format_from_fourcc'
}

Converts a FOURCC value into the corresponding GstVideo.VideoFormat. If the FOURCC cannot be represented by GstVideo.VideoFormat, GstVideo.VideoFormat.UNKNOWN is returned.

Parameters:

fourcc ( Number ) –

a FOURCC value representing raw YUV video

Returns ( GstVideo.VideoFormat ) –

the GstVideo.VideoFormat describing the FOURCC value


GstVideo.VideoFormat.from_fourcc

def GstVideo.VideoFormat.from_fourcc (fourcc):
    #python wrapper for 'gst_video_format_from_fourcc'

Converts a FOURCC value into the corresponding GstVideo.VideoFormat. If the FOURCC cannot be represented by GstVideo.VideoFormat, GstVideo.VideoFormat.UNKNOWN is returned.

Parameters:

fourcc ( int ) –

a FOURCC value representing raw YUV video

Returns ( GstVideo.VideoFormat ) –

the GstVideo.VideoFormat describing the FOURCC value


gst_video_format_from_masks

GstVideoFormat
gst_video_format_from_masks (gint depth,
                             gint bpp,
                             gint endianness,
                             guint red_mask,
                             guint green_mask,
                             guint blue_mask,
                             guint alpha_mask)

Find the GstVideoFormat for the given parameters.

Parameters:

depth

the amount of bits used for a pixel

bpp

the amount of bits used to store a pixel. This value is bigger than depth

endianness

the endianness of the masks, G_LITTLE_ENDIAN or G_BIG_ENDIAN

red_mask

the red mask

green_mask

the green mask

blue_mask

the blue mask

alpha_mask

the alpha mask, or 0 if no alpha mask

Returns

a GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to not specify a known format.


GstVideo.VideoFormat.prototype.from_masks

function GstVideo.VideoFormat.prototype.from_masks(depth: Number, bpp: Number, endianness: Number, red_mask: Number, green_mask: Number, blue_mask: Number, alpha_mask: Number): {
    // javascript wrapper for 'gst_video_format_from_masks'
}

Find the GstVideo.VideoFormat for the given parameters.

Parameters:

depth ( Number ) –

the amount of bits used for a pixel

bpp ( Number ) –

the amount of bits used to store a pixel. This value is bigger than depth

endianness ( Number ) –

the endianness of the masks, GLib.LITTLE_ENDIAN or GLib.BIG_ENDIAN

red_mask ( Number ) –

the red mask

green_mask ( Number ) –

the green mask

blue_mask ( Number ) –

the blue mask

alpha_mask ( Number ) –

the alpha mask, or 0 if no alpha mask

Returns ( GstVideo.VideoFormat ) –

a GstVideo.VideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to not specify a known format.


GstVideo.VideoFormat.from_masks

def GstVideo.VideoFormat.from_masks (depth, bpp, endianness, red_mask, green_mask, blue_mask, alpha_mask):
    #python wrapper for 'gst_video_format_from_masks'

Find the GstVideo.VideoFormat for the given parameters.

Parameters:

depth ( int ) –

the amount of bits used for a pixel

bpp ( int ) –

the amount of bits used to store a pixel. This value is bigger than depth

endianness ( int ) –

the endianness of the masks, GLib.LITTLE_ENDIAN or GLib.BIG_ENDIAN

red_mask ( int ) –

the red mask

green_mask ( int ) –

the green mask

blue_mask ( int ) –

the blue mask

alpha_mask ( int ) –

the alpha mask, or 0 if no alpha mask

Returns ( GstVideo.VideoFormat ) –

a GstVideo.VideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to not specify a known format.


gst_video_format_from_string

GstVideoFormat
gst_video_format_from_string (const gchar * format)

Convert the format string to its GstVideoFormat.

Parameters:

format

a format string

Returns

the GstVideoFormat for format or GST_VIDEO_FORMAT_UNKNOWN when the string is not a known format.


GstVideo.VideoFormat.prototype.from_string

function GstVideo.VideoFormat.prototype.from_string(format: String): {
    // javascript wrapper for 'gst_video_format_from_string'
}

Convert the format string to its GstVideo.VideoFormat.

Parameters:

format ( String ) –

a format string

Returns ( GstVideo.VideoFormat ) –

the GstVideo.VideoFormat for format or GST_VIDEO_FORMAT_UNKNOWN when the string is not a known format.


GstVideo.VideoFormat.from_string

def GstVideo.VideoFormat.from_string (format):
    #python wrapper for 'gst_video_format_from_string'

Convert the format string to its GstVideo.VideoFormat.

Parameters:

format ( str ) –

a format string

Returns ( GstVideo.VideoFormat ) –

the GstVideo.VideoFormat for format or GST_VIDEO_FORMAT_UNKNOWN when the string is not a known format.


gst_video_format_get_info

const GstVideoFormatInfo *
gst_video_format_get_info (GstVideoFormat format)

Get the GstVideoFormatInfo for format

Parameters:

format

a GstVideoFormat

Returns

The GstVideoFormatInfo for format.


GstVideo.VideoFormat.prototype.get_info

function GstVideo.VideoFormat.prototype.get_info(format: GstVideo.VideoFormat): {
    // javascript wrapper for 'gst_video_format_get_info'
}

Get the GstVideo.VideoFormatInfo for format

Parameters:

Returns ( GstVideo.VideoFormatInfo ) –

The GstVideo.VideoFormatInfo for format.


GstVideo.VideoFormat.get_info

def GstVideo.VideoFormat.get_info (format):
    #python wrapper for 'gst_video_format_get_info'

Get the GstVideo.VideoFormatInfo for format

Parameters:

Returns ( GstVideo.VideoFormatInfo ) –

The GstVideo.VideoFormatInfo for format.


gst_video_format_get_palette

gconstpointer
gst_video_format_get_palette (GstVideoFormat format,
                              gsize * size)

Get the default palette of format. This the palette used in the pack function for paletted formats.

Parameters:

format

a GstVideoFormat

size ( [out] ) –

size of the palette in bytes

Returns ( [transfer: none] ) –

the default palette of format or NULL when format does not have a palette.

Since : 1.2


GstVideo.VideoFormat.prototype.get_palette

function GstVideo.VideoFormat.prototype.get_palette(format: GstVideo.VideoFormat): {
    // javascript wrapper for 'gst_video_format_get_palette'
}

Get the default palette of format. This the palette used in the pack function for paletted formats.

Parameters:

Returns a tuple made of:

( Object ) –

the default palette of format or null when format does not have a palette.

size ( Number ) –

the default palette of format or null when format does not have a palette.

Since : 1.2


GstVideo.VideoFormat.get_palette

def GstVideo.VideoFormat.get_palette (format):
    #python wrapper for 'gst_video_format_get_palette'

Get the default palette of format. This the palette used in the pack function for paletted formats.

Parameters:

Returns a tuple made of:

( object ) –

the default palette of format or None when format does not have a palette.

size ( int ) –

the default palette of format or None when format does not have a palette.

Since : 1.2


gst_video_format_to_fourcc

guint32
gst_video_format_to_fourcc (GstVideoFormat format)

Converts a GstVideoFormat value into the corresponding FOURCC. Only a few YUV formats have corresponding FOURCC values. If format has no corresponding FOURCC value, 0 is returned.

Parameters:

format

a GstVideoFormat video format

Returns

the FOURCC corresponding to format


GstVideo.VideoFormat.prototype.to_fourcc

function GstVideo.VideoFormat.prototype.to_fourcc(format: GstVideo.VideoFormat): {
    // javascript wrapper for 'gst_video_format_to_fourcc'
}

Converts a GstVideo.VideoFormat value into the corresponding FOURCC. Only a few YUV formats have corresponding FOURCC values. If format has no corresponding FOURCC value, 0 is returned.

Parameters:

format ( GstVideo.VideoFormat ) –

a GstVideo.VideoFormat video format

Returns ( Number ) –

the FOURCC corresponding to format


GstVideo.VideoFormat.to_fourcc

def GstVideo.VideoFormat.to_fourcc (format):
    #python wrapper for 'gst_video_format_to_fourcc'

Converts a GstVideo.VideoFormat value into the corresponding FOURCC. Only a few YUV formats have corresponding FOURCC values. If format has no corresponding FOURCC value, 0 is returned.

Parameters:

format ( GstVideo.VideoFormat ) –

a GstVideo.VideoFormat video format

Returns ( int ) –

the FOURCC corresponding to format


gst_video_format_to_string

const gchar *
gst_video_format_to_string (GstVideoFormat format)

Returns a string containing a descriptive name for the GstVideoFormat if there is one, or NULL otherwise.

Parameters:

format

a GstVideoFormat video format

Returns

the name corresponding to format


GstVideo.VideoFormat.prototype.to_string

function GstVideo.VideoFormat.prototype.to_string(format: GstVideo.VideoFormat): {
    // javascript wrapper for 'gst_video_format_to_string'
}

Returns a string containing a descriptive name for the GstVideo.VideoFormat if there is one, or NULL otherwise.

Parameters:

format ( GstVideo.VideoFormat ) –

a GstVideo.VideoFormat video format

Returns ( String ) –

the name corresponding to format


GstVideo.VideoFormat.to_string

def GstVideo.VideoFormat.to_string (format):
    #python wrapper for 'gst_video_format_to_string'

Returns a string containing a descriptive name for the GstVideo.VideoFormat if there is one, or NULL otherwise.

Parameters:

format ( GstVideo.VideoFormat ) –

a GstVideo.VideoFormat video format

Returns ( str ) –

the name corresponding to format


gst_video_formats_raw

const GstVideoFormat *
gst_video_formats_raw (guint * len)

Return all the raw video formats supported by GStreamer.

Parameters:

len ( [out] ) –

the number of elements in the returned array

Returns ( [transfer: none] [array length=len] ) –

an array of GstVideoFormat

Since : 1.18


GstVideo.prototype.video_formats_raw

function GstVideo.prototype.video_formats_raw(): {
    // javascript wrapper for 'gst_video_formats_raw'
}

Return all the raw video formats supported by GStreamer.

Returns a tuple made of:

( [ GstVideo.VideoFormat ] ) –

an array of GstVideo.VideoFormat

len ( Number ) –

an array of GstVideo.VideoFormat

Since : 1.18


GstVideo.video_formats_raw

def GstVideo.video_formats_raw ():
    #python wrapper for 'gst_video_formats_raw'

Return all the raw video formats supported by GStreamer.

Returns a tuple made of:

( [ GstVideo.VideoFormat ] ) –

an array of GstVideo.VideoFormat

len ( int ) –

an array of GstVideo.VideoFormat

Since : 1.18


gst_video_make_raw_caps

GstCaps *
gst_video_make_raw_caps (const GstVideoFormat * formats,
                         guint len)

Return a generic raw video caps for formats defined in formats. If formats is NULL returns a caps for all the supported raw video formats, see gst_video_formats_raw.

Parameters:

formats ( [array length=len] [nullable] ) –

an array of raw GstVideoFormat, or NULL

len

the size of formats

Returns ( [transfer: full] ) –

a video GstCaps

Since : 1.18


GstVideo.prototype.video_make_raw_caps

function GstVideo.prototype.video_make_raw_caps(formats: [ GstVideo.VideoFormat ], len: Number): {
    // javascript wrapper for 'gst_video_make_raw_caps'
}

Return a generic raw video caps for formats defined in formats. If formats is null returns a caps for all the supported raw video formats, see GstVideo.prototype.video_formats_raw.

Parameters:

formats ( [ GstVideo.VideoFormat ] ) –

an array of raw GstVideo.VideoFormat, or null

len ( Number ) –

the size of formats

Returns ( Gst.Caps ) –

a video GstCaps

Since : 1.18


GstVideo.video_make_raw_caps

def GstVideo.video_make_raw_caps (formats, len):
    #python wrapper for 'gst_video_make_raw_caps'

Return a generic raw video caps for formats defined in formats. If formats is None returns a caps for all the supported raw video formats, see GstVideo.video_formats_raw.

Parameters:

formats ( [ GstVideo.VideoFormat ] ) –

an array of raw GstVideo.VideoFormat, or None

len ( int ) –

the size of formats

Returns ( Gst.Caps ) –

a video GstCaps

Since : 1.18


gst_video_make_raw_caps_with_features

GstCaps *
gst_video_make_raw_caps_with_features (const GstVideoFormat * formats,
                                       guint len,
                                       GstCapsFeatures * features)

Return a generic raw video caps for formats defined in formats with features features. If formats is NULL returns a caps for all the supported video formats, see gst_video_formats_raw.

Parameters:

formats ( [array length=len] [nullable] ) –

an array of raw GstVideoFormat, or NULL

len

the size of formats

features ( [transfer: full] [allow-none] ) –

the GstCapsFeatures to set on the caps

Returns ( [transfer: full] ) –

a video GstCaps

Since : 1.18


GstVideo.prototype.video_make_raw_caps_with_features

function GstVideo.prototype.video_make_raw_caps_with_features(formats: [ GstVideo.VideoFormat ], len: Number, features: Gst.CapsFeatures): {
    // javascript wrapper for 'gst_video_make_raw_caps_with_features'
}

Return a generic raw video caps for formats defined in formats with features features. If formats is null returns a caps for all the supported video formats, see GstVideo.prototype.video_formats_raw.

Parameters:

formats ( [ GstVideo.VideoFormat ] ) –

an array of raw GstVideo.VideoFormat, or null

len ( Number ) –

the size of formats

features ( Gst.CapsFeatures ) –

the Gst.CapsFeatures to set on the caps

Returns ( Gst.Caps ) –

a video GstCaps

Since : 1.18


GstVideo.video_make_raw_caps_with_features

def GstVideo.video_make_raw_caps_with_features (formats, len, features):
    #python wrapper for 'gst_video_make_raw_caps_with_features'

Return a generic raw video caps for formats defined in formats with features features. If formats is None returns a caps for all the supported video formats, see GstVideo.video_formats_raw.

Parameters:

formats ( [ GstVideo.VideoFormat ] ) –

an array of raw GstVideo.VideoFormat, or None

len ( int ) –

the size of formats

features ( Gst.CapsFeatures ) –

the Gst.CapsFeatures to set on the caps

Returns ( Gst.Caps ) –

a video GstCaps

Since : 1.18


Function Macros

GST_VIDEO_CAPS_MAKE

#define GST_VIDEO_CAPS_MAKE(format)                                     \
    "video/x-raw, "                                                     \
    "format = (string) " format ", "                                    \
    "width = " GST_VIDEO_SIZE_RANGE ", "                                \
    "height = " GST_VIDEO_SIZE_RANGE ", "                               \
    "framerate = " GST_VIDEO_FPS_RANGE

Generic caps string for video, for use in pad templates.

Parameters:

format

string format that describes the pixel layout, as string (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)


GST_VIDEO_CAPS_MAKE_WITH_FEATURES

#define GST_VIDEO_CAPS_MAKE_WITH_FEATURES(features,format)              \
    "video/x-raw(" features "), "                                       \
    "format = (string) " format ", "                                    \
    "width = " GST_VIDEO_SIZE_RANGE ", "                                \
    "height = " GST_VIDEO_SIZE_RANGE ", "                               \
    "framerate = " GST_VIDEO_FPS_RANGE

Generic caps string for video, for use in pad templates.

Parameters:

format

string format that describes the pixel layout, as string (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)

features

Requires caps features as a string, e.g. "memory:SystemMemory".


GST_VIDEO_FORMAT_INFO_BITS

#define GST_VIDEO_FORMAT_INFO_BITS(info)         ((info)->bits)

GST_VIDEO_FORMAT_INFO_DATA

#define GST_VIDEO_FORMAT_INFO_DATA(info,planes,comp) \
  (((guint8*)(planes)[(info)->plane[comp]]) + (info)->poffset[comp])

GST_VIDEO_FORMAT_INFO_DEPTH

#define GST_VIDEO_FORMAT_INFO_DEPTH(info,c)      ((info)->depth[c])

GST_VIDEO_FORMAT_INFO_FLAGS

#define GST_VIDEO_FORMAT_INFO_FLAGS(info)        ((info)->flags)

GST_VIDEO_FORMAT_INFO_FORMAT

#define GST_VIDEO_FORMAT_INFO_FORMAT(info)       ((info)->format)

GST_VIDEO_FORMAT_INFO_HAS_ALPHA

#define GST_VIDEO_FORMAT_INFO_HAS_ALPHA(info)    ((info)->flags & GST_VIDEO_FORMAT_FLAG_ALPHA)

GST_VIDEO_FORMAT_INFO_HAS_PALETTE

#define GST_VIDEO_FORMAT_INFO_HAS_PALETTE(info)  ((info)->flags & GST_VIDEO_FORMAT_FLAG_PALETTE)

GST_VIDEO_FORMAT_INFO_H_SUB

#define GST_VIDEO_FORMAT_INFO_H_SUB(info,c)      ((info)->h_sub[c])

GST_VIDEO_FORMAT_INFO_IS_COMPLEX

#define GST_VIDEO_FORMAT_INFO_IS_COMPLEX(info)   ((info)->flags & GST_VIDEO_FORMAT_FLAG_COMPLEX)

GST_VIDEO_FORMAT_INFO_IS_GRAY

#define GST_VIDEO_FORMAT_INFO_IS_GRAY(info)      ((info)->flags & GST_VIDEO_FORMAT_FLAG_GRAY)

GST_VIDEO_FORMAT_INFO_IS_LE

#define GST_VIDEO_FORMAT_INFO_IS_LE(info)        ((info)->flags & GST_VIDEO_FORMAT_FLAG_LE)

GST_VIDEO_FORMAT_INFO_IS_RGB

#define GST_VIDEO_FORMAT_INFO_IS_RGB(info)       ((info)->flags & GST_VIDEO_FORMAT_FLAG_RGB)

GST_VIDEO_FORMAT_INFO_IS_TILED

#define GST_VIDEO_FORMAT_INFO_IS_TILED(info)     ((info)->flags & GST_VIDEO_FORMAT_FLAG_TILED)

GST_VIDEO_FORMAT_INFO_IS_YUV

#define GST_VIDEO_FORMAT_INFO_IS_YUV(info)       ((info)->flags & GST_VIDEO_FORMAT_FLAG_YUV)

GST_VIDEO_FORMAT_INFO_NAME

#define GST_VIDEO_FORMAT_INFO_NAME(info)         ((info)->name)

GST_VIDEO_FORMAT_INFO_N_COMPONENTS

#define GST_VIDEO_FORMAT_INFO_N_COMPONENTS(info) ((info)->n_components)

GST_VIDEO_FORMAT_INFO_N_PLANES

#define GST_VIDEO_FORMAT_INFO_N_PLANES(info)     ((info)->n_planes)

Number of planes. This is the number of planes the pixel layout is organized in in memory. The number of planes can be less than the number of components (e.g. Y,U,V,A or R, G, B, A) when multiple components are packed into one plane.

Examples: RGB/RGBx/RGBA: 1 plane, 3/3/4 components; I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components.

Parameters:

info

a GstVideoFormatInfo


GST_VIDEO_FORMAT_INFO_OFFSET

#define GST_VIDEO_FORMAT_INFO_OFFSET(info,offsets,comp) \
  (((offsets)[(info)->plane[comp]]) + (info)->poffset[comp])

GST_VIDEO_FORMAT_INFO_PLANE

#define GST_VIDEO_FORMAT_INFO_PLANE(info,c)      ((info)->plane[c])

Plane number where the given component can be found. A plane may contain data for multiple components.

Parameters:

info

a GstVideoFormatInfo

c

the component index


GST_VIDEO_FORMAT_INFO_POFFSET

#define GST_VIDEO_FORMAT_INFO_POFFSET(info,c)    ((info)->poffset[c])

GST_VIDEO_FORMAT_INFO_PSTRIDE

#define GST_VIDEO_FORMAT_INFO_PSTRIDE(info,c)    ((info)->pixel_stride[c])

pixel stride for the given component. This is the amount of bytes to the pixel immediately to the right, so basically bytes from one pixel to the next. When bits < 8, the stride is expressed in bits.

Examples: for 24-bit RGB, the pixel stride would be 3 bytes, while it would be 4 bytes for RGBx or ARGB, and 8 bytes for ARGB64 or AYUV64. For planar formats such as I420 the pixel stride is usually 1. For YUY2 it would be 2 bytes.

Parameters:

info

a GstVideoFormatInfo

c

the component index


GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT

#define GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT(info,c,h) GST_VIDEO_SUB_SCALE ((info)->h_sub[c],(h))

GST_VIDEO_FORMAT_INFO_SCALE_WIDTH

#define GST_VIDEO_FORMAT_INFO_SCALE_WIDTH(info,c,w)  GST_VIDEO_SUB_SCALE ((info)->w_sub[c],(w))

GST_VIDEO_FORMAT_INFO_SHIFT

#define GST_VIDEO_FORMAT_INFO_SHIFT(info,c)      ((info)->shift[c])

GST_VIDEO_FORMAT_INFO_STRIDE

#define GST_VIDEO_FORMAT_INFO_STRIDE(info,strides,comp) ((strides)[(info)->plane[comp]])

Row stride in bytes, that is number of bytes from the first pixel component of a row to the first pixel component in the next row. This might include some row padding (memory not actually used for anything, to make sure the beginning of the next row is aligned in a particular way).

Parameters:

info

a GstVideoFormatInfo

strides

an array of strides

comp

the component index


GST_VIDEO_FORMAT_INFO_TILE_HS

#define GST_VIDEO_FORMAT_INFO_TILE_HS(info) ((info)->tile_hs)

GST_VIDEO_FORMAT_INFO_TILE_MODE

#define GST_VIDEO_FORMAT_INFO_TILE_MODE(info) ((info)->tile_mode)

GST_VIDEO_FORMAT_INFO_TILE_WS

#define GST_VIDEO_FORMAT_INFO_TILE_WS(info) ((info)->tile_ws)

GST_VIDEO_FORMAT_INFO_W_SUB

#define GST_VIDEO_FORMAT_INFO_W_SUB(info,c)      ((info)->w_sub[c])

GST_VIDEO_NE

#define GST_VIDEO_NE(s) G_STRINGIFY(s)"_LE"

GST_VIDEO_OE

#define GST_VIDEO_OE(s) G_STRINGIFY(s)"_BE"

GST_VIDEO_SUB_SCALE

#define GST_VIDEO_SUB_SCALE(scale,val)   (-((-((gint)(val)))>>(scale)))

Enumerations

GstVideoFormat

Enum value describing the most common video formats.

See the GStreamer raw video format design document for details about the layout and packing of these formats in memory.

Members
GST_VIDEO_FORMAT_UNKNOWN (0) –

Unknown or unset video format id

GST_VIDEO_FORMAT_ENCODED (1) –

Encoded video format. Only ever use that in caps for special video formats in combination with non-system memory GstCapsFeatures where it does not make sense to specify a real video format.

GST_VIDEO_FORMAT_I420 (2) –

planar 4:2:0 YUV

GST_VIDEO_FORMAT_YV12 (3) –

planar 4:2:0 YVU (like I420 but UV planes swapped)

GST_VIDEO_FORMAT_YUY2 (4) –

packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)

GST_VIDEO_FORMAT_UYVY (5) –

packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

GST_VIDEO_FORMAT_AYUV (6) –

packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)

GST_VIDEO_FORMAT_RGBx (7) –

sparse rgb packed into 32 bit, space last

GST_VIDEO_FORMAT_BGRx (8) –

sparse reverse rgb packed into 32 bit, space last

GST_VIDEO_FORMAT_xRGB (9) –

sparse rgb packed into 32 bit, space first

GST_VIDEO_FORMAT_xBGR (10) –

sparse reverse rgb packed into 32 bit, space first

GST_VIDEO_FORMAT_RGBA (11) –

rgb with alpha channel last

GST_VIDEO_FORMAT_BGRA (12) –

reverse rgb with alpha channel last

GST_VIDEO_FORMAT_ARGB (13) –

rgb with alpha channel first

GST_VIDEO_FORMAT_ABGR (14) –

reverse rgb with alpha channel first

GST_VIDEO_FORMAT_RGB (15) –

RGB packed into 24 bits without padding (R-G-B-R-G-B)

GST_VIDEO_FORMAT_BGR (16) –

reverse RGB packed into 24 bits without padding (B-G-R-B-G-R)

GST_VIDEO_FORMAT_Y41B (17) –

planar 4:1:1 YUV

GST_VIDEO_FORMAT_Y42B (18) –

planar 4:2:2 YUV

GST_VIDEO_FORMAT_YVYU (19) –

packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)

GST_VIDEO_FORMAT_Y444 (20) –

planar 4:4:4 YUV

GST_VIDEO_FORMAT_v210 (21) –

packed 4:2:2 10-bit YUV, complex format

GST_VIDEO_FORMAT_v216 (22) –

packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order

GST_VIDEO_FORMAT_NV12 (23) –

planar 4:2:0 YUV with interleaved UV plane

GST_VIDEO_FORMAT_NV21 (24) –

planar 4:2:0 YUV with interleaved VU plane

GST_VIDEO_FORMAT_GRAY8 (25) –

8-bit grayscale

GST_VIDEO_FORMAT_GRAY16_BE (26) –

16-bit grayscale, most significant byte first

GST_VIDEO_FORMAT_GRAY16_LE (27) –

16-bit grayscale, least significant byte first

GST_VIDEO_FORMAT_v308 (28) –

packed 4:4:4 YUV (Y-U-V ...)

GST_VIDEO_FORMAT_RGB16 (29) –

rgb 5-6-5 bits per component

GST_VIDEO_FORMAT_BGR16 (30) –

reverse rgb 5-6-5 bits per component

GST_VIDEO_FORMAT_RGB15 (31) –

rgb 5-5-5 bits per component

GST_VIDEO_FORMAT_BGR15 (32) –

reverse rgb 5-5-5 bits per component

GST_VIDEO_FORMAT_UYVP (33) –

packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

GST_VIDEO_FORMAT_A420 (34) –

planar 4:4:2:0 AYUV

GST_VIDEO_FORMAT_RGB8P (35) –

8-bit paletted RGB

GST_VIDEO_FORMAT_YUV9 (36) –

planar 4:1:0 YUV

GST_VIDEO_FORMAT_YVU9 (37) –

planar 4:1:0 YUV (like YUV9 but UV planes swapped)

GST_VIDEO_FORMAT_IYU1 (38) –

packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)

GST_VIDEO_FORMAT_ARGB64 (39) –

rgb with alpha channel first, 16 bits per channel

GST_VIDEO_FORMAT_AYUV64 (40) –

packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)

GST_VIDEO_FORMAT_r210 (41) –

packed 4:4:4 RGB, 10 bits per channel

GST_VIDEO_FORMAT_I420_10BE (42) –

planar 4:2:0 YUV, 10 bits per channel

GST_VIDEO_FORMAT_I420_10LE (43) –

planar 4:2:0 YUV, 10 bits per channel

GST_VIDEO_FORMAT_I422_10BE (44) –

planar 4:2:2 YUV, 10 bits per channel

GST_VIDEO_FORMAT_I422_10LE (45) –

planar 4:2:2 YUV, 10 bits per channel

GST_VIDEO_FORMAT_Y444_10BE (46) –

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

GST_VIDEO_FORMAT_Y444_10LE (47) –

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

GST_VIDEO_FORMAT_GBR (48) –

planar 4:4:4 RGB, 8 bits per channel (Since: 1.2)

GST_VIDEO_FORMAT_GBR_10BE (49) –

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

GST_VIDEO_FORMAT_GBR_10LE (50) –

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

GST_VIDEO_FORMAT_NV16 (51) –

planar 4:2:2 YUV with interleaved UV plane (Since: 1.2)

GST_VIDEO_FORMAT_NV24 (52) –

planar 4:4:4 YUV with interleaved UV plane (Since: 1.2)

GST_VIDEO_FORMAT_NV12_64Z32 (53) –

NV12 with 64x32 tiling in zigzag pattern (Since: 1.4)

GST_VIDEO_FORMAT_A420_10BE (54) –

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

GST_VIDEO_FORMAT_A420_10LE (55) –

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

GST_VIDEO_FORMAT_A422_10BE (56) –

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

GST_VIDEO_FORMAT_A422_10LE (57) –

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

GST_VIDEO_FORMAT_A444_10BE (58) –

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

GST_VIDEO_FORMAT_A444_10LE (59) –

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

GST_VIDEO_FORMAT_NV61 (60) –

planar 4:2:2 YUV with interleaved VU plane (Since: 1.6)

GST_VIDEO_FORMAT_P010_10BE (61) –

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

GST_VIDEO_FORMAT_P010_10LE (62) –

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

GST_VIDEO_FORMAT_IYU2 (63) –

packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)

GST_VIDEO_FORMAT_VYUY (64) –

packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...)

GST_VIDEO_FORMAT_GBRA (65) –

planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GBRA_10BE (66) –

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GBRA_10LE (67) –

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GBR_12BE (68) –

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GBR_12LE (69) –

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GBRA_12BE (70) –

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GBRA_12LE (71) –

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_I420_12BE (72) –

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_I420_12LE (73) –

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_I422_12BE (74) –

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_I422_12LE (75) –

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_Y444_12BE (76) –

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_Y444_12LE (77) –

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

GST_VIDEO_FORMAT_GRAY10_LE32 (78) –

10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14)

GST_VIDEO_FORMAT_NV12_10LE32 (79) –

10-bit variant of GST_VIDEO_FORMAT_NV12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

GST_VIDEO_FORMAT_NV16_10LE32 (80) –

10-bit variant of GST_VIDEO_FORMAT_NV16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

GST_VIDEO_FORMAT_NV12_10LE40 (81) –

Fully packed variant of NV12_10LE32 (Since: 1.16)

GST_VIDEO_FORMAT_Y210 (82) –

packed 4:2:2 YUV, 10 bits per channel (Since: 1.16)

GST_VIDEO_FORMAT_Y410 (83) –

packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)

GST_VIDEO_FORMAT_VUYA (84) –

packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16)

GST_VIDEO_FORMAT_BGR10A2_LE (85) –

packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16)

GST_VIDEO_FORMAT_RGB10A2_LE (86) –

packed 4:4:4 RGB with alpha channel(R-G-B-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.18)

GST_VIDEO_FORMAT_Y444_16BE (87) –

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

GST_VIDEO_FORMAT_Y444_16LE (88) –

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

GST_VIDEO_FORMAT_P016_BE (89) –

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

GST_VIDEO_FORMAT_P016_LE (90) –

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

GST_VIDEO_FORMAT_P012_BE (91) –

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

GST_VIDEO_FORMAT_P012_LE (92) –

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

GST_VIDEO_FORMAT_Y212_BE (93) –

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

GST_VIDEO_FORMAT_Y212_LE (94) –

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

GST_VIDEO_FORMAT_Y412_BE (95) –

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

GST_VIDEO_FORMAT_Y412_LE (96) –

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

GST_VIDEO_FORMAT_NV12_4L4 (97) –

NV12 with 4x4 tiles in linear order.

GST_VIDEO_FORMAT_NV12_32L32 (98) –

NV12 with 32x32 tiles in linear order.


GstVideo.VideoFormat

Enum value describing the most common video formats.

See the GStreamer raw video format design document for details about the layout and packing of these formats in memory.

Members
GstVideo.VideoFormat.UNKNOWN (0) –

Unknown or unset video format id

GstVideo.VideoFormat.ENCODED (1) –

Encoded video format. Only ever use that in caps for special video formats in combination with non-system memory GstCapsFeatures where it does not make sense to specify a real video format.

GstVideo.VideoFormat.I420 (2) –

planar 4:2:0 YUV

GstVideo.VideoFormat.YV12 (3) –

planar 4:2:0 YVU (like I420 but UV planes swapped)

GstVideo.VideoFormat.YUY2 (4) –

packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)

GstVideo.VideoFormat.UYVY (5) –

packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

GstVideo.VideoFormat.AYUV (6) –

packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)

GstVideo.VideoFormat.RGBX (7) –

sparse rgb packed into 32 bit, space last

GstVideo.VideoFormat.BGRX (8) –

sparse reverse rgb packed into 32 bit, space last

GstVideo.VideoFormat.XRGB (9) –

sparse rgb packed into 32 bit, space first

GstVideo.VideoFormat.XBGR (10) –

sparse reverse rgb packed into 32 bit, space first

GstVideo.VideoFormat.RGBA (11) –

rgb with alpha channel last

GstVideo.VideoFormat.BGRA (12) –

reverse rgb with alpha channel last

GstVideo.VideoFormat.ARGB (13) –

rgb with alpha channel first

GstVideo.VideoFormat.ABGR (14) –

reverse rgb with alpha channel first

GstVideo.VideoFormat.RGB (15) –

RGB packed into 24 bits without padding (R-G-B-R-G-B)

GstVideo.VideoFormat.BGR (16) –

reverse RGB packed into 24 bits without padding (B-G-R-B-G-R)

GstVideo.VideoFormat.Y41B (17) –

planar 4:1:1 YUV

GstVideo.VideoFormat.Y42B (18) –

planar 4:2:2 YUV

GstVideo.VideoFormat.YVYU (19) –

packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)

GstVideo.VideoFormat.Y444 (20) –

planar 4:4:4 YUV

GstVideo.VideoFormat.V210 (21) –

packed 4:2:2 10-bit YUV, complex format

GstVideo.VideoFormat.V216 (22) –

packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order

GstVideo.VideoFormat.NV12 (23) –

planar 4:2:0 YUV with interleaved UV plane

GstVideo.VideoFormat.NV21 (24) –

planar 4:2:0 YUV with interleaved VU plane

GstVideo.VideoFormat.GRAY8 (25) –

8-bit grayscale

GstVideo.VideoFormat.GRAY16_BE (26) –

16-bit grayscale, most significant byte first

GstVideo.VideoFormat.GRAY16_LE (27) –

16-bit grayscale, least significant byte first

GstVideo.VideoFormat.V308 (28) –

packed 4:4:4 YUV (Y-U-V ...)

GstVideo.VideoFormat.RGB16 (29) –

rgb 5-6-5 bits per component

GstVideo.VideoFormat.BGR16 (30) –

reverse rgb 5-6-5 bits per component

GstVideo.VideoFormat.RGB15 (31) –

rgb 5-5-5 bits per component

GstVideo.VideoFormat.BGR15 (32) –

reverse rgb 5-5-5 bits per component

GstVideo.VideoFormat.UYVP (33) –

packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

GstVideo.VideoFormat.A420 (34) –

planar 4:4:2:0 AYUV

GstVideo.VideoFormat.RGB8P (35) –

8-bit paletted RGB

GstVideo.VideoFormat.YUV9 (36) –

planar 4:1:0 YUV

GstVideo.VideoFormat.YVU9 (37) –

planar 4:1:0 YUV (like YUV9 but UV planes swapped)

GstVideo.VideoFormat.IYU1 (38) –

packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)

GstVideo.VideoFormat.ARGB64 (39) –

rgb with alpha channel first, 16 bits per channel

GstVideo.VideoFormat.AYUV64 (40) –

packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)

GstVideo.VideoFormat.R210 (41) –

packed 4:4:4 RGB, 10 bits per channel

GstVideo.VideoFormat.I420_10BE (42) –

planar 4:2:0 YUV, 10 bits per channel

GstVideo.VideoFormat.I420_10LE (43) –

planar 4:2:0 YUV, 10 bits per channel

GstVideo.VideoFormat.I422_10BE (44) –

planar 4:2:2 YUV, 10 bits per channel

GstVideo.VideoFormat.I422_10LE (45) –

planar 4:2:2 YUV, 10 bits per channel

GstVideo.VideoFormat.Y444_10BE (46) –

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.Y444_10LE (47) –

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.GBR (48) –

planar 4:4:4 RGB, 8 bits per channel (Since: 1.2)

GstVideo.VideoFormat.GBR_10BE (49) –

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.GBR_10LE (50) –

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.NV16 (51) –

planar 4:2:2 YUV with interleaved UV plane (Since: 1.2)

GstVideo.VideoFormat.NV24 (52) –

planar 4:4:4 YUV with interleaved UV plane (Since: 1.2)

GstVideo.VideoFormat.NV12_64Z32 (53) –

NV12 with 64x32 tiling in zigzag pattern (Since: 1.4)

GstVideo.VideoFormat.A420_10BE (54) –

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A420_10LE (55) –

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A422_10BE (56) –

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A422_10LE (57) –

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A444_10BE (58) –

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A444_10LE (59) –

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.NV61 (60) –

planar 4:2:2 YUV with interleaved VU plane (Since: 1.6)

GstVideo.VideoFormat.P010_10BE (61) –

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

GstVideo.VideoFormat.P010_10LE (62) –

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

GstVideo.VideoFormat.IYU2 (63) –

packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)

GstVideo.VideoFormat.VYUY (64) –

packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...)

GstVideo.VideoFormat.GBRA (65) –

planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_10BE (66) –

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_10LE (67) –

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBR_12BE (68) –

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBR_12LE (69) –

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_12BE (70) –

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_12LE (71) –

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I420_12BE (72) –

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I420_12LE (73) –

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I422_12BE (74) –

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I422_12LE (75) –

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.Y444_12BE (76) –

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.Y444_12LE (77) –

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GRAY10_LE32 (78) –

10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14)

GstVideo.VideoFormat.NV12_10LE32 (79) –

10-bit variant of GST_VIDEO_FORMAT_NV12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

GstVideo.VideoFormat.NV16_10LE32 (80) –

10-bit variant of GST_VIDEO_FORMAT_NV16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

GstVideo.VideoFormat.NV12_10LE40 (81) –

Fully packed variant of NV12_10LE32 (Since: 1.16)

GstVideo.VideoFormat.Y210 (82) –

packed 4:2:2 YUV, 10 bits per channel (Since: 1.16)

GstVideo.VideoFormat.Y410 (83) –

packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)

GstVideo.VideoFormat.VUYA (84) –

packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16)

GstVideo.VideoFormat.BGR10A2_LE (85) –

packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16)

GstVideo.VideoFormat.RGB10A2_LE (86) –

packed 4:4:4 RGB with alpha channel(R-G-B-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.18)

GstVideo.VideoFormat.Y444_16BE (87) –

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.Y444_16LE (88) –

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P016_BE (89) –

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P016_LE (90) –

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P012_BE (91) –

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P012_LE (92) –

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

GstVideo.VideoFormat.Y212_BE (93) –

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

GstVideo.VideoFormat.Y212_LE (94) –

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

GstVideo.VideoFormat.Y412_BE (95) –

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

GstVideo.VideoFormat.Y412_LE (96) –

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

GstVideo.VideoFormat.NV12_4L4 (97) –

NV12 with 4x4 tiles in linear order.

GstVideo.VideoFormat.NV12_32L32 (98) –

NV12 with 32x32 tiles in linear order.


GstVideo.VideoFormat

Enum value describing the most common video formats.

See the GStreamer raw video format design document for details about the layout and packing of these formats in memory.

Members
GstVideo.VideoFormat.UNKNOWN (0) –

Unknown or unset video format id

GstVideo.VideoFormat.ENCODED (1) –

Encoded video format. Only ever use that in caps for special video formats in combination with non-system memory GstCapsFeatures where it does not make sense to specify a real video format.

GstVideo.VideoFormat.I420 (2) –

planar 4:2:0 YUV

GstVideo.VideoFormat.YV12 (3) –

planar 4:2:0 YVU (like I420 but UV planes swapped)

GstVideo.VideoFormat.YUY2 (4) –

packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)

GstVideo.VideoFormat.UYVY (5) –

packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

GstVideo.VideoFormat.AYUV (6) –

packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)

GstVideo.VideoFormat.RGBX (7) –

sparse rgb packed into 32 bit, space last

GstVideo.VideoFormat.BGRX (8) –

sparse reverse rgb packed into 32 bit, space last

GstVideo.VideoFormat.XRGB (9) –

sparse rgb packed into 32 bit, space first

GstVideo.VideoFormat.XBGR (10) –

sparse reverse rgb packed into 32 bit, space first

GstVideo.VideoFormat.RGBA (11) –

rgb with alpha channel last

GstVideo.VideoFormat.BGRA (12) –

reverse rgb with alpha channel last

GstVideo.VideoFormat.ARGB (13) –

rgb with alpha channel first

GstVideo.VideoFormat.ABGR (14) –

reverse rgb with alpha channel first

GstVideo.VideoFormat.RGB (15) –

RGB packed into 24 bits without padding (R-G-B-R-G-B)

GstVideo.VideoFormat.BGR (16) –

reverse RGB packed into 24 bits without padding (B-G-R-B-G-R)

GstVideo.VideoFormat.Y41B (17) –

planar 4:1:1 YUV

GstVideo.VideoFormat.Y42B (18) –

planar 4:2:2 YUV

GstVideo.VideoFormat.YVYU (19) –

packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)

GstVideo.VideoFormat.Y444 (20) –

planar 4:4:4 YUV

GstVideo.VideoFormat.V210 (21) –

packed 4:2:2 10-bit YUV, complex format

GstVideo.VideoFormat.V216 (22) –

packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order

GstVideo.VideoFormat.NV12 (23) –

planar 4:2:0 YUV with interleaved UV plane

GstVideo.VideoFormat.NV21 (24) –

planar 4:2:0 YUV with interleaved VU plane

GstVideo.VideoFormat.GRAY8 (25) –

8-bit grayscale

GstVideo.VideoFormat.GRAY16_BE (26) –

16-bit grayscale, most significant byte first

GstVideo.VideoFormat.GRAY16_LE (27) –

16-bit grayscale, least significant byte first

GstVideo.VideoFormat.V308 (28) –

packed 4:4:4 YUV (Y-U-V ...)

GstVideo.VideoFormat.RGB16 (29) –

rgb 5-6-5 bits per component

GstVideo.VideoFormat.BGR16 (30) –

reverse rgb 5-6-5 bits per component

GstVideo.VideoFormat.RGB15 (31) –

rgb 5-5-5 bits per component

GstVideo.VideoFormat.BGR15 (32) –

reverse rgb 5-5-5 bits per component

GstVideo.VideoFormat.UYVP (33) –

packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)

GstVideo.VideoFormat.A420 (34) –

planar 4:4:2:0 AYUV

GstVideo.VideoFormat.RGB8P (35) –

8-bit paletted RGB

GstVideo.VideoFormat.YUV9 (36) –

planar 4:1:0 YUV

GstVideo.VideoFormat.YVU9 (37) –

planar 4:1:0 YUV (like YUV9 but UV planes swapped)

GstVideo.VideoFormat.IYU1 (38) –

packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)

GstVideo.VideoFormat.ARGB64 (39) –

rgb with alpha channel first, 16 bits per channel

GstVideo.VideoFormat.AYUV64 (40) –

packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)

GstVideo.VideoFormat.R210 (41) –

packed 4:4:4 RGB, 10 bits per channel

GstVideo.VideoFormat.I420_10BE (42) –

planar 4:2:0 YUV, 10 bits per channel

GstVideo.VideoFormat.I420_10LE (43) –

planar 4:2:0 YUV, 10 bits per channel

GstVideo.VideoFormat.I422_10BE (44) –

planar 4:2:2 YUV, 10 bits per channel

GstVideo.VideoFormat.I422_10LE (45) –

planar 4:2:2 YUV, 10 bits per channel

GstVideo.VideoFormat.Y444_10BE (46) –

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.Y444_10LE (47) –

planar 4:4:4 YUV, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.GBR (48) –

planar 4:4:4 RGB, 8 bits per channel (Since: 1.2)

GstVideo.VideoFormat.GBR_10BE (49) –

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.GBR_10LE (50) –

planar 4:4:4 RGB, 10 bits per channel (Since: 1.2)

GstVideo.VideoFormat.NV16 (51) –

planar 4:2:2 YUV with interleaved UV plane (Since: 1.2)

GstVideo.VideoFormat.NV24 (52) –

planar 4:4:4 YUV with interleaved UV plane (Since: 1.2)

GstVideo.VideoFormat.NV12_64Z32 (53) –

NV12 with 64x32 tiling in zigzag pattern (Since: 1.4)

GstVideo.VideoFormat.A420_10BE (54) –

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A420_10LE (55) –

planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A422_10BE (56) –

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A422_10LE (57) –

planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A444_10BE (58) –

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.A444_10LE (59) –

planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6)

GstVideo.VideoFormat.NV61 (60) –

planar 4:2:2 YUV with interleaved VU plane (Since: 1.6)

GstVideo.VideoFormat.P010_10BE (61) –

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

GstVideo.VideoFormat.P010_10LE (62) –

planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10)

GstVideo.VideoFormat.IYU2 (63) –

packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)

GstVideo.VideoFormat.VYUY (64) –

packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...)

GstVideo.VideoFormat.GBRA (65) –

planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_10BE (66) –

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_10LE (67) –

planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBR_12BE (68) –

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBR_12LE (69) –

planar 4:4:4 RGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_12BE (70) –

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GBRA_12LE (71) –

planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I420_12BE (72) –

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I420_12LE (73) –

planar 4:2:0 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I422_12BE (74) –

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.I422_12LE (75) –

planar 4:2:2 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.Y444_12BE (76) –

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.Y444_12LE (77) –

planar 4:4:4 YUV, 12 bits per channel (Since: 1.12)

GstVideo.VideoFormat.GRAY10_LE32 (78) –

10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14)

GstVideo.VideoFormat.NV12_10LE32 (79) –

10-bit variant of GST_VIDEO_FORMAT_NV12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

GstVideo.VideoFormat.NV16_10LE32 (80) –

10-bit variant of GST_VIDEO_FORMAT_NV16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14)

GstVideo.VideoFormat.NV12_10LE40 (81) –

Fully packed variant of NV12_10LE32 (Since: 1.16)

GstVideo.VideoFormat.Y210 (82) –

packed 4:2:2 YUV, 10 bits per channel (Since: 1.16)

GstVideo.VideoFormat.Y410 (83) –

packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16)

GstVideo.VideoFormat.VUYA (84) –

packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16)

GstVideo.VideoFormat.BGR10A2_LE (85) –

packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16)

GstVideo.VideoFormat.RGB10A2_LE (86) –

packed 4:4:4 RGB with alpha channel(R-G-B-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.18)

GstVideo.VideoFormat.Y444_16BE (87) –

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.Y444_16LE (88) –

planar 4:4:4 YUV, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P016_BE (89) –

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P016_LE (90) –

planar 4:2:0 YUV with interleaved UV plane, 16 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P012_BE (91) –

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

GstVideo.VideoFormat.P012_LE (92) –

planar 4:2:0 YUV with interleaved UV plane, 12 bits per channel (Since: 1.18)

GstVideo.VideoFormat.Y212_BE (93) –

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

GstVideo.VideoFormat.Y212_LE (94) –

packed 4:2:2 YUV, 12 bits per channel (Y-U-Y-V) (Since: 1.18)

GstVideo.VideoFormat.Y412_BE (95) –

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

GstVideo.VideoFormat.Y412_LE (96) –

packed 4:4:4:4 YUV, 12 bits per channel(U-Y-V-A...) (Since: 1.18)

GstVideo.VideoFormat.NV12_4L4 (97) –

NV12 with 4x4 tiles in linear order.

GstVideo.VideoFormat.NV12_32L32 (98) –

NV12 with 32x32 tiles in linear order.


GstVideoFormatFlags

The different video flags that a format info can have.

Members
GST_VIDEO_FORMAT_FLAG_YUV (1) –

The video format is YUV, components are numbered 0=Y, 1=U, 2=V.

GST_VIDEO_FORMAT_FLAG_RGB (2) –

The video format is RGB, components are numbered 0=R, 1=G, 2=B.

GST_VIDEO_FORMAT_FLAG_GRAY (4) –

The video is gray, there is one gray component with index 0.

GST_VIDEO_FORMAT_FLAG_ALPHA (8) –

The video format has an alpha components with the number 3.

GST_VIDEO_FORMAT_FLAG_LE (16) –

The video format has data stored in little endianness.

GST_VIDEO_FORMAT_FLAG_PALETTE (32) –

The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane.

GST_VIDEO_FORMAT_FLAG_COMPLEX (64) –

The video format has a complex layout that can't be described with the usual information in the GstVideoFormatInfo.

GST_VIDEO_FORMAT_FLAG_UNPACK (128) –

This format can be used in a GstVideoFormatUnpack and GstVideoFormatPack function.

GST_VIDEO_FORMAT_FLAG_TILED (256) –

The format is tiled, there is tiling information in the last plane.


GstVideo.VideoFormatFlags

The different video flags that a format info can have.

Members
GstVideo.VideoFormatFlags.YUV (1) –

The video format is YUV, components are numbered 0=Y, 1=U, 2=V.

GstVideo.VideoFormatFlags.RGB (2) –

The video format is RGB, components are numbered 0=R, 1=G, 2=B.

GstVideo.VideoFormatFlags.GRAY (4) –

The video is gray, there is one gray component with index 0.

GstVideo.VideoFormatFlags.ALPHA (8) –

The video format has an alpha components with the number 3.

GstVideo.VideoFormatFlags.LE (16) –

The video format has data stored in little endianness.

GstVideo.VideoFormatFlags.PALETTE (32) –

The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane.

GstVideo.VideoFormatFlags.COMPLEX (64) –

The video format has a complex layout that can't be described with the usual information in the GstVideo.VideoFormatInfo.

GstVideo.VideoFormatFlags.UNPACK (128) –

This format can be used in a GstVideo.VideoFormatUnpack and GstVideo.VideoFormatPack function.

GstVideo.VideoFormatFlags.TILED (256) –

The format is tiled, there is tiling information in the last plane.


GstVideo.VideoFormatFlags

The different video flags that a format info can have.

Members
GstVideo.VideoFormatFlags.YUV (1) –

The video format is YUV, components are numbered 0=Y, 1=U, 2=V.

GstVideo.VideoFormatFlags.RGB (2) –

The video format is RGB, components are numbered 0=R, 1=G, 2=B.

GstVideo.VideoFormatFlags.GRAY (4) –

The video is gray, there is one gray component with index 0.

GstVideo.VideoFormatFlags.ALPHA (8) –

The video format has an alpha components with the number 3.

GstVideo.VideoFormatFlags.LE (16) –

The video format has data stored in little endianness.

GstVideo.VideoFormatFlags.PALETTE (32) –

The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane.

GstVideo.VideoFormatFlags.COMPLEX (64) –

The video format has a complex layout that can't be described with the usual information in the GstVideo.VideoFormatInfo.

GstVideo.VideoFormatFlags.UNPACK (128) –

This format can be used in a GstVideo.VideoFormatUnpack and GstVideo.VideoFormatPack function.

GstVideo.VideoFormatFlags.TILED (256) –

The format is tiled, there is tiling information in the last plane.


GstVideoPackFlags

The different flags that can be used when packing and unpacking.

Members
GST_VIDEO_PACK_FLAG_NONE (0) –

No flag

GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE (1) –

When the source has a smaller depth than the target format, set the least significant bits of the target to 0. This is likely slightly faster but less accurate. When this flag is not specified, the most significant bits of the source are duplicated in the least significant bits of the destination.

GST_VIDEO_PACK_FLAG_INTERLACED (2) –

The source is interlaced. The unpacked format will be interlaced as well with each line containing information from alternating fields. (Since: 1.2)


GstVideo.VideoPackFlags

The different flags that can be used when packing and unpacking.

Members
GstVideo.VideoPackFlags.NONE (0) –

No flag

GstVideo.VideoPackFlags.TRUNCATE_RANGE (1) –

When the source has a smaller depth than the target format, set the least significant bits of the target to 0. This is likely slightly faster but less accurate. When this flag is not specified, the most significant bits of the source are duplicated in the least significant bits of the destination.

GstVideo.VideoPackFlags.INTERLACED (2) –

The source is interlaced. The unpacked format will be interlaced as well with each line containing information from alternating fields. (Since: 1.2)


GstVideo.VideoPackFlags

The different flags that can be used when packing and unpacking.

Members
GstVideo.VideoPackFlags.NONE (0) –

No flag

GstVideo.VideoPackFlags.TRUNCATE_RANGE (1) –

When the source has a smaller depth than the target format, set the least significant bits of the target to 0. This is likely slightly faster but less accurate. When this flag is not specified, the most significant bits of the source are duplicated in the least significant bits of the destination.

GstVideo.VideoPackFlags.INTERLACED (2) –

The source is interlaced. The unpacked format will be interlaced as well with each line containing information from alternating fields. (Since: 1.2)


Constants

GST_VIDEO_COMP_A

#define GST_VIDEO_COMP_A  3

GstVideo.VIDEO_COMP_A


GstVideo.VIDEO_COMP_A


GST_VIDEO_COMP_B

#define GST_VIDEO_COMP_B  2

GstVideo.VIDEO_COMP_B


GstVideo.VIDEO_COMP_B


GST_VIDEO_COMP_G

#define GST_VIDEO_COMP_G  1

GstVideo.VIDEO_COMP_G


GstVideo.VIDEO_COMP_G


GST_VIDEO_COMP_INDEX

#define GST_VIDEO_COMP_INDEX    0

GstVideo.VIDEO_COMP_INDEX


GstVideo.VIDEO_COMP_INDEX


GST_VIDEO_COMP_PALETTE

#define GST_VIDEO_COMP_PALETTE  1

GstVideo.VIDEO_COMP_PALETTE


GstVideo.VIDEO_COMP_PALETTE


GST_VIDEO_COMP_R

#define GST_VIDEO_COMP_R  0

GstVideo.VIDEO_COMP_R


GstVideo.VIDEO_COMP_R


GST_VIDEO_COMP_U

#define GST_VIDEO_COMP_U  1

GstVideo.VIDEO_COMP_U


GstVideo.VIDEO_COMP_U


GST_VIDEO_COMP_V

#define GST_VIDEO_COMP_V  2

GstVideo.VIDEO_COMP_V


GstVideo.VIDEO_COMP_V


GST_VIDEO_COMP_Y

#define GST_VIDEO_COMP_Y  0

GstVideo.VIDEO_COMP_Y


GstVideo.VIDEO_COMP_Y


GST_VIDEO_FORMATS_ALL

#define GST_VIDEO_FORMATS_ALL "{ AYUV64, ARGB64, GBRA_12BE, GBRA_12LE, Y412_BE, " \
    "Y412_LE, A444_10BE, GBRA_10BE, A444_10LE, GBRA_10LE, A422_10BE, A422_10LE, " \
    "A420_10BE, A420_10LE, Y410, RGB10A2_LE, BGR10A2_LE, GBRA, ABGR, VUYA, BGRA, " \
    "AYUV, ARGB, RGBA, A420, Y444_16BE, Y444_16LE, v216, P016_BE, P016_LE, Y444_12BE, " \
    "GBR_12BE, Y444_12LE, GBR_12LE, I422_12BE, I422_12LE, Y212_BE, Y212_LE, I420_12BE, " \
    "I420_12LE, P012_BE, P012_LE, Y444_10BE, GBR_10BE, Y444_10LE, GBR_10LE, r210, " \
    "I422_10BE, I422_10LE, NV16_10LE32, Y210, v210, UYVP, I420_10BE, I420_10LE, " \
    "P010_10BE, P010_10LE, NV12_10LE32, NV12_10LE40, Y444, GBR, NV24, xBGR, BGRx, " \
    "xRGB, RGBx, BGR, IYU2, v308, RGB, Y42B, NV61, NV16, VYUY, UYVY, YVYU, YUY2, I420, " \
    "YV12, NV21, NV12, NV12_64Z32, NV12_4L4, NV12_32L32, Y41B, IYU1, YVU9, YUV9, RGB16, " \
    "BGR16, RGB15, BGR15, RGB8P, GRAY16_BE, GRAY16_LE, GRAY10_LE32, GRAY8 }"

List of all video formats, for use in template caps strings.

Formats are sorted by decreasing "quality", using these criteria by priority:

  • number of components
  • depth
  • subsampling factor of the width
  • subsampling factor of the height
  • number of planes
  • native endianness preferred
  • pixel stride
  • poffset
  • prefer non-complex formats
  • prefer YUV formats over RGB ones
  • prefer I420 over YV12
  • format name

GstVideo.VIDEO_FORMATS_ALL

List of all video formats, for use in template caps strings.

Formats are sorted by decreasing "quality", using these criteria by priority:

  • number of components
  • depth
  • subsampling factor of the width
  • subsampling factor of the height
  • number of planes
  • native endianness preferred
  • pixel stride
  • poffset
  • prefer non-complex formats
  • prefer YUV formats over RGB ones
  • prefer I420 over YV12
  • format name

GstVideo.VIDEO_FORMATS_ALL

List of all video formats, for use in template caps strings.

Formats are sorted by decreasing "quality", using these criteria by priority:

  • number of components
  • depth
  • subsampling factor of the width
  • subsampling factor of the height
  • number of planes
  • native endianness preferred
  • pixel stride
  • poffset
  • prefer non-complex formats
  • prefer YUV formats over RGB ones
  • prefer I420 over YV12
  • format name

GST_VIDEO_FPS_RANGE

#define GST_VIDEO_FPS_RANGE "(fraction) [ 0, max ]"

GstVideo.VIDEO_FPS_RANGE


GstVideo.VIDEO_FPS_RANGE


GST_VIDEO_MAX_COMPONENTS

#define GST_VIDEO_MAX_COMPONENTS 4

GstVideo.VIDEO_MAX_COMPONENTS


GstVideo.VIDEO_MAX_COMPONENTS


GST_VIDEO_MAX_PLANES

#define GST_VIDEO_MAX_PLANES 4

GstVideo.VIDEO_MAX_PLANES


GstVideo.VIDEO_MAX_PLANES


GST_VIDEO_SIZE_RANGE

#define GST_VIDEO_SIZE_RANGE "(int) [ 1, max ]"

GstVideo.VIDEO_SIZE_RANGE


GstVideo.VIDEO_SIZE_RANGE


Callbacks

GstVideoFormatPack

(*GstVideoFormatPack) (const GstVideoFormatInfo * info,
                       GstVideoPackFlags flags,
                       const gpointer src,
                       gint sstride,
                       gpointer * data,
                       const gint * stride,
                       GstVideoChromaSite chroma_site,
                       gint y,
                       gint width)

Packs width pixels from src to the given planes and strides in the format info. The pixels from source have each component interleaved and will be packed into the planes in data.

This function operates on pack_lines lines, meaning that src should contain at least pack_lines lines with a stride of sstride and y should be a multiple of pack_lines.

Subsampled formats will use the horizontally and vertically cosited component from the source. Subsampling should be performed before packing.

Because this function does not have a x coordinate, it is not possible to pack pixels starting from an unaligned position. For tiled images this means that packing should start from a tile coordinate. For subsampled formats this means that a complete pixel needs to be packed.

Parameters:

info

a GstVideoFormatInfo

flags

flags to control the packing

src

a source array

sstride

the source array stride

data

pointers to the destination data planes

stride

strides of the destination planes

chroma_site

the chroma siting of the target when subsampled (not used)

y

the y position in the image to pack to

width

the amount of pixels to pack.


GstVideo.VideoFormatPack

function GstVideo.VideoFormatPack(info: GstVideo.VideoFormatInfo, flags: GstVideo.VideoPackFlags, src: Object, sstride: Number, data: Object, stride: Number, chroma_site: GstVideo.VideoChromaSite, y: Number, width: Number): {
    // javascript wrapper for 'GstVideoFormatPack'
}

Packs width pixels from src to the given planes and strides in the format info. The pixels from source have each component interleaved and will be packed into the planes in data.

This function operates on pack_lines lines, meaning that src should contain at least pack_lines lines with a stride of sstride and y should be a multiple of pack_lines.

Subsampled formats will use the horizontally and vertically cosited component from the source. Subsampling should be performed before packing.

Because this function does not have a x coordinate, it is not possible to pack pixels starting from an unaligned position. For tiled images this means that packing should start from a tile coordinate. For subsampled formats this means that a complete pixel needs to be packed.

Parameters:

flags ( GstVideo.VideoPackFlags ) –

flags to control the packing

src ( Object ) –

a source array

sstride ( Number ) –

the source array stride

data ( Object ) –

pointers to the destination data planes

stride ( Number ) –

strides of the destination planes

chroma_site ( GstVideo.VideoChromaSite ) –

the chroma siting of the target when subsampled (not used)

y ( Number ) –

the y position in the image to pack to

width ( Number ) –

the amount of pixels to pack.


GstVideo.VideoFormatPack

def GstVideo.VideoFormatPack (info, flags, src, sstride, data, stride, chroma_site, y, width):
    #python wrapper for 'GstVideoFormatPack'

Packs width pixels from src to the given planes and strides in the format info. The pixels from source have each component interleaved and will be packed into the planes in data.

This function operates on pack_lines lines, meaning that src should contain at least pack_lines lines with a stride of sstride and y should be a multiple of pack_lines.

Subsampled formats will use the horizontally and vertically cosited component from the source. Subsampling should be performed before packing.

Because this function does not have a x coordinate, it is not possible to pack pixels starting from an unaligned position. For tiled images this means that packing should start from a tile coordinate. For subsampled formats this means that a complete pixel needs to be packed.

Parameters:

flags ( GstVideo.VideoPackFlags ) –

flags to control the packing

src ( object ) –

a source array

sstride ( int ) –

the source array stride

data ( object ) –

pointers to the destination data planes

stride ( int ) –

strides of the destination planes

chroma_site ( GstVideo.VideoChromaSite ) –

the chroma siting of the target when subsampled (not used)

y ( int ) –

the y position in the image to pack to

width ( int ) –

the amount of pixels to pack.


GstVideoFormatUnpack

(*GstVideoFormatUnpack) (const GstVideoFormatInfo * info,
                         GstVideoPackFlags flags,
                         gpointer dest,
                         const gpointer * data,
                         const gint * stride,
                         gint x,
                         gint y,
                         gint width)

Unpacks width pixels from the given planes and strides containing data of format info. The pixels will be unpacked into dest with each component interleaved as per info's unpack_format, which will usually be one of GST_VIDEO_FORMAT_ARGB, GST_VIDEO_FORMAT_AYUV, GST_VIDEO_FORMAT_ARGB64 or GST_VIDEO_FORMAT_AYUV64 depending on the format to unpack. dest should at least be big enough to hold width * bytes_per_pixel bytes where bytes_per_pixel relates to the unpack format and will usually be either 4 or 8 depending on the unpack format. bytes_per_pixel will be the same as the pixel stride for plane 0 for the above formats.

For subsampled formats, the components will be duplicated in the destination array. Reconstruction of the missing components can be performed in a separate step after unpacking.

Parameters:

info

a GstVideoFormatInfo

flags

flags to control the unpacking

dest

a destination array

data

pointers to the data planes

stride

strides of the planes

x

the x position in the image to start from

y

the y position in the image to start from

width

the amount of pixels to unpack.


GstVideo.VideoFormatUnpack

function GstVideo.VideoFormatUnpack(info: GstVideo.VideoFormatInfo, flags: GstVideo.VideoPackFlags, dest: Object, data: Object, stride: Number, x: Number, y: Number, width: Number): {
    // javascript wrapper for 'GstVideoFormatUnpack'
}

Unpacks width pixels from the given planes and strides containing data of format info. The pixels will be unpacked into dest with each component interleaved as per info's unpack_format, which will usually be one of GstVideo.VideoFormat.ARGB, GstVideo.VideoFormat.AYUV, GstVideo.VideoFormat.ARGB64 or GstVideo.VideoFormat.AYUV64 depending on the format to unpack. dest should at least be big enough to hold width * bytes_per_pixel bytes where bytes_per_pixel relates to the unpack format and will usually be either 4 or 8 depending on the unpack format. bytes_per_pixel will be the same as the pixel stride for plane 0 for the above formats.

For subsampled formats, the components will be duplicated in the destination array. Reconstruction of the missing components can be performed in a separate step after unpacking.

Parameters:

flags ( GstVideo.VideoPackFlags ) –

flags to control the unpacking

dest ( Object ) –

a destination array

data ( Object ) –

pointers to the data planes

stride ( Number ) –

strides of the planes

x ( Number ) –

the x position in the image to start from

y ( Number ) –

the y position in the image to start from

width ( Number ) –

the amount of pixels to unpack.


GstVideo.VideoFormatUnpack

def GstVideo.VideoFormatUnpack (info, flags, dest, data, stride, x, y, width):
    #python wrapper for 'GstVideoFormatUnpack'

Unpacks width pixels from the given planes and strides containing data of format info. The pixels will be unpacked into dest with each component interleaved as per info's unpack_format, which will usually be one of GstVideo.VideoFormat.ARGB, GstVideo.VideoFormat.AYUV, GstVideo.VideoFormat.ARGB64 or GstVideo.VideoFormat.AYUV64 depending on the format to unpack. dest should at least be big enough to hold width * bytes_per_pixel bytes where bytes_per_pixel relates to the unpack format and will usually be either 4 or 8 depending on the unpack format. bytes_per_pixel will be the same as the pixel stride for plane 0 for the above formats.

For subsampled formats, the components will be duplicated in the destination array. Reconstruction of the missing components can be performed in a separate step after unpacking.

Parameters:

flags ( GstVideo.VideoPackFlags ) –

flags to control the unpacking

dest ( object ) –

a destination array

data ( object ) –

pointers to the data planes

stride ( int ) –

strides of the planes

x ( int ) –

the x position in the image to start from

y ( int ) –

the y position in the image to start from

width ( int ) –

the amount of pixels to unpack.


The results of the search are