gstvideo

gstvideo — Support library for video operations

Functions

#define GST_VIDEO_CAPS_YUV()
#define GST_VIDEO_CAPS_GRAY16()
gboolean gst_video_calculate_display_ratio ()
const GValue * gst_video_frame_rate ()
gboolean gst_video_get_size ()
gboolean gst_video_get_size_from_caps ()
gboolean gst_video_format_convert ()
GstCaps * gst_video_format_new_caps ()
GstCaps * gst_video_format_new_caps_interlaced ()
GstCaps * gst_video_format_new_template_caps ()
int gst_video_format_get_component_height ()
int gst_video_format_get_component_offset ()
int gst_video_format_get_component_width ()
int gst_video_format_get_component_depth ()
int gst_video_format_get_pixel_stride ()
int gst_video_format_get_row_stride ()
int gst_video_format_get_size ()
gboolean gst_video_format_has_alpha ()
gboolean gst_video_format_is_rgb ()
gboolean gst_video_format_is_gray ()
gboolean gst_video_format_is_yuv ()
guint32 gst_video_format_to_fourcc ()
GstVideoFormat gst_video_format_from_fourcc ()
gboolean gst_video_format_parse_caps ()
gboolean gst_video_format_parse_caps_interlaced ()
gboolean gst_video_parse_caps_framerate ()
gboolean gst_video_parse_caps_pixel_aspect_ratio ()
const char * gst_video_parse_caps_color_matrix ()
const char * gst_video_parse_caps_chroma_site ()
GstBuffer * gst_video_parse_caps_palette ()
void (*GstVideoConvertFrameCallback) ()
GstBuffer * gst_video_convert_frame ()
void gst_video_convert_frame_async ()
GstEvent * gst_video_event_new_still_frame ()
gboolean gst_video_event_parse_still_frame ()
GstEvent * gst_video_event_new_upstream_force_key_unit ()
GstEvent * gst_video_event_new_downstream_force_key_unit ()
gboolean gst_video_event_is_force_key_unit ()
gboolean gst_video_event_parse_upstream_force_key_unit ()
gboolean gst_video_event_parse_downstream_force_key_unit ()

Types and Values

#define GST_VIDEO_BLUE_MASK_15
#define GST_VIDEO_BLUE_MASK_15_INT
#define GST_VIDEO_BLUE_MASK_16
#define GST_VIDEO_BLUE_MASK_16_INT
#define GST_VIDEO_BYTE1_MASK_24
#define GST_VIDEO_BYTE1_MASK_24_INT
#define GST_VIDEO_BYTE1_MASK_32
#define GST_VIDEO_BYTE1_MASK_32_INT
#define GST_VIDEO_BYTE2_MASK_24
#define GST_VIDEO_BYTE2_MASK_24_INT
#define GST_VIDEO_BYTE2_MASK_32
#define GST_VIDEO_BYTE2_MASK_32_INT
#define GST_VIDEO_BYTE3_MASK_24
#define GST_VIDEO_BYTE3_MASK_24_INT
#define GST_VIDEO_BYTE3_MASK_32
#define GST_VIDEO_BYTE3_MASK_32_INT
#define GST_VIDEO_BYTE4_MASK_32
#define GST_VIDEO_BYTE4_MASK_32_INT
#define GST_VIDEO_CAPS_ABGR
#define GST_VIDEO_CAPS_ARGB
#define GST_VIDEO_CAPS_BGR
#define GST_VIDEO_CAPS_BGRA
#define GST_VIDEO_CAPS_BGRx
#define GST_VIDEO_CAPS_BGRx_HOST_ENDIAN
#define GST_VIDEO_CAPS_RGB
#define GST_VIDEO_CAPS_RGBA
#define GST_VIDEO_CAPS_RGB_15
#define GST_VIDEO_CAPS_RGB_16
#define GST_VIDEO_CAPS_RGBx
#define GST_VIDEO_CAPS_xBGR
#define GST_VIDEO_CAPS_xRGB
#define GST_VIDEO_CAPS_xRGB_HOST_ENDIAN
#define GST_VIDEO_CAPS_BGR_15
#define GST_VIDEO_CAPS_BGR_16
#define GST_VIDEO_CAPS_RGB8_PALETTED
#define GST_VIDEO_CAPS_GRAY8
#define GST_VIDEO_CAPS_ARGB_64
#define GST_VIDEO_CAPS_r210
#define GST_VIDEO_COMP1_MASK_15
#define GST_VIDEO_COMP1_MASK_15_INT
#define GST_VIDEO_COMP1_MASK_16
#define GST_VIDEO_COMP1_MASK_16_INT
#define GST_VIDEO_COMP2_MASK_15
#define GST_VIDEO_COMP2_MASK_15_INT
#define GST_VIDEO_COMP2_MASK_16
#define GST_VIDEO_COMP2_MASK_16_INT
#define GST_VIDEO_COMP3_MASK_15
#define GST_VIDEO_COMP3_MASK_15_INT
#define GST_VIDEO_COMP3_MASK_16
#define GST_VIDEO_COMP3_MASK_16_INT
#define GST_VIDEO_FPS_RANGE
#define GST_VIDEO_GREEN_MASK_15
#define GST_VIDEO_GREEN_MASK_15_INT
#define GST_VIDEO_GREEN_MASK_16
#define GST_VIDEO_GREEN_MASK_16_INT
#define GST_VIDEO_RED_MASK_15
#define GST_VIDEO_RED_MASK_15_INT
#define GST_VIDEO_RED_MASK_16
#define GST_VIDEO_RED_MASK_16_INT
#define GST_VIDEO_SIZE_RANGE
#define GST_VIDEO_BUFFER_TFF
#define GST_VIDEO_BUFFER_RFF
#define GST_VIDEO_BUFFER_ONEFIELD
#define GST_VIDEO_BUFFER_PROGRESSIVE
enum GstVideoFormat

Includes

#include <gst/video/video.h>

Description

This library contains some helper functions and includes the videosink and videofilter base classes.

Functions

GST_VIDEO_CAPS_YUV()

#define             GST_VIDEO_CAPS_YUV(fourcc)

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

Parameters

fourcc

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

 

GST_VIDEO_CAPS_GRAY16()

#define             GST_VIDEO_CAPS_GRAY16(endianness)

Generic caps string for 16-bit grayscale video, for use in pad templates.

Parameters

endianness

endianness as string, ie. either "1234", "4321", "BIG_ENDIAN" or "LITTLE_ENDIAN"

 

Since 0.10.29


gst_video_calculate_display_ratio ()

gboolean
gst_video_calculate_display_ratio (guint *dar_n,
                                   guint *dar_d,
                                   guint video_width,
                                   guint video_height,
                                   guint video_par_n,
                                   guint video_par_d,
                                   guint display_par_n,
                                   guint display_par_d);

Given the Pixel Aspect Ratio and size of an input video frame, and the pixel aspect ratio of the intended display device, calculates the actual display ratio the video will be rendered with.

Parameters

dar_n

Numerator of the calculated display_ratio

 

dar_d

Denominator of the calculated display_ratio

 

video_width

Width of the video frame in pixels

 

video_height

Height of the video frame in pixels

 

video_par_n

Numerator of the pixel aspect ratio of the input video.

 

video_par_d

Denominator of the pixel aspect ratio of the input video.

 

display_par_n

Numerator of the pixel aspect ratio of the display device

 

display_par_d

Denominator of the pixel aspect ratio of the display device

 

Returns

A boolean indicating success and a calculated Display Ratio in the dar_n and dar_d parameters. The return value is FALSE in the case of integer overflow or other error.

Since 0.10.7


gst_video_frame_rate ()

const GValue *
gst_video_frame_rate (GstPad *pad);

A convenience function to retrieve a GValue holding the framerate from the caps on a pad.

The pad needs to have negotiated caps containing a framerate property.

Parameters

pad

pointer to a GstPad

 

Returns

NULL if the pad has no configured caps or the configured caps do not contain a framerate.


gst_video_get_size ()

gboolean
gst_video_get_size (GstPad *pad,
                    gint *width,
                    gint *height);

Inspect the caps of the provided pad and retrieve the width and height of the video frames it is configured for.

The pad needs to have negotiated caps containing width and height properties.

Parameters

pad

pointer to a GstPad

 

width

pointer to integer to hold pixel width of the video frames (output)

 

height

pointer to integer to hold pixel height of the video frames (output)

 

Returns

TRUE if the width and height could be retrieved.


gst_video_get_size_from_caps ()

gboolean
gst_video_get_size_from_caps (const GstCaps *caps,
                              gint *size);

Calculates the total number of bytes in the raw video format for the given caps. This number should be used when allocating a buffer for raw video.

Parameters

caps

a pointer to GstCaps

 

size

a pointer to a gint that will be assigned the size (in bytes) of a video frame with the given caps

 

Returns

TRUE if the size could be calculated from the caps

Since 0.10.36


gst_video_format_convert ()

gboolean
gst_video_format_convert (GstVideoFormat format,
                          int width,
                          int height,
                          int fps_n,
                          int fps_d,
                          GstFormat src_format,
                          gint64 src_value,
                          GstFormat dest_format,
                          gint64 *dest_value);

Converts among various GstFormat types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw video, GST_FORMAT_DEFAULT corresponds to video frames. This function can be to handle pad queries of the type GST_QUERY_CONVERT.

Parameters

format

a GstVideoFormat

 

width

the width of video

 

height

the height of video

 

fps_n

frame rate numerator

 

fps_d

frame rate denominator

 

src_format

GstFormat of the src_value

 

src_value

value to convert

 

dest_format

GstFormat of the dest_value

 

dest_value

pointer to destination value

 

Returns

TRUE if the conversion was successful.

Since 0.10.16


gst_video_format_new_caps ()

GstCaps *
gst_video_format_new_caps (GstVideoFormat format,
                           int width,
                           int height,
                           int framerate_n,
                           int framerate_d,
                           int par_n,
                           int par_d);

Creates a new GstCaps object based on the parameters provided.

Parameters

format

the GstVideoFormat describing the raw video format

 

width

width of video

 

height

height of video

 

framerate_n

numerator of frame rate

 

framerate_d

denominator of frame rate

 

par_n

numerator of pixel aspect ratio

 

par_d

denominator of pixel aspect ratio

 

Returns

a new GstCaps object, or NULL if there was an error

Since 0.10.16


gst_video_format_new_caps_interlaced ()

GstCaps *
gst_video_format_new_caps_interlaced (GstVideoFormat format,
                                      int width,
                                      int height,
                                      int framerate_n,
                                      int framerate_d,
                                      int par_n,
                                      int par_d,
                                      gboolean interlaced);

Creates a new GstCaps object based on the parameters provided.

Parameters

format

the GstVideoFormat describing the raw video format

 

width

width of video

 

height

height of video

 

framerate_n

numerator of frame rate

 

framerate_d

denominator of frame rate

 

par_n

numerator of pixel aspect ratio

 

par_d

denominator of pixel aspect ratio

 

interlaced

TRUE if the format is interlaced

 

Returns

a new GstCaps object, or NULL if there was an error

Since 0.10.23


gst_video_format_new_template_caps ()

GstCaps *
gst_video_format_new_template_caps (GstVideoFormat format);

Creates a new GstCaps object based on the parameters provided. Size, frame rate, and pixel aspect ratio are set to the full range.

Parameters

format

the GstVideoFormat describing the raw video format

 

Returns

a new GstCaps object, or NULL if there was an error

Since 0.10.33


gst_video_format_get_component_height ()

int
gst_video_format_get_component_height (GstVideoFormat format,
                                       int component,
                                       int height);

Calculates the height of the component. See gst_video_format_get_row_stride for a description of the component index.

Parameters

format

a GstVideoFormat

 

component

the component index

 

height

the height of video

 

Returns

height of component component

Since 0.10.16


gst_video_format_get_component_offset ()

int
gst_video_format_get_component_offset (GstVideoFormat format,
                                       int component,
                                       int width,
                                       int height);

Calculates the offset (in bytes) of the first pixel of the component with index component . For packed formats, this will typically be a small integer (0, 1, 2, 3). For planar formats, this will be a (relatively) large offset to the beginning of the second or third component planes. See gst_video_format_get_row_stride for a description of the component index.

Parameters

format

a GstVideoFormat

 

component

the component index

 

width

the width of video

 

height

the height of video

 

Returns

offset of component component

Since 0.10.16


gst_video_format_get_component_width ()

int
gst_video_format_get_component_width (GstVideoFormat format,
                                      int component,
                                      int width);

Calculates the width of the component. See gst_video_format_get_row_stride for a description of the component index.

Parameters

format

a GstVideoFormat

 

component

the component index

 

width

the width of video

 

Returns

width of component component

Since 0.10.16


gst_video_format_get_component_depth ()

int
gst_video_format_get_component_depth (GstVideoFormat format,
                                      int component);

Returns the number of bits used to encode an individual pixel of a given component . Typically this is 8, although higher and lower values are possible for some formats.

Parameters

format

a GstVideoFormat

 

component

the video component (e.g. 0 for 'R' in RGB)

 

Returns

depth of component

Since 0.10.33


gst_video_format_get_pixel_stride ()

int
gst_video_format_get_pixel_stride (GstVideoFormat format,
                                   int component);

Calculates the pixel stride (number of bytes from one pixel to the pixel to its immediate left) for the video component with an index of component . See gst_video_format_get_row_stride for a description of the component index.

Parameters

format

a GstVideoFormat

 

component

the component index

 

Returns

pixel stride of component component

Since 0.10.16


gst_video_format_get_row_stride ()

int
gst_video_format_get_row_stride (GstVideoFormat format,
                                 int component,
                                 int width);

Calculates the row stride (number of bytes from one row of pixels to the next) for the video component with an index of component . For YUV video, Y, U, and V have component indices of 0, 1, and 2, respectively. For RGB video, R, G, and B have component indicies of 0, 1, and 2, respectively. Alpha channels, if present, have a component index of 3. The width parameter always represents the width of the video, not the component.

Parameters

format

a GstVideoFormat

 

component

the component index

 

width

the width of video

 

Returns

row stride of component component

Since 0.10.16


gst_video_format_get_size ()

int
gst_video_format_get_size (GstVideoFormat format,
                           int width,
                           int height);

Calculates the total number of bytes in the raw video format. This number should be used when allocating a buffer for raw video.

Parameters

format

a GstVideoFormat

 

width

the width of video

 

height

the height of video

 

Returns

size (in bytes) of raw video format

Since 0.10.16


gst_video_format_has_alpha ()

gboolean
gst_video_format_has_alpha (GstVideoFormat format);

Returns TRUE or FALSE depending on if the video format provides an alpha channel.

Parameters

format

a GstVideoFormat

 

Returns

TRUE if format has an alpha channel

Since 0.10.16


gst_video_format_is_rgb ()

gboolean
gst_video_format_is_rgb (GstVideoFormat format);

Determine whether the video format is an RGB format.

Parameters

format

a GstVideoFormat

 

Returns

TRUE if format represents RGB video

Since 0.10.16


gst_video_format_is_gray ()

gboolean
gst_video_format_is_gray (GstVideoFormat format);

Determine whether the video format is a grayscale format.

Parameters

format

a GstVideoFormat

 

Returns

TRUE if format represents grayscale video

Since 0.10.29


gst_video_format_is_yuv ()

gboolean
gst_video_format_is_yuv (GstVideoFormat format);

Determine whether the video format is a YUV format.

Parameters

format

a GstVideoFormat

 

Returns

TRUE if format represents YUV video

Since 0.10.16


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

Since 0.10.16


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

Since 0.10.16


gst_video_format_parse_caps ()

gboolean
gst_video_format_parse_caps (const GstCaps *caps,
                             GstVideoFormat *format,
                             int *width,
                             int *height);

Determines the GstVideoFormat of caps and places it in the location pointed to by format . Extracts the size of the video and places it in the location pointed to by width and height . If caps does not represent a video format or does not contain height and width, the function will fail and return FALSE. If caps does not represent a raw video format listed in GstVideoFormat, but still contains video caps, this function will return TRUE and set format to GST_VIDEO_FORMAT_UNKNOWN.

Parameters

caps

the GstCaps to parse

 

format

the GstVideoFormat of the video represented by caps (output)

 

width

the width of the video represented by caps , may be NULL (output)

 

height

the height of the video represented by caps , may be NULL (output)

 

Returns

TRUE if caps was parsed correctly.

Since 0.10.16


gst_video_format_parse_caps_interlaced ()

gboolean
gst_video_format_parse_caps_interlaced
                               (GstCaps *caps,
                                gboolean *interlaced);

Extracts whether the caps represents interlaced content or not and places it in interlaced .

Parameters

caps

the fixed GstCaps to parse

 

interlaced

whether caps represents interlaced video or not, may be NULL (output)

 

Returns

TRUE if caps was parsed correctly.

Since 0.10.23


gst_video_parse_caps_framerate ()

gboolean
gst_video_parse_caps_framerate (GstCaps *caps,
                                int *fps_n,
                                int *fps_d);

Extracts the frame rate from caps and places the values in the locations pointed to by fps_n and fps_d . Returns TRUE if the values could be parsed correctly, FALSE if not.

This function can be used with GstCaps that have any media type; it is not limited to formats handled by GstVideoFormat.

Parameters

caps

pointer to a GstCaps instance

 

fps_n

pointer to integer to hold numerator of frame rate (output)

 

fps_d

pointer to integer to hold denominator of frame rate (output)

 

Returns

TRUE if caps was parsed correctly.

Since 0.10.16


gst_video_parse_caps_pixel_aspect_ratio ()

gboolean
gst_video_parse_caps_pixel_aspect_ratio
                               (GstCaps *caps,
                                int *par_n,
                                int *par_d);

Extracts the pixel aspect ratio from caps and places the values in the locations pointed to by par_n and par_d . Returns TRUE if the values could be parsed correctly, FALSE if not.

This function can be used with GstCaps that have any media type; it is not limited to formats handled by GstVideoFormat.

Parameters

caps

pointer to a GstCaps instance

 

par_n

pointer to numerator of pixel aspect ratio (output)

 

par_d

pointer to denominator of pixel aspect ratio (output)

 

Returns

TRUE if caps was parsed correctly.

Since 0.10.16


gst_video_parse_caps_color_matrix ()

const char *
gst_video_parse_caps_color_matrix (GstCaps *caps);

Extracts the color matrix used by the caps. Possible values are "sdtv" for the standard definition color matrix (as specified in Rec. ITU-R BT.470-6) or "hdtv" for the high definition color matrix (as specified in Rec. ITU-R BT.709)

Parameters

caps

the fixed GstCaps to parse

 

Returns

a color matrix string, or NULL if no color matrix could be determined.

Since 0.10.29


gst_video_parse_caps_chroma_site ()

const char *
gst_video_parse_caps_chroma_site (GstCaps *caps);

Extracts the chroma site used by the caps. Possible values are "mpeg2" for MPEG-2 style chroma siting (co-sited horizontally, halfway-sited vertically), "jpeg" for JPEG and Theora style chroma siting (halfway-sited both horizontally and vertically). Other chroma site values are possible, but uncommon.

When no chroma site is specified in the caps, it should be assumed to be "mpeg2".

Parameters

caps

the fixed GstCaps to parse

 

Returns

a chroma site string, or NULL if no chroma site could be determined.

Since 0.10.29


gst_video_parse_caps_palette ()

GstBuffer *
gst_video_parse_caps_palette (GstCaps *caps);

Returns the palette data from the caps as a GstBuffer. For GST_VIDEO_FORMAT_RGB8_PALETTED this is containing 256 guint32 values, each containing ARGB colors in native endianness.

Parameters

caps

GstCaps to parse

 

Returns

a GstBuffer containing the palette data. Unref after usage.

Since 0.10.32


GstVideoConvertFrameCallback ()

void
(*GstVideoConvertFrameCallback) (GstBuffer *buf,
                                 GError *error,
                                 gpointer user_data);

gst_video_convert_frame ()

GstBuffer *
gst_video_convert_frame (GstBuffer *buf,
                         const GstCaps *to_caps,
                         GstClockTime timeout,
                         GError **error);

Converts a raw video buffer into the specified output caps.

The output caps can be any raw video formats or any image formats (jpeg, png, ...).

The width, height and pixel-aspect-ratio can also be specified in the output caps.

Parameters

buf

a GstBuffer

 

to_caps

the GstCaps to convert to

 

timeout

the maximum amount of time allowed for the processing.

 

error

pointer to a GError. Can be NULL.

 

Returns

The converted GstBuffer, or NULL if an error happened (in which case err will point to the GError).

Since 0.10.31


gst_video_convert_frame_async ()

void
gst_video_convert_frame_async (GstBuffer *buf,
                               const GstCaps *to_caps,
                               GstClockTime timeout,
                               GstVideoConvertFrameCallback callback,
                               gpointer user_data,
                               GDestroyNotify destroy_notify);

Converts a raw video buffer into the specified output caps.

The output caps can be any raw video formats or any image formats (jpeg, png, ...).

The width, height and pixel-aspect-ratio can also be specified in the output caps.

callback will be called after conversion, when an error occured or if conversion didn't finish after timeout . callback will always be called from the thread default GMainContext, see g_main_context_get_thread_default(). If GLib before 2.22 is used, this will always be the global default main context.

destroy_notify will be called after the callback was called and user_data is not needed anymore.

Parameters

buf

a GstBuffer

 

to_caps

the GstCaps to convert to

 

timeout

the maximum amount of time allowed for the processing.

 

callback

GstVideoConvertFrameCallback that will be called after conversion.

 

user_data

extra data that will be passed to the callback

 

destroy_notify

GDestroyNotify to be called after user_data is not needed anymore

 

Since 0.10.31


gst_video_event_new_still_frame ()

GstEvent *
gst_video_event_new_still_frame (gboolean in_still);

Creates a new Still Frame event. If in_still is TRUE, then the event represents the start of a still frame sequence. If it is FALSE, then the event ends a still frame sequence.

To parse an event created by gst_video_event_new_still_frame() use gst_video_event_parse_still_frame().

Parameters

in_still

boolean value for the still-frame state of the event.

 

Returns

The new GstEvent

Since 0.10.26


gst_video_event_parse_still_frame ()

gboolean
gst_video_event_parse_still_frame (GstEvent *event,
                                   gboolean *in_still);

Parse a GstEvent, identify if it is a Still Frame event, and return the still-frame state from the event if it is. If the event represents the start of a still frame, the in_still variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the in_still variable order to just check whether the event is a valid still-frame event.

Create a still frame event using gst_video_event_new_still_frame()

Parameters

event

A GstEvent to parse

 

in_still

A boolean to receive the still-frame status from the event, or NULL

 

Returns

TRUE if the event is a valid still-frame event. FALSE if not

Since 0.10.26


gst_video_event_new_upstream_force_key_unit ()

GstEvent *
gst_video_event_new_upstream_force_key_unit
                               (GstClockTime running_time,
                                gboolean all_headers,
                                guint count);

Creates a new upstream force key unit event. An upstream force key unit event can be sent to request upstream elements to produce a key unit.

running_time can be set to request a new key unit at a specific running_time. If set to GST_CLOCK_TIME_NONE, upstream elements will produce a new key unit as soon as possible.

To parse an event created by gst_video_event_new_downstream_force_key_unit() use gst_video_event_parse_downstream_force_key_unit().

Parameters

running_time

the running_time at which a new key unit should be produced

 

all_headers

TRUE to produce headers when starting a new key unit

 

count

integer that can be used to number key units

 

Returns

The new GstEvent

Since 0.10.36


gst_video_event_new_downstream_force_key_unit ()

GstEvent *
gst_video_event_new_downstream_force_key_unit
                               (GstClockTime timestamp,
                                GstClockTime streamtime,
                                GstClockTime runningtime,
                                gboolean all_headers,
                                guint count);

Creates a new downstream force key unit event. A downstream force key unit event can be sent down the pipeline to request downstream elements to produce a key unit. A downstream force key unit event must also be sent when handling an upstream force key unit event to notify downstream that the latter has been handled.

To parse an event created by gst_video_event_new_downstream_force_key_unit() use gst_video_event_parse_downstream_force_key_unit().

Parameters

timestamp

the timestamp of the buffer that starts a new key unit

 

stream_time

the stream_time of the buffer that starts a new key unit

 

running_time

the running_time of the buffer that starts a new key unit

 

all_headers

TRUE to produce headers when starting a new key unit

 

count

integer that can be used to number key units

 

Returns

The new GstEvent

Since 0.10.36


gst_video_event_is_force_key_unit ()

gboolean
gst_video_event_is_force_key_unit (GstEvent *event);

Checks if an event is a force key unit event. Returns true for both upstream and downstream force key unit events.

Parameters

event

A GstEvent to check

 

Returns

TRUE if the event is a valid force key unit event

Since 0.10.36


gst_video_event_parse_upstream_force_key_unit ()

gboolean
gst_video_event_parse_upstream_force_key_unit
                               (GstEvent *event,
                                GstClockTime *running_time,
                                gboolean *all_headers,
                                guint *count);

Get running-time, all-headers and count in the force key unit event. See gst_video_event_new_upstream_force_key_unit() for a full description of the upstream force key unit event.

Create an upstream force key unit event using gst_video_event_new_upstream_force_key_unit()

Parameters

event

A GstEvent to parse

 

running_time

A pointer to the running_time in the event.

[out]

all_headers

A pointer to the all_headers flag in the event.

[out]

count

A pointer to the count field in the event.

[out]

Returns

TRUE if the event is a valid upstream force-key-unit event. FALSE if not

Since 0.10.36


gst_video_event_parse_downstream_force_key_unit ()

gboolean
gst_video_event_parse_downstream_force_key_unit
                               (GstEvent *event,
                                GstClockTime *timestamp,
                                GstClockTime *streamtime,
                                GstClockTime *runningtime,
                                gboolean *all_headers,
                                guint *count);

Get timestamp, stream-time, running-time, all-headers and count in the force key unit event. See gst_video_event_new_downstream_force_key_unit() for a full description of the downstream force key unit event.

Parameters

event

A GstEvent to parse

 

timestamp

A pointer to the timestamp in the event.

[out]

stream_time

A pointer to the stream-time in the event.

[out]

running_time

A pointer to the running-time in the event.

[out]

all_headers

A pointer to the all_headers flag in the event.

[out]

count

A pointer to the count field of the event.

[out]

Returns

TRUE if the event is a valid downstream force key unit event.

Since 0.10.36

Types and Values

GST_VIDEO_BLUE_MASK_15

#define GST_VIDEO_BLUE_MASK_15 GST_VIDEO_COMP3_MASK_15

GST_VIDEO_BLUE_MASK_15 is deprecated and should not be used in newly-written code.


GST_VIDEO_BLUE_MASK_15_INT

#define GST_VIDEO_BLUE_MASK_15_INT GST_VIDEO_COMP3_MASK_15_INT

GST_VIDEO_BLUE_MASK_15_INT is deprecated and should not be used in newly-written code.


GST_VIDEO_BLUE_MASK_16

#define GST_VIDEO_BLUE_MASK_16 GST_VIDEO_COMP3_MASK_16

GST_VIDEO_BLUE_MASK_16 is deprecated and should not be used in newly-written code.


GST_VIDEO_BLUE_MASK_16_INT

#define GST_VIDEO_BLUE_MASK_16_INT GST_VIDEO_COMP3_MASK_16_INT

GST_VIDEO_BLUE_MASK_16_INT is deprecated and should not be used in newly-written code.


GST_VIDEO_BYTE1_MASK_24

#define GST_VIDEO_BYTE1_MASK_24  "0x00FF0000"

GST_VIDEO_BYTE1_MASK_24_INT

#define GST_VIDEO_BYTE1_MASK_24_INT  0x00FF0000

GST_VIDEO_BYTE1_MASK_32

#define GST_VIDEO_BYTE1_MASK_32  "0xFF000000"

GST_VIDEO_BYTE1_MASK_32_INT

#define GST_VIDEO_BYTE1_MASK_32_INT  0xFF000000

GST_VIDEO_BYTE2_MASK_24

#define GST_VIDEO_BYTE2_MASK_24  "0x0000FF00"

GST_VIDEO_BYTE2_MASK_24_INT

#define GST_VIDEO_BYTE2_MASK_24_INT  0x0000FF00

GST_VIDEO_BYTE2_MASK_32

#define GST_VIDEO_BYTE2_MASK_32  "0x00FF0000"

GST_VIDEO_BYTE2_MASK_32_INT

#define GST_VIDEO_BYTE2_MASK_32_INT  0x00FF0000

GST_VIDEO_BYTE3_MASK_24

#define GST_VIDEO_BYTE3_MASK_24  "0x000000FF"

GST_VIDEO_BYTE3_MASK_24_INT

#define GST_VIDEO_BYTE3_MASK_24_INT  0x000000FF

GST_VIDEO_BYTE3_MASK_32

#define GST_VIDEO_BYTE3_MASK_32  "0x0000FF00"

GST_VIDEO_BYTE3_MASK_32_INT

#define GST_VIDEO_BYTE3_MASK_32_INT  0x0000FF00

GST_VIDEO_BYTE4_MASK_32

#define GST_VIDEO_BYTE4_MASK_32  "0x000000FF"

GST_VIDEO_BYTE4_MASK_32_INT

#define GST_VIDEO_BYTE4_MASK_32_INT  0x000000FF

GST_VIDEO_CAPS_ABGR

#define             GST_VIDEO_CAPS_ABGR

GST_VIDEO_CAPS_ARGB

#define             GST_VIDEO_CAPS_ARGB

GST_VIDEO_CAPS_BGR

#define             GST_VIDEO_CAPS_BGR

GST_VIDEO_CAPS_BGRA

#define             GST_VIDEO_CAPS_BGRA

GST_VIDEO_CAPS_BGRx

#define             GST_VIDEO_CAPS_BGRx

GST_VIDEO_CAPS_BGRx_HOST_ENDIAN

#define             GST_VIDEO_CAPS_BGRx_HOST_ENDIAN

GST_VIDEO_CAPS_RGB

#define             GST_VIDEO_CAPS_RGB

GST_VIDEO_CAPS_RGBA

#define             GST_VIDEO_CAPS_RGBA

GST_VIDEO_CAPS_RGB_15

#define             GST_VIDEO_CAPS_RGB_15

GST_VIDEO_CAPS_RGB_16

#define             GST_VIDEO_CAPS_RGB_16

GST_VIDEO_CAPS_RGBx

#define             GST_VIDEO_CAPS_RGBx

GST_VIDEO_CAPS_xBGR

#define             GST_VIDEO_CAPS_xBGR

GST_VIDEO_CAPS_xRGB

#define             GST_VIDEO_CAPS_xRGB

GST_VIDEO_CAPS_xRGB_HOST_ENDIAN

#define             GST_VIDEO_CAPS_xRGB_HOST_ENDIAN

GST_VIDEO_CAPS_BGR_15

#define             GST_VIDEO_CAPS_BGR_15

GST_VIDEO_CAPS_BGR_16

#define             GST_VIDEO_CAPS_BGR_16

GST_VIDEO_CAPS_RGB8_PALETTED

#define             GST_VIDEO_CAPS_RGB8_PALETTED

Generic caps string for 8-bit paletted RGB video, for use in pad templates.

Since 0.10.32


GST_VIDEO_CAPS_GRAY8

#define             GST_VIDEO_CAPS_GRAY8

Generic caps string for 8-bit grayscale video, for use in pad templates.

Since 0.10.29


GST_VIDEO_CAPS_ARGB_64

#define             GST_VIDEO_CAPS_ARGB_64

GST_VIDEO_CAPS_r210

#define             GST_VIDEO_CAPS_r210

GST_VIDEO_COMP1_MASK_15

#define GST_VIDEO_COMP1_MASK_15 "0x7c00"

GST_VIDEO_COMP1_MASK_15_INT

#define GST_VIDEO_COMP1_MASK_15_INT 0x7c00

GST_VIDEO_COMP1_MASK_16

#define GST_VIDEO_COMP1_MASK_16 "0xf800"

GST_VIDEO_COMP1_MASK_16_INT

#define GST_VIDEO_COMP1_MASK_16_INT 0xf800

GST_VIDEO_COMP2_MASK_15

#define GST_VIDEO_COMP2_MASK_15 "0x03e0"

GST_VIDEO_COMP2_MASK_15_INT

#define GST_VIDEO_COMP2_MASK_15_INT 0x03e0

GST_VIDEO_COMP2_MASK_16

#define GST_VIDEO_COMP2_MASK_16 "0x07e0"

GST_VIDEO_COMP2_MASK_16_INT

#define GST_VIDEO_COMP2_MASK_16_INT 0x07e0

GST_VIDEO_COMP3_MASK_15

#define GST_VIDEO_COMP3_MASK_15 "0x001f"

GST_VIDEO_COMP3_MASK_15_INT

#define GST_VIDEO_COMP3_MASK_15_INT 0x001f

GST_VIDEO_COMP3_MASK_16

#define GST_VIDEO_COMP3_MASK_16 "0x001f"

GST_VIDEO_COMP3_MASK_16_INT

#define GST_VIDEO_COMP3_MASK_16_INT 0x001f

GST_VIDEO_FPS_RANGE

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

GST_VIDEO_GREEN_MASK_15

#define GST_VIDEO_GREEN_MASK_15 GST_VIDEO_COMP2_MASK_15

GST_VIDEO_GREEN_MASK_15 is deprecated and should not be used in newly-written code.


GST_VIDEO_GREEN_MASK_15_INT

#define GST_VIDEO_GREEN_MASK_15_INT GST_VIDEO_COMP2_MASK_15_INT

GST_VIDEO_GREEN_MASK_15_INT is deprecated and should not be used in newly-written code.


GST_VIDEO_GREEN_MASK_16

#define GST_VIDEO_GREEN_MASK_16 GST_VIDEO_COMP2_MASK_16

GST_VIDEO_GREEN_MASK_16 is deprecated and should not be used in newly-written code.


GST_VIDEO_GREEN_MASK_16_INT

#define GST_VIDEO_GREEN_MASK_16_INT GST_VIDEO_COMP2_MASK_16_INT

GST_VIDEO_GREEN_MASK_16_INT is deprecated and should not be used in newly-written code.


GST_VIDEO_RED_MASK_15

#define GST_VIDEO_RED_MASK_15 GST_VIDEO_COMP1_MASK_15

GST_VIDEO_RED_MASK_15 is deprecated and should not be used in newly-written code.


GST_VIDEO_RED_MASK_15_INT

#define GST_VIDEO_RED_MASK_15_INT GST_VIDEO_COMP1_MASK_15_INT

GST_VIDEO_RED_MASK_15_INT is deprecated and should not be used in newly-written code.


GST_VIDEO_RED_MASK_16

#define GST_VIDEO_RED_MASK_16 GST_VIDEO_COMP1_MASK_16

GST_VIDEO_RED_MASK_16 is deprecated and should not be used in newly-written code.


GST_VIDEO_RED_MASK_16_INT

#define GST_VIDEO_RED_MASK_16_INT GST_VIDEO_COMP1_MASK_16_INT

GST_VIDEO_RED_MASK_16_INT is deprecated and should not be used in newly-written code.


GST_VIDEO_SIZE_RANGE

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

GST_VIDEO_BUFFER_TFF

#define GST_VIDEO_BUFFER_TFF GST_BUFFER_FLAG_MEDIA1

If the GstBuffer is interlaced, then the first field in the video frame is the top field. If unset, the bottom field is first.

Since 0.10.23


GST_VIDEO_BUFFER_RFF

#define GST_VIDEO_BUFFER_RFF GST_BUFFER_FLAG_MEDIA2

If the GstBuffer is interlaced, then the first field (as defined by the GST_VIDEO_BUFFER_TFF flag setting) is repeated.

Since 0.10.23


GST_VIDEO_BUFFER_ONEFIELD

#define GST_VIDEO_BUFFER_ONEFIELD GST_BUFFER_FLAG_MEDIA3

If the GstBuffer is interlaced, then only the first field (as defined by the GST_VIDEO_BUFFER_TFF flag setting) is to be displayed.

Since 0.10.23


GST_VIDEO_BUFFER_PROGRESSIVE

#define GST_VIDEO_BUFFER_PROGRESSIVE GST_BUFFER_FLAG_MEDIA4

If the GstBuffer is telecined, then the buffer is progressive if the GST_VIDEO_BUFFER_PROGRESSIVE flag is set, else it is telecine mixed.

Since 0.10.33


enum GstVideoFormat

Enum value describing the most common video formats.

Members

GST_VIDEO_FORMAT_UNKNOWN

Unknown or unset video format id

 

GST_VIDEO_FORMAT_I420

planar 4:2:0 YUV

 

GST_VIDEO_FORMAT_YV12

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

 

GST_VIDEO_FORMAT_YUY2

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

 

GST_VIDEO_FORMAT_UYVY

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

 

GST_VIDEO_FORMAT_AYUV

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

 

GST_VIDEO_FORMAT_RGBx

sparse rgb packed into 32 bit, space last

 

GST_VIDEO_FORMAT_BGRx

sparse reverse rgb packed into 32 bit, space last

 

GST_VIDEO_FORMAT_xRGB

sparse rgb packed into 32 bit, space first

 

GST_VIDEO_FORMAT_xBGR

sparse reverse rgb packed into 32 bit, space first

 

GST_VIDEO_FORMAT_RGBA

rgb with alpha channel last

 

GST_VIDEO_FORMAT_BGRA

reverse rgb with alpha channel last

 

GST_VIDEO_FORMAT_ARGB

rgb with alpha channel first

 

GST_VIDEO_FORMAT_ABGR

reverse rgb with alpha channel first

 

GST_VIDEO_FORMAT_RGB

rgb

 

GST_VIDEO_FORMAT_BGR

reverse rgb

 

GST_VIDEO_FORMAT_Y41B

planar 4:1:1 YUV (Since: 0.10.18)

 

GST_VIDEO_FORMAT_Y42B

planar 4:2:2 YUV (Since: 0.10.18)

 

GST_VIDEO_FORMAT_YVYU

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

 

GST_VIDEO_FORMAT_Y444

planar 4:4:4 YUV (Since: 0.10.24)

 

GST_VIDEO_FORMAT_v210

packed 4:2:2 10-bit YUV, complex format (Since: 0.10.24)

 

GST_VIDEO_FORMAT_v216

packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order (Since: 0.10.24)

 

GST_VIDEO_FORMAT_NV12

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

 

GST_VIDEO_FORMAT_NV21

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

 

GST_VIDEO_FORMAT_GRAY8

8-bit grayscale (Since: 0.10.29)

 

GST_VIDEO_FORMAT_GRAY16_BE

16-bit grayscale, most significant byte first (Since: 0.10.29)

 

GST_VIDEO_FORMAT_GRAY16_LE

16-bit grayscale, least significant byte first (Since: 0.10.29)

 

GST_VIDEO_FORMAT_v308

packed 4:4:4 YUV (Since: 0.10.29)

 

GST_VIDEO_FORMAT_Y800

same as GST_VIDEO_FORMAT_GRAY8 (Since: 0.10.30)

 

GST_VIDEO_FORMAT_Y16

same as GST_VIDEO_FORMAT_GRAY16_LE (Since: 0.10.30)

 

GST_VIDEO_FORMAT_RGB16

rgb 5-6-5 bits per component (Since: 0.10.30)

 

GST_VIDEO_FORMAT_BGR16

reverse rgb 5-6-5 bits per component (Since: 0.10.30)

 

GST_VIDEO_FORMAT_RGB15

rgb 5-5-5 bits per component (Since: 0.10.30)

 

GST_VIDEO_FORMAT_BGR15

reverse rgb 5-5-5 bits per component (Since: 0.10.30)

 

GST_VIDEO_FORMAT_UYVP

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

 

GST_VIDEO_FORMAT_A420

planar 4:4:2:0 AYUV (Since: 0.10.31)

 

GST_VIDEO_FORMAT_RGB8_PALETTED

8-bit paletted RGB (Since: 0.10.32)

 

GST_VIDEO_FORMAT_YUV9

planar 4:1:0 YUV (Since: 0.10.32)

 

GST_VIDEO_FORMAT_YVU9

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

 

GST_VIDEO_FORMAT_IYU1

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

 

GST_VIDEO_FORMAT_ARGB64

rgb with alpha channel first, 16 bits per channel (Since: 0.10.33)

 

GST_VIDEO_FORMAT_AYUV64

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

 

GST_VIDEO_FORMAT_r210

packed 4:4:4 RGB, 10 bits per channel (Since: 0.10.33)