1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>gstvideo</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-video.html" title="Video Library">
9 <link rel="prev" href="gstreamer-video.html" title="Video Library">
10 <link rel="next" href="gst-plugins-base-libs-gstvideofilter.html" title="gstvideofilter">
11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gstreamer-video.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-video.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-libs-gstvideofilter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstvideo.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-libs-gstvideo.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="gst-plugins-base-libs-gstvideo"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstvideo.top_of_page"></a>gstvideo</span></h2>
34 <p>gstvideo — Support library for video operations</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gstvideo.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include <gst/video/video.h>
43 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BLUE-MASK-15:CAPS" title="GST_VIDEO_BLUE_MASK_15">GST_VIDEO_BLUE_MASK_15</a>
44 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BLUE-MASK-15-INT:CAPS" title="GST_VIDEO_BLUE_MASK_15_INT">GST_VIDEO_BLUE_MASK_15_INT</a>
45 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BLUE-MASK-16:CAPS" title="GST_VIDEO_BLUE_MASK_16">GST_VIDEO_BLUE_MASK_16</a>
46 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BLUE-MASK-16-INT:CAPS" title="GST_VIDEO_BLUE_MASK_16_INT">GST_VIDEO_BLUE_MASK_16_INT</a>
47 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE1-MASK-24:CAPS" title="GST_VIDEO_BYTE1_MASK_24">GST_VIDEO_BYTE1_MASK_24</a>
48 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE1-MASK-24-INT:CAPS" title="GST_VIDEO_BYTE1_MASK_24_INT">GST_VIDEO_BYTE1_MASK_24_INT</a>
49 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE1-MASK-32:CAPS" title="GST_VIDEO_BYTE1_MASK_32">GST_VIDEO_BYTE1_MASK_32</a>
50 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE1-MASK-32-INT:CAPS" title="GST_VIDEO_BYTE1_MASK_32_INT">GST_VIDEO_BYTE1_MASK_32_INT</a>
51 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE2-MASK-24:CAPS" title="GST_VIDEO_BYTE2_MASK_24">GST_VIDEO_BYTE2_MASK_24</a>
52 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE2-MASK-24-INT:CAPS" title="GST_VIDEO_BYTE2_MASK_24_INT">GST_VIDEO_BYTE2_MASK_24_INT</a>
53 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE2-MASK-32:CAPS" title="GST_VIDEO_BYTE2_MASK_32">GST_VIDEO_BYTE2_MASK_32</a>
54 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE2-MASK-32-INT:CAPS" title="GST_VIDEO_BYTE2_MASK_32_INT">GST_VIDEO_BYTE2_MASK_32_INT</a>
55 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE3-MASK-24:CAPS" title="GST_VIDEO_BYTE3_MASK_24">GST_VIDEO_BYTE3_MASK_24</a>
56 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE3-MASK-24-INT:CAPS" title="GST_VIDEO_BYTE3_MASK_24_INT">GST_VIDEO_BYTE3_MASK_24_INT</a>
57 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE3-MASK-32:CAPS" title="GST_VIDEO_BYTE3_MASK_32">GST_VIDEO_BYTE3_MASK_32</a>
58 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE3-MASK-32-INT:CAPS" title="GST_VIDEO_BYTE3_MASK_32_INT">GST_VIDEO_BYTE3_MASK_32_INT</a>
59 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE4-MASK-32:CAPS" title="GST_VIDEO_BYTE4_MASK_32">GST_VIDEO_BYTE4_MASK_32</a>
60 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BYTE4-MASK-32-INT:CAPS" title="GST_VIDEO_BYTE4_MASK_32_INT">GST_VIDEO_BYTE4_MASK_32_INT</a>
61 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-ABGR:CAPS" title="GST_VIDEO_CAPS_ABGR">GST_VIDEO_CAPS_ABGR</a>
62 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-ARGB:CAPS" title="GST_VIDEO_CAPS_ARGB">GST_VIDEO_CAPS_ARGB</a>
63 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-BGR:CAPS" title="GST_VIDEO_CAPS_BGR">GST_VIDEO_CAPS_BGR</a>
64 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-BGRA:CAPS" title="GST_VIDEO_CAPS_BGRA">GST_VIDEO_CAPS_BGRA</a>
65 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-BGRx" title="GST_VIDEO_CAPS_BGRx">GST_VIDEO_CAPS_BGRx</a>
66 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-BGRx-HOST-ENDIAN" title="GST_VIDEO_CAPS_BGRx_HOST_ENDIAN">GST_VIDEO_CAPS_BGRx_HOST_ENDIAN</a>
67 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-RGB:CAPS" title="GST_VIDEO_CAPS_RGB">GST_VIDEO_CAPS_RGB</a>
68 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-RGBA:CAPS" title="GST_VIDEO_CAPS_RGBA">GST_VIDEO_CAPS_RGBA</a>
69 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-RGB-15:CAPS" title="GST_VIDEO_CAPS_RGB_15">GST_VIDEO_CAPS_RGB_15</a>
70 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-RGB-16:CAPS" title="GST_VIDEO_CAPS_RGB_16">GST_VIDEO_CAPS_RGB_16</a>
71 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-RGBx" title="GST_VIDEO_CAPS_RGBx">GST_VIDEO_CAPS_RGBx</a>
72 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-YUV:CAPS" title="GST_VIDEO_CAPS_YUV()">GST_VIDEO_CAPS_YUV</a> (fourcc)
73 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-xBGR" title="GST_VIDEO_CAPS_xBGR">GST_VIDEO_CAPS_xBGR</a>
74 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-xRGB" title="GST_VIDEO_CAPS_xRGB">GST_VIDEO_CAPS_xRGB</a>
75 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-xRGB-HOST-ENDIAN" title="GST_VIDEO_CAPS_xRGB_HOST_ENDIAN">GST_VIDEO_CAPS_xRGB_HOST_ENDIAN</a>
76 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-BGR-15:CAPS" title="GST_VIDEO_CAPS_BGR_15">GST_VIDEO_CAPS_BGR_15</a>
77 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-BGR-16:CAPS" title="GST_VIDEO_CAPS_BGR_16">GST_VIDEO_CAPS_BGR_16</a>
78 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-RGB8-PALETTED:CAPS" title="GST_VIDEO_CAPS_RGB8_PALETTED">GST_VIDEO_CAPS_RGB8_PALETTED</a>
79 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-GRAY8:CAPS" title="GST_VIDEO_CAPS_GRAY8">GST_VIDEO_CAPS_GRAY8</a>
80 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-GRAY16:CAPS" title="GST_VIDEO_CAPS_GRAY16()">GST_VIDEO_CAPS_GRAY16</a> (endianness)
81 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FPS-RANGE:CAPS" title="GST_VIDEO_FPS_RANGE">GST_VIDEO_FPS_RANGE</a>
82 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-GREEN-MASK-15:CAPS" title="GST_VIDEO_GREEN_MASK_15">GST_VIDEO_GREEN_MASK_15</a>
83 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-GREEN-MASK-15-INT:CAPS" title="GST_VIDEO_GREEN_MASK_15_INT">GST_VIDEO_GREEN_MASK_15_INT</a>
84 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-GREEN-MASK-16:CAPS" title="GST_VIDEO_GREEN_MASK_16">GST_VIDEO_GREEN_MASK_16</a>
85 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-GREEN-MASK-16-INT:CAPS" title="GST_VIDEO_GREEN_MASK_16_INT">GST_VIDEO_GREEN_MASK_16_INT</a>
86 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-RED-MASK-15:CAPS" title="GST_VIDEO_RED_MASK_15">GST_VIDEO_RED_MASK_15</a>
87 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-RED-MASK-15-INT:CAPS" title="GST_VIDEO_RED_MASK_15_INT">GST_VIDEO_RED_MASK_15_INT</a>
88 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-RED-MASK-16:CAPS" title="GST_VIDEO_RED_MASK_16">GST_VIDEO_RED_MASK_16</a>
89 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-RED-MASK-16-INT:CAPS" title="GST_VIDEO_RED_MASK_16_INT">GST_VIDEO_RED_MASK_16_INT</a>
90 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-SIZE-RANGE:CAPS" title="GST_VIDEO_SIZE_RANGE">GST_VIDEO_SIZE_RANGE</a>
91 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-TFF:CAPS" title="GST_VIDEO_BUFFER_TFF">GST_VIDEO_BUFFER_TFF</a>
92 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-RFF:CAPS" title="GST_VIDEO_BUFFER_RFF">GST_VIDEO_BUFFER_RFF</a>
93 #define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-ONEFIELD:CAPS" title="GST_VIDEO_BUFFER_ONEFIELD">GST_VIDEO_BUFFER_ONEFIELD</a>
94 enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat">GstVideoFormat</a>;
95 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-calculate-display-ratio" title="gst_video_calculate_display_ratio ()">gst_video_calculate_display_ratio</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *dar_n</code></em>,
96 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *dar_d</code></em>,
97 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_width</code></em>,
98 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_height</code></em>,
99 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_par_n</code></em>,
100 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_par_d</code></em>,
101 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> display_par_n</code></em>,
102 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> display_par_d</code></em>);
103 const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-rate" title="gst_video_frame_rate ()">gst_video_frame_rate</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);
104 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-get-size" title="gst_video_get_size ()">gst_video_get_size</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
105 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
106 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);
107 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-convert" title="gst_video_format_convert ()">gst_video_format_convert</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
108 <em class="parameter"><code><span class="type">int</span> width</code></em>,
109 <em class="parameter"><code><span class="type">int</span> height</code></em>,
110 <em class="parameter"><code><span class="type">int</span> fps_n</code></em>,
111 <em class="parameter"><code><span class="type">int</span> fps_d</code></em>,
112 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_format</code></em>,
113 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> src_value</code></em>,
114 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_format</code></em>,
115 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> *dest_value</code></em>);
116 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-new-caps" title="gst_video_format_new_caps ()">gst_video_format_new_caps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
117 <em class="parameter"><code><span class="type">int</span> width</code></em>,
118 <em class="parameter"><code><span class="type">int</span> height</code></em>,
119 <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
120 <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
121 <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
122 <em class="parameter"><code><span class="type">int</span> par_d</code></em>);
123 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-new-caps-interlaced" title="gst_video_format_new_caps_interlaced ()">gst_video_format_new_caps_interlaced</a>
124 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
125 <em class="parameter"><code><span class="type">int</span> width</code></em>,
126 <em class="parameter"><code><span class="type">int</span> height</code></em>,
127 <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
128 <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
129 <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
130 <em class="parameter"><code><span class="type">int</span> par_d</code></em>,
131 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> interlaced</code></em>);
132 <span class="returnvalue">int</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-component-height" title="gst_video_format_get_component_height ()">gst_video_format_get_component_height</a>
133 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
134 <em class="parameter"><code><span class="type">int</span> component</code></em>,
135 <em class="parameter"><code><span class="type">int</span> height</code></em>);
136 <span class="returnvalue">int</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-component-offset" title="gst_video_format_get_component_offset ()">gst_video_format_get_component_offset</a>
137 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
138 <em class="parameter"><code><span class="type">int</span> component</code></em>,
139 <em class="parameter"><code><span class="type">int</span> width</code></em>,
140 <em class="parameter"><code><span class="type">int</span> height</code></em>);
141 <span class="returnvalue">int</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-component-width" title="gst_video_format_get_component_width ()">gst_video_format_get_component_width</a>
142 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
143 <em class="parameter"><code><span class="type">int</span> component</code></em>,
144 <em class="parameter"><code><span class="type">int</span> width</code></em>);
145 <span class="returnvalue">int</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-pixel-stride" title="gst_video_format_get_pixel_stride ()">gst_video_format_get_pixel_stride</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
146 <em class="parameter"><code><span class="type">int</span> component</code></em>);
147 <span class="returnvalue">int</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-row-stride" title="gst_video_format_get_row_stride ()">gst_video_format_get_row_stride</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
148 <em class="parameter"><code><span class="type">int</span> component</code></em>,
149 <em class="parameter"><code><span class="type">int</span> width</code></em>);
150 <span class="returnvalue">int</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-size" title="gst_video_format_get_size ()">gst_video_format_get_size</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
151 <em class="parameter"><code><span class="type">int</span> width</code></em>,
152 <em class="parameter"><code><span class="type">int</span> height</code></em>);
153 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-has-alpha" title="gst_video_format_has_alpha ()">gst_video_format_has_alpha</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);
154 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-is-rgb" title="gst_video_format_is_rgb ()">gst_video_format_is_rgb</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);
155 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-is-gray" title="gst_video_format_is_gray ()">gst_video_format_is_gray</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);
156 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-is-yuv" title="gst_video_format_is_yuv ()">gst_video_format_is_yuv</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);
157 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-to-fourcc" title="gst_video_format_to_fourcc ()">gst_video_format_to_fourcc</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);
158 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-from-fourcc" title="gst_video_format_from_fourcc ()">gst_video_format_from_fourcc</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> fourcc</code></em>);
159 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-parse-caps" title="gst_video_format_parse_caps ()">gst_video_format_parse_caps</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
160 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> *format</code></em>,
161 <em class="parameter"><code><span class="type">int</span> *width</code></em>,
162 <em class="parameter"><code><span class="type">int</span> *height</code></em>);
163 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-parse-caps-interlaced" title="gst_video_format_parse_caps_interlaced ()">gst_video_format_parse_caps_interlaced</a>
164 (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
165 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *interlaced</code></em>);
166 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-parse-caps-framerate" title="gst_video_parse_caps_framerate ()">gst_video_parse_caps_framerate</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
167 <em class="parameter"><code><span class="type">int</span> *fps_n</code></em>,
168 <em class="parameter"><code><span class="type">int</span> *fps_d</code></em>);
169 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-parse-caps-pixel-aspect-ratio" title="gst_video_parse_caps_pixel_aspect_ratio ()">gst_video_parse_caps_pixel_aspect_ratio</a>
170 (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
171 <em class="parameter"><code><span class="type">int</span> *par_n</code></em>,
172 <em class="parameter"><code><span class="type">int</span> *par_d</code></em>);
173 const <span class="returnvalue">char</span> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-parse-caps-color-matrix" title="gst_video_parse_caps_color_matrix ()">gst_video_parse_caps_color_matrix</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
174 const <span class="returnvalue">char</span> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-parse-caps-chroma-site" title="gst_video_parse_caps_chroma_site ()">gst_video_parse_caps_chroma_site</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
175 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-parse-caps-palette" title="gst_video_parse_caps_palette ()">gst_video_parse_caps_palette</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
176 <span class="returnvalue">void</span> (<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertFrameCallback" title="GstVideoConvertFrameCallback ()">*GstVideoConvertFrameCallback</a>) (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
177 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
178 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
179 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-convert-frame" title="gst_video_convert_frame ()">gst_video_convert_frame</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
180 <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *to_caps</code></em>,
181 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timeout</code></em>,
182 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
183 <span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-convert-frame-async" title="gst_video_convert_frame_async ()">gst_video_convert_frame_async</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
184 <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *to_caps</code></em>,
185 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timeout</code></em>,
186 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertFrameCallback" title="GstVideoConvertFrameCallback ()"><span class="type">GstVideoConvertFrameCallback</span></a> callback</code></em>,
187 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
188 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_notify</code></em>);
189 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="returnvalue">GstEvent</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-still-frame" title="gst_video_event_new_still_frame ()">gst_video_event_new_still_frame</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> in_still</code></em>);
190 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-parse-still-frame" title="gst_video_event_parse_still_frame ()">gst_video_event_parse_still_frame</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
191 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *in_still</code></em>);
194 <div class="refsect1">
195 <a name="gst-plugins-base-libs-gstvideo.description"></a><h2>Description</h2>
198 <div class="refsect2">
199 <a name="idp28861408"></a><p>
200 This library contains some helper functions and includes the
201 videosink and videofilter base classes.
207 <div class="refsect1">
208 <a name="gst-plugins-base-libs-gstvideo.details"></a><h2>Details</h2>
209 <div class="refsect2">
210 <a name="GST-VIDEO-BLUE-MASK-15:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_15</h3>
211 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_15 GST_VIDEO_COMP3_MASK_15
213 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
214 <h3 class="title">Warning</h3>
215 <p><code class="literal">GST_VIDEO_BLUE_MASK_15</code> is deprecated and should not be used in newly-written code.</p>
219 <div class="refsect2">
220 <a name="GST-VIDEO-BLUE-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_15_INT</h3>
221 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_15_INT GST_VIDEO_COMP3_MASK_15_INT
223 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
224 <h3 class="title">Warning</h3>
225 <p><code class="literal">GST_VIDEO_BLUE_MASK_15_INT</code> is deprecated and should not be used in newly-written code.</p>
229 <div class="refsect2">
230 <a name="GST-VIDEO-BLUE-MASK-16:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_16</h3>
231 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_16 GST_VIDEO_COMP3_MASK_16
233 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
234 <h3 class="title">Warning</h3>
235 <p><code class="literal">GST_VIDEO_BLUE_MASK_16</code> is deprecated and should not be used in newly-written code.</p>
239 <div class="refsect2">
240 <a name="GST-VIDEO-BLUE-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_16_INT</h3>
241 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_16_INT GST_VIDEO_COMP3_MASK_16_INT
243 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
244 <h3 class="title">Warning</h3>
245 <p><code class="literal">GST_VIDEO_BLUE_MASK_16_INT</code> is deprecated and should not be used in newly-written code.</p>
249 <div class="refsect2">
250 <a name="GST-VIDEO-BYTE1-MASK-24:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_24</h3>
251 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_24 "0x00FF0000"
255 <div class="refsect2">
256 <a name="GST-VIDEO-BYTE1-MASK-24-INT:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_24_INT</h3>
257 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_24_INT 0x00FF0000
261 <div class="refsect2">
262 <a name="GST-VIDEO-BYTE1-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_32</h3>
263 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_32 "0xFF000000"
267 <div class="refsect2">
268 <a name="GST-VIDEO-BYTE1-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_32_INT</h3>
269 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_32_INT 0xFF000000
273 <div class="refsect2">
274 <a name="GST-VIDEO-BYTE2-MASK-24:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_24</h3>
275 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_24 "0x0000FF00"
279 <div class="refsect2">
280 <a name="GST-VIDEO-BYTE2-MASK-24-INT:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_24_INT</h3>
281 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_24_INT 0x0000FF00
285 <div class="refsect2">
286 <a name="GST-VIDEO-BYTE2-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_32</h3>
287 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_32 "0x00FF0000"
291 <div class="refsect2">
292 <a name="GST-VIDEO-BYTE2-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_32_INT</h3>
293 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_32_INT 0x00FF0000
297 <div class="refsect2">
298 <a name="GST-VIDEO-BYTE3-MASK-24:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_24</h3>
299 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_24 "0x000000FF"
303 <div class="refsect2">
304 <a name="GST-VIDEO-BYTE3-MASK-24-INT:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_24_INT</h3>
305 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_24_INT 0x000000FF
309 <div class="refsect2">
310 <a name="GST-VIDEO-BYTE3-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_32</h3>
311 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_32 "0x0000FF00"
315 <div class="refsect2">
316 <a name="GST-VIDEO-BYTE3-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_32_INT</h3>
317 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_32_INT 0x0000FF00
321 <div class="refsect2">
322 <a name="GST-VIDEO-BYTE4-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE4_MASK_32</h3>
323 <pre class="programlisting">#define GST_VIDEO_BYTE4_MASK_32 "0x000000FF"
327 <div class="refsect2">
328 <a name="GST-VIDEO-BYTE4-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE4_MASK_32_INT</h3>
329 <pre class="programlisting">#define GST_VIDEO_BYTE4_MASK_32_INT 0x000000FF
333 <div class="refsect2">
334 <a name="GST-VIDEO-CAPS-ABGR:CAPS"></a><h3>GST_VIDEO_CAPS_ABGR</h3>
335 <pre class="programlisting">#define GST_VIDEO_CAPS_ABGR</pre>
338 <div class="refsect2">
339 <a name="GST-VIDEO-CAPS-ARGB:CAPS"></a><h3>GST_VIDEO_CAPS_ARGB</h3>
340 <pre class="programlisting">#define GST_VIDEO_CAPS_ARGB</pre>
343 <div class="refsect2">
344 <a name="GST-VIDEO-CAPS-BGR:CAPS"></a><h3>GST_VIDEO_CAPS_BGR</h3>
345 <pre class="programlisting">#define GST_VIDEO_CAPS_BGR</pre>
348 <div class="refsect2">
349 <a name="GST-VIDEO-CAPS-BGRA:CAPS"></a><h3>GST_VIDEO_CAPS_BGRA</h3>
350 <pre class="programlisting">#define GST_VIDEO_CAPS_BGRA</pre>
353 <div class="refsect2">
354 <a name="GST-VIDEO-CAPS-BGRx"></a><h3>GST_VIDEO_CAPS_BGRx</h3>
355 <pre class="programlisting">#define GST_VIDEO_CAPS_BGRx</pre>
358 <div class="refsect2">
359 <a name="GST-VIDEO-CAPS-BGRx-HOST-ENDIAN"></a><h3>GST_VIDEO_CAPS_BGRx_HOST_ENDIAN</h3>
360 <pre class="programlisting">#define GST_VIDEO_CAPS_BGRx_HOST_ENDIAN</pre>
363 <div class="refsect2">
364 <a name="GST-VIDEO-CAPS-RGB:CAPS"></a><h3>GST_VIDEO_CAPS_RGB</h3>
365 <pre class="programlisting">#define GST_VIDEO_CAPS_RGB</pre>
368 <div class="refsect2">
369 <a name="GST-VIDEO-CAPS-RGBA:CAPS"></a><h3>GST_VIDEO_CAPS_RGBA</h3>
370 <pre class="programlisting">#define GST_VIDEO_CAPS_RGBA</pre>
373 <div class="refsect2">
374 <a name="GST-VIDEO-CAPS-RGB-15:CAPS"></a><h3>GST_VIDEO_CAPS_RGB_15</h3>
375 <pre class="programlisting">#define GST_VIDEO_CAPS_RGB_15</pre>
378 <div class="refsect2">
379 <a name="GST-VIDEO-CAPS-RGB-16:CAPS"></a><h3>GST_VIDEO_CAPS_RGB_16</h3>
380 <pre class="programlisting">#define GST_VIDEO_CAPS_RGB_16</pre>
383 <div class="refsect2">
384 <a name="GST-VIDEO-CAPS-RGBx"></a><h3>GST_VIDEO_CAPS_RGBx</h3>
385 <pre class="programlisting">#define GST_VIDEO_CAPS_RGBx</pre>
388 <div class="refsect2">
389 <a name="GST-VIDEO-CAPS-YUV:CAPS"></a><h3>GST_VIDEO_CAPS_YUV()</h3>
390 <pre class="programlisting">#define GST_VIDEO_CAPS_YUV(fourcc)</pre>
392 Generic caps string for YUV video, for use in pad templates.
394 <div class="variablelist"><table border="0">
395 <col align="left" valign="top">
397 <td><p><span class="term"><em class="parameter"><code>fourcc</code></em> :</span></p></td>
398 <td>YUV fourcc format that describes the pixel layout, as string
399 (e.g. "I420", "YV12", "YUY2", "AYUV", etc.)</td>
404 <div class="refsect2">
405 <a name="GST-VIDEO-CAPS-xBGR"></a><h3>GST_VIDEO_CAPS_xBGR</h3>
406 <pre class="programlisting">#define GST_VIDEO_CAPS_xBGR</pre>
409 <div class="refsect2">
410 <a name="GST-VIDEO-CAPS-xRGB"></a><h3>GST_VIDEO_CAPS_xRGB</h3>
411 <pre class="programlisting">#define GST_VIDEO_CAPS_xRGB</pre>
414 <div class="refsect2">
415 <a name="GST-VIDEO-CAPS-xRGB-HOST-ENDIAN"></a><h3>GST_VIDEO_CAPS_xRGB_HOST_ENDIAN</h3>
416 <pre class="programlisting">#define GST_VIDEO_CAPS_xRGB_HOST_ENDIAN</pre>
419 <div class="refsect2">
420 <a name="GST-VIDEO-CAPS-BGR-15:CAPS"></a><h3>GST_VIDEO_CAPS_BGR_15</h3>
421 <pre class="programlisting">#define GST_VIDEO_CAPS_BGR_15</pre>
424 <div class="refsect2">
425 <a name="GST-VIDEO-CAPS-BGR-16:CAPS"></a><h3>GST_VIDEO_CAPS_BGR_16</h3>
426 <pre class="programlisting">#define GST_VIDEO_CAPS_BGR_16</pre>
429 <div class="refsect2">
430 <a name="GST-VIDEO-CAPS-RGB8-PALETTED:CAPS"></a><h3>GST_VIDEO_CAPS_RGB8_PALETTED</h3>
431 <pre class="programlisting">#define GST_VIDEO_CAPS_RGB8_PALETTED</pre>
433 Generic caps string for 8-bit paletted RGB video, for use in pad templates.
435 <p class="since">Since 0.10.32</p>
438 <div class="refsect2">
439 <a name="GST-VIDEO-CAPS-GRAY8:CAPS"></a><h3>GST_VIDEO_CAPS_GRAY8</h3>
440 <pre class="programlisting">#define GST_VIDEO_CAPS_GRAY8</pre>
442 Generic caps string for 8-bit grayscale video, for use in pad templates.
444 <p class="since">Since 0.10.29</p>
447 <div class="refsect2">
448 <a name="GST-VIDEO-CAPS-GRAY16:CAPS"></a><h3>GST_VIDEO_CAPS_GRAY16()</h3>
449 <pre class="programlisting">#define GST_VIDEO_CAPS_GRAY16(endianness)</pre>
451 Generic caps string for 16-bit grayscale video, for use in pad templates.
453 <div class="variablelist"><table border="0">
454 <col align="left" valign="top">
456 <td><p><span class="term"><em class="parameter"><code>endianness</code></em> :</span></p></td>
457 <td>endianness as string, ie. either "1234", "4321", "BIG_ENDIAN"
458 or "LITTLE_ENDIAN"</td>
461 <p class="since">Since 0.10.29</p>
464 <div class="refsect2">
465 <a name="GST-VIDEO-FPS-RANGE:CAPS"></a><h3>GST_VIDEO_FPS_RANGE</h3>
466 <pre class="programlisting">#define GST_VIDEO_FPS_RANGE "(fraction) [ 0, max ]"
470 <div class="refsect2">
471 <a name="GST-VIDEO-GREEN-MASK-15:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_15</h3>
472 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_15 GST_VIDEO_COMP2_MASK_15
474 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
475 <h3 class="title">Warning</h3>
476 <p><code class="literal">GST_VIDEO_GREEN_MASK_15</code> is deprecated and should not be used in newly-written code.</p>
480 <div class="refsect2">
481 <a name="GST-VIDEO-GREEN-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_15_INT</h3>
482 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_15_INT GST_VIDEO_COMP2_MASK_15_INT
484 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
485 <h3 class="title">Warning</h3>
486 <p><code class="literal">GST_VIDEO_GREEN_MASK_15_INT</code> is deprecated and should not be used in newly-written code.</p>
490 <div class="refsect2">
491 <a name="GST-VIDEO-GREEN-MASK-16:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_16</h3>
492 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_16 GST_VIDEO_COMP2_MASK_16
494 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
495 <h3 class="title">Warning</h3>
496 <p><code class="literal">GST_VIDEO_GREEN_MASK_16</code> is deprecated and should not be used in newly-written code.</p>
500 <div class="refsect2">
501 <a name="GST-VIDEO-GREEN-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_16_INT</h3>
502 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_16_INT GST_VIDEO_COMP2_MASK_16_INT
504 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
505 <h3 class="title">Warning</h3>
506 <p><code class="literal">GST_VIDEO_GREEN_MASK_16_INT</code> is deprecated and should not be used in newly-written code.</p>
510 <div class="refsect2">
511 <a name="GST-VIDEO-RED-MASK-15:CAPS"></a><h3>GST_VIDEO_RED_MASK_15</h3>
512 <pre class="programlisting">#define GST_VIDEO_RED_MASK_15 GST_VIDEO_COMP1_MASK_15
514 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
515 <h3 class="title">Warning</h3>
516 <p><code class="literal">GST_VIDEO_RED_MASK_15</code> is deprecated and should not be used in newly-written code.</p>
520 <div class="refsect2">
521 <a name="GST-VIDEO-RED-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_RED_MASK_15_INT</h3>
522 <pre class="programlisting">#define GST_VIDEO_RED_MASK_15_INT GST_VIDEO_COMP1_MASK_15_INT
524 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
525 <h3 class="title">Warning</h3>
526 <p><code class="literal">GST_VIDEO_RED_MASK_15_INT</code> is deprecated and should not be used in newly-written code.</p>
530 <div class="refsect2">
531 <a name="GST-VIDEO-RED-MASK-16:CAPS"></a><h3>GST_VIDEO_RED_MASK_16</h3>
532 <pre class="programlisting">#define GST_VIDEO_RED_MASK_16 GST_VIDEO_COMP1_MASK_16
534 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
535 <h3 class="title">Warning</h3>
536 <p><code class="literal">GST_VIDEO_RED_MASK_16</code> is deprecated and should not be used in newly-written code.</p>
540 <div class="refsect2">
541 <a name="GST-VIDEO-RED-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_RED_MASK_16_INT</h3>
542 <pre class="programlisting">#define GST_VIDEO_RED_MASK_16_INT GST_VIDEO_COMP1_MASK_16_INT
544 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
545 <h3 class="title">Warning</h3>
546 <p><code class="literal">GST_VIDEO_RED_MASK_16_INT</code> is deprecated and should not be used in newly-written code.</p>
550 <div class="refsect2">
551 <a name="GST-VIDEO-SIZE-RANGE:CAPS"></a><h3>GST_VIDEO_SIZE_RANGE</h3>
552 <pre class="programlisting">#define GST_VIDEO_SIZE_RANGE "(int) [ 1, max ]"
556 <div class="refsect2">
557 <a name="GST-VIDEO-BUFFER-TFF:CAPS"></a><h3>GST_VIDEO_BUFFER_TFF</h3>
558 <pre class="programlisting">#define GST_VIDEO_BUFFER_TFF GST_BUFFER_FLAG_MEDIA1
561 If the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> is interlaced, then the first field in the video frame is
562 the top field. If unset, the bottom field is first.
564 <p class="since">Since 0.10.23</p>
567 <div class="refsect2">
568 <a name="GST-VIDEO-BUFFER-RFF:CAPS"></a><h3>GST_VIDEO_BUFFER_RFF</h3>
569 <pre class="programlisting">#define GST_VIDEO_BUFFER_RFF GST_BUFFER_FLAG_MEDIA2
572 If the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> is interlaced, then the first field (as defined by the
573 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-TFF:CAPS" title="GST_VIDEO_BUFFER_TFF"><code class="literal">GST_VIDEO_BUFFER_TFF</code></a> flag setting) is repeated.
575 <p class="since">Since 0.10.23</p>
578 <div class="refsect2">
579 <a name="GST-VIDEO-BUFFER-ONEFIELD:CAPS"></a><h3>GST_VIDEO_BUFFER_ONEFIELD</h3>
580 <pre class="programlisting">#define GST_VIDEO_BUFFER_ONEFIELD GST_BUFFER_FLAG_MEDIA3
583 If the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> is interlaced, then only the first field (as defined by the
584 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-TFF:CAPS" title="GST_VIDEO_BUFFER_TFF"><code class="literal">GST_VIDEO_BUFFER_TFF</code></a> flag setting) is to be displayed.
586 <p class="since">Since 0.10.23</p>
589 <div class="refsect2">
590 <a name="GstVideoFormat"></a><h3>enum GstVideoFormat</h3>
591 <pre class="programlisting">typedef enum {
592 GST_VIDEO_FORMAT_UNKNOWN,
593 GST_VIDEO_FORMAT_I420,
594 GST_VIDEO_FORMAT_YV12,
595 GST_VIDEO_FORMAT_YUY2,
596 GST_VIDEO_FORMAT_UYVY,
597 GST_VIDEO_FORMAT_AYUV,
598 GST_VIDEO_FORMAT_RGBx,
599 GST_VIDEO_FORMAT_BGRx,
600 GST_VIDEO_FORMAT_xRGB,
601 GST_VIDEO_FORMAT_xBGR,
602 GST_VIDEO_FORMAT_RGBA,
603 GST_VIDEO_FORMAT_BGRA,
604 GST_VIDEO_FORMAT_ARGB,
605 GST_VIDEO_FORMAT_ABGR,
606 GST_VIDEO_FORMAT_RGB,
607 GST_VIDEO_FORMAT_BGR,
608 GST_VIDEO_FORMAT_Y41B,
609 GST_VIDEO_FORMAT_Y42B,
610 GST_VIDEO_FORMAT_YVYU,
611 GST_VIDEO_FORMAT_Y444,
612 GST_VIDEO_FORMAT_v210,
613 GST_VIDEO_FORMAT_v216,
614 GST_VIDEO_FORMAT_NV12,
615 GST_VIDEO_FORMAT_NV21,
616 GST_VIDEO_FORMAT_GRAY8,
617 GST_VIDEO_FORMAT_GRAY16_BE,
618 GST_VIDEO_FORMAT_GRAY16_LE,
619 GST_VIDEO_FORMAT_v308,
620 GST_VIDEO_FORMAT_Y800,
621 GST_VIDEO_FORMAT_Y16,
622 GST_VIDEO_FORMAT_RGB16,
623 GST_VIDEO_FORMAT_BGR16,
624 GST_VIDEO_FORMAT_RGB15,
625 GST_VIDEO_FORMAT_BGR15,
626 GST_VIDEO_FORMAT_UYVP,
627 GST_VIDEO_FORMAT_A420,
628 GST_VIDEO_FORMAT_RGB8_PALETTED,
629 GST_VIDEO_FORMAT_YUV9,
630 GST_VIDEO_FORMAT_YVU9,
631 GST_VIDEO_FORMAT_IYU1,
632 GST_VIDEO_FORMAT_ARGB64,
633 GST_VIDEO_FORMAT_AYUV64,
634 GST_VIDEO_FORMAT_r210
638 Enum value describing the most common video formats.
640 <div class="variablelist"><table border="0">
641 <col align="left" valign="top">
644 <td><p><a name="GST-VIDEO-FORMAT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UNKNOWN</code></span></p></td>
645 <td>Unknown or unset video format id
649 <td><p><a name="GST-VIDEO-FORMAT-I420:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I420</code></span></p></td>
654 <td><p><a name="GST-VIDEO-FORMAT-YV12:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YV12</code></span></p></td>
655 <td>planar 4:2:0 YVU (like I420 but UV planes swapped)
659 <td><p><a name="GST-VIDEO-FORMAT-YUY2:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YUY2</code></span></p></td>
660 <td>packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)
664 <td><p><a name="GST-VIDEO-FORMAT-UYVY:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UYVY</code></span></p></td>
665 <td>packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)
669 <td><p><a name="GST-VIDEO-FORMAT-AYUV:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_AYUV</code></span></p></td>
670 <td>packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)
674 <td><p><a name="GST-VIDEO-FORMAT-RGBx"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGBx</code></span></p></td>
675 <td>sparse rgb packed into 32 bit, space last
679 <td><p><a name="GST-VIDEO-FORMAT-BGRx"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGRx</code></span></p></td>
680 <td>sparse reverse rgb packed into 32 bit, space last
684 <td><p><a name="GST-VIDEO-FORMAT-xRGB"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_xRGB</code></span></p></td>
685 <td>sparse rgb packed into 32 bit, space first
689 <td><p><a name="GST-VIDEO-FORMAT-xBGR"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_xBGR</code></span></p></td>
690 <td>sparse reverse rgb packed into 32 bit, space first
694 <td><p><a name="GST-VIDEO-FORMAT-RGBA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGBA</code></span></p></td>
695 <td>rgb with alpha channel last
699 <td><p><a name="GST-VIDEO-FORMAT-BGRA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGRA</code></span></p></td>
700 <td>reverse rgb with alpha channel last
704 <td><p><a name="GST-VIDEO-FORMAT-ARGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ARGB</code></span></p></td>
705 <td>rgb with alpha channel first
709 <td><p><a name="GST-VIDEO-FORMAT-ABGR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ABGR</code></span></p></td>
710 <td>reverse rgb with alpha channel first
714 <td><p><a name="GST-VIDEO-FORMAT-RGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB</code></span></p></td>
719 <td><p><a name="GST-VIDEO-FORMAT-BGR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR</code></span></p></td>
724 <td><p><a name="GST-VIDEO-FORMAT-Y41B:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y41B</code></span></p></td>
725 <td>planar 4:1:1 YUV (Since: 0.10.18)
729 <td><p><a name="GST-VIDEO-FORMAT-Y42B:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y42B</code></span></p></td>
730 <td>planar 4:2:2 YUV (Since: 0.10.18)
734 <td><p><a name="GST-VIDEO-FORMAT-YVYU:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YVYU</code></span></p></td>
735 <td>packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...) (Since: 0.10.23)
739 <td><p><a name="GST-VIDEO-FORMAT-Y444:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y444</code></span></p></td>
740 <td>planar 4:4:4 YUV (Since: 0.10.24)
744 <td><p><a name="GST-VIDEO-FORMAT-v210"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v210</code></span></p></td>
745 <td>packed 4:2:2 10-bit YUV, complex format (Since: 0.10.24)
749 <td><p><a name="GST-VIDEO-FORMAT-v216"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v216</code></span></p></td>
750 <td>packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order (Since: 0.10.24)
754 <td><p><a name="GST-VIDEO-FORMAT-NV12:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV12</code></span></p></td>
755 <td>planar 4:2:0 YUV with interleaved UV plane (Since: 0.10.26)
759 <td><p><a name="GST-VIDEO-FORMAT-NV21:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV21</code></span></p></td>
760 <td>planar 4:2:0 YUV with interleaved VU plane (Since: 0.10.26)
764 <td><p><a name="GST-VIDEO-FORMAT-GRAY8:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GRAY8</code></span></p></td>
765 <td>8-bit grayscale (Since: 0.10.29)
769 <td><p><a name="GST-VIDEO-FORMAT-GRAY16-BE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GRAY16_BE</code></span></p></td>
770 <td>16-bit grayscale, most significant byte first (Since: 0.10.29)
774 <td><p><a name="GST-VIDEO-FORMAT-GRAY16-LE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GRAY16_LE</code></span></p></td>
775 <td>16-bit grayscale, least significant byte first (Since: 0.10.29)
779 <td><p><a name="GST-VIDEO-FORMAT-v308"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v308</code></span></p></td>
780 <td>packed 4:4:4 YUV (Since: 0.10.29)
784 <td><p><a name="GST-VIDEO-FORMAT-Y800:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y800</code></span></p></td>
785 <td>same as GST_VIDEO_FORMAT_GRAY8 (Since: 0.10.30)
789 <td><p><a name="GST-VIDEO-FORMAT-Y16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y16</code></span></p></td>
790 <td>same as GST_VIDEO_FORMAT_GRAY16_LE (Since: 0.10.30)
794 <td><p><a name="GST-VIDEO-FORMAT-RGB16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB16</code></span></p></td>
795 <td>rgb 5-6-5 bits per component (Since: 0.10.30)
799 <td><p><a name="GST-VIDEO-FORMAT-BGR16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR16</code></span></p></td>
800 <td>reverse rgb 5-6-5 bits per component (Since: 0.10.30)
804 <td><p><a name="GST-VIDEO-FORMAT-RGB15:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB15</code></span></p></td>
805 <td>rgb 5-5-5 bits per component (Since: 0.10.30)
809 <td><p><a name="GST-VIDEO-FORMAT-BGR15:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR15</code></span></p></td>
810 <td>reverse rgb 5-5-5 bits per component (Since: 0.10.30)
814 <td><p><a name="GST-VIDEO-FORMAT-UYVP:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UYVP</code></span></p></td>
815 <td>packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) (Since: 0.10.31)
819 <td><p><a name="GST-VIDEO-FORMAT-A420:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_A420</code></span></p></td>
820 <td>planar 4:4:2:0 AYUV (Since: 0.10.31)
824 <td><p><a name="GST-VIDEO-FORMAT-RGB8-PALETTED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB8_PALETTED</code></span></p></td>
825 <td>8-bit paletted RGB (Since: 0.10.32)
829 <td><p><a name="GST-VIDEO-FORMAT-YUV9:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YUV9</code></span></p></td>
830 <td>planar 4:1:0 YUV (Since: 0.10.32)
834 <td><p><a name="GST-VIDEO-FORMAT-YVU9:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YVU9</code></span></p></td>
835 <td>planar 4:1:0 YUV (like YUV9 but UV planes swapped) (Since: 0.10.32)
839 <td><p><a name="GST-VIDEO-FORMAT-IYU1:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_IYU1</code></span></p></td>
840 <td>packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...) (Since: 0.10.32)
844 <td><p><a name="GST-VIDEO-FORMAT-ARGB64:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ARGB64</code></span></p></td>
845 <td>rgb with alpha channel first, 16 bits per channel (Since: 0.10.33)
849 <td><p><a name="GST-VIDEO-FORMAT-AYUV64:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_AYUV64</code></span></p></td>
850 <td>packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...) (Since: 0.10.33)
854 <td><p><a name="GST-VIDEO-FORMAT-r210"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_r210</code></span></p></td>
855 <td>packed 4:4:4 RGB, 10 bits per channel (Since: 0.10.33)
862 <div class="refsect2">
863 <a name="gst-video-calculate-display-ratio"></a><h3>gst_video_calculate_display_ratio ()</h3>
864 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_calculate_display_ratio (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *dar_n</code></em>,
865 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *dar_d</code></em>,
866 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_width</code></em>,
867 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_height</code></em>,
868 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_par_n</code></em>,
869 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> video_par_d</code></em>,
870 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> display_par_n</code></em>,
871 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> display_par_d</code></em>);</pre>
873 Given the Pixel Aspect Ratio and size of an input video frame, and the
874 pixel aspect ratio of the intended display device, calculates the actual
875 display ratio the video will be rendered with.
877 <div class="variablelist"><table border="0">
878 <col align="left" valign="top">
881 <td><p><span class="term"><em class="parameter"><code>dar_n</code></em> :</span></p></td>
882 <td>Numerator of the calculated display_ratio</td>
885 <td><p><span class="term"><em class="parameter"><code>dar_d</code></em> :</span></p></td>
886 <td>Denominator of the calculated display_ratio</td>
889 <td><p><span class="term"><em class="parameter"><code>video_width</code></em> :</span></p></td>
890 <td>Width of the video frame in pixels</td>
893 <td><p><span class="term"><em class="parameter"><code>video_height</code></em> :</span></p></td>
894 <td>Height of the video frame in pixels</td>
897 <td><p><span class="term"><em class="parameter"><code>video_par_n</code></em> :</span></p></td>
898 <td>Numerator of the pixel aspect ratio of the input video.</td>
901 <td><p><span class="term"><em class="parameter"><code>video_par_d</code></em> :</span></p></td>
902 <td>Denominator of the pixel aspect ratio of the input video.</td>
905 <td><p><span class="term"><em class="parameter"><code>display_par_n</code></em> :</span></p></td>
906 <td>Numerator of the pixel aspect ratio of the display device</td>
909 <td><p><span class="term"><em class="parameter"><code>display_par_d</code></em> :</span></p></td>
910 <td>Denominator of the pixel aspect ratio of the display device</td>
913 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
914 <td>A boolean indicating success and a calculated Display Ratio in the
915 dar_n and dar_d parameters.
916 The return value is FALSE in the case of integer overflow or other error.</td>
920 <p class="since">Since 0.10.7</p>
923 <div class="refsect2">
924 <a name="gst-video-frame-rate"></a><h3>gst_video_frame_rate ()</h3>
925 <pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * gst_video_frame_rate (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);</pre>
927 A convenience function to retrieve a GValue holding the framerate
928 from the caps on a pad.
931 The pad needs to have negotiated caps containing a framerate property.
933 <div class="variablelist"><table border="0">
934 <col align="left" valign="top">
937 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
938 <td>pointer to a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>
942 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
943 <td>NULL if the pad has no configured caps or the configured caps
944 do not contain a framerate.</td>
950 <div class="refsect2">
951 <a name="gst-video-get-size"></a><h3>gst_video_get_size ()</h3>
952 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_get_size (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>,
953 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
954 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);</pre>
956 Inspect the caps of the provided pad and retrieve the width and height of
957 the video frames it is configured for.
960 The pad needs to have negotiated caps containing width and height properties.
962 <div class="variablelist"><table border="0">
963 <col align="left" valign="top">
966 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
967 <td>pointer to a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>
971 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
972 <td>pointer to integer to hold pixel width of the video frames (output)</td>
975 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
976 <td>pointer to integer to hold pixel height of the video frames (output)</td>
979 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
980 <td>TRUE if the width and height could be retrieved.</td>
986 <div class="refsect2">
987 <a name="gst-video-format-convert"></a><h3>gst_video_format_convert ()</h3>
988 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_convert (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
989 <em class="parameter"><code><span class="type">int</span> width</code></em>,
990 <em class="parameter"><code><span class="type">int</span> height</code></em>,
991 <em class="parameter"><code><span class="type">int</span> fps_n</code></em>,
992 <em class="parameter"><code><span class="type">int</span> fps_d</code></em>,
993 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> src_format</code></em>,
994 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> src_value</code></em>,
995 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> dest_format</code></em>,
996 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> *dest_value</code></em>);</pre>
998 Converts among various <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> types. This function handles
999 GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
1000 raw video, GST_FORMAT_DEFAULT corresponds to video frames. This
1001 function can be to handle pad queries of the type GST_QUERY_CONVERT.
1003 <div class="variablelist"><table border="0">
1004 <col align="left" valign="top">
1007 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1008 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1012 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1013 <td>the width of video</td>
1016 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1017 <td>the height of video</td>
1020 <td><p><span class="term"><em class="parameter"><code>fps_n</code></em> :</span></p></td>
1021 <td>frame rate numerator</td>
1024 <td><p><span class="term"><em class="parameter"><code>fps_d</code></em> :</span></p></td>
1025 <td>frame rate denominator</td>
1028 <td><p><span class="term"><em class="parameter"><code>src_format</code></em> :</span></p></td>
1030 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> of the <em class="parameter"><code>src_value</code></em>
1034 <td><p><span class="term"><em class="parameter"><code>src_value</code></em> :</span></p></td>
1035 <td>value to convert</td>
1038 <td><p><span class="term"><em class="parameter"><code>dest_format</code></em> :</span></p></td>
1040 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstFormat.html#GstFormat"><span class="type">GstFormat</span></a> of the <em class="parameter"><code>dest_value</code></em>
1044 <td><p><span class="term"><em class="parameter"><code>dest_value</code></em> :</span></p></td>
1045 <td>pointer to destination value</td>
1048 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1049 <td>TRUE if the conversion was successful.</td>
1053 <p class="since">Since 0.10.16</p>
1056 <div class="refsect2">
1057 <a name="gst-video-format-new-caps"></a><h3>gst_video_format_new_caps ()</h3>
1058 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * gst_video_format_new_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1059 <em class="parameter"><code><span class="type">int</span> width</code></em>,
1060 <em class="parameter"><code><span class="type">int</span> height</code></em>,
1061 <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
1062 <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
1063 <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
1064 <em class="parameter"><code><span class="type">int</span> par_d</code></em>);</pre>
1066 Creates a new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> object based on the parameters provided.
1068 <div class="variablelist"><table border="0">
1069 <col align="left" valign="top">
1072 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1073 <td>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> describing the raw video format</td>
1076 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1077 <td>width of video</td>
1080 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1081 <td>height of video</td>
1084 <td><p><span class="term"><em class="parameter"><code>framerate_n</code></em> :</span></p></td>
1085 <td>numerator of frame rate</td>
1088 <td><p><span class="term"><em class="parameter"><code>framerate_d</code></em> :</span></p></td>
1089 <td>denominator of frame rate</td>
1092 <td><p><span class="term"><em class="parameter"><code>par_n</code></em> :</span></p></td>
1093 <td>numerator of pixel aspect ratio</td>
1096 <td><p><span class="term"><em class="parameter"><code>par_d</code></em> :</span></p></td>
1097 <td>denominator of pixel aspect ratio</td>
1100 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1101 <td>a new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> object, or NULL if there was an error</td>
1105 <p class="since">Since 0.10.16</p>
1108 <div class="refsect2">
1109 <a name="gst-video-format-new-caps-interlaced"></a><h3>gst_video_format_new_caps_interlaced ()</h3>
1110 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> * gst_video_format_new_caps_interlaced
1111 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1112 <em class="parameter"><code><span class="type">int</span> width</code></em>,
1113 <em class="parameter"><code><span class="type">int</span> height</code></em>,
1114 <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
1115 <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
1116 <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
1117 <em class="parameter"><code><span class="type">int</span> par_d</code></em>,
1118 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> interlaced</code></em>);</pre>
1120 Creates a new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> object based on the parameters provided.
1122 <div class="variablelist"><table border="0">
1123 <col align="left" valign="top">
1126 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1127 <td>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> describing the raw video format</td>
1130 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1131 <td>width of video</td>
1134 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1135 <td>height of video</td>
1138 <td><p><span class="term"><em class="parameter"><code>framerate_n</code></em> :</span></p></td>
1139 <td>numerator of frame rate</td>
1142 <td><p><span class="term"><em class="parameter"><code>framerate_d</code></em> :</span></p></td>
1143 <td>denominator of frame rate</td>
1146 <td><p><span class="term"><em class="parameter"><code>par_n</code></em> :</span></p></td>
1147 <td>numerator of pixel aspect ratio</td>
1150 <td><p><span class="term"><em class="parameter"><code>par_d</code></em> :</span></p></td>
1151 <td>denominator of pixel aspect ratio</td>
1154 <td><p><span class="term"><em class="parameter"><code>interlaced</code></em> :</span></p></td>
1156 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the format is interlaced</td>
1159 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1160 <td>a new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> object, or NULL if there was an error</td>
1164 <p class="since">Since 0.10.23</p>
1167 <div class="refsect2">
1168 <a name="gst-video-format-get-component-height"></a><h3>gst_video_format_get_component_height ()</h3>
1169 <pre class="programlisting"><span class="returnvalue">int</span> gst_video_format_get_component_height
1170 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1171 <em class="parameter"><code><span class="type">int</span> component</code></em>,
1172 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
1174 Calculates the height of the component. See
1175 <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1176 of the component index.
1178 <div class="variablelist"><table border="0">
1179 <col align="left" valign="top">
1182 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1183 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1187 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1188 <td>the component index</td>
1191 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1192 <td>the height of video</td>
1195 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1196 <td>height of component <em class="parameter"><code>component</code></em>
1201 <p class="since">Since 0.10.16</p>
1204 <div class="refsect2">
1205 <a name="gst-video-format-get-component-offset"></a><h3>gst_video_format_get_component_offset ()</h3>
1206 <pre class="programlisting"><span class="returnvalue">int</span> gst_video_format_get_component_offset
1207 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1208 <em class="parameter"><code><span class="type">int</span> component</code></em>,
1209 <em class="parameter"><code><span class="type">int</span> width</code></em>,
1210 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
1212 Calculates the offset (in bytes) of the first pixel of the component
1213 with index <em class="parameter"><code>component</code></em>. For packed formats, this will typically be a
1214 small integer (0, 1, 2, 3). For planar formats, this will be a
1215 (relatively) large offset to the beginning of the second or third
1216 component planes. See <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1217 of the component index.
1219 <div class="variablelist"><table border="0">
1220 <col align="left" valign="top">
1223 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1224 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1228 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1229 <td>the component index</td>
1232 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1233 <td>the width of video</td>
1236 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1237 <td>the height of video</td>
1240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1241 <td>offset of component <em class="parameter"><code>component</code></em>
1246 <p class="since">Since 0.10.16</p>
1249 <div class="refsect2">
1250 <a name="gst-video-format-get-component-width"></a><h3>gst_video_format_get_component_width ()</h3>
1251 <pre class="programlisting"><span class="returnvalue">int</span> gst_video_format_get_component_width
1252 (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1253 <em class="parameter"><code><span class="type">int</span> component</code></em>,
1254 <em class="parameter"><code><span class="type">int</span> width</code></em>);</pre>
1256 Calculates the width of the component. See
1257 <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1258 of the component index.
1260 <div class="variablelist"><table border="0">
1261 <col align="left" valign="top">
1264 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1265 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1269 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1270 <td>the component index</td>
1273 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1274 <td>the width of video</td>
1277 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1278 <td>width of component <em class="parameter"><code>component</code></em>
1283 <p class="since">Since 0.10.16</p>
1286 <div class="refsect2">
1287 <a name="gst-video-format-get-pixel-stride"></a><h3>gst_video_format_get_pixel_stride ()</h3>
1288 <pre class="programlisting"><span class="returnvalue">int</span> gst_video_format_get_pixel_stride (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1289 <em class="parameter"><code><span class="type">int</span> component</code></em>);</pre>
1291 Calculates the pixel stride (number of bytes from one pixel to the
1292 pixel to its immediate left) for the video component with an index
1293 of <em class="parameter"><code>component</code></em>. See <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1294 of the component index.
1296 <div class="variablelist"><table border="0">
1297 <col align="left" valign="top">
1300 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1301 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1305 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1306 <td>the component index</td>
1309 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1310 <td>pixel stride of component <em class="parameter"><code>component</code></em>
1315 <p class="since">Since 0.10.16</p>
1318 <div class="refsect2">
1319 <a name="gst-video-format-get-row-stride"></a><h3>gst_video_format_get_row_stride ()</h3>
1320 <pre class="programlisting"><span class="returnvalue">int</span> gst_video_format_get_row_stride (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1321 <em class="parameter"><code><span class="type">int</span> component</code></em>,
1322 <em class="parameter"><code><span class="type">int</span> width</code></em>);</pre>
1324 Calculates the row stride (number of bytes from one row of pixels to
1325 the next) for the video component with an index of <em class="parameter"><code>component</code></em>. For
1326 YUV video, Y, U, and V have component indices of 0, 1, and 2,
1327 respectively. For RGB video, R, G, and B have component indicies of
1328 0, 1, and 2, respectively. Alpha channels, if present, have a component
1329 index of 3. The <em class="parameter"><code>width</code></em> parameter always represents the width of the
1330 video, not the component.
1332 <div class="variablelist"><table border="0">
1333 <col align="left" valign="top">
1336 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1337 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1341 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1342 <td>the component index</td>
1345 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1346 <td>the width of video</td>
1349 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1350 <td>row stride of component <em class="parameter"><code>component</code></em>
1355 <p class="since">Since 0.10.16</p>
1358 <div class="refsect2">
1359 <a name="gst-video-format-get-size"></a><h3>gst_video_format_get_size ()</h3>
1360 <pre class="programlisting"><span class="returnvalue">int</span> gst_video_format_get_size (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>,
1361 <em class="parameter"><code><span class="type">int</span> width</code></em>,
1362 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
1364 Calculates the total number of bytes in the raw video format. This
1365 number should be used when allocating a buffer for raw video.
1367 <div class="variablelist"><table border="0">
1368 <col align="left" valign="top">
1371 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1372 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1376 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1377 <td>the width of video</td>
1380 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1381 <td>the height of video</td>
1384 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1385 <td>size (in bytes) of raw video format</td>
1389 <p class="since">Since 0.10.16</p>
1392 <div class="refsect2">
1393 <a name="gst-video-format-has-alpha"></a><h3>gst_video_format_has_alpha ()</h3>
1394 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_has_alpha (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);</pre>
1396 Returns TRUE or FALSE depending on if the video format provides an
1399 <div class="variablelist"><table border="0">
1400 <col align="left" valign="top">
1403 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1404 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1408 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1409 <td>TRUE if <em class="parameter"><code>format</code></em> has an alpha channel</td>
1413 <p class="since">Since 0.10.16</p>
1416 <div class="refsect2">
1417 <a name="gst-video-format-is-rgb"></a><h3>gst_video_format_is_rgb ()</h3>
1418 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_is_rgb (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);</pre>
1420 Determine whether the video format is an RGB format.
1422 <div class="variablelist"><table border="0">
1423 <col align="left" valign="top">
1426 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1427 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1431 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1432 <td>TRUE if <em class="parameter"><code>format</code></em> represents RGB video</td>
1436 <p class="since">Since 0.10.16</p>
1439 <div class="refsect2">
1440 <a name="gst-video-format-is-gray"></a><h3>gst_video_format_is_gray ()</h3>
1441 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_is_gray (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);</pre>
1443 Determine whether the video format is a grayscale format.
1445 <div class="variablelist"><table border="0">
1446 <col align="left" valign="top">
1449 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1450 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1454 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1455 <td>TRUE if <em class="parameter"><code>format</code></em> represents grayscale video</td>
1459 <p class="since">Since 0.10.29</p>
1462 <div class="refsect2">
1463 <a name="gst-video-format-is-yuv"></a><h3>gst_video_format_is_yuv ()</h3>
1464 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_is_yuv (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);</pre>
1466 Determine whether the video format is a YUV format.
1468 <div class="variablelist"><table border="0">
1469 <col align="left" valign="top">
1472 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1473 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1477 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1478 <td>TRUE if <em class="parameter"><code>format</code></em> represents YUV video</td>
1482 <p class="since">Since 0.10.16</p>
1485 <div class="refsect2">
1486 <a name="gst-video-format-to-fourcc"></a><h3>gst_video_format_to_fourcc ()</h3>
1487 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> gst_video_format_to_fourcc (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> format</code></em>);</pre>
1489 Converts a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> value into the corresponding FOURCC. Only
1490 a few YUV formats have corresponding FOURCC values. If <em class="parameter"><code>format</code></em> has
1491 no corresponding FOURCC value, 0 is returned.
1493 <div class="variablelist"><table border="0">
1494 <col align="left" valign="top">
1497 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1498 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> video format</td>
1501 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1502 <td>the FOURCC corresponding to <em class="parameter"><code>format</code></em>
1507 <p class="since">Since 0.10.16</p>
1510 <div class="refsect2">
1511 <a name="gst-video-format-from-fourcc"></a><h3>gst_video_format_from_fourcc ()</h3>
1512 <pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a> gst_video_format_from_fourcc (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> fourcc</code></em>);</pre>
1514 Converts a FOURCC value into the corresponding <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>.
1515 If the FOURCC cannot be represented by <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>,
1516 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-UNKNOWN:CAPS"><span class="type">GST_VIDEO_FORMAT_UNKNOWN</span></a> is returned.
1518 <div class="variablelist"><table border="0">
1519 <col align="left" valign="top">
1522 <td><p><span class="term"><em class="parameter"><code>fourcc</code></em> :</span></p></td>
1523 <td>a FOURCC value representing raw YUV video</td>
1526 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1527 <td>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> describing the FOURCC value</td>
1531 <p class="since">Since 0.10.16</p>
1534 <div class="refsect2">
1535 <a name="gst-video-format-parse-caps"></a><h3>gst_video_format_parse_caps ()</h3>
1536 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_parse_caps (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
1537 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> *format</code></em>,
1538 <em class="parameter"><code><span class="type">int</span> *width</code></em>,
1539 <em class="parameter"><code><span class="type">int</span> *height</code></em>);</pre>
1541 Determines the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> of <em class="parameter"><code>caps</code></em> and places it in the location
1542 pointed to by <em class="parameter"><code>format</code></em>. Extracts the size of the video and places it
1543 in the location pointed to by <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>. If <em class="parameter"><code>caps</code></em> does not
1544 represent one of the raw video formats listed in <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>, the
1545 function will fail and return FALSE.
1547 <div class="variablelist"><table border="0">
1548 <col align="left" valign="top">
1551 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1552 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to parse</td>
1555 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1556 <td>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> of the video represented by <em class="parameter"><code>caps</code></em> (output)</td>
1559 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1560 <td>the width of the video represented by <em class="parameter"><code>caps</code></em>, may be NULL (output)</td>
1563 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1564 <td>the height of the video represented by <em class="parameter"><code>caps</code></em>, may be NULL (output)</td>
1567 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1568 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1572 <p class="since">Since 0.10.16</p>
1575 <div class="refsect2">
1576 <a name="gst-video-format-parse-caps-interlaced"></a><h3>gst_video_format_parse_caps_interlaced ()</h3>
1577 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_format_parse_caps_interlaced
1578 (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
1579 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *interlaced</code></em>);</pre>
1581 Extracts whether the caps represents interlaced content or not and places it
1582 in <em class="parameter"><code>interlaced</code></em>.
1584 <div class="variablelist"><table border="0">
1585 <col align="left" valign="top">
1588 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1589 <td>the fixed <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to parse</td>
1592 <td><p><span class="term"><em class="parameter"><code>interlaced</code></em> :</span></p></td>
1593 <td>whether <em class="parameter"><code>caps</code></em> represents interlaced video or not, may be NULL (output)</td>
1596 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1597 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1601 <p class="since">Since 0.10.23</p>
1604 <div class="refsect2">
1605 <a name="gst-video-parse-caps-framerate"></a><h3>gst_video_parse_caps_framerate ()</h3>
1606 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_parse_caps_framerate (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
1607 <em class="parameter"><code><span class="type">int</span> *fps_n</code></em>,
1608 <em class="parameter"><code><span class="type">int</span> *fps_d</code></em>);</pre>
1610 Extracts the frame rate from <em class="parameter"><code>caps</code></em> and places the values in the locations
1611 pointed to by <em class="parameter"><code>fps_n</code></em> and <em class="parameter"><code>fps_d</code></em>. Returns TRUE if the values could be
1612 parsed correctly, FALSE if not.
1615 This function can be used with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> that have any media type; it
1616 is not limited to formats handled by <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>.
1618 <div class="variablelist"><table border="0">
1619 <col align="left" valign="top">
1622 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1623 <td>pointer to a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> instance</td>
1626 <td><p><span class="term"><em class="parameter"><code>fps_n</code></em> :</span></p></td>
1627 <td>pointer to integer to hold numerator of frame rate (output)</td>
1630 <td><p><span class="term"><em class="parameter"><code>fps_d</code></em> :</span></p></td>
1631 <td>pointer to integer to hold denominator of frame rate (output)</td>
1634 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1635 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1639 <p class="since">Since 0.10.16</p>
1642 <div class="refsect2">
1643 <a name="gst-video-parse-caps-pixel-aspect-ratio"></a><h3>gst_video_parse_caps_pixel_aspect_ratio ()</h3>
1644 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_parse_caps_pixel_aspect_ratio
1645 (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>,
1646 <em class="parameter"><code><span class="type">int</span> *par_n</code></em>,
1647 <em class="parameter"><code><span class="type">int</span> *par_d</code></em>);</pre>
1649 Extracts the pixel aspect ratio from <em class="parameter"><code>caps</code></em> and places the values in
1650 the locations pointed to by <em class="parameter"><code>par_n</code></em> and <em class="parameter"><code>par_d</code></em>. Returns TRUE if the
1651 values could be parsed correctly, FALSE if not.
1654 This function can be used with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> that have any media type; it
1655 is not limited to formats handled by <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>.
1657 <div class="variablelist"><table border="0">
1658 <col align="left" valign="top">
1661 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1662 <td>pointer to a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> instance</td>
1665 <td><p><span class="term"><em class="parameter"><code>par_n</code></em> :</span></p></td>
1666 <td>pointer to numerator of pixel aspect ratio (output)</td>
1669 <td><p><span class="term"><em class="parameter"><code>par_d</code></em> :</span></p></td>
1670 <td>pointer to denominator of pixel aspect ratio (output)</td>
1673 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1674 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1678 <p class="since">Since 0.10.16</p>
1681 <div class="refsect2">
1682 <a name="gst-video-parse-caps-color-matrix"></a><h3>gst_video_parse_caps_color_matrix ()</h3>
1683 <pre class="programlisting">const <span class="returnvalue">char</span> * gst_video_parse_caps_color_matrix (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
1685 Extracts the color matrix used by the caps. Possible values are
1686 "sdtv" for the standard definition color matrix (as specified in
1687 Rec. ITU-R BT.470-6) or "hdtv" for the high definition color
1688 matrix (as specified in Rec. ITU-R BT.709)
1690 <div class="variablelist"><table border="0">
1691 <col align="left" valign="top">
1694 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1695 <td>the fixed <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to parse</td>
1698 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1699 <td>a color matrix string, or NULL if no color matrix could be
1704 <p class="since">Since 0.10.29</p>
1707 <div class="refsect2">
1708 <a name="gst-video-parse-caps-chroma-site"></a><h3>gst_video_parse_caps_chroma_site ()</h3>
1709 <pre class="programlisting">const <span class="returnvalue">char</span> * gst_video_parse_caps_chroma_site (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
1711 Extracts the chroma site used by the caps. Possible values are
1712 "mpeg2" for MPEG-2 style chroma siting (co-sited horizontally,
1713 halfway-sited vertically), "jpeg" for JPEG and Theora style
1714 chroma siting (halfway-sited both horizontally and vertically).
1715 Other chroma site values are possible, but uncommon.
1718 When no chroma site is specified in the caps, it should be assumed
1721 <div class="variablelist"><table border="0">
1722 <col align="left" valign="top">
1725 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1726 <td>the fixed <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to parse</td>
1729 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1730 <td>a chroma site string, or NULL if no chroma site could be
1735 <p class="since">Since 0.10.29</p>
1738 <div class="refsect2">
1739 <a name="gst-video-parse-caps-palette"></a><h3>gst_video_parse_caps_palette ()</h3>
1740 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> * gst_video_parse_caps_palette (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
1742 Returns the palette data from the caps as a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>. For
1743 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-RGB8-PALETTED:CAPS"><span class="type">GST_VIDEO_FORMAT_RGB8_PALETTED</span></a> this is containing 256 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a>
1744 values, each containing ARGB colors in native endianness.
1746 <div class="variablelist"><table border="0">
1747 <col align="left" valign="top">
1750 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1752 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to parse</td>
1755 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1756 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> containing the palette data. Unref after usage.</td>
1760 <p class="since">Since 0.10.32</p>
1763 <div class="refsect2">
1764 <a name="GstVideoConvertFrameCallback"></a><h3>GstVideoConvertFrameCallback ()</h3>
1765 <pre class="programlisting"><span class="returnvalue">void</span> (*GstVideoConvertFrameCallback) (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
1766 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
1767 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
1770 <div class="refsect2">
1771 <a name="gst-video-convert-frame"></a><h3>gst_video_convert_frame ()</h3>
1772 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> * gst_video_convert_frame (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
1773 <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *to_caps</code></em>,
1774 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timeout</code></em>,
1775 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
1777 Converts a raw video buffer into the specified output caps.
1780 The output caps can be any raw video formats or any image formats (jpeg, png, ...).
1783 The width, height and pixel-aspect-ratio can also be specified in the output caps.
1785 <div class="variablelist"><table border="0">
1786 <col align="left" valign="top">
1789 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
1790 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
1794 <td><p><span class="term"><em class="parameter"><code>to_caps</code></em> :</span></p></td>
1795 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to convert to</td>
1798 <td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
1799 <td>the maximum amount of time allowed for the processing.</td>
1802 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
1803 <td>pointer to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. Can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
1806 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1807 <td>The converted <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error happened (in which case <em class="parameter"><code>err</code></em>
1808 will point to the <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>).</td>
1812 <p class="since">Since 0.10.31</p>
1815 <div class="refsect2">
1816 <a name="gst-video-convert-frame-async"></a><h3>gst_video_convert_frame_async ()</h3>
1817 <pre class="programlisting"><span class="returnvalue">void</span> gst_video_convert_frame_async (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
1818 <em class="parameter"><code>const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *to_caps</code></em>,
1819 <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> timeout</code></em>,
1820 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertFrameCallback" title="GstVideoConvertFrameCallback ()"><span class="type">GstVideoConvertFrameCallback</span></a> callback</code></em>,
1821 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
1822 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_notify</code></em>);</pre>
1824 Converts a raw video buffer into the specified output caps.
1827 The output caps can be any raw video formats or any image formats (jpeg, png, ...).
1830 The width, height and pixel-aspect-ratio can also be specified in the output caps.
1833 <em class="parameter"><code>callback</code></em> will be called after conversion, when an error occured or if conversion didn't
1834 finish after <em class="parameter"><code>timeout</code></em>. <em class="parameter"><code>callback</code></em> will always be called from the thread default
1835 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><code class="literal">GMainContext</code></a>, see <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-get-thread-default"><code class="function">g_main_context_get_thread_default()</code></a>. If GLib before 2.22 is used,
1836 this will always be the global default main context.
1839 <em class="parameter"><code>destroy_notify</code></em> will be called after the callback was called and <em class="parameter"><code>user_data</code></em> is not needed
1842 <div class="variablelist"><table border="0">
1843 <col align="left" valign="top">
1846 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
1847 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
1851 <td><p><span class="term"><em class="parameter"><code>to_caps</code></em> :</span></p></td>
1852 <td>the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> to convert to</td>
1855 <td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
1856 <td>the maximum amount of time allowed for the processing.</td>
1859 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1861 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertFrameCallback" title="GstVideoConvertFrameCallback ()"><code class="literal">GstVideoConvertFrameCallback</code></a> that will be called after conversion.</td>
1864 <td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>
1866 <a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><code class="literal">GDestroyNotify</code></a> to be called after <em class="parameter"><code>user_data</code></em> is not needed anymore</td>
1870 <p class="since">Since 0.10.31</p>
1873 <div class="refsect2">
1874 <a name="gst-video-event-new-still-frame"></a><h3>gst_video_event_new_still_frame ()</h3>
1875 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="returnvalue">GstEvent</span></a> * gst_video_event_new_still_frame (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> in_still</code></em>);</pre>
1877 Creates a new Still Frame event. If <em class="parameter"><code>in_still</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the event
1878 represents the start of a still frame sequence. If it is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then
1879 the event ends a still frame sequence.
1882 To parse an event created by <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-still-frame" title="gst_video_event_new_still_frame ()"><code class="function">gst_video_event_new_still_frame()</code></a> use
1883 <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-parse-still-frame" title="gst_video_event_parse_still_frame ()"><code class="function">gst_video_event_parse_still_frame()</code></a>.
1885 <div class="variablelist"><table border="0">
1886 <col align="left" valign="top">
1889 <td><p><span class="term"><em class="parameter"><code>in_still</code></em> :</span></p></td>
1890 <td>boolean value for the still-frame state of the event.</td>
1893 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1894 <td>The new GstEvent</td>
1898 <p class="since">Since 0.10.26</p>
1901 <div class="refsect2">
1902 <a name="gst-video-event-parse-still-frame"></a><h3>gst_video_event_parse_still_frame ()</h3>
1903 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gst_video_event_parse_still_frame (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> *event</code></em>,
1904 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *in_still</code></em>);</pre>
1906 Parse a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a>, identify if it is a Still Frame event, and
1907 return the still-frame state from the event if it is.
1908 If the event represents the start of a still frame, the in_still
1909 variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the
1910 in_still variable order to just check whether the event is a valid still-frame
1914 Create a still frame event using <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-still-frame" title="gst_video_event_new_still_frame ()"><code class="function">gst_video_event_new_still_frame()</code></a>
1916 <div class="variablelist"><table border="0">
1917 <col align="left" valign="top">
1920 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1921 <td>A <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="type">GstEvent</span></a> to parse</td>
1924 <td><p><span class="term"><em class="parameter"><code>in_still</code></em> :</span></p></td>
1925 <td>A boolean to receive the still-frame status from the event, or NULL</td>
1928 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1930 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the event is a valid still-frame event. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not</td>
1934 <p class="since">Since 0.10.26</p>
1938 <div class="footer">
1940 Generated by GTK-Doc V1.17</div>