gstvideo.types

D types for gstvideo1 library

var BUFFER_POOL_OPTION_VIDEO_AFFINE_TRANSFORMATION_META BUFFER_POOL_OPTION_VIDEO_ALIGNMENT BUFFER_POOL_OPTION_VIDEO_GL_TEXTURE_UPLOAD_META BUFFER_POOL_OPTION_VIDEO_META CAPS_FEATURE_FORMAT_INTERLACED CAPS_FEATURE_META_GST_VIDEO_AFFINE_TRANSFORMATION_META CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META CAPS_FEATURE_META_GST_VIDEO_META CAPS_FEATURE_META_GST_VIDEO_OVERLAY_COMPOSITION META_TAG_VIDEO_COLORSPACE_STR META_TAG_VIDEO_ORIENTATION_STR META_TAG_VIDEO_SIZE_STR META_TAG_VIDEO_STR VIDEO_COLORIMETRY_BT2020 VIDEO_COLORIMETRY_BT2020_10 VIDEO_COLORIMETRY_BT2100_HLG VIDEO_COLORIMETRY_BT2100_PQ VIDEO_COLORIMETRY_BT601 VIDEO_COLORIMETRY_BT709 VIDEO_COLORIMETRY_SMPTE240M VIDEO_COLORIMETRY_SRGB VIDEO_COMP_A VIDEO_COMP_B VIDEO_COMP_G VIDEO_COMP_INDEX VIDEO_COMP_PALETTE VIDEO_COMP_R VIDEO_COMP_U VIDEO_COMP_V VIDEO_COMP_Y VIDEO_CONVERTER_OPT_ALPHA_MODE VIDEO_CONVERTER_OPT_ALPHA_VALUE VIDEO_CONVERTER_OPT_ASYNC_TASKS VIDEO_CONVERTER_OPT_BORDER_ARGB VIDEO_CONVERTER_OPT_CHROMA_MODE VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD VIDEO_CONVERTER_OPT_DEST_HEIGHT VIDEO_CONVERTER_OPT_DEST_WIDTH VIDEO_CONVERTER_OPT_DEST_X VIDEO_CONVERTER_OPT_DEST_Y VIDEO_CONVERTER_OPT_DITHER_METHOD VIDEO_CONVERTER_OPT_DITHER_QUANTIZATION VIDEO_CONVERTER_OPT_FILL_BORDER VIDEO_CONVERTER_OPT_GAMMA_MODE VIDEO_CONVERTER_OPT_MATRIX_MODE VIDEO_CONVERTER_OPT_PRIMARIES_MODE VIDEO_CONVERTER_OPT_RESAMPLER_METHOD VIDEO_CONVERTER_OPT_RESAMPLER_TAPS VIDEO_CONVERTER_OPT_SRC_HEIGHT VIDEO_CONVERTER_OPT_SRC_WIDTH VIDEO_CONVERTER_OPT_SRC_X VIDEO_CONVERTER_OPT_SRC_Y VIDEO_CONVERTER_OPT_THREADS VIDEO_DECODER_MAX_ERRORS VIDEO_DECODER_SINK_NAME VIDEO_DECODER_SRC_NAME VIDEO_DMA_DRM_CAPS_MAKE VIDEO_ENCODER_SINK_NAME VIDEO_ENCODER_SRC_NAME VIDEO_FORMATS_ALL VIDEO_FORMATS_ALL_STR VIDEO_FORMATS_ANY VIDEO_FORMATS_ANY_STR VIDEO_FPS_RANGE VIDEO_MAX_COMPONENTS VIDEO_MAX_PLANES VIDEO_RESAMPLER_OPT_CUBIC_B VIDEO_RESAMPLER_OPT_CUBIC_C VIDEO_RESAMPLER_OPT_ENVELOPE VIDEO_RESAMPLER_OPT_MAX_TAPS VIDEO_RESAMPLER_OPT_SHARPEN VIDEO_RESAMPLER_OPT_SHARPNESS VIDEO_SCALER_OPT_DITHER_METHOD VIDEO_SIZE_RANGE VIDEO_TILE_TYPE_MASK VIDEO_TILE_TYPE_SHIFT VIDEO_TILE_X_TILES_MASK VIDEO_TILE_Y_TILES_SHIFT

Types 58

Variables 78

enumvarBUFFER_POOL_OPTION_VIDEO_AFFINE_TRANSFORMATION_META = "GstBufferPoolOptionVideoAffineTransformation"
enumvarBUFFER_POOL_OPTION_VIDEO_ALIGNMENT = "GstBufferPoolOptionVideoAlignment"

A bufferpool option to enable extra padding. When a bufferpool supports this option, [gstvideo.global.bufferPoolConfigSetVideoAlignment] can be called.

When this option is enabled on the bufferpool, #GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled.

enumvarBUFFER_POOL_OPTION_VIDEO_GL_TEXTURE_UPLOAD_META = "GstBufferPoolOptionVideoGLTextureUploadMeta"

An option that can be activated on a bufferpool to request gl texture upload meta on buffers from the pool.

When this option is enabled on the bufferpool, @GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled.

enumvarBUFFER_POOL_OPTION_VIDEO_META = "GstBufferPoolOptionVideoMeta"

An option that can be activated on bufferpool to request video metadata on buffers from the pool.

enumvarCAPS_FEATURE_FORMAT_INTERLACED = "format:Interlaced"

Name of the caps feature indicating that the stream is interlaced.

Currently it is only used for video with 'interlace-mode=alternate' to ensure backwards compatibility for this new mode. In this mode each buffer carries a single field of interlaced video. @GST_VIDEO_BUFFER_FLAG_TOP_FIELD and @GST_VIDEO_BUFFER_FLAG_BOTTOM_FIELD indicate whether the buffer carries a top or bottom field. The order of buffers/fields in the stream and the timestamps on the buffers indicate the temporal order of the fields. Top and bottom fields are expected to alternate in this mode. The frame rate in the caps still signals the frame rate, so the notional field rate will be twice the frame rate from the caps (see @GST_VIDEO_INFO_FIELD_RATE_N).

enumvarCAPS_FEATURE_META_GST_VIDEO_AFFINE_TRANSFORMATION_META = "meta:GstVideoAffineTransformation"
enumvarCAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META = "meta:GstVideoGLTextureUploadMeta"
enumvarCAPS_FEATURE_META_GST_VIDEO_META = "meta:GstVideoMeta"
enumvarCAPS_FEATURE_META_GST_VIDEO_OVERLAY_COMPOSITION = "meta:GstVideoOverlayComposition"
enumvarMETA_TAG_VIDEO_COLORSPACE_STR = "colorspace"

This metadata stays relevant as long as video colorspace is unchanged.

enumvarMETA_TAG_VIDEO_ORIENTATION_STR = "orientation"

This metadata stays relevant as long as video orientation is unchanged.

enumvarMETA_TAG_VIDEO_SIZE_STR = "size"

This metadata stays relevant as long as video size is unchanged.

enumvarMETA_TAG_VIDEO_STR = "video"

This metadata is relevant for video streams.

enumvarVIDEO_COLORIMETRY_BT2020 = "bt2020"
enumvarVIDEO_COLORIMETRY_BT2020_10 = "bt2020-10"
enumvarVIDEO_COLORIMETRY_BT2100_HLG = "bt2100-hlg"
enumvarVIDEO_COLORIMETRY_BT2100_PQ = "bt2100-pq"
enumvarVIDEO_COLORIMETRY_BT601 = "bt601"
enumvarVIDEO_COLORIMETRY_BT709 = "bt709"
enumvarVIDEO_COLORIMETRY_SMPTE240M = "smpte240m"
enumvarVIDEO_COLORIMETRY_SRGB = "sRGB"
enumvarVIDEO_COMP_A = 3
enumvarVIDEO_COMP_B = 2
enumvarVIDEO_COMP_G = 1
enumvarVIDEO_COMP_INDEX = 0
enumvarVIDEO_COMP_PALETTE = 1
enumvarVIDEO_COMP_R = 0
enumvarVIDEO_COMP_U = 1
enumvarVIDEO_COMP_V = 2
enumvarVIDEO_COMP_Y = 0
enumvarVIDEO_CONVERTER_OPT_ALPHA_MODE = "GstVideoConverter.alpha-mode"

#GstVideoAlphaMode, the alpha mode to use. Default is #GST_VIDEO_ALPHA_MODE_COPY.

enumvarVIDEO_CONVERTER_OPT_ALPHA_VALUE = "GstVideoConverter.alpha-value"

#G_TYPE_DOUBLE, the alpha color value to use. Default to 1.0

enumvarVIDEO_CONVERTER_OPT_ASYNC_TASKS = "GstVideoConverter.async-tasks"

#G_TYPE_BOOLEAN, whether [gstvideo.video_converter.VideoConverter.frame] will return immediately without waiting for the conversion to complete. A subsequent [gstvideo.video_converter.VideoConverter.frameFinish] must be performed to ensure completion of the conversion before subsequent use. Default false

enumvarVIDEO_CONVERTER_OPT_BORDER_ARGB = "GstVideoConverter.border-argb"

#G_TYPE_UINT, the border color to use if #GST_VIDEO_CONVERTER_OPT_FILL_BORDER is set to true. The color is in ARGB format. Default 0xff000000

enumvarVIDEO_CONVERTER_OPT_CHROMA_MODE = "GstVideoConverter.chroma-mode"

#GstVideoChromaMode, set the chroma resample mode subsampled formats. Default is #GST_VIDEO_CHROMA_MODE_FULL.

enumvarVIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD = "GstVideoConverter.chroma-resampler-method"

#GstVideoChromaMethod, The resampler method to use for chroma resampling. Other options for the resampler can be used, see the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_LINEAR

enumvarVIDEO_CONVERTER_OPT_DEST_HEIGHT = "GstVideoConverter.dest-height"

#G_TYPE_INT, height in the destination frame, default destination height

enumvarVIDEO_CONVERTER_OPT_DEST_WIDTH = "GstVideoConverter.dest-width"

#G_TYPE_INT, width in the destination frame, default destination width

enumvarVIDEO_CONVERTER_OPT_DEST_X = "GstVideoConverter.dest-x"

#G_TYPE_INT, x position in the destination frame, default 0

enumvarVIDEO_CONVERTER_OPT_DEST_Y = "GstVideoConverter.dest-y"

#G_TYPE_INT, y position in the destination frame, default 0

enumvarVIDEO_CONVERTER_OPT_DITHER_METHOD = "GstVideoConverter.dither-method"

#GstVideoDitherMethod, The dither method to use when changing bit depth. Default is #GST_VIDEO_DITHER_BAYER.

enumvarVIDEO_CONVERTER_OPT_DITHER_QUANTIZATION = "GstVideoConverter.dither-quantization"

#G_TYPE_UINT, The quantization amount to dither to. Components will be quantized to multiples of this value. Default is 1

enumvarVIDEO_CONVERTER_OPT_FILL_BORDER = "GstVideoConverter.fill-border"

#G_TYPE_BOOLEAN, if the destination rectangle does not fill the complete destination image, render a border with #GST_VIDEO_CONVERTER_OPT_BORDER_ARGB. Otherwise the unusded pixels in the destination are untouched. Default true.

enumvarVIDEO_CONVERTER_OPT_GAMMA_MODE = "GstVideoConverter.gamma-mode"

#GstVideoGammaMode, set the gamma mode. Default is #GST_VIDEO_GAMMA_MODE_NONE.

enumvarVIDEO_CONVERTER_OPT_MATRIX_MODE = "GstVideoConverter.matrix-mode"

#GstVideoMatrixMode, set the color matrix conversion mode for converting between Y'PbPr and non-linear RGB (R'G'B'). Default is #GST_VIDEO_MATRIX_MODE_FULL.

enumvarVIDEO_CONVERTER_OPT_PRIMARIES_MODE = "GstVideoConverter.primaries-mode"

#GstVideoPrimariesMode, set the primaries conversion mode. Default is #GST_VIDEO_PRIMARIES_MODE_NONE.

enumvarVIDEO_CONVERTER_OPT_RESAMPLER_METHOD = "GstVideoConverter.resampler-method"

#GstVideoResamplerMethod, The resampler method to use for resampling. Other options for the resampler can be used, see the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_CUBIC

enumvarVIDEO_CONVERTER_OPT_RESAMPLER_TAPS = "GstVideoConverter.resampler-taps"

#G_TYPE_UINT, The number of taps for the resampler. Default is 0: let the resampler choose a good value.

enumvarVIDEO_CONVERTER_OPT_SRC_HEIGHT = "GstVideoConverter.src-height"

#G_TYPE_INT, source height to convert, default source height

enumvarVIDEO_CONVERTER_OPT_SRC_WIDTH = "GstVideoConverter.src-width"

#G_TYPE_INT, source width to convert, default source width

enumvarVIDEO_CONVERTER_OPT_SRC_X = "GstVideoConverter.src-x"

#G_TYPE_INT, source x position to start conversion, default 0

enumvarVIDEO_CONVERTER_OPT_SRC_Y = "GstVideoConverter.src-y"

#G_TYPE_INT, source y position to start conversion, default 0

enumvarVIDEO_CONVERTER_OPT_THREADS = "GstVideoConverter.threads"

#G_TYPE_UINT, maximum number of threads to use. Default 1, 0 for the number of cores.

enumvarVIDEO_DECODER_MAX_ERRORS = - 1

Default maximum number of errors tolerated before signaling error.

enumvarVIDEO_DECODER_SINK_NAME = "sink"

The name of the templates for the sink pad.

enumvarVIDEO_DECODER_SRC_NAME = "src"

The name of the templates for the source pad.

enumvarVIDEO_DMA_DRM_CAPS_MAKE = "video/x-raw(memory:DMABuf), format = (string) DMA_DRM, width = "

Generic caps string for video wit DMABuf(GST_CAPS_FEATURE_MEMORY_DMABUF) feature, for use in pad templates. As drm-format is supposed to be defined at run-time it's not predefined here.

enumvarVIDEO_ENCODER_SINK_NAME = "sink"

The name of the templates for the sink pad.

enumvarVIDEO_ENCODER_SRC_NAME = "src"

The name of the templates for the source pad.

enumvarVIDEO_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
enumvarVIDEO_FORMATS_ALL_STR = "A444_16BE, A444_16LE, AYUV64, ARGB64, RGBA64_BE, ARGB64_BE, BGRA64_BE, ABGR64_BE, 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, BGR10A2_LE, Y410, RGB10A2_LE, A444, GBRA, AYUV, VUYA, RGBA, RBGA, ARGB, BGRA, ABGR, A422, A420, AV12, Y444_16BE, GBR_16BE, Y444_16LE, GBR_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, 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_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
enumvarVIDEO_FORMATS_ANY = "{ "

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

enumvarVIDEO_FORMATS_ANY_STR = "DMA_DRM, "

This is similar to [gstvideo.types.VIDEO_FORMATS_ALL_STR] but includes formats like DMA_DRM for which no software converter exists. This should be used for passthrough template caps.

enumvarVIDEO_FPS_RANGE = "(fraction) [ 0, max ]"
enumvarVIDEO_MAX_COMPONENTS = 4
enumvarVIDEO_MAX_PLANES = 4
enumvarVIDEO_RESAMPLER_OPT_CUBIC_B = "GstVideoResampler.cubic-b"

G_TYPE_DOUBLE, B parameter of the cubic filter. The B parameter controls the bluriness. Values between 0.0 and 2.0 are accepted. 1/3 is the default.

Below are some values of popular filters: B C Hermite 0.0 0.0 Spline 1.0 0.0 Catmull-Rom 0.0 1/2 Mitchell 1/3 1/3 Robidoux 0.3782 0.3109 Robidoux Sharp 0.2620 0.3690 Robidoux Soft 0.6796 0.1602

enumvarVIDEO_RESAMPLER_OPT_CUBIC_C = "GstVideoResampler.cubic-c"

G_TYPE_DOUBLE, C parameter of the cubic filter. The C parameter controls the Keys alpha value. Values between 0.0 and 2.0 are accepted. 1/3 is the default.

See #GST_VIDEO_RESAMPLER_OPT_CUBIC_B for some more common values

enumvarVIDEO_RESAMPLER_OPT_ENVELOPE = "GstVideoResampler.envelope"

G_TYPE_DOUBLE, specifies the size of filter envelope for @GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between 1.0 and 5.0. 2.0 is the default.

enumvarVIDEO_RESAMPLER_OPT_MAX_TAPS = "GstVideoResampler.max-taps"

G_TYPE_INT, limits the maximum number of taps to use. 16 is the default.

enumvarVIDEO_RESAMPLER_OPT_SHARPEN = "GstVideoResampler.sharpen"

G_TYPE_DOUBLE, specifies sharpening of the filter for @GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between 0.0 and 1.0. 0.0 is the default.

enumvarVIDEO_RESAMPLER_OPT_SHARPNESS = "GstVideoResampler.sharpness"

G_TYPE_DOUBLE, specifies sharpness of the filter for @GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between 0.5 and 1.5. 1.0 is the default.

enumvarVIDEO_SCALER_OPT_DITHER_METHOD = "GstVideoScaler.dither-method"

#GstVideoDitherMethod, The dither method to use for propagating quatization errors.

enumvarVIDEO_SIZE_RANGE = "(int) [ 1, max ]"
enumvarVIDEO_TILE_TYPE_MASK = 65535
enumvarVIDEO_TILE_TYPE_SHIFT = 16
enumvarVIDEO_TILE_X_TILES_MASK = 65535
enumvarVIDEO_TILE_Y_TILES_SHIFT = 16