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

GST_VIDEO_BLUE_MASK_15

#define GST_VIDEO_BLUE_MASK_15 GST_VIDEO_COMP3_MASK_15

GST_VIDEO_BLUE_MASK_15_INT

#define GST_VIDEO_BLUE_MASK_15_INT GST_VIDEO_COMP3_MASK_15_INT

GST_VIDEO_BLUE_MASK_16

#define GST_VIDEO_BLUE_MASK_16 GST_VIDEO_COMP3_MASK_16

GST_VIDEO_BLUE_MASK_16_INT

#define GST_VIDEO_BLUE_MASK_16_INT GST_VIDEO_COMP3_MASK_16_INT

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

#define             GST_VIDEO_CAPS_YUV(fourcc)

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

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

#define             GST_VIDEO_CAPS_GRAY16(endianness)

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

Since 0.10.29

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_INT

#define GST_VIDEO_GREEN_MASK_15_INT GST_VIDEO_COMP2_MASK_15_INT

GST_VIDEO_GREEN_MASK_16

#define GST_VIDEO_GREEN_MASK_16 GST_VIDEO_COMP2_MASK_16

GST_VIDEO_GREEN_MASK_16_INT

#define GST_VIDEO_GREEN_MASK_16_INT GST_VIDEO_COMP2_MASK_16_INT

GST_VIDEO_RED_MASK_15

#define GST_VIDEO_RED_MASK_15 GST_VIDEO_COMP1_MASK_15

GST_VIDEO_RED_MASK_15_INT

#define GST_VIDEO_RED_MASK_15_INT GST_VIDEO_COMP1_MASK_15_INT

GST_VIDEO_RED_MASK_16

#define GST_VIDEO_RED_MASK_16 GST_VIDEO_COMP1_MASK_16

GST_VIDEO_RED_MASK_16_INT

#define GST_VIDEO_RED_MASK_16_INT GST_VIDEO_COMP1_MASK_16_INT

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

enum GstVideoFormat

typedef enum {
  GST_VIDEO_FORMAT_UNKNOWN,
  GST_VIDEO_FORMAT_I420,
  GST_VIDEO_FORMAT_YV12,
  GST_VIDEO_FORMAT_YUY2,
  GST_VIDEO_FORMAT_UYVY,
  GST_VIDEO_FORMAT_AYUV,
  GST_VIDEO_FORMAT_RGBx,
  GST_VIDEO_FORMAT_BGRx,
  GST_VIDEO_FORMAT_xRGB,
  GST_VIDEO_FORMAT_xBGR,
  GST_VIDEO_FORMAT_RGBA,
  GST_VIDEO_FORMAT_BGRA,
  GST_VIDEO_FORMAT_ARGB,
  GST_VIDEO_FORMAT_ABGR,
  GST_VIDEO_FORMAT_RGB,
  GST_VIDEO_FORMAT_BGR,
  GST_VIDEO_FORMAT_Y41B,
  GST_VIDEO_FORMAT_Y42B,
  GST_VIDEO_FORMAT_YVYU,
  GST_VIDEO_FORMAT_Y444,
  GST_VIDEO_FORMAT_v210,
  GST_VIDEO_FORMAT_v216,
  GST_VIDEO_FORMAT_NV12,
  GST_VIDEO_FORMAT_NV21,
  GST_VIDEO_FORMAT_GRAY8,
  GST_VIDEO_FORMAT_GRAY16_BE,
  GST_VIDEO_FORMAT_GRAY16_LE,
  GST_VIDEO_FORMAT_v308,
  GST_VIDEO_FORMAT_Y800,
  GST_VIDEO_FORMAT_Y16,
  GST_VIDEO_FORMAT_RGB16,
  GST_VIDEO_FORMAT_BGR16,
  GST_VIDEO_FORMAT_RGB15,
  GST_VIDEO_FORMAT_BGR15,
  GST_VIDEO_FORMAT_UYVP,
  GST_VIDEO_FORMAT_A420,
  GST_VIDEO_FORMAT_RGB8_PALETTED,
  GST_VIDEO_FORMAT_YUV9,
  GST_VIDEO_FORMAT_YVU9,
  GST_VIDEO_FORMAT_IYU1,
  GST_VIDEO_FORMAT_ARGB64,
  GST_VIDEO_FORMAT_AYUV64,
  GST_VIDEO_FORMAT_r210
} GstVideoFormat;

Enum value describing the most common video formats.

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.

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.

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.

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.

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.

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.

Since 0.10.23

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.

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.

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.

Since 0.10.16

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.

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.

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.

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.

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.

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.

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.

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.

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.

Since 0.10.16

gst_video_format_parse_caps ()

gboolean            gst_video_format_parse_caps         (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 one of the raw video formats listed in GstVideoFormat, the function will fail and return FALSE.

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.

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.

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.

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)

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

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.

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.

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.

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

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

Since 0.10.26