33
30
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstvideo.top_of_page"></a>gstvideo</span></h2>
34
31
<p>gstvideo — Support library for video operations</p>
36
<td valign="top" align="right"></td>
33
<td class="gallery_image" valign="top" align="right"></td>
37
34
</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 <gst/video/video.h>
43
<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>,
44
<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>,
45
<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>,
46
<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>,
47
<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>,
48
<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>,
49
<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>,
50
<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>);
51
<span class="returnvalue">void</span> (<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()">*GstVideoConvertSampleCallback</a>) (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
52
<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>,
53
<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>);
54
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-convert-sample" title="gst_video_convert_sample ()">gst_video_convert_sample</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
55
<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>,
56
<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>,
57
<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>);
58
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-convert-sample-async" title="gst_video_convert_sample_async ()">gst_video_convert_sample_async</a> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
59
<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>,
60
<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>,
61
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()"><span class="type">GstVideoConvertSampleCallback</span></a> callback</code></em>,
62
<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>,
63
<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>);
64
struct <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment">GstVideoAlignment</a>;
65
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-alignment-reset" title="gst_video_alignment_reset ()">gst_video_alignment_reset</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a> *align</code></em>);
66
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-STR:CAPS" title="GST_META_TAG_VIDEO_STR">GST_META_TAG_VIDEO_STR</a>
67
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-ORIENTATION-STR:CAPS" title="GST_META_TAG_VIDEO_ORIENTATION_STR">GST_META_TAG_VIDEO_ORIENTATION_STR</a>
68
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-SIZE-STR:CAPS" title="GST_META_TAG_VIDEO_SIZE_STR">GST_META_TAG_VIDEO_SIZE_STR</a>
69
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-COLORSPACE-STR:CAPS" title="GST_META_TAG_VIDEO_COLORSPACE_STR">GST_META_TAG_VIDEO_COLORSPACE_STR</a>
71
<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>);
72
<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>,
73
<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>);
74
<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>
75
(<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>,
76
<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> stream_time</code></em>,
77
<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>,
78
<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>,
79
<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>);
80
<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>
81
(<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>,
82
<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>,
83
<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> *stream_time</code></em>,
84
<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>,
85
<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>,
86
<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>);
87
<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>
88
(<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>,
89
<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>,
90
<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>);
91
<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>
92
(<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>,
93
<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>,
94
<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>,
95
<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>);
96
<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>);
98
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat">GstVideoFormat</a>;
99
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-MAX-PLANES:CAPS" title="GST_VIDEO_MAX_PLANES">GST_VIDEO_MAX_PLANES</a>
100
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-MAX-COMPONENTS:CAPS" title="GST_VIDEO_MAX_COMPONENTS">GST_VIDEO_MAX_COMPONENTS</a>
101
struct <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo">GstVideoFormatInfo</a>;
102
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite">GstVideoChromaSite</a>;
103
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="returnvalue">GstVideoChromaSite</span></a> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-chroma-from-string" title="gst_video_chroma_from_string ()">gst_video_chroma_from_string</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s</code></em>);
104
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-chroma-to-string" title="gst_video_chroma_to_string ()">gst_video_chroma_to_string</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> site</code></em>);
105
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatFlags" title="enum GstVideoFormatFlags">GstVideoFormatFlags</a>;
106
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags">GstVideoPackFlags</a>;
107
<span class="returnvalue">void</span> (<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatUnpack" title="GstVideoFormatUnpack ()">*GstVideoFormatUnpack</a>) (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
108
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags"><span class="type">GstVideoPackFlags</span></a> flags</code></em>,
109
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> dest</code></em>,
110
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data[GST_VIDEO_MAX_PLANES]</code></em>,
111
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride[GST_VIDEO_MAX_PLANES]</code></em>,
112
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
113
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
114
<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>);
115
<span class="returnvalue">void</span> (<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatPack" title="GstVideoFormatPack ()">*GstVideoFormatPack</a>) (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
116
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags"><span class="type">GstVideoPackFlags</span></a> flags</code></em>,
117
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> src</code></em>,
118
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sstride</code></em>,
119
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data[GST_VIDEO_MAX_PLANES]</code></em>,
120
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride[GST_VIDEO_MAX_PLANES]</code></em>,
121
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> chroma_site</code></em>,
122
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</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> width</code></em>);
124
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-FORMAT:CAPS" title="GST_VIDEO_FORMAT_INFO_FORMAT()">GST_VIDEO_FORMAT_INFO_FORMAT</a> (info)
125
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-NAME:CAPS" title="GST_VIDEO_FORMAT_INFO_NAME()">GST_VIDEO_FORMAT_INFO_NAME</a> (info)
126
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-FLAGS:CAPS" title="GST_VIDEO_FORMAT_INFO_FLAGS()">GST_VIDEO_FORMAT_INFO_FLAGS</a> (info)
127
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-YUV:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_YUV()">GST_VIDEO_FORMAT_INFO_IS_YUV</a> (info)
128
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-RGB:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_RGB()">GST_VIDEO_FORMAT_INFO_IS_RGB</a> (info)
129
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-GRAY:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_GRAY()">GST_VIDEO_FORMAT_INFO_IS_GRAY</a> (info)
130
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-HAS-ALPHA:CAPS" title="GST_VIDEO_FORMAT_INFO_HAS_ALPHA()">GST_VIDEO_FORMAT_INFO_HAS_ALPHA</a> (info)
131
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-LE:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_LE()">GST_VIDEO_FORMAT_INFO_IS_LE</a> (info)
132
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-HAS-PALETTE:CAPS" title="GST_VIDEO_FORMAT_INFO_HAS_PALETTE()">GST_VIDEO_FORMAT_INFO_HAS_PALETTE</a> (info)
133
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-COMPLEX:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_COMPLEX()">GST_VIDEO_FORMAT_INFO_IS_COMPLEX</a> (info)
134
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-BITS:CAPS" title="GST_VIDEO_FORMAT_INFO_BITS()">GST_VIDEO_FORMAT_INFO_BITS</a> (info)
135
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-N-COMPONENTS:CAPS" title="GST_VIDEO_FORMAT_INFO_N_COMPONENTS()">GST_VIDEO_FORMAT_INFO_N_COMPONENTS</a> (info)
136
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-SHIFT:CAPS" title="GST_VIDEO_FORMAT_INFO_SHIFT()">GST_VIDEO_FORMAT_INFO_SHIFT</a> (info,
138
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-DEPTH:CAPS" title="GST_VIDEO_FORMAT_INFO_DEPTH()">GST_VIDEO_FORMAT_INFO_DEPTH</a> (info,
140
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-PSTRIDE:CAPS" title="GST_VIDEO_FORMAT_INFO_PSTRIDE()">GST_VIDEO_FORMAT_INFO_PSTRIDE</a> (info,
142
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-N-PLANES:CAPS" title="GST_VIDEO_FORMAT_INFO_N_PLANES()">GST_VIDEO_FORMAT_INFO_N_PLANES</a> (info)
143
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-PLANE:CAPS" title="GST_VIDEO_FORMAT_INFO_PLANE()">GST_VIDEO_FORMAT_INFO_PLANE</a> (info,
145
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-POFFSET:CAPS" title="GST_VIDEO_FORMAT_INFO_POFFSET()">GST_VIDEO_FORMAT_INFO_POFFSET</a> (info,
147
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-W-SUB:CAPS" title="GST_VIDEO_FORMAT_INFO_W_SUB()">GST_VIDEO_FORMAT_INFO_W_SUB</a> (info,
149
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-H-SUB:CAPS" title="GST_VIDEO_FORMAT_INFO_H_SUB()">GST_VIDEO_FORMAT_INFO_H_SUB</a> (info,
151
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-SUB-SCALE:CAPS" title="GST_VIDEO_SUB_SCALE()">GST_VIDEO_SUB_SCALE</a> (scale,
153
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-SCALE-WIDTH:CAPS" title="GST_VIDEO_FORMAT_INFO_SCALE_WIDTH()">GST_VIDEO_FORMAT_INFO_SCALE_WIDTH</a> (info,
156
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-SCALE-HEIGHT:CAPS" title="GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT()">GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT</a> (info,
159
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-DATA:CAPS" title="GST_VIDEO_FORMAT_INFO_DATA()">GST_VIDEO_FORMAT_INFO_DATA</a> (info,
162
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-STRIDE:CAPS" title="GST_VIDEO_FORMAT_INFO_STRIDE()">GST_VIDEO_FORMAT_INFO_STRIDE</a> (info,
165
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-OFFSET:CAPS" title="GST_VIDEO_FORMAT_INFO_OFFSET()">GST_VIDEO_FORMAT_INFO_OFFSET</a> (info,
168
<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-masks" title="gst_video_format_from_masks ()">gst_video_format_from_masks</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> depth</code></em>,
169
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
170
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>,
171
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> red_mask</code></em>,
172
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> green_mask</code></em>,
173
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blue_mask</code></em>,
174
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> alpha_mask</code></em>);
175
<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>);
176
<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>);
177
<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-string" title="gst_video_format_from_string ()">gst_video_format_from_string</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>);
178
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-to-string" title="gst_video_format_to_string ()">gst_video_format_to_string</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
const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="returnvalue">GstVideoFormatInfo</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-info" title="gst_video_format_get_info ()">gst_video_format_get_info</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>);
180
#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>
181
#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>
182
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMATS-ALL:CAPS" title="GST_VIDEO_FORMATS_ALL">GST_VIDEO_FORMATS_ALL</a>
183
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-MAKE:CAPS" title="GST_VIDEO_CAPS_MAKE()">GST_VIDEO_CAPS_MAKE</a> (format)
186
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange">GstVideoColorRange</a>;
187
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorMatrix" title="enum GstVideoColorMatrix">GstVideoColorMatrix</a>;
188
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoTransferFunction" title="enum GstVideoTransferFunction">GstVideoTransferFunction</a>;
189
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorPrimaries" title="enum GstVideoColorPrimaries">GstVideoColorPrimaries</a>;
190
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry">GstVideoColorimetry</a>;
191
<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-colorimetry-matches" title="gst_video_colorimetry_matches ()">gst_video_colorimetry_matches</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>,
192
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *color</code></em>);
193
<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-colorimetry-from-string" title="gst_video_colorimetry_from_string ()">gst_video_colorimetry_from_string</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>,
194
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *color</code></em>);
195
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-colorimetry-to-string" title="gst_video_colorimetry_to_string ()">gst_video_colorimetry_to_string</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>);
196
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-color-range-offsets" title="gst_video_color_range_offsets ()">gst_video_color_range_offsets</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a> range</code></em>,
197
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
198
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset[GST_VIDEO_MAX_COMPONENTS]</code></em>,
199
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> scale[GST_VIDEO_MAX_COMPONENTS]</code></em>);
202
struct <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo">GstVideoInfo</a>;
203
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInterlaceMode" title="enum GstVideoInterlaceMode">GstVideoInterlaceMode</a>;
204
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFlags" title="enum GstVideoFlags">GstVideoFlags</a>;
205
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FORMAT:CAPS" title="GST_VIDEO_INFO_FORMAT()">GST_VIDEO_INFO_FORMAT</a> (i)
206
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-NAME:CAPS" title="GST_VIDEO_INFO_NAME()">GST_VIDEO_INFO_NAME</a> (i)
207
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-YUV:CAPS" title="GST_VIDEO_INFO_IS_YUV()">GST_VIDEO_INFO_IS_YUV</a> (i)
208
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-RGB:CAPS" title="GST_VIDEO_INFO_IS_RGB()">GST_VIDEO_INFO_IS_RGB</a> (i)
209
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-GRAY:CAPS" title="GST_VIDEO_INFO_IS_GRAY()">GST_VIDEO_INFO_IS_GRAY</a> (i)
210
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-HAS-ALPHA:CAPS" title="GST_VIDEO_INFO_HAS_ALPHA()">GST_VIDEO_INFO_HAS_ALPHA</a> (i)
211
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-INTERLACE-MODE:CAPS" title="GST_VIDEO_INFO_INTERLACE_MODE()">GST_VIDEO_INFO_INTERLACE_MODE</a> (i)
212
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-INTERLACED:CAPS" title="GST_VIDEO_INFO_IS_INTERLACED()">GST_VIDEO_INFO_IS_INTERLACED</a> (i)
213
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAGS:CAPS" title="GST_VIDEO_INFO_FLAGS()">GST_VIDEO_INFO_FLAGS</a> (i)
214
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-WIDTH:CAPS" title="GST_VIDEO_INFO_WIDTH()">GST_VIDEO_INFO_WIDTH</a> (i)
215
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-HEIGHT:CAPS" title="GST_VIDEO_INFO_HEIGHT()">GST_VIDEO_INFO_HEIGHT</a> (i)
216
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-SIZE:CAPS" title="GST_VIDEO_INFO_SIZE()">GST_VIDEO_INFO_SIZE</a> (i)
217
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-VIEWS:CAPS" title="GST_VIDEO_INFO_VIEWS()">GST_VIDEO_INFO_VIEWS</a> (i)
218
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PAR-N:CAPS" title="GST_VIDEO_INFO_PAR_N()">GST_VIDEO_INFO_PAR_N</a> (i)
219
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PAR-D:CAPS" title="GST_VIDEO_INFO_PAR_D()">GST_VIDEO_INFO_PAR_D</a> (i)
220
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FPS-N:CAPS" title="GST_VIDEO_INFO_FPS_N()">GST_VIDEO_INFO_FPS_N</a> (i)
221
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FPS-D:CAPS" title="GST_VIDEO_INFO_FPS_D()">GST_VIDEO_INFO_FPS_D</a> (i)
222
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAG-IS-SET:CAPS" title="GST_VIDEO_INFO_FLAG_IS_SET()">GST_VIDEO_INFO_FLAG_IS_SET</a> (i,
224
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAG-SET:CAPS" title="GST_VIDEO_INFO_FLAG_SET()">GST_VIDEO_INFO_FLAG_SET</a> (i,
226
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAG-UNSET:CAPS" title="GST_VIDEO_INFO_FLAG_UNSET()">GST_VIDEO_INFO_FLAG_UNSET</a> (i,
228
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-N-PLANES:CAPS" title="GST_VIDEO_INFO_N_PLANES()">GST_VIDEO_INFO_N_PLANES</a> (i)
229
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PLANE-OFFSET:CAPS" title="GST_VIDEO_INFO_PLANE_OFFSET()">GST_VIDEO_INFO_PLANE_OFFSET</a> (i,
231
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PLANE-STRIDE:CAPS" title="GST_VIDEO_INFO_PLANE_STRIDE()">GST_VIDEO_INFO_PLANE_STRIDE</a> (i,
233
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-N-COMPONENTS:CAPS" title="GST_VIDEO_INFO_N_COMPONENTS()">GST_VIDEO_INFO_N_COMPONENTS</a> (i)
234
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-DEPTH:CAPS" title="GST_VIDEO_INFO_COMP_DEPTH()">GST_VIDEO_INFO_COMP_DEPTH</a> (i,
236
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-DATA:CAPS" title="GST_VIDEO_INFO_COMP_DATA()">GST_VIDEO_INFO_COMP_DATA</a> (i,
239
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-OFFSET:CAPS" title="GST_VIDEO_INFO_COMP_OFFSET()">GST_VIDEO_INFO_COMP_OFFSET</a> (i,
241
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-STRIDE:CAPS" title="GST_VIDEO_INFO_COMP_STRIDE()">GST_VIDEO_INFO_COMP_STRIDE</a> (i,
243
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-WIDTH:CAPS" title="GST_VIDEO_INFO_COMP_WIDTH()">GST_VIDEO_INFO_COMP_WIDTH</a> (i,
245
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-HEIGHT:CAPS" title="GST_VIDEO_INFO_COMP_HEIGHT()">GST_VIDEO_INFO_COMP_HEIGHT</a> (i,
247
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-PLANE:CAPS" title="GST_VIDEO_INFO_COMP_PLANE()">GST_VIDEO_INFO_COMP_PLANE</a> (i,
249
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-PSTRIDE:CAPS" title="GST_VIDEO_INFO_COMP_PSTRIDE()">GST_VIDEO_INFO_COMP_PSTRIDE</a> (i,
251
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-POFFSET:CAPS" title="GST_VIDEO_INFO_COMP_POFFSET()">GST_VIDEO_INFO_COMP_POFFSET</a> (i,
253
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-init" title="gst_video_info_init ()">gst_video_info_init</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>);
254
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-set-format" title="gst_video_info_set_format ()">gst_video_info_set_format</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
255
<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>,
256
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
257
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);
258
<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-info-from-caps" title="gst_video_info_from_caps ()">gst_video_info_from_caps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
259
<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>);
260
<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-info-to-caps" title="gst_video_info_to_caps ()">gst_video_info_to_caps</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>);
261
<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-info-convert" title="gst_video_info_convert ()">gst_video_info_convert</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
262
<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>,
263
<em class="parameter"><code><span class="type">gint64</span> src_value</code></em>,
264
<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>,
265
<em class="parameter"><code><span class="type">gint64</span> *dest_value</code></em>);
266
<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-info-is-equal" title="gst_video_info_is_equal ()">gst_video_info_is_equal</a> (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
267
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *other</code></em>);
268
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-align" title="gst_video_info_align ()">gst_video_info_align</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
269
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a> *align</code></em>);
272
struct <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame">GstVideoFrame</a>;
273
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrameFlags" title="enum GstVideoFrameFlags">GstVideoFrameFlags</a>;
274
<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-frame-map-id" title="gst_video_frame_map_id ()">gst_video_frame_map_id</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>,
275
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
276
<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> *buffer</code></em>,
277
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>,
278
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);
279
<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-frame-map" title="gst_video_frame_map ()">gst_video_frame_map</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>,
280
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
281
<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> *buffer</code></em>,
282
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);
283
<span class="returnvalue">void</span> <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-unmap" title="gst_video_frame_unmap ()">gst_video_frame_unmap</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>);
284
<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-frame-copy" title="gst_video_frame_copy ()">gst_video_frame_copy</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *dest</code></em>,
285
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *src</code></em>);
286
<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-frame-copy-plane" title="gst_video_frame_copy_plane ()">gst_video_frame_copy_plane</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *dest</code></em>,
287
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *src</code></em>,
288
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);
289
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-FORMAT:CAPS" title="GST_VIDEO_FRAME_FORMAT()">GST_VIDEO_FRAME_FORMAT</a> (f)
290
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-WIDTH:CAPS" title="GST_VIDEO_FRAME_WIDTH()">GST_VIDEO_FRAME_WIDTH</a> (f)
291
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-HEIGHT:CAPS" title="GST_VIDEO_FRAME_HEIGHT()">GST_VIDEO_FRAME_HEIGHT</a> (f)
292
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-SIZE:CAPS" title="GST_VIDEO_FRAME_SIZE()">GST_VIDEO_FRAME_SIZE</a> (f)
293
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-FLAGS:CAPS" title="GST_VIDEO_FRAME_FLAGS()">GST_VIDEO_FRAME_FLAGS</a> (f)
294
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-FLAG-IS-SET:CAPS" title="GST_VIDEO_FRAME_FLAG_IS_SET()">GST_VIDEO_FRAME_FLAG_IS_SET</a> (f,
296
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-INTERLACED:CAPS" title="GST_VIDEO_FRAME_IS_INTERLACED()">GST_VIDEO_FRAME_IS_INTERLACED</a> (f)
297
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-TFF:CAPS" title="GST_VIDEO_FRAME_IS_TFF()">GST_VIDEO_FRAME_IS_TFF</a> (f)
298
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-RFF:CAPS" title="GST_VIDEO_FRAME_IS_RFF()">GST_VIDEO_FRAME_IS_RFF</a> (f)
299
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-ONEFIELD:CAPS" title="GST_VIDEO_FRAME_IS_ONEFIELD()">GST_VIDEO_FRAME_IS_ONEFIELD</a> (f)
300
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-N-PLANES:CAPS" title="GST_VIDEO_FRAME_N_PLANES()">GST_VIDEO_FRAME_N_PLANES</a> (f)
301
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-PLANE-DATA:CAPS" title="GST_VIDEO_FRAME_PLANE_DATA()">GST_VIDEO_FRAME_PLANE_DATA</a> (f,
303
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-PLANE-OFFSET:CAPS" title="GST_VIDEO_FRAME_PLANE_OFFSET()">GST_VIDEO_FRAME_PLANE_OFFSET</a> (f,
305
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-PLANE-STRIDE:CAPS" title="GST_VIDEO_FRAME_PLANE_STRIDE()">GST_VIDEO_FRAME_PLANE_STRIDE</a> (f,
307
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-N-COMPONENTS:CAPS" title="GST_VIDEO_FRAME_N_COMPONENTS()">GST_VIDEO_FRAME_N_COMPONENTS</a> (f)
308
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-DEPTH:CAPS" title="GST_VIDEO_FRAME_COMP_DEPTH()">GST_VIDEO_FRAME_COMP_DEPTH</a> (f,
310
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-DATA:CAPS" title="GST_VIDEO_FRAME_COMP_DATA()">GST_VIDEO_FRAME_COMP_DATA</a> (f,
312
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-STRIDE:CAPS" title="GST_VIDEO_FRAME_COMP_STRIDE()">GST_VIDEO_FRAME_COMP_STRIDE</a> (f,
314
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-OFFSET:CAPS" title="GST_VIDEO_FRAME_COMP_OFFSET()">GST_VIDEO_FRAME_COMP_OFFSET</a> (f,
316
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-WIDTH:CAPS" title="GST_VIDEO_FRAME_COMP_WIDTH()">GST_VIDEO_FRAME_COMP_WIDTH</a> (f,
318
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-HEIGHT:CAPS" title="GST_VIDEO_FRAME_COMP_HEIGHT()">GST_VIDEO_FRAME_COMP_HEIGHT</a> (f,
320
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-PLANE:CAPS" title="GST_VIDEO_FRAME_COMP_PLANE()">GST_VIDEO_FRAME_COMP_PLANE</a> (f,
322
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-PSTRIDE:CAPS" title="GST_VIDEO_FRAME_COMP_PSTRIDE()">GST_VIDEO_FRAME_COMP_PSTRIDE</a> (f,
324
#define <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-POFFSET:CAPS" title="GST_VIDEO_FRAME_COMP_POFFSET()">GST_VIDEO_FRAME_COMP_POFFSET</a> (f,
326
enum <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoBufferFlags" title="enum GstVideoBufferFlags">GstVideoBufferFlags</a>;
35
<div class="refsect1">
36
<a name="gst-plugins-base-libs-gstvideo.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table width="100%" border="0">
39
<col width="150px" class="functions_return">
40
<col class="functions_name">
44
<td class="function_type">
45
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
47
<td class="function_name">
48
<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> <span class="c_punctuation">()</span>
52
<td class="function_type">
53
<span class="returnvalue">void</span>
55
<td class="function_name">
56
<span class="c_punctuation">(</span><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()">*GstVideoConvertSampleCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
60
<td class="function_type">
61
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> *
63
<td class="function_name">
64
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-convert-sample" title="gst_video_convert_sample ()">gst_video_convert_sample</a> <span class="c_punctuation">()</span>
68
<td class="function_type">
69
<span class="returnvalue">void</span>
71
<td class="function_name">
72
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-convert-sample-async" title="gst_video_convert_sample_async ()">gst_video_convert_sample_async</a> <span class="c_punctuation">()</span>
76
<td class="function_type">
77
<span class="returnvalue">void</span>
79
<td class="function_name">
80
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-alignment-reset" title="gst_video_alignment_reset ()">gst_video_alignment_reset</a> <span class="c_punctuation">()</span>
84
<td class="function_type">
85
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="returnvalue">GstEvent</span></a> *
87
<td class="function_name">
88
<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> <span class="c_punctuation">()</span>
92
<td class="function_type">
93
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
95
<td class="function_name">
96
<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> <span class="c_punctuation">()</span>
100
<td class="function_type">
101
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="returnvalue">GstEvent</span></a> *
103
<td class="function_name">
104
<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> <span class="c_punctuation">()</span>
108
<td class="function_type">
109
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
111
<td class="function_name">
112
<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> <span class="c_punctuation">()</span>
116
<td class="function_type">
117
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstEvent.html#GstEvent"><span class="returnvalue">GstEvent</span></a> *
119
<td class="function_name">
120
<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> <span class="c_punctuation">()</span>
124
<td class="function_type">
125
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
127
<td class="function_name">
128
<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> <span class="c_punctuation">()</span>
132
<td class="function_type">
133
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
135
<td class="function_name">
136
<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> <span class="c_punctuation">()</span>
140
<td class="function_type">
141
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="returnvalue">GstVideoChromaSite</span></a>
143
<td class="function_name">
144
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-chroma-from-string" title="gst_video_chroma_from_string ()">gst_video_chroma_from_string</a> <span class="c_punctuation">()</span>
148
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
150
<td class="function_name">
151
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-chroma-to-string" title="gst_video_chroma_to_string ()">gst_video_chroma_to_string</a> <span class="c_punctuation">()</span>
155
<td class="function_type">
156
<span class="returnvalue">void</span>
158
<td class="function_name">
159
<span class="c_punctuation">(</span><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatUnpack" title="GstVideoFormatUnpack ()">*GstVideoFormatUnpack</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
163
<td class="function_type">
164
<span class="returnvalue">void</span>
166
<td class="function_name">
167
<span class="c_punctuation">(</span><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatPack" title="GstVideoFormatPack ()">*GstVideoFormatPack</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
171
<td class="define_keyword">#define</td>
172
<td class="function_name">
173
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-FORMAT:CAPS" title="GST_VIDEO_FORMAT_INFO_FORMAT()">GST_VIDEO_FORMAT_INFO_FORMAT</a><span class="c_punctuation">()</span>
177
<td class="define_keyword">#define</td>
178
<td class="function_name">
179
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-NAME:CAPS" title="GST_VIDEO_FORMAT_INFO_NAME()">GST_VIDEO_FORMAT_INFO_NAME</a><span class="c_punctuation">()</span>
183
<td class="define_keyword">#define</td>
184
<td class="function_name">
185
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-FLAGS:CAPS" title="GST_VIDEO_FORMAT_INFO_FLAGS()">GST_VIDEO_FORMAT_INFO_FLAGS</a><span class="c_punctuation">()</span>
189
<td class="define_keyword">#define</td>
190
<td class="function_name">
191
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-YUV:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_YUV()">GST_VIDEO_FORMAT_INFO_IS_YUV</a><span class="c_punctuation">()</span>
195
<td class="define_keyword">#define</td>
196
<td class="function_name">
197
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-RGB:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_RGB()">GST_VIDEO_FORMAT_INFO_IS_RGB</a><span class="c_punctuation">()</span>
201
<td class="define_keyword">#define</td>
202
<td class="function_name">
203
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-GRAY:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_GRAY()">GST_VIDEO_FORMAT_INFO_IS_GRAY</a><span class="c_punctuation">()</span>
207
<td class="define_keyword">#define</td>
208
<td class="function_name">
209
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-HAS-ALPHA:CAPS" title="GST_VIDEO_FORMAT_INFO_HAS_ALPHA()">GST_VIDEO_FORMAT_INFO_HAS_ALPHA</a><span class="c_punctuation">()</span>
213
<td class="define_keyword">#define</td>
214
<td class="function_name">
215
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-LE:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_LE()">GST_VIDEO_FORMAT_INFO_IS_LE</a><span class="c_punctuation">()</span>
219
<td class="define_keyword">#define</td>
220
<td class="function_name">
221
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-HAS-PALETTE:CAPS" title="GST_VIDEO_FORMAT_INFO_HAS_PALETTE()">GST_VIDEO_FORMAT_INFO_HAS_PALETTE</a><span class="c_punctuation">()</span>
225
<td class="define_keyword">#define</td>
226
<td class="function_name">
227
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-IS-COMPLEX:CAPS" title="GST_VIDEO_FORMAT_INFO_IS_COMPLEX()">GST_VIDEO_FORMAT_INFO_IS_COMPLEX</a><span class="c_punctuation">()</span>
231
<td class="define_keyword">#define</td>
232
<td class="function_name">
233
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-BITS:CAPS" title="GST_VIDEO_FORMAT_INFO_BITS()">GST_VIDEO_FORMAT_INFO_BITS</a><span class="c_punctuation">()</span>
237
<td class="define_keyword">#define</td>
238
<td class="function_name">
239
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-N-COMPONENTS:CAPS" title="GST_VIDEO_FORMAT_INFO_N_COMPONENTS()">GST_VIDEO_FORMAT_INFO_N_COMPONENTS</a><span class="c_punctuation">()</span>
243
<td class="define_keyword">#define</td>
244
<td class="function_name">
245
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-SHIFT:CAPS" title="GST_VIDEO_FORMAT_INFO_SHIFT()">GST_VIDEO_FORMAT_INFO_SHIFT</a><span class="c_punctuation">()</span>
249
<td class="define_keyword">#define</td>
250
<td class="function_name">
251
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-DEPTH:CAPS" title="GST_VIDEO_FORMAT_INFO_DEPTH()">GST_VIDEO_FORMAT_INFO_DEPTH</a><span class="c_punctuation">()</span>
255
<td class="define_keyword">#define</td>
256
<td class="function_name">
257
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-PSTRIDE:CAPS" title="GST_VIDEO_FORMAT_INFO_PSTRIDE()">GST_VIDEO_FORMAT_INFO_PSTRIDE</a><span class="c_punctuation">()</span>
261
<td class="define_keyword">#define</td>
262
<td class="function_name">
263
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-N-PLANES:CAPS" title="GST_VIDEO_FORMAT_INFO_N_PLANES()">GST_VIDEO_FORMAT_INFO_N_PLANES</a><span class="c_punctuation">()</span>
267
<td class="define_keyword">#define</td>
268
<td class="function_name">
269
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-PLANE:CAPS" title="GST_VIDEO_FORMAT_INFO_PLANE()">GST_VIDEO_FORMAT_INFO_PLANE</a><span class="c_punctuation">()</span>
273
<td class="define_keyword">#define</td>
274
<td class="function_name">
275
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-POFFSET:CAPS" title="GST_VIDEO_FORMAT_INFO_POFFSET()">GST_VIDEO_FORMAT_INFO_POFFSET</a><span class="c_punctuation">()</span>
279
<td class="define_keyword">#define</td>
280
<td class="function_name">
281
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-W-SUB:CAPS" title="GST_VIDEO_FORMAT_INFO_W_SUB()">GST_VIDEO_FORMAT_INFO_W_SUB</a><span class="c_punctuation">()</span>
285
<td class="define_keyword">#define</td>
286
<td class="function_name">
287
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-H-SUB:CAPS" title="GST_VIDEO_FORMAT_INFO_H_SUB()">GST_VIDEO_FORMAT_INFO_H_SUB</a><span class="c_punctuation">()</span>
291
<td class="define_keyword">#define</td>
292
<td class="function_name">
293
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-SUB-SCALE:CAPS" title="GST_VIDEO_SUB_SCALE()">GST_VIDEO_SUB_SCALE</a><span class="c_punctuation">()</span>
297
<td class="define_keyword">#define</td>
298
<td class="function_name">
299
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-SCALE-WIDTH:CAPS" title="GST_VIDEO_FORMAT_INFO_SCALE_WIDTH()">GST_VIDEO_FORMAT_INFO_SCALE_WIDTH</a><span class="c_punctuation">()</span>
303
<td class="define_keyword">#define</td>
304
<td class="function_name">
305
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-SCALE-HEIGHT:CAPS" title="GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT()">GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT</a><span class="c_punctuation">()</span>
309
<td class="define_keyword">#define</td>
310
<td class="function_name">
311
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-DATA:CAPS" title="GST_VIDEO_FORMAT_INFO_DATA()">GST_VIDEO_FORMAT_INFO_DATA</a><span class="c_punctuation">()</span>
315
<td class="define_keyword">#define</td>
316
<td class="function_name">
317
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-STRIDE:CAPS" title="GST_VIDEO_FORMAT_INFO_STRIDE()">GST_VIDEO_FORMAT_INFO_STRIDE</a><span class="c_punctuation">()</span>
321
<td class="define_keyword">#define</td>
322
<td class="function_name">
323
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-INFO-OFFSET:CAPS" title="GST_VIDEO_FORMAT_INFO_OFFSET()">GST_VIDEO_FORMAT_INFO_OFFSET</a><span class="c_punctuation">()</span>
327
<td class="function_type">
328
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
330
<td class="function_name">
331
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-from-masks" title="gst_video_format_from_masks ()">gst_video_format_from_masks</a> <span class="c_punctuation">()</span>
335
<td class="function_type">
336
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
338
<td class="function_name">
339
<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> <span class="c_punctuation">()</span>
343
<td class="function_type">
344
<span class="returnvalue">guint32</span>
346
<td class="function_name">
347
<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> <span class="c_punctuation">()</span>
351
<td class="function_type">
352
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
354
<td class="function_name">
355
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-from-string" title="gst_video_format_from_string ()">gst_video_format_from_string</a> <span class="c_punctuation">()</span>
359
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
361
<td class="function_name">
362
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-to-string" title="gst_video_format_to_string ()">gst_video_format_to_string</a> <span class="c_punctuation">()</span>
366
<td class="function_type">const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="returnvalue">GstVideoFormatInfo</span></a> *
368
<td class="function_name">
369
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-format-get-info" title="gst_video_format_get_info ()">gst_video_format_get_info</a> <span class="c_punctuation">()</span>
373
<td class="define_keyword">#define</td>
374
<td class="function_name">
375
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CAPS-MAKE:CAPS" title="GST_VIDEO_CAPS_MAKE()">GST_VIDEO_CAPS_MAKE</a><span class="c_punctuation">()</span>
379
<td class="function_type">
380
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
382
<td class="function_name">
383
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-colorimetry-matches" title="gst_video_colorimetry_matches ()">gst_video_colorimetry_matches</a> <span class="c_punctuation">()</span>
387
<td class="function_type">
388
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
390
<td class="function_name">
391
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-colorimetry-from-string" title="gst_video_colorimetry_from_string ()">gst_video_colorimetry_from_string</a> <span class="c_punctuation">()</span>
395
<td class="function_type">
396
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
398
<td class="function_name">
399
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-colorimetry-to-string" title="gst_video_colorimetry_to_string ()">gst_video_colorimetry_to_string</a> <span class="c_punctuation">()</span>
403
<td class="function_type">
404
<span class="returnvalue">void</span>
406
<td class="function_name">
407
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-color-range-offsets" title="gst_video_color_range_offsets ()">gst_video_color_range_offsets</a> <span class="c_punctuation">()</span>
411
<td class="define_keyword">#define</td>
412
<td class="function_name">
413
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FORMAT:CAPS" title="GST_VIDEO_INFO_FORMAT()">GST_VIDEO_INFO_FORMAT</a><span class="c_punctuation">()</span>
417
<td class="define_keyword">#define</td>
418
<td class="function_name">
419
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-NAME:CAPS" title="GST_VIDEO_INFO_NAME()">GST_VIDEO_INFO_NAME</a><span class="c_punctuation">()</span>
423
<td class="define_keyword">#define</td>
424
<td class="function_name">
425
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-YUV:CAPS" title="GST_VIDEO_INFO_IS_YUV()">GST_VIDEO_INFO_IS_YUV</a><span class="c_punctuation">()</span>
429
<td class="define_keyword">#define</td>
430
<td class="function_name">
431
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-RGB:CAPS" title="GST_VIDEO_INFO_IS_RGB()">GST_VIDEO_INFO_IS_RGB</a><span class="c_punctuation">()</span>
435
<td class="define_keyword">#define</td>
436
<td class="function_name">
437
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-GRAY:CAPS" title="GST_VIDEO_INFO_IS_GRAY()">GST_VIDEO_INFO_IS_GRAY</a><span class="c_punctuation">()</span>
441
<td class="define_keyword">#define</td>
442
<td class="function_name">
443
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-HAS-ALPHA:CAPS" title="GST_VIDEO_INFO_HAS_ALPHA()">GST_VIDEO_INFO_HAS_ALPHA</a><span class="c_punctuation">()</span>
447
<td class="define_keyword">#define</td>
448
<td class="function_name">
449
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-INTERLACE-MODE:CAPS" title="GST_VIDEO_INFO_INTERLACE_MODE()">GST_VIDEO_INFO_INTERLACE_MODE</a><span class="c_punctuation">()</span>
453
<td class="define_keyword">#define</td>
454
<td class="function_name">
455
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-IS-INTERLACED:CAPS" title="GST_VIDEO_INFO_IS_INTERLACED()">GST_VIDEO_INFO_IS_INTERLACED</a><span class="c_punctuation">()</span>
459
<td class="define_keyword">#define</td>
460
<td class="function_name">
461
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAGS:CAPS" title="GST_VIDEO_INFO_FLAGS()">GST_VIDEO_INFO_FLAGS</a><span class="c_punctuation">()</span>
465
<td class="define_keyword">#define</td>
466
<td class="function_name">
467
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-WIDTH:CAPS" title="GST_VIDEO_INFO_WIDTH()">GST_VIDEO_INFO_WIDTH</a><span class="c_punctuation">()</span>
471
<td class="define_keyword">#define</td>
472
<td class="function_name">
473
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-HEIGHT:CAPS" title="GST_VIDEO_INFO_HEIGHT()">GST_VIDEO_INFO_HEIGHT</a><span class="c_punctuation">()</span>
477
<td class="define_keyword">#define</td>
478
<td class="function_name">
479
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-SIZE:CAPS" title="GST_VIDEO_INFO_SIZE()">GST_VIDEO_INFO_SIZE</a><span class="c_punctuation">()</span>
483
<td class="define_keyword">#define</td>
484
<td class="function_name">
485
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-VIEWS:CAPS" title="GST_VIDEO_INFO_VIEWS()">GST_VIDEO_INFO_VIEWS</a><span class="c_punctuation">()</span>
489
<td class="define_keyword">#define</td>
490
<td class="function_name">
491
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PAR-N:CAPS" title="GST_VIDEO_INFO_PAR_N()">GST_VIDEO_INFO_PAR_N</a><span class="c_punctuation">()</span>
495
<td class="define_keyword">#define</td>
496
<td class="function_name">
497
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PAR-D:CAPS" title="GST_VIDEO_INFO_PAR_D()">GST_VIDEO_INFO_PAR_D</a><span class="c_punctuation">()</span>
501
<td class="define_keyword">#define</td>
502
<td class="function_name">
503
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FPS-N:CAPS" title="GST_VIDEO_INFO_FPS_N()">GST_VIDEO_INFO_FPS_N</a><span class="c_punctuation">()</span>
507
<td class="define_keyword">#define</td>
508
<td class="function_name">
509
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FPS-D:CAPS" title="GST_VIDEO_INFO_FPS_D()">GST_VIDEO_INFO_FPS_D</a><span class="c_punctuation">()</span>
513
<td class="define_keyword">#define</td>
514
<td class="function_name">
515
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAG-IS-SET:CAPS" title="GST_VIDEO_INFO_FLAG_IS_SET()">GST_VIDEO_INFO_FLAG_IS_SET</a><span class="c_punctuation">()</span>
519
<td class="define_keyword">#define</td>
520
<td class="function_name">
521
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAG-SET:CAPS" title="GST_VIDEO_INFO_FLAG_SET()">GST_VIDEO_INFO_FLAG_SET</a><span class="c_punctuation">()</span>
525
<td class="define_keyword">#define</td>
526
<td class="function_name">
527
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-FLAG-UNSET:CAPS" title="GST_VIDEO_INFO_FLAG_UNSET()">GST_VIDEO_INFO_FLAG_UNSET</a><span class="c_punctuation">()</span>
531
<td class="define_keyword">#define</td>
532
<td class="function_name">
533
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-N-PLANES:CAPS" title="GST_VIDEO_INFO_N_PLANES()">GST_VIDEO_INFO_N_PLANES</a><span class="c_punctuation">()</span>
537
<td class="define_keyword">#define</td>
538
<td class="function_name">
539
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PLANE-OFFSET:CAPS" title="GST_VIDEO_INFO_PLANE_OFFSET()">GST_VIDEO_INFO_PLANE_OFFSET</a><span class="c_punctuation">()</span>
543
<td class="define_keyword">#define</td>
544
<td class="function_name">
545
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-PLANE-STRIDE:CAPS" title="GST_VIDEO_INFO_PLANE_STRIDE()">GST_VIDEO_INFO_PLANE_STRIDE</a><span class="c_punctuation">()</span>
549
<td class="define_keyword">#define</td>
550
<td class="function_name">
551
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-N-COMPONENTS:CAPS" title="GST_VIDEO_INFO_N_COMPONENTS()">GST_VIDEO_INFO_N_COMPONENTS</a><span class="c_punctuation">()</span>
555
<td class="define_keyword">#define</td>
556
<td class="function_name">
557
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-DEPTH:CAPS" title="GST_VIDEO_INFO_COMP_DEPTH()">GST_VIDEO_INFO_COMP_DEPTH</a><span class="c_punctuation">()</span>
561
<td class="define_keyword">#define</td>
562
<td class="function_name">
563
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-DATA:CAPS" title="GST_VIDEO_INFO_COMP_DATA()">GST_VIDEO_INFO_COMP_DATA</a><span class="c_punctuation">()</span>
567
<td class="define_keyword">#define</td>
568
<td class="function_name">
569
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-OFFSET:CAPS" title="GST_VIDEO_INFO_COMP_OFFSET()">GST_VIDEO_INFO_COMP_OFFSET</a><span class="c_punctuation">()</span>
573
<td class="define_keyword">#define</td>
574
<td class="function_name">
575
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-STRIDE:CAPS" title="GST_VIDEO_INFO_COMP_STRIDE()">GST_VIDEO_INFO_COMP_STRIDE</a><span class="c_punctuation">()</span>
579
<td class="define_keyword">#define</td>
580
<td class="function_name">
581
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-WIDTH:CAPS" title="GST_VIDEO_INFO_COMP_WIDTH()">GST_VIDEO_INFO_COMP_WIDTH</a><span class="c_punctuation">()</span>
585
<td class="define_keyword">#define</td>
586
<td class="function_name">
587
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-HEIGHT:CAPS" title="GST_VIDEO_INFO_COMP_HEIGHT()">GST_VIDEO_INFO_COMP_HEIGHT</a><span class="c_punctuation">()</span>
591
<td class="define_keyword">#define</td>
592
<td class="function_name">
593
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-PLANE:CAPS" title="GST_VIDEO_INFO_COMP_PLANE()">GST_VIDEO_INFO_COMP_PLANE</a><span class="c_punctuation">()</span>
597
<td class="define_keyword">#define</td>
598
<td class="function_name">
599
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-PSTRIDE:CAPS" title="GST_VIDEO_INFO_COMP_PSTRIDE()">GST_VIDEO_INFO_COMP_PSTRIDE</a><span class="c_punctuation">()</span>
603
<td class="define_keyword">#define</td>
604
<td class="function_name">
605
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-INFO-COMP-POFFSET:CAPS" title="GST_VIDEO_INFO_COMP_POFFSET()">GST_VIDEO_INFO_COMP_POFFSET</a><span class="c_punctuation">()</span>
609
<td class="function_type">
610
<span class="returnvalue">void</span>
612
<td class="function_name">
613
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-init" title="gst_video_info_init ()">gst_video_info_init</a> <span class="c_punctuation">()</span>
617
<td class="function_type">
618
<span class="returnvalue">void</span>
620
<td class="function_name">
621
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-set-format" title="gst_video_info_set_format ()">gst_video_info_set_format</a> <span class="c_punctuation">()</span>
625
<td class="function_type">
626
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
628
<td class="function_name">
629
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-from-caps" title="gst_video_info_from_caps ()">gst_video_info_from_caps</a> <span class="c_punctuation">()</span>
633
<td class="function_type">
634
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="returnvalue">GstCaps</span></a> *
636
<td class="function_name">
637
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-to-caps" title="gst_video_info_to_caps ()">gst_video_info_to_caps</a> <span class="c_punctuation">()</span>
641
<td class="function_type">
642
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
644
<td class="function_name">
645
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-convert" title="gst_video_info_convert ()">gst_video_info_convert</a> <span class="c_punctuation">()</span>
649
<td class="function_type">
650
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
652
<td class="function_name">
653
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-is-equal" title="gst_video_info_is_equal ()">gst_video_info_is_equal</a> <span class="c_punctuation">()</span>
657
<td class="function_type">
658
<span class="returnvalue">void</span>
660
<td class="function_name">
661
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-align" title="gst_video_info_align ()">gst_video_info_align</a> <span class="c_punctuation">()</span>
665
<td class="function_type">
666
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
668
<td class="function_name">
669
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-map-id" title="gst_video_frame_map_id ()">gst_video_frame_map_id</a> <span class="c_punctuation">()</span>
673
<td class="function_type">
674
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
676
<td class="function_name">
677
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-map" title="gst_video_frame_map ()">gst_video_frame_map</a> <span class="c_punctuation">()</span>
681
<td class="function_type">
682
<span class="returnvalue">void</span>
684
<td class="function_name">
685
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-unmap" title="gst_video_frame_unmap ()">gst_video_frame_unmap</a> <span class="c_punctuation">()</span>
689
<td class="function_type">
690
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
692
<td class="function_name">
693
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-copy" title="gst_video_frame_copy ()">gst_video_frame_copy</a> <span class="c_punctuation">()</span>
697
<td class="function_type">
698
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
700
<td class="function_name">
701
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-copy-plane" title="gst_video_frame_copy_plane ()">gst_video_frame_copy_plane</a> <span class="c_punctuation">()</span>
705
<td class="define_keyword">#define</td>
706
<td class="function_name">
707
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-FORMAT:CAPS" title="GST_VIDEO_FRAME_FORMAT()">GST_VIDEO_FRAME_FORMAT</a><span class="c_punctuation">()</span>
711
<td class="define_keyword">#define</td>
712
<td class="function_name">
713
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-WIDTH:CAPS" title="GST_VIDEO_FRAME_WIDTH()">GST_VIDEO_FRAME_WIDTH</a><span class="c_punctuation">()</span>
717
<td class="define_keyword">#define</td>
718
<td class="function_name">
719
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-HEIGHT:CAPS" title="GST_VIDEO_FRAME_HEIGHT()">GST_VIDEO_FRAME_HEIGHT</a><span class="c_punctuation">()</span>
723
<td class="define_keyword">#define</td>
724
<td class="function_name">
725
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-SIZE:CAPS" title="GST_VIDEO_FRAME_SIZE()">GST_VIDEO_FRAME_SIZE</a><span class="c_punctuation">()</span>
729
<td class="define_keyword">#define</td>
730
<td class="function_name">
731
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-FLAGS:CAPS" title="GST_VIDEO_FRAME_FLAGS()">GST_VIDEO_FRAME_FLAGS</a><span class="c_punctuation">()</span>
735
<td class="define_keyword">#define</td>
736
<td class="function_name">
737
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-FLAG-IS-SET:CAPS" title="GST_VIDEO_FRAME_FLAG_IS_SET()">GST_VIDEO_FRAME_FLAG_IS_SET</a><span class="c_punctuation">()</span>
741
<td class="define_keyword">#define</td>
742
<td class="function_name">
743
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-INTERLACED:CAPS" title="GST_VIDEO_FRAME_IS_INTERLACED()">GST_VIDEO_FRAME_IS_INTERLACED</a><span class="c_punctuation">()</span>
747
<td class="define_keyword">#define</td>
748
<td class="function_name">
749
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-TFF:CAPS" title="GST_VIDEO_FRAME_IS_TFF()">GST_VIDEO_FRAME_IS_TFF</a><span class="c_punctuation">()</span>
753
<td class="define_keyword">#define</td>
754
<td class="function_name">
755
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-RFF:CAPS" title="GST_VIDEO_FRAME_IS_RFF()">GST_VIDEO_FRAME_IS_RFF</a><span class="c_punctuation">()</span>
759
<td class="define_keyword">#define</td>
760
<td class="function_name">
761
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-IS-ONEFIELD:CAPS" title="GST_VIDEO_FRAME_IS_ONEFIELD()">GST_VIDEO_FRAME_IS_ONEFIELD</a><span class="c_punctuation">()</span>
765
<td class="define_keyword">#define</td>
766
<td class="function_name">
767
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-N-PLANES:CAPS" title="GST_VIDEO_FRAME_N_PLANES()">GST_VIDEO_FRAME_N_PLANES</a><span class="c_punctuation">()</span>
771
<td class="define_keyword">#define</td>
772
<td class="function_name">
773
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-PLANE-DATA:CAPS" title="GST_VIDEO_FRAME_PLANE_DATA()">GST_VIDEO_FRAME_PLANE_DATA</a><span class="c_punctuation">()</span>
777
<td class="define_keyword">#define</td>
778
<td class="function_name">
779
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-PLANE-OFFSET:CAPS" title="GST_VIDEO_FRAME_PLANE_OFFSET()">GST_VIDEO_FRAME_PLANE_OFFSET</a><span class="c_punctuation">()</span>
783
<td class="define_keyword">#define</td>
784
<td class="function_name">
785
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-PLANE-STRIDE:CAPS" title="GST_VIDEO_FRAME_PLANE_STRIDE()">GST_VIDEO_FRAME_PLANE_STRIDE</a><span class="c_punctuation">()</span>
789
<td class="define_keyword">#define</td>
790
<td class="function_name">
791
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-N-COMPONENTS:CAPS" title="GST_VIDEO_FRAME_N_COMPONENTS()">GST_VIDEO_FRAME_N_COMPONENTS</a><span class="c_punctuation">()</span>
795
<td class="define_keyword">#define</td>
796
<td class="function_name">
797
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-DEPTH:CAPS" title="GST_VIDEO_FRAME_COMP_DEPTH()">GST_VIDEO_FRAME_COMP_DEPTH</a><span class="c_punctuation">()</span>
801
<td class="define_keyword">#define</td>
802
<td class="function_name">
803
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-DATA:CAPS" title="GST_VIDEO_FRAME_COMP_DATA()">GST_VIDEO_FRAME_COMP_DATA</a><span class="c_punctuation">()</span>
807
<td class="define_keyword">#define</td>
808
<td class="function_name">
809
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-STRIDE:CAPS" title="GST_VIDEO_FRAME_COMP_STRIDE()">GST_VIDEO_FRAME_COMP_STRIDE</a><span class="c_punctuation">()</span>
813
<td class="define_keyword">#define</td>
814
<td class="function_name">
815
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-OFFSET:CAPS" title="GST_VIDEO_FRAME_COMP_OFFSET()">GST_VIDEO_FRAME_COMP_OFFSET</a><span class="c_punctuation">()</span>
819
<td class="define_keyword">#define</td>
820
<td class="function_name">
821
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-WIDTH:CAPS" title="GST_VIDEO_FRAME_COMP_WIDTH()">GST_VIDEO_FRAME_COMP_WIDTH</a><span class="c_punctuation">()</span>
825
<td class="define_keyword">#define</td>
826
<td class="function_name">
827
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-HEIGHT:CAPS" title="GST_VIDEO_FRAME_COMP_HEIGHT()">GST_VIDEO_FRAME_COMP_HEIGHT</a><span class="c_punctuation">()</span>
831
<td class="define_keyword">#define</td>
832
<td class="function_name">
833
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-PLANE:CAPS" title="GST_VIDEO_FRAME_COMP_PLANE()">GST_VIDEO_FRAME_COMP_PLANE</a><span class="c_punctuation">()</span>
837
<td class="define_keyword">#define</td>
838
<td class="function_name">
839
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-PSTRIDE:CAPS" title="GST_VIDEO_FRAME_COMP_PSTRIDE()">GST_VIDEO_FRAME_COMP_PSTRIDE</a><span class="c_punctuation">()</span>
843
<td class="define_keyword">#define</td>
844
<td class="function_name">
845
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FRAME-COMP-POFFSET:CAPS" title="GST_VIDEO_FRAME_COMP_POFFSET()">GST_VIDEO_FRAME_COMP_POFFSET</a><span class="c_punctuation">()</span>
851
<div class="refsect1">
852
<a name="gst-plugins-base-libs-gstvideo.other"></a><h2>Types and Values</h2>
853
<div class="informaltable"><table width="100%" border="0">
855
<col width="150px" class="name">
856
<col class="description">
860
<td class="datatype_keyword">struct</td>
861
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment">GstVideoAlignment</a></td>
864
<td class="define_keyword">#define</td>
865
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-STR:CAPS" title="GST_META_TAG_VIDEO_STR">GST_META_TAG_VIDEO_STR</a></td>
868
<td class="define_keyword">#define</td>
869
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-ORIENTATION-STR:CAPS" title="GST_META_TAG_VIDEO_ORIENTATION_STR">GST_META_TAG_VIDEO_ORIENTATION_STR</a></td>
872
<td class="define_keyword">#define</td>
873
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-SIZE-STR:CAPS" title="GST_META_TAG_VIDEO_SIZE_STR">GST_META_TAG_VIDEO_SIZE_STR</a></td>
876
<td class="define_keyword">#define</td>
877
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-META-TAG-VIDEO-COLORSPACE-STR:CAPS" title="GST_META_TAG_VIDEO_COLORSPACE_STR">GST_META_TAG_VIDEO_COLORSPACE_STR</a></td>
880
<td class="datatype_keyword">enum</td>
881
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat">GstVideoFormat</a></td>
884
<td class="define_keyword">#define</td>
885
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-MAX-PLANES:CAPS" title="GST_VIDEO_MAX_PLANES">GST_VIDEO_MAX_PLANES</a></td>
888
<td class="define_keyword">#define</td>
889
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-MAX-COMPONENTS:CAPS" title="GST_VIDEO_MAX_COMPONENTS">GST_VIDEO_MAX_COMPONENTS</a></td>
892
<td class="datatype_keyword">struct</td>
893
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo">GstVideoFormatInfo</a></td>
896
<td class="datatype_keyword">enum</td>
897
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite">GstVideoChromaSite</a></td>
900
<td class="datatype_keyword">enum</td>
901
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatFlags" title="enum GstVideoFormatFlags">GstVideoFormatFlags</a></td>
904
<td class="datatype_keyword">enum</td>
905
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags">GstVideoPackFlags</a></td>
908
<td class="define_keyword">#define</td>
909
<td class="function_name"><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></td>
912
<td class="define_keyword">#define</td>
913
<td class="function_name"><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></td>
916
<td class="define_keyword">#define</td>
917
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMATS-ALL:CAPS" title="GST_VIDEO_FORMATS_ALL">GST_VIDEO_FORMATS_ALL</a></td>
920
<td class="datatype_keyword">enum</td>
921
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange">GstVideoColorRange</a></td>
924
<td class="datatype_keyword">enum</td>
925
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorMatrix" title="enum GstVideoColorMatrix">GstVideoColorMatrix</a></td>
928
<td class="datatype_keyword">enum</td>
929
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoTransferFunction" title="enum GstVideoTransferFunction">GstVideoTransferFunction</a></td>
932
<td class="datatype_keyword">enum</td>
933
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorPrimaries" title="enum GstVideoColorPrimaries">GstVideoColorPrimaries</a></td>
936
<td class="datatype_keyword"> </td>
937
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry">GstVideoColorimetry</a></td>
940
<td class="datatype_keyword">struct</td>
941
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo">GstVideoInfo</a></td>
944
<td class="datatype_keyword">enum</td>
945
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInterlaceMode" title="enum GstVideoInterlaceMode">GstVideoInterlaceMode</a></td>
948
<td class="datatype_keyword">enum</td>
949
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFlags" title="enum GstVideoFlags">GstVideoFlags</a></td>
952
<td class="datatype_keyword">struct</td>
953
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame">GstVideoFrame</a></td>
956
<td class="datatype_keyword">enum</td>
957
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrameFlags" title="enum GstVideoFrameFlags">GstVideoFrameFlags</a></td>
960
<td class="datatype_keyword">enum</td>
961
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoBufferFlags" title="enum GstVideoBufferFlags">GstVideoBufferFlags</a></td>
966
<div class="refsect1">
967
<a name="gst-plugins-base-libs-gstvideo.object-hierarchy"></a><h2>Object Hierarchy</h2>
971
<div class="refsect1">
972
<a name="gst-plugins-base-libs-gstvideo.includes"></a><h2>Includes</h2>
973
<pre class="synopsis">#include <gst/video/video.h>
329
976
<div class="refsect1">
330
977
<a name="gst-plugins-base-libs-gstvideo.description"></a><h2>Description</h2>
333
978
<div class="refsect2">
334
<a name="id-1.2.14.3.4.2.1"></a><p>
979
<a name="id-1.2.14.3.7.2"></a><p>
335
980
This library contains some helper functions and includes the
336
981
videosink and videofilter base classes.
342
985
<div class="refsect1">
343
<a name="gst-plugins-base-libs-gstvideo.details"></a><h2>Details</h2>
986
<a name="gst-plugins-base-libs-gstvideo.functions_details"></a><h2>Functions</h2>
344
987
<div class="refsect2">
345
<a name="gst-video-calculate-display-ratio"></a><h3>gst_video_calculate_display_ratio ()</h3>
346
<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>,
347
<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>,
348
<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>,
349
<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>,
350
<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>,
351
<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>,
352
<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>,
353
<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>
355
Given the Pixel Aspect Ratio and size of an input video frame, and the
988
<a name="gst-video-calculate-display-ratio"></a><h3>gst_video_calculate_display_ratio ()</h3>
989
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
990
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>,
991
<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>,
992
<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>,
993
<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>,
994
<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>,
995
<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>,
996
<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>,
997
<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>
998
<p>Given the Pixel Aspect Ratio and size of an input video frame, and the
356
999
pixel aspect ratio of the intended display device, calculates the actual
357
display ratio the video will be rendered with.
359
<div class="variablelist"><table border="0" class="variablelist">
1000
display ratio the video will be rendered with.</p>
1001
<div class="refsect3">
1002
<a name="id-1.2.14.3.8.2.5"></a><h4>Parameters</h4>
1003
<div class="informaltable"><table width="100%" border="0">
361
<col align="left" valign="top">
1005
<col width="150px" class="parameters_name">
1006
<col class="parameters_description">
1007
<col width="200px" class="parameters_annotations">
366
<td><p><span class="term"><em class="parameter"><code>dar_n</code></em> :</span></p></td>
367
<td>Numerator of the calculated display_ratio</td>
370
<td><p><span class="term"><em class="parameter"><code>dar_d</code></em> :</span></p></td>
371
<td>Denominator of the calculated display_ratio</td>
374
<td><p><span class="term"><em class="parameter"><code>video_width</code></em> :</span></p></td>
375
<td>Width of the video frame in pixels</td>
378
<td><p><span class="term"><em class="parameter"><code>video_height</code></em> :</span></p></td>
379
<td>Height of the video frame in pixels</td>
382
<td><p><span class="term"><em class="parameter"><code>video_par_n</code></em> :</span></p></td>
383
<td>Numerator of the pixel aspect ratio of the input video.</td>
386
<td><p><span class="term"><em class="parameter"><code>video_par_d</code></em> :</span></p></td>
387
<td>Denominator of the pixel aspect ratio of the input video.</td>
390
<td><p><span class="term"><em class="parameter"><code>display_par_n</code></em> :</span></p></td>
391
<td>Numerator of the pixel aspect ratio of the display device</td>
394
<td><p><span class="term"><em class="parameter"><code>display_par_d</code></em> :</span></p></td>
395
<td>Denominator of the pixel aspect ratio of the display device</td>
398
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
399
<td>A boolean indicating success and a calculated Display Ratio in the
1011
<td class="parameter_name"><p>dar_n</p></td>
1012
<td class="parameter_description"><p>Numerator of the calculated display_ratio</p></td>
1013
<td class="parameter_annotations"> </td>
1016
<td class="parameter_name"><p>dar_d</p></td>
1017
<td class="parameter_description"><p>Denominator of the calculated display_ratio</p></td>
1018
<td class="parameter_annotations"> </td>
1021
<td class="parameter_name"><p>video_width</p></td>
1022
<td class="parameter_description"><p>Width of the video frame in pixels</p></td>
1023
<td class="parameter_annotations"> </td>
1026
<td class="parameter_name"><p>video_height</p></td>
1027
<td class="parameter_description"><p>Height of the video frame in pixels</p></td>
1028
<td class="parameter_annotations"> </td>
1031
<td class="parameter_name"><p>video_par_n</p></td>
1032
<td class="parameter_description"><p>Numerator of the pixel aspect ratio of the input video.</p></td>
1033
<td class="parameter_annotations"> </td>
1036
<td class="parameter_name"><p>video_par_d</p></td>
1037
<td class="parameter_description"><p>Denominator of the pixel aspect ratio of the input video.</p></td>
1038
<td class="parameter_annotations"> </td>
1041
<td class="parameter_name"><p>display_par_n</p></td>
1042
<td class="parameter_description"><p>Numerator of the pixel aspect ratio of the display device</p></td>
1043
<td class="parameter_annotations"> </td>
1046
<td class="parameter_name"><p>display_par_d</p></td>
1047
<td class="parameter_description"><p>Denominator of the pixel aspect ratio of the display device</p></td>
1048
<td class="parameter_annotations"> </td>
1053
<div class="refsect3">
1054
<a name="id-1.2.14.3.8.2.6"></a><h4>Returns</h4>
1055
<p> A boolean indicating success and a calculated Display Ratio in the
400
1056
dar_n and dar_d parameters.
401
The return value is FALSE in the case of integer overflow or other error.</td>
407
<div class="refsect2">
408
<a name="GstVideoConvertSampleCallback"></a><h3>GstVideoConvertSampleCallback ()</h3>
409
<pre class="programlisting"><span class="returnvalue">void</span> (*GstVideoConvertSampleCallback) (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
410
<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>,
411
<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>
414
<div class="refsect2">
415
<a name="gst-video-convert-sample"></a><h3>gst_video_convert_sample ()</h3>
416
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> * gst_video_convert_sample (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
417
<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>,
418
<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>,
419
<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>
421
Converts a raw video buffer into the specified output caps.
424
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
427
The width, height and pixel-aspect-ratio can also be specified in the output caps.
429
<div class="variablelist"><table border="0" class="variablelist">
1057
The return value is FALSE in the case of integer overflow or other error.</p>
1062
<div class="refsect2">
1063
<a name="GstVideoConvertSampleCallback"></a><h3>GstVideoConvertSampleCallback ()</h3>
1064
<pre class="programlisting"><span class="returnvalue">void</span>
1065
<span class="c_punctuation">(</span>*GstVideoConvertSampleCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
1066
<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>,
1067
<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>
1070
<div class="refsect2">
1071
<a name="gst-video-convert-sample"></a><h3>gst_video_convert_sample ()</h3>
1072
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="returnvalue">GstSample</span></a> *
1073
gst_video_convert_sample (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
1074
<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>,
1075
<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>,
1076
<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>
1077
<p>Converts a raw video buffer into the specified output caps.</p>
1078
<p>The output caps can be any raw video formats or any image formats (jpeg, png, ...).</p>
1079
<p>The width, height and pixel-aspect-ratio can also be specified in the output caps.</p>
1080
<div class="refsect3">
1081
<a name="id-1.2.14.3.8.4.7"></a><h4>Parameters</h4>
1082
<div class="informaltable"><table width="100%" border="0">
431
<col align="left" valign="top">
1084
<col width="150px" class="parameters_name">
1085
<col class="parameters_description">
1086
<col width="200px" class="parameters_annotations">
436
<td><p><span class="term"><em class="parameter"><code>sample</code></em> :</span></p></td>
437
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a>
441
<td><p><span class="term"><em class="parameter"><code>to_caps</code></em> :</span></p></td>
442
<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>
445
<td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
446
<td>the maximum amount of time allowed for the processing.</td>
449
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
450
<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>
453
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
454
<td>The converted <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</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>
455
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>
1090
<td class="parameter_name"><p>sample</p></td>
1091
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a></p></td>
1092
<td class="parameter_annotations"> </td>
1095
<td class="parameter_name"><p>to_caps</p></td>
1096
<td class="parameter_description"><p>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</p></td>
1097
<td class="parameter_annotations"> </td>
1100
<td class="parameter_name"><p>timeout</p></td>
1101
<td class="parameter_description"><p>the maximum amount of time allowed for the processing.</p></td>
1102
<td class="parameter_annotations"> </td>
1105
<td class="parameter_name"><p>error</p></td>
1106
<td class="parameter_description"><p>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>.</p></td>
1107
<td class="parameter_annotations"> </td>
1112
<div class="refsect3">
1113
<a name="id-1.2.14.3.8.4.8"></a><h4>Returns</h4>
1114
<p> The converted <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</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>
1115
will point to the <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>).</p>
461
1120
<div class="refsect2">
462
<a name="gst-video-convert-sample-async"></a><h3>gst_video_convert_sample_async ()</h3>
463
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_convert_sample_async (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
464
<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>,
465
<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>,
466
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()"><span class="type">GstVideoConvertSampleCallback</span></a> callback</code></em>,
467
<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>,
468
<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>
470
Converts a raw video buffer into the specified output caps.
473
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
476
The width, height and pixel-aspect-ratio can also be specified in the output caps.
479
<em class="parameter"><code>callback</code></em> will be called after conversion, when an error occured or if conversion didn't
480
finish after <em class="parameter"><code>timeout</code></em>. <em class="parameter"><code>callback</code></em> will always be called from the thread default
1121
<a name="gst-video-convert-sample-async"></a><h3>gst_video_convert_sample_async ()</h3>
1122
<pre class="programlisting"><span class="returnvalue">void</span>
1123
gst_video_convert_sample_async (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a> *sample</code></em>,
1124
<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>,
1125
<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>,
1126
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()"><span class="type">GstVideoConvertSampleCallback</span></a> callback</code></em>,
1127
<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>,
1128
<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>
1129
<p>Converts a raw video buffer into the specified output caps.</p>
1130
<p>The output caps can be any raw video formats or any image formats (jpeg, png, ...).</p>
1131
<p>The width, height and pixel-aspect-ratio can also be specified in the output caps.</p>
1132
<p><em class="parameter"><code>callback</code></em>
1133
will be called after conversion, when an error occured or if conversion didn't
1134
finish after <em class="parameter"><code>timeout</code></em>
1135
. <em class="parameter"><code>callback</code></em>
1136
will always be called from the thread default
481
1137
<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,
482
this will always be the global default main context.
485
<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
488
<div class="variablelist"><table border="0" class="variablelist">
490
<col align="left" valign="top">
495
<td><p><span class="term"><em class="parameter"><code>sample</code></em> :</span></p></td>
496
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a>
500
<td><p><span class="term"><em class="parameter"><code>to_caps</code></em> :</span></p></td>
501
<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>
504
<td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
505
<td>the maximum amount of time allowed for the processing.</td>
508
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
510
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()"><code class="literal">GstVideoConvertSampleCallback</code></a> that will be called after conversion.</td>
513
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
514
<td>extra data that will be passed to the <em class="parameter"><code>callback</code></em>
518
<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>
520
<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>
526
<div class="refsect2">
527
<a name="GstVideoAlignment"></a><h3>struct GstVideoAlignment</h3>
528
<pre class="programlisting">struct GstVideoAlignment {
530
guint padding_bottom;
533
guint stride_align[GST_VIDEO_MAX_PLANES];
537
Extra alignment paramters for the memory of video buffers. This
538
structure is usually used to configure the bufferpool if it supports the
539
<span class="type">GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT</span>.
541
<div class="variablelist"><table border="0" class="variablelist">
543
<col align="left" valign="top">
548
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-top"></a>padding_top</code></em>;</span></p></td>
549
<td>extra pixels on the top</td>
552
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-bottom"></a>padding_bottom</code></em>;</span></p></td>
553
<td>extra pixels on the bottom</td>
556
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-left"></a>padding_left</code></em>;</span></p></td>
557
<td>extra pixels on the left side</td>
560
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-right"></a>padding_right</code></em>;</span></p></td>
561
<td>extra pixels on the right side</td>
564
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.stride-align"></a>stride_align</code></em>[GST_VIDEO_MAX_PLANES];</span></p></td>
565
<td>array with extra alignment requirements for the strides</td>
571
<div class="refsect2">
572
<a name="gst-video-alignment-reset"></a><h3>gst_video_alignment_reset ()</h3>
573
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_alignment_reset (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a> *align</code></em>);</pre>
575
Set <em class="parameter"><code>align</code></em> to its default values with no padding and no alignment.
577
<div class="variablelist"><table border="0" class="variablelist">
579
<col align="left" valign="top">
1138
this will always be the global default main context.</p>
1139
<p><em class="parameter"><code>destroy_notify</code></em>
1140
will be called after the callback was called and <em class="parameter"><code>user_data</code></em>
1143
<div class="refsect3">
1144
<a name="id-1.2.14.3.8.5.9"></a><h4>Parameters</h4>
1145
<div class="informaltable"><table width="100%" border="0">
1147
<col width="150px" class="parameters_name">
1148
<col class="parameters_description">
1149
<col width="200px" class="parameters_annotations">
1153
<td class="parameter_name"><p>sample</p></td>
1154
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstSample.html#GstSample"><span class="type">GstSample</span></a></p></td>
1155
<td class="parameter_annotations"> </td>
1158
<td class="parameter_name"><p>to_caps</p></td>
1159
<td class="parameter_description"><p>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</p></td>
1160
<td class="parameter_annotations"> </td>
1163
<td class="parameter_name"><p>timeout</p></td>
1164
<td class="parameter_description"><p>the maximum amount of time allowed for the processing.</p></td>
1165
<td class="parameter_annotations"> </td>
1168
<td class="parameter_name"><p>callback</p></td>
1169
<td class="parameter_description"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoConvertSampleCallback" title="GstVideoConvertSampleCallback ()"><code class="literal">GstVideoConvertSampleCallback</code></a> that will be called after conversion.</p></td>
1170
<td class="parameter_annotations"> </td>
1173
<td class="parameter_name"><p>user_data</p></td>
1174
<td class="parameter_description"><p>extra data that will be passed to the <em class="parameter"><code>callback</code></em>
1176
<td class="parameter_annotations"> </td>
1179
<td class="parameter_name"><p>destroy_notify</p></td>
1180
<td class="parameter_description"><p><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>
1181
is not needed anymore</p></td>
1182
<td class="parameter_annotations"> </td>
1189
<div class="refsect2">
1190
<a name="gst-video-alignment-reset"></a><h3>gst_video_alignment_reset ()</h3>
1191
<pre class="programlisting"><span class="returnvalue">void</span>
1192
gst_video_alignment_reset (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a> *align</code></em>);</pre>
1193
<p>Set <em class="parameter"><code>align</code></em>
1194
to its default values with no padding and no alignment.</p>
1195
<div class="refsect3">
1196
<a name="id-1.2.14.3.8.6.5"></a><h4>Parameters</h4>
1197
<div class="informaltable"><table width="100%" border="0">
1199
<col width="150px" class="parameters_name">
1200
<col class="parameters_description">
1201
<col width="200px" class="parameters_annotations">
583
<td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
584
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a>
1204
<td class="parameter_name"><p>align</p></td>
1205
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a></p></td>
1206
<td class="parameter_annotations"> </td>
590
<div class="refsect2">
591
<a name="GST-META-TAG-VIDEO-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_STR</h3>
592
<pre class="programlisting">#define GST_META_TAG_VIDEO_STR "video"
595
This metadata is relevant for video streams.
597
<p class="since">Since 1.2</p>
600
<div class="refsect2">
601
<a name="GST-META-TAG-VIDEO-ORIENTATION-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_ORIENTATION_STR</h3>
602
<pre class="programlisting">#define GST_META_TAG_VIDEO_ORIENTATION_STR "orientation"
605
This metadata stays relevant as long as video orientation is unchanged.
607
<p class="since">Since 1.2</p>
610
<div class="refsect2">
611
<a name="GST-META-TAG-VIDEO-SIZE-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_SIZE_STR</h3>
612
<pre class="programlisting">#define GST_META_TAG_VIDEO_SIZE_STR "size"
615
This metadata stays relevant as long as video size is unchanged.
617
<p class="since">Since 1.2</p>
620
<div class="refsect2">
621
<a name="GST-META-TAG-VIDEO-COLORSPACE-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_COLORSPACE_STR</h3>
622
<pre class="programlisting">#define GST_META_TAG_VIDEO_COLORSPACE_STR "colorspace"
625
This metadata stays relevant as long as video colorspace is unchanged.
627
<p class="since">Since 1.2</p>
630
<div class="refsect2">
631
<a name="gst-video-event-new-still-frame"></a><h3>gst_video_event_new_still_frame ()</h3>
632
<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>
634
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
1212
<div class="refsect2">
1213
<a name="gst-video-event-new-still-frame"></a><h3>gst_video_event_new_still_frame ()</h3>
1214
<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> *
1215
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>
1216
<p>Creates a new Still Frame event. If <em class="parameter"><code>in_still</code></em>
1217
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
635
1218
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
636
the event ends a still frame sequence.
639
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
640
<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>.
642
<div class="variablelist"><table border="0" class="variablelist">
1219
the event ends a still frame sequence.</p>
1220
<p>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
1221
<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>.</p>
1222
<div class="refsect3">
1223
<a name="id-1.2.14.3.8.7.6"></a><h4>Parameters</h4>
1224
<div class="informaltable"><table width="100%" border="0">
644
<col align="left" valign="top">
1226
<col width="150px" class="parameters_name">
1227
<col class="parameters_description">
1228
<col width="200px" class="parameters_annotations">
649
<td><p><span class="term"><em class="parameter"><code>in_still</code></em> :</span></p></td>
650
<td>boolean value for the still-frame state of the event.</td>
653
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
654
<td>The new GstEvent</td>
1231
<td class="parameter_name"><p>in_still</p></td>
1232
<td class="parameter_description"><p>boolean value for the still-frame state of the event.</p></td>
1233
<td class="parameter_annotations"> </td>
1237
<div class="refsect3">
1238
<a name="id-1.2.14.3.8.7.7"></a><h4>Returns</h4>
1239
<p> The new GstEvent</p>
660
1244
<div class="refsect2">
661
<a name="gst-video-event-parse-still-frame"></a><h3>gst_video_event_parse_still_frame ()</h3>
662
<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>,
663
<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>
665
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
1245
<a name="gst-video-event-parse-still-frame"></a><h3>gst_video_event_parse_still_frame ()</h3>
1246
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1247
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>,
1248
<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>
1249
<p>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
666
1250
return the still-frame state from the event if it is.
667
1251
If the event represents the start of a still frame, the in_still
668
1252
variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the
669
1253
in_still variable order to just check whether the event is a valid still-frame
673
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>
675
<div class="variablelist"><table border="0" class="variablelist">
1255
<p>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></p>
1256
<div class="refsect3">
1257
<a name="id-1.2.14.3.8.8.6"></a><h4>Parameters</h4>
1258
<div class="informaltable"><table width="100%" border="0">
677
<col align="left" valign="top">
1260
<col width="150px" class="parameters_name">
1261
<col class="parameters_description">
1262
<col width="200px" class="parameters_annotations">
682
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
683
<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>
686
<td><p><span class="term"><em class="parameter"><code>in_still</code></em> :</span></p></td>
687
<td>A boolean to receive the still-frame status from the event, or NULL</td>
690
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
692
<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>
1266
<td class="parameter_name"><p>event</p></td>
1267
<td class="parameter_description"><p>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</p></td>
1268
<td class="parameter_annotations"> </td>
1271
<td class="parameter_name"><p>in_still</p></td>
1272
<td class="parameter_description"><p>A boolean to receive the still-frame status from the event, or NULL</p></td>
1273
<td class="parameter_annotations"> </td>
1278
<div class="refsect3">
1279
<a name="id-1.2.14.3.8.8.7"></a><h4>Returns</h4>
1280
<p> <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</p>
698
1285
<div class="refsect2">
699
<a name="gst-video-event-new-downstream-force-key-unit"></a><h3>gst_video_event_new_downstream_force_key_unit ()</h3>
700
<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
701
(<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>,
702
<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> stream_time</code></em>,
703
<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>,
704
<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>,
705
<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>
707
Creates a new downstream force key unit event. A downstream force key unit
1286
<a name="gst-video-event-new-downstream-force-key-unit"></a><h3>gst_video_event_new_downstream_force_key_unit ()</h3>
1287
<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> *
1288
gst_video_event_new_downstream_force_key_unit
1289
(<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>,
1290
<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> stream_time</code></em>,
1291
<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>,
1292
<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>,
1293
<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>
1294
<p>Creates a new downstream force key unit event. A downstream force key unit
708
1295
event can be sent down the pipeline to request downstream elements to produce
709
1296
a key unit. A downstream force key unit event must also be sent when handling
710
1297
an upstream force key unit event to notify downstream that the latter has been
714
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
715
<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>.
717
<div class="variablelist"><table border="0" class="variablelist">
719
<col align="left" valign="top">
724
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
725
<td>the timestamp of the buffer that starts a new key unit</td>
728
<td><p><span class="term"><em class="parameter"><code>stream_time</code></em> :</span></p></td>
729
<td>the stream_time of the buffer that starts a new key unit</td>
732
<td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
733
<td>the running_time of the buffer that starts a new key unit</td>
736
<td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
738
<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>
741
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
742
<td>integer that can be used to number key units</td>
745
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
746
<td>The new GstEvent</td>
752
<div class="refsect2">
753
<a name="gst-video-event-parse-downstream-force-key-unit"></a><h3>gst_video_event_parse_downstream_force_key_unit ()</h3>
754
<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
755
(<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>,
756
<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>,
757
<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> *stream_time</code></em>,
758
<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>,
759
<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>,
760
<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>
762
Get timestamp, stream-time, running-time, all-headers and count in the force
763
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
764
full description of the downstream force key unit event.
766
<div class="variablelist"><table border="0" class="variablelist">
768
<col align="left" valign="top">
773
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
774
<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>
777
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
778
<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>
782
<td><p><span class="term"><em class="parameter"><code>stream_time</code></em> :</span></p></td>
783
<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>
787
<td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
788
<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>
792
<td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
793
<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>
797
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
798
<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>
802
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
804
<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>
810
<div class="refsect2">
811
<a name="gst-video-event-new-upstream-force-key-unit"></a><h3>gst_video_event_new_upstream_force_key_unit ()</h3>
812
<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
813
(<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>,
814
<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>,
815
<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>
817
Creates a new upstream force key unit event. An upstream force key unit event
818
can be sent to request upstream elements to produce a key unit.
821
<em class="parameter"><code>running_time</code></em> can be set to request a new key unit at a specific
1299
<p>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
1300
<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>.</p>
1301
<div class="refsect3">
1302
<a name="id-1.2.14.3.8.9.6"></a><h4>Parameters</h4>
1303
<div class="informaltable"><table width="100%" border="0">
1305
<col width="150px" class="parameters_name">
1306
<col class="parameters_description">
1307
<col width="200px" class="parameters_annotations">
1311
<td class="parameter_name"><p>timestamp</p></td>
1312
<td class="parameter_description"><p>the timestamp of the buffer that starts a new key unit</p></td>
1313
<td class="parameter_annotations"> </td>
1316
<td class="parameter_name"><p>stream_time</p></td>
1317
<td class="parameter_description"><p>the stream_time of the buffer that starts a new key unit</p></td>
1318
<td class="parameter_annotations"> </td>
1321
<td class="parameter_name"><p>running_time</p></td>
1322
<td class="parameter_description"><p>the running_time of the buffer that starts a new key unit</p></td>
1323
<td class="parameter_annotations"> </td>
1326
<td class="parameter_name"><p>all_headers</p></td>
1327
<td class="parameter_description"><p><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</p></td>
1328
<td class="parameter_annotations"> </td>
1331
<td class="parameter_name"><p>count</p></td>
1332
<td class="parameter_description"><p>integer that can be used to number key units</p></td>
1333
<td class="parameter_annotations"> </td>
1338
<div class="refsect3">
1339
<a name="id-1.2.14.3.8.9.7"></a><h4>Returns</h4>
1340
<p> The new GstEvent</p>
1345
<div class="refsect2">
1346
<a name="gst-video-event-parse-downstream-force-key-unit"></a><h3>gst_video_event_parse_downstream_force_key_unit ()</h3>
1347
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1348
gst_video_event_parse_downstream_force_key_unit
1349
(<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>,
1350
<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>,
1351
<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> *stream_time</code></em>,
1352
<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>,
1353
<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>,
1354
<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>
1355
<p>Get timestamp, stream-time, running-time, all-headers and count in the force
1356
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
1357
full description of the downstream force key unit event.</p>
1358
<div class="refsect3">
1359
<a name="id-1.2.14.3.8.10.5"></a><h4>Parameters</h4>
1360
<div class="informaltable"><table width="100%" border="0">
1362
<col width="150px" class="parameters_name">
1363
<col class="parameters_description">
1364
<col width="200px" class="parameters_annotations">
1368
<td class="parameter_name"><p>event</p></td>
1369
<td class="parameter_description"><p>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</p></td>
1370
<td class="parameter_annotations"> </td>
1373
<td class="parameter_name"><p>timestamp</p></td>
1374
<td class="parameter_description"><p> A pointer to the timestamp in the event. </p></td>
1375
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1378
<td class="parameter_name"><p>stream_time</p></td>
1379
<td class="parameter_description"><p> A pointer to the stream-time in the event. </p></td>
1380
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1383
<td class="parameter_name"><p>running_time</p></td>
1384
<td class="parameter_description"><p> A pointer to the running-time in the event. </p></td>
1385
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1388
<td class="parameter_name"><p>all_headers</p></td>
1389
<td class="parameter_description"><p> A pointer to the all_headers flag in the event. </p></td>
1390
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1393
<td class="parameter_name"><p>count</p></td>
1394
<td class="parameter_description"><p> A pointer to the count field of the event. </p></td>
1395
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1400
<div class="refsect3">
1401
<a name="id-1.2.14.3.8.10.6"></a><h4>Returns</h4>
1402
<p> <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.</p>
1407
<div class="refsect2">
1408
<a name="gst-video-event-new-upstream-force-key-unit"></a><h3>gst_video_event_new_upstream_force_key_unit ()</h3>
1409
<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> *
1410
gst_video_event_new_upstream_force_key_unit
1411
(<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>,
1412
<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>,
1413
<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>
1414
<p>Creates a new upstream force key unit event. An upstream force key unit event
1415
can be sent to request upstream elements to produce a key unit. </p>
1416
<p><em class="parameter"><code>running_time</code></em>
1417
can be set to request a new key unit at a specific
822
1418
running_time. If set to GST_CLOCK_TIME_NONE, upstream elements will produce a
823
new key unit as soon as possible.
826
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
827
<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>.
829
<div class="variablelist"><table border="0" class="variablelist">
831
<col align="left" valign="top">
836
<td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
837
<td>the running_time at which a new key unit should be produced</td>
840
<td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
842
<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>
845
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
846
<td>integer that can be used to number key units</td>
849
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
850
<td>The new GstEvent</td>
856
<div class="refsect2">
857
<a name="gst-video-event-parse-upstream-force-key-unit"></a><h3>gst_video_event_parse_upstream_force_key_unit ()</h3>
858
<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
859
(<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>,
860
<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>,
861
<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>,
862
<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>
864
Get running-time, all-headers and count in the force key unit event. See
865
<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
866
upstream force key unit event.
869
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>
871
<div class="variablelist"><table border="0" class="variablelist">
873
<col align="left" valign="top">
878
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
879
<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>
882
<td><p><span class="term"><em class="parameter"><code>running_time</code></em> :</span></p></td>
883
<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>
887
<td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
888
<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>
892
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
893
<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>
897
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
899
<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>
905
<div class="refsect2">
906
<a name="gst-video-event-is-force-key-unit"></a><h3>gst_video_event_is_force_key_unit ()</h3>
907
<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>
909
Checks if an event is a force key unit event. Returns true for both upstream
910
and downstream force key unit events.
912
<div class="variablelist"><table border="0" class="variablelist">
914
<col align="left" valign="top">
919
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
920
<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>
923
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
925
<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>
931
<div class="refsect2">
932
<a name="GstVideoFormat"></a><h3>enum GstVideoFormat</h3>
933
<pre class="programlisting">typedef enum {
934
GST_VIDEO_FORMAT_UNKNOWN,
935
GST_VIDEO_FORMAT_ENCODED,
936
GST_VIDEO_FORMAT_I420,
937
GST_VIDEO_FORMAT_YV12,
938
GST_VIDEO_FORMAT_YUY2,
939
GST_VIDEO_FORMAT_UYVY,
940
GST_VIDEO_FORMAT_AYUV,
941
GST_VIDEO_FORMAT_RGBx,
942
GST_VIDEO_FORMAT_BGRx,
943
GST_VIDEO_FORMAT_xRGB,
944
GST_VIDEO_FORMAT_xBGR,
945
GST_VIDEO_FORMAT_RGBA,
946
GST_VIDEO_FORMAT_BGRA,
947
GST_VIDEO_FORMAT_ARGB,
948
GST_VIDEO_FORMAT_ABGR,
949
GST_VIDEO_FORMAT_RGB,
950
GST_VIDEO_FORMAT_BGR,
951
GST_VIDEO_FORMAT_Y41B,
952
GST_VIDEO_FORMAT_Y42B,
953
GST_VIDEO_FORMAT_YVYU,
954
GST_VIDEO_FORMAT_Y444,
955
GST_VIDEO_FORMAT_v210,
956
GST_VIDEO_FORMAT_v216,
957
GST_VIDEO_FORMAT_NV12,
958
GST_VIDEO_FORMAT_NV21,
959
GST_VIDEO_FORMAT_GRAY8,
960
GST_VIDEO_FORMAT_GRAY16_BE,
961
GST_VIDEO_FORMAT_GRAY16_LE,
962
GST_VIDEO_FORMAT_v308,
963
GST_VIDEO_FORMAT_RGB16,
964
GST_VIDEO_FORMAT_BGR16,
965
GST_VIDEO_FORMAT_RGB15,
966
GST_VIDEO_FORMAT_BGR15,
967
GST_VIDEO_FORMAT_UYVP,
968
GST_VIDEO_FORMAT_A420,
969
GST_VIDEO_FORMAT_RGB8P,
970
GST_VIDEO_FORMAT_YUV9,
971
GST_VIDEO_FORMAT_YVU9,
972
GST_VIDEO_FORMAT_IYU1,
973
GST_VIDEO_FORMAT_ARGB64,
974
GST_VIDEO_FORMAT_AYUV64,
975
GST_VIDEO_FORMAT_r210,
976
GST_VIDEO_FORMAT_I420_10BE,
977
GST_VIDEO_FORMAT_I420_10LE,
978
GST_VIDEO_FORMAT_I422_10BE,
979
GST_VIDEO_FORMAT_I422_10LE,
980
GST_VIDEO_FORMAT_Y444_10BE,
981
GST_VIDEO_FORMAT_Y444_10LE,
982
GST_VIDEO_FORMAT_GBR,
983
GST_VIDEO_FORMAT_GBR_10BE,
984
GST_VIDEO_FORMAT_GBR_10LE,
985
GST_VIDEO_FORMAT_NV16,
986
GST_VIDEO_FORMAT_NV24,
990
Enum value describing the most common video formats.
992
<div class="variablelist"><table border="0" class="variablelist">
994
<col align="left" valign="top">
999
<td><p><a name="GST-VIDEO-FORMAT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UNKNOWN</code></span></p></td>
1000
<td>Unknown or unset video format id
1004
<td><p><a name="GST-VIDEO-FORMAT-ENCODED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ENCODED</code></span></p></td>
1005
<td>Encoded video format
1009
<td><p><a name="GST-VIDEO-FORMAT-I420:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I420</code></span></p></td>
1010
<td>planar 4:2:0 YUV
1014
<td><p><a name="GST-VIDEO-FORMAT-YV12:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YV12</code></span></p></td>
1015
<td>planar 4:2:0 YVU (like I420 but UV planes swapped)
1019
<td><p><a name="GST-VIDEO-FORMAT-YUY2:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YUY2</code></span></p></td>
1020
<td>packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)
1024
<td><p><a name="GST-VIDEO-FORMAT-UYVY:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UYVY</code></span></p></td>
1025
<td>packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)
1029
<td><p><a name="GST-VIDEO-FORMAT-AYUV:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_AYUV</code></span></p></td>
1030
<td>packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)
1034
<td><p><a name="GST-VIDEO-FORMAT-RGBx"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGBx</code></span></p></td>
1035
<td>sparse rgb packed into 32 bit, space last
1039
<td><p><a name="GST-VIDEO-FORMAT-BGRx"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGRx</code></span></p></td>
1040
<td>sparse reverse rgb packed into 32 bit, space last
1044
<td><p><a name="GST-VIDEO-FORMAT-xRGB"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_xRGB</code></span></p></td>
1045
<td>sparse rgb packed into 32 bit, space first
1049
<td><p><a name="GST-VIDEO-FORMAT-xBGR"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_xBGR</code></span></p></td>
1050
<td>sparse reverse rgb packed into 32 bit, space first
1054
<td><p><a name="GST-VIDEO-FORMAT-RGBA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGBA</code></span></p></td>
1055
<td>rgb with alpha channel last
1059
<td><p><a name="GST-VIDEO-FORMAT-BGRA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGRA</code></span></p></td>
1060
<td>reverse rgb with alpha channel last
1064
<td><p><a name="GST-VIDEO-FORMAT-ARGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ARGB</code></span></p></td>
1065
<td>rgb with alpha channel first
1069
<td><p><a name="GST-VIDEO-FORMAT-ABGR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ABGR</code></span></p></td>
1070
<td>reverse rgb with alpha channel first
1074
<td><p><a name="GST-VIDEO-FORMAT-RGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB</code></span></p></td>
1079
<td><p><a name="GST-VIDEO-FORMAT-BGR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR</code></span></p></td>
1084
<td><p><a name="GST-VIDEO-FORMAT-Y41B:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y41B</code></span></p></td>
1085
<td>planar 4:1:1 YUV
1089
<td><p><a name="GST-VIDEO-FORMAT-Y42B:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y42B</code></span></p></td>
1090
<td>planar 4:2:2 YUV
1094
<td><p><a name="GST-VIDEO-FORMAT-YVYU:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YVYU</code></span></p></td>
1095
<td>packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)
1099
<td><p><a name="GST-VIDEO-FORMAT-Y444:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y444</code></span></p></td>
1100
<td>planar 4:4:4 YUV
1104
<td><p><a name="GST-VIDEO-FORMAT-v210"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v210</code></span></p></td>
1105
<td>packed 4:2:2 10-bit YUV, complex format
1109
<td><p><a name="GST-VIDEO-FORMAT-v216"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v216</code></span></p></td>
1110
<td>packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order
1114
<td><p><a name="GST-VIDEO-FORMAT-NV12:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV12</code></span></p></td>
1115
<td>planar 4:2:0 YUV with interleaved UV plane
1119
<td><p><a name="GST-VIDEO-FORMAT-NV21:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV21</code></span></p></td>
1120
<td>planar 4:2:0 YUV with interleaved VU plane
1124
<td><p><a name="GST-VIDEO-FORMAT-GRAY8:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GRAY8</code></span></p></td>
1129
<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>
1130
<td>16-bit grayscale, most significant byte first
1134
<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>
1135
<td>16-bit grayscale, least significant byte first
1139
<td><p><a name="GST-VIDEO-FORMAT-v308"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_v308</code></span></p></td>
1140
<td>packed 4:4:4 YUV
1144
<td><p><a name="GST-VIDEO-FORMAT-RGB16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB16</code></span></p></td>
1145
<td>rgb 5-6-5 bits per component
1149
<td><p><a name="GST-VIDEO-FORMAT-BGR16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR16</code></span></p></td>
1150
<td>reverse rgb 5-6-5 bits per component
1154
<td><p><a name="GST-VIDEO-FORMAT-RGB15:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB15</code></span></p></td>
1155
<td>rgb 5-5-5 bits per component
1159
<td><p><a name="GST-VIDEO-FORMAT-BGR15:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_BGR15</code></span></p></td>
1160
<td>reverse rgb 5-5-5 bits per component
1164
<td><p><a name="GST-VIDEO-FORMAT-UYVP:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_UYVP</code></span></p></td>
1165
<td>packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)
1169
<td><p><a name="GST-VIDEO-FORMAT-A420:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_A420</code></span></p></td>
1170
<td>planar 4:4:2:0 AYUV
1174
<td><p><a name="GST-VIDEO-FORMAT-RGB8P:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_RGB8P</code></span></p></td>
1175
<td>8-bit paletted RGB
1179
<td><p><a name="GST-VIDEO-FORMAT-YUV9:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YUV9</code></span></p></td>
1180
<td>planar 4:1:0 YUV
1184
<td><p><a name="GST-VIDEO-FORMAT-YVU9:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_YVU9</code></span></p></td>
1185
<td>planar 4:1:0 YUV (like YUV9 but UV planes swapped)
1189
<td><p><a name="GST-VIDEO-FORMAT-IYU1:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_IYU1</code></span></p></td>
1190
<td>packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)
1194
<td><p><a name="GST-VIDEO-FORMAT-ARGB64:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_ARGB64</code></span></p></td>
1195
<td>rgb with alpha channel first, 16 bits per channel
1199
<td><p><a name="GST-VIDEO-FORMAT-AYUV64:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_AYUV64</code></span></p></td>
1200
<td>packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)
1204
<td><p><a name="GST-VIDEO-FORMAT-r210"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_r210</code></span></p></td>
1205
<td>packed 4:4:4 RGB, 10 bits per channel
1209
<td><p><a name="GST-VIDEO-FORMAT-I420-10BE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I420_10BE</code></span></p></td>
1210
<td>planar 4:2:0 YUV, 10 bits per channel
1214
<td><p><a name="GST-VIDEO-FORMAT-I420-10LE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I420_10LE</code></span></p></td>
1215
<td>planar 4:2:0 YUV, 10 bits per channel
1219
<td><p><a name="GST-VIDEO-FORMAT-I422-10BE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I422_10BE</code></span></p></td>
1220
<td>planar 4:2:2 YUV, 10 bits per channel
1224
<td><p><a name="GST-VIDEO-FORMAT-I422-10LE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_I422_10LE</code></span></p></td>
1225
<td>planar 4:2:2 YUV, 10 bits per channel
1229
<td><p><a name="GST-VIDEO-FORMAT-Y444-10BE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y444_10BE</code></span></p></td>
1230
<td>planar 4:4:4 YUV, 10 bits per channel
1234
<td><p><a name="GST-VIDEO-FORMAT-Y444-10LE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_Y444_10LE</code></span></p></td>
1235
<td>planar 4:4:4 YUV, 10 bits per channel
1239
<td><p><a name="GST-VIDEO-FORMAT-GBR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GBR</code></span></p></td>
1240
<td>planar 4:4:4 RGB, 8 bits per channel
1244
<td><p><a name="GST-VIDEO-FORMAT-GBR-10BE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GBR_10BE</code></span></p></td>
1245
<td>planar 4:4:4 RGB, 10 bits per channel
1249
<td><p><a name="GST-VIDEO-FORMAT-GBR-10LE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_GBR_10LE</code></span></p></td>
1250
<td>planar 4:4:4 RGB, 10 bits per channel
1254
<td><p><a name="GST-VIDEO-FORMAT-NV16:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV16</code></span></p></td>
1255
<td>planar 4:2:2 YUV with interleaved UV plane
1259
<td><p><a name="GST-VIDEO-FORMAT-NV24:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_NV24</code></span></p></td>
1260
<td>planar 4:4:4 YUV with interleaved UV plane
1267
<div class="refsect2">
1268
<a name="GST-VIDEO-MAX-PLANES:CAPS"></a><h3>GST_VIDEO_MAX_PLANES</h3>
1269
<pre class="programlisting">#define GST_VIDEO_MAX_PLANES 4
1273
<div class="refsect2">
1274
<a name="GST-VIDEO-MAX-COMPONENTS:CAPS"></a><h3>GST_VIDEO_MAX_COMPONENTS</h3>
1275
<pre class="programlisting">#define GST_VIDEO_MAX_COMPONENTS 4
1279
<div class="refsect2">
1280
<a name="GstVideoFormatInfo"></a><h3>struct GstVideoFormatInfo</h3>
1281
<pre class="programlisting">struct GstVideoFormatInfo {
1282
GstVideoFormat format;
1284
const gchar *description;
1285
GstVideoFormatFlags flags;
1288
guint shift[GST_VIDEO_MAX_COMPONENTS];
1289
guint depth[GST_VIDEO_MAX_COMPONENTS];
1290
gint pixel_stride[GST_VIDEO_MAX_COMPONENTS];
1292
guint plane[GST_VIDEO_MAX_COMPONENTS];
1293
guint poffset[GST_VIDEO_MAX_COMPONENTS];
1294
guint w_sub[GST_VIDEO_MAX_COMPONENTS];
1295
guint h_sub[GST_VIDEO_MAX_COMPONENTS];
1297
GstVideoFormat unpack_format;
1298
GstVideoFormatUnpack unpack_func;
1300
GstVideoFormatPack pack_func;
1302
gpointer _gst_reserved[GST_PADDING];
1306
Information for a video format.
1308
<div class="variablelist"><table border="0" class="variablelist">
1310
<col align="left" valign="top">
1315
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.format"></a>format</code></em>;</span></p></td>
1316
<td><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a></td>
1319
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstVideoFormatInfo.name"></a>name</code></em>;</span></p></td>
1320
<td>string representation of the format</td>
1323
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstVideoFormatInfo.description"></a>description</code></em>;</span></p></td>
1324
<td>use readable description of the format</td>
1327
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatFlags" title="enum GstVideoFormatFlags"><span class="type">GstVideoFormatFlags</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.flags"></a>flags</code></em>;</span></p></td>
1328
<td><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatFlags" title="enum GstVideoFormatFlags"><span class="type">GstVideoFormatFlags</span></a></td>
1331
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.bits"></a>bits</code></em>;</span></p></td>
1332
<td>The number of bits used to pack data items. This can be less than 8
1333
when multiple pixels are stored in a byte. for values > 8 multiple bytes
1334
should be read according to the endianness flag before applying the shift
1338
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.n-components"></a>n_components</code></em>;</span></p></td>
1339
<td>the number of components in the video format.</td>
1342
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.shift"></a>shift</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1343
<td>the number of bits to shift away to get the component data</td>
1346
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.depth"></a>depth</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1347
<td>the depth in bits for each component</td>
1350
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.pixel-stride"></a>pixel_stride</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1351
<td>the pixel stride of each component. This is the amount of
1352
bytes to the pixel immediately to the right. When bits < 8, the stride is
1353
expressed in bits. For 24-bit RGB, this would be 3 bytes, for example,
1354
while it would be 4 bytes for RGBx or ARGB.</td>
1357
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.n-planes"></a>n_planes</code></em>;</span></p></td>
1358
<td>the number of planes for this format. The number of planes can be
1359
less than the amount of components when multiple components are packed into
1363
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.plane"></a>plane</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1364
<td>the plane number where a component can be found</td>
1367
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.poffset"></a>poffset</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1368
<td>the offset in the plane where the first pixel of the components
1372
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.w-sub"></a>w_sub</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1373
<td>subsampling factor of the width for the component. Use
1374
GST_VIDEO_SUB_SCALE to scale a width.</td>
1377
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.h-sub"></a>h_sub</code></em>[GST_VIDEO_MAX_COMPONENTS];</span></p></td>
1378
<td>subsampling factor of the height for the component. Use
1379
GST_VIDEO_SUB_SCALE to scale a height.</td>
1382
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.unpack-format"></a>unpack_format</code></em>;</span></p></td>
1383
<td>the format of the unpacked pixels. This format must have the
1384
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-FLAG-UNPACK:CAPS"><span class="type">GST_VIDEO_FORMAT_FLAG_UNPACK</span></a> flag set.</td>
1387
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatUnpack" title="GstVideoFormatUnpack ()"><span class="type">GstVideoFormatUnpack</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.unpack-func"></a>unpack_func</code></em>;</span></p></td>
1388
<td>an unpack function for this format</td>
1391
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.pack-lines"></a>pack_lines</code></em>;</span></p></td>
1392
<td>the amount of lines that will be packed</td>
1395
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatPack" title="GstVideoFormatPack ()"><span class="type">GstVideoFormatPack</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.pack-func"></a>pack_func</code></em>;</span></p></td>
1396
<td>an pack function for this format</td>
1399
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.-gst-reserved"></a>_gst_reserved</code></em>[GST_PADDING];</span></p></td>
1406
<div class="refsect2">
1407
<a name="GstVideoChromaSite"></a><h3>enum GstVideoChromaSite</h3>
1408
<pre class="programlisting">typedef enum {
1409
GST_VIDEO_CHROMA_SITE_UNKNOWN = 0,
1410
GST_VIDEO_CHROMA_SITE_NONE = (1 << 0),
1411
GST_VIDEO_CHROMA_SITE_H_COSITED = (1 << 1),
1412
GST_VIDEO_CHROMA_SITE_V_COSITED = (1 << 2),
1413
GST_VIDEO_CHROMA_SITE_ALT_LINE = (1 << 3),
1414
/* some common chroma cositing */
1415
GST_VIDEO_CHROMA_SITE_COSITED = (GST_VIDEO_CHROMA_SITE_H_COSITED | GST_VIDEO_CHROMA_SITE_V_COSITED),
1416
GST_VIDEO_CHROMA_SITE_JPEG = (GST_VIDEO_CHROMA_SITE_NONE),
1417
GST_VIDEO_CHROMA_SITE_MPEG2 = (GST_VIDEO_CHROMA_SITE_H_COSITED),
1418
GST_VIDEO_CHROMA_SITE_DV = (GST_VIDEO_CHROMA_SITE_COSITED | GST_VIDEO_CHROMA_SITE_ALT_LINE),
1419
} GstVideoChromaSite;
1422
Various Chroma sitings.
1424
<div class="variablelist"><table border="0" class="variablelist">
1426
<col align="left" valign="top">
1431
<td><p><a name="GST-VIDEO-CHROMA-SITE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_UNKNOWN</code></span></p></td>
1432
<td>unknown cositing
1436
<td><p><a name="GST-VIDEO-CHROMA-SITE-NONE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_NONE</code></span></p></td>
1441
<td><p><a name="GST-VIDEO-CHROMA-SITE-H-COSITED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_H_COSITED</code></span></p></td>
1442
<td>chroma is horizontally cosited
1446
<td><p><a name="GST-VIDEO-CHROMA-SITE-V-COSITED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_V_COSITED</code></span></p></td>
1447
<td>chroma is vertically cosited
1451
<td><p><a name="GST-VIDEO-CHROMA-SITE-ALT-LINE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_ALT_LINE</code></span></p></td>
1452
<td>choma samples are sited on alternate lines
1456
<td><p><a name="GST-VIDEO-CHROMA-SITE-COSITED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_COSITED</code></span></p></td>
1457
<td>chroma samples cosited with luma samples
1461
<td><p><a name="GST-VIDEO-CHROMA-SITE-JPEG:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_JPEG</code></span></p></td>
1462
<td>jpeg style cositing, also for mpeg1 and mjpeg
1466
<td><p><a name="GST-VIDEO-CHROMA-SITE-MPEG2:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_MPEG2</code></span></p></td>
1467
<td>mpeg2 style cositing
1471
<td><p><a name="GST-VIDEO-CHROMA-SITE-DV:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_CHROMA_SITE_DV</code></span></p></td>
1472
<td>DV style cositing
1479
<div class="refsect2">
1480
<a name="gst-video-chroma-from-string"></a><h3>gst_video_chroma_from_string ()</h3>
1481
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="returnvalue">GstVideoChromaSite</span></a> gst_video_chroma_from_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s</code></em>);</pre>
1483
Convert <em class="parameter"><code>s</code></em> to a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a>
1485
<div class="variablelist"><table border="0" class="variablelist">
1487
<col align="left" valign="top">
1492
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
1493
<td>a chromasite string</td>
1496
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1497
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> or <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CHROMA-SITE-UNKNOWN:CAPS"><code class="literal">GST_VIDEO_CHROMA_SITE_UNKNOWN</code></a> when <em class="parameter"><code>s</code></em> does
1498
not contain a valid chroma description.</td>
1504
<div class="refsect2">
1505
<a name="gst-video-chroma-to-string"></a><h3>gst_video_chroma_to_string ()</h3>
1506
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_video_chroma_to_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> site</code></em>);</pre>
1508
Converts <em class="parameter"><code>site</code></em> to its string representation.
1510
<div class="variablelist"><table border="0" class="variablelist">
1512
<col align="left" valign="top">
1517
<td><p><span class="term"><em class="parameter"><code>site</code></em> :</span></p></td>
1518
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a>
1522
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1523
<td>a string describing <em class="parameter"><code>site</code></em>.</td>
1529
<div class="refsect2">
1530
<a name="GstVideoFormatFlags"></a><h3>enum GstVideoFormatFlags</h3>
1531
<pre class="programlisting">typedef enum {
1532
GST_VIDEO_FORMAT_FLAG_YUV = (1 << 0),
1533
GST_VIDEO_FORMAT_FLAG_RGB = (1 << 1),
1534
GST_VIDEO_FORMAT_FLAG_GRAY = (1 << 2),
1535
GST_VIDEO_FORMAT_FLAG_ALPHA = (1 << 3),
1536
GST_VIDEO_FORMAT_FLAG_LE = (1 << 4),
1537
GST_VIDEO_FORMAT_FLAG_PALETTE = (1 << 5),
1538
GST_VIDEO_FORMAT_FLAG_COMPLEX = (1 << 6),
1539
GST_VIDEO_FORMAT_FLAG_UNPACK = (1 << 7)
1540
} GstVideoFormatFlags;
1543
The different video flags that a format info can have.
1545
<div class="variablelist"><table border="0" class="variablelist">
1547
<col align="left" valign="top">
1552
<td><p><a name="GST-VIDEO-FORMAT-FLAG-YUV:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_YUV</code></span></p></td>
1553
<td>The video format is YUV, components are numbered
1558
<td><p><a name="GST-VIDEO-FORMAT-FLAG-RGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_RGB</code></span></p></td>
1559
<td>The video format is RGB, components are numbered
1564
<td><p><a name="GST-VIDEO-FORMAT-FLAG-GRAY:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_GRAY</code></span></p></td>
1565
<td>The video is gray, there is one gray component
1570
<td><p><a name="GST-VIDEO-FORMAT-FLAG-ALPHA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_ALPHA</code></span></p></td>
1571
<td>The video format has an alpha components with
1576
<td><p><a name="GST-VIDEO-FORMAT-FLAG-LE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_LE</code></span></p></td>
1577
<td>The video format has data stored in little
1582
<td><p><a name="GST-VIDEO-FORMAT-FLAG-PALETTE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_PALETTE</code></span></p></td>
1583
<td>The video format has a palette. The palette
1584
is stored in the second plane and indexes are stored in the first plane.
1588
<td><p><a name="GST-VIDEO-FORMAT-FLAG-COMPLEX:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_COMPLEX</code></span></p></td>
1589
<td>The video format has a complex layout that
1590
can't be described with the usual information in the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a>.
1594
<td><p><a name="GST-VIDEO-FORMAT-FLAG-UNPACK:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FORMAT_FLAG_UNPACK</code></span></p></td>
1595
<td>This format can be used in a
1596
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatUnpack" title="GstVideoFormatUnpack ()"><span class="type">GstVideoFormatUnpack</span></a> and <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatPack" title="GstVideoFormatPack ()"><span class="type">GstVideoFormatPack</span></a> function.
1603
<div class="refsect2">
1604
<a name="GstVideoPackFlags"></a><h3>enum GstVideoPackFlags</h3>
1605
<pre class="programlisting">typedef enum {
1606
GST_VIDEO_PACK_FLAG_NONE = 0,
1607
GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE = (1 << 0),
1608
GST_VIDEO_PACK_FLAG_INTERLACED = (1 << 1)
1609
} GstVideoPackFlags;
1612
The different flags that can be used when packing and unpacking.
1614
<div class="variablelist"><table border="0" class="variablelist">
1616
<col align="left" valign="top">
1621
<td><p><a name="GST-VIDEO-PACK-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_PACK_FLAG_NONE</code></span></p></td>
1626
<td><p><a name="GST-VIDEO-PACK-FLAG-TRUNCATE-RANGE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE</code></span></p></td>
1627
<td>When the source has a smaller depth
1628
than the target format, set the least significant bits of the target
1629
to 0. This is likely sightly faster but less accurate. When this flag
1630
is not specified, the most significant bits of the source are duplicated
1631
in the least significant bits of the destination.
1635
<td><p><a name="GST-VIDEO-PACK-FLAG-INTERLACED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_PACK_FLAG_INTERLACED</code></span></p></td>
1636
<td>The source is interlaced. The unpacked
1637
format will be interlaced as well with each line containing
1638
information from alternating fields. (Since 1.2)
1645
<div class="refsect2">
1646
<a name="GstVideoFormatUnpack"></a><h3>GstVideoFormatUnpack ()</h3>
1647
<pre class="programlisting"><span class="returnvalue">void</span> (*GstVideoFormatUnpack) (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
1648
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags"><span class="type">GstVideoPackFlags</span></a> flags</code></em>,
1649
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> dest</code></em>,
1650
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data[GST_VIDEO_MAX_PLANES]</code></em>,
1651
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride[GST_VIDEO_MAX_PLANES]</code></em>,
1652
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
1653
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
1654
<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>);</pre>
1656
Unpacks <em class="parameter"><code>width</code></em> pixels from the given planes and strides containing data of
1657
format <em class="parameter"><code>info</code></em>. The pixels will be unpacked into <em class="parameter"><code>dest</code></em> which each component
1658
interleaved. <em class="parameter"><code>dest</code></em> should at least be big enough to hold <em class="parameter"><code>width</code></em> *
1659
n_components * size(unpack_format) bytes.
1662
For subsampled formats, the components will be duplicated in the destination
1419
new key unit as soon as possible.</p>
1420
<p>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
1421
<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>.</p>
1422
<div class="refsect3">
1423
<a name="id-1.2.14.3.8.11.7"></a><h4>Parameters</h4>
1424
<div class="informaltable"><table width="100%" border="0">
1426
<col width="150px" class="parameters_name">
1427
<col class="parameters_description">
1428
<col width="200px" class="parameters_annotations">
1432
<td class="parameter_name"><p>running_time</p></td>
1433
<td class="parameter_description"><p>the running_time at which a new key unit should be produced</p></td>
1434
<td class="parameter_annotations"> </td>
1437
<td class="parameter_name"><p>all_headers</p></td>
1438
<td class="parameter_description"><p><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</p></td>
1439
<td class="parameter_annotations"> </td>
1442
<td class="parameter_name"><p>count</p></td>
1443
<td class="parameter_description"><p>integer that can be used to number key units</p></td>
1444
<td class="parameter_annotations"> </td>
1449
<div class="refsect3">
1450
<a name="id-1.2.14.3.8.11.8"></a><h4>Returns</h4>
1451
<p> The new GstEvent</p>
1456
<div class="refsect2">
1457
<a name="gst-video-event-parse-upstream-force-key-unit"></a><h3>gst_video_event_parse_upstream_force_key_unit ()</h3>
1458
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1459
gst_video_event_parse_upstream_force_key_unit
1460
(<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>,
1461
<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>,
1462
<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>,
1463
<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>
1464
<p>Get running-time, all-headers and count in the force key unit event. See
1465
<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
1466
upstream force key unit event.</p>
1467
<p>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></p>
1468
<div class="refsect3">
1469
<a name="id-1.2.14.3.8.12.6"></a><h4>Parameters</h4>
1470
<div class="informaltable"><table width="100%" border="0">
1472
<col width="150px" class="parameters_name">
1473
<col class="parameters_description">
1474
<col width="200px" class="parameters_annotations">
1478
<td class="parameter_name"><p>event</p></td>
1479
<td class="parameter_description"><p>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</p></td>
1480
<td class="parameter_annotations"> </td>
1483
<td class="parameter_name"><p>running_time</p></td>
1484
<td class="parameter_description"><p> A pointer to the running_time in the event. </p></td>
1485
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1488
<td class="parameter_name"><p>all_headers</p></td>
1489
<td class="parameter_description"><p> A pointer to the all_headers flag in the event. </p></td>
1490
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1493
<td class="parameter_name"><p>count</p></td>
1494
<td class="parameter_description"><p> A pointer to the count field in the event. </p></td>
1495
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1500
<div class="refsect3">
1501
<a name="id-1.2.14.3.8.12.7"></a><h4>Returns</h4>
1502
<p> <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</p>
1507
<div class="refsect2">
1508
<a name="gst-video-event-is-force-key-unit"></a><h3>gst_video_event_is_force_key_unit ()</h3>
1509
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1510
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>
1511
<p>Checks if an event is a force key unit event. Returns true for both upstream
1512
and downstream force key unit events.</p>
1513
<div class="refsect3">
1514
<a name="id-1.2.14.3.8.13.5"></a><h4>Parameters</h4>
1515
<div class="informaltable"><table width="100%" border="0">
1517
<col width="150px" class="parameters_name">
1518
<col class="parameters_description">
1519
<col width="200px" class="parameters_annotations">
1522
<td class="parameter_name"><p>event</p></td>
1523
<td class="parameter_description"><p>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</p></td>
1524
<td class="parameter_annotations"> </td>
1528
<div class="refsect3">
1529
<a name="id-1.2.14.3.8.13.6"></a><h4>Returns</h4>
1530
<p> <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</p>
1535
<div class="refsect2">
1536
<a name="gst-video-chroma-from-string"></a><h3>gst_video_chroma_from_string ()</h3>
1537
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="returnvalue">GstVideoChromaSite</span></a>
1538
gst_video_chroma_from_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s</code></em>);</pre>
1539
<p>Convert <em class="parameter"><code>s</code></em>
1540
to a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a></p>
1541
<div class="refsect3">
1542
<a name="id-1.2.14.3.8.14.5"></a><h4>Parameters</h4>
1543
<div class="informaltable"><table width="100%" border="0">
1545
<col width="150px" class="parameters_name">
1546
<col class="parameters_description">
1547
<col width="200px" class="parameters_annotations">
1550
<td class="parameter_name"><p>s</p></td>
1551
<td class="parameter_description"><p>a chromasite string</p></td>
1552
<td class="parameter_annotations"> </td>
1556
<div class="refsect3">
1557
<a name="id-1.2.14.3.8.14.6"></a><h4>Returns</h4>
1558
<p> a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> or <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-CHROMA-SITE-UNKNOWN:CAPS"><code class="literal">GST_VIDEO_CHROMA_SITE_UNKNOWN</code></a> when <em class="parameter"><code>s</code></em>
1560
not contain a valid chroma description.</p>
1565
<div class="refsect2">
1566
<a name="gst-video-chroma-to-string"></a><h3>gst_video_chroma_to_string ()</h3>
1567
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
1568
gst_video_chroma_to_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> site</code></em>);</pre>
1569
<p>Converts <em class="parameter"><code>site</code></em>
1570
to its string representation.</p>
1571
<div class="refsect3">
1572
<a name="id-1.2.14.3.8.15.5"></a><h4>Parameters</h4>
1573
<div class="informaltable"><table width="100%" border="0">
1575
<col width="150px" class="parameters_name">
1576
<col class="parameters_description">
1577
<col width="200px" class="parameters_annotations">
1580
<td class="parameter_name"><p>site</p></td>
1581
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a></p></td>
1582
<td class="parameter_annotations"> </td>
1586
<div class="refsect3">
1587
<a name="id-1.2.14.3.8.15.6"></a><h4>Returns</h4>
1588
<p> a string describing <em class="parameter"><code>site</code></em>
1594
<div class="refsect2">
1595
<a name="GstVideoFormatUnpack"></a><h3>GstVideoFormatUnpack ()</h3>
1596
<pre class="programlisting"><span class="returnvalue">void</span>
1597
<span class="c_punctuation">(</span>*GstVideoFormatUnpack<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
1598
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags"><span class="type">GstVideoPackFlags</span></a> flags</code></em>,
1599
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> dest</code></em>,
1600
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data[GST_VIDEO_MAX_PLANES]</code></em>,
1601
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride[GST_VIDEO_MAX_PLANES]</code></em>,
1602
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
1603
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
1604
<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>);</pre>
1605
<p>Unpacks <em class="parameter"><code>width</code></em>
1606
pixels from the given planes and strides containing data of
1607
format <em class="parameter"><code>info</code></em>
1608
. The pixels will be unpacked into <em class="parameter"><code>dest</code></em>
1609
which each component
1610
interleaved. <em class="parameter"><code>dest</code></em>
1611
should at least be big enough to hold <em class="parameter"><code>width</code></em>
1613
n_components * size(unpack_format) bytes.</p>
1614
<p>For subsampled formats, the components will be duplicated in the destination
1663
1615
array. Reconstruction of the missing components can be performed in a
1664
separate step after unpacking.
1666
<div class="variablelist"><table border="0" class="variablelist">
1616
separate step after unpacking.</p>
1617
<div class="refsect3">
1618
<a name="id-1.2.14.3.8.16.6"></a><h4>Parameters</h4>
1619
<div class="informaltable"><table width="100%" border="0">
1668
<col align="left" valign="top">
1621
<col width="150px" class="parameters_name">
1622
<col class="parameters_description">
1623
<col width="200px" class="parameters_annotations">
1673
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
1674
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a>
1678
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
1679
<td>flags to control the unpacking</td>
1682
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
1683
<td>a destination array</td>
1686
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1687
<td>pointers to the data planes</td>
1690
<td><p><span class="term"><em class="parameter"><code>stride</code></em> :</span></p></td>
1691
<td>strides of the planes</td>
1694
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
1695
<td>the x position in the image to start from</td>
1698
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
1699
<td>the y position in the image to start from</td>
1702
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1703
<td>the amount of pixels to unpack.</td>
1627
<td class="parameter_name"><p>info</p></td>
1628
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a></p></td>
1629
<td class="parameter_annotations"> </td>
1632
<td class="parameter_name"><p>flags</p></td>
1633
<td class="parameter_description"><p>flags to control the unpacking</p></td>
1634
<td class="parameter_annotations"> </td>
1637
<td class="parameter_name"><p>dest</p></td>
1638
<td class="parameter_description"><p>a destination array</p></td>
1639
<td class="parameter_annotations"> </td>
1642
<td class="parameter_name"><p>data</p></td>
1643
<td class="parameter_description"><p>pointers to the data planes</p></td>
1644
<td class="parameter_annotations"> </td>
1647
<td class="parameter_name"><p>stride</p></td>
1648
<td class="parameter_description"><p>strides of the planes</p></td>
1649
<td class="parameter_annotations"> </td>
1652
<td class="parameter_name"><p>x</p></td>
1653
<td class="parameter_description"><p>the x position in the image to start from</p></td>
1654
<td class="parameter_annotations"> </td>
1657
<td class="parameter_name"><p>y</p></td>
1658
<td class="parameter_description"><p>the y position in the image to start from</p></td>
1659
<td class="parameter_annotations"> </td>
1662
<td class="parameter_name"><p>width</p></td>
1663
<td class="parameter_description"><p>the amount of pixels to unpack.</p></td>
1664
<td class="parameter_annotations"> </td>
1709
1671
<div class="refsect2">
1710
<a name="GstVideoFormatPack"></a><h3>GstVideoFormatPack ()</h3>
1711
<pre class="programlisting"><span class="returnvalue">void</span> (*GstVideoFormatPack) (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
1712
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags"><span class="type">GstVideoPackFlags</span></a> flags</code></em>,
1713
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> src</code></em>,
1714
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sstride</code></em>,
1715
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data[GST_VIDEO_MAX_PLANES]</code></em>,
1716
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride[GST_VIDEO_MAX_PLANES]</code></em>,
1717
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> chroma_site</code></em>,
1718
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
1719
<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>);</pre>
1721
Packs <em class="parameter"><code>width</code></em> pixels from <em class="parameter"><code>src</code></em> to the given planes and strides in the
1722
format <em class="parameter"><code>info</code></em>. The pixels from source have each component interleaved
1723
and will be packed into the planes in <em class="parameter"><code>data</code></em>.
1726
This function operates on pack_lines lines, meaning that <em class="parameter"><code>src</code></em> should
1727
contain at least pack_lines lines with a stride of <em class="parameter"><code>sstride</code></em> and <em class="parameter"><code>y</code></em>
1728
should be a multiple of pack_lines.
1731
Subsampled formats will use the horizontally cosited component in the
1732
destination. Subsampling should be performed before packing.
1734
<div class="variablelist"><table border="0" class="variablelist">
1672
<a name="GstVideoFormatPack"></a><h3>GstVideoFormatPack ()</h3>
1673
<pre class="programlisting"><span class="returnvalue">void</span>
1674
<span class="c_punctuation">(</span>*GstVideoFormatPack<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
1675
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoPackFlags" title="enum GstVideoPackFlags"><span class="type">GstVideoPackFlags</span></a> flags</code></em>,
1676
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> src</code></em>,
1677
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> sstride</code></em>,
1678
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data[GST_VIDEO_MAX_PLANES]</code></em>,
1679
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> stride[GST_VIDEO_MAX_PLANES]</code></em>,
1680
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> chroma_site</code></em>,
1681
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
1682
<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>);</pre>
1683
<p>Packs <em class="parameter"><code>width</code></em>
1684
pixels from <em class="parameter"><code>src</code></em>
1685
to the given planes and strides in the
1686
format <em class="parameter"><code>info</code></em>
1687
. The pixels from source have each component interleaved
1688
and will be packed into the planes in <em class="parameter"><code>data</code></em>
1690
<p>This function operates on pack_lines lines, meaning that <em class="parameter"><code>src</code></em>
1692
contain at least pack_lines lines with a stride of <em class="parameter"><code>sstride</code></em>
1693
and <em class="parameter"><code>y</code></em>
1695
should be a multiple of pack_lines.</p>
1696
<p>Subsampled formats will use the horizontally cosited component in the
1697
destination. Subsampling should be performed before packing.</p>
1698
<div class="refsect3">
1699
<a name="id-1.2.14.3.8.17.7"></a><h4>Parameters</h4>
1700
<div class="informaltable"><table width="100%" border="0">
1736
<col align="left" valign="top">
1702
<col width="150px" class="parameters_name">
1703
<col class="parameters_description">
1704
<col width="200px" class="parameters_annotations">
1741
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
1742
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a>
1746
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
1747
<td>flags to control the packing</td>
1750
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
1751
<td>a source array</td>
1754
<td><p><span class="term"><em class="parameter"><code>sstride</code></em> :</span></p></td>
1755
<td>the source array stride</td>
1758
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1759
<td>pointers to the destination data planes</td>
1762
<td><p><span class="term"><em class="parameter"><code>stride</code></em> :</span></p></td>
1763
<td>strides of the destination planes</td>
1766
<td><p><span class="term"><em class="parameter"><code>chroma_site</code></em> :</span></p></td>
1767
<td>the chroma siting of the target when subsampled (not used)</td>
1770
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
1771
<td>the y position in the image to pack to</td>
1774
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1775
<td>the amount of pixels to pack.</td>
1708
<td class="parameter_name"><p>info</p></td>
1709
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a></p></td>
1710
<td class="parameter_annotations"> </td>
1713
<td class="parameter_name"><p>flags</p></td>
1714
<td class="parameter_description"><p>flags to control the packing</p></td>
1715
<td class="parameter_annotations"> </td>
1718
<td class="parameter_name"><p>src</p></td>
1719
<td class="parameter_description"><p>a source array</p></td>
1720
<td class="parameter_annotations"> </td>
1723
<td class="parameter_name"><p>sstride</p></td>
1724
<td class="parameter_description"><p>the source array stride</p></td>
1725
<td class="parameter_annotations"> </td>
1728
<td class="parameter_name"><p>data</p></td>
1729
<td class="parameter_description"><p>pointers to the destination data planes</p></td>
1730
<td class="parameter_annotations"> </td>
1733
<td class="parameter_name"><p>stride</p></td>
1734
<td class="parameter_description"><p>strides of the destination planes</p></td>
1735
<td class="parameter_annotations"> </td>
1738
<td class="parameter_name"><p>chroma_site</p></td>
1739
<td class="parameter_description"><p>the chroma siting of the target when subsampled (not used)</p></td>
1740
<td class="parameter_annotations"> </td>
1743
<td class="parameter_name"><p>y</p></td>
1744
<td class="parameter_description"><p>the y position in the image to pack to</p></td>
1745
<td class="parameter_annotations"> </td>
1748
<td class="parameter_name"><p>width</p></td>
1749
<td class="parameter_description"><p>the amount of pixels to pack.</p></td>
1750
<td class="parameter_annotations"> </td>
1781
1757
<div class="refsect2">
1966
1930
<div class="refsect2">
1967
<a name="gst-video-format-from-masks"></a><h3>gst_video_format_from_masks ()</h3>
1968
<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_masks (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> depth</code></em>,
1969
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
1970
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>,
1971
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> red_mask</code></em>,
1972
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> green_mask</code></em>,
1973
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blue_mask</code></em>,
1974
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> alpha_mask</code></em>);</pre>
1976
Find the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> for the given parameters.
1978
<div class="variablelist"><table border="0" class="variablelist">
1931
<a name="gst-video-format-from-masks"></a><h3>gst_video_format_from_masks ()</h3>
1932
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
1933
gst_video_format_from_masks (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> depth</code></em>,
1934
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
1935
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> endianness</code></em>,
1936
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> red_mask</code></em>,
1937
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> green_mask</code></em>,
1938
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> blue_mask</code></em>,
1939
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> alpha_mask</code></em>);</pre>
1940
<p>Find the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> for the given parameters.</p>
1941
<div class="refsect3">
1942
<a name="id-1.2.14.3.8.44.5"></a><h4>Parameters</h4>
1943
<div class="informaltable"><table width="100%" border="0">
1980
<col align="left" valign="top">
1945
<col width="150px" class="parameters_name">
1946
<col class="parameters_description">
1947
<col width="200px" class="parameters_annotations">
1985
<td><p><span class="term"><em class="parameter"><code>depth</code></em> :</span></p></td>
1986
<td>the amount of bits used for a pixel</td>
1951
<td class="parameter_name"><p>depth</p></td>
1952
<td class="parameter_description"><p>the amount of bits used for a pixel</p></td>
1953
<td class="parameter_annotations"> </td>
1989
<td><p><span class="term"><em class="parameter"><code>bpp</code></em> :</span></p></td>
1990
<td>the amount of bits used to store a pixel. This value is bigger than
1956
<td class="parameter_name"><p>bpp</p></td>
1957
<td class="parameter_description"><p>the amount of bits used to store a pixel. This value is bigger than
1991
1958
<em class="parameter"><code>depth</code></em>
1995
<td><p><span class="term"><em class="parameter"><code>endianness</code></em> :</span></p></td>
1996
<td>the endianness of the masks, <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Order-Macros.html#G-LITTLE-ENDIAN:CAPS"><span class="type">G_LITTLE_ENDIAN</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Order-Macros.html#G-BIG-ENDIAN:CAPS"><span class="type">G_BIG_ENDIAN</span></a>
2000
<td><p><span class="term"><em class="parameter"><code>red_mask</code></em> :</span></p></td>
2001
<td>the red mask</td>
2004
<td><p><span class="term"><em class="parameter"><code>green_mask</code></em> :</span></p></td>
2005
<td>the green mask</td>
2008
<td><p><span class="term"><em class="parameter"><code>blue_mask</code></em> :</span></p></td>
2009
<td>the blue mask</td>
2012
<td><p><span class="term"><em class="parameter"><code>alpha_mask</code></em> :</span></p></td>
2013
<td>the alpha mask, or 0 if no alpha mask</td>
2016
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2017
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> or GST_VIDEO_FORMAT_UNKNOWN when the parameters to
2018
not specify a known format.</td>
1960
<td class="parameter_annotations"> </td>
1963
<td class="parameter_name"><p>endianness</p></td>
1964
<td class="parameter_description"><p>the endianness of the masks, <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Order-Macros.html#G-LITTLE-ENDIAN:CAPS"><span class="type">G_LITTLE_ENDIAN</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Order-Macros.html#G-BIG-ENDIAN:CAPS"><span class="type">G_BIG_ENDIAN</span></a></p></td>
1965
<td class="parameter_annotations"> </td>
1968
<td class="parameter_name"><p>red_mask</p></td>
1969
<td class="parameter_description"><p>the red mask</p></td>
1970
<td class="parameter_annotations"> </td>
1973
<td class="parameter_name"><p>green_mask</p></td>
1974
<td class="parameter_description"><p>the green mask</p></td>
1975
<td class="parameter_annotations"> </td>
1978
<td class="parameter_name"><p>blue_mask</p></td>
1979
<td class="parameter_description"><p>the blue mask</p></td>
1980
<td class="parameter_annotations"> </td>
1983
<td class="parameter_name"><p>alpha_mask</p></td>
1984
<td class="parameter_description"><p>the alpha mask, or 0 if no alpha mask</p></td>
1985
<td class="parameter_annotations"> </td>
1990
<div class="refsect3">
1991
<a name="id-1.2.14.3.8.44.6"></a><h4>Returns</h4>
1992
<p> a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> or GST_VIDEO_FORMAT_UNKNOWN when the parameters to
1993
not specify a known format.</p>
2024
1998
<div class="refsect2">
2025
<a name="gst-video-format-from-fourcc"></a><h3>gst_video_format_from_fourcc ()</h3>
2026
<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>
2028
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>.
1999
<a name="gst-video-format-from-fourcc"></a><h3>gst_video_format_from_fourcc ()</h3>
2000
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
2001
gst_video_format_from_fourcc (<em class="parameter"><code><span class="type">guint32</span> fourcc</code></em>);</pre>
2002
<p>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>.
2029
2003
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>,
2030
<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.
2032
<div class="variablelist"><table border="0" class="variablelist">
2034
<col align="left" valign="top">
2039
<td><p><span class="term"><em class="parameter"><code>fourcc</code></em> :</span></p></td>
2040
<td>a FOURCC value representing raw YUV video</td>
2043
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2044
<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>
2050
<div class="refsect2">
2051
<a name="gst-video-format-to-fourcc"></a><h3>gst_video_format_to_fourcc ()</h3>
2052
<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>
2054
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
2055
a few YUV formats have corresponding FOURCC values. If <em class="parameter"><code>format</code></em> has
2056
no corresponding FOURCC value, 0 is returned.
2058
<div class="variablelist"><table border="0" class="variablelist">
2060
<col align="left" valign="top">
2065
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
2066
<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>
2069
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2070
<td>the FOURCC corresponding to <em class="parameter"><code>format</code></em>
2077
<div class="refsect2">
2078
<a name="gst-video-format-from-string"></a><h3>gst_video_format_from_string ()</h3>
2079
<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_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>);</pre>
2081
Convert the <em class="parameter"><code>format</code></em> string to its <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>.
2083
<div class="variablelist"><table border="0" class="variablelist">
2085
<col align="left" valign="top">
2090
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
2091
<td>a format string</td>
2094
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2095
<td>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> for <em class="parameter"><code>format</code></em> or GST_VIDEO_FORMAT_UNKNOWN when the
2096
string is not a known format.</td>
2102
<div class="refsect2">
2103
<a name="gst-video-format-to-string"></a><h3>gst_video_format_to_string ()</h3>
2104
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_video_format_to_string (<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>
2107
<div class="refsect2">
2108
<a name="gst-video-format-get-info"></a><h3>gst_video_format_get_info ()</h3>
2109
<pre class="programlisting">const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="returnvalue">GstVideoFormatInfo</span></a> * gst_video_format_get_info (<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>
2111
Get the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> for <em class="parameter"><code>format</code></em>
2113
<div class="variablelist"><table border="0" class="variablelist">
2115
<col align="left" valign="top">
2120
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
2121
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>
2125
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2126
<td>The <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> for <em class="parameter"><code>format</code></em>.</td>
2132
<div class="refsect2">
2133
<a name="GST-VIDEO-SIZE-RANGE:CAPS"></a><h3>GST_VIDEO_SIZE_RANGE</h3>
2134
<pre class="programlisting">#define GST_VIDEO_SIZE_RANGE "(int) [ 1, max ]"
2138
<div class="refsect2">
2139
<a name="GST-VIDEO-FPS-RANGE:CAPS"></a><h3>GST_VIDEO_FPS_RANGE</h3>
2140
<pre class="programlisting">#define GST_VIDEO_FPS_RANGE "(fraction) [ 0, max ]"
2144
<div class="refsect2">
2145
<a name="GST-VIDEO-FORMATS-ALL:CAPS"></a><h3>GST_VIDEO_FORMATS_ALL</h3>
2146
<pre class="programlisting">#define GST_VIDEO_FORMATS_ALL</pre>
2004
<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.</p>
2005
<div class="refsect3">
2006
<a name="id-1.2.14.3.8.45.5"></a><h4>Parameters</h4>
2007
<div class="informaltable"><table width="100%" border="0">
2009
<col width="150px" class="parameters_name">
2010
<col class="parameters_description">
2011
<col width="200px" class="parameters_annotations">
2014
<td class="parameter_name"><p>fourcc</p></td>
2015
<td class="parameter_description"><p>a FOURCC value representing raw YUV video</p></td>
2016
<td class="parameter_annotations"> </td>
2020
<div class="refsect3">
2021
<a name="id-1.2.14.3.8.45.6"></a><h4>Returns</h4>
2022
<p> 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</p>
2027
<div class="refsect2">
2028
<a name="gst-video-format-to-fourcc"></a><h3>gst_video_format_to_fourcc ()</h3>
2029
<pre class="programlisting"><span class="returnvalue">guint32</span>
2030
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>
2031
<p>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
2032
a few YUV formats have corresponding FOURCC values. If <em class="parameter"><code>format</code></em>
2034
no corresponding FOURCC value, 0 is returned.</p>
2035
<div class="refsect3">
2036
<a name="id-1.2.14.3.8.46.5"></a><h4>Parameters</h4>
2037
<div class="informaltable"><table width="100%" border="0">
2039
<col width="150px" class="parameters_name">
2040
<col class="parameters_description">
2041
<col width="200px" class="parameters_annotations">
2044
<td class="parameter_name"><p>format</p></td>
2045
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> video format</p></td>
2046
<td class="parameter_annotations"> </td>
2050
<div class="refsect3">
2051
<a name="id-1.2.14.3.8.46.6"></a><h4>Returns</h4>
2052
<p> the FOURCC corresponding to <em class="parameter"><code>format</code></em>
2058
<div class="refsect2">
2059
<a name="gst-video-format-from-string"></a><h3>gst_video_format_from_string ()</h3>
2060
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="returnvalue">GstVideoFormat</span></a>
2061
gst_video_format_from_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>);</pre>
2062
<p>Convert the <em class="parameter"><code>format</code></em>
2063
string to its <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a>.</p>
2064
<div class="refsect3">
2065
<a name="id-1.2.14.3.8.47.5"></a><h4>Parameters</h4>
2066
<div class="informaltable"><table width="100%" border="0">
2068
<col width="150px" class="parameters_name">
2069
<col class="parameters_description">
2070
<col width="200px" class="parameters_annotations">
2073
<td class="parameter_name"><p>format</p></td>
2074
<td class="parameter_description"><p>a format string</p></td>
2075
<td class="parameter_annotations"> </td>
2079
<div class="refsect3">
2080
<a name="id-1.2.14.3.8.47.6"></a><h4>Returns</h4>
2081
<p> the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> for <em class="parameter"><code>format</code></em>
2082
or GST_VIDEO_FORMAT_UNKNOWN when the
2083
string is not a known format.</p>
2088
<div class="refsect2">
2089
<a name="gst-video-format-to-string"></a><h3>gst_video_format_to_string ()</h3>
2090
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
2091
gst_video_format_to_string (<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>
2094
<div class="refsect2">
2095
<a name="gst-video-format-get-info"></a><h3>gst_video_format_get_info ()</h3>
2096
<pre class="programlisting">const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="returnvalue">GstVideoFormatInfo</span></a> *
2097
gst_video_format_get_info (<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>
2098
<p>Get the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> for <em class="parameter"><code>format</code></em>
2100
<div class="refsect3">
2101
<a name="id-1.2.14.3.8.49.5"></a><h4>Parameters</h4>
2102
<div class="informaltable"><table width="100%" border="0">
2104
<col width="150px" class="parameters_name">
2105
<col class="parameters_description">
2106
<col width="200px" class="parameters_annotations">
2109
<td class="parameter_name"><p>format</p></td>
2110
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a></p></td>
2111
<td class="parameter_annotations"> </td>
2115
<div class="refsect3">
2116
<a name="id-1.2.14.3.8.49.6"></a><h4>Returns</h4>
2117
<p> The <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> for <em class="parameter"><code>format</code></em>
2149
2123
<div class="refsect2">
2150
2124
<a name="GST-VIDEO-CAPS-MAKE:CAPS"></a><h3>GST_VIDEO_CAPS_MAKE()</h3>
2151
2125
<pre class="programlisting">#define GST_VIDEO_CAPS_MAKE(format)</pre>
2153
Generic caps string for video, for use in pad templates.
2155
<div class="variablelist"><table border="0" class="variablelist">
2157
<col align="left" valign="top">
2161
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
2162
<td>string format that describes the pixel layout, as string
2163
(e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)</td>
2168
<div class="refsect2">
2169
<a name="GstVideoColorRange"></a><h3>enum GstVideoColorRange</h3>
2170
<pre class="programlisting">typedef enum {
2171
GST_VIDEO_COLOR_RANGE_UNKNOWN = 0,
2172
GST_VIDEO_COLOR_RANGE_0_255,
2173
GST_VIDEO_COLOR_RANGE_16_235
2174
} GstVideoColorRange;
2177
Possible color range values. These constants are defined for 8 bit color
2178
values and can be scaled for other bit depths.
2180
<div class="variablelist"><table border="0" class="variablelist">
2182
<col align="left" valign="top">
2187
<td><p><a name="GST-VIDEO-COLOR-RANGE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_RANGE_UNKNOWN</code></span></p></td>
2192
<td><p><a name="GST-VIDEO-COLOR-RANGE-0-255:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_RANGE_0_255</code></span></p></td>
2193
<td>[0..255] for 8 bit components
2197
<td><p><a name="GST-VIDEO-COLOR-RANGE-16-235:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_RANGE_16_235</code></span></p></td>
2198
<td>[16..235] for 8 bit components. Chroma has
2206
<div class="refsect2">
2207
<a name="GstVideoColorMatrix"></a><h3>enum GstVideoColorMatrix</h3>
2208
<pre class="programlisting">typedef enum {
2209
GST_VIDEO_COLOR_MATRIX_UNKNOWN = 0,
2210
GST_VIDEO_COLOR_MATRIX_RGB,
2211
GST_VIDEO_COLOR_MATRIX_FCC,
2212
GST_VIDEO_COLOR_MATRIX_BT709,
2213
GST_VIDEO_COLOR_MATRIX_BT601,
2214
GST_VIDEO_COLOR_MATRIX_SMPTE240M
2215
} GstVideoColorMatrix;
2218
The color matrix is used to convert between Y'PbPr and
2219
non-linear RGB (R'G'B')
2221
<div class="variablelist"><table border="0" class="variablelist">
2223
<col align="left" valign="top">
2228
<td><p><a name="GST-VIDEO-COLOR-MATRIX-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_MATRIX_UNKNOWN</code></span></p></td>
2233
<td><p><a name="GST-VIDEO-COLOR-MATRIX-RGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_MATRIX_RGB</code></span></p></td>
2238
<td><p><a name="GST-VIDEO-COLOR-MATRIX-FCC:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_MATRIX_FCC</code></span></p></td>
2239
<td>FCC color matrix
2243
<td><p><a name="GST-VIDEO-COLOR-MATRIX-BT709:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_MATRIX_BT709</code></span></p></td>
2244
<td>ITU-R BT.709 color matrix
2248
<td><p><a name="GST-VIDEO-COLOR-MATRIX-BT601:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_MATRIX_BT601</code></span></p></td>
2249
<td>ITU-R BT.601 color matrix
2253
<td><p><a name="GST-VIDEO-COLOR-MATRIX-SMPTE240M:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_MATRIX_SMPTE240M</code></span></p></td>
2254
<td>SMPTE 240M color matrix
2261
<div class="refsect2">
2262
<a name="GstVideoTransferFunction"></a><h3>enum GstVideoTransferFunction</h3>
2263
<pre class="programlisting">typedef enum {
2264
GST_VIDEO_TRANSFER_UNKNOWN = 0,
2265
GST_VIDEO_TRANSFER_GAMMA10,
2266
GST_VIDEO_TRANSFER_GAMMA18,
2267
GST_VIDEO_TRANSFER_GAMMA20,
2268
GST_VIDEO_TRANSFER_GAMMA22,
2269
GST_VIDEO_TRANSFER_BT709,
2270
GST_VIDEO_TRANSFER_SMPTE240M,
2271
GST_VIDEO_TRANSFER_SRGB,
2272
GST_VIDEO_TRANSFER_GAMMA28,
2273
GST_VIDEO_TRANSFER_LOG100,
2274
GST_VIDEO_TRANSFER_LOG316
2275
} GstVideoTransferFunction;
2278
The video transfer function defines the formula for converting between
2279
non-linear RGB (R'G'B') and linear RGB
2281
<div class="variablelist"><table border="0" class="variablelist">
2283
<col align="left" valign="top">
2288
<td><p><a name="GST-VIDEO-TRANSFER-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_UNKNOWN</code></span></p></td>
2289
<td>unknown transfer function
2293
<td><p><a name="GST-VIDEO-TRANSFER-GAMMA10:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_GAMMA10</code></span></p></td>
2294
<td>linear RGB, gamma 1.0 curve
2298
<td><p><a name="GST-VIDEO-TRANSFER-GAMMA18:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_GAMMA18</code></span></p></td>
2303
<td><p><a name="GST-VIDEO-TRANSFER-GAMMA20:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_GAMMA20</code></span></p></td>
2308
<td><p><a name="GST-VIDEO-TRANSFER-GAMMA22:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_GAMMA22</code></span></p></td>
2313
<td><p><a name="GST-VIDEO-TRANSFER-BT709:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_BT709</code></span></p></td>
2314
<td>Gamma 2.2 curve with a linear segment in the lower
2319
<td><p><a name="GST-VIDEO-TRANSFER-SMPTE240M:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_SMPTE240M</code></span></p></td>
2320
<td>Gamma 2.2 curve with a linear segment in the
2325
<td><p><a name="GST-VIDEO-TRANSFER-SRGB:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_SRGB</code></span></p></td>
2326
<td>Gamma 2.4 curve with a linear segment in the lower
2331
<td><p><a name="GST-VIDEO-TRANSFER-GAMMA28:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_GAMMA28</code></span></p></td>
2336
<td><p><a name="GST-VIDEO-TRANSFER-LOG100:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_LOG100</code></span></p></td>
2337
<td>Logarithmic transfer characteristic
2342
<td><p><a name="GST-VIDEO-TRANSFER-LOG316:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_TRANSFER_LOG316</code></span></p></td>
2343
<td>Logarithmic transfer characteristic
2351
<div class="refsect2">
2352
<a name="GstVideoColorPrimaries"></a><h3>enum GstVideoColorPrimaries</h3>
2353
<pre class="programlisting">typedef enum {
2354
GST_VIDEO_COLOR_PRIMARIES_UNKNOWN = 0,
2355
GST_VIDEO_COLOR_PRIMARIES_BT709,
2356
GST_VIDEO_COLOR_PRIMARIES_BT470M,
2357
GST_VIDEO_COLOR_PRIMARIES_BT470BG,
2358
GST_VIDEO_COLOR_PRIMARIES_SMPTE170M,
2359
GST_VIDEO_COLOR_PRIMARIES_SMPTE240M,
2360
GST_VIDEO_COLOR_PRIMARIES_FILM
2361
} GstVideoColorPrimaries;
2364
The color primaries define the how to transform linear RGB values to and from
2365
the CIE XYZ colorspace.
2367
<div class="variablelist"><table border="0" class="variablelist">
2369
<col align="left" valign="top">
2374
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_UNKNOWN</code></span></p></td>
2375
<td>unknown color primaries
2379
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-BT709:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_BT709</code></span></p></td>
2384
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-BT470M:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_BT470M</code></span></p></td>
2385
<td>BT470M primaries
2389
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-BT470BG:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_BT470BG</code></span></p></td>
2390
<td>BT470BG primaries
2394
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-SMPTE170M:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_SMPTE170M</code></span></p></td>
2395
<td>SMPTE170M primaries
2399
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-SMPTE240M:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_SMPTE240M</code></span></p></td>
2400
<td>SMPTE240M primaries
2404
<td><p><a name="GST-VIDEO-COLOR-PRIMARIES-FILM:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_COLOR_PRIMARIES_FILM</code></span></p></td>
2412
<div class="refsect2">
2413
<a name="GstVideoColorimetry"></a><h3>GstVideoColorimetry</h3>
2414
<pre class="programlisting">typedef struct {
2415
GstVideoColorRange range;
2416
GstVideoColorMatrix matrix;
2417
GstVideoTransferFunction transfer;
2418
GstVideoColorPrimaries primaries;
2419
} GstVideoColorimetry;
2422
Structure describing the color info.
2424
<div class="variablelist"><table border="0" class="variablelist">
2426
<col align="left" valign="top">
2431
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.range"></a>range</code></em>;</span></p></td>
2432
<td>the color range. This is the valid range for the samples.
2433
It is used to convert the samples to Y'PbPr values.</td>
2436
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorMatrix" title="enum GstVideoColorMatrix"><span class="type">GstVideoColorMatrix</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.matrix"></a>matrix</code></em>;</span></p></td>
2437
<td>the color matrix. Used to convert between Y'PbPr and
2438
non-linear RGB (R'G'B')</td>
2441
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoTransferFunction" title="enum GstVideoTransferFunction"><span class="type">GstVideoTransferFunction</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.transfer"></a>transfer</code></em>;</span></p></td>
2442
<td>the transfer function. used to convert between R'G'B' and RGB</td>
2445
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorPrimaries" title="enum GstVideoColorPrimaries"><span class="type">GstVideoColorPrimaries</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.primaries"></a>primaries</code></em>;</span></p></td>
2446
<td>color primaries. used to convert between R'G'B' and CIE XYZ</td>
2452
<div class="refsect2">
2453
<a name="gst-video-colorimetry-matches"></a><h3>gst_video_colorimetry_matches ()</h3>
2454
<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_colorimetry_matches (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>,
2455
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *color</code></em>);</pre>
2457
Check if the colorimetry information in <em class="parameter"><code>info</code></em> matches that of the
2458
string <em class="parameter"><code>color</code></em>.
2460
<div class="variablelist"><table border="0" class="variablelist">
2462
<col align="left" valign="top">
2467
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
2468
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
2472
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2473
<td>a colorimetry string</td>
2476
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2478
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>color</code></em> conveys the same colorimetry info as the color
2479
information in <em class="parameter"><code>info</code></em>.</td>
2485
<div class="refsect2">
2486
<a name="gst-video-colorimetry-from-string"></a><h3>gst_video_colorimetry_from_string ()</h3>
2487
<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_colorimetry_from_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>,
2488
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *color</code></em>);</pre>
2490
Parse the colorimetry string and update <em class="parameter"><code>cinfo</code></em> with the parsed
2493
<div class="variablelist"><table border="0" class="variablelist">
2495
<col align="left" valign="top">
2500
<td><p><span class="term"><em class="parameter"><code>cinfo</code></em> :</span></p></td>
2501
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a>
2505
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2506
<td>a colorimetry string</td>
2509
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2511
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>color</code></em> points to valid colorimetry info.</td>
2517
<div class="refsect2">
2518
<a name="gst-video-colorimetry-to-string"></a><h3>gst_video_colorimetry_to_string ()</h3>
2519
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gst_video_colorimetry_to_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>);</pre>
2521
Make a string representation of <em class="parameter"><code>cinfo</code></em>.
2523
<div class="variablelist"><table border="0" class="variablelist">
2525
<col align="left" valign="top">
2530
<td><p><span class="term"><em class="parameter"><code>cinfo</code></em> :</span></p></td>
2531
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a>
2535
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2536
<td>a string representation of <em class="parameter"><code>cinfo</code></em>.</td>
2542
<div class="refsect2">
2543
<a name="gst-video-color-range-offsets"></a><h3>gst_video_color_range_offsets ()</h3>
2544
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_color_range_offsets (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a> range</code></em>,
2545
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
2546
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset[GST_VIDEO_MAX_COMPONENTS]</code></em>,
2547
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> scale[GST_VIDEO_MAX_COMPONENTS]</code></em>);</pre>
2549
Compute the offset and scale values for each component of <em class="parameter"><code>info</code></em>. For each
2126
<p>Generic caps string for video, for use in pad templates.</p>
2127
<div class="refsect3">
2128
<a name="id-1.2.14.3.8.50.5"></a><h4>Parameters</h4>
2129
<div class="informaltable"><table width="100%" border="0">
2131
<col width="150px" class="parameters_name">
2132
<col class="parameters_description">
2133
<col width="200px" class="parameters_annotations">
2136
<td class="parameter_name"><p>format</p></td>
2137
<td class="parameter_description"><p>string format that describes the pixel layout, as string
2138
(e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.)</p></td>
2139
<td class="parameter_annotations"> </td>
2145
<div class="refsect2">
2146
<a name="gst-video-colorimetry-matches"></a><h3>gst_video_colorimetry_matches ()</h3>
2147
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2148
gst_video_colorimetry_matches (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>,
2149
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *color</code></em>);</pre>
2150
<p>Check if the colorimetry information in <em class="parameter"><code>info</code></em>
2152
string <em class="parameter"><code>color</code></em>
2154
<div class="refsect3">
2155
<a name="id-1.2.14.3.8.51.5"></a><h4>Parameters</h4>
2156
<div class="informaltable"><table width="100%" border="0">
2158
<col width="150px" class="parameters_name">
2159
<col class="parameters_description">
2160
<col width="200px" class="parameters_annotations">
2164
<td class="parameter_name"><p>info</p></td>
2165
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2166
<td class="parameter_annotations"> </td>
2169
<td class="parameter_name"><p>color</p></td>
2170
<td class="parameter_description"><p>a colorimetry string</p></td>
2171
<td class="parameter_annotations"> </td>
2176
<div class="refsect3">
2177
<a name="id-1.2.14.3.8.51.6"></a><h4>Returns</h4>
2178
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>color</code></em>
2179
conveys the same colorimetry info as the color
2180
information in <em class="parameter"><code>info</code></em>
2186
<div class="refsect2">
2187
<a name="gst-video-colorimetry-from-string"></a><h3>gst_video_colorimetry_from_string ()</h3>
2188
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2189
gst_video_colorimetry_from_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>,
2190
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *color</code></em>);</pre>
2191
<p>Parse the colorimetry string and update <em class="parameter"><code>cinfo</code></em>
2194
<div class="refsect3">
2195
<a name="id-1.2.14.3.8.52.5"></a><h4>Parameters</h4>
2196
<div class="informaltable"><table width="100%" border="0">
2198
<col width="150px" class="parameters_name">
2199
<col class="parameters_description">
2200
<col width="200px" class="parameters_annotations">
2204
<td class="parameter_name"><p>cinfo</p></td>
2205
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a></p></td>
2206
<td class="parameter_annotations"> </td>
2209
<td class="parameter_name"><p>color</p></td>
2210
<td class="parameter_description"><p>a colorimetry string</p></td>
2211
<td class="parameter_annotations"> </td>
2216
<div class="refsect3">
2217
<a name="id-1.2.14.3.8.52.6"></a><h4>Returns</h4>
2218
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if <em class="parameter"><code>color</code></em>
2219
points to valid colorimetry info.</p>
2224
<div class="refsect2">
2225
<a name="gst-video-colorimetry-to-string"></a><h3>gst_video_colorimetry_to_string ()</h3>
2226
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
2227
gst_video_colorimetry_to_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> *cinfo</code></em>);</pre>
2228
<p>Make a string representation of <em class="parameter"><code>cinfo</code></em>
2230
<div class="refsect3">
2231
<a name="id-1.2.14.3.8.53.5"></a><h4>Parameters</h4>
2232
<div class="informaltable"><table width="100%" border="0">
2234
<col width="150px" class="parameters_name">
2235
<col class="parameters_description">
2236
<col width="200px" class="parameters_annotations">
2239
<td class="parameter_name"><p>cinfo</p></td>
2240
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a></p></td>
2241
<td class="parameter_annotations"> </td>
2245
<div class="refsect3">
2246
<a name="id-1.2.14.3.8.53.6"></a><h4>Returns</h4>
2247
<p> a string representation of <em class="parameter"><code>cinfo</code></em>
2253
<div class="refsect2">
2254
<a name="gst-video-color-range-offsets"></a><h3>gst_video_color_range_offsets ()</h3>
2255
<pre class="programlisting"><span class="returnvalue">void</span>
2256
gst_video_color_range_offsets (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a> range</code></em>,
2257
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *info</code></em>,
2258
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> offset[GST_VIDEO_MAX_COMPONENTS]</code></em>,
2259
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> scale[GST_VIDEO_MAX_COMPONENTS]</code></em>);</pre>
2260
<p>Compute the offset and scale values for each component of <em class="parameter"><code>info</code></em>
2550
2262
component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
2554
The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert
2263
range [0.0 .. 1.0].</p>
2264
<p>The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert
2555
2265
the component values in range [0.0 .. 1.0] back to their representation in
2556
<em class="parameter"><code>info</code></em> and <em class="parameter"><code>range</code></em>.
2558
<div class="variablelist"><table border="0" class="variablelist">
2560
<col align="left" valign="top">
2565
<td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td>
2566
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a>
2570
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
2571
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a>
2575
<td><p><span class="term"><em class="parameter"><code>offsets</code></em> :</span></p></td>
2576
<td>output offsets. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2580
<td><p><span class="term"><em class="parameter"><code>scale</code></em> :</span></p></td>
2581
<td>output scale. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2588
<div class="refsect2">
2589
<a name="GstVideoInfo"></a><h3>struct GstVideoInfo</h3>
2590
<pre class="programlisting">struct GstVideoInfo {
2591
const GstVideoFormatInfo *finfo;
2593
GstVideoInterlaceMode interlace_mode;
2594
GstVideoFlags flags;
2600
GstVideoChromaSite chroma_site;
2601
GstVideoColorimetry colorimetry;
2608
gsize offset[GST_VIDEO_MAX_PLANES];
2609
gint stride[GST_VIDEO_MAX_PLANES];
2613
Information describing image properties. This information can be filled
2614
in from GstCaps with <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-from-caps" title="gst_video_info_from_caps ()"><code class="function">gst_video_info_from_caps()</code></a>. The information is also used
2615
to store the specific video info when mapping a video frame with
2616
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-map" title="gst_video_frame_map ()"><code class="function">gst_video_frame_map()</code></a>.
2619
Use the provided macros to access the info in this structure.
2621
<div class="variablelist"><table border="0" class="variablelist">
2623
<col align="left" valign="top">
2628
<td><p><span class="term">const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *<em class="structfield"><code><a name="GstVideoInfo.finfo"></a>finfo</code></em>;</span></p></td>
2629
<td>the format info of the video</td>
2632
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInterlaceMode" title="enum GstVideoInterlaceMode"><span class="type">GstVideoInterlaceMode</span></a> <em class="structfield"><code><a name="GstVideoInfo.interlace-mode"></a>interlace_mode</code></em>;</span></p></td>
2633
<td>the interlace mode</td>
2636
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFlags" title="enum GstVideoFlags"><span class="type">GstVideoFlags</span></a> <em class="structfield"><code><a name="GstVideoInfo.flags"></a>flags</code></em>;</span></p></td>
2637
<td>additional video flags</td>
2640
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.width"></a>width</code></em>;</span></p></td>
2641
<td>the width of the video</td>
2644
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.height"></a>height</code></em>;</span></p></td>
2645
<td>the height of the video</td>
2648
<td><p><span class="term"><span class="type">gsize</span> <em class="structfield"><code><a name="GstVideoInfo.size"></a>size</code></em>;</span></p></td>
2649
<td>the default size of one frame</td>
2652
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.views"></a>views</code></em>;</span></p></td>
2653
<td>the number of views for multiview video</td>
2656
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> <em class="structfield"><code><a name="GstVideoInfo.chroma-site"></a>chroma_site</code></em>;</span></p></td>
2657
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a>.</td>
2660
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> <em class="structfield"><code><a name="GstVideoInfo.colorimetry"></a>colorimetry</code></em>;</span></p></td>
2661
<td>the colorimetry info</td>
2664
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.par-n"></a>par_n</code></em>;</span></p></td>
2665
<td>the pixel-aspect-ratio numerator</td>
2668
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.par-d"></a>par_d</code></em>;</span></p></td>
2669
<td>the pixel-aspect-ratio demnominator</td>
2672
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.fps-n"></a>fps_n</code></em>;</span></p></td>
2673
<td>the framerate numerator</td>
2676
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.fps-d"></a>fps_d</code></em>;</span></p></td>
2677
<td>the framerate demnominator</td>
2680
<td><p><span class="term"><span class="type">gsize</span> <em class="structfield"><code><a name="GstVideoInfo.offset"></a>offset</code></em>[GST_VIDEO_MAX_PLANES];</span></p></td>
2681
<td>offsets of the planes</td>
2684
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.stride"></a>stride</code></em>[GST_VIDEO_MAX_PLANES];</span></p></td>
2685
<td>strides of the planes</td>
2691
<div class="refsect2">
2692
<a name="GstVideoInterlaceMode"></a><h3>enum GstVideoInterlaceMode</h3>
2693
<pre class="programlisting">typedef enum {
2694
GST_VIDEO_INTERLACE_MODE_PROGRESSIVE = 0,
2695
GST_VIDEO_INTERLACE_MODE_INTERLEAVED,
2696
GST_VIDEO_INTERLACE_MODE_MIXED,
2697
GST_VIDEO_INTERLACE_MODE_FIELDS
2698
} GstVideoInterlaceMode;
2701
The possible values of the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInterlaceMode" title="enum GstVideoInterlaceMode"><span class="type">GstVideoInterlaceMode</span></a> describing the interlace
2704
<div class="variablelist"><table border="0" class="variablelist">
2706
<col align="left" valign="top">
2711
<td><p><a name="GST-VIDEO-INTERLACE-MODE-PROGRESSIVE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_INTERLACE_MODE_PROGRESSIVE</code></span></p></td>
2712
<td>all frames are progressive
2716
<td><p><a name="GST-VIDEO-INTERLACE-MODE-INTERLEAVED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_INTERLACE_MODE_INTERLEAVED</code></span></p></td>
2717
<td>2 fields are interleaved in one video
2718
frame. Extra buffer flags describe the field order.
2722
<td><p><a name="GST-VIDEO-INTERLACE-MODE-MIXED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_INTERLACE_MODE_MIXED</code></span></p></td>
2723
<td>frames contains both interlaced and
2724
progressive video, the buffer flags describe the frame and fields.
2728
<td><p><a name="GST-VIDEO-INTERLACE-MODE-FIELDS:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_INTERLACE_MODE_FIELDS</code></span></p></td>
2729
<td>2 fields are stored in one buffer, use the
2730
frame ID to get access to the required field. For multiview (the
2731
'views' property > 1) the fields of view N can be found at frame ID
2732
(N * 2) and (N * 2) + 1.
2733
Each field has only half the amount of lines as noted in the
2734
height property. This mode requires multiple GstVideoMeta metadata
2735
to describe the fields.
2742
<div class="refsect2">
2743
<a name="GstVideoFlags"></a><h3>enum GstVideoFlags</h3>
2744
<pre class="programlisting">typedef enum {
2745
GST_VIDEO_FLAG_NONE = 0,
2746
GST_VIDEO_FLAG_VARIABLE_FPS = (1 << 0),
2747
GST_VIDEO_FLAG_PREMULTIPLIED_ALPHA = (1 << 1)
2753
<div class="variablelist"><table border="0" class="variablelist">
2755
<col align="left" valign="top">
2760
<td><p><a name="GST-VIDEO-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FLAG_NONE</code></span></p></td>
2765
<td><p><a name="GST-VIDEO-FLAG-VARIABLE-FPS:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FLAG_VARIABLE_FPS</code></span></p></td>
2766
<td>a variable fps is selected, fps_n and fps_d
2767
denote the maximum fps of the video
2771
<td><p><a name="GST-VIDEO-FLAG-PREMULTIPLIED-ALPHA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FLAG_PREMULTIPLIED_ALPHA</code></span></p></td>
2772
<td>Each color has been scaled by the alpha
2266
<em class="parameter"><code>info</code></em>
2267
and <em class="parameter"><code>range</code></em>
2269
<div class="refsect3">
2270
<a name="id-1.2.14.3.8.54.6"></a><h4>Parameters</h4>
2271
<div class="informaltable"><table width="100%" border="0">
2273
<col width="150px" class="parameters_name">
2274
<col class="parameters_description">
2275
<col width="200px" class="parameters_annotations">
2279
<td class="parameter_name"><p>range</p></td>
2280
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a></p></td>
2281
<td class="parameter_annotations"> </td>
2284
<td class="parameter_name"><p>info</p></td>
2285
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a></p></td>
2286
<td class="parameter_annotations"> </td>
2289
<td class="parameter_name"><p>offsets</p></td>
2290
<td class="parameter_description"><p> output offsets. </p></td>
2291
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
2294
<td class="parameter_name"><p>scale</p></td>
2295
<td class="parameter_description"><p> output scale. </p></td>
2296
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
2780
2303
<div class="refsect2">
2978
2501
<div class="refsect2">
2979
<a name="gst-video-info-init"></a><h3>gst_video_info_init ()</h3>
2980
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_info_init (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>);</pre>
2982
Initialize <em class="parameter"><code>info</code></em> with default values.
2984
<div class="variablelist"><table border="0" class="variablelist">
2986
<col align="left" valign="top">
2990
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
2991
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
2997
<div class="refsect2">
2998
<a name="gst-video-info-set-format"></a><h3>gst_video_info_set_format ()</h3>
2999
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_info_set_format (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3000
<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>,
3001
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
3002
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
3004
Set the default info for a video frame of <em class="parameter"><code>format</code></em> and <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>.
3006
<div class="variablelist"><table border="0" class="variablelist">
3008
<col align="left" valign="top">
3013
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3014
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3018
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
3022
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
3026
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
3033
<div class="refsect2">
3034
<a name="gst-video-info-from-caps"></a><h3>gst_video_info_from_caps ()</h3>
3035
<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_info_from_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3036
<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>);</pre>
3038
Parse <em class="parameter"><code>caps</code></em> and update <em class="parameter"><code>info</code></em>.
3040
<div class="variablelist"><table border="0" class="variablelist">
3042
<col align="left" valign="top">
3047
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3048
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3052
<td><p><span class="term"><em class="parameter"><code>caps</code></em> :</span></p></td>
3053
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>
3057
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3058
<td>TRUE if <em class="parameter"><code>caps</code></em> could be parsed</td>
3064
<div class="refsect2">
3065
<a name="gst-video-info-to-caps"></a><h3>gst_video_info_to_caps ()</h3>
3066
<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_info_to_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>);</pre>
3068
Convert the values of <em class="parameter"><code>info</code></em> into a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>.
3070
<div class="variablelist"><table border="0" class="variablelist">
3072
<col align="left" valign="top">
3077
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3078
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3082
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3083
<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> containing the info of <em class="parameter"><code>info</code></em>.</td>
3089
<div class="refsect2">
3090
<a name="gst-video-info-convert"></a><h3>gst_video_info_convert ()</h3>
3091
<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_info_convert (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3092
<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>,
3093
<em class="parameter"><code><span class="type">gint64</span> src_value</code></em>,
3094
<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>,
3095
<em class="parameter"><code><span class="type">gint64</span> *dest_value</code></em>);</pre>
3097
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
2502
<a name="gst-video-info-init"></a><h3>gst_video_info_init ()</h3>
2503
<pre class="programlisting"><span class="returnvalue">void</span>
2504
gst_video_info_init (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>);</pre>
2505
<p>Initialize <em class="parameter"><code>info</code></em>
2506
with default values.</p>
2507
<div class="refsect3">
2508
<a name="id-1.2.14.3.8.88.5"></a><h4>Parameters</h4>
2509
<div class="informaltable"><table width="100%" border="0">
2511
<col width="150px" class="parameters_name">
2512
<col class="parameters_description">
2513
<col width="200px" class="parameters_annotations">
2516
<td class="parameter_name"><p>info</p></td>
2517
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2518
<td class="parameter_annotations"> </td>
2524
<div class="refsect2">
2525
<a name="gst-video-info-set-format"></a><h3>gst_video_info_set_format ()</h3>
2526
<pre class="programlisting"><span class="returnvalue">void</span>
2527
gst_video_info_set_format (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2528
<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>,
2529
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
2530
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
2531
<p>Set the default info for a video frame of <em class="parameter"><code>format</code></em>
2532
and <em class="parameter"><code>width</code></em>
2533
and <em class="parameter"><code>height</code></em>
2535
<div class="refsect3">
2536
<a name="id-1.2.14.3.8.89.5"></a><h4>Parameters</h4>
2537
<div class="informaltable"><table width="100%" border="0">
2539
<col width="150px" class="parameters_name">
2540
<col class="parameters_description">
2541
<col width="200px" class="parameters_annotations">
2545
<td class="parameter_name"><p>info</p></td>
2546
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2547
<td class="parameter_annotations"> </td>
2550
<td class="parameter_name"><p>format</p></td>
2551
<td class="parameter_description"><p>the format</p></td>
2552
<td class="parameter_annotations"> </td>
2555
<td class="parameter_name"><p>width</p></td>
2556
<td class="parameter_description"><p>a width</p></td>
2557
<td class="parameter_annotations"> </td>
2560
<td class="parameter_name"><p>height</p></td>
2561
<td class="parameter_description"><p>a height</p></td>
2562
<td class="parameter_annotations"> </td>
2569
<div class="refsect2">
2570
<a name="gst-video-info-from-caps"></a><h3>gst_video_info_from_caps ()</h3>
2571
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2572
gst_video_info_from_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2573
<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>);</pre>
2574
<p>Parse <em class="parameter"><code>caps</code></em>
2575
and update <em class="parameter"><code>info</code></em>
2577
<div class="refsect3">
2578
<a name="id-1.2.14.3.8.90.5"></a><h4>Parameters</h4>
2579
<div class="informaltable"><table width="100%" border="0">
2581
<col width="150px" class="parameters_name">
2582
<col class="parameters_description">
2583
<col width="200px" class="parameters_annotations">
2587
<td class="parameter_name"><p>info</p></td>
2588
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2589
<td class="parameter_annotations"> </td>
2592
<td class="parameter_name"><p>caps</p></td>
2593
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a></p></td>
2594
<td class="parameter_annotations"> </td>
2599
<div class="refsect3">
2600
<a name="id-1.2.14.3.8.90.6"></a><h4>Returns</h4>
2601
<p> TRUE if <em class="parameter"><code>caps</code></em>
2607
<div class="refsect2">
2608
<a name="gst-video-info-to-caps"></a><h3>gst_video_info_to_caps ()</h3>
2609
<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> *
2610
gst_video_info_to_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>);</pre>
2611
<p>Convert the values of <em class="parameter"><code>info</code></em>
2612
into a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>.</p>
2613
<div class="refsect3">
2614
<a name="id-1.2.14.3.8.91.5"></a><h4>Parameters</h4>
2615
<div class="informaltable"><table width="100%" border="0">
2617
<col width="150px" class="parameters_name">
2618
<col class="parameters_description">
2619
<col width="200px" class="parameters_annotations">
2622
<td class="parameter_name"><p>info</p></td>
2623
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2624
<td class="parameter_annotations"> </td>
2628
<div class="refsect3">
2629
<a name="id-1.2.14.3.8.91.6"></a><h4>Returns</h4>
2630
<p> a new <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> containing the info of <em class="parameter"><code>info</code></em>
2636
<div class="refsect2">
2637
<a name="gst-video-info-convert"></a><h3>gst_video_info_convert ()</h3>
2638
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2639
gst_video_info_convert (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2640
<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>,
2641
<em class="parameter"><code><span class="type">gint64</span> src_value</code></em>,
2642
<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>,
2643
<em class="parameter"><code><span class="type">gint64</span> *dest_value</code></em>);</pre>
2644
<p>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
3098
2645
GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
3099
2646
raw video, GST_FORMAT_DEFAULT corresponds to video frames. This
3100
function can be used to handle pad queries of the type GST_QUERY_CONVERT.
3102
<div class="variablelist"><table border="0" class="variablelist">
3104
<col align="left" valign="top">
3109
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3110
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3114
<td><p><span class="term"><em class="parameter"><code>src_format</code></em> :</span></p></td>
3116
<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>
3120
<td><p><span class="term"><em class="parameter"><code>src_value</code></em> :</span></p></td>
3121
<td>value to convert</td>
3124
<td><p><span class="term"><em class="parameter"><code>dest_format</code></em> :</span></p></td>
3126
<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>
3130
<td><p><span class="term"><em class="parameter"><code>dest_value</code></em> :</span></p></td>
3131
<td>pointer to destination value</td>
3134
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3135
<td>TRUE if the conversion was successful.</td>
3141
<div class="refsect2">
3142
<a name="gst-video-info-is-equal"></a><h3>gst_video_info_is_equal ()</h3>
3143
<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_info_is_equal (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3144
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *other</code></em>);</pre>
3146
Compares two <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> and returns whether they are equal or not
3148
<div class="variablelist"><table border="0" class="variablelist">
3150
<col align="left" valign="top">
3155
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3156
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3160
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
3161
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3165
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3167
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>info</code></em> and <em class="parameter"><code>other</code></em> are equal, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
3173
<div class="refsect2">
3174
<a name="gst-video-info-align"></a><h3>gst_video_info_align ()</h3>
3175
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_info_align (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3176
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a> *align</code></em>);</pre>
3178
Adjust the offset and stride fields in <em class="parameter"><code>info</code></em> so that the padding and
3179
stride alignment in <em class="parameter"><code>align</code></em> is respected.
3182
Extra padding will be added to the right side when stride alignment padding
3183
is required and <em class="parameter"><code>align</code></em> will be updated with the new padding values.
3185
<div class="variablelist"><table border="0" class="variablelist">
3187
<col align="left" valign="top">
3192
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3193
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3197
<td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
3198
<td>alignment parameters</td>
3204
<div class="refsect2">
3205
<a name="GstVideoFrame"></a><h3>struct GstVideoFrame</h3>
3206
<pre class="programlisting">struct GstVideoFrame {
3208
GstVideoFrameFlags flags;
3214
gpointer data[GST_VIDEO_MAX_PLANES];
3215
GstMapInfo map[GST_VIDEO_MAX_PLANES];
3219
A video frame obtained from <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-map" title="gst_video_frame_map ()"><code class="function">gst_video_frame_map()</code></a>
3221
<div class="variablelist"><table border="0" class="variablelist">
3223
<col align="left" valign="top">
3228
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> <em class="structfield"><code><a name="GstVideoFrame.info"></a>info</code></em>;</span></p></td>
3229
<td>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3233
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrameFlags" title="enum GstVideoFrameFlags"><span class="type">GstVideoFrameFlags</span></a> <em class="structfield"><code><a name="GstVideoFrame.flags"></a>flags</code></em>;</span></p></td>
3237
<td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *<em class="structfield"><code><a name="GstVideoFrame.buffer"></a>buffer</code></em>;</span></p></td>
3238
<td>the mapped buffer</td>
3241
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GstVideoFrame.meta"></a>meta</code></em>;</span></p></td>
3242
<td>pointer to metadata if any</td>
3245
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoFrame.id"></a>id</code></em>;</span></p></td>
3246
<td>id of the mapped frame. the id can for example be used to
3247
indentify the frame in case of multiview video.</td>
3250
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GstVideoFrame.data"></a>data</code></em>[GST_VIDEO_MAX_PLANES];</span></p></td>
3251
<td>pointers to the plane data</td>
3254
<td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapInfo"><span class="type">GstMapInfo</span></a> <em class="structfield"><code><a name="GstVideoFrame.map"></a>map</code></em>[GST_VIDEO_MAX_PLANES];</span></p></td>
3255
<td>mappings of the planes</td>
3261
<div class="refsect2">
3262
<a name="GstVideoFrameFlags"></a><h3>enum GstVideoFrameFlags</h3>
3263
<pre class="programlisting">typedef enum {
3264
GST_VIDEO_FRAME_FLAG_NONE = 0,
3265
GST_VIDEO_FRAME_FLAG_INTERLACED = (1 << 0),
3266
GST_VIDEO_FRAME_FLAG_TFF = (1 << 1),
3267
GST_VIDEO_FRAME_FLAG_RFF = (1 << 2),
3268
GST_VIDEO_FRAME_FLAG_ONEFIELD = (1 << 3)
3269
} GstVideoFrameFlags;
3272
Extra video frame flags
3274
<div class="variablelist"><table border="0" class="variablelist">
3276
<col align="left" valign="top">
3281
<td><p><a name="GST-VIDEO-FRAME-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FRAME_FLAG_NONE</code></span></p></td>
3286
<td><p><a name="GST-VIDEO-FRAME-FLAG-INTERLACED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FRAME_FLAG_INTERLACED</code></span></p></td>
3287
<td>The video frame is interlaced. In mixed
3288
interlace-mode, this flags specifies if the frame is interlace or
3293
<td><p><a name="GST-VIDEO-FRAME-FLAG-TFF:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FRAME_FLAG_TFF</code></span></p></td>
3294
<td>The video frame has the top field first
3298
<td><p><a name="GST-VIDEO-FRAME-FLAG-RFF:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FRAME_FLAG_RFF</code></span></p></td>
3299
<td>The video frame has the repeat flag
3303
<td><p><a name="GST-VIDEO-FRAME-FLAG-ONEFIELD:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_FRAME_FLAG_ONEFIELD</code></span></p></td>
3304
<td>The video frame has one field
3311
<div class="refsect2">
3312
<a name="gst-video-frame-map-id"></a><h3>gst_video_frame_map_id ()</h3>
3313
<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_frame_map_id (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>,
3314
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3315
<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> *buffer</code></em>,
3316
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>,
3317
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);</pre>
3319
Use <em class="parameter"><code>info</code></em> and <em class="parameter"><code>buffer</code></em> to fill in the values of <em class="parameter"><code>frame</code></em> with the video frame
3320
information of frame <em class="parameter"><code>id</code></em>.
3323
When <em class="parameter"><code>id</code></em> is -1, the default frame is mapped. When <em class="parameter"><code>id</code></em> != -1, this function
3324
will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> when there is no GstVideoMeta with that id.
3327
All video planes of <em class="parameter"><code>buffer</code></em> will be mapped and the pointers will be set in
3328
<em class="parameter"><code>frame->data</code></em>.
3330
<div class="variablelist"><table border="0" class="variablelist">
3332
<col align="left" valign="top">
3337
<td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
3338
<td>pointer to <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
3342
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3343
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3347
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
3348
<td>the buffer to map</td>
3351
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
3352
<td>the frame id to map</td>
3355
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
3356
<td><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a></td>
3359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3361
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</td>
3367
<div class="refsect2">
3368
<a name="gst-video-frame-map"></a><h3>gst_video_frame_map ()</h3>
3369
<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_frame_map (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>,
3370
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
3371
<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> *buffer</code></em>,
3372
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);</pre>
3374
Use <em class="parameter"><code>info</code></em> and <em class="parameter"><code>buffer</code></em> to fill in the values of <em class="parameter"><code>frame</code></em>.
3377
All video planes of <em class="parameter"><code>buffer</code></em> will be mapped and the pointers will be set in
3378
<em class="parameter"><code>frame->data</code></em>.
3380
<div class="variablelist"><table border="0" class="variablelist">
3382
<col align="left" valign="top">
3387
<td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
3388
<td>pointer to <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
3392
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
3393
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a>
3397
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
3398
<td>the buffer to map</td>
3401
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
3402
<td><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a></td>
3405
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3407
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</td>
3413
<div class="refsect2">
3414
<a name="gst-video-frame-unmap"></a><h3>gst_video_frame_unmap ()</h3>
3415
<pre class="programlisting"><span class="returnvalue">void</span> gst_video_frame_unmap (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>);</pre>
3417
Unmap the memory previously mapped with gst_video_frame_map.
3419
<div class="variablelist"><table border="0" class="variablelist">
3421
<col align="left" valign="top">
2647
function can be used to handle pad queries of the type GST_QUERY_CONVERT.</p>
2648
<div class="refsect3">
2649
<a name="id-1.2.14.3.8.92.5"></a><h4>Parameters</h4>
2650
<div class="informaltable"><table width="100%" border="0">
2652
<col width="150px" class="parameters_name">
2653
<col class="parameters_description">
2654
<col width="200px" class="parameters_annotations">
2658
<td class="parameter_name"><p>info</p></td>
2659
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2660
<td class="parameter_annotations"> </td>
2663
<td class="parameter_name"><p>src_format</p></td>
2664
<td class="parameter_description"><p><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>
2666
<td class="parameter_annotations"> </td>
2669
<td class="parameter_name"><p>src_value</p></td>
2670
<td class="parameter_description"><p>value to convert</p></td>
2671
<td class="parameter_annotations"> </td>
2674
<td class="parameter_name"><p>dest_format</p></td>
2675
<td class="parameter_description"><p><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>
2677
<td class="parameter_annotations"> </td>
2680
<td class="parameter_name"><p>dest_value</p></td>
2681
<td class="parameter_description"><p>pointer to destination value</p></td>
2682
<td class="parameter_annotations"> </td>
2687
<div class="refsect3">
2688
<a name="id-1.2.14.3.8.92.6"></a><h4>Returns</h4>
2689
<p> TRUE if the conversion was successful.</p>
2694
<div class="refsect2">
2695
<a name="gst-video-info-is-equal"></a><h3>gst_video_info_is_equal ()</h3>
2696
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2697
gst_video_info_is_equal (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2698
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *other</code></em>);</pre>
2699
<p>Compares two <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> and returns whether they are equal or not</p>
2700
<div class="refsect3">
2701
<a name="id-1.2.14.3.8.93.5"></a><h4>Parameters</h4>
2702
<div class="informaltable"><table width="100%" border="0">
2704
<col width="150px" class="parameters_name">
2705
<col class="parameters_description">
2706
<col width="200px" class="parameters_annotations">
2710
<td class="parameter_name"><p>info</p></td>
2711
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2712
<td class="parameter_annotations"> </td>
2715
<td class="parameter_name"><p>other</p></td>
2716
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2717
<td class="parameter_annotations"> </td>
2722
<div class="refsect3">
2723
<a name="id-1.2.14.3.8.93.6"></a><h4>Returns</h4>
2724
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>info</code></em>
2725
and <em class="parameter"><code>other</code></em>
2726
are equal, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
2731
<div class="refsect2">
2732
<a name="gst-video-info-align"></a><h3>gst_video_info_align ()</h3>
2733
<pre class="programlisting"><span class="returnvalue">void</span>
2734
gst_video_info_align (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2735
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoAlignment" title="struct GstVideoAlignment"><span class="type">GstVideoAlignment</span></a> *align</code></em>);</pre>
2736
<p>Adjust the offset and stride fields in <em class="parameter"><code>info</code></em>
2737
so that the padding and
2738
stride alignment in <em class="parameter"><code>align</code></em>
2740
<p>Extra padding will be added to the right side when stride alignment padding
2741
is required and <em class="parameter"><code>align</code></em>
2742
will be updated with the new padding values.</p>
2743
<div class="refsect3">
2744
<a name="id-1.2.14.3.8.94.6"></a><h4>Parameters</h4>
2745
<div class="informaltable"><table width="100%" border="0">
2747
<col width="150px" class="parameters_name">
2748
<col class="parameters_description">
2749
<col width="200px" class="parameters_annotations">
2753
<td class="parameter_name"><p>info</p></td>
2754
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2755
<td class="parameter_annotations"> </td>
2758
<td class="parameter_name"><p>align</p></td>
2759
<td class="parameter_description"><p>alignment parameters</p></td>
2760
<td class="parameter_annotations"> </td>
2767
<div class="refsect2">
2768
<a name="gst-video-frame-map-id"></a><h3>gst_video_frame_map_id ()</h3>
2769
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2770
gst_video_frame_map_id (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>,
2771
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2772
<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> *buffer</code></em>,
2773
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>,
2774
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);</pre>
2775
<p>Use <em class="parameter"><code>info</code></em>
2776
and <em class="parameter"><code>buffer</code></em>
2777
to fill in the values of <em class="parameter"><code>frame</code></em>
2778
with the video frame
2779
information of frame <em class="parameter"><code>id</code></em>
2781
<p>When <em class="parameter"><code>id</code></em>
2782
is -1, the default frame is mapped. When <em class="parameter"><code>id</code></em>
2783
!= -1, this function
2784
will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> when there is no GstVideoMeta with that id.</p>
2785
<p>All video planes of <em class="parameter"><code>buffer</code></em>
2786
will be mapped and the pointers will be set in
2787
<em class="parameter"><code>frame->data</code></em>
2789
<div class="refsect3">
2790
<a name="id-1.2.14.3.8.95.7"></a><h4>Parameters</h4>
2791
<div class="informaltable"><table width="100%" border="0">
2793
<col width="150px" class="parameters_name">
2794
<col class="parameters_description">
2795
<col width="200px" class="parameters_annotations">
2799
<td class="parameter_name"><p>frame</p></td>
2800
<td class="parameter_description"><p>pointer to <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2801
<td class="parameter_annotations"> </td>
2804
<td class="parameter_name"><p>info</p></td>
2805
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2806
<td class="parameter_annotations"> </td>
2809
<td class="parameter_name"><p>buffer</p></td>
2810
<td class="parameter_description"><p>the buffer to map</p></td>
2811
<td class="parameter_annotations"> </td>
2814
<td class="parameter_name"><p>id</p></td>
2815
<td class="parameter_description"><p>the frame id to map</p></td>
2816
<td class="parameter_annotations"> </td>
2819
<td class="parameter_name"><p>flags</p></td>
2820
<td class="parameter_description"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a></p></td>
2821
<td class="parameter_annotations"> </td>
2826
<div class="refsect3">
2827
<a name="id-1.2.14.3.8.95.8"></a><h4>Returns</h4>
2828
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
2833
<div class="refsect2">
2834
<a name="gst-video-frame-map"></a><h3>gst_video_frame_map ()</h3>
2835
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2836
gst_video_frame_map (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>,
2837
<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> *info</code></em>,
2838
<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> *buffer</code></em>,
2839
<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a> flags</code></em>);</pre>
2840
<p>Use <em class="parameter"><code>info</code></em>
2841
and <em class="parameter"><code>buffer</code></em>
2842
to fill in the values of <em class="parameter"><code>frame</code></em>
2844
<p>All video planes of <em class="parameter"><code>buffer</code></em>
2845
will be mapped and the pointers will be set in
2846
<em class="parameter"><code>frame->data</code></em>
2848
<div class="refsect3">
2849
<a name="id-1.2.14.3.8.96.6"></a><h4>Parameters</h4>
2850
<div class="informaltable"><table width="100%" border="0">
2852
<col width="150px" class="parameters_name">
2853
<col class="parameters_description">
2854
<col width="200px" class="parameters_annotations">
2858
<td class="parameter_name"><p>frame</p></td>
2859
<td class="parameter_description"><p>pointer to <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2860
<td class="parameter_annotations"> </td>
2863
<td class="parameter_name"><p>info</p></td>
2864
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
2865
<td class="parameter_annotations"> </td>
2868
<td class="parameter_name"><p>buffer</p></td>
2869
<td class="parameter_description"><p>the buffer to map</p></td>
2870
<td class="parameter_annotations"> </td>
2873
<td class="parameter_name"><p>flags</p></td>
2874
<td class="parameter_description"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapFlags"><span class="type">GstMapFlags</span></a></p></td>
2875
<td class="parameter_annotations"> </td>
2880
<div class="refsect3">
2881
<a name="id-1.2.14.3.8.96.7"></a><h4>Returns</h4>
2882
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success.</p>
2887
<div class="refsect2">
2888
<a name="gst-video-frame-unmap"></a><h3>gst_video_frame_unmap ()</h3>
2889
<pre class="programlisting"><span class="returnvalue">void</span>
2890
gst_video_frame_unmap (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *frame</code></em>);</pre>
2891
<p>Unmap the memory previously mapped with gst_video_frame_map.</p>
2892
<div class="refsect3">
2893
<a name="id-1.2.14.3.8.97.5"></a><h4>Parameters</h4>
2894
<div class="informaltable"><table width="100%" border="0">
2896
<col width="150px" class="parameters_name">
2897
<col class="parameters_description">
2898
<col width="200px" class="parameters_annotations">
3425
<td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
3426
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
2901
<td class="parameter_name"><p>frame</p></td>
2902
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2903
<td class="parameter_annotations"> </td>
3432
<div class="refsect2">
3433
<a name="gst-video-frame-copy"></a><h3>gst_video_frame_copy ()</h3>
3434
<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_frame_copy (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *dest</code></em>,
3435
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *src</code></em>);</pre>
3437
Copy the contents from <em class="parameter"><code>src</code></em> to <em class="parameter"><code>dest</code></em>.
3439
<div class="variablelist"><table border="0" class="variablelist">
3441
<col align="left" valign="top">
3446
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
3447
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
3451
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
3452
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
3456
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3457
<td>TRUE if the contents could be copied.</td>
3463
<div class="refsect2">
3464
<a name="gst-video-frame-copy-plane"></a><h3>gst_video_frame_copy_plane ()</h3>
3465
<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_frame_copy_plane (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *dest</code></em>,
3466
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *src</code></em>,
3467
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);</pre>
3469
Copy the plane with index <em class="parameter"><code>plane</code></em> from <em class="parameter"><code>src</code></em> to <em class="parameter"><code>dest</code></em>.
3471
<div class="variablelist"><table border="0" class="variablelist">
3473
<col align="left" valign="top">
3478
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
3479
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
3483
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
3484
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a>
3488
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
3492
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3493
<td>TRUE if the contents could be copied.</td>
2909
<div class="refsect2">
2910
<a name="gst-video-frame-copy"></a><h3>gst_video_frame_copy ()</h3>
2911
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2912
gst_video_frame_copy (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *dest</code></em>,
2913
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *src</code></em>);</pre>
2914
<p>Copy the contents from <em class="parameter"><code>src</code></em>
2915
to <em class="parameter"><code>dest</code></em>
2917
<div class="refsect3">
2918
<a name="id-1.2.14.3.8.98.5"></a><h4>Parameters</h4>
2919
<div class="informaltable"><table width="100%" border="0">
2921
<col width="150px" class="parameters_name">
2922
<col class="parameters_description">
2923
<col width="200px" class="parameters_annotations">
2927
<td class="parameter_name"><p>dest</p></td>
2928
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2929
<td class="parameter_annotations"> </td>
2932
<td class="parameter_name"><p>src</p></td>
2933
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2934
<td class="parameter_annotations"> </td>
2939
<div class="refsect3">
2940
<a name="id-1.2.14.3.8.98.6"></a><h4>Returns</h4>
2941
<p> TRUE if the contents could be copied.</p>
2946
<div class="refsect2">
2947
<a name="gst-video-frame-copy-plane"></a><h3>gst_video_frame_copy_plane ()</h3>
2948
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
2949
gst_video_frame_copy_plane (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *dest</code></em>,
2950
<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *src</code></em>,
2951
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> plane</code></em>);</pre>
2952
<p>Copy the plane with index <em class="parameter"><code>plane</code></em>
2953
from <em class="parameter"><code>src</code></em>
2954
to <em class="parameter"><code>dest</code></em>
2956
<div class="refsect3">
2957
<a name="id-1.2.14.3.8.99.5"></a><h4>Parameters</h4>
2958
<div class="informaltable"><table width="100%" border="0">
2960
<col width="150px" class="parameters_name">
2961
<col class="parameters_description">
2962
<col width="200px" class="parameters_annotations">
2966
<td class="parameter_name"><p>dest</p></td>
2967
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2968
<td class="parameter_annotations"> </td>
2971
<td class="parameter_name"><p>src</p></td>
2972
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a></p></td>
2973
<td class="parameter_annotations"> </td>
2976
<td class="parameter_name"><p>plane</p></td>
2977
<td class="parameter_description"><p>a plane</p></td>
2978
<td class="parameter_annotations"> </td>
2983
<div class="refsect3">
2984
<a name="id-1.2.14.3.8.99.6"></a><h4>Returns</h4>
2985
<p> TRUE if the contents could be copied.</p>
3499
2990
<div class="refsect2">
3639
3130
<pre class="programlisting">#define GST_VIDEO_FRAME_COMP_POFFSET(f,c) GST_VIDEO_INFO_COMP_POFFSET(&(f)->info,(c))
3134
<div class="refsect1">
3135
<a name="gst-plugins-base-libs-gstvideo.other_details"></a><h2>Types and Values</h2>
3136
<div class="refsect2">
3137
<a name="GstVideoAlignment"></a><h3>struct GstVideoAlignment</h3>
3138
<pre class="programlisting">struct GstVideoAlignment {
3140
guint padding_bottom;
3142
guint padding_right;
3143
guint stride_align[GST_VIDEO_MAX_PLANES];
3146
<p>Extra alignment paramters for the memory of video buffers. This
3147
structure is usually used to configure the bufferpool if it supports the
3148
<span class="type">GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT</span>.</p>
3149
<div class="refsect3">
3150
<a name="id-1.2.14.3.9.2.5"></a><h4>Members</h4>
3151
<div class="informaltable"><table width="100%" border="0">
3153
<col width="300px" class="struct_members_name">
3154
<col class="struct_members_description">
3155
<col width="200px" class="struct_members_annotations">
3159
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-top"></a>padding_top</code></em>;</p></td>
3160
<td class="struct_member_description"><p>extra pixels on the top</p></td>
3161
<td class="struct_member_annotations"> </td>
3164
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-bottom"></a>padding_bottom</code></em>;</p></td>
3165
<td class="struct_member_description"><p>extra pixels on the bottom</p></td>
3166
<td class="struct_member_annotations"> </td>
3169
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-left"></a>padding_left</code></em>;</p></td>
3170
<td class="struct_member_description"><p>extra pixels on the left side</p></td>
3171
<td class="struct_member_annotations"> </td>
3174
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.padding-right"></a>padding_right</code></em>;</p></td>
3175
<td class="struct_member_description"><p>extra pixels on the right side</p></td>
3176
<td class="struct_member_annotations"> </td>
3179
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoAlignment.stride-align"></a>stride_align</code></em>[GST_VIDEO_MAX_PLANES];</p></td>
3180
<td class="struct_member_description"><p>array with extra alignment requirements for the strides</p></td>
3181
<td class="struct_member_annotations"> </td>
3188
<div class="refsect2">
3189
<a name="GST-META-TAG-VIDEO-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_STR</h3>
3190
<pre class="programlisting">#define GST_META_TAG_VIDEO_STR "video"
3192
<p>This metadata is relevant for video streams.</p>
3193
<p class="since">Since 1.2</p>
3196
<div class="refsect2">
3197
<a name="GST-META-TAG-VIDEO-ORIENTATION-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_ORIENTATION_STR</h3>
3198
<pre class="programlisting">#define GST_META_TAG_VIDEO_ORIENTATION_STR "orientation"
3200
<p>This metadata stays relevant as long as video orientation is unchanged.</p>
3201
<p class="since">Since 1.2</p>
3204
<div class="refsect2">
3205
<a name="GST-META-TAG-VIDEO-SIZE-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_SIZE_STR</h3>
3206
<pre class="programlisting">#define GST_META_TAG_VIDEO_SIZE_STR "size"
3208
<p>This metadata stays relevant as long as video size is unchanged.</p>
3209
<p class="since">Since 1.2</p>
3212
<div class="refsect2">
3213
<a name="GST-META-TAG-VIDEO-COLORSPACE-STR:CAPS"></a><h3>GST_META_TAG_VIDEO_COLORSPACE_STR</h3>
3214
<pre class="programlisting">#define GST_META_TAG_VIDEO_COLORSPACE_STR "colorspace"
3216
<p>This metadata stays relevant as long as video colorspace is unchanged.</p>
3217
<p class="since">Since 1.2</p>
3220
<div class="refsect2">
3221
<a name="GstVideoFormat"></a><h3>enum GstVideoFormat</h3>
3222
<p>Enum value describing the most common video formats.</p>
3223
<div class="refsect3">
3224
<a name="id-1.2.14.3.9.7.4"></a><h4>Members</h4>
3225
<div class="informaltable"><table width="100%" border="0">
3227
<col width="300px" class="enum_members_name">
3228
<col class="enum_members_description">
3229
<col width="200px" class="enum_members_annotations">
3233
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-UNKNOWN:CAPS"></a>GST_VIDEO_FORMAT_UNKNOWN</p></td>
3234
<td class="enum_member_description">
3235
<p>Unknown or unset video format id</p>
3237
<td class="enum_member_annotations"> </td>
3240
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-ENCODED:CAPS"></a>GST_VIDEO_FORMAT_ENCODED</p></td>
3241
<td class="enum_member_description">
3242
<p>Encoded video format</p>
3244
<td class="enum_member_annotations"> </td>
3247
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-I420:CAPS"></a>GST_VIDEO_FORMAT_I420</p></td>
3248
<td class="enum_member_description">
3249
<p>planar 4:2:0 YUV</p>
3251
<td class="enum_member_annotations"> </td>
3254
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-YV12:CAPS"></a>GST_VIDEO_FORMAT_YV12</p></td>
3255
<td class="enum_member_description">
3256
<p>planar 4:2:0 YVU (like I420 but UV planes swapped)</p>
3258
<td class="enum_member_annotations"> </td>
3261
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-YUY2:CAPS"></a>GST_VIDEO_FORMAT_YUY2</p></td>
3262
<td class="enum_member_description">
3263
<p>packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)</p>
3265
<td class="enum_member_annotations"> </td>
3268
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-UYVY:CAPS"></a>GST_VIDEO_FORMAT_UYVY</p></td>
3269
<td class="enum_member_description">
3270
<p>packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)</p>
3272
<td class="enum_member_annotations"> </td>
3275
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-AYUV:CAPS"></a>GST_VIDEO_FORMAT_AYUV</p></td>
3276
<td class="enum_member_description">
3277
<p>packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)</p>
3279
<td class="enum_member_annotations"> </td>
3282
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-RGBx"></a>GST_VIDEO_FORMAT_RGBx</p></td>
3283
<td class="enum_member_description">
3284
<p>sparse rgb packed into 32 bit, space last</p>
3286
<td class="enum_member_annotations"> </td>
3289
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-BGRx"></a>GST_VIDEO_FORMAT_BGRx</p></td>
3290
<td class="enum_member_description">
3291
<p>sparse reverse rgb packed into 32 bit, space last</p>
3293
<td class="enum_member_annotations"> </td>
3296
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-xRGB"></a>GST_VIDEO_FORMAT_xRGB</p></td>
3297
<td class="enum_member_description">
3298
<p>sparse rgb packed into 32 bit, space first</p>
3300
<td class="enum_member_annotations"> </td>
3303
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-xBGR"></a>GST_VIDEO_FORMAT_xBGR</p></td>
3304
<td class="enum_member_description">
3305
<p>sparse reverse rgb packed into 32 bit, space first</p>
3307
<td class="enum_member_annotations"> </td>
3310
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-RGBA:CAPS"></a>GST_VIDEO_FORMAT_RGBA</p></td>
3311
<td class="enum_member_description">
3312
<p>rgb with alpha channel last</p>
3314
<td class="enum_member_annotations"> </td>
3317
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-BGRA:CAPS"></a>GST_VIDEO_FORMAT_BGRA</p></td>
3318
<td class="enum_member_description">
3319
<p>reverse rgb with alpha channel last</p>
3321
<td class="enum_member_annotations"> </td>
3324
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-ARGB:CAPS"></a>GST_VIDEO_FORMAT_ARGB</p></td>
3325
<td class="enum_member_description">
3326
<p>rgb with alpha channel first</p>
3328
<td class="enum_member_annotations"> </td>
3331
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-ABGR:CAPS"></a>GST_VIDEO_FORMAT_ABGR</p></td>
3332
<td class="enum_member_description">
3333
<p>reverse rgb with alpha channel first</p>
3335
<td class="enum_member_annotations"> </td>
3338
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-RGB:CAPS"></a>GST_VIDEO_FORMAT_RGB</p></td>
3339
<td class="enum_member_description">
3342
<td class="enum_member_annotations"> </td>
3345
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-BGR:CAPS"></a>GST_VIDEO_FORMAT_BGR</p></td>
3346
<td class="enum_member_description">
3349
<td class="enum_member_annotations"> </td>
3352
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-Y41B:CAPS"></a>GST_VIDEO_FORMAT_Y41B</p></td>
3353
<td class="enum_member_description">
3354
<p>planar 4:1:1 YUV</p>
3356
<td class="enum_member_annotations"> </td>
3359
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-Y42B:CAPS"></a>GST_VIDEO_FORMAT_Y42B</p></td>
3360
<td class="enum_member_description">
3361
<p>planar 4:2:2 YUV</p>
3363
<td class="enum_member_annotations"> </td>
3366
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-YVYU:CAPS"></a>GST_VIDEO_FORMAT_YVYU</p></td>
3367
<td class="enum_member_description">
3368
<p>packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)</p>
3370
<td class="enum_member_annotations"> </td>
3373
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-Y444:CAPS"></a>GST_VIDEO_FORMAT_Y444</p></td>
3374
<td class="enum_member_description">
3375
<p>planar 4:4:4 YUV</p>
3377
<td class="enum_member_annotations"> </td>
3380
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-v210"></a>GST_VIDEO_FORMAT_v210</p></td>
3381
<td class="enum_member_description">
3382
<p>packed 4:2:2 10-bit YUV, complex format</p>
3384
<td class="enum_member_annotations"> </td>
3387
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-v216"></a>GST_VIDEO_FORMAT_v216</p></td>
3388
<td class="enum_member_description">
3389
<p>packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order</p>
3391
<td class="enum_member_annotations"> </td>
3394
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-NV12:CAPS"></a>GST_VIDEO_FORMAT_NV12</p></td>
3395
<td class="enum_member_description">
3396
<p>planar 4:2:0 YUV with interleaved UV plane</p>
3398
<td class="enum_member_annotations"> </td>
3401
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-NV21:CAPS"></a>GST_VIDEO_FORMAT_NV21</p></td>
3402
<td class="enum_member_description">
3403
<p>planar 4:2:0 YUV with interleaved VU plane</p>
3405
<td class="enum_member_annotations"> </td>
3408
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-GRAY8:CAPS"></a>GST_VIDEO_FORMAT_GRAY8</p></td>
3409
<td class="enum_member_description">
3410
<p>8-bit grayscale</p>
3412
<td class="enum_member_annotations"> </td>
3415
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-GRAY16-BE:CAPS"></a>GST_VIDEO_FORMAT_GRAY16_BE</p></td>
3416
<td class="enum_member_description">
3417
<p>16-bit grayscale, most significant byte first</p>
3419
<td class="enum_member_annotations"> </td>
3422
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-GRAY16-LE:CAPS"></a>GST_VIDEO_FORMAT_GRAY16_LE</p></td>
3423
<td class="enum_member_description">
3424
<p>16-bit grayscale, least significant byte first</p>
3426
<td class="enum_member_annotations"> </td>
3429
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-v308"></a>GST_VIDEO_FORMAT_v308</p></td>
3430
<td class="enum_member_description">
3431
<p>packed 4:4:4 YUV</p>
3433
<td class="enum_member_annotations"> </td>
3436
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-RGB16:CAPS"></a>GST_VIDEO_FORMAT_RGB16</p></td>
3437
<td class="enum_member_description">
3438
<p>rgb 5-6-5 bits per component</p>
3440
<td class="enum_member_annotations"> </td>
3443
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-BGR16:CAPS"></a>GST_VIDEO_FORMAT_BGR16</p></td>
3444
<td class="enum_member_description">
3445
<p>reverse rgb 5-6-5 bits per component</p>
3447
<td class="enum_member_annotations"> </td>
3450
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-RGB15:CAPS"></a>GST_VIDEO_FORMAT_RGB15</p></td>
3451
<td class="enum_member_description">
3452
<p>rgb 5-5-5 bits per component</p>
3454
<td class="enum_member_annotations"> </td>
3457
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-BGR15:CAPS"></a>GST_VIDEO_FORMAT_BGR15</p></td>
3458
<td class="enum_member_description">
3459
<p>reverse rgb 5-5-5 bits per component</p>
3461
<td class="enum_member_annotations"> </td>
3464
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-UYVP:CAPS"></a>GST_VIDEO_FORMAT_UYVP</p></td>
3465
<td class="enum_member_description">
3466
<p>packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)</p>
3468
<td class="enum_member_annotations"> </td>
3471
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-A420:CAPS"></a>GST_VIDEO_FORMAT_A420</p></td>
3472
<td class="enum_member_description">
3473
<p>planar 4:4:2:0 AYUV</p>
3475
<td class="enum_member_annotations"> </td>
3478
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-RGB8P:CAPS"></a>GST_VIDEO_FORMAT_RGB8P</p></td>
3479
<td class="enum_member_description">
3480
<p>8-bit paletted RGB</p>
3482
<td class="enum_member_annotations"> </td>
3485
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-YUV9:CAPS"></a>GST_VIDEO_FORMAT_YUV9</p></td>
3486
<td class="enum_member_description">
3487
<p>planar 4:1:0 YUV</p>
3489
<td class="enum_member_annotations"> </td>
3492
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-YVU9:CAPS"></a>GST_VIDEO_FORMAT_YVU9</p></td>
3493
<td class="enum_member_description">
3494
<p>planar 4:1:0 YUV (like YUV9 but UV planes swapped)</p>
3496
<td class="enum_member_annotations"> </td>
3499
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-IYU1:CAPS"></a>GST_VIDEO_FORMAT_IYU1</p></td>
3500
<td class="enum_member_description">
3501
<p>packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)</p>
3503
<td class="enum_member_annotations"> </td>
3506
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-ARGB64:CAPS"></a>GST_VIDEO_FORMAT_ARGB64</p></td>
3507
<td class="enum_member_description">
3508
<p>rgb with alpha channel first, 16 bits per channel</p>
3510
<td class="enum_member_annotations"> </td>
3513
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-AYUV64:CAPS"></a>GST_VIDEO_FORMAT_AYUV64</p></td>
3514
<td class="enum_member_description">
3515
<p>packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)</p>
3517
<td class="enum_member_annotations"> </td>
3520
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-r210"></a>GST_VIDEO_FORMAT_r210</p></td>
3521
<td class="enum_member_description">
3522
<p>packed 4:4:4 RGB, 10 bits per channel</p>
3524
<td class="enum_member_annotations"> </td>
3527
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-I420-10BE:CAPS"></a>GST_VIDEO_FORMAT_I420_10BE</p></td>
3528
<td class="enum_member_description">
3529
<p>planar 4:2:0 YUV, 10 bits per channel</p>
3531
<td class="enum_member_annotations"> </td>
3534
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-I420-10LE:CAPS"></a>GST_VIDEO_FORMAT_I420_10LE</p></td>
3535
<td class="enum_member_description">
3536
<p>planar 4:2:0 YUV, 10 bits per channel</p>
3538
<td class="enum_member_annotations"> </td>
3541
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-I422-10BE:CAPS"></a>GST_VIDEO_FORMAT_I422_10BE</p></td>
3542
<td class="enum_member_description">
3543
<p>planar 4:2:2 YUV, 10 bits per channel</p>
3545
<td class="enum_member_annotations"> </td>
3548
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-I422-10LE:CAPS"></a>GST_VIDEO_FORMAT_I422_10LE</p></td>
3549
<td class="enum_member_description">
3550
<p>planar 4:2:2 YUV, 10 bits per channel</p>
3552
<td class="enum_member_annotations"> </td>
3555
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-Y444-10BE:CAPS"></a>GST_VIDEO_FORMAT_Y444_10BE</p></td>
3556
<td class="enum_member_description">
3557
<p>planar 4:4:4 YUV, 10 bits per channel</p>
3559
<td class="enum_member_annotations"> </td>
3562
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-Y444-10LE:CAPS"></a>GST_VIDEO_FORMAT_Y444_10LE</p></td>
3563
<td class="enum_member_description">
3564
<p>planar 4:4:4 YUV, 10 bits per channel</p>
3566
<td class="enum_member_annotations"> </td>
3569
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-GBR:CAPS"></a>GST_VIDEO_FORMAT_GBR</p></td>
3570
<td class="enum_member_description">
3571
<p>planar 4:4:4 RGB, 8 bits per channel</p>
3573
<td class="enum_member_annotations"> </td>
3576
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-GBR-10BE:CAPS"></a>GST_VIDEO_FORMAT_GBR_10BE</p></td>
3577
<td class="enum_member_description">
3578
<p>planar 4:4:4 RGB, 10 bits per channel</p>
3580
<td class="enum_member_annotations"> </td>
3583
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-GBR-10LE:CAPS"></a>GST_VIDEO_FORMAT_GBR_10LE</p></td>
3584
<td class="enum_member_description">
3585
<p>planar 4:4:4 RGB, 10 bits per channel</p>
3587
<td class="enum_member_annotations"> </td>
3590
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-NV16:CAPS"></a>GST_VIDEO_FORMAT_NV16</p></td>
3591
<td class="enum_member_description">
3592
<p>planar 4:2:2 YUV with interleaved UV plane</p>
3594
<td class="enum_member_annotations"> </td>
3597
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-NV24:CAPS"></a>GST_VIDEO_FORMAT_NV24</p></td>
3598
<td class="enum_member_description">
3599
<p>planar 4:4:4 YUV with interleaved UV plane</p>
3601
<td class="enum_member_annotations"> </td>
3608
<div class="refsect2">
3609
<a name="GST-VIDEO-MAX-PLANES:CAPS"></a><h3>GST_VIDEO_MAX_PLANES</h3>
3610
<pre class="programlisting">#define GST_VIDEO_MAX_PLANES 4
3614
<div class="refsect2">
3615
<a name="GST-VIDEO-MAX-COMPONENTS:CAPS"></a><h3>GST_VIDEO_MAX_COMPONENTS</h3>
3616
<pre class="programlisting">#define GST_VIDEO_MAX_COMPONENTS 4
3620
<div class="refsect2">
3621
<a name="GstVideoFormatInfo"></a><h3>struct GstVideoFormatInfo</h3>
3622
<pre class="programlisting">struct GstVideoFormatInfo {
3623
GstVideoFormat format;
3625
const gchar *description;
3626
GstVideoFormatFlags flags;
3629
guint shift[GST_VIDEO_MAX_COMPONENTS];
3630
guint depth[GST_VIDEO_MAX_COMPONENTS];
3631
gint pixel_stride[GST_VIDEO_MAX_COMPONENTS];
3633
guint plane[GST_VIDEO_MAX_COMPONENTS];
3634
guint poffset[GST_VIDEO_MAX_COMPONENTS];
3635
guint w_sub[GST_VIDEO_MAX_COMPONENTS];
3636
guint h_sub[GST_VIDEO_MAX_COMPONENTS];
3638
GstVideoFormat unpack_format;
3639
GstVideoFormatUnpack unpack_func;
3641
GstVideoFormatPack pack_func;
3643
gpointer _gst_reserved[GST_PADDING];
3646
<p>Information for a video format.</p>
3647
<div class="refsect3">
3648
<a name="id-1.2.14.3.9.10.5"></a><h4>Members</h4>
3649
<div class="informaltable"><table width="100%" border="0">
3651
<col width="300px" class="struct_members_name">
3652
<col class="struct_members_description">
3653
<col width="200px" class="struct_members_annotations">
3657
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.format"></a>format</code></em>;</p></td>
3658
<td class="struct_member_description"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a></p></td>
3659
<td class="struct_member_annotations"> </td>
3662
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstVideoFormatInfo.name"></a>name</code></em>;</p></td>
3663
<td class="struct_member_description"><p>string representation of the format</p></td>
3664
<td class="struct_member_annotations"> </td>
3667
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GstVideoFormatInfo.description"></a>description</code></em>;</p></td>
3668
<td class="struct_member_description"><p>use readable description of the format</p></td>
3669
<td class="struct_member_annotations"> </td>
3672
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatFlags" title="enum GstVideoFormatFlags"><span class="type">GstVideoFormatFlags</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.flags"></a>flags</code></em>;</p></td>
3673
<td class="struct_member_description"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatFlags" title="enum GstVideoFormatFlags"><span class="type">GstVideoFormatFlags</span></a></p></td>
3674
<td class="struct_member_annotations"> </td>
3677
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.bits"></a>bits</code></em>;</p></td>
3678
<td class="struct_member_description"><p>The number of bits used to pack data items. This can be less than 8
3679
when multiple pixels are stored in a byte. for values > 8 multiple bytes
3680
should be read according to the endianness flag before applying the shift
3682
<td class="struct_member_annotations"> </td>
3685
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.n-components"></a>n_components</code></em>;</p></td>
3686
<td class="struct_member_description"><p>the number of components in the video format.</p></td>
3687
<td class="struct_member_annotations"> </td>
3690
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.shift"></a>shift</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3691
<td class="struct_member_description"><p>the number of bits to shift away to get the component data</p></td>
3692
<td class="struct_member_annotations"> </td>
3695
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.depth"></a>depth</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3696
<td class="struct_member_description"><p>the depth in bits for each component</p></td>
3697
<td class="struct_member_annotations"> </td>
3700
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.pixel-stride"></a>pixel_stride</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3701
<td class="struct_member_description"><p>the pixel stride of each component. This is the amount of
3702
bytes to the pixel immediately to the right. When bits < 8, the stride is
3703
expressed in bits. For 24-bit RGB, this would be 3 bytes, for example,
3704
while it would be 4 bytes for RGBx or ARGB.</p></td>
3705
<td class="struct_member_annotations"> </td>
3708
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.n-planes"></a>n_planes</code></em>;</p></td>
3709
<td class="struct_member_description"><p>the number of planes for this format. The number of planes can be
3710
less than the amount of components when multiple components are packed into
3712
<td class="struct_member_annotations"> </td>
3715
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.plane"></a>plane</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3716
<td class="struct_member_description"><p>the plane number where a component can be found</p></td>
3717
<td class="struct_member_annotations"> </td>
3720
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.poffset"></a>poffset</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3721
<td class="struct_member_description"><p>the offset in the plane where the first pixel of the components
3722
can be found.</p></td>
3723
<td class="struct_member_annotations"> </td>
3726
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.w-sub"></a>w_sub</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3727
<td class="struct_member_description"><p>subsampling factor of the width for the component. Use
3728
GST_VIDEO_SUB_SCALE to scale a width.</p></td>
3729
<td class="struct_member_annotations"> </td>
3732
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.h-sub"></a>h_sub</code></em>[GST_VIDEO_MAX_COMPONENTS];</p></td>
3733
<td class="struct_member_description"><p>subsampling factor of the height for the component. Use
3734
GST_VIDEO_SUB_SCALE to scale a height.</p></td>
3735
<td class="struct_member_annotations"> </td>
3738
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormat" title="enum GstVideoFormat"><span class="type">GstVideoFormat</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.unpack-format"></a>unpack_format</code></em>;</p></td>
3739
<td class="struct_member_description"><p>the format of the unpacked pixels. This format must have the
3740
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-FLAG-UNPACK:CAPS"><span class="type">GST_VIDEO_FORMAT_FLAG_UNPACK</span></a> flag set.</p></td>
3741
<td class="struct_member_annotations"> </td>
3744
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatUnpack" title="GstVideoFormatUnpack ()"><span class="type">GstVideoFormatUnpack</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.unpack-func"></a>unpack_func</code></em>;</p></td>
3745
<td class="struct_member_description"><p>an unpack function for this format</p></td>
3746
<td class="struct_member_annotations"> </td>
3749
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.pack-lines"></a>pack_lines</code></em>;</p></td>
3750
<td class="struct_member_description"><p>the amount of lines that will be packed</p></td>
3751
<td class="struct_member_annotations"> </td>
3754
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatPack" title="GstVideoFormatPack ()"><span class="type">GstVideoFormatPack</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.pack-func"></a>pack_func</code></em>;</p></td>
3755
<td class="struct_member_description"><p>an pack function for this format</p></td>
3756
<td class="struct_member_annotations"> </td>
3759
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GstVideoFormatInfo.-gst-reserved"></a>_gst_reserved</code></em>[GST_PADDING];</p></td>
3768
<div class="refsect2">
3769
<a name="GstVideoChromaSite"></a><h3>enum GstVideoChromaSite</h3>
3770
<p>Various Chroma sitings.</p>
3771
<div class="refsect3">
3772
<a name="id-1.2.14.3.9.11.4"></a><h4>Members</h4>
3773
<div class="informaltable"><table width="100%" border="0">
3775
<col width="300px" class="enum_members_name">
3776
<col class="enum_members_description">
3777
<col width="200px" class="enum_members_annotations">
3781
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-UNKNOWN:CAPS"></a>GST_VIDEO_CHROMA_SITE_UNKNOWN</p></td>
3782
<td class="enum_member_description">
3783
<p>unknown cositing</p>
3785
<td class="enum_member_annotations"> </td>
3788
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-NONE:CAPS"></a>GST_VIDEO_CHROMA_SITE_NONE</p></td>
3789
<td class="enum_member_description">
3792
<td class="enum_member_annotations"> </td>
3795
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-H-COSITED:CAPS"></a>GST_VIDEO_CHROMA_SITE_H_COSITED</p></td>
3796
<td class="enum_member_description">
3797
<p>chroma is horizontally cosited</p>
3799
<td class="enum_member_annotations"> </td>
3802
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-V-COSITED:CAPS"></a>GST_VIDEO_CHROMA_SITE_V_COSITED</p></td>
3803
<td class="enum_member_description">
3804
<p>chroma is vertically cosited</p>
3806
<td class="enum_member_annotations"> </td>
3809
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-ALT-LINE:CAPS"></a>GST_VIDEO_CHROMA_SITE_ALT_LINE</p></td>
3810
<td class="enum_member_description">
3811
<p>choma samples are sited on alternate lines</p>
3813
<td class="enum_member_annotations"> </td>
3816
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-COSITED:CAPS"></a>GST_VIDEO_CHROMA_SITE_COSITED</p></td>
3817
<td class="enum_member_description">
3818
<p>chroma samples cosited with luma samples</p>
3820
<td class="enum_member_annotations"> </td>
3823
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-JPEG:CAPS"></a>GST_VIDEO_CHROMA_SITE_JPEG</p></td>
3824
<td class="enum_member_description">
3825
<p>jpeg style cositing, also for mpeg1 and mjpeg</p>
3827
<td class="enum_member_annotations"> </td>
3830
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-MPEG2:CAPS"></a>GST_VIDEO_CHROMA_SITE_MPEG2</p></td>
3831
<td class="enum_member_description">
3832
<p>mpeg2 style cositing</p>
3834
<td class="enum_member_annotations"> </td>
3837
<td class="enum_member_name"><p><a name="GST-VIDEO-CHROMA-SITE-DV:CAPS"></a>GST_VIDEO_CHROMA_SITE_DV</p></td>
3838
<td class="enum_member_description">
3839
<p>DV style cositing</p>
3841
<td class="enum_member_annotations"> </td>
3848
<div class="refsect2">
3849
<a name="GstVideoFormatFlags"></a><h3>enum GstVideoFormatFlags</h3>
3850
<p>The different video flags that a format info can have.</p>
3851
<div class="refsect3">
3852
<a name="id-1.2.14.3.9.12.4"></a><h4>Members</h4>
3853
<div class="informaltable"><table width="100%" border="0">
3855
<col width="300px" class="enum_members_name">
3856
<col class="enum_members_description">
3857
<col width="200px" class="enum_members_annotations">
3861
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-YUV:CAPS"></a>GST_VIDEO_FORMAT_FLAG_YUV</p></td>
3862
<td class="enum_member_description">
3863
<p>The video format is YUV, components are numbered
3866
<td class="enum_member_annotations"> </td>
3869
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-RGB:CAPS"></a>GST_VIDEO_FORMAT_FLAG_RGB</p></td>
3870
<td class="enum_member_description">
3871
<p>The video format is RGB, components are numbered
3874
<td class="enum_member_annotations"> </td>
3877
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-GRAY:CAPS"></a>GST_VIDEO_FORMAT_FLAG_GRAY</p></td>
3878
<td class="enum_member_description">
3879
<p>The video is gray, there is one gray component
3882
<td class="enum_member_annotations"> </td>
3885
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-ALPHA:CAPS"></a>GST_VIDEO_FORMAT_FLAG_ALPHA</p></td>
3886
<td class="enum_member_description">
3887
<p>The video format has an alpha components with
3890
<td class="enum_member_annotations"> </td>
3893
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-LE:CAPS"></a>GST_VIDEO_FORMAT_FLAG_LE</p></td>
3894
<td class="enum_member_description">
3895
<p>The video format has data stored in little
3898
<td class="enum_member_annotations"> </td>
3901
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-PALETTE:CAPS"></a>GST_VIDEO_FORMAT_FLAG_PALETTE</p></td>
3902
<td class="enum_member_description">
3903
<p>The video format has a palette. The palette
3904
is stored in the second plane and indexes are stored in the first plane.</p>
3906
<td class="enum_member_annotations"> </td>
3909
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-COMPLEX:CAPS"></a>GST_VIDEO_FORMAT_FLAG_COMPLEX</p></td>
3910
<td class="enum_member_description">
3911
<p>The video format has a complex layout that
3912
can't be described with the usual information in the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a>.</p>
3914
<td class="enum_member_annotations"> </td>
3917
<td class="enum_member_name"><p><a name="GST-VIDEO-FORMAT-FLAG-UNPACK:CAPS"></a>GST_VIDEO_FORMAT_FLAG_UNPACK</p></td>
3918
<td class="enum_member_description">
3919
<p>This format can be used in a
3920
<a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatUnpack" title="GstVideoFormatUnpack ()"><span class="type">GstVideoFormatUnpack</span></a> and <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatPack" title="GstVideoFormatPack ()"><span class="type">GstVideoFormatPack</span></a> function.</p>
3922
<td class="enum_member_annotations"> </td>
3929
<div class="refsect2">
3930
<a name="GstVideoPackFlags"></a><h3>enum GstVideoPackFlags</h3>
3931
<p>The different flags that can be used when packing and unpacking.</p>
3932
<div class="refsect3">
3933
<a name="id-1.2.14.3.9.13.4"></a><h4>Members</h4>
3934
<div class="informaltable"><table width="100%" border="0">
3936
<col width="300px" class="enum_members_name">
3937
<col class="enum_members_description">
3938
<col width="200px" class="enum_members_annotations">
3942
<td class="enum_member_name"><p><a name="GST-VIDEO-PACK-FLAG-NONE:CAPS"></a>GST_VIDEO_PACK_FLAG_NONE</p></td>
3943
<td class="enum_member_description">
3946
<td class="enum_member_annotations"> </td>
3949
<td class="enum_member_name"><p><a name="GST-VIDEO-PACK-FLAG-TRUNCATE-RANGE:CAPS"></a>GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE</p></td>
3950
<td class="enum_member_description">
3951
<p>When the source has a smaller depth
3952
than the target format, set the least significant bits of the target
3953
to 0. This is likely sightly faster but less accurate. When this flag
3954
is not specified, the most significant bits of the source are duplicated
3955
in the least significant bits of the destination.</p>
3957
<td class="enum_member_annotations"> </td>
3960
<td class="enum_member_name"><p><a name="GST-VIDEO-PACK-FLAG-INTERLACED:CAPS"></a>GST_VIDEO_PACK_FLAG_INTERLACED</p></td>
3961
<td class="enum_member_description">
3962
<p>The source is interlaced. The unpacked
3963
format will be interlaced as well with each line containing
3964
information from alternating fields. (Since 1.2)</p>
3966
<td class="enum_member_annotations"> </td>
3973
<div class="refsect2">
3974
<a name="GST-VIDEO-SIZE-RANGE:CAPS"></a><h3>GST_VIDEO_SIZE_RANGE</h3>
3975
<pre class="programlisting">#define GST_VIDEO_SIZE_RANGE "(int) [ 1, max ]"
3979
<div class="refsect2">
3980
<a name="GST-VIDEO-FPS-RANGE:CAPS"></a><h3>GST_VIDEO_FPS_RANGE</h3>
3981
<pre class="programlisting">#define GST_VIDEO_FPS_RANGE "(fraction) [ 0, max ]"
3985
<div class="refsect2">
3986
<a name="GST-VIDEO-FORMATS-ALL:CAPS"></a><h3>GST_VIDEO_FORMATS_ALL</h3>
3987
<pre class="programlisting">#define GST_VIDEO_FORMATS_ALL</pre>
3990
<div class="refsect2">
3991
<a name="GstVideoColorRange"></a><h3>enum GstVideoColorRange</h3>
3992
<p>Possible color range values. These constants are defined for 8 bit color
3993
values and can be scaled for other bit depths.</p>
3994
<div class="refsect3">
3995
<a name="id-1.2.14.3.9.17.4"></a><h4>Members</h4>
3996
<div class="informaltable"><table width="100%" border="0">
3998
<col width="300px" class="enum_members_name">
3999
<col class="enum_members_description">
4000
<col width="200px" class="enum_members_annotations">
4004
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-RANGE-UNKNOWN:CAPS"></a>GST_VIDEO_COLOR_RANGE_UNKNOWN</p></td>
4005
<td class="enum_member_description">
4006
<p>unknown range</p>
4008
<td class="enum_member_annotations"> </td>
4011
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-RANGE-0-255:CAPS"></a>GST_VIDEO_COLOR_RANGE_0_255</p></td>
4012
<td class="enum_member_description">
4013
<p>[0..255] for 8 bit components</p>
4015
<td class="enum_member_annotations"> </td>
4018
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-RANGE-16-235:CAPS"></a>GST_VIDEO_COLOR_RANGE_16_235</p></td>
4019
<td class="enum_member_description">
4020
<p>[16..235] for 8 bit components. Chroma has
4021
[16..240] range.</p>
4023
<td class="enum_member_annotations"> </td>
4030
<div class="refsect2">
4031
<a name="GstVideoColorMatrix"></a><h3>enum GstVideoColorMatrix</h3>
4032
<p>The color matrix is used to convert between Y'PbPr and
4033
non-linear RGB (R'G'B')</p>
4034
<div class="refsect3">
4035
<a name="id-1.2.14.3.9.18.4"></a><h4>Members</h4>
4036
<div class="informaltable"><table width="100%" border="0">
4038
<col width="300px" class="enum_members_name">
4039
<col class="enum_members_description">
4040
<col width="200px" class="enum_members_annotations">
4044
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-MATRIX-UNKNOWN:CAPS"></a>GST_VIDEO_COLOR_MATRIX_UNKNOWN</p></td>
4045
<td class="enum_member_description">
4046
<p>unknown matrix</p>
4048
<td class="enum_member_annotations"> </td>
4051
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-MATRIX-RGB:CAPS"></a>GST_VIDEO_COLOR_MATRIX_RGB</p></td>
4052
<td class="enum_member_description">
4053
<p>identity matrix</p>
4055
<td class="enum_member_annotations"> </td>
4058
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-MATRIX-FCC:CAPS"></a>GST_VIDEO_COLOR_MATRIX_FCC</p></td>
4059
<td class="enum_member_description">
4060
<p>FCC color matrix</p>
4062
<td class="enum_member_annotations"> </td>
4065
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-MATRIX-BT709:CAPS"></a>GST_VIDEO_COLOR_MATRIX_BT709</p></td>
4066
<td class="enum_member_description">
4067
<p>ITU-R BT.709 color matrix</p>
4069
<td class="enum_member_annotations"> </td>
4072
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-MATRIX-BT601:CAPS"></a>GST_VIDEO_COLOR_MATRIX_BT601</p></td>
4073
<td class="enum_member_description">
4074
<p>ITU-R BT.601 color matrix</p>
4076
<td class="enum_member_annotations"> </td>
4079
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-MATRIX-SMPTE240M:CAPS"></a>GST_VIDEO_COLOR_MATRIX_SMPTE240M</p></td>
4080
<td class="enum_member_description">
4081
<p>SMPTE 240M color matrix</p>
4083
<td class="enum_member_annotations"> </td>
4090
<div class="refsect2">
4091
<a name="GstVideoTransferFunction"></a><h3>enum GstVideoTransferFunction</h3>
4092
<p>The video transfer function defines the formula for converting between
4093
non-linear RGB (R'G'B') and linear RGB</p>
4094
<div class="refsect3">
4095
<a name="id-1.2.14.3.9.19.4"></a><h4>Members</h4>
4096
<div class="informaltable"><table width="100%" border="0">
4098
<col width="300px" class="enum_members_name">
4099
<col class="enum_members_description">
4100
<col width="200px" class="enum_members_annotations">
4104
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-UNKNOWN:CAPS"></a>GST_VIDEO_TRANSFER_UNKNOWN</p></td>
4105
<td class="enum_member_description">
4106
<p>unknown transfer function</p>
4108
<td class="enum_member_annotations"> </td>
4111
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-GAMMA10:CAPS"></a>GST_VIDEO_TRANSFER_GAMMA10</p></td>
4112
<td class="enum_member_description">
4113
<p>linear RGB, gamma 1.0 curve</p>
4115
<td class="enum_member_annotations"> </td>
4118
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-GAMMA18:CAPS"></a>GST_VIDEO_TRANSFER_GAMMA18</p></td>
4119
<td class="enum_member_description">
4120
<p>Gamma 1.8 curve</p>
4122
<td class="enum_member_annotations"> </td>
4125
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-GAMMA20:CAPS"></a>GST_VIDEO_TRANSFER_GAMMA20</p></td>
4126
<td class="enum_member_description">
4127
<p>Gamma 2.0 curve</p>
4129
<td class="enum_member_annotations"> </td>
4132
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-GAMMA22:CAPS"></a>GST_VIDEO_TRANSFER_GAMMA22</p></td>
4133
<td class="enum_member_description">
4134
<p>Gamma 2.2 curve</p>
4136
<td class="enum_member_annotations"> </td>
4139
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-BT709:CAPS"></a>GST_VIDEO_TRANSFER_BT709</p></td>
4140
<td class="enum_member_description">
4141
<p>Gamma 2.2 curve with a linear segment in the lower
4144
<td class="enum_member_annotations"> </td>
4147
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-SMPTE240M:CAPS"></a>GST_VIDEO_TRANSFER_SMPTE240M</p></td>
4148
<td class="enum_member_description">
4149
<p>Gamma 2.2 curve with a linear segment in the
4152
<td class="enum_member_annotations"> </td>
4155
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-SRGB:CAPS"></a>GST_VIDEO_TRANSFER_SRGB</p></td>
4156
<td class="enum_member_description">
4157
<p>Gamma 2.4 curve with a linear segment in the lower
4160
<td class="enum_member_annotations"> </td>
4163
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-GAMMA28:CAPS"></a>GST_VIDEO_TRANSFER_GAMMA28</p></td>
4164
<td class="enum_member_description">
4165
<p>Gamma 2.8 curve</p>
4167
<td class="enum_member_annotations"> </td>
4170
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-LOG100:CAPS"></a>GST_VIDEO_TRANSFER_LOG100</p></td>
4171
<td class="enum_member_description">
4172
<p>Logarithmic transfer characteristic
4175
<td class="enum_member_annotations"> </td>
4178
<td class="enum_member_name"><p><a name="GST-VIDEO-TRANSFER-LOG316:CAPS"></a>GST_VIDEO_TRANSFER_LOG316</p></td>
4179
<td class="enum_member_description">
4180
<p>Logarithmic transfer characteristic
4181
316.22777:1 range</p>
4183
<td class="enum_member_annotations"> </td>
4190
<div class="refsect2">
4191
<a name="GstVideoColorPrimaries"></a><h3>enum GstVideoColorPrimaries</h3>
4192
<p>The color primaries define the how to transform linear RGB values to and from
4193
the CIE XYZ colorspace.</p>
4194
<div class="refsect3">
4195
<a name="id-1.2.14.3.9.20.4"></a><h4>Members</h4>
4196
<div class="informaltable"><table width="100%" border="0">
4198
<col width="300px" class="enum_members_name">
4199
<col class="enum_members_description">
4200
<col width="200px" class="enum_members_annotations">
4204
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-UNKNOWN:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_UNKNOWN</p></td>
4205
<td class="enum_member_description">
4206
<p>unknown color primaries</p>
4208
<td class="enum_member_annotations"> </td>
4211
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-BT709:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_BT709</p></td>
4212
<td class="enum_member_description">
4213
<p>BT709 primaries</p>
4215
<td class="enum_member_annotations"> </td>
4218
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-BT470M:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_BT470M</p></td>
4219
<td class="enum_member_description">
4220
<p>BT470M primaries</p>
4222
<td class="enum_member_annotations"> </td>
4225
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-BT470BG:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_BT470BG</p></td>
4226
<td class="enum_member_description">
4227
<p>BT470BG primaries</p>
4229
<td class="enum_member_annotations"> </td>
4232
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-SMPTE170M:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_SMPTE170M</p></td>
4233
<td class="enum_member_description">
4234
<p>SMPTE170M primaries</p>
4236
<td class="enum_member_annotations"> </td>
4239
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-SMPTE240M:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_SMPTE240M</p></td>
4240
<td class="enum_member_description">
4241
<p>SMPTE240M primaries</p>
4243
<td class="enum_member_annotations"> </td>
4246
<td class="enum_member_name"><p><a name="GST-VIDEO-COLOR-PRIMARIES-FILM:CAPS"></a>GST_VIDEO_COLOR_PRIMARIES_FILM</p></td>
4247
<td class="enum_member_description">
4250
<td class="enum_member_annotations"> </td>
4257
<div class="refsect2">
4258
<a name="GstVideoColorimetry"></a><h3>GstVideoColorimetry</h3>
4259
<pre class="programlisting">typedef struct {
4260
GstVideoColorRange range;
4261
GstVideoColorMatrix matrix;
4262
GstVideoTransferFunction transfer;
4263
GstVideoColorPrimaries primaries;
4264
} GstVideoColorimetry;
4266
<p>Structure describing the color info.</p>
4267
<div class="refsect3">
4268
<a name="id-1.2.14.3.9.21.5"></a><h4>Members</h4>
4269
<div class="informaltable"><table width="100%" border="0">
4271
<col width="300px" class="struct_members_name">
4272
<col class="struct_members_description">
4273
<col width="200px" class="struct_members_annotations">
4277
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorRange" title="enum GstVideoColorRange"><span class="type">GstVideoColorRange</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.range"></a>range</code></em>;</p></td>
4278
<td class="struct_member_description"><p>the color range. This is the valid range for the samples.
4279
It is used to convert the samples to Y'PbPr values.</p></td>
4280
<td class="struct_member_annotations"> </td>
4283
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorMatrix" title="enum GstVideoColorMatrix"><span class="type">GstVideoColorMatrix</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.matrix"></a>matrix</code></em>;</p></td>
4284
<td class="struct_member_description"><p>the color matrix. Used to convert between Y'PbPr and
4285
non-linear RGB (R'G'B')</p></td>
4286
<td class="struct_member_annotations"> </td>
4289
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoTransferFunction" title="enum GstVideoTransferFunction"><span class="type">GstVideoTransferFunction</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.transfer"></a>transfer</code></em>;</p></td>
4290
<td class="struct_member_description"><p>the transfer function. used to convert between R'G'B' and RGB</p></td>
4291
<td class="struct_member_annotations"> </td>
4294
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorPrimaries" title="enum GstVideoColorPrimaries"><span class="type">GstVideoColorPrimaries</span></a> <em class="structfield"><code><a name="GstVideoColorimetry.primaries"></a>primaries</code></em>;</p></td>
4295
<td class="struct_member_description"><p>color primaries. used to convert between R'G'B' and CIE XYZ</p></td>
4296
<td class="struct_member_annotations"> </td>
4303
<div class="refsect2">
4304
<a name="GstVideoInfo"></a><h3>struct GstVideoInfo</h3>
4305
<pre class="programlisting">struct GstVideoInfo {
4306
const GstVideoFormatInfo *finfo;
4308
GstVideoInterlaceMode interlace_mode;
4309
GstVideoFlags flags;
4315
GstVideoChromaSite chroma_site;
4316
GstVideoColorimetry colorimetry;
4323
gsize offset[GST_VIDEO_MAX_PLANES];
4324
gint stride[GST_VIDEO_MAX_PLANES];
4327
<p>Information describing image properties. This information can be filled
4328
in from GstCaps with <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-info-from-caps" title="gst_video_info_from_caps ()"><code class="function">gst_video_info_from_caps()</code></a>. The information is also used
4329
to store the specific video info when mapping a video frame with
4330
<a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-map" title="gst_video_frame_map ()"><code class="function">gst_video_frame_map()</code></a>.</p>
4331
<p>Use the provided macros to access the info in this structure.</p>
4332
<div class="refsect3">
4333
<a name="id-1.2.14.3.9.22.6"></a><h4>Members</h4>
4334
<div class="informaltable"><table width="100%" border="0">
4336
<col width="300px" class="struct_members_name">
4337
<col class="struct_members_description">
4338
<col width="200px" class="struct_members_annotations">
4342
<td class="struct_member_name"><p>const <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFormatInfo" title="struct GstVideoFormatInfo"><span class="type">GstVideoFormatInfo</span></a> *<em class="structfield"><code><a name="GstVideoInfo.finfo"></a>finfo</code></em>;</p></td>
4343
<td class="struct_member_description"><p>the format info of the video</p></td>
4344
<td class="struct_member_annotations"> </td>
4347
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInterlaceMode" title="enum GstVideoInterlaceMode"><span class="type">GstVideoInterlaceMode</span></a> <em class="structfield"><code><a name="GstVideoInfo.interlace-mode"></a>interlace_mode</code></em>;</p></td>
4348
<td class="struct_member_description"><p>the interlace mode</p></td>
4349
<td class="struct_member_annotations"> </td>
4352
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFlags" title="enum GstVideoFlags"><span class="type">GstVideoFlags</span></a> <em class="structfield"><code><a name="GstVideoInfo.flags"></a>flags</code></em>;</p></td>
4353
<td class="struct_member_description"><p>additional video flags</p></td>
4354
<td class="struct_member_annotations"> </td>
4357
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.width"></a>width</code></em>;</p></td>
4358
<td class="struct_member_description"><p>the width of the video</p></td>
4359
<td class="struct_member_annotations"> </td>
4362
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.height"></a>height</code></em>;</p></td>
4363
<td class="struct_member_description"><p>the height of the video</p></td>
4364
<td class="struct_member_annotations"> </td>
4367
<td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="GstVideoInfo.size"></a>size</code></em>;</p></td>
4368
<td class="struct_member_description"><p>the default size of one frame</p></td>
4369
<td class="struct_member_annotations"> </td>
4372
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.views"></a>views</code></em>;</p></td>
4373
<td class="struct_member_description"><p>the number of views for multiview video</p></td>
4374
<td class="struct_member_annotations"> </td>
4377
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a> <em class="structfield"><code><a name="GstVideoInfo.chroma-site"></a>chroma_site</code></em>;</p></td>
4378
<td class="struct_member_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoChromaSite" title="enum GstVideoChromaSite"><span class="type">GstVideoChromaSite</span></a>.</p></td>
4379
<td class="struct_member_annotations"> </td>
4382
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoColorimetry" title="GstVideoColorimetry"><span class="type">GstVideoColorimetry</span></a> <em class="structfield"><code><a name="GstVideoInfo.colorimetry"></a>colorimetry</code></em>;</p></td>
4383
<td class="struct_member_description"><p>the colorimetry info</p></td>
4384
<td class="struct_member_annotations"> </td>
4387
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.par-n"></a>par_n</code></em>;</p></td>
4388
<td class="struct_member_description"><p>the pixel-aspect-ratio numerator</p></td>
4389
<td class="struct_member_annotations"> </td>
4392
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.par-d"></a>par_d</code></em>;</p></td>
4393
<td class="struct_member_description"><p>the pixel-aspect-ratio demnominator</p></td>
4394
<td class="struct_member_annotations"> </td>
4397
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.fps-n"></a>fps_n</code></em>;</p></td>
4398
<td class="struct_member_description"><p>the framerate numerator</p></td>
4399
<td class="struct_member_annotations"> </td>
4402
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.fps-d"></a>fps_d</code></em>;</p></td>
4403
<td class="struct_member_description"><p>the framerate demnominator</p></td>
4404
<td class="struct_member_annotations"> </td>
4407
<td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="GstVideoInfo.offset"></a>offset</code></em>[GST_VIDEO_MAX_PLANES];</p></td>
4408
<td class="struct_member_description"><p>offsets of the planes</p></td>
4409
<td class="struct_member_annotations"> </td>
4412
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoInfo.stride"></a>stride</code></em>[GST_VIDEO_MAX_PLANES];</p></td>
4413
<td class="struct_member_description"><p>strides of the planes</p></td>
4414
<td class="struct_member_annotations"> </td>
4421
<div class="refsect2">
4422
<a name="GstVideoInterlaceMode"></a><h3>enum GstVideoInterlaceMode</h3>
4423
<p>The possible values of the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInterlaceMode" title="enum GstVideoInterlaceMode"><span class="type">GstVideoInterlaceMode</span></a> describing the interlace
4424
mode of the stream.</p>
4425
<div class="refsect3">
4426
<a name="id-1.2.14.3.9.23.4"></a><h4>Members</h4>
4427
<div class="informaltable"><table width="100%" border="0">
4429
<col width="300px" class="enum_members_name">
4430
<col class="enum_members_description">
4431
<col width="200px" class="enum_members_annotations">
4435
<td class="enum_member_name"><p><a name="GST-VIDEO-INTERLACE-MODE-PROGRESSIVE:CAPS"></a>GST_VIDEO_INTERLACE_MODE_PROGRESSIVE</p></td>
4436
<td class="enum_member_description">
4437
<p>all frames are progressive</p>
4439
<td class="enum_member_annotations"> </td>
4442
<td class="enum_member_name"><p><a name="GST-VIDEO-INTERLACE-MODE-INTERLEAVED:CAPS"></a>GST_VIDEO_INTERLACE_MODE_INTERLEAVED</p></td>
4443
<td class="enum_member_description">
4444
<p>2 fields are interleaved in one video
4445
frame. Extra buffer flags describe the field order.</p>
4447
<td class="enum_member_annotations"> </td>
4450
<td class="enum_member_name"><p><a name="GST-VIDEO-INTERLACE-MODE-MIXED:CAPS"></a>GST_VIDEO_INTERLACE_MODE_MIXED</p></td>
4451
<td class="enum_member_description">
4452
<p>frames contains both interlaced and
4453
progressive video, the buffer flags describe the frame and fields.</p>
4455
<td class="enum_member_annotations"> </td>
4458
<td class="enum_member_name"><p><a name="GST-VIDEO-INTERLACE-MODE-FIELDS:CAPS"></a>GST_VIDEO_INTERLACE_MODE_FIELDS</p></td>
4459
<td class="enum_member_description">
4460
<p>2 fields are stored in one buffer, use the
4461
frame ID to get access to the required field. For multiview (the
4462
'views' property > 1) the fields of view N can be found at frame ID
4463
(N * 2) and (N * 2) + 1.
4464
Each field has only half the amount of lines as noted in the
4465
height property. This mode requires multiple GstVideoMeta metadata
4466
to describe the fields.</p>
4468
<td class="enum_member_annotations"> </td>
4475
<div class="refsect2">
4476
<a name="GstVideoFlags"></a><h3>enum GstVideoFlags</h3>
4477
<p>Extra video flags</p>
4478
<div class="refsect3">
4479
<a name="id-1.2.14.3.9.24.4"></a><h4>Members</h4>
4480
<div class="informaltable"><table width="100%" border="0">
4482
<col width="300px" class="enum_members_name">
4483
<col class="enum_members_description">
4484
<col width="200px" class="enum_members_annotations">
4488
<td class="enum_member_name"><p><a name="GST-VIDEO-FLAG-NONE:CAPS"></a>GST_VIDEO_FLAG_NONE</p></td>
4489
<td class="enum_member_description">
4492
<td class="enum_member_annotations"> </td>
4495
<td class="enum_member_name"><p><a name="GST-VIDEO-FLAG-VARIABLE-FPS:CAPS"></a>GST_VIDEO_FLAG_VARIABLE_FPS</p></td>
4496
<td class="enum_member_description">
4497
<p>a variable fps is selected, fps_n and fps_d
4498
denote the maximum fps of the video</p>
4500
<td class="enum_member_annotations"> </td>
4503
<td class="enum_member_name"><p><a name="GST-VIDEO-FLAG-PREMULTIPLIED-ALPHA:CAPS"></a>GST_VIDEO_FLAG_PREMULTIPLIED_ALPHA</p></td>
4504
<td class="enum_member_description">
4505
<p>Each color has been scaled by the alpha
4508
<td class="enum_member_annotations"> </td>
4515
<div class="refsect2">
4516
<a name="GstVideoFrame"></a><h3>struct GstVideoFrame</h3>
4517
<pre class="programlisting">struct GstVideoFrame {
4519
GstVideoFrameFlags flags;
4525
gpointer data[GST_VIDEO_MAX_PLANES];
4526
GstMapInfo map[GST_VIDEO_MAX_PLANES];
4529
<p>A video frame obtained from <a class="link" href="gst-plugins-base-libs-gstvideo.html#gst-video-frame-map" title="gst_video_frame_map ()"><code class="function">gst_video_frame_map()</code></a></p>
4530
<div class="refsect3">
4531
<a name="id-1.2.14.3.9.25.5"></a><h4>Members</h4>
4532
<div class="informaltable"><table width="100%" border="0">
4534
<col width="300px" class="struct_members_name">
4535
<col class="struct_members_description">
4536
<col width="200px" class="struct_members_annotations">
4540
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a> <em class="structfield"><code><a name="GstVideoFrame.info"></a>info</code></em>;</p></td>
4541
<td class="struct_member_description"><p>the <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoInfo" title="struct GstVideoInfo"><span class="type">GstVideoInfo</span></a></p></td>
4542
<td class="struct_member_annotations"> </td>
4545
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrameFlags" title="enum GstVideoFrameFlags"><span class="type">GstVideoFrameFlags</span></a> <em class="structfield"><code><a name="GstVideoFrame.flags"></a>flags</code></em>;</p></td>
4550
<td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *<em class="structfield"><code><a name="GstVideoFrame.buffer"></a>buffer</code></em>;</p></td>
4551
<td class="struct_member_description"><p>the mapped buffer</p></td>
4552
<td class="struct_member_annotations"> </td>
4555
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GstVideoFrame.meta"></a>meta</code></em>;</p></td>
4556
<td class="struct_member_description"><p>pointer to metadata if any</p></td>
4557
<td class="struct_member_annotations"> </td>
4560
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GstVideoFrame.id"></a>id</code></em>;</p></td>
4561
<td class="struct_member_description"><p>id of the mapped frame. the id can for example be used to
4562
indentify the frame in case of multiview video.</p></td>
4563
<td class="struct_member_annotations"> </td>
4566
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GstVideoFrame.data"></a>data</code></em>[GST_VIDEO_MAX_PLANES];</p></td>
4567
<td class="struct_member_description"><p>pointers to the plane data</p></td>
4568
<td class="struct_member_annotations"> </td>
4571
<td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMemory.html#GstMapInfo"><span class="type">GstMapInfo</span></a> <em class="structfield"><code><a name="GstVideoFrame.map"></a>map</code></em>[GST_VIDEO_MAX_PLANES];</p></td>
4572
<td class="struct_member_description"><p>mappings of the planes</p></td>
4573
<td class="struct_member_annotations"> </td>
4580
<div class="refsect2">
4581
<a name="GstVideoFrameFlags"></a><h3>enum GstVideoFrameFlags</h3>
4582
<p>Extra video frame flags</p>
4583
<div class="refsect3">
4584
<a name="id-1.2.14.3.9.26.4"></a><h4>Members</h4>
4585
<div class="informaltable"><table width="100%" border="0">
4587
<col width="300px" class="enum_members_name">
4588
<col class="enum_members_description">
4589
<col width="200px" class="enum_members_annotations">
4593
<td class="enum_member_name"><p><a name="GST-VIDEO-FRAME-FLAG-NONE:CAPS"></a>GST_VIDEO_FRAME_FLAG_NONE</p></td>
4594
<td class="enum_member_description">
4597
<td class="enum_member_annotations"> </td>
4600
<td class="enum_member_name"><p><a name="GST-VIDEO-FRAME-FLAG-INTERLACED:CAPS"></a>GST_VIDEO_FRAME_FLAG_INTERLACED</p></td>
4601
<td class="enum_member_description">
4602
<p>The video frame is interlaced. In mixed
4603
interlace-mode, this flags specifies if the frame is interlace or
4606
<td class="enum_member_annotations"> </td>
4609
<td class="enum_member_name"><p><a name="GST-VIDEO-FRAME-FLAG-TFF:CAPS"></a>GST_VIDEO_FRAME_FLAG_TFF</p></td>
4610
<td class="enum_member_description">
4611
<p>The video frame has the top field first</p>
4613
<td class="enum_member_annotations"> </td>
4616
<td class="enum_member_name"><p><a name="GST-VIDEO-FRAME-FLAG-RFF:CAPS"></a>GST_VIDEO_FRAME_FLAG_RFF</p></td>
4617
<td class="enum_member_description">
4618
<p>The video frame has the repeat flag</p>
4620
<td class="enum_member_annotations"> </td>
4623
<td class="enum_member_name"><p><a name="GST-VIDEO-FRAME-FLAG-ONEFIELD:CAPS"></a>GST_VIDEO_FRAME_FLAG_ONEFIELD</p></td>
4624
<td class="enum_member_description">
4625
<p>The video frame has one field</p>
4627
<td class="enum_member_annotations"> </td>
3643
4634
<div class="refsect2">
3644
4635
<a name="GstVideoBufferFlags"></a><h3>enum GstVideoBufferFlags</h3>
3645
<pre class="programlisting">typedef enum {
3646
GST_VIDEO_BUFFER_FLAG_INTERLACED = (GST_BUFFER_FLAG_LAST << 0),
3647
GST_VIDEO_BUFFER_FLAG_TFF = (GST_BUFFER_FLAG_LAST << 1),
3648
GST_VIDEO_BUFFER_FLAG_RFF = (GST_BUFFER_FLAG_LAST << 2),
3649
GST_VIDEO_BUFFER_FLAG_ONEFIELD = (GST_BUFFER_FLAG_LAST << 3),
3651
GST_VIDEO_BUFFER_FLAG_LAST = (GST_BUFFER_FLAG_LAST << 8)
3652
} GstVideoBufferFlags;
3655
Additional video buffer flags.
3657
<div class="variablelist"><table border="0" class="variablelist">
4636
<p>Additional video buffer flags.</p>
4637
<div class="refsect3">
4638
<a name="id-1.2.14.3.9.27.4"></a><h4>Members</h4>
4639
<div class="informaltable"><table width="100%" border="0">
3659
<col align="left" valign="top">
4641
<col width="300px" class="enum_members_name">
4642
<col class="enum_members_description">
4643
<col width="200px" class="enum_members_annotations">
3664
<td><p><a name="GST-VIDEO-BUFFER-FLAG-INTERLACED:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_BUFFER_FLAG_INTERLACED</code></span></p></td>
3665
<td>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. In mixed
4647
<td class="enum_member_name"><p><a name="GST-VIDEO-BUFFER-FLAG-INTERLACED:CAPS"></a>GST_VIDEO_BUFFER_FLAG_INTERLACED</p></td>
4648
<td class="enum_member_description">
4649
<p>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. In mixed
3666
4650
interlace-mode, this flags specifies if the frame is
3667
interlaced or progressive.
4651
interlaced or progressive.</p>
4653
<td class="enum_member_annotations"> </td>
3671
<td><p><a name="GST-VIDEO-BUFFER-FLAG-TFF:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_BUFFER_FLAG_TFF</code></span></p></td>
3672
<td>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
4656
<td class="enum_member_name"><p><a name="GST-VIDEO-BUFFER-FLAG-TFF:CAPS"></a>GST_VIDEO_BUFFER_FLAG_TFF</p></td>
4657
<td class="enum_member_description">
4658
<p>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
3673
4659
in the video frame is the top field. If unset, the
3674
bottom field is first.
4660
bottom field is first.</p>
4662
<td class="enum_member_annotations"> </td>
3678
<td><p><a name="GST-VIDEO-BUFFER-FLAG-RFF:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_BUFFER_FLAG_RFF</code></span></p></td>
3679
<td>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
4665
<td class="enum_member_name"><p><a name="GST-VIDEO-BUFFER-FLAG-RFF:CAPS"></a>GST_VIDEO_BUFFER_FLAG_RFF</p></td>
4666
<td class="enum_member_description">
4667
<p>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
3680
4668
(as defined by the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-TFF:CAPS"><code class="literal">GST_VIDEO_BUFFER_TFF</code></a> flag setting)
4671
<td class="enum_member_annotations"> </td>
3685
<td><p><a name="GST-VIDEO-BUFFER-FLAG-ONEFIELD:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_BUFFER_FLAG_ONEFIELD</code></span></p></td>
3686
<td>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
4674
<td class="enum_member_name"><p><a name="GST-VIDEO-BUFFER-FLAG-ONEFIELD:CAPS"></a>GST_VIDEO_BUFFER_FLAG_ONEFIELD</p></td>
4675
<td class="enum_member_description">
4676
<p>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
3687
4677
first field (as defined by the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideo.html#GST-VIDEO-BUFFER-TFF:CAPS"><code class="literal">GST_VIDEO_BUFFER_TFF</code></a>
3688
flag setting) is to be displayed.
4678
flag setting) is to be displayed.</p>
4680
<td class="enum_member_annotations"> </td>
3692
<td><p><a name="GST-VIDEO-BUFFER-FLAG-LAST:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_BUFFER_FLAG_LAST</code></span></p></td>
4683
<td class="enum_member_name"><p><a name="GST-VIDEO-BUFFER-FLAG-LAST:CAPS"></a>GST_VIDEO_BUFFER_FLAG_LAST</p></td>
3700
4693
<div class="footer">
3702
Generated by GTK-Doc V1.19</div>
4695
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'