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

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.

GstVideoConvertSampleCallback ()

void
(*GstVideoConvertSampleCallback) (GstSample *sample,
                                  GError *error,
                                  gpointer user_data);

gst_video_convert_sample ()

GstSample *
gst_video_convert_sample (GstSample *sample,
                          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.

gst_video_convert_sample_async ()

void
gst_video_convert_sample_async (GstSample *sample,
                                const GstCaps *to_caps,
                                GstClockTime timeout,
                                GstVideoConvertSampleCallback 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.

gst_video_alignment_reset ()

void
gst_video_alignment_reset (GstVideoAlignment *align);

Set align to its default values with no padding and no alignment.

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

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

gst_video_event_new_downstream_force_key_unit ()

GstEvent *
gst_video_event_new_downstream_force_key_unit
                               (GstClockTime timestamp,
                                GstClockTime stream_time,
                                GstClockTime running_time,
                                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().

gst_video_event_parse_downstream_force_key_unit ()

gboolean
gst_video_event_parse_downstream_force_key_unit
                               (GstEvent *event,
                                GstClockTime *timestamp,
                                GstClockTime *stream_time,
                                GstClockTime *running_time,
                                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.

running_time will be adjusted for any pad offsets of pads it was passing through.

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

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

running_time will be adjusted for any pad offsets of pads it was passing through.

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.

gst_video_chroma_from_string ()

GstVideoChromaSite
gst_video_chroma_from_string (const gchar *s);

Convert s to a GstVideoChromaSite

gst_video_chroma_to_string ()

const gchar *
gst_video_chroma_to_string (GstVideoChromaSite site);

Converts site to its string representation.

GstVideoFormatUnpack ()

void
(*GstVideoFormatUnpack) (const GstVideoFormatInfo *info,
                         GstVideoPackFlags flags,
                         gpointer dest,
                         const gpointer data[GST_VIDEO_MAX_PLANES],
                         const gint stride[GST_VIDEO_MAX_PLANES],
                         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 which each component interleaved. dest should at least be big enough to hold width * n_components * size(unpack_format) bytes.

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.

GstVideoFormatPack ()

void
(*GstVideoFormatPack) (const GstVideoFormatInfo *info,
                       GstVideoPackFlags flags,
                       const gpointer src,
                       gint sstride,
                       gpointer data[GST_VIDEO_MAX_PLANES],
                       const gint stride[GST_VIDEO_MAX_PLANES],
                       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 cosited component in the destination. Subsampling should be performed before packing.

Because tis 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 need to be packed.

GST_VIDEO_FORMAT_INFO_FORMAT()

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

GST_VIDEO_FORMAT_INFO_NAME()

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

GST_VIDEO_FORMAT_INFO_FLAGS()

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

GST_VIDEO_FORMAT_INFO_IS_YUV()

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

GST_VIDEO_FORMAT_INFO_IS_RGB()

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

GST_VIDEO_FORMAT_INFO_IS_GRAY()

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

GST_VIDEO_FORMAT_INFO_HAS_ALPHA()

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

GST_VIDEO_FORMAT_INFO_IS_LE()

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

GST_VIDEO_FORMAT_INFO_HAS_PALETTE()

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

GST_VIDEO_FORMAT_INFO_IS_COMPLEX()

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

GST_VIDEO_FORMAT_INFO_BITS()

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

GST_VIDEO_FORMAT_INFO_N_COMPONENTS()

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

GST_VIDEO_FORMAT_INFO_SHIFT()

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

GST_VIDEO_FORMAT_INFO_DEPTH()

#define GST_VIDEO_FORMAT_INFO_DEPTH(info,c)      ((info)->depth[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_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_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_W_SUB()

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

GST_VIDEO_FORMAT_INFO_H_SUB()

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

GST_VIDEO_SUB_SCALE()

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

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

#define             GST_VIDEO_FORMAT_INFO_DATA(info,planes,comp)

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

#define             GST_VIDEO_FORMAT_INFO_OFFSET(info,offsets,comp)

GST_VIDEO_FORMAT_INFO_TILE_MODE()

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

GST_VIDEO_FORMAT_INFO_TILE_WS()

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

GST_VIDEO_FORMAT_INFO_TILE_HS()

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

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

GstVideoFormat
gst_video_format_from_string (const gchar *format);

Convert the format string to its GstVideoFormat.

gst_video_format_to_string ()

const gchar *
gst_video_format_to_string (GstVideoFormat format);

gst_video_format_get_info ()

const GstVideoFormatInfo *
gst_video_format_get_info (GstVideoFormat format);

Get the GstVideoFormatInfo for format

GST_VIDEO_CAPS_MAKE()

#define             GST_VIDEO_CAPS_MAKE(format)

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

gst_video_colorimetry_matches ()

gboolean
gst_video_colorimetry_matches (GstVideoColorimetry *cinfo,
                               const gchar *color);

Check if the colorimetry information in info matches that of the string color .

gst_video_colorimetry_from_string ()

gboolean
gst_video_colorimetry_from_string (GstVideoColorimetry *cinfo,
                                   const gchar *color);

Parse the colorimetry string and update cinfo with the parsed values.

gst_video_colorimetry_to_string ()

gchar *
gst_video_colorimetry_to_string (GstVideoColorimetry *cinfo);

Make a string representation of cinfo .

gst_video_color_range_offsets ()

void
gst_video_color_range_offsets (GstVideoColorRange range,
                               const GstVideoFormatInfo *info,
                               gint offset[GST_VIDEO_MAX_COMPONENTS],
                               gint scale[GST_VIDEO_MAX_COMPONENTS]);

Compute the offset and scale values for each component of info . For each component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the range [0.0 .. 1.0].

The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert the component values in range [0.0 .. 1.0] back to their representation in info and range .

GST_VIDEO_INFO_FORMAT()

#define GST_VIDEO_INFO_FORMAT(i)         (GST_VIDEO_FORMAT_INFO_FORMAT((i)->finfo))

GST_VIDEO_INFO_NAME()

#define GST_VIDEO_INFO_NAME(i)           (GST_VIDEO_FORMAT_INFO_NAME((i)->finfo))

GST_VIDEO_INFO_IS_YUV()

#define GST_VIDEO_INFO_IS_YUV(i)         (GST_VIDEO_FORMAT_INFO_IS_YUV((i)->finfo))

GST_VIDEO_INFO_IS_RGB()

#define GST_VIDEO_INFO_IS_RGB(i)         (GST_VIDEO_FORMAT_INFO_IS_RGB((i)->finfo))

GST_VIDEO_INFO_IS_GRAY()

#define GST_VIDEO_INFO_IS_GRAY(i)        (GST_VIDEO_FORMAT_INFO_IS_GRAY((i)->finfo))

GST_VIDEO_INFO_HAS_ALPHA()

#define GST_VIDEO_INFO_HAS_ALPHA(i)      (GST_VIDEO_FORMAT_INFO_HAS_ALPHA((i)->finfo))

GST_VIDEO_INFO_INTERLACE_MODE()

#define GST_VIDEO_INFO_INTERLACE_MODE(i) ((i)->interlace_mode)

GST_VIDEO_INFO_IS_INTERLACED()

#define GST_VIDEO_INFO_IS_INTERLACED(i)  ((i)->interlace_mode != GST_VIDEO_INTERLACE_MODE_PROGRESSIVE)

GST_VIDEO_INFO_FLAGS()

#define GST_VIDEO_INFO_FLAGS(i)          ((i)->flags)

GST_VIDEO_INFO_WIDTH()

#define GST_VIDEO_INFO_WIDTH(i)          ((i)->width)

GST_VIDEO_INFO_HEIGHT()

#define GST_VIDEO_INFO_HEIGHT(i)         ((i)->height)

GST_VIDEO_INFO_SIZE()

#define GST_VIDEO_INFO_SIZE(i)           ((i)->size)

GST_VIDEO_INFO_VIEWS()

#define GST_VIDEO_INFO_VIEWS(i)          ((i)->views)

GST_VIDEO_INFO_PAR_N()

#define GST_VIDEO_INFO_PAR_N(i)          ((i)->par_n)

GST_VIDEO_INFO_PAR_D()

#define GST_VIDEO_INFO_PAR_D(i)          ((i)->par_d)

GST_VIDEO_INFO_FPS_N()

#define GST_VIDEO_INFO_FPS_N(i)          ((i)->fps_n)

GST_VIDEO_INFO_FPS_D()

#define GST_VIDEO_INFO_FPS_D(i)          ((i)->fps_d)

GST_VIDEO_INFO_FLAG_IS_SET()

#define GST_VIDEO_INFO_FLAG_IS_SET(i,flag) ((GST_VIDEO_INFO_FLAGS(i) & (flag)) == (flag))

GST_VIDEO_INFO_FLAG_SET()

#define GST_VIDEO_INFO_FLAG_SET(i,flag)    (GST_VIDEO_INFO_FLAGS(i) |= (flag))

GST_VIDEO_INFO_FLAG_UNSET()

#define GST_VIDEO_INFO_FLAG_UNSET(i,flag)  (GST_VIDEO_INFO_FLAGS(i) &= ~(flag))

GST_VIDEO_INFO_N_PLANES()

#define GST_VIDEO_INFO_N_PLANES(i)       (GST_VIDEO_FORMAT_INFO_N_PLANES((i)->finfo))

GST_VIDEO_INFO_PLANE_OFFSET()

#define GST_VIDEO_INFO_PLANE_OFFSET(i,p) ((i)->offset[p])

GST_VIDEO_INFO_PLANE_STRIDE()

#define GST_VIDEO_INFO_PLANE_STRIDE(i,p) ((i)->stride[p])

GST_VIDEO_INFO_N_COMPONENTS()

#define GST_VIDEO_INFO_N_COMPONENTS(i)   GST_VIDEO_FORMAT_INFO_N_COMPONENTS((i)->finfo)

GST_VIDEO_INFO_COMP_DEPTH()

#define GST_VIDEO_INFO_COMP_DEPTH(i,c)   GST_VIDEO_FORMAT_INFO_DEPTH((i)->finfo,(c))

GST_VIDEO_INFO_COMP_DATA()

#define GST_VIDEO_INFO_COMP_DATA(i,d,c)  GST_VIDEO_FORMAT_INFO_DATA((i)->finfo,d,(c))

GST_VIDEO_INFO_COMP_OFFSET()

#define GST_VIDEO_INFO_COMP_OFFSET(i,c)  GST_VIDEO_FORMAT_INFO_OFFSET((i)->finfo,(i)->offset,(c))

GST_VIDEO_INFO_COMP_STRIDE()

#define GST_VIDEO_INFO_COMP_STRIDE(i,c)  GST_VIDEO_FORMAT_INFO_STRIDE((i)->finfo,(i)->stride,(c))

GST_VIDEO_INFO_COMP_WIDTH()

#define GST_VIDEO_INFO_COMP_WIDTH(i,c)   GST_VIDEO_FORMAT_INFO_SCALE_WIDTH((i)->finfo,(c),(i)->width)

GST_VIDEO_INFO_COMP_HEIGHT()

#define GST_VIDEO_INFO_COMP_HEIGHT(i,c)  GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT((i)->finfo,(c),(i)->height)

GST_VIDEO_INFO_COMP_PLANE()

#define GST_VIDEO_INFO_COMP_PLANE(i,c)   GST_VIDEO_FORMAT_INFO_PLANE((i)->finfo,(c))

GST_VIDEO_INFO_COMP_PSTRIDE()

#define GST_VIDEO_INFO_COMP_PSTRIDE(i,c) GST_VIDEO_FORMAT_INFO_PSTRIDE((i)->finfo,(c))

GST_VIDEO_INFO_COMP_POFFSET()

#define GST_VIDEO_INFO_COMP_POFFSET(i,c) GST_VIDEO_FORMAT_INFO_POFFSET((i)->finfo,(c))

gst_video_info_init ()

void
gst_video_info_init (GstVideoInfo *info);

Initialize info with default values.

gst_video_info_set_format ()

void
gst_video_info_set_format (GstVideoInfo *info,
                           GstVideoFormat format,
                           guint width,
                           guint height);

Set the default info for a video frame of format and width and height .

Note: This initializes info first, no values are preserved.

gst_video_info_from_caps ()

gboolean
gst_video_info_from_caps (GstVideoInfo *info,
                          const GstCaps *caps);

Parse caps and update info .

gst_video_info_to_caps ()

GstCaps *
gst_video_info_to_caps (GstVideoInfo *info);

Convert the values of info into a GstCaps.

gst_video_info_convert ()

gboolean
gst_video_info_convert (GstVideoInfo *info,
                        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 used to handle pad queries of the type GST_QUERY_CONVERT.

gst_video_info_is_equal ()

gboolean
gst_video_info_is_equal (const GstVideoInfo *info,
                         const GstVideoInfo *other);

Compares two GstVideoInfo and returns whether they are equal or not

gst_video_info_align ()

void
gst_video_info_align (GstVideoInfo *info,
                      GstVideoAlignment *align);

Adjust the offset and stride fields in info so that the padding and stride alignment in align is respected.

Extra padding will be added to the right side when stride alignment padding is required and align will be updated with the new padding values.

gst_video_frame_map_id ()

gboolean
gst_video_frame_map_id (GstVideoFrame *frame,
                        GstVideoInfo *info,
                        GstBuffer *buffer,
                        gint id,
                        GstMapFlags flags);

Use info and buffer to fill in the values of frame with the video frame information of frame id .

When id is -1, the default frame is mapped. When id != -1, this function will return FALSE when there is no GstVideoMeta with that id.

All video planes of buffer will be mapped and the pointers will be set in frame->data .

gst_video_frame_map ()

gboolean
gst_video_frame_map (GstVideoFrame *frame,
                     GstVideoInfo *info,
                     GstBuffer *buffer,
                     GstMapFlags flags);

Use info and buffer to fill in the values of frame .

All video planes of buffer will be mapped and the pointers will be set in frame->data .

gst_video_frame_unmap ()

void
gst_video_frame_unmap (GstVideoFrame *frame);

Unmap the memory previously mapped with gst_video_frame_map.

gst_video_frame_copy ()

gboolean
gst_video_frame_copy (GstVideoFrame *dest,
                      const GstVideoFrame *src);

Copy the contents from src to dest .

gst_video_frame_copy_plane ()

gboolean
gst_video_frame_copy_plane (GstVideoFrame *dest,
                            const GstVideoFrame *src,
                            guint plane);

Copy the plane with index plane from src to dest .

GST_VIDEO_FRAME_FORMAT()

#define GST_VIDEO_FRAME_FORMAT(f)         (GST_VIDEO_INFO_FORMAT(&(f)->info))

GST_VIDEO_FRAME_WIDTH()

#define GST_VIDEO_FRAME_WIDTH(f)          (GST_VIDEO_INFO_WIDTH(&(f)->info))

GST_VIDEO_FRAME_HEIGHT()

#define GST_VIDEO_FRAME_HEIGHT(f)         (GST_VIDEO_INFO_HEIGHT(&(f)->info))

GST_VIDEO_FRAME_SIZE()

#define GST_VIDEO_FRAME_SIZE(f)           (GST_VIDEO_INFO_SIZE(&(f)->info))

GST_VIDEO_FRAME_FLAGS()

#define GST_VIDEO_FRAME_FLAGS(f)          ((f)->flags)

GST_VIDEO_FRAME_FLAG_IS_SET()

#define GST_VIDEO_FRAME_FLAG_IS_SET(f,fl) ((GST_VIDEO_FRAME_FLAGS(f) & (fl)) == (fl))

GST_VIDEO_FRAME_IS_INTERLACED()

#define GST_VIDEO_FRAME_IS_INTERLACED(f)  (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_INTERLACED))

GST_VIDEO_FRAME_IS_TFF()

#define GST_VIDEO_FRAME_IS_TFF(f)         (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_TFF))

GST_VIDEO_FRAME_IS_RFF()

#define GST_VIDEO_FRAME_IS_RFF(f)         (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_RFF))

GST_VIDEO_FRAME_IS_ONEFIELD()

#define GST_VIDEO_FRAME_IS_ONEFIELD(f)    (GST_VIDEO_FRAME_FLAG_IS_SET(f, GST_VIDEO_FRAME_FLAG_ONEFIELD))

GST_VIDEO_FRAME_N_PLANES()

#define GST_VIDEO_FRAME_N_PLANES(f)       (GST_VIDEO_INFO_N_PLANES(&(f)->info))

GST_VIDEO_FRAME_PLANE_DATA()

#define GST_VIDEO_FRAME_PLANE_DATA(f,p)   ((f)->data[p])

GST_VIDEO_FRAME_PLANE_OFFSET()

#define GST_VIDEO_FRAME_PLANE_OFFSET(f,p) (GST_VIDEO_INFO_PLANE_OFFSET(&(f)->info,(p)))

GST_VIDEO_FRAME_PLANE_STRIDE()

#define GST_VIDEO_FRAME_PLANE_STRIDE(f,p) (GST_VIDEO_INFO_PLANE_STRIDE(&(f)->info,(p)))

GST_VIDEO_FRAME_N_COMPONENTS()

#define GST_VIDEO_FRAME_N_COMPONENTS(f)   GST_VIDEO_INFO_N_COMPONENTS(&(f)->info)

GST_VIDEO_FRAME_COMP_DEPTH()

#define GST_VIDEO_FRAME_COMP_DEPTH(f,c)   GST_VIDEO_INFO_COMP_DEPTH(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_DATA()

#define GST_VIDEO_FRAME_COMP_DATA(f,c)    GST_VIDEO_INFO_COMP_DATA(&(f)->info,(f)->data,(c))

GST_VIDEO_FRAME_COMP_STRIDE()

#define GST_VIDEO_FRAME_COMP_STRIDE(f,c)  GST_VIDEO_INFO_COMP_STRIDE(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_OFFSET()

#define GST_VIDEO_FRAME_COMP_OFFSET(f,c)  GST_VIDEO_INFO_COMP_OFFSET(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_WIDTH()

#define GST_VIDEO_FRAME_COMP_WIDTH(f,c)   GST_VIDEO_INFO_COMP_WIDTH(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_HEIGHT()

#define GST_VIDEO_FRAME_COMP_HEIGHT(f,c)  GST_VIDEO_INFO_COMP_HEIGHT(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_PLANE()

#define GST_VIDEO_FRAME_COMP_PLANE(f,c)   GST_VIDEO_INFO_COMP_PLANE(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_PSTRIDE()

#define GST_VIDEO_FRAME_COMP_PSTRIDE(f,c) GST_VIDEO_INFO_COMP_PSTRIDE(&(f)->info,(c))

GST_VIDEO_FRAME_COMP_POFFSET()

#define GST_VIDEO_FRAME_COMP_POFFSET(f,c) GST_VIDEO_INFO_COMP_POFFSET(&(f)->info,(c))

gst_video_tile_get_index ()

guint
gst_video_tile_get_index (GstVideoTileMode mode,
                          gint x,
                          gint y,
                          gint x_tiles,
                          gint y_tiles);

Get the tile index of the tile at coordinates x and y in the tiled image of x_tiles by y_tiles .

Use this method when mode is of type GST_VIDEO_TILE_MODE_INDEXED.

GST_VIDEO_TILE_MAKE_MODE()

#define             GST_VIDEO_TILE_MAKE_MODE(num, type)

use this macro to create new tile modes.

GST_VIDEO_TILE_MODE_TYPE()

#define GST_VIDEO_TILE_MODE_TYPE(mode)       ((mode) & GST_VIDEO_TILE_TYPE_MASK)

Get the tile mode type of mode

GST_VIDEO_TILE_MODE_IS_INDEXED()

#define GST_VIDEO_TILE_MODE_IS_INDEXED(mode) (GST_VIDEO_TILE_MODE_TYPE(mode) == GST_VIDEO_TILE_TYPE_INDEXED)

Check if mode is an indexed tile type

GST_VIDEO_TILE_MAKE_STRIDE()

#define             GST_VIDEO_TILE_MAKE_STRIDE(x_tiles, y_tiles)

Encode the number of tile in X and Y into the stride.

GST_VIDEO_TILE_X_TILES()

#define GST_VIDEO_TILE_X_TILES(stride) ((stride) & GST_VIDEO_TILE_X_TILES_MASK)

Extract the number of tiles in X from the stride value.

GST_VIDEO_TILE_Y_TILES()

#define GST_VIDEO_TILE_Y_TILES(stride) ((stride) >> GST_VIDEO_TILE_Y_TILES_SHIFT)

Extract the number of tiles in Y from the stride value.

struct GstVideoAlignment

struct GstVideoAlignment {
  guint padding_top;
  guint padding_bottom;
  guint padding_left;
  guint padding_right;
  guint stride_align[GST_VIDEO_MAX_PLANES];
};

Extra alignment paramters for the memory of video buffers. This structure is usually used to configure the bufferpool if it supports the GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT.

GST_META_TAG_VIDEO_STR

#define GST_META_TAG_VIDEO_STR "video"

This metadata is relevant for video streams.

Since 1.2

GST_META_TAG_VIDEO_ORIENTATION_STR

#define GST_META_TAG_VIDEO_ORIENTATION_STR "orientation"

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

Since 1.2

GST_META_TAG_VIDEO_SIZE_STR

#define GST_META_TAG_VIDEO_SIZE_STR "size"

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

Since 1.2

GST_META_TAG_VIDEO_COLORSPACE_STR

#define GST_META_TAG_VIDEO_COLORSPACE_STR "colorspace"

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

Since 1.2

enum GstVideoFormat

Enum value describing the most common video formats.

GST_VIDEO_MAX_PLANES

#define GST_VIDEO_MAX_PLANES 4

GST_VIDEO_MAX_COMPONENTS

#define GST_VIDEO_MAX_COMPONENTS 4

struct GstVideoFormatInfo

struct GstVideoFormatInfo {
  GstVideoFormat format;
  const gchar *name;
  const gchar *description;
  GstVideoFormatFlags flags;
  guint bits;
  guint n_components;
  guint shift[GST_VIDEO_MAX_COMPONENTS];
  guint depth[GST_VIDEO_MAX_COMPONENTS];
  gint  pixel_stride[GST_VIDEO_MAX_COMPONENTS];
  guint n_planes;
  guint plane[GST_VIDEO_MAX_COMPONENTS];
  guint poffset[GST_VIDEO_MAX_COMPONENTS];
  guint w_sub[GST_VIDEO_MAX_COMPONENTS];
  guint h_sub[GST_VIDEO_MAX_COMPONENTS];

  GstVideoFormat unpack_format;
  GstVideoFormatUnpack unpack_func;
  gint pack_lines;
  GstVideoFormatPack pack_func;

  GstVideoTileMode tile_mode;
  guint tile_ws;
  guint tile_hs;

  gpointer _gst_reserved[GST_PADDING];
};

Information for a video format.

enum GstVideoChromaSite

Various Chroma sitings.

enum GstVideoFormatFlags

The different video flags that a format info can have.

enum GstVideoPackFlags

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

GST_VIDEO_SIZE_RANGE

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

GST_VIDEO_FPS_RANGE

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

GST_VIDEO_FORMATS_ALL

#define             GST_VIDEO_FORMATS_ALL

enum GstVideoColorRange

Possible color range values. These constants are defined for 8 bit color values and can be scaled for other bit depths.

enum GstVideoColorMatrix

The color matrix is used to convert between Y'PbPr and non-linear RGB (R'G'B')

enum GstVideoTransferFunction

The video transfer function defines the formula for converting between non-linear RGB (R'G'B') and linear RGB

enum GstVideoColorPrimaries

The color primaries define the how to transform linear RGB values to and from the CIE XYZ colorspace.

GstVideoColorimetry

typedef struct {
  GstVideoColorRange        range;
  GstVideoColorMatrix       matrix;
  GstVideoTransferFunction  transfer;
  GstVideoColorPrimaries    primaries;
} GstVideoColorimetry;

Structure describing the color info.

struct GstVideoInfo

struct GstVideoInfo {
  const GstVideoFormatInfo *finfo;

  GstVideoInterlaceMode     interlace_mode;
  GstVideoFlags             flags;
  gint                      width;
  gint                      height;
  gsize                     size;
  gint                      views;

  GstVideoChromaSite        chroma_site;
  GstVideoColorimetry       colorimetry;

  gint                      par_n;
  gint                      par_d;
  gint                      fps_n;
  gint                      fps_d;

  gsize                     offset[GST_VIDEO_MAX_PLANES];
  gint                      stride[GST_VIDEO_MAX_PLANES];
};

Information describing image properties. This information can be filled in from GstCaps with gst_video_info_from_caps(). The information is also used to store the specific video info when mapping a video frame with gst_video_frame_map().

Use the provided macros to access the info in this structure.

enum GstVideoInterlaceMode

The possible values of the GstVideoInterlaceMode describing the interlace mode of the stream.

enum GstVideoFlags

Extra video flags

struct GstVideoFrame

struct GstVideoFrame {
  GstVideoInfo info;
  GstVideoFrameFlags flags;

  GstBuffer *buffer;
  gpointer   meta;
  gint       id;

  gpointer   data[GST_VIDEO_MAX_PLANES];
  GstMapInfo map[GST_VIDEO_MAX_PLANES];
};

A video frame obtained from gst_video_frame_map()

enum GstVideoFrameFlags

Extra video frame flags

enum GstVideoBufferFlags

Additional video buffer flags.

enum GstVideoTileType

Enum value describing the most common tiling types.

enum GstVideoTileMode

Enum value describing the available tiling modes.