Initialize Tizen 2.3
[framework/multimedia/gst-plugins-base0.10.git] / mobile / docs / libs / html / gst-plugins-base-libs-gstvideo.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
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.76.1">
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-gstvideooverlaycomposition.html" title="gstvideooverlaycomposition">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
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">
16 <tr valign="middle">
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-gstvideooverlaycomposition.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-libs-gstvideo.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-libs-gstvideo.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
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>
32 <td valign="top">
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>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-base-libs-gstvideo.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;gst/video/video.h&gt;
42
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-CAPS-ARGB-64:CAPS" title="GST_VIDEO_CAPS_ARGB_64">GST_VIDEO_CAPS_ARGB_64</a>
82 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-r210" title="GST_VIDEO_CAPS_r210">GST_VIDEO_CAPS_r210</a>
83 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP1-MASK-15:CAPS" title="GST_VIDEO_COMP1_MASK_15">GST_VIDEO_COMP1_MASK_15</a>
84 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP1-MASK-15-INT:CAPS" title="GST_VIDEO_COMP1_MASK_15_INT">GST_VIDEO_COMP1_MASK_15_INT</a>
85 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP1-MASK-16:CAPS" title="GST_VIDEO_COMP1_MASK_16">GST_VIDEO_COMP1_MASK_16</a>
86 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP1-MASK-16-INT:CAPS" title="GST_VIDEO_COMP1_MASK_16_INT">GST_VIDEO_COMP1_MASK_16_INT</a>
87 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP2-MASK-15:CAPS" title="GST_VIDEO_COMP2_MASK_15">GST_VIDEO_COMP2_MASK_15</a>
88 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP2-MASK-15-INT:CAPS" title="GST_VIDEO_COMP2_MASK_15_INT">GST_VIDEO_COMP2_MASK_15_INT</a>
89 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP2-MASK-16:CAPS" title="GST_VIDEO_COMP2_MASK_16">GST_VIDEO_COMP2_MASK_16</a>
90 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP2-MASK-16-INT:CAPS" title="GST_VIDEO_COMP2_MASK_16_INT">GST_VIDEO_COMP2_MASK_16_INT</a>
91 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP3-MASK-15:CAPS" title="GST_VIDEO_COMP3_MASK_15">GST_VIDEO_COMP3_MASK_15</a>
92 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP3-MASK-15-INT:CAPS" title="GST_VIDEO_COMP3_MASK_15_INT">GST_VIDEO_COMP3_MASK_15_INT</a>
93 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP3-MASK-16:CAPS" title="GST_VIDEO_COMP3_MASK_16">GST_VIDEO_COMP3_MASK_16</a>
94 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-COMP3-MASK-16-INT:CAPS" title="GST_VIDEO_COMP3_MASK_16_INT">GST_VIDEO_COMP3_MASK_16_INT</a>
95 #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>
96 #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>
97 #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>
98 #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>
99 #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>
100 #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>
101 #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>
102 #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>
103 #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>
104 #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>
105 #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>
106 #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>
107 #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>
108 #define             <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-PROGRESSIVE:CAPS" title="GST_VIDEO_BUFFER_PROGRESSIVE">GST_VIDEO_BUFFER_PROGRESSIVE</a>
109 enum                <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat">GstVideoFormat</a>;
110 <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>,
111                                                          <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>,
112                                                          <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>,
113                                                          <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>,
114                                                          <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>,
115                                                          <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>,
116                                                          <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>,
117                                                          <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>);
118 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>);
119 <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>,
120                                                          <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>,
121                                                          <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>);
122 <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-from-caps" title="gst_video_get_size_from_caps ()">gst_video_get_size_from_caps</a>        (<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> *caps</code></em>,
123                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *size</code></em>);
124 <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>,
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> fps_n</code></em>,
128                                                          <em class="parameter"><code><span class="type">int</span> fps_d</code></em>,
129                                                          <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>,
130                                                          <em class="parameter"><code><span class="type">gint64</span> src_value</code></em>,
131                                                          <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>,
132                                                          <em class="parameter"><code><span class="type">gint64</span> *dest_value</code></em>);
133 <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>,
134                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
135                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>,
136                                                          <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
137                                                          <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
138                                                          <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
139                                                          <em class="parameter"><code><span class="type">int</span> par_d</code></em>);
140 <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>
141                                                         (<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>,
142                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
143                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>,
144                                                          <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
145                                                          <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
146                                                          <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
147                                                          <em class="parameter"><code><span class="type">int</span> par_d</code></em>,
148                                                          <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>);
149 <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-template-caps" title="gst_video_format_new_template_caps ()">gst_video_format_new_template_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>);
150 <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>
151                                                         (<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>,
152                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
153                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>);
154 <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>
155                                                         (<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                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
157                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
158                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>);
159 <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>
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> component</code></em>,
162                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>);
163 <span class="returnvalue">int</span>                 <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-component-depth" title="gst_video_format_get_component_depth ()">gst_video_format_get_component_depth</a>
164                                                         (<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>,
165                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>);
166 <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>,
167                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>);
168 <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>,
169                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
170                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>);
171 <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>,
172                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
173                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>);
174 <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>);
175 <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>);
176 <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>);
177 <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>);
178 <span class="returnvalue">guint32</span>             <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>);
179 <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><span class="type">guint32</span> fourcc</code></em>);
180 <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>const <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>,
181                                                          <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>,
182                                                          <em class="parameter"><code><span class="type">int</span> *width</code></em>,
183                                                          <em class="parameter"><code><span class="type">int</span> *height</code></em>);
184 <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>
185                                                         (<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>,
186                                                          <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>);
187 <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>,
188                                                          <em class="parameter"><code><span class="type">int</span> *fps_n</code></em>,
189                                                          <em class="parameter"><code><span class="type">int</span> *fps_d</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-parse-caps-pixel-aspect-ratio" title="gst_video_parse_caps_pixel_aspect_ratio ()">gst_video_parse_caps_pixel_aspect_ratio</a>
191                                                         (<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>,
192                                                          <em class="parameter"><code><span class="type">int</span> *par_n</code></em>,
193                                                          <em class="parameter"><code><span class="type">int</span> *par_d</code></em>);
194 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>);
195 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>);
196 <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>);
197 <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>,
198                                                          <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>,
199                                                          <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>);
200 <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>,
201                                                          <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>,
202                                                          <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>,
203                                                          <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>);
204 <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>,
205                                                          <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>,
206                                                          <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>,
207                                                          <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>,
208                                                          <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>,
209                                                          <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>);
210 <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>);
211 <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>,
212                                                          <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>);
213 <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-upstream-force-key-unit" title="gst_video_event_new_upstream_force_key_unit ()">gst_video_event_new_upstream_force_key_unit</a>
214                                                         (<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> running_time</code></em>,
215                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> all_headers</code></em>,
216                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> count</code></em>);
217 <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-downstream-force-key-unit" title="gst_video_event_new_downstream_force_key_unit ()">gst_video_event_new_downstream_force_key_unit</a>
218                                                         (<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> timestamp</code></em>,
219                                                          <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> streamtime</code></em>,
220                                                          <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> runningtime</code></em>,
221                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> all_headers</code></em>,
222                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> count</code></em>);
223 <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-is-force-key-unit" title="gst_video_event_is_force_key_unit ()">gst_video_event_is_force_key_unit</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>);
224 <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-upstream-force-key-unit" title="gst_video_event_parse_upstream_force_key_unit ()">gst_video_event_parse_upstream_force_key_unit</a>
225                                                         (<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>,
226                                                          <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> *running_time</code></em>,
227                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *all_headers</code></em>,
228                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *count</code></em>);
229 <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-downstream-force-key-unit" title="gst_video_event_parse_downstream_force_key_unit ()">gst_video_event_parse_downstream_force_key_unit</a>
230                                                         (<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>,
231                                                          <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> *timestamp</code></em>,
232                                                          <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> *streamtime</code></em>,
233                                                          <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> *runningtime</code></em>,
234                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *all_headers</code></em>,
235                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *count</code></em>);
236 </pre>
237 </div>
238 <div class="refsect1">
239 <a name="gst-plugins-base-libs-gstvideo.description"></a><h2>Description</h2>
240 <p>
241 </p>
242 <div class="refsect2">
243 <a name="idp29566608"></a><p>
244 This library contains some helper functions and includes the
245 videosink and videofilter base classes.
246 </p>
247 </div>
248 <p>
249 </p>
250 </div>
251 <div class="refsect1">
252 <a name="gst-plugins-base-libs-gstvideo.details"></a><h2>Details</h2>
253 <div class="refsect2">
254 <a name="GST-VIDEO-BLUE-MASK-15:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_15</h3>
255 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_15 GST_VIDEO_COMP3_MASK_15
256 </pre>
257 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
258 <h3 class="title">Warning</h3>
259 <p><code class="literal">GST_VIDEO_BLUE_MASK_15</code> is deprecated and should not be used in newly-written code.</p>
260 </div>
261 </div>
262 <hr>
263 <div class="refsect2">
264 <a name="GST-VIDEO-BLUE-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_15_INT</h3>
265 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_15_INT GST_VIDEO_COMP3_MASK_15_INT
266 </pre>
267 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
268 <h3 class="title">Warning</h3>
269 <p><code class="literal">GST_VIDEO_BLUE_MASK_15_INT</code> is deprecated and should not be used in newly-written code.</p>
270 </div>
271 </div>
272 <hr>
273 <div class="refsect2">
274 <a name="GST-VIDEO-BLUE-MASK-16:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_16</h3>
275 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_16 GST_VIDEO_COMP3_MASK_16
276 </pre>
277 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
278 <h3 class="title">Warning</h3>
279 <p><code class="literal">GST_VIDEO_BLUE_MASK_16</code> is deprecated and should not be used in newly-written code.</p>
280 </div>
281 </div>
282 <hr>
283 <div class="refsect2">
284 <a name="GST-VIDEO-BLUE-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_BLUE_MASK_16_INT</h3>
285 <pre class="programlisting">#define GST_VIDEO_BLUE_MASK_16_INT GST_VIDEO_COMP3_MASK_16_INT
286 </pre>
287 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
288 <h3 class="title">Warning</h3>
289 <p><code class="literal">GST_VIDEO_BLUE_MASK_16_INT</code> is deprecated and should not be used in newly-written code.</p>
290 </div>
291 </div>
292 <hr>
293 <div class="refsect2">
294 <a name="GST-VIDEO-BYTE1-MASK-24:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_24</h3>
295 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_24  "0x00FF0000"
296 </pre>
297 </div>
298 <hr>
299 <div class="refsect2">
300 <a name="GST-VIDEO-BYTE1-MASK-24-INT:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_24_INT</h3>
301 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_24_INT  0x00FF0000
302 </pre>
303 </div>
304 <hr>
305 <div class="refsect2">
306 <a name="GST-VIDEO-BYTE1-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_32</h3>
307 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_32  "0xFF000000"
308 </pre>
309 </div>
310 <hr>
311 <div class="refsect2">
312 <a name="GST-VIDEO-BYTE1-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE1_MASK_32_INT</h3>
313 <pre class="programlisting">#define GST_VIDEO_BYTE1_MASK_32_INT  0xFF000000
314 </pre>
315 </div>
316 <hr>
317 <div class="refsect2">
318 <a name="GST-VIDEO-BYTE2-MASK-24:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_24</h3>
319 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_24  "0x0000FF00"
320 </pre>
321 </div>
322 <hr>
323 <div class="refsect2">
324 <a name="GST-VIDEO-BYTE2-MASK-24-INT:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_24_INT</h3>
325 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_24_INT  0x0000FF00
326 </pre>
327 </div>
328 <hr>
329 <div class="refsect2">
330 <a name="GST-VIDEO-BYTE2-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_32</h3>
331 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_32  "0x00FF0000"
332 </pre>
333 </div>
334 <hr>
335 <div class="refsect2">
336 <a name="GST-VIDEO-BYTE2-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE2_MASK_32_INT</h3>
337 <pre class="programlisting">#define GST_VIDEO_BYTE2_MASK_32_INT  0x00FF0000
338 </pre>
339 </div>
340 <hr>
341 <div class="refsect2">
342 <a name="GST-VIDEO-BYTE3-MASK-24:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_24</h3>
343 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_24  "0x000000FF"
344 </pre>
345 </div>
346 <hr>
347 <div class="refsect2">
348 <a name="GST-VIDEO-BYTE3-MASK-24-INT:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_24_INT</h3>
349 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_24_INT  0x000000FF
350 </pre>
351 </div>
352 <hr>
353 <div class="refsect2">
354 <a name="GST-VIDEO-BYTE3-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_32</h3>
355 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_32  "0x0000FF00"
356 </pre>
357 </div>
358 <hr>
359 <div class="refsect2">
360 <a name="GST-VIDEO-BYTE3-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE3_MASK_32_INT</h3>
361 <pre class="programlisting">#define GST_VIDEO_BYTE3_MASK_32_INT  0x0000FF00
362 </pre>
363 </div>
364 <hr>
365 <div class="refsect2">
366 <a name="GST-VIDEO-BYTE4-MASK-32:CAPS"></a><h3>GST_VIDEO_BYTE4_MASK_32</h3>
367 <pre class="programlisting">#define GST_VIDEO_BYTE4_MASK_32  "0x000000FF"
368 </pre>
369 </div>
370 <hr>
371 <div class="refsect2">
372 <a name="GST-VIDEO-BYTE4-MASK-32-INT:CAPS"></a><h3>GST_VIDEO_BYTE4_MASK_32_INT</h3>
373 <pre class="programlisting">#define GST_VIDEO_BYTE4_MASK_32_INT  0x000000FF
374 </pre>
375 </div>
376 <hr>
377 <div class="refsect2">
378 <a name="GST-VIDEO-CAPS-ABGR:CAPS"></a><h3>GST_VIDEO_CAPS_ABGR</h3>
379 <pre class="programlisting">#define             GST_VIDEO_CAPS_ABGR</pre>
380 </div>
381 <hr>
382 <div class="refsect2">
383 <a name="GST-VIDEO-CAPS-ARGB:CAPS"></a><h3>GST_VIDEO_CAPS_ARGB</h3>
384 <pre class="programlisting">#define             GST_VIDEO_CAPS_ARGB</pre>
385 </div>
386 <hr>
387 <div class="refsect2">
388 <a name="GST-VIDEO-CAPS-BGR:CAPS"></a><h3>GST_VIDEO_CAPS_BGR</h3>
389 <pre class="programlisting">#define             GST_VIDEO_CAPS_BGR</pre>
390 </div>
391 <hr>
392 <div class="refsect2">
393 <a name="GST-VIDEO-CAPS-BGRA:CAPS"></a><h3>GST_VIDEO_CAPS_BGRA</h3>
394 <pre class="programlisting">#define             GST_VIDEO_CAPS_BGRA</pre>
395 </div>
396 <hr>
397 <div class="refsect2">
398 <a name="GST-VIDEO-CAPS-BGRx"></a><h3>GST_VIDEO_CAPS_BGRx</h3>
399 <pre class="programlisting">#define             GST_VIDEO_CAPS_BGRx</pre>
400 </div>
401 <hr>
402 <div class="refsect2">
403 <a name="GST-VIDEO-CAPS-BGRx-HOST-ENDIAN"></a><h3>GST_VIDEO_CAPS_BGRx_HOST_ENDIAN</h3>
404 <pre class="programlisting">#define             GST_VIDEO_CAPS_BGRx_HOST_ENDIAN</pre>
405 </div>
406 <hr>
407 <div class="refsect2">
408 <a name="GST-VIDEO-CAPS-RGB:CAPS"></a><h3>GST_VIDEO_CAPS_RGB</h3>
409 <pre class="programlisting">#define             GST_VIDEO_CAPS_RGB</pre>
410 </div>
411 <hr>
412 <div class="refsect2">
413 <a name="GST-VIDEO-CAPS-RGBA:CAPS"></a><h3>GST_VIDEO_CAPS_RGBA</h3>
414 <pre class="programlisting">#define             GST_VIDEO_CAPS_RGBA</pre>
415 </div>
416 <hr>
417 <div class="refsect2">
418 <a name="GST-VIDEO-CAPS-RGB-15:CAPS"></a><h3>GST_VIDEO_CAPS_RGB_15</h3>
419 <pre class="programlisting">#define             GST_VIDEO_CAPS_RGB_15</pre>
420 </div>
421 <hr>
422 <div class="refsect2">
423 <a name="GST-VIDEO-CAPS-RGB-16:CAPS"></a><h3>GST_VIDEO_CAPS_RGB_16</h3>
424 <pre class="programlisting">#define             GST_VIDEO_CAPS_RGB_16</pre>
425 </div>
426 <hr>
427 <div class="refsect2">
428 <a name="GST-VIDEO-CAPS-RGBx"></a><h3>GST_VIDEO_CAPS_RGBx</h3>
429 <pre class="programlisting">#define             GST_VIDEO_CAPS_RGBx</pre>
430 </div>
431 <hr>
432 <div class="refsect2">
433 <a name="GST-VIDEO-CAPS-YUV:CAPS"></a><h3>GST_VIDEO_CAPS_YUV()</h3>
434 <pre class="programlisting">#define             GST_VIDEO_CAPS_YUV(fourcc)</pre>
435 <p>
436 Generic caps string for YUV video, for use in pad templates.
437 </p>
438 <div class="variablelist"><table border="0">
439 <col align="left" valign="top">
440 <tbody><tr>
441 <td><p><span class="term"><em class="parameter"><code>fourcc</code></em> :</span></p></td>
442 <td>YUV fourcc format that describes the pixel layout, as string
443 (e.g. "I420", "YV12", "YUY2", "AYUV", etc.)</td>
444 </tr></tbody>
445 </table></div>
446 </div>
447 <hr>
448 <div class="refsect2">
449 <a name="GST-VIDEO-CAPS-xBGR"></a><h3>GST_VIDEO_CAPS_xBGR</h3>
450 <pre class="programlisting">#define             GST_VIDEO_CAPS_xBGR</pre>
451 </div>
452 <hr>
453 <div class="refsect2">
454 <a name="GST-VIDEO-CAPS-xRGB"></a><h3>GST_VIDEO_CAPS_xRGB</h3>
455 <pre class="programlisting">#define             GST_VIDEO_CAPS_xRGB</pre>
456 </div>
457 <hr>
458 <div class="refsect2">
459 <a name="GST-VIDEO-CAPS-xRGB-HOST-ENDIAN"></a><h3>GST_VIDEO_CAPS_xRGB_HOST_ENDIAN</h3>
460 <pre class="programlisting">#define             GST_VIDEO_CAPS_xRGB_HOST_ENDIAN</pre>
461 </div>
462 <hr>
463 <div class="refsect2">
464 <a name="GST-VIDEO-CAPS-BGR-15:CAPS"></a><h3>GST_VIDEO_CAPS_BGR_15</h3>
465 <pre class="programlisting">#define             GST_VIDEO_CAPS_BGR_15</pre>
466 </div>
467 <hr>
468 <div class="refsect2">
469 <a name="GST-VIDEO-CAPS-BGR-16:CAPS"></a><h3>GST_VIDEO_CAPS_BGR_16</h3>
470 <pre class="programlisting">#define             GST_VIDEO_CAPS_BGR_16</pre>
471 </div>
472 <hr>
473 <div class="refsect2">
474 <a name="GST-VIDEO-CAPS-RGB8-PALETTED:CAPS"></a><h3>GST_VIDEO_CAPS_RGB8_PALETTED</h3>
475 <pre class="programlisting">#define             GST_VIDEO_CAPS_RGB8_PALETTED</pre>
476 <p>
477 Generic caps string for 8-bit paletted RGB video, for use in pad templates.
478 </p>
479 <p class="since">Since 0.10.32</p>
480 </div>
481 <hr>
482 <div class="refsect2">
483 <a name="GST-VIDEO-CAPS-GRAY8:CAPS"></a><h3>GST_VIDEO_CAPS_GRAY8</h3>
484 <pre class="programlisting">#define             GST_VIDEO_CAPS_GRAY8</pre>
485 <p>
486 Generic caps string for 8-bit grayscale video, for use in pad templates.
487 </p>
488 <p class="since">Since 0.10.29</p>
489 </div>
490 <hr>
491 <div class="refsect2">
492 <a name="GST-VIDEO-CAPS-GRAY16:CAPS"></a><h3>GST_VIDEO_CAPS_GRAY16()</h3>
493 <pre class="programlisting">#define             GST_VIDEO_CAPS_GRAY16(endianness)</pre>
494 <p>
495 Generic caps string for 16-bit grayscale video, for use in pad templates.
496 </p>
497 <div class="variablelist"><table border="0">
498 <col align="left" valign="top">
499 <tbody><tr>
500 <td><p><span class="term"><em class="parameter"><code>endianness</code></em> :</span></p></td>
501 <td>endianness as string, ie. either "1234", "4321", "BIG_ENDIAN"
502 or "LITTLE_ENDIAN"</td>
503 </tr></tbody>
504 </table></div>
505 <p class="since">Since 0.10.29</p>
506 </div>
507 <hr>
508 <div class="refsect2">
509 <a name="GST-VIDEO-CAPS-ARGB-64:CAPS"></a><h3>GST_VIDEO_CAPS_ARGB_64</h3>
510 <pre class="programlisting">#define             GST_VIDEO_CAPS_ARGB_64</pre>
511 </div>
512 <hr>
513 <div class="refsect2">
514 <a name="GST-VIDEO-CAPS-r210"></a><h3>GST_VIDEO_CAPS_r210</h3>
515 <pre class="programlisting">#define             GST_VIDEO_CAPS_r210</pre>
516 </div>
517 <hr>
518 <div class="refsect2">
519 <a name="GST-VIDEO-COMP1-MASK-15:CAPS"></a><h3>GST_VIDEO_COMP1_MASK_15</h3>
520 <pre class="programlisting">#define GST_VIDEO_COMP1_MASK_15 "0x7c00"
521 </pre>
522 </div>
523 <hr>
524 <div class="refsect2">
525 <a name="GST-VIDEO-COMP1-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_COMP1_MASK_15_INT</h3>
526 <pre class="programlisting">#define GST_VIDEO_COMP1_MASK_15_INT 0x7c00
527 </pre>
528 </div>
529 <hr>
530 <div class="refsect2">
531 <a name="GST-VIDEO-COMP1-MASK-16:CAPS"></a><h3>GST_VIDEO_COMP1_MASK_16</h3>
532 <pre class="programlisting">#define GST_VIDEO_COMP1_MASK_16 "0xf800"
533 </pre>
534 </div>
535 <hr>
536 <div class="refsect2">
537 <a name="GST-VIDEO-COMP1-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_COMP1_MASK_16_INT</h3>
538 <pre class="programlisting">#define GST_VIDEO_COMP1_MASK_16_INT 0xf800
539 </pre>
540 </div>
541 <hr>
542 <div class="refsect2">
543 <a name="GST-VIDEO-COMP2-MASK-15:CAPS"></a><h3>GST_VIDEO_COMP2_MASK_15</h3>
544 <pre class="programlisting">#define GST_VIDEO_COMP2_MASK_15 "0x03e0"
545 </pre>
546 </div>
547 <hr>
548 <div class="refsect2">
549 <a name="GST-VIDEO-COMP2-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_COMP2_MASK_15_INT</h3>
550 <pre class="programlisting">#define GST_VIDEO_COMP2_MASK_15_INT 0x03e0
551 </pre>
552 </div>
553 <hr>
554 <div class="refsect2">
555 <a name="GST-VIDEO-COMP2-MASK-16:CAPS"></a><h3>GST_VIDEO_COMP2_MASK_16</h3>
556 <pre class="programlisting">#define GST_VIDEO_COMP2_MASK_16 "0x07e0"
557 </pre>
558 </div>
559 <hr>
560 <div class="refsect2">
561 <a name="GST-VIDEO-COMP2-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_COMP2_MASK_16_INT</h3>
562 <pre class="programlisting">#define GST_VIDEO_COMP2_MASK_16_INT 0x07e0
563 </pre>
564 </div>
565 <hr>
566 <div class="refsect2">
567 <a name="GST-VIDEO-COMP3-MASK-15:CAPS"></a><h3>GST_VIDEO_COMP3_MASK_15</h3>
568 <pre class="programlisting">#define GST_VIDEO_COMP3_MASK_15 "0x001f"
569 </pre>
570 </div>
571 <hr>
572 <div class="refsect2">
573 <a name="GST-VIDEO-COMP3-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_COMP3_MASK_15_INT</h3>
574 <pre class="programlisting">#define GST_VIDEO_COMP3_MASK_15_INT 0x001f
575 </pre>
576 </div>
577 <hr>
578 <div class="refsect2">
579 <a name="GST-VIDEO-COMP3-MASK-16:CAPS"></a><h3>GST_VIDEO_COMP3_MASK_16</h3>
580 <pre class="programlisting">#define GST_VIDEO_COMP3_MASK_16 "0x001f"
581 </pre>
582 </div>
583 <hr>
584 <div class="refsect2">
585 <a name="GST-VIDEO-COMP3-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_COMP3_MASK_16_INT</h3>
586 <pre class="programlisting">#define GST_VIDEO_COMP3_MASK_16_INT 0x001f
587 </pre>
588 </div>
589 <hr>
590 <div class="refsect2">
591 <a name="GST-VIDEO-FPS-RANGE:CAPS"></a><h3>GST_VIDEO_FPS_RANGE</h3>
592 <pre class="programlisting">#define GST_VIDEO_FPS_RANGE "(fraction) [ 0, max ]"
593 </pre>
594 </div>
595 <hr>
596 <div class="refsect2">
597 <a name="GST-VIDEO-GREEN-MASK-15:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_15</h3>
598 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_15 GST_VIDEO_COMP2_MASK_15
599 </pre>
600 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
601 <h3 class="title">Warning</h3>
602 <p><code class="literal">GST_VIDEO_GREEN_MASK_15</code> is deprecated and should not be used in newly-written code.</p>
603 </div>
604 </div>
605 <hr>
606 <div class="refsect2">
607 <a name="GST-VIDEO-GREEN-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_15_INT</h3>
608 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_15_INT GST_VIDEO_COMP2_MASK_15_INT
609 </pre>
610 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
611 <h3 class="title">Warning</h3>
612 <p><code class="literal">GST_VIDEO_GREEN_MASK_15_INT</code> is deprecated and should not be used in newly-written code.</p>
613 </div>
614 </div>
615 <hr>
616 <div class="refsect2">
617 <a name="GST-VIDEO-GREEN-MASK-16:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_16</h3>
618 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_16 GST_VIDEO_COMP2_MASK_16
619 </pre>
620 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
621 <h3 class="title">Warning</h3>
622 <p><code class="literal">GST_VIDEO_GREEN_MASK_16</code> is deprecated and should not be used in newly-written code.</p>
623 </div>
624 </div>
625 <hr>
626 <div class="refsect2">
627 <a name="GST-VIDEO-GREEN-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_GREEN_MASK_16_INT</h3>
628 <pre class="programlisting">#define GST_VIDEO_GREEN_MASK_16_INT GST_VIDEO_COMP2_MASK_16_INT
629 </pre>
630 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
631 <h3 class="title">Warning</h3>
632 <p><code class="literal">GST_VIDEO_GREEN_MASK_16_INT</code> is deprecated and should not be used in newly-written code.</p>
633 </div>
634 </div>
635 <hr>
636 <div class="refsect2">
637 <a name="GST-VIDEO-RED-MASK-15:CAPS"></a><h3>GST_VIDEO_RED_MASK_15</h3>
638 <pre class="programlisting">#define GST_VIDEO_RED_MASK_15 GST_VIDEO_COMP1_MASK_15
639 </pre>
640 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
641 <h3 class="title">Warning</h3>
642 <p><code class="literal">GST_VIDEO_RED_MASK_15</code> is deprecated and should not be used in newly-written code.</p>
643 </div>
644 </div>
645 <hr>
646 <div class="refsect2">
647 <a name="GST-VIDEO-RED-MASK-15-INT:CAPS"></a><h3>GST_VIDEO_RED_MASK_15_INT</h3>
648 <pre class="programlisting">#define GST_VIDEO_RED_MASK_15_INT GST_VIDEO_COMP1_MASK_15_INT
649 </pre>
650 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
651 <h3 class="title">Warning</h3>
652 <p><code class="literal">GST_VIDEO_RED_MASK_15_INT</code> is deprecated and should not be used in newly-written code.</p>
653 </div>
654 </div>
655 <hr>
656 <div class="refsect2">
657 <a name="GST-VIDEO-RED-MASK-16:CAPS"></a><h3>GST_VIDEO_RED_MASK_16</h3>
658 <pre class="programlisting">#define GST_VIDEO_RED_MASK_16 GST_VIDEO_COMP1_MASK_16
659 </pre>
660 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
661 <h3 class="title">Warning</h3>
662 <p><code class="literal">GST_VIDEO_RED_MASK_16</code> is deprecated and should not be used in newly-written code.</p>
663 </div>
664 </div>
665 <hr>
666 <div class="refsect2">
667 <a name="GST-VIDEO-RED-MASK-16-INT:CAPS"></a><h3>GST_VIDEO_RED_MASK_16_INT</h3>
668 <pre class="programlisting">#define GST_VIDEO_RED_MASK_16_INT GST_VIDEO_COMP1_MASK_16_INT
669 </pre>
670 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
671 <h3 class="title">Warning</h3>
672 <p><code class="literal">GST_VIDEO_RED_MASK_16_INT</code> is deprecated and should not be used in newly-written code.</p>
673 </div>
674 </div>
675 <hr>
676 <div class="refsect2">
677 <a name="GST-VIDEO-SIZE-RANGE:CAPS"></a><h3>GST_VIDEO_SIZE_RANGE</h3>
678 <pre class="programlisting">#define GST_VIDEO_SIZE_RANGE "(int) [ 1, max ]"
679 </pre>
680 </div>
681 <hr>
682 <div class="refsect2">
683 <a name="GST-VIDEO-BUFFER-TFF:CAPS"></a><h3>GST_VIDEO_BUFFER_TFF</h3>
684 <pre class="programlisting">#define GST_VIDEO_BUFFER_TFF GST_BUFFER_FLAG_MEDIA1
685 </pre>
686 <p>
687 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
688 the top field.  If unset, the bottom field is first.
689 </p>
690 <p class="since">Since 0.10.23</p>
691 </div>
692 <hr>
693 <div class="refsect2">
694 <a name="GST-VIDEO-BUFFER-RFF:CAPS"></a><h3>GST_VIDEO_BUFFER_RFF</h3>
695 <pre class="programlisting">#define GST_VIDEO_BUFFER_RFF GST_BUFFER_FLAG_MEDIA2
696 </pre>
697 <p>
698 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
699 <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.
700 </p>
701 <p class="since">Since 0.10.23</p>
702 </div>
703 <hr>
704 <div class="refsect2">
705 <a name="GST-VIDEO-BUFFER-ONEFIELD:CAPS"></a><h3>GST_VIDEO_BUFFER_ONEFIELD</h3>
706 <pre class="programlisting">#define GST_VIDEO_BUFFER_ONEFIELD GST_BUFFER_FLAG_MEDIA3
707 </pre>
708 <p>
709 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
710 <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.
711 </p>
712 <p class="since">Since 0.10.23</p>
713 </div>
714 <hr>
715 <div class="refsect2">
716 <a name="GST-VIDEO-BUFFER-PROGRESSIVE:CAPS"></a><h3>GST_VIDEO_BUFFER_PROGRESSIVE</h3>
717 <pre class="programlisting">#define GST_VIDEO_BUFFER_PROGRESSIVE GST_BUFFER_FLAG_MEDIA4
718 </pre>
719 <p>
720 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 telecined, then the buffer is progressive if the
721 <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-PROGRESSIVE:CAPS" title="GST_VIDEO_BUFFER_PROGRESSIVE"><code class="literal">GST_VIDEO_BUFFER_PROGRESSIVE</code></a> flag is set, else it is telecine mixed.
722 </p>
723 <p class="since">Since 0.10.33</p>
724 </div>
725 <hr>
726 <div class="refsect2">
727 <a name="GstVideoFormat"></a><h3>enum GstVideoFormat</h3>
728 <pre class="programlisting">typedef enum {
729   GST_VIDEO_FORMAT_UNKNOWN,
730   GST_VIDEO_FORMAT_I420,
731   GST_VIDEO_FORMAT_YV12,
732   GST_VIDEO_FORMAT_YUY2,
733   GST_VIDEO_FORMAT_UYVY,
734   GST_VIDEO_FORMAT_AYUV,
735   GST_VIDEO_FORMAT_RGBx,
736   GST_VIDEO_FORMAT_BGRx,
737   GST_VIDEO_FORMAT_xRGB,
738   GST_VIDEO_FORMAT_xBGR,
739   GST_VIDEO_FORMAT_RGBA,
740   GST_VIDEO_FORMAT_BGRA,
741   GST_VIDEO_FORMAT_ARGB,
742   GST_VIDEO_FORMAT_ABGR,
743   GST_VIDEO_FORMAT_RGB,
744   GST_VIDEO_FORMAT_BGR,
745   GST_VIDEO_FORMAT_Y41B,
746   GST_VIDEO_FORMAT_Y42B,
747   GST_VIDEO_FORMAT_YVYU,
748   GST_VIDEO_FORMAT_Y444,
749   GST_VIDEO_FORMAT_v210,
750   GST_VIDEO_FORMAT_v216,
751   GST_VIDEO_FORMAT_NV12,
752   GST_VIDEO_FORMAT_NV21,
753   GST_VIDEO_FORMAT_GRAY8,
754   GST_VIDEO_FORMAT_GRAY16_BE,
755   GST_VIDEO_FORMAT_GRAY16_LE,
756   GST_VIDEO_FORMAT_v308,
757   GST_VIDEO_FORMAT_Y800,
758   GST_VIDEO_FORMAT_Y16,
759   GST_VIDEO_FORMAT_RGB16,
760   GST_VIDEO_FORMAT_BGR16,
761   GST_VIDEO_FORMAT_RGB15,
762   GST_VIDEO_FORMAT_BGR15,
763   GST_VIDEO_FORMAT_UYVP,
764   GST_VIDEO_FORMAT_A420,
765   GST_VIDEO_FORMAT_RGB8_PALETTED,
766   GST_VIDEO_FORMAT_YUV9,
767   GST_VIDEO_FORMAT_YVU9,
768   GST_VIDEO_FORMAT_IYU1,
769   GST_VIDEO_FORMAT_ARGB64,
770   GST_VIDEO_FORMAT_AYUV64,
771   GST_VIDEO_FORMAT_r210
772 } GstVideoFormat;
773 </pre>
774 <p>
775 Enum value describing the most common video formats.
776 </p>
777 <div class="variablelist"><table border="0">
778 <col align="left" valign="top">
779 <tbody>
780 <tr>
781 <td><p><a name="GST-VIDEO-FORMAT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UNKNOWN</code></span></p></td>
782 <td>Unknown or unset video format id
783 </td>
784 </tr>
785 <tr>
786 <td><p><a name="GST-VIDEO-FORMAT-I420:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I420</code></span></p></td>
787 <td>planar 4:2:0 YUV
788 </td>
789 </tr>
790 <tr>
791 <td><p><a name="GST-VIDEO-FORMAT-YV12:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YV12</code></span></p></td>
792 <td>planar 4:2:0 YVU (like I420 but UV planes swapped)
793 </td>
794 </tr>
795 <tr>
796 <td><p><a name="GST-VIDEO-FORMAT-YUY2:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YUY2</code></span></p></td>
797 <td>packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)
798 </td>
799 </tr>
800 <tr>
801 <td><p><a name="GST-VIDEO-FORMAT-UYVY:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UYVY</code></span></p></td>
802 <td>packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) 
803 </td>
804 </tr>
805 <tr>
806 <td><p><a name="GST-VIDEO-FORMAT-AYUV:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_AYUV</code></span></p></td>
807 <td>packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)
808 </td>
809 </tr>
810 <tr>
811 <td><p><a name="GST-VIDEO-FORMAT-RGBx"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGBx</code></span></p></td>
812 <td>sparse rgb packed into 32 bit, space last
813 </td>
814 </tr>
815 <tr>
816 <td><p><a name="GST-VIDEO-FORMAT-BGRx"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGRx</code></span></p></td>
817 <td>sparse reverse rgb packed into 32 bit, space last
818 </td>
819 </tr>
820 <tr>
821 <td><p><a name="GST-VIDEO-FORMAT-xRGB"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_xRGB</code></span></p></td>
822 <td>sparse rgb packed into 32 bit, space first
823 </td>
824 </tr>
825 <tr>
826 <td><p><a name="GST-VIDEO-FORMAT-xBGR"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_xBGR</code></span></p></td>
827 <td>sparse reverse rgb packed into 32 bit, space first
828 </td>
829 </tr>
830 <tr>
831 <td><p><a name="GST-VIDEO-FORMAT-RGBA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGBA</code></span></p></td>
832 <td>rgb with alpha channel last
833 </td>
834 </tr>
835 <tr>
836 <td><p><a name="GST-VIDEO-FORMAT-BGRA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGRA</code></span></p></td>
837 <td>reverse rgb with alpha channel last
838 </td>
839 </tr>
840 <tr>
841 <td><p><a name="GST-VIDEO-FORMAT-ARGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ARGB</code></span></p></td>
842 <td>rgb with alpha channel first
843 </td>
844 </tr>
845 <tr>
846 <td><p><a name="GST-VIDEO-FORMAT-ABGR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ABGR</code></span></p></td>
847 <td>reverse rgb with alpha channel first
848 </td>
849 </tr>
850 <tr>
851 <td><p><a name="GST-VIDEO-FORMAT-RGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB</code></span></p></td>
852 <td>rgb
853 </td>
854 </tr>
855 <tr>
856 <td><p><a name="GST-VIDEO-FORMAT-BGR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR</code></span></p></td>
857 <td>reverse rgb
858 </td>
859 </tr>
860 <tr>
861 <td><p><a name="GST-VIDEO-FORMAT-Y41B:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y41B</code></span></p></td>
862 <td>planar 4:1:1 YUV (Since: 0.10.18)
863 </td>
864 </tr>
865 <tr>
866 <td><p><a name="GST-VIDEO-FORMAT-Y42B:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y42B</code></span></p></td>
867 <td>planar 4:2:2 YUV (Since: 0.10.18)
868 </td>
869 </tr>
870 <tr>
871 <td><p><a name="GST-VIDEO-FORMAT-YVYU:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YVYU</code></span></p></td>
872 <td>packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...) (Since: 0.10.23)
873 </td>
874 </tr>
875 <tr>
876 <td><p><a name="GST-VIDEO-FORMAT-Y444:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y444</code></span></p></td>
877 <td>planar 4:4:4 YUV (Since: 0.10.24)
878 </td>
879 </tr>
880 <tr>
881 <td><p><a name="GST-VIDEO-FORMAT-v210"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v210</code></span></p></td>
882 <td>packed 4:2:2 10-bit YUV, complex format (Since: 0.10.24)
883 </td>
884 </tr>
885 <tr>
886 <td><p><a name="GST-VIDEO-FORMAT-v216"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v216</code></span></p></td>
887 <td>packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order (Since: 0.10.24)
888 </td>
889 </tr>
890 <tr>
891 <td><p><a name="GST-VIDEO-FORMAT-NV12:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV12</code></span></p></td>
892 <td>planar 4:2:0 YUV with interleaved UV plane (Since: 0.10.26)
893 </td>
894 </tr>
895 <tr>
896 <td><p><a name="GST-VIDEO-FORMAT-NV21:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV21</code></span></p></td>
897 <td>planar 4:2:0 YUV with interleaved VU plane (Since: 0.10.26)
898 </td>
899 </tr>
900 <tr>
901 <td><p><a name="GST-VIDEO-FORMAT-GRAY8:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GRAY8</code></span></p></td>
902 <td>8-bit grayscale (Since: 0.10.29)
903 </td>
904 </tr>
905 <tr>
906 <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>
907 <td>16-bit grayscale, most significant byte first (Since: 0.10.29)
908 </td>
909 </tr>
910 <tr>
911 <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>
912 <td>16-bit grayscale, least significant byte first (Since: 0.10.29)
913 </td>
914 </tr>
915 <tr>
916 <td><p><a name="GST-VIDEO-FORMAT-v308"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v308</code></span></p></td>
917 <td>packed 4:4:4 YUV (Since: 0.10.29)
918 </td>
919 </tr>
920 <tr>
921 <td><p><a name="GST-VIDEO-FORMAT-Y800:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y800</code></span></p></td>
922 <td>same as GST_VIDEO_FORMAT_GRAY8 (Since: 0.10.30)
923 </td>
924 </tr>
925 <tr>
926 <td><p><a name="GST-VIDEO-FORMAT-Y16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y16</code></span></p></td>
927 <td>same as GST_VIDEO_FORMAT_GRAY16_LE (Since: 0.10.30)
928 </td>
929 </tr>
930 <tr>
931 <td><p><a name="GST-VIDEO-FORMAT-RGB16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB16</code></span></p></td>
932 <td>rgb 5-6-5 bits per component (Since: 0.10.30)
933 </td>
934 </tr>
935 <tr>
936 <td><p><a name="GST-VIDEO-FORMAT-BGR16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR16</code></span></p></td>
937 <td>reverse rgb 5-6-5 bits per component (Since: 0.10.30)
938 </td>
939 </tr>
940 <tr>
941 <td><p><a name="GST-VIDEO-FORMAT-RGB15:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB15</code></span></p></td>
942 <td>rgb 5-5-5 bits per component (Since: 0.10.30)
943 </td>
944 </tr>
945 <tr>
946 <td><p><a name="GST-VIDEO-FORMAT-BGR15:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR15</code></span></p></td>
947 <td>reverse rgb 5-5-5 bits per component (Since: 0.10.30)
948 </td>
949 </tr>
950 <tr>
951 <td><p><a name="GST-VIDEO-FORMAT-UYVP:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UYVP</code></span></p></td>
952 <td>packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) (Since: 0.10.31)
953 </td>
954 </tr>
955 <tr>
956 <td><p><a name="GST-VIDEO-FORMAT-A420:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_A420</code></span></p></td>
957 <td>planar 4:4:2:0 AYUV (Since: 0.10.31)
958 </td>
959 </tr>
960 <tr>
961 <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>
962 <td>8-bit paletted RGB (Since: 0.10.32)
963 </td>
964 </tr>
965 <tr>
966 <td><p><a name="GST-VIDEO-FORMAT-YUV9:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YUV9</code></span></p></td>
967 <td>planar 4:1:0 YUV (Since: 0.10.32)
968 </td>
969 </tr>
970 <tr>
971 <td><p><a name="GST-VIDEO-FORMAT-YVU9:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YVU9</code></span></p></td>
972 <td>planar 4:1:0 YUV (like YUV9 but UV planes swapped) (Since: 0.10.32)
973 </td>
974 </tr>
975 <tr>
976 <td><p><a name="GST-VIDEO-FORMAT-IYU1:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_IYU1</code></span></p></td>
977 <td>packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...) (Since: 0.10.32)
978 </td>
979 </tr>
980 <tr>
981 <td><p><a name="GST-VIDEO-FORMAT-ARGB64:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ARGB64</code></span></p></td>
982 <td>rgb with alpha channel first, 16 bits per channel (Since: 0.10.33)
983 </td>
984 </tr>
985 <tr>
986 <td><p><a name="GST-VIDEO-FORMAT-AYUV64:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_AYUV64</code></span></p></td>
987 <td>packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...) (Since: 0.10.33)
988 </td>
989 </tr>
990 <tr>
991 <td><p><a name="GST-VIDEO-FORMAT-r210"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_r210</code></span></p></td>
992 <td>packed 4:4:4 RGB, 10 bits per channel (Since: 0.10.33)
993 </td>
994 </tr>
995 </tbody>
996 </table></div>
997 </div>
998 <hr>
999 <div class="refsect2">
1000 <a name="gst-video-calculate-display-ratio"></a><h3>gst_video_calculate_display_ratio ()</h3>
1001 <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>,
1002                                                          <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>,
1003                                                          <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>,
1004                                                          <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>,
1005                                                          <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>,
1006                                                          <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>,
1007                                                          <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>,
1008                                                          <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>
1009 <p>
1010 Given the Pixel Aspect Ratio and size of an input video frame, and the
1011 pixel aspect ratio of the intended display device, calculates the actual
1012 display ratio the video will be rendered with.
1013 </p>
1014 <div class="variablelist"><table border="0">
1015 <col align="left" valign="top">
1016 <tbody>
1017 <tr>
1018 <td><p><span class="term"><em class="parameter"><code>dar_n</code></em> :</span></p></td>
1019 <td>Numerator of the calculated display_ratio</td>
1020 </tr>
1021 <tr>
1022 <td><p><span class="term"><em class="parameter"><code>dar_d</code></em> :</span></p></td>
1023 <td>Denominator of the calculated display_ratio</td>
1024 </tr>
1025 <tr>
1026 <td><p><span class="term"><em class="parameter"><code>video_width</code></em> :</span></p></td>
1027 <td>Width of the video frame in pixels</td>
1028 </tr>
1029 <tr>
1030 <td><p><span class="term"><em class="parameter"><code>video_height</code></em> :</span></p></td>
1031 <td>Height of the video frame in pixels</td>
1032 </tr>
1033 <tr>
1034 <td><p><span class="term"><em class="parameter"><code>video_par_n</code></em> :</span></p></td>
1035 <td>Numerator of the pixel aspect ratio of the input video.</td>
1036 </tr>
1037 <tr>
1038 <td><p><span class="term"><em class="parameter"><code>video_par_d</code></em> :</span></p></td>
1039 <td>Denominator of the pixel aspect ratio of the input video.</td>
1040 </tr>
1041 <tr>
1042 <td><p><span class="term"><em class="parameter"><code>display_par_n</code></em> :</span></p></td>
1043 <td>Numerator of the pixel aspect ratio of the display device</td>
1044 </tr>
1045 <tr>
1046 <td><p><span class="term"><em class="parameter"><code>display_par_d</code></em> :</span></p></td>
1047 <td>Denominator of the pixel aspect ratio of the display device</td>
1048 </tr>
1049 <tr>
1050 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1051 <td>A boolean indicating success and a calculated Display Ratio in the
1052 dar_n and dar_d parameters.
1053 The return value is FALSE in the case of integer overflow or other error.</td>
1054 </tr>
1055 </tbody>
1056 </table></div>
1057 <p class="since">Since 0.10.7</p>
1058 </div>
1059 <hr>
1060 <div class="refsect2">
1061 <a name="gst-video-frame-rate"></a><h3>gst_video_frame_rate ()</h3>
1062 <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>
1063 <p>
1064 A convenience function to retrieve a GValue holding the framerate
1065 from the caps on a pad.
1066 </p>
1067 <p>
1068 The pad needs to have negotiated caps containing a framerate property.
1069 </p>
1070 <div class="variablelist"><table border="0">
1071 <col align="left" valign="top">
1072 <tbody>
1073 <tr>
1074 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1075 <td>pointer to a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>
1076 </td>
1077 </tr>
1078 <tr>
1079 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1080 <td>NULL if the pad has no configured caps or the configured caps
1081 do not contain a framerate.</td>
1082 </tr>
1083 </tbody>
1084 </table></div>
1085 </div>
1086 <hr>
1087 <div class="refsect2">
1088 <a name="gst-video-get-size"></a><h3>gst_video_get_size ()</h3>
1089 <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>,
1090                                                          <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>,
1091                                                          <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>
1092 <p>
1093 Inspect the caps of the provided pad and retrieve the width and height of
1094 the video frames it is configured for.
1095 </p>
1096 <p>
1097 The pad needs to have negotiated caps containing width and height properties.
1098 </p>
1099 <div class="variablelist"><table border="0">
1100 <col align="left" valign="top">
1101 <tbody>
1102 <tr>
1103 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
1104 <td>pointer to a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a>
1105 </td>
1106 </tr>
1107 <tr>
1108 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1109 <td>pointer to integer to hold pixel width of the video frames (output)</td>
1110 </tr>
1111 <tr>
1112 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1113 <td>pointer to integer to hold pixel height of the video frames (output)</td>
1114 </tr>
1115 <tr>
1116 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1117 <td>TRUE if the width and height could be retrieved.</td>
1118 </tr>
1119 </tbody>
1120 </table></div>
1121 </div>
1122 <hr>
1123 <div class="refsect2">
1124 <a name="gst-video-get-size-from-caps"></a><h3>gst_video_get_size_from_caps ()</h3>
1125 <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_from_caps        (<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> *caps</code></em>,
1126                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *size</code></em>);</pre>
1127 <p>
1128 Calculates the total number of bytes in the raw video format for the given
1129 caps.  This number should be used when allocating a buffer for raw video.
1130 </p>
1131 <div class="variablelist"><table border="0">
1132 <col align="left" valign="top">
1133 <tbody>
1134 <tr>
1135 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1136 <td>a pointer to <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>
1137 </td>
1138 </tr>
1139 <tr>
1140 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
1141 <td>a pointer to a gint that will be assigned the size (in bytes) of a video frame with the given caps</td>
1142 </tr>
1143 <tr>
1144 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1145 <td>
1146 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the size could be calculated from the caps</td>
1147 </tr>
1148 </tbody>
1149 </table></div>
1150 <p class="since">Since 0.10.36</p>
1151 </div>
1152 <hr>
1153 <div class="refsect2">
1154 <a name="gst-video-format-convert"></a><h3>gst_video_format_convert ()</h3>
1155 <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>,
1156                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
1157                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>,
1158                                                          <em class="parameter"><code><span class="type">int</span> fps_n</code></em>,
1159                                                          <em class="parameter"><code><span class="type">int</span> fps_d</code></em>,
1160                                                          <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>,
1161                                                          <em class="parameter"><code><span class="type">gint64</span> src_value</code></em>,
1162                                                          <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>,
1163                                                          <em class="parameter"><code><span class="type">gint64</span> *dest_value</code></em>);</pre>
1164 <p>
1165 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
1166 GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT.  For
1167 raw video, GST_FORMAT_DEFAULT corresponds to video frames.  This
1168 function can be to handle pad queries of the type GST_QUERY_CONVERT.
1169 </p>
1170 <div class="variablelist"><table border="0">
1171 <col align="left" valign="top">
1172 <tbody>
1173 <tr>
1174 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1175 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1176 </td>
1177 </tr>
1178 <tr>
1179 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1180 <td>the width of video</td>
1181 </tr>
1182 <tr>
1183 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1184 <td>the height of video</td>
1185 </tr>
1186 <tr>
1187 <td><p><span class="term"><em class="parameter"><code>fps_n</code></em> :</span></p></td>
1188 <td>frame rate numerator</td>
1189 </tr>
1190 <tr>
1191 <td><p><span class="term"><em class="parameter"><code>fps_d</code></em> :</span></p></td>
1192 <td>frame rate denominator</td>
1193 </tr>
1194 <tr>
1195 <td><p><span class="term"><em class="parameter"><code>src_format</code></em> :</span></p></td>
1196 <td>
1197 <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>
1198 </td>
1199 </tr>
1200 <tr>
1201 <td><p><span class="term"><em class="parameter"><code>src_value</code></em> :</span></p></td>
1202 <td>value to convert</td>
1203 </tr>
1204 <tr>
1205 <td><p><span class="term"><em class="parameter"><code>dest_format</code></em> :</span></p></td>
1206 <td>
1207 <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>
1208 </td>
1209 </tr>
1210 <tr>
1211 <td><p><span class="term"><em class="parameter"><code>dest_value</code></em> :</span></p></td>
1212 <td>pointer to destination value</td>
1213 </tr>
1214 <tr>
1215 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1216 <td>TRUE if the conversion was successful.</td>
1217 </tr>
1218 </tbody>
1219 </table></div>
1220 <p class="since">Since 0.10.16</p>
1221 </div>
1222 <hr>
1223 <div class="refsect2">
1224 <a name="gst-video-format-new-caps"></a><h3>gst_video_format_new_caps ()</h3>
1225 <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>,
1226                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
1227                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>,
1228                                                          <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
1229                                                          <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
1230                                                          <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
1231                                                          <em class="parameter"><code><span class="type">int</span> par_d</code></em>);</pre>
1232 <p>
1233 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.
1234 </p>
1235 <div class="variablelist"><table border="0">
1236 <col align="left" valign="top">
1237 <tbody>
1238 <tr>
1239 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1240 <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>
1241 </tr>
1242 <tr>
1243 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1244 <td>width of video</td>
1245 </tr>
1246 <tr>
1247 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1248 <td>height of video</td>
1249 </tr>
1250 <tr>
1251 <td><p><span class="term"><em class="parameter"><code>framerate_n</code></em> :</span></p></td>
1252 <td>numerator of frame rate</td>
1253 </tr>
1254 <tr>
1255 <td><p><span class="term"><em class="parameter"><code>framerate_d</code></em> :</span></p></td>
1256 <td>denominator of frame rate</td>
1257 </tr>
1258 <tr>
1259 <td><p><span class="term"><em class="parameter"><code>par_n</code></em> :</span></p></td>
1260 <td>numerator of pixel aspect ratio</td>
1261 </tr>
1262 <tr>
1263 <td><p><span class="term"><em class="parameter"><code>par_d</code></em> :</span></p></td>
1264 <td>denominator of pixel aspect ratio</td>
1265 </tr>
1266 <tr>
1267 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1268 <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>
1269 </tr>
1270 </tbody>
1271 </table></div>
1272 <p class="since">Since 0.10.16</p>
1273 </div>
1274 <hr>
1275 <div class="refsect2">
1276 <a name="gst-video-format-new-caps-interlaced"></a><h3>gst_video_format_new_caps_interlaced ()</h3>
1277 <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
1278                                                         (<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>,
1279                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
1280                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>,
1281                                                          <em class="parameter"><code><span class="type">int</span> framerate_n</code></em>,
1282                                                          <em class="parameter"><code><span class="type">int</span> framerate_d</code></em>,
1283                                                          <em class="parameter"><code><span class="type">int</span> par_n</code></em>,
1284                                                          <em class="parameter"><code><span class="type">int</span> par_d</code></em>,
1285                                                          <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>
1286 <p>
1287 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.
1288 </p>
1289 <div class="variablelist"><table border="0">
1290 <col align="left" valign="top">
1291 <tbody>
1292 <tr>
1293 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1294 <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>
1295 </tr>
1296 <tr>
1297 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1298 <td>width of video</td>
1299 </tr>
1300 <tr>
1301 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1302 <td>height of video</td>
1303 </tr>
1304 <tr>
1305 <td><p><span class="term"><em class="parameter"><code>framerate_n</code></em> :</span></p></td>
1306 <td>numerator of frame rate</td>
1307 </tr>
1308 <tr>
1309 <td><p><span class="term"><em class="parameter"><code>framerate_d</code></em> :</span></p></td>
1310 <td>denominator of frame rate</td>
1311 </tr>
1312 <tr>
1313 <td><p><span class="term"><em class="parameter"><code>par_n</code></em> :</span></p></td>
1314 <td>numerator of pixel aspect ratio</td>
1315 </tr>
1316 <tr>
1317 <td><p><span class="term"><em class="parameter"><code>par_d</code></em> :</span></p></td>
1318 <td>denominator of pixel aspect ratio</td>
1319 </tr>
1320 <tr>
1321 <td><p><span class="term"><em class="parameter"><code>interlaced</code></em> :</span></p></td>
1322 <td>
1323 <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>
1324 </tr>
1325 <tr>
1326 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1327 <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>
1328 </tr>
1329 </tbody>
1330 </table></div>
1331 <p class="since">Since 0.10.23</p>
1332 </div>
1333 <hr>
1334 <div class="refsect2">
1335 <a name="gst-video-format-new-template-caps"></a><h3>gst_video_format_new_template_caps ()</h3>
1336 <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_template_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>);</pre>
1337 <p>
1338 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.
1339 Size, frame rate, and pixel aspect ratio are set to the full
1340 range.
1341 </p>
1342 <div class="variablelist"><table border="0">
1343 <col align="left" valign="top">
1344 <tbody>
1345 <tr>
1346 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1347 <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>
1348 </tr>
1349 <tr>
1350 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1351 <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>
1352 </tr>
1353 </tbody>
1354 </table></div>
1355 <p class="since">Since 0.10.33</p>
1356 </div>
1357 <hr>
1358 <div class="refsect2">
1359 <a name="gst-video-format-get-component-height"></a><h3>gst_video_format_get_component_height ()</h3>
1360 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_video_format_get_component_height
1361                                                         (<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>,
1362                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
1363                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
1364 <p>
1365 Calculates the height of the component.  See
1366 <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1367 of the component index.
1368 </p>
1369 <div class="variablelist"><table border="0">
1370 <col align="left" valign="top">
1371 <tbody>
1372 <tr>
1373 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1374 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1375 </td>
1376 </tr>
1377 <tr>
1378 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1379 <td>the component index</td>
1380 </tr>
1381 <tr>
1382 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1383 <td>the height of video</td>
1384 </tr>
1385 <tr>
1386 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1387 <td>height of component <em class="parameter"><code>component</code></em>
1388 </td>
1389 </tr>
1390 </tbody>
1391 </table></div>
1392 <p class="since">Since 0.10.16</p>
1393 </div>
1394 <hr>
1395 <div class="refsect2">
1396 <a name="gst-video-format-get-component-offset"></a><h3>gst_video_format_get_component_offset ()</h3>
1397 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_video_format_get_component_offset
1398                                                         (<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>,
1399                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
1400                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
1401                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
1402 <p>
1403 Calculates the offset (in bytes) of the first pixel of the component
1404 with index <em class="parameter"><code>component</code></em>.  For packed formats, this will typically be a
1405 small integer (0, 1, 2, 3).  For planar formats, this will be a
1406 (relatively) large offset to the beginning of the second or third
1407 component planes.  See <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1408 of the component index.
1409 </p>
1410 <div class="variablelist"><table border="0">
1411 <col align="left" valign="top">
1412 <tbody>
1413 <tr>
1414 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1415 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1416 </td>
1417 </tr>
1418 <tr>
1419 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1420 <td>the component index</td>
1421 </tr>
1422 <tr>
1423 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1424 <td>the width of video</td>
1425 </tr>
1426 <tr>
1427 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1428 <td>the height of video</td>
1429 </tr>
1430 <tr>
1431 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1432 <td>offset of component <em class="parameter"><code>component</code></em>
1433 </td>
1434 </tr>
1435 </tbody>
1436 </table></div>
1437 <p class="since">Since 0.10.16</p>
1438 </div>
1439 <hr>
1440 <div class="refsect2">
1441 <a name="gst-video-format-get-component-width"></a><h3>gst_video_format_get_component_width ()</h3>
1442 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_video_format_get_component_width
1443                                                         (<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>,
1444                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
1445                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>);</pre>
1446 <p>
1447 Calculates the width of the component.  See
1448 <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1449 of the component index.
1450 </p>
1451 <div class="variablelist"><table border="0">
1452 <col align="left" valign="top">
1453 <tbody>
1454 <tr>
1455 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1456 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1457 </td>
1458 </tr>
1459 <tr>
1460 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1461 <td>the component index</td>
1462 </tr>
1463 <tr>
1464 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1465 <td>the width of video</td>
1466 </tr>
1467 <tr>
1468 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1469 <td>width of component <em class="parameter"><code>component</code></em>
1470 </td>
1471 </tr>
1472 </tbody>
1473 </table></div>
1474 <p class="since">Since 0.10.16</p>
1475 </div>
1476 <hr>
1477 <div class="refsect2">
1478 <a name="gst-video-format-get-component-depth"></a><h3>gst_video_format_get_component_depth ()</h3>
1479 <pre class="programlisting"><span class="returnvalue">int</span>                 gst_video_format_get_component_depth
1480                                                         (<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>,
1481                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>);</pre>
1482 <p>
1483 Returns the number of bits used to encode an individual pixel of
1484 a given <em class="parameter"><code>component</code></em>.  Typically this is 8, although higher and lower
1485 values are possible for some formats.
1486 </p>
1487 <div class="variablelist"><table border="0">
1488 <col align="left" valign="top">
1489 <tbody>
1490 <tr>
1491 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1492 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1493 </td>
1494 </tr>
1495 <tr>
1496 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1497 <td>the video component (e.g. 0 for 'R' in RGB)</td>
1498 </tr>
1499 <tr>
1500 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1501 <td>depth of component</td>
1502 </tr>
1503 </tbody>
1504 </table></div>
1505 <p class="since">Since 0.10.33</p>
1506 </div>
1507 <hr>
1508 <div class="refsect2">
1509 <a name="gst-video-format-get-pixel-stride"></a><h3>gst_video_format_get_pixel_stride ()</h3>
1510 <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>,
1511                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>);</pre>
1512 <p>
1513 Calculates the pixel stride (number of bytes from one pixel to the
1514 pixel to its immediate left) for the video component with an index
1515 of <em class="parameter"><code>component</code></em>.  See <em class="parameter"><code>gst_video_format_get_row_stride</code></em> for a description
1516 of the component index.
1517 </p>
1518 <div class="variablelist"><table border="0">
1519 <col align="left" valign="top">
1520 <tbody>
1521 <tr>
1522 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1523 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1524 </td>
1525 </tr>
1526 <tr>
1527 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1528 <td>the component index</td>
1529 </tr>
1530 <tr>
1531 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1532 <td>pixel stride of component <em class="parameter"><code>component</code></em>
1533 </td>
1534 </tr>
1535 </tbody>
1536 </table></div>
1537 <p class="since">Since 0.10.16</p>
1538 </div>
1539 <hr>
1540 <div class="refsect2">
1541 <a name="gst-video-format-get-row-stride"></a><h3>gst_video_format_get_row_stride ()</h3>
1542 <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>,
1543                                                          <em class="parameter"><code><span class="type">int</span> component</code></em>,
1544                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>);</pre>
1545 <p>
1546 Calculates the row stride (number of bytes from one row of pixels to
1547 the next) for the video component with an index of <em class="parameter"><code>component</code></em>.  For
1548 YUV video, Y, U, and V have component indices of 0, 1, and 2,
1549 respectively.  For RGB video, R, G, and B have component indicies of
1550 0, 1, and 2, respectively.  Alpha channels, if present, have a component
1551 index of 3.  The <em class="parameter"><code>width</code></em> parameter always represents the width of the
1552 video, not the component.
1553 </p>
1554 <div class="variablelist"><table border="0">
1555 <col align="left" valign="top">
1556 <tbody>
1557 <tr>
1558 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1559 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1560 </td>
1561 </tr>
1562 <tr>
1563 <td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
1564 <td>the component index</td>
1565 </tr>
1566 <tr>
1567 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1568 <td>the width of video</td>
1569 </tr>
1570 <tr>
1571 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1572 <td>row stride of component <em class="parameter"><code>component</code></em>
1573 </td>
1574 </tr>
1575 </tbody>
1576 </table></div>
1577 <p class="since">Since 0.10.16</p>
1578 </div>
1579 <hr>
1580 <div class="refsect2">
1581 <a name="gst-video-format-get-size"></a><h3>gst_video_format_get_size ()</h3>
1582 <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>,
1583                                                          <em class="parameter"><code><span class="type">int</span> width</code></em>,
1584                                                          <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
1585 <p>
1586 Calculates the total number of bytes in the raw video format.  This
1587 number should be used when allocating a buffer for raw video.
1588 </p>
1589 <div class="variablelist"><table border="0">
1590 <col align="left" valign="top">
1591 <tbody>
1592 <tr>
1593 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1594 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1595 </td>
1596 </tr>
1597 <tr>
1598 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1599 <td>the width of video</td>
1600 </tr>
1601 <tr>
1602 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1603 <td>the height of video</td>
1604 </tr>
1605 <tr>
1606 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1607 <td>size (in bytes) of raw video format</td>
1608 </tr>
1609 </tbody>
1610 </table></div>
1611 <p class="since">Since 0.10.16</p>
1612 </div>
1613 <hr>
1614 <div class="refsect2">
1615 <a name="gst-video-format-has-alpha"></a><h3>gst_video_format_has_alpha ()</h3>
1616 <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>
1617 <p>
1618 Returns TRUE or FALSE depending on if the video format provides an
1619 alpha channel.
1620 </p>
1621 <div class="variablelist"><table border="0">
1622 <col align="left" valign="top">
1623 <tbody>
1624 <tr>
1625 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1626 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1627 </td>
1628 </tr>
1629 <tr>
1630 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1631 <td>TRUE if <em class="parameter"><code>format</code></em> has an alpha channel</td>
1632 </tr>
1633 </tbody>
1634 </table></div>
1635 <p class="since">Since 0.10.16</p>
1636 </div>
1637 <hr>
1638 <div class="refsect2">
1639 <a name="gst-video-format-is-rgb"></a><h3>gst_video_format_is_rgb ()</h3>
1640 <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>
1641 <p>
1642 Determine whether the video format is an RGB format.
1643 </p>
1644 <div class="variablelist"><table border="0">
1645 <col align="left" valign="top">
1646 <tbody>
1647 <tr>
1648 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1649 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1650 </td>
1651 </tr>
1652 <tr>
1653 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1654 <td>TRUE if <em class="parameter"><code>format</code></em> represents RGB video</td>
1655 </tr>
1656 </tbody>
1657 </table></div>
1658 <p class="since">Since 0.10.16</p>
1659 </div>
1660 <hr>
1661 <div class="refsect2">
1662 <a name="gst-video-format-is-gray"></a><h3>gst_video_format_is_gray ()</h3>
1663 <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>
1664 <p>
1665 Determine whether the video format is a grayscale format.
1666 </p>
1667 <div class="variablelist"><table border="0">
1668 <col align="left" valign="top">
1669 <tbody>
1670 <tr>
1671 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1672 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1673 </td>
1674 </tr>
1675 <tr>
1676 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1677 <td>TRUE if <em class="parameter"><code>format</code></em> represents grayscale video</td>
1678 </tr>
1679 </tbody>
1680 </table></div>
1681 <p class="since">Since 0.10.29</p>
1682 </div>
1683 <hr>
1684 <div class="refsect2">
1685 <a name="gst-video-format-is-yuv"></a><h3>gst_video_format_is_yuv ()</h3>
1686 <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>
1687 <p>
1688 Determine whether the video format is a YUV format.
1689 </p>
1690 <div class="variablelist"><table border="0">
1691 <col align="left" valign="top">
1692 <tbody>
1693 <tr>
1694 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1695 <td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
1696 </td>
1697 </tr>
1698 <tr>
1699 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1700 <td>TRUE if <em class="parameter"><code>format</code></em> represents YUV video</td>
1701 </tr>
1702 </tbody>
1703 </table></div>
1704 <p class="since">Since 0.10.16</p>
1705 </div>
1706 <hr>
1707 <div class="refsect2">
1708 <a name="gst-video-format-to-fourcc"></a><h3>gst_video_format_to_fourcc ()</h3>
1709 <pre class="programlisting"><span class="returnvalue">guint32</span>             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>
1710 <p>
1711 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
1712 a few YUV formats have corresponding FOURCC values.  If <em class="parameter"><code>format</code></em> has
1713 no corresponding FOURCC value, 0 is returned.
1714 </p>
1715 <div class="variablelist"><table border="0">
1716 <col align="left" valign="top">
1717 <tbody>
1718 <tr>
1719 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1720 <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>
1721 </tr>
1722 <tr>
1723 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1724 <td>the FOURCC corresponding to <em class="parameter"><code>format</code></em>
1725 </td>
1726 </tr>
1727 </tbody>
1728 </table></div>
1729 <p class="since">Since 0.10.16</p>
1730 </div>
1731 <hr>
1732 <div class="refsect2">
1733 <a name="gst-video-format-from-fourcc"></a><h3>gst_video_format_from_fourcc ()</h3>
1734 <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><span class="type">guint32</span> fourcc</code></em>);</pre>
1735 <p>
1736 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>.
1737 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>,
1738 <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.
1739 </p>
1740 <div class="variablelist"><table border="0">
1741 <col align="left" valign="top">
1742 <tbody>
1743 <tr>
1744 <td><p><span class="term"><em class="parameter"><code>fourcc</code></em> :</span></p></td>
1745 <td>a FOURCC value representing raw YUV video</td>
1746 </tr>
1747 <tr>
1748 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1749 <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>
1750 </tr>
1751 </tbody>
1752 </table></div>
1753 <p class="since">Since 0.10.16</p>
1754 </div>
1755 <hr>
1756 <div class="refsect2">
1757 <a name="gst-video-format-parse-caps"></a><h3>gst_video_format_parse_caps ()</h3>
1758 <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>const <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>,
1759                                                          <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>,
1760                                                          <em class="parameter"><code><span class="type">int</span> *width</code></em>,
1761                                                          <em class="parameter"><code><span class="type">int</span> *height</code></em>);</pre>
1762 <p>
1763 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
1764 pointed to by <em class="parameter"><code>format</code></em>.  Extracts the size of the video and places it
1765 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
1766 represent a video format or does not contain height and width, the
1767 function will fail and return FALSE. If <em class="parameter"><code>caps</code></em> does not represent a raw
1768 video format listed in <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>, but still contains video caps,
1769 this function will return TRUE and set <em class="parameter"><code>format</code></em> to <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-UNKNOWN:CAPS"><span class="type">GST_VIDEO_FORMAT_UNKNOWN</span></a>.
1770 </p>
1771 <div class="variablelist"><table border="0">
1772 <col align="left" valign="top">
1773 <tbody>
1774 <tr>
1775 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1776 <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>
1777 </tr>
1778 <tr>
1779 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
1780 <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>
1781 </tr>
1782 <tr>
1783 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1784 <td>the width of the video represented by <em class="parameter"><code>caps</code></em>, may be NULL (output)</td>
1785 </tr>
1786 <tr>
1787 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1788 <td>the height of the video represented by <em class="parameter"><code>caps</code></em>, may be NULL (output)</td>
1789 </tr>
1790 <tr>
1791 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1792 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1793 </tr>
1794 </tbody>
1795 </table></div>
1796 <p class="since">Since 0.10.16</p>
1797 </div>
1798 <hr>
1799 <div class="refsect2">
1800 <a name="gst-video-format-parse-caps-interlaced"></a><h3>gst_video_format_parse_caps_interlaced ()</h3>
1801 <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
1802                                                         (<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>,
1803                                                          <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>
1804 <p>
1805 Extracts whether the caps represents interlaced content or not and places it
1806 in <em class="parameter"><code>interlaced</code></em>.
1807 </p>
1808 <div class="variablelist"><table border="0">
1809 <col align="left" valign="top">
1810 <tbody>
1811 <tr>
1812 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1813 <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>
1814 </tr>
1815 <tr>
1816 <td><p><span class="term"><em class="parameter"><code>interlaced</code></em> :</span></p></td>
1817 <td>whether <em class="parameter"><code>caps</code></em> represents interlaced video or not, may be NULL (output)</td>
1818 </tr>
1819 <tr>
1820 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1821 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1822 </tr>
1823 </tbody>
1824 </table></div>
1825 <p class="since">Since 0.10.23</p>
1826 </div>
1827 <hr>
1828 <div class="refsect2">
1829 <a name="gst-video-parse-caps-framerate"></a><h3>gst_video_parse_caps_framerate ()</h3>
1830 <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>,
1831                                                          <em class="parameter"><code><span class="type">int</span> *fps_n</code></em>,
1832                                                          <em class="parameter"><code><span class="type">int</span> *fps_d</code></em>);</pre>
1833 <p>
1834 Extracts the frame rate from <em class="parameter"><code>caps</code></em> and places the values in the locations
1835 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
1836 parsed correctly, FALSE if not.
1837 </p>
1838 <p>
1839 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
1840 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>.
1841 </p>
1842 <div class="variablelist"><table border="0">
1843 <col align="left" valign="top">
1844 <tbody>
1845 <tr>
1846 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1847 <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>
1848 </tr>
1849 <tr>
1850 <td><p><span class="term"><em class="parameter"><code>fps_n</code></em> :</span></p></td>
1851 <td>pointer to integer to hold numerator of frame rate (output)</td>
1852 </tr>
1853 <tr>
1854 <td><p><span class="term"><em class="parameter"><code>fps_d</code></em> :</span></p></td>
1855 <td>pointer to integer to hold denominator of frame rate (output)</td>
1856 </tr>
1857 <tr>
1858 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1859 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1860 </tr>
1861 </tbody>
1862 </table></div>
1863 <p class="since">Since 0.10.16</p>
1864 </div>
1865 <hr>
1866 <div class="refsect2">
1867 <a name="gst-video-parse-caps-pixel-aspect-ratio"></a><h3>gst_video_parse_caps_pixel_aspect_ratio ()</h3>
1868 <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
1869                                                         (<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>,
1870                                                          <em class="parameter"><code><span class="type">int</span> *par_n</code></em>,
1871                                                          <em class="parameter"><code><span class="type">int</span> *par_d</code></em>);</pre>
1872 <p>
1873 Extracts the pixel aspect ratio from <em class="parameter"><code>caps</code></em> and places the values in
1874 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
1875 values could be parsed correctly, FALSE if not.
1876 </p>
1877 <p>
1878 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
1879 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>.
1880 </p>
1881 <div class="variablelist"><table border="0">
1882 <col align="left" valign="top">
1883 <tbody>
1884 <tr>
1885 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1886 <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>
1887 </tr>
1888 <tr>
1889 <td><p><span class="term"><em class="parameter"><code>par_n</code></em> :</span></p></td>
1890 <td>pointer to numerator of pixel aspect ratio (output)</td>
1891 </tr>
1892 <tr>
1893 <td><p><span class="term"><em class="parameter"><code>par_d</code></em> :</span></p></td>
1894 <td>pointer to denominator of pixel aspect ratio (output)</td>
1895 </tr>
1896 <tr>
1897 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1898 <td>TRUE if <em class="parameter"><code>caps</code></em> was parsed correctly.</td>
1899 </tr>
1900 </tbody>
1901 </table></div>
1902 <p class="since">Since 0.10.16</p>
1903 </div>
1904 <hr>
1905 <div class="refsect2">
1906 <a name="gst-video-parse-caps-color-matrix"></a><h3>gst_video_parse_caps_color_matrix ()</h3>
1907 <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>
1908 <p>
1909 Extracts the color matrix used by the caps.  Possible values are
1910 "sdtv" for the standard definition color matrix (as specified in
1911 Rec. ITU-R BT.470-6) or "hdtv" for the high definition color
1912 matrix (as specified in Rec. ITU-R BT.709)
1913 </p>
1914 <div class="variablelist"><table border="0">
1915 <col align="left" valign="top">
1916 <tbody>
1917 <tr>
1918 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1919 <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>
1920 </tr>
1921 <tr>
1922 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1923 <td>a color matrix string, or NULL if no color matrix could be
1924 determined.</td>
1925 </tr>
1926 </tbody>
1927 </table></div>
1928 <p class="since">Since 0.10.29</p>
1929 </div>
1930 <hr>
1931 <div class="refsect2">
1932 <a name="gst-video-parse-caps-chroma-site"></a><h3>gst_video_parse_caps_chroma_site ()</h3>
1933 <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>
1934 <p>
1935 Extracts the chroma site used by the caps.  Possible values are
1936 "mpeg2" for MPEG-2 style chroma siting (co-sited horizontally,
1937 halfway-sited vertically), "jpeg" for JPEG and Theora style
1938 chroma siting (halfway-sited both horizontally and vertically).
1939 Other chroma site values are possible, but uncommon.
1940 </p>
1941 <p>
1942 When no chroma site is specified in the caps, it should be assumed
1943 to be "mpeg2".
1944 </p>
1945 <div class="variablelist"><table border="0">
1946 <col align="left" valign="top">
1947 <tbody>
1948 <tr>
1949 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1950 <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>
1951 </tr>
1952 <tr>
1953 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1954 <td>a chroma site string, or NULL if no chroma site could be
1955 determined.</td>
1956 </tr>
1957 </tbody>
1958 </table></div>
1959 <p class="since">Since 0.10.29</p>
1960 </div>
1961 <hr>
1962 <div class="refsect2">
1963 <a name="gst-video-parse-caps-palette"></a><h3>gst_video_parse_caps_palette ()</h3>
1964 <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>
1965 <p>
1966 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
1967 <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 <span class="type">guint32</span>
1968 values, each containing ARGB colors in native endianness.
1969 </p>
1970 <div class="variablelist"><table border="0">
1971 <col align="left" valign="top">
1972 <tbody>
1973 <tr>
1974 <td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
1975 <td>
1976 <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>
1977 </tr>
1978 <tr>
1979 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1980 <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>
1981 </tr>
1982 </tbody>
1983 </table></div>
1984 <p class="since">Since 0.10.32</p>
1985 </div>
1986 <hr>
1987 <div class="refsect2">
1988 <a name="GstVideoConvertFrameCallback"></a><h3>GstVideoConvertFrameCallback ()</h3>
1989 <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>,
1990                                                          <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>,
1991                                                          <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>
1992 </div>
1993 <hr>
1994 <div class="refsect2">
1995 <a name="gst-video-convert-frame"></a><h3>gst_video_convert_frame ()</h3>
1996 <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>,
1997                                                          <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>,
1998                                                          <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>,
1999                                                          <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>
2000 <p>
2001 Converts a raw video buffer into the specified output caps.
2002 </p>
2003 <p>
2004 The output caps can be any raw video formats or any image formats (jpeg, png, ...).
2005 </p>
2006 <p>
2007 The width, height and pixel-aspect-ratio can also be specified in the output caps.
2008 </p>
2009 <div class="variablelist"><table border="0">
2010 <col align="left" valign="top">
2011 <tbody>
2012 <tr>
2013 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
2014 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
2015 </td>
2016 </tr>
2017 <tr>
2018 <td><p><span class="term"><em class="parameter"><code>to_caps</code></em> :</span></p></td>
2019 <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>
2020 </tr>
2021 <tr>
2022 <td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
2023 <td>the maximum amount of time allowed for the processing.</td>
2024 </tr>
2025 <tr>
2026 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
2027 <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>
2028 </tr>
2029 <tr>
2030 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2031 <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>
2032 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>
2033 </tr>
2034 </tbody>
2035 </table></div>
2036 <p class="since">Since 0.10.31</p>
2037 </div>
2038 <hr>
2039 <div class="refsect2">
2040 <a name="gst-video-convert-frame-async"></a><h3>gst_video_convert_frame_async ()</h3>
2041 <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>,
2042                                                          <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>,
2043                                                          <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>,
2044                                                          <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>,
2045                                                          <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>,
2046                                                          <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>
2047 <p>
2048 Converts a raw video buffer into the specified output caps.
2049 </p>
2050 <p>
2051 The output caps can be any raw video formats or any image formats (jpeg, png, ...).
2052 </p>
2053 <p>
2054 The width, height and pixel-aspect-ratio can also be specified in the output caps.
2055 </p>
2056 <p>
2057 <em class="parameter"><code>callback</code></em> will be called after conversion, when an error occured or if conversion didn't
2058 finish after <em class="parameter"><code>timeout</code></em>. <em class="parameter"><code>callback</code></em> will always be called from the thread default
2059 <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,
2060 this will always be the global default main context.
2061 </p>
2062 <p>
2063 <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
2064 anymore.
2065 </p>
2066 <div class="variablelist"><table border="0">
2067 <col align="left" valign="top">
2068 <tbody>
2069 <tr>
2070 <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
2071 <td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
2072 </td>
2073 </tr>
2074 <tr>
2075 <td><p><span class="term"><em class="parameter"><code>to_caps</code></em> :</span></p></td>
2076 <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>
2077 </tr>
2078 <tr>
2079 <td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
2080 <td>the maximum amount of time allowed for the processing.</td>
2081 </tr>
2082 <tr>
2083 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
2084 <td>
2085 <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>
2086 </tr>
2087 <tr>
2088 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2089 <td>extra data that will be passed to the <em class="parameter"><code>callback</code></em>
2090 </td>
2091 </tr>
2092 <tr>
2093 <td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>
2094 <td>
2095 <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>
2096 </tr>
2097 </tbody>
2098 </table></div>
2099 <p class="since">Since 0.10.31</p>
2100 </div>
2101 <hr>
2102 <div class="refsect2">
2103 <a name="gst-video-event-new-still-frame"></a><h3>gst_video_event_new_still_frame ()</h3>
2104 <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>
2105 <p>
2106 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
2107 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
2108 the event ends a still frame sequence.
2109 </p>
2110 <p>
2111 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
2112 <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>.
2113 </p>
2114 <div class="variablelist"><table border="0">
2115 <col align="left" valign="top">
2116 <tbody>
2117 <tr>
2118 <td><p><span class="term"><em class="parameter"><code>in_still</code></em> :</span></p></td>
2119 <td>boolean value for the still-frame state of the event.</td>
2120 </tr>
2121 <tr>
2122 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2123 <td>The new GstEvent</td>
2124 </tr>
2125 </tbody>
2126 </table></div>
2127 <p class="since">Since 0.10.26</p>
2128 </div>
2129 <hr>
2130 <div class="refsect2">
2131 <a name="gst-video-event-parse-still-frame"></a><h3>gst_video_event_parse_still_frame ()</h3>
2132 <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>,
2133                                                          <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>
2134 <p>
2135 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
2136 return the still-frame state from the event if it is.
2137 If the event represents the start of a still frame, the in_still
2138 variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the
2139 in_still variable order to just check whether the event is a valid still-frame
2140 event.
2141 </p>
2142 <p>
2143 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>
2144 </p>
2145 <div class="variablelist"><table border="0">
2146 <col align="left" valign="top">
2147 <tbody>
2148 <tr>
2149 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2150 <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>
2151 </tr>
2152 <tr>
2153 <td><p><span class="term"><em class="parameter"><code>in_still</code></em> :</span></p></td>
2154 <td>A boolean to receive the still-frame status from the event, or NULL</td>
2155 </tr>
2156 <tr>
2157 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2158 <td>
2159 <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>
2160 </tr>
2161 </tbody>
2162 </table></div>
2163 <p class="since">Since 0.10.26</p>
2164 </div>
2165 <hr>
2166 <div class="refsect2">
2167 <a name="gst-video-event-new-upstream-force-key-unit"></a><h3>gst_video_event_new_upstream_force_key_unit ()</h3>
2168 <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_upstream_force_key_unit
2169                                                         (<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> running_time</code></em>,
2170                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> all_headers</code></em>,
2171                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> count</code></em>);</pre>
2172 <p>
2173 Creates a new upstream force key unit event. An upstream force key unit event
2174 can be sent to request upstream elements to produce a key unit. 
2175 </p>
2176 <p>
2177 <em class="parameter"><code>running_time</code></em> can be set to request a new key unit at a specific
2178 running_time. If set to GST_CLOCK_TIME_NONE, upstream elements will produce a
2179 new key unit as soon as possible.
2180 </p>
2181 <p>
2182 To parse an event created by <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-downstream-force-key-unit" title="gst_video_event_new_downstream_force_key_unit ()"><code class="function">gst_video_event_new_downstream_force_key_unit()</code></a> use
2183 <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-parse-downstream-force-key-unit" title="gst_video_event_parse_downstream_force_key_unit ()"><code class="function">gst_video_event_parse_downstream_force_key_unit()</code></a>.
2184 </p>
2185 <div class="variablelist"><table border="0">
2186 <col align="left" valign="top">
2187 <tbody>
2188 <tr>
2189 <td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
2190 <td>the running_time at which a new key unit should be produced</td>
2191 </tr>
2192 <tr>
2193 <td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
2194 <td>
2195 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to produce headers when starting a new key unit</td>
2196 </tr>
2197 <tr>
2198 <td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
2199 <td>integer that can be used to number key units</td>
2200 </tr>
2201 <tr>
2202 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2203 <td>The new GstEvent</td>
2204 </tr>
2205 </tbody>
2206 </table></div>
2207 <p class="since">Since 0.10.36</p>
2208 </div>
2209 <hr>
2210 <div class="refsect2">
2211 <a name="gst-video-event-new-downstream-force-key-unit"></a><h3>gst_video_event_new_downstream_force_key_unit ()</h3>
2212 <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_downstream_force_key_unit
2213                                                         (<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> timestamp</code></em>,
2214                                                          <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> streamtime</code></em>,
2215                                                          <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> runningtime</code></em>,
2216                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> all_headers</code></em>,
2217                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> count</code></em>);</pre>
2218 <p>
2219 Creates a new downstream force key unit event. A downstream force key unit
2220 event can be sent down the pipeline to request downstream elements to produce
2221 a key unit. A downstream force key unit event must also be sent when handling
2222 an upstream force key unit event to notify downstream that the latter has been
2223 handled.
2224 </p>
2225 <p>
2226 To parse an event created by <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-downstream-force-key-unit" title="gst_video_event_new_downstream_force_key_unit ()"><code class="function">gst_video_event_new_downstream_force_key_unit()</code></a> use
2227 <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-parse-downstream-force-key-unit" title="gst_video_event_parse_downstream_force_key_unit ()"><code class="function">gst_video_event_parse_downstream_force_key_unit()</code></a>.
2228 </p>
2229 <div class="variablelist"><table border="0">
2230 <col align="left" valign="top">
2231 <tbody>
2232 <tr>
2233 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
2234 <td>the timestamp of the buffer that starts a new key unit</td>
2235 </tr>
2236 <tr>
2237 <td><p><span class="term"><em class="parameter"><code>stream_time</code></em> :</span></p></td>
2238 <td>the stream_time of the buffer that starts a new key unit</td>
2239 </tr>
2240 <tr>
2241 <td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
2242 <td>the running_time of the buffer that starts a new key unit</td>
2243 </tr>
2244 <tr>
2245 <td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
2246 <td>
2247 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to produce headers when starting a new key unit</td>
2248 </tr>
2249 <tr>
2250 <td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
2251 <td>integer that can be used to number key units</td>
2252 </tr>
2253 <tr>
2254 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2255 <td>The new GstEvent</td>
2256 </tr>
2257 </tbody>
2258 </table></div>
2259 <p class="since">Since 0.10.36</p>
2260 </div>
2261 <hr>
2262 <div class="refsect2">
2263 <a name="gst-video-event-is-force-key-unit"></a><h3>gst_video_event_is_force_key_unit ()</h3>
2264 <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_is_force_key_unit   (<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>);</pre>
2265 <p>
2266 Checks if an event is a force key unit event. Returns true for both upstream
2267 and downstream force key unit events.
2268 </p>
2269 <div class="variablelist"><table border="0">
2270 <col align="left" valign="top">
2271 <tbody>
2272 <tr>
2273 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2274 <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 check</td>
2275 </tr>
2276 <tr>
2277 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2278 <td>
2279 <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 force key unit event</td>
2280 </tr>
2281 </tbody>
2282 </table></div>
2283 <p class="since">Since 0.10.36</p>
2284 </div>
2285 <hr>
2286 <div class="refsect2">
2287 <a name="gst-video-event-parse-upstream-force-key-unit"></a><h3>gst_video_event_parse_upstream_force_key_unit ()</h3>
2288 <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_upstream_force_key_unit
2289                                                         (<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>,
2290                                                          <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> *running_time</code></em>,
2291                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *all_headers</code></em>,
2292                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *count</code></em>);</pre>
2293 <p>
2294 Get running-time, all-headers and count in the force key unit event. See
2295 <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-upstream-force-key-unit" title="gst_video_event_new_upstream_force_key_unit ()"><code class="function">gst_video_event_new_upstream_force_key_unit()</code></a> for a full description of the
2296 upstream force key unit event.
2297 </p>
2298 <p>
2299 Create an upstream force key unit event using  <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-upstream-force-key-unit" title="gst_video_event_new_upstream_force_key_unit ()"><code class="function">gst_video_event_new_upstream_force_key_unit()</code></a>
2300 </p>
2301 <div class="variablelist"><table border="0">
2302 <col align="left" valign="top">
2303 <tbody>
2304 <tr>
2305 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2306 <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>
2307 </tr>
2308 <tr>
2309 <td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
2310 <td>A pointer to the running_time in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2311 </td>
2312 </tr>
2313 <tr>
2314 <td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
2315 <td>A pointer to the all_headers flag in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2316 </td>
2317 </tr>
2318 <tr>
2319 <td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
2320 <td>A pointer to the count field in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2321 </td>
2322 </tr>
2323 <tr>
2324 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2325 <td>
2326 <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 upstream force-key-unit 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>
2327 </tr>
2328 </tbody>
2329 </table></div>
2330 <p class="since">Since 0.10.36</p>
2331 </div>
2332 <hr>
2333 <div class="refsect2">
2334 <a name="gst-video-event-parse-downstream-force-key-unit"></a><h3>gst_video_event_parse_downstream_force_key_unit ()</h3>
2335 <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_downstream_force_key_unit
2336                                                         (<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>,
2337                                                          <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> *timestamp</code></em>,
2338                                                          <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> *streamtime</code></em>,
2339                                                          <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> *runningtime</code></em>,
2340                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *all_headers</code></em>,
2341                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *count</code></em>);</pre>
2342 <p>
2343 Get timestamp, stream-time, running-time, all-headers and count in the force
2344 key unit event. See <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-event-new-downstream-force-key-unit" title="gst_video_event_new_downstream_force_key_unit ()"><code class="function">gst_video_event_new_downstream_force_key_unit()</code></a> for a
2345 full description of the downstream force key unit event.
2346 </p>
2347 <div class="variablelist"><table border="0">
2348 <col align="left" valign="top">
2349 <tbody>
2350 <tr>
2351 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
2352 <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>
2353 </tr>
2354 <tr>
2355 <td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
2356 <td>A pointer to the timestamp in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2357 </td>
2358 </tr>
2359 <tr>
2360 <td><p><span class="term"><em class="parameter"><code>stream_time</code></em> :</span></p></td>
2361 <td>A pointer to the stream-time in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2362 </td>
2363 </tr>
2364 <tr>
2365 <td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
2366 <td>A pointer to the running-time in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2367 </td>
2368 </tr>
2369 <tr>
2370 <td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
2371 <td>A pointer to the all_headers flag in the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2372 </td>
2373 </tr>
2374 <tr>
2375 <td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
2376 <td>A pointer to the count field of the event. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2377 </td>
2378 </tr>
2379 <tr>
2380 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2381 <td>
2382 <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 downstream force key unit event.</td>
2383 </tr>
2384 </tbody>
2385 </table></div>
2386 <p class="since">Since 0.10.36</p>
2387 </div>
2388 </div>
2389 </div>
2390 <div class="footer">
2391 <hr>
2392           Generated by GTK-Doc V1.18</div>
2393 </body>
2394 </html>