GstVideoFormatInfo

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.

Since : 1.18

gst_video_format_info_extrapolate_stride

gint
gst_video_format_info_extrapolate_stride (const GstVideoFormatInfo * finfo,
                                          gint plane,
                                          gint stride)

Extrapolate plane stride from the first stride of an image. This helper is useful to support legacy API were only one stride is supported.

Since : 1.22

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.

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.

gst_video_format_from_string

GstVideoFormat
gst_video_format_from_string (const gchar * format)

Convert the format string to its GstVideoFormat.

gst_video_format_get_info

const GstVideoFormatInfo *
gst_video_format_get_info (GstVideoFormat format)

Get the GstVideoFormatInfo 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.

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.

gst_video_format_to_string

const gchar *
gst_video_format_to_string (GstVideoFormat format)

Returns a string containing a descriptive name for the GstVideoFormat.

Since 1.26 this can also be used with GST_VIDEO_FORMAT_UNKNOWN, previous versions were printing a critical warning and returned NULL.

gst_video_formats_any

const GstVideoFormat *
gst_video_formats_any (guint * len)

Return all the raw video formats supported by GStreamer including special opaque formats such as GST_VIDEO_FORMAT_DMA_DRM for which no software conversion exists. This should be use for passthrough template cpas.

Since : 1.24

gst_video_formats_raw

const GstVideoFormat *
gst_video_formats_raw (guint * len)

Return all the raw video formats supported by GStreamer.

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.

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.

Since : 1.18

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.

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.

Since : 1.2

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) != 0)

GST_VIDEO_FORMAT_INFO_HAS_PALETTE

#define GST_VIDEO_FORMAT_INFO_HAS_PALETTE(info)  (((info)->flags & GST_VIDEO_FORMAT_FLAG_PALETTE) != 0)

GST_VIDEO_FORMAT_INFO_HAS_SUBTILES

#define GST_VIDEO_FORMAT_INFO_HAS_SUBTILES(info) (((info)->flags & GST_VIDEO_FORMAT_FLAG_SUBTILES) != 0)

This macro checks if GST_VIDEO_FORMAT_FLAG_SUBTILES is set. When this flag is set, it means that the tile sizes must be scaled as per the subsampling.

Since : 1.22

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) != 0)

GST_VIDEO_FORMAT_INFO_IS_GRAY

#define GST_VIDEO_FORMAT_INFO_IS_GRAY(info)      (((info)->flags & GST_VIDEO_FORMAT_FLAG_GRAY) != 0)

GST_VIDEO_FORMAT_INFO_IS_LE

#define GST_VIDEO_FORMAT_INFO_IS_LE(info)        (((info)->flags & GST_VIDEO_FORMAT_FLAG_LE) != 0)

GST_VIDEO_FORMAT_INFO_IS_RGB

#define GST_VIDEO_FORMAT_INFO_IS_RGB(info)       (((info)->flags & GST_VIDEO_FORMAT_FLAG_RGB) != 0)

GST_VIDEO_FORMAT_INFO_IS_TILED

#define GST_VIDEO_FORMAT_INFO_IS_TILED(info)     (((info)->flags & GST_VIDEO_FORMAT_FLAG_TILED) != 0)

GST_VIDEO_FORMAT_INFO_IS_VALID_RAW

#define GST_VIDEO_FORMAT_INFO_IS_VALID_RAW(info)              \
  (info != NULL && (info)->format > GST_VIDEO_FORMAT_ENCODED)

Tests that the given GstVideoFormatInfo represents a valid un-encoded format.

Since : 1.22

GST_VIDEO_FORMAT_INFO_IS_YUV

#define GST_VIDEO_FORMAT_INFO_IS_YUV(info)       (((info)->flags & GST_VIDEO_FORMAT_FLAG_YUV) != 0)

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.

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.

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.

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

GST_VIDEO_FORMAT_INFO_TILE_HEIGHT

#define GST_VIDEO_FORMAT_INFO_TILE_HEIGHT(info,plane) ((info)->tile_info[plane].height)

See height.

Returns the tile height.

Since : 1.22

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_SIZE

#define GST_VIDEO_FORMAT_INFO_TILE_SIZE(info,plane) ((info)->tile_info[plane].size)

Provides the size in bytes of a tile in the specified plane. This replaces the width and height shift, which was limited to power of two dimensions.

Since : 1.22

GST_VIDEO_FORMAT_INFO_TILE_STRIDE

#define GST_VIDEO_FORMAT_INFO_TILE_STRIDE(info,plane) ((info)->tile_info[plane].stride)

See stride.

Returns the stride of one tile, regardless of the internal details of the tile (could be a complex system with subtile) the tiles size should alway match the tile width multiplied by the tile stride.

Since : 1.22

GST_VIDEO_FORMAT_INFO_TILE_WIDTH

#define GST_VIDEO_FORMAT_INFO_TILE_WIDTH(info,plane) ((info)->tile_info[plane].width)

See width.

Return the width of one tile in pixels, zero if its not an integer.

Since : 1.22

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

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.

GstVideoFormatFlags

The different video flags that a format info can have.

GstVideoPackFlags

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

GST_VIDEO_COMP_A

#define GST_VIDEO_COMP_A  3

GST_VIDEO_COMP_B

#define GST_VIDEO_COMP_B  2

GST_VIDEO_COMP_G

#define GST_VIDEO_COMP_G  1

GST_VIDEO_COMP_INDEX

#define GST_VIDEO_COMP_INDEX    0

GST_VIDEO_COMP_PALETTE

#define GST_VIDEO_COMP_PALETTE  1

GST_VIDEO_COMP_R

#define GST_VIDEO_COMP_R  0

GST_VIDEO_COMP_U

#define GST_VIDEO_COMP_U  1

GST_VIDEO_COMP_V

#define GST_VIDEO_COMP_V  2

GST_VIDEO_COMP_Y

#define GST_VIDEO_COMP_Y  0

GST_VIDEO_FORMATS_ALL

#define GST_VIDEO_FORMATS_ALL "{ " GST_VIDEO_FORMATS_ALL_STR " }"

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_FORMATS_ALL_STR

#define GST_VIDEO_FORMATS_ALL_STR "A444_16BE, A444_16LE, AYUV64, ARGB64, " \
    "Y416_BE, RGBA64_BE, ARGB64_BE, BGRA64_BE, ABGR64_BE, Y416_LE, RGBA64_LE, " \
    "ARGB64_LE, BGRA64_LE, ABGR64_LE, A422_16BE, A422_16LE, A420_16BE, " \
    "A420_16LE, A444_12BE, GBRA_12BE, A444_12LE, GBRA_12LE, Y412_BE, Y412_LE, " \
    "A422_12BE, A422_12LE, A420_12BE, A420_12LE, A444_10BE, GBRA_10BE, " \
    "A444_10LE, GBRA_10LE, A422_10BE, A422_10LE, A420_10BE, A420_10LE, Y410, " \
    "BGR10A2_LE, RGB10A2_LE, A444, GBRA, AYUV, VUYA, RGBA, RBGA, ARGB, BGRA, " \
    "ABGR, A422, A420, AV12, Y444_16BE, GBR_16BE, Y444_16LE, GBR_16LE, " \
    "Y216_BE, v216, Y216_LE, 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, UYVP, v210, I420_10BE, " \
    "I420_10LE, P010_10BE, MT2110R, MT2110T, NV12_10BE_8L128, NV12_10LE40_4L4, " \
    "P010_10LE, NV12_10LE40, NV12_10LE32, Y444, BGRP, GBR, RGBP, NV24, v308, " \
    "IYU2, RGBx, xRGB, BGRx, xBGR, RGB, BGR, Y42B, NV16, NV61, YUY2, YVYU, " \
    "UYVY, VYUY, I420, YV12, NV12, NV21, NV12_16L32S, NV12_32L32, NV12_4L4, " \
    "NV12_64Z32, NV12_8L128, Y41B, IYU1, YUV9, YVU9, BGR16, RGB16, BGR15, " \
    "RGB15, RGB8P, GRAY16_BE, GRAY16_LE, GRAY10_LE16, GRAY10_LE32, GRAY8"

Declare all video formats as a string.

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

Since : 1.24

GST_VIDEO_FORMATS_ANY

#define GST_VIDEO_FORMATS_ANY "{ " GST_VIDEO_FORMATS_ANY_STR " }"

This is similar to GST_VIDEO_FORMATS_ALL but includes formats like DMA_DRM that do not have a software converter. This should be used for passthrough template caps.

Since : 1.24

GST_VIDEO_FORMATS_ANY_STR

#define GST_VIDEO_FORMATS_ANY_STR "DMA_DRM, " GST_VIDEO_FORMATS_ALL_STR

This is similar to GST_VIDEO_FORMATS_ALL_STR but includes formats like DMA_DRM for which no software converter exists. This should be used for passthrough template caps.

Since : 1.24

GST_VIDEO_FORMAT_LAST

#define GST_VIDEO_FORMAT_LAST (GST_VIDEO_FORMAT_GRAY10_LE16 + 1)

Number of video formats in GstVideoFormat.

Since : 1.26

GST_VIDEO_FPS_RANGE

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

GST_VIDEO_MAX_COMPONENTS

#define GST_VIDEO_MAX_COMPONENTS 4

GST_VIDEO_MAX_PLANES

#define GST_VIDEO_MAX_PLANES 4

GST_VIDEO_SIZE_RANGE

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

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.

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.