~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gstvideo.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>gstvideo</title>
 
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstvideo</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-video.html" title="Video Library">
9
9
<link rel="prev" href="gstreamer-video.html" title="Video Library">
10
10
<link rel="next" href="gst-plugins-base-libs-gstvideometa.html" title="gstvideometa">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="gstreamer-video.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="gstreamer-video.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
21
 
<td><a accesskey="n" href="gst-plugins-base-libs-gstvideometa.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#gst-plugins-base-libs-gstvideo.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-libs-gstvideo.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gst-plugins-base-libs-gstvideo.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-libs-gstvideo.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="gstreamer-video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="gstreamer-video.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="gst-plugins-base-libs-gstvideometa.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
29
26
<div class="refentry">
30
27
<a name="gst-plugins-base-libs-gstvideo"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
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>
35
32
</td>
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 &lt;gst/video/video.h&gt;
42
 
 
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>
70
 
 
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>);
97
 
 
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,
137
 
                                                         c)
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,
139
 
                                                         c)
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,
141
 
                                                         c)
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,
144
 
                                                         c)
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,
146
 
                                                         c)
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,
148
 
                                                         c)
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,
150
 
                                                         c)
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,
152
 
                                                         val)
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,
154
 
                                                         c,
155
 
                                                         w)
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,
157
 
                                                         c,
158
 
                                                         h)
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,
160
 
                                                         planes,
161
 
                                                         comp)
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,
163
 
                                                         strides,
164
 
                                                         comp)
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,
166
 
                                                         offsets,
167
 
                                                         comp)
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)
184
 
 
185
 
 
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>);
200
 
 
201
 
 
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,
223
 
                                                         flag)
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,
225
 
                                                         flag)
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,
227
 
                                                         flag)
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,
230
 
                                                         p)
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,
232
 
                                                         p)
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,
235
 
                                                         c)
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,
237
 
                                                         d,
238
 
                                                         c)
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,
240
 
                                                         c)
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,
242
 
                                                         c)
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,
244
 
                                                         c)
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,
246
 
                                                         c)
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,
248
 
                                                         c)
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,
250
 
                                                         c)
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,
252
 
                                                         c)
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>);
270
 
 
271
 
 
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,
295
 
                                                         fl)
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,
302
 
                                                         p)
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,
304
 
                                                         p)
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,
306
 
                                                         p)
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,
309
 
                                                         c)
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,
311
 
                                                         c)
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,
313
 
                                                         c)
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,
315
 
                                                         c)
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,
317
 
                                                         c)
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,
319
 
                                                         c)
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,
321
 
                                                         c)
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,
323
 
                                                         c)
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,
325
 
                                                         c)
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">
 
38
<colgroup>
 
39
<col width="150px" class="functions_return">
 
40
<col class="functions_name">
 
41
</colgroup>
 
42
<tbody>
 
43
<tr>
 
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>
 
46
</td>
 
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>
 
49
</td>
 
50
</tr>
 
51
<tr>
 
52
<td class="function_type">
 
53
<span class="returnvalue">void</span>
 
54
</td>
 
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>
 
57
</td>
 
58
</tr>
 
59
<tr>
 
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> *
 
62
</td>
 
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>
 
65
</td>
 
66
</tr>
 
67
<tr>
 
68
<td class="function_type">
 
69
<span class="returnvalue">void</span>
 
70
</td>
 
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>
 
73
</td>
 
74
</tr>
 
75
<tr>
 
76
<td class="function_type">
 
77
<span class="returnvalue">void</span>
 
78
</td>
 
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>
 
81
</td>
 
82
</tr>
 
83
<tr>
 
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> *
 
86
</td>
 
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>
 
89
</td>
 
90
</tr>
 
91
<tr>
 
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>
 
94
</td>
 
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>
 
97
</td>
 
98
</tr>
 
99
<tr>
 
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> *
 
102
</td>
 
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>
 
105
</td>
 
106
</tr>
 
107
<tr>
 
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>
 
110
</td>
 
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>
 
113
</td>
 
114
</tr>
 
115
<tr>
 
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> *
 
118
</td>
 
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>
 
121
</td>
 
122
</tr>
 
123
<tr>
 
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>
 
126
</td>
 
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>
 
129
</td>
 
130
</tr>
 
131
<tr>
 
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>
 
134
</td>
 
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>
 
137
</td>
 
138
</tr>
 
139
<tr>
 
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>
 
142
</td>
 
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>
 
145
</td>
 
146
</tr>
 
147
<tr>
 
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> *
 
149
</td>
 
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>
 
152
</td>
 
153
</tr>
 
154
<tr>
 
155
<td class="function_type">
 
156
<span class="returnvalue">void</span>
 
157
</td>
 
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>
 
160
</td>
 
161
</tr>
 
162
<tr>
 
163
<td class="function_type">
 
164
<span class="returnvalue">void</span>
 
165
</td>
 
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>
 
168
</td>
 
169
</tr>
 
170
<tr>
 
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>
 
174
</td>
 
175
</tr>
 
176
<tr>
 
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>
 
180
</td>
 
181
</tr>
 
182
<tr>
 
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>
 
186
</td>
 
187
</tr>
 
188
<tr>
 
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>
 
192
</td>
 
193
</tr>
 
194
<tr>
 
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>
 
198
</td>
 
199
</tr>
 
200
<tr>
 
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>
 
204
</td>
 
205
</tr>
 
206
<tr>
 
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>
 
210
</td>
 
211
</tr>
 
212
<tr>
 
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>
 
216
</td>
 
217
</tr>
 
218
<tr>
 
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>
 
222
</td>
 
223
</tr>
 
224
<tr>
 
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>
 
228
</td>
 
229
</tr>
 
230
<tr>
 
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>
 
234
</td>
 
235
</tr>
 
236
<tr>
 
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>
 
240
</td>
 
241
</tr>
 
242
<tr>
 
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>
 
246
</td>
 
247
</tr>
 
248
<tr>
 
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>
 
252
</td>
 
253
</tr>
 
254
<tr>
 
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>
 
258
</td>
 
259
</tr>
 
260
<tr>
 
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>
 
264
</td>
 
265
</tr>
 
266
<tr>
 
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>
 
270
</td>
 
271
</tr>
 
272
<tr>
 
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>
 
276
</td>
 
277
</tr>
 
278
<tr>
 
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>
 
282
</td>
 
283
</tr>
 
284
<tr>
 
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>
 
288
</td>
 
289
</tr>
 
290
<tr>
 
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>
 
294
</td>
 
295
</tr>
 
296
<tr>
 
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>
 
300
</td>
 
301
</tr>
 
302
<tr>
 
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>
 
306
</td>
 
307
</tr>
 
308
<tr>
 
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>
 
312
</td>
 
313
</tr>
 
314
<tr>
 
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>
 
318
</td>
 
319
</tr>
 
320
<tr>
 
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>
 
324
</td>
 
325
</tr>
 
326
<tr>
 
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>
 
329
</td>
 
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>
 
332
</td>
 
333
</tr>
 
334
<tr>
 
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>
 
337
</td>
 
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>
 
340
</td>
 
341
</tr>
 
342
<tr>
 
343
<td class="function_type">
 
344
<span class="returnvalue">guint32</span>
 
345
</td>
 
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>
 
348
</td>
 
349
</tr>
 
350
<tr>
 
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>
 
353
</td>
 
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>
 
356
</td>
 
357
</tr>
 
358
<tr>
 
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> *
 
360
</td>
 
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>
 
363
</td>
 
364
</tr>
 
365
<tr>
 
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> *
 
367
</td>
 
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>
 
370
</td>
 
371
</tr>
 
372
<tr>
 
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>
 
376
</td>
 
377
</tr>
 
378
<tr>
 
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>
 
381
</td>
 
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>
 
384
</td>
 
385
</tr>
 
386
<tr>
 
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>
 
389
</td>
 
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>
 
392
</td>
 
393
</tr>
 
394
<tr>
 
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> *
 
397
</td>
 
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>
 
400
</td>
 
401
</tr>
 
402
<tr>
 
403
<td class="function_type">
 
404
<span class="returnvalue">void</span>
 
405
</td>
 
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>
 
408
</td>
 
409
</tr>
 
410
<tr>
 
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>
 
414
</td>
 
415
</tr>
 
416
<tr>
 
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>
 
420
</td>
 
421
</tr>
 
422
<tr>
 
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>
 
426
</td>
 
427
</tr>
 
428
<tr>
 
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>
 
432
</td>
 
433
</tr>
 
434
<tr>
 
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>
 
438
</td>
 
439
</tr>
 
440
<tr>
 
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>
 
444
</td>
 
445
</tr>
 
446
<tr>
 
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>
 
450
</td>
 
451
</tr>
 
452
<tr>
 
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>
 
456
</td>
 
457
</tr>
 
458
<tr>
 
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>
 
462
</td>
 
463
</tr>
 
464
<tr>
 
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>
 
468
</td>
 
469
</tr>
 
470
<tr>
 
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>
 
474
</td>
 
475
</tr>
 
476
<tr>
 
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>
 
480
</td>
 
481
</tr>
 
482
<tr>
 
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>
 
486
</td>
 
487
</tr>
 
488
<tr>
 
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>
 
492
</td>
 
493
</tr>
 
494
<tr>
 
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>
 
498
</td>
 
499
</tr>
 
500
<tr>
 
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>
 
504
</td>
 
505
</tr>
 
506
<tr>
 
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>
 
510
</td>
 
511
</tr>
 
512
<tr>
 
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>
 
516
</td>
 
517
</tr>
 
518
<tr>
 
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>
 
522
</td>
 
523
</tr>
 
524
<tr>
 
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>
 
528
</td>
 
529
</tr>
 
530
<tr>
 
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>
 
534
</td>
 
535
</tr>
 
536
<tr>
 
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>
 
540
</td>
 
541
</tr>
 
542
<tr>
 
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>
 
546
</td>
 
547
</tr>
 
548
<tr>
 
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>
 
552
</td>
 
553
</tr>
 
554
<tr>
 
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>
 
558
</td>
 
559
</tr>
 
560
<tr>
 
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>
 
564
</td>
 
565
</tr>
 
566
<tr>
 
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>
 
570
</td>
 
571
</tr>
 
572
<tr>
 
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>
 
576
</td>
 
577
</tr>
 
578
<tr>
 
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>
 
582
</td>
 
583
</tr>
 
584
<tr>
 
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>
 
588
</td>
 
589
</tr>
 
590
<tr>
 
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>
 
594
</td>
 
595
</tr>
 
596
<tr>
 
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>
 
600
</td>
 
601
</tr>
 
602
<tr>
 
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>
 
606
</td>
 
607
</tr>
 
608
<tr>
 
609
<td class="function_type">
 
610
<span class="returnvalue">void</span>
 
611
</td>
 
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>
 
614
</td>
 
615
</tr>
 
616
<tr>
 
617
<td class="function_type">
 
618
<span class="returnvalue">void</span>
 
619
</td>
 
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>
 
622
</td>
 
623
</tr>
 
624
<tr>
 
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>
 
627
</td>
 
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>
 
630
</td>
 
631
</tr>
 
632
<tr>
 
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> *
 
635
</td>
 
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>
 
638
</td>
 
639
</tr>
 
640
<tr>
 
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>
 
643
</td>
 
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>
 
646
</td>
 
647
</tr>
 
648
<tr>
 
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>
 
651
</td>
 
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>
 
654
</td>
 
655
</tr>
 
656
<tr>
 
657
<td class="function_type">
 
658
<span class="returnvalue">void</span>
 
659
</td>
 
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>
 
662
</td>
 
663
</tr>
 
664
<tr>
 
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>
 
667
</td>
 
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>
 
670
</td>
 
671
</tr>
 
672
<tr>
 
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>
 
675
</td>
 
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>
 
678
</td>
 
679
</tr>
 
680
<tr>
 
681
<td class="function_type">
 
682
<span class="returnvalue">void</span>
 
683
</td>
 
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>
 
686
</td>
 
687
</tr>
 
688
<tr>
 
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>
 
691
</td>
 
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>
 
694
</td>
 
695
</tr>
 
696
<tr>
 
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>
 
699
</td>
 
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>
 
702
</td>
 
703
</tr>
 
704
<tr>
 
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>
 
708
</td>
 
709
</tr>
 
710
<tr>
 
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>
 
714
</td>
 
715
</tr>
 
716
<tr>
 
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>
 
720
</td>
 
721
</tr>
 
722
<tr>
 
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>
 
726
</td>
 
727
</tr>
 
728
<tr>
 
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>
 
732
</td>
 
733
</tr>
 
734
<tr>
 
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>
 
738
</td>
 
739
</tr>
 
740
<tr>
 
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>
 
744
</td>
 
745
</tr>
 
746
<tr>
 
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>
 
750
</td>
 
751
</tr>
 
752
<tr>
 
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>
 
756
</td>
 
757
</tr>
 
758
<tr>
 
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>
 
762
</td>
 
763
</tr>
 
764
<tr>
 
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>
 
768
</td>
 
769
</tr>
 
770
<tr>
 
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>
 
774
</td>
 
775
</tr>
 
776
<tr>
 
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>
 
780
</td>
 
781
</tr>
 
782
<tr>
 
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>
 
786
</td>
 
787
</tr>
 
788
<tr>
 
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>
 
792
</td>
 
793
</tr>
 
794
<tr>
 
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>
 
798
</td>
 
799
</tr>
 
800
<tr>
 
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>
 
804
</td>
 
805
</tr>
 
806
<tr>
 
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>
 
810
</td>
 
811
</tr>
 
812
<tr>
 
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>
 
816
</td>
 
817
</tr>
 
818
<tr>
 
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>
 
822
</td>
 
823
</tr>
 
824
<tr>
 
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>
 
828
</td>
 
829
</tr>
 
830
<tr>
 
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>
 
834
</td>
 
835
</tr>
 
836
<tr>
 
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>
 
840
</td>
 
841
</tr>
 
842
<tr>
 
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>
 
846
</td>
 
847
</tr>
 
848
</tbody>
 
849
</table></div>
 
850
</div>
 
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">
 
854
<colgroup>
 
855
<col width="150px" class="name">
 
856
<col class="description">
 
857
</colgroup>
 
858
<tbody>
 
859
<tr>
 
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>
 
862
</tr>
 
863
<tr>
 
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>
 
866
</tr>
 
867
<tr>
 
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>
 
870
</tr>
 
871
<tr>
 
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>
 
874
</tr>
 
875
<tr>
 
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>
 
878
</tr>
 
879
<tr>
 
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>
 
882
</tr>
 
883
<tr>
 
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>
 
886
</tr>
 
887
<tr>
 
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>
 
890
</tr>
 
891
<tr>
 
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>
 
894
</tr>
 
895
<tr>
 
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>
 
898
</tr>
 
899
<tr>
 
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>
 
902
</tr>
 
903
<tr>
 
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>
 
906
</tr>
 
907
<tr>
 
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>
 
910
</tr>
 
911
<tr>
 
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>
 
914
</tr>
 
915
<tr>
 
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>
 
918
</tr>
 
919
<tr>
 
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>
 
922
</tr>
 
923
<tr>
 
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>
 
926
</tr>
 
927
<tr>
 
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>
 
930
</tr>
 
931
<tr>
 
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>
 
934
</tr>
 
935
<tr>
 
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>
 
938
</tr>
 
939
<tr>
 
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>
 
942
</tr>
 
943
<tr>
 
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>
 
946
</tr>
 
947
<tr>
 
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>
 
950
</tr>
 
951
<tr>
 
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>
 
954
</tr>
 
955
<tr>
 
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>
 
958
</tr>
 
959
<tr>
 
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>
 
962
</tr>
 
963
</tbody>
 
964
</table></div>
 
965
</div>
 
966
<div class="refsect1">
 
967
<a name="gst-plugins-base-libs-gstvideo.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
968
<pre class="screen">
 
969
</pre>
 
970
</div>
 
971
<div class="refsect1">
 
972
<a name="gst-plugins-base-libs-gstvideo.includes"></a><h2>Includes</h2>
 
973
<pre class="synopsis">#include &lt;gst/video/video.h&gt;
327
974
</pre>
328
975
</div>
329
976
<div class="refsect1">
330
977
<a name="gst-plugins-base-libs-gstvideo.description"></a><h2>Description</h2>
331
 
<p>
332
 
</p>
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.
337
982
</p>
338
983
</div>
339
 
<p>
340
 
</p>
341
984
</div>
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>
354
 
<p>
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.
358
 
</p>
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">
360
1004
<colgroup>
361
 
<col align="left" valign="top">
362
 
<col>
 
1005
<col width="150px" class="parameters_name">
 
1006
<col class="parameters_description">
 
1007
<col width="200px" class="parameters_annotations">
363
1008
</colgroup>
364
1009
<tbody>
365
1010
<tr>
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>
368
 
</tr>
369
 
<tr>
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>
372
 
</tr>
373
 
<tr>
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>
376
 
</tr>
377
 
<tr>
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>
380
 
</tr>
381
 
<tr>
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>
384
 
</tr>
385
 
<tr>
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>
388
 
</tr>
389
 
<tr>
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>
392
 
</tr>
393
 
<tr>
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>
396
 
</tr>
397
 
<tr>
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>
 
1014
</tr>
 
1015
<tr>
 
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>
 
1019
</tr>
 
1020
<tr>
 
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>
 
1024
</tr>
 
1025
<tr>
 
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>
 
1029
</tr>
 
1030
<tr>
 
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>
 
1034
</tr>
 
1035
<tr>
 
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>
 
1039
</tr>
 
1040
<tr>
 
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>
 
1044
</tr>
 
1045
<tr>
 
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>
 
1049
</tr>
 
1050
</tbody>
 
1051
</table></div>
 
1052
</div>
 
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>
402
 
</tr>
403
 
</tbody>
404
 
</table></div>
405
 
</div>
406
 
<hr>
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>
412
 
</div>
413
 
<hr>
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>
420
 
<p>
421
 
Converts a raw video buffer into the specified output caps.
422
 
</p>
423
 
<p>
424
 
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
425
 
</p>
426
 
<p>
427
 
The width, height and pixel-aspect-ratio can also be specified in the output caps.
428
 
</p>
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>
 
1058
<p></p>
 
1059
</div>
 
1060
</div>
 
1061
<hr>
 
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>
 
1068
</div>
 
1069
<hr>
 
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">
430
1083
<colgroup>
431
 
<col align="left" valign="top">
432
 
<col>
 
1084
<col width="150px" class="parameters_name">
 
1085
<col class="parameters_description">
 
1086
<col width="200px" class="parameters_annotations">
433
1087
</colgroup>
434
1088
<tbody>
435
1089
<tr>
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>
438
 
</td>
439
 
</tr>
440
 
<tr>
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>
443
 
</tr>
444
 
<tr>
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>
447
 
</tr>
448
 
<tr>
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>
451
 
</tr>
452
 
<tr>
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>
 
1093
</tr>
 
1094
<tr>
 
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>
 
1098
</tr>
 
1099
<tr>
 
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>
 
1103
</tr>
 
1104
<tr>
 
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>
456
1108
</tr>
457
1109
</tbody>
458
1110
</table></div>
459
1111
</div>
 
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>
 
1116
<p></p>
 
1117
</div>
 
1118
</div>
460
1119
<hr>
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>
469
 
<p>
470
 
Converts a raw video buffer into the specified output caps.
471
 
</p>
472
 
<p>
473
 
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
474
 
</p>
475
 
<p>
476
 
The width, height and pixel-aspect-ratio can also be specified in the output caps.
477
 
</p>
478
 
<p>
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.
483
 
</p>
484
 
<p>
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
486
 
anymore.
487
 
</p>
488
 
<div class="variablelist"><table border="0" class="variablelist">
489
 
<colgroup>
490
 
<col align="left" valign="top">
491
 
<col>
492
 
</colgroup>
493
 
<tbody>
494
 
<tr>
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>
497
 
</td>
498
 
</tr>
499
 
<tr>
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>
502
 
</tr>
503
 
<tr>
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>
506
 
</tr>
507
 
<tr>
508
 
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
509
 
<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>
511
 
</tr>
512
 
<tr>
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>
515
 
</td>
516
 
</tr>
517
 
<tr>
518
 
<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>
519
 
<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>
521
 
</tr>
522
 
</tbody>
523
 
</table></div>
524
 
</div>
525
 
<hr>
526
 
<div class="refsect2">
527
 
<a name="GstVideoAlignment"></a><h3>struct GstVideoAlignment</h3>
528
 
<pre class="programlisting">struct GstVideoAlignment {
529
 
  guint padding_top;
530
 
  guint padding_bottom;
531
 
  guint padding_left;
532
 
  guint padding_right;
533
 
  guint stride_align[GST_VIDEO_MAX_PLANES];
534
 
};
535
 
</pre>
536
 
<p>
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>.
540
 
</p>
541
 
<div class="variablelist"><table border="0" class="variablelist">
542
 
<colgroup>
543
 
<col align="left" valign="top">
544
 
<col>
545
 
</colgroup>
546
 
<tbody>
547
 
<tr>
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>
550
 
</tr>
551
 
<tr>
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>
554
 
</tr>
555
 
<tr>
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>
558
 
</tr>
559
 
<tr>
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>
562
 
</tr>
563
 
<tr>
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>
566
 
</tr>
567
 
</tbody>
568
 
</table></div>
569
 
</div>
570
 
<hr>
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>
574
 
<p>
575
 
Set <em class="parameter"><code>align</code></em> to its default values with no padding and no alignment.
576
 
</p>
577
 
<div class="variablelist"><table border="0" class="variablelist">
578
 
<colgroup>
579
 
<col align="left" valign="top">
580
 
<col>
 
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>
 
1141
 is not needed
 
1142
anymore.</p>
 
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">
 
1146
<colgroup>
 
1147
<col width="150px" class="parameters_name">
 
1148
<col class="parameters_description">
 
1149
<col width="200px" class="parameters_annotations">
 
1150
</colgroup>
 
1151
<tbody>
 
1152
<tr>
 
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>
 
1156
</tr>
 
1157
<tr>
 
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>
 
1161
</tr>
 
1162
<tr>
 
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>
 
1166
</tr>
 
1167
<tr>
 
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>
 
1171
</tr>
 
1172
<tr>
 
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>
 
1175
</p></td>
 
1176
<td class="parameter_annotations"> </td>
 
1177
</tr>
 
1178
<tr>
 
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>
 
1183
</tr>
 
1184
</tbody>
 
1185
</table></div>
 
1186
</div>
 
1187
</div>
 
1188
<hr>
 
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">
 
1198
<colgroup>
 
1199
<col width="150px" class="parameters_name">
 
1200
<col class="parameters_description">
 
1201
<col width="200px" class="parameters_annotations">
581
1202
</colgroup>
582
1203
<tbody><tr>
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>
585
 
</td>
 
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>
586
1207
</tr></tbody>
587
1208
</table></div>
588
1209
</div>
589
 
<hr>
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"
593
 
</pre>
594
 
<p>
595
 
This metadata is relevant for video streams.
596
 
</p>
597
 
<p class="since">Since 1.2</p>
598
 
</div>
599
 
<hr>
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"
603
 
</pre>
604
 
<p>
605
 
This metadata stays relevant as long as video orientation is unchanged.
606
 
</p>
607
 
<p class="since">Since 1.2</p>
608
 
</div>
609
 
<hr>
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"
613
 
</pre>
614
 
<p>
615
 
This metadata stays relevant as long as video size is unchanged.
616
 
</p>
617
 
<p class="since">Since 1.2</p>
618
 
</div>
619
 
<hr>
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"
623
 
</pre>
624
 
<p>
625
 
This metadata stays relevant as long as video colorspace is unchanged.
626
 
</p>
627
 
<p class="since">Since 1.2</p>
628
 
</div>
629
 
<hr>
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>
633
 
<p>
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
 
1210
</div>
 
1211
<hr>
 
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.
637
 
</p>
638
 
<p>
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>.
641
 
</p>
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">
643
1225
<colgroup>
644
 
<col align="left" valign="top">
645
 
<col>
 
1226
<col width="150px" class="parameters_name">
 
1227
<col class="parameters_description">
 
1228
<col width="200px" class="parameters_annotations">
646
1229
</colgroup>
647
 
<tbody>
648
 
<tr>
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>
651
 
</tr>
652
 
<tr>
653
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
654
 
<td>The new GstEvent</td>
655
 
</tr>
656
 
</tbody>
 
1230
<tbody><tr>
 
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>
 
1234
</tr></tbody>
657
1235
</table></div>
658
1236
</div>
 
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>
 
1240
<p></p>
 
1241
</div>
 
1242
</div>
659
1243
<hr>
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>
664
 
<p>
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
670
 
event.
671
 
</p>
672
 
<p>
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>
674
 
</p>
675
 
<div class="variablelist"><table border="0" class="variablelist">
 
1254
event.</p>
 
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">
676
1259
<colgroup>
677
 
<col align="left" valign="top">
678
 
<col>
 
1260
<col width="150px" class="parameters_name">
 
1261
<col class="parameters_description">
 
1262
<col width="200px" class="parameters_annotations">
679
1263
</colgroup>
680
1264
<tbody>
681
1265
<tr>
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>
684
 
</tr>
685
 
<tr>
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>
688
 
</tr>
689
 
<tr>
690
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
691
 
<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>
 
1269
</tr>
 
1270
<tr>
 
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>
693
1274
</tr>
694
1275
</tbody>
695
1276
</table></div>
696
1277
</div>
 
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>
 
1281
<p></p>
 
1282
</div>
 
1283
</div>
697
1284
<hr>
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>
706
 
<p>
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
711
 
handled.
712
 
</p>
713
 
<p>
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>.
716
 
</p>
717
 
<div class="variablelist"><table border="0" class="variablelist">
718
 
<colgroup>
719
 
<col align="left" valign="top">
720
 
<col>
721
 
</colgroup>
722
 
<tbody>
723
 
<tr>
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>
726
 
</tr>
727
 
<tr>
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>
730
 
</tr>
731
 
<tr>
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>
734
 
</tr>
735
 
<tr>
736
 
<td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
737
 
<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>
739
 
</tr>
740
 
<tr>
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>
743
 
</tr>
744
 
<tr>
745
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
746
 
<td>The new GstEvent</td>
747
 
</tr>
748
 
</tbody>
749
 
</table></div>
750
 
</div>
751
 
<hr>
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>
761
 
<p>
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.
765
 
</p>
766
 
<div class="variablelist"><table border="0" class="variablelist">
767
 
<colgroup>
768
 
<col align="left" valign="top">
769
 
<col>
770
 
</colgroup>
771
 
<tbody>
772
 
<tr>
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>
775
 
</tr>
776
 
<tr>
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>
779
 
</td>
780
 
</tr>
781
 
<tr>
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>
784
 
</td>
785
 
</tr>
786
 
<tr>
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>
789
 
</td>
790
 
</tr>
791
 
<tr>
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>
794
 
</td>
795
 
</tr>
796
 
<tr>
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>
799
 
</td>
800
 
</tr>
801
 
<tr>
802
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
803
 
<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>
805
 
</tr>
806
 
</tbody>
807
 
</table></div>
808
 
</div>
809
 
<hr>
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>
816
 
<p>
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. 
819
 
</p>
820
 
<p>
821
 
<em class="parameter"><code>running_time</code></em> can be set to request a new key unit at a specific
 
1298
handled.</p>
 
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">
 
1304
<colgroup>
 
1305
<col width="150px" class="parameters_name">
 
1306
<col class="parameters_description">
 
1307
<col width="200px" class="parameters_annotations">
 
1308
</colgroup>
 
1309
<tbody>
 
1310
<tr>
 
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>
 
1314
</tr>
 
1315
<tr>
 
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>
 
1319
</tr>
 
1320
<tr>
 
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>
 
1324
</tr>
 
1325
<tr>
 
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>
 
1329
</tr>
 
1330
<tr>
 
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>
 
1334
</tr>
 
1335
</tbody>
 
1336
</table></div>
 
1337
</div>
 
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>
 
1341
<p></p>
 
1342
</div>
 
1343
</div>
 
1344
<hr>
 
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">
 
1361
<colgroup>
 
1362
<col width="150px" class="parameters_name">
 
1363
<col class="parameters_description">
 
1364
<col width="200px" class="parameters_annotations">
 
1365
</colgroup>
 
1366
<tbody>
 
1367
<tr>
 
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>
 
1371
</tr>
 
1372
<tr>
 
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>
 
1376
</tr>
 
1377
<tr>
 
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>
 
1381
</tr>
 
1382
<tr>
 
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>
 
1386
</tr>
 
1387
<tr>
 
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>
 
1391
</tr>
 
1392
<tr>
 
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>
 
1396
</tr>
 
1397
</tbody>
 
1398
</table></div>
 
1399
</div>
 
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>
 
1403
<p></p>
 
1404
</div>
 
1405
</div>
 
1406
<hr>
 
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.
824
 
</p>
825
 
<p>
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>.
828
 
</p>
829
 
<div class="variablelist"><table border="0" class="variablelist">
830
 
<colgroup>
831
 
<col align="left" valign="top">
832
 
<col>
833
 
</colgroup>
834
 
<tbody>
835
 
<tr>
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>
838
 
</tr>
839
 
<tr>
840
 
<td><p><span class="term"><em class="parameter"><code>all_headers</code></em> :</span></p></td>
841
 
<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>
843
 
</tr>
844
 
<tr>
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>
847
 
</tr>
848
 
<tr>
849
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
850
 
<td>The new GstEvent</td>
851
 
</tr>
852
 
</tbody>
853
 
</table></div>
854
 
</div>
855
 
<hr>
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>
863
 
<p>
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.
867
 
</p>
868
 
<p>
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>
870
 
</p>
871
 
<div class="variablelist"><table border="0" class="variablelist">
872
 
<colgroup>
873
 
<col align="left" valign="top">
874
 
<col>
875
 
</colgroup>
876
 
<tbody>
877
 
<tr>
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>
880
 
</tr>
881
 
<tr>
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>
884
 
</td>
885
 
</tr>
886
 
<tr>
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>
889
 
</td>
890
 
</tr>
891
 
<tr>
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>
894
 
</td>
895
 
</tr>
896
 
<tr>
897
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
898
 
<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>
900
 
</tr>
901
 
</tbody>
902
 
</table></div>
903
 
</div>
904
 
<hr>
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>
908
 
<p>
909
 
Checks if an event is a force key unit event. Returns true for both upstream
910
 
and downstream force key unit events.
911
 
</p>
912
 
<div class="variablelist"><table border="0" class="variablelist">
913
 
<colgroup>
914
 
<col align="left" valign="top">
915
 
<col>
916
 
</colgroup>
917
 
<tbody>
918
 
<tr>
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>
921
 
</tr>
922
 
<tr>
923
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
924
 
<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>
926
 
</tr>
927
 
</tbody>
928
 
</table></div>
929
 
</div>
930
 
<hr>
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,
987
 
} GstVideoFormat;
988
 
</pre>
989
 
<p>
990
 
Enum value describing the most common video formats.
991
 
</p>
992
 
<div class="variablelist"><table border="0" class="variablelist">
993
 
<colgroup>
994
 
<col align="left" valign="top">
995
 
<col>
996
 
</colgroup>
997
 
<tbody>
998
 
<tr>
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
1001
 
</td>
1002
 
</tr>
1003
 
<tr>
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
1006
 
</td>
1007
 
</tr>
1008
 
<tr>
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
1011
 
</td>
1012
 
</tr>
1013
 
<tr>
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)
1016
 
</td>
1017
 
</tr>
1018
 
<tr>
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 ...)
1021
 
</td>
1022
 
</tr>
1023
 
<tr>
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 ...)
1026
 
</td>
1027
 
</tr>
1028
 
<tr>
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 ...)
1031
 
</td>
1032
 
</tr>
1033
 
<tr>
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
1036
 
</td>
1037
 
</tr>
1038
 
<tr>
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
1041
 
</td>
1042
 
</tr>
1043
 
<tr>
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
1046
 
</td>
1047
 
</tr>
1048
 
<tr>
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
1051
 
</td>
1052
 
</tr>
1053
 
<tr>
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
1056
 
</td>
1057
 
</tr>
1058
 
<tr>
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
1061
 
</td>
1062
 
</tr>
1063
 
<tr>
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
1066
 
</td>
1067
 
</tr>
1068
 
<tr>
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
1071
 
</td>
1072
 
</tr>
1073
 
<tr>
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>
1075
 
<td>rgb
1076
 
</td>
1077
 
</tr>
1078
 
<tr>
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>
1080
 
<td>reverse rgb
1081
 
</td>
1082
 
</tr>
1083
 
<tr>
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
1086
 
</td>
1087
 
</tr>
1088
 
<tr>
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
1091
 
</td>
1092
 
</tr>
1093
 
<tr>
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 ...)
1096
 
</td>
1097
 
</tr>
1098
 
<tr>
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
1101
 
</td>
1102
 
</tr>
1103
 
<tr>
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
1106
 
</td>
1107
 
</tr>
1108
 
<tr>
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
1111
 
</td>
1112
 
</tr>
1113
 
<tr>
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
1116
 
</td>
1117
 
</tr>
1118
 
<tr>
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
1121
 
</td>
1122
 
</tr>
1123
 
<tr>
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>
1125
 
<td>8-bit grayscale
1126
 
</td>
1127
 
</tr>
1128
 
<tr>
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
1131
 
</td>
1132
 
</tr>
1133
 
<tr>
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
1136
 
</td>
1137
 
</tr>
1138
 
<tr>
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
1141
 
</td>
1142
 
</tr>
1143
 
<tr>
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
1146
 
</td>
1147
 
</tr>
1148
 
<tr>
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
1151
 
</td>
1152
 
</tr>
1153
 
<tr>
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
1156
 
</td>
1157
 
</tr>
1158
 
<tr>
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
1161
 
</td>
1162
 
</tr>
1163
 
<tr>
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 ...)
1166
 
</td>
1167
 
</tr>
1168
 
<tr>
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
1171
 
</td>
1172
 
</tr>
1173
 
<tr>
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
1176
 
</td>
1177
 
</tr>
1178
 
<tr>
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
1181
 
</td>
1182
 
</tr>
1183
 
<tr>
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)
1186
 
</td>
1187
 
</tr>
1188
 
<tr>
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 ...)
1191
 
</td>
1192
 
</tr>
1193
 
<tr>
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
1196
 
</td>
1197
 
</tr>
1198
 
<tr>
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 ...)
1201
 
</td>
1202
 
</tr>
1203
 
<tr>
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
1206
 
</td>
1207
 
</tr>
1208
 
<tr>
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
1211
 
</td>
1212
 
</tr>
1213
 
<tr>
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
1216
 
</td>
1217
 
</tr>
1218
 
<tr>
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
1221
 
</td>
1222
 
</tr>
1223
 
<tr>
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
1226
 
</td>
1227
 
</tr>
1228
 
<tr>
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
1231
 
</td>
1232
 
</tr>
1233
 
<tr>
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
1236
 
</td>
1237
 
</tr>
1238
 
<tr>
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
1241
 
</td>
1242
 
</tr>
1243
 
<tr>
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
1246
 
</td>
1247
 
</tr>
1248
 
<tr>
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
1251
 
</td>
1252
 
</tr>
1253
 
<tr>
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
1256
 
</td>
1257
 
</tr>
1258
 
<tr>
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
1261
 
</td>
1262
 
</tr>
1263
 
</tbody>
1264
 
</table></div>
1265
 
</div>
1266
 
<hr>
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
1270
 
</pre>
1271
 
</div>
1272
 
<hr>
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
1276
 
</pre>
1277
 
</div>
1278
 
<hr>
1279
 
<div class="refsect2">
1280
 
<a name="GstVideoFormatInfo"></a><h3>struct GstVideoFormatInfo</h3>
1281
 
<pre class="programlisting">struct GstVideoFormatInfo {
1282
 
  GstVideoFormat format;
1283
 
  const gchar *name;
1284
 
  const gchar *description;
1285
 
  GstVideoFormatFlags flags;
1286
 
  guint bits;
1287
 
  guint n_components;
1288
 
  guint shift[GST_VIDEO_MAX_COMPONENTS];
1289
 
  guint depth[GST_VIDEO_MAX_COMPONENTS];
1290
 
  gint  pixel_stride[GST_VIDEO_MAX_COMPONENTS];
1291
 
  guint n_planes;
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];
1296
 
 
1297
 
  GstVideoFormat unpack_format;
1298
 
  GstVideoFormatUnpack unpack_func;
1299
 
  gint pack_lines;
1300
 
  GstVideoFormatPack pack_func;
1301
 
 
1302
 
  gpointer _gst_reserved[GST_PADDING];
1303
 
};
1304
 
</pre>
1305
 
<p>
1306
 
Information for a video format.
1307
 
</p>
1308
 
<div class="variablelist"><table border="0" class="variablelist">
1309
 
<colgroup>
1310
 
<col align="left" valign="top">
1311
 
<col>
1312
 
</colgroup>
1313
 
<tbody>
1314
 
<tr>
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>
1317
 
</tr>
1318
 
<tr>
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>
1321
 
</tr>
1322
 
<tr>
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>
1325
 
</tr>
1326
 
<tr>
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>
1329
 
</tr>
1330
 
<tr>
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 &gt; 8 multiple bytes
1334
 
should be read according to the endianness flag before applying the shift
1335
 
and mask.</td>
1336
 
</tr>
1337
 
<tr>
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>
1340
 
</tr>
1341
 
<tr>
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>
1344
 
</tr>
1345
 
<tr>
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>
1348
 
</tr>
1349
 
<tr>
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 &lt; 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>
1355
 
</tr>
1356
 
<tr>
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
1360
 
one plane.</td>
1361
 
</tr>
1362
 
<tr>
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>
1365
 
</tr>
1366
 
<tr>
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
1369
 
can be found.</td>
1370
 
</tr>
1371
 
<tr>
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>
1375
 
</tr>
1376
 
<tr>
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>
1380
 
</tr>
1381
 
<tr>
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>
1385
 
</tr>
1386
 
<tr>
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>
1389
 
</tr>
1390
 
<tr>
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>
1393
 
</tr>
1394
 
<tr>
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>
1397
 
</tr>
1398
 
<tr>
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>
1400
 
<td></td>
1401
 
</tr>
1402
 
</tbody>
1403
 
</table></div>
1404
 
</div>
1405
 
<hr>
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 &lt;&lt; 0),
1411
 
  GST_VIDEO_CHROMA_SITE_H_COSITED = (1 &lt;&lt; 1),
1412
 
  GST_VIDEO_CHROMA_SITE_V_COSITED = (1 &lt;&lt; 2),
1413
 
  GST_VIDEO_CHROMA_SITE_ALT_LINE  = (1 &lt;&lt; 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;
1420
 
</pre>
1421
 
<p>
1422
 
Various Chroma sitings.
1423
 
</p>
1424
 
<div class="variablelist"><table border="0" class="variablelist">
1425
 
<colgroup>
1426
 
<col align="left" valign="top">
1427
 
<col>
1428
 
</colgroup>
1429
 
<tbody>
1430
 
<tr>
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
1433
 
</td>
1434
 
</tr>
1435
 
<tr>
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>
1437
 
<td>no cositing
1438
 
</td>
1439
 
</tr>
1440
 
<tr>
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
1443
 
</td>
1444
 
</tr>
1445
 
<tr>
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
1448
 
</td>
1449
 
</tr>
1450
 
<tr>
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
1453
 
</td>
1454
 
</tr>
1455
 
<tr>
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
1458
 
</td>
1459
 
</tr>
1460
 
<tr>
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
1463
 
</td>
1464
 
</tr>
1465
 
<tr>
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
1468
 
</td>
1469
 
</tr>
1470
 
<tr>
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
1473
 
</td>
1474
 
</tr>
1475
 
</tbody>
1476
 
</table></div>
1477
 
</div>
1478
 
<hr>
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>
1482
 
<p>
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>
1484
 
</p>
1485
 
<div class="variablelist"><table border="0" class="variablelist">
1486
 
<colgroup>
1487
 
<col align="left" valign="top">
1488
 
<col>
1489
 
</colgroup>
1490
 
<tbody>
1491
 
<tr>
1492
 
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
1493
 
<td>a chromasite string</td>
1494
 
</tr>
1495
 
<tr>
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>
1499
 
</tr>
1500
 
</tbody>
1501
 
</table></div>
1502
 
</div>
1503
 
<hr>
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>
1507
 
<p>
1508
 
Converts <em class="parameter"><code>site</code></em> to its string representation.
1509
 
</p>
1510
 
<div class="variablelist"><table border="0" class="variablelist">
1511
 
<colgroup>
1512
 
<col align="left" valign="top">
1513
 
<col>
1514
 
</colgroup>
1515
 
<tbody>
1516
 
<tr>
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>
1519
 
</td>
1520
 
</tr>
1521
 
<tr>
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>
1524
 
</tr>
1525
 
</tbody>
1526
 
</table></div>
1527
 
</div>
1528
 
<hr>
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 &lt;&lt; 0),
1533
 
  GST_VIDEO_FORMAT_FLAG_RGB      = (1 &lt;&lt; 1),
1534
 
  GST_VIDEO_FORMAT_FLAG_GRAY     = (1 &lt;&lt; 2),
1535
 
  GST_VIDEO_FORMAT_FLAG_ALPHA    = (1 &lt;&lt; 3),
1536
 
  GST_VIDEO_FORMAT_FLAG_LE       = (1 &lt;&lt; 4),
1537
 
  GST_VIDEO_FORMAT_FLAG_PALETTE  = (1 &lt;&lt; 5),
1538
 
  GST_VIDEO_FORMAT_FLAG_COMPLEX  = (1 &lt;&lt; 6),
1539
 
  GST_VIDEO_FORMAT_FLAG_UNPACK   = (1 &lt;&lt; 7)
1540
 
} GstVideoFormatFlags;
1541
 
</pre>
1542
 
<p>
1543
 
The different video flags that a format info can have.
1544
 
</p>
1545
 
<div class="variablelist"><table border="0" class="variablelist">
1546
 
<colgroup>
1547
 
<col align="left" valign="top">
1548
 
<col>
1549
 
</colgroup>
1550
 
<tbody>
1551
 
<tr>
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
1554
 
  0=Y, 1=U, 2=V.
1555
 
</td>
1556
 
</tr>
1557
 
<tr>
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
1560
 
  0=R, 1=G, 2=B.
1561
 
</td>
1562
 
</tr>
1563
 
<tr>
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
1566
 
  with index 0.
1567
 
</td>
1568
 
</tr>
1569
 
<tr>
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
1572
 
  the number 3.
1573
 
</td>
1574
 
</tr>
1575
 
<tr>
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
1578
 
  endianness.
1579
 
</td>
1580
 
</tr>
1581
 
<tr>
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.
1585
 
</td>
1586
 
</tr>
1587
 
<tr>
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>.
1591
 
</td>
1592
 
</tr>
1593
 
<tr>
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.
1597
 
</td>
1598
 
</tr>
1599
 
</tbody>
1600
 
</table></div>
1601
 
</div>
1602
 
<hr>
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 &lt;&lt; 0),
1608
 
  GST_VIDEO_PACK_FLAG_INTERLACED     = (1 &lt;&lt; 1)
1609
 
} GstVideoPackFlags;
1610
 
</pre>
1611
 
<p>
1612
 
The different flags that can be used when packing and unpacking.
1613
 
</p>
1614
 
<div class="variablelist"><table border="0" class="variablelist">
1615
 
<colgroup>
1616
 
<col align="left" valign="top">
1617
 
<col>
1618
 
</colgroup>
1619
 
<tbody>
1620
 
<tr>
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>
1622
 
<td>No flag
1623
 
</td>
1624
 
</tr>
1625
 
<tr>
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.
1632
 
</td>
1633
 
</tr>
1634
 
<tr>
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)
1639
 
</td>
1640
 
</tr>
1641
 
</tbody>
1642
 
</table></div>
1643
 
</div>
1644
 
<hr>
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>
1655
 
<p>
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.
1660
 
</p>
1661
 
<p>
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">
 
1425
<colgroup>
 
1426
<col width="150px" class="parameters_name">
 
1427
<col class="parameters_description">
 
1428
<col width="200px" class="parameters_annotations">
 
1429
</colgroup>
 
1430
<tbody>
 
1431
<tr>
 
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>
 
1435
</tr>
 
1436
<tr>
 
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>
 
1440
</tr>
 
1441
<tr>
 
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>
 
1445
</tr>
 
1446
</tbody>
 
1447
</table></div>
 
1448
</div>
 
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>
 
1452
<p></p>
 
1453
</div>
 
1454
</div>
 
1455
<hr>
 
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">
 
1471
<colgroup>
 
1472
<col width="150px" class="parameters_name">
 
1473
<col class="parameters_description">
 
1474
<col width="200px" class="parameters_annotations">
 
1475
</colgroup>
 
1476
<tbody>
 
1477
<tr>
 
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>
 
1481
</tr>
 
1482
<tr>
 
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>
 
1486
</tr>
 
1487
<tr>
 
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>
 
1491
</tr>
 
1492
<tr>
 
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>
 
1496
</tr>
 
1497
</tbody>
 
1498
</table></div>
 
1499
</div>
 
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>
 
1503
<p></p>
 
1504
</div>
 
1505
</div>
 
1506
<hr>
 
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">
 
1516
<colgroup>
 
1517
<col width="150px" class="parameters_name">
 
1518
<col class="parameters_description">
 
1519
<col width="200px" class="parameters_annotations">
 
1520
</colgroup>
 
1521
<tbody><tr>
 
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>
 
1525
</tr></tbody>
 
1526
</table></div>
 
1527
</div>
 
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>
 
1531
<p></p>
 
1532
</div>
 
1533
</div>
 
1534
<hr>
 
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">
 
1544
<colgroup>
 
1545
<col width="150px" class="parameters_name">
 
1546
<col class="parameters_description">
 
1547
<col width="200px" class="parameters_annotations">
 
1548
</colgroup>
 
1549
<tbody><tr>
 
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>
 
1553
</tr></tbody>
 
1554
</table></div>
 
1555
</div>
 
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>
 
1559
does
 
1560
not contain a valid chroma description.</p>
 
1561
<p></p>
 
1562
</div>
 
1563
</div>
 
1564
<hr>
 
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">
 
1574
<colgroup>
 
1575
<col width="150px" class="parameters_name">
 
1576
<col class="parameters_description">
 
1577
<col width="200px" class="parameters_annotations">
 
1578
</colgroup>
 
1579
<tbody><tr>
 
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>
 
1583
</tr></tbody>
 
1584
</table></div>
 
1585
</div>
 
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>
 
1589
.</p>
 
1590
<p></p>
 
1591
</div>
 
1592
</div>
 
1593
<hr>
 
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>
 
1612
 *
 
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.
1665
 
</p>
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">
1667
1620
<colgroup>
1668
 
<col align="left" valign="top">
1669
 
<col>
 
1621
<col width="150px" class="parameters_name">
 
1622
<col class="parameters_description">
 
1623
<col width="200px" class="parameters_annotations">
1670
1624
</colgroup>
1671
1625
<tbody>
1672
1626
<tr>
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>
1675
 
</td>
1676
 
</tr>
1677
 
<tr>
1678
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
1679
 
<td>flags to control the unpacking</td>
1680
 
</tr>
1681
 
<tr>
1682
 
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
1683
 
<td>a destination array</td>
1684
 
</tr>
1685
 
<tr>
1686
 
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1687
 
<td>pointers to the data planes</td>
1688
 
</tr>
1689
 
<tr>
1690
 
<td><p><span class="term"><em class="parameter"><code>stride</code></em> :</span></p></td>
1691
 
<td>strides of the planes</td>
1692
 
</tr>
1693
 
<tr>
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>
1696
 
</tr>
1697
 
<tr>
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>
1700
 
</tr>
1701
 
<tr>
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>
 
1630
</tr>
 
1631
<tr>
 
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>
 
1635
</tr>
 
1636
<tr>
 
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>
 
1640
</tr>
 
1641
<tr>
 
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>
 
1645
</tr>
 
1646
<tr>
 
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>
 
1650
</tr>
 
1651
<tr>
 
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>
 
1655
</tr>
 
1656
<tr>
 
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>
 
1660
</tr>
 
1661
<tr>
 
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>
1704
1665
</tr>
1705
1666
</tbody>
1706
1667
</table></div>
1707
1668
</div>
 
1669
</div>
1708
1670
<hr>
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>
1720
 
<p>
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>.
1724
 
</p>
1725
 
<p>
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.
1729
 
</p>
1730
 
<p>
1731
 
Subsampled formats will use the horizontally cosited component in the
1732
 
destination. Subsampling should be performed before packing.
1733
 
</p>
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>
 
1689
.</p>
 
1690
<p>This function operates on pack_lines lines, meaning that <em class="parameter"><code>src</code></em>
 
1691
 should
 
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>
 
1694
 
 
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">
1735
1701
<colgroup>
1736
 
<col align="left" valign="top">
1737
 
<col>
 
1702
<col width="150px" class="parameters_name">
 
1703
<col class="parameters_description">
 
1704
<col width="200px" class="parameters_annotations">
1738
1705
</colgroup>
1739
1706
<tbody>
1740
1707
<tr>
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>
1743
 
</td>
1744
 
</tr>
1745
 
<tr>
1746
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
1747
 
<td>flags to control the packing</td>
1748
 
</tr>
1749
 
<tr>
1750
 
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
1751
 
<td>a source array</td>
1752
 
</tr>
1753
 
<tr>
1754
 
<td><p><span class="term"><em class="parameter"><code>sstride</code></em> :</span></p></td>
1755
 
<td>the source array stride</td>
1756
 
</tr>
1757
 
<tr>
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>
1760
 
</tr>
1761
 
<tr>
1762
 
<td><p><span class="term"><em class="parameter"><code>stride</code></em> :</span></p></td>
1763
 
<td>strides of the destination planes</td>
1764
 
</tr>
1765
 
<tr>
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>
1768
 
</tr>
1769
 
<tr>
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>
1772
 
</tr>
1773
 
<tr>
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>
 
1711
</tr>
 
1712
<tr>
 
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>
 
1716
</tr>
 
1717
<tr>
 
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>
 
1721
</tr>
 
1722
<tr>
 
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>
 
1726
</tr>
 
1727
<tr>
 
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>
 
1731
</tr>
 
1732
<tr>
 
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>
 
1736
</tr>
 
1737
<tr>
 
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>
 
1741
</tr>
 
1742
<tr>
 
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>
 
1746
</tr>
 
1747
<tr>
 
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>
1776
1751
</tr>
1777
1752
</tbody>
1778
1753
</table></div>
 
1754
</div>
1779
1755
</div>
1780
1756
<hr>
1781
1757
<div class="refsect2">
1866
1842
<a name="GST-VIDEO-FORMAT-INFO-PSTRIDE:CAPS"></a><h3>GST_VIDEO_FORMAT_INFO_PSTRIDE()</h3>
1867
1843
<pre class="programlisting">#define GST_VIDEO_FORMAT_INFO_PSTRIDE(info,c)    ((info)-&gt;pixel_stride[c])
1868
1844
</pre>
1869
 
<p>
1870
 
pixel stride for the given component. This is the amount of bytes to the
 
1845
<p>pixel stride for the given component. This is the amount of bytes to the
1871
1846
pixel immediately to the right, so basically bytes from one pixel to the
1872
 
next. When bits &lt; 8, the stride is expressed in bits.
1873
 
</p>
1874
 
<p>
1875
 
Examples: for 24-bit RGB, the pixel stride would be 3 bytes, while it
 
1847
next. When bits &lt; 8, the stride is expressed in bits.</p>
 
1848
<p>Examples: for 24-bit RGB, the pixel stride would be 3 bytes, while it
1876
1849
would be 4 bytes for RGBx or ARGB, and 8 bytes for ARGB64 or AYUV64.
1877
1850
For planar formats such as I420 the pixel stride is usually 1. For
1878
 
YUY2 it would be 2 bytes.
1879
 
</p>
 
1851
YUY2 it would be 2 bytes.</p>
1880
1852
</div>
1881
1853
<hr>
1882
1854
<div class="refsect2">
1883
1855
<a name="GST-VIDEO-FORMAT-INFO-N-PLANES:CAPS"></a><h3>GST_VIDEO_FORMAT_INFO_N_PLANES()</h3>
1884
1856
<pre class="programlisting">#define GST_VIDEO_FORMAT_INFO_N_PLANES(info)     ((info)-&gt;n_planes)
1885
1857
</pre>
1886
 
<p>
1887
 
Number of planes. This is the number of planes the pixel layout is
 
1858
<p>Number of planes. This is the number of planes the pixel layout is
1888
1859
organized in in memory. The number of planes can be less than the
1889
1860
number of components (e.g. Y,U,V,A or R, G, B, A) when multiple
1890
 
components are packed into one plane.
1891
 
</p>
1892
 
<p>
1893
 
Examples: RGB/RGBx/RGBA: 1 plane, 3/3/4 components;
1894
 
I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components.
1895
 
</p>
 
1861
components are packed into one plane.</p>
 
1862
<p>Examples: RGB/RGBx/RGBA: 1 plane, 3/3/4 components;
 
1863
I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components.</p>
1896
1864
</div>
1897
1865
<hr>
1898
1866
<div class="refsect2">
1899
1867
<a name="GST-VIDEO-FORMAT-INFO-PLANE:CAPS"></a><h3>GST_VIDEO_FORMAT_INFO_PLANE()</h3>
1900
1868
<pre class="programlisting">#define GST_VIDEO_FORMAT_INFO_PLANE(info,c)      ((info)-&gt;plane[c])
1901
1869
</pre>
1902
 
<p>
1903
 
Plane number where the given component can be found. A plane may
1904
 
contain data for multiple components.
1905
 
</p>
 
1870
<p>Plane number where the given component can be found. A plane may
 
1871
contain data for multiple components.</p>
1906
1872
</div>
1907
1873
<hr>
1908
1874
<div class="refsect2">
1950
1916
<a name="GST-VIDEO-FORMAT-INFO-STRIDE:CAPS"></a><h3>GST_VIDEO_FORMAT_INFO_STRIDE()</h3>
1951
1917
<pre class="programlisting">#define GST_VIDEO_FORMAT_INFO_STRIDE(info,strides,comp) ((strides)[(info)-&gt;plane[comp]])
1952
1918
</pre>
1953
 
<p>
1954
 
Row stride in bytes, that is number of bytes from the first pixel component
 
1919
<p>Row stride in bytes, that is number of bytes from the first pixel component
1955
1920
of a row to the first pixel component in the next row. This might include
1956
1921
some row padding (memory not actually used for anything, to make sure the
1957
 
beginning of the next row is aligned in a particular way).
1958
 
</p>
 
1922
beginning of the next row is aligned in a particular way).</p>
1959
1923
</div>
1960
1924
<hr>
1961
1925
<div class="refsect2">
1964
1928
</div>
1965
1929
<hr>
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>
1975
 
<p>
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.
1977
 
</p>
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">
1979
1944
<colgroup>
1980
 
<col align="left" valign="top">
1981
 
<col>
 
1945
<col width="150px" class="parameters_name">
 
1946
<col class="parameters_description">
 
1947
<col width="200px" class="parameters_annotations">
1982
1948
</colgroup>
1983
1949
<tbody>
1984
1950
<tr>
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>
1987
1954
</tr>
1988
1955
<tr>
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>
1992
 
</td>
1993
 
</tr>
1994
 
<tr>
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>
1997
 
</td>
1998
 
</tr>
1999
 
<tr>
2000
 
<td><p><span class="term"><em class="parameter"><code>red_mask</code></em> :</span></p></td>
2001
 
<td>the red mask</td>
2002
 
</tr>
2003
 
<tr>
2004
 
<td><p><span class="term"><em class="parameter"><code>green_mask</code></em> :</span></p></td>
2005
 
<td>the green mask</td>
2006
 
</tr>
2007
 
<tr>
2008
 
<td><p><span class="term"><em class="parameter"><code>blue_mask</code></em> :</span></p></td>
2009
 
<td>the blue mask</td>
2010
 
</tr>
2011
 
<tr>
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>
2014
 
</tr>
2015
 
<tr>
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>
 
1959
</p></td>
 
1960
<td class="parameter_annotations"> </td>
 
1961
</tr>
 
1962
<tr>
 
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>
 
1966
</tr>
 
1967
<tr>
 
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>
 
1971
</tr>
 
1972
<tr>
 
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>
 
1976
</tr>
 
1977
<tr>
 
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>
 
1981
</tr>
 
1982
<tr>
 
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>
2019
1986
</tr>
2020
1987
</tbody>
2021
1988
</table></div>
2022
1989
</div>
 
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>
 
1994
<p></p>
 
1995
</div>
 
1996
</div>
2023
1997
<hr>
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>
2027
 
<p>
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.
2031
 
</p>
2032
 
<div class="variablelist"><table border="0" class="variablelist">
2033
 
<colgroup>
2034
 
<col align="left" valign="top">
2035
 
<col>
2036
 
</colgroup>
2037
 
<tbody>
2038
 
<tr>
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>
2041
 
</tr>
2042
 
<tr>
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>
2045
 
</tr>
2046
 
</tbody>
2047
 
</table></div>
2048
 
</div>
2049
 
<hr>
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>
2053
 
<p>
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.
2057
 
</p>
2058
 
<div class="variablelist"><table border="0" class="variablelist">
2059
 
<colgroup>
2060
 
<col align="left" valign="top">
2061
 
<col>
2062
 
</colgroup>
2063
 
<tbody>
2064
 
<tr>
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>
2067
 
</tr>
2068
 
<tr>
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>
2071
 
</td>
2072
 
</tr>
2073
 
</tbody>
2074
 
</table></div>
2075
 
</div>
2076
 
<hr>
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>
2080
 
<p>
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>.
2082
 
</p>
2083
 
<div class="variablelist"><table border="0" class="variablelist">
2084
 
<colgroup>
2085
 
<col align="left" valign="top">
2086
 
<col>
2087
 
</colgroup>
2088
 
<tbody>
2089
 
<tr>
2090
 
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
2091
 
<td>a format string</td>
2092
 
</tr>
2093
 
<tr>
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>
2097
 
</tr>
2098
 
</tbody>
2099
 
</table></div>
2100
 
</div>
2101
 
<hr>
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>
2105
 
</div>
2106
 
<hr>
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>
2110
 
<p>
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>
2112
 
</p>
2113
 
<div class="variablelist"><table border="0" class="variablelist">
2114
 
<colgroup>
2115
 
<col align="left" valign="top">
2116
 
<col>
2117
 
</colgroup>
2118
 
<tbody>
2119
 
<tr>
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>
2122
 
</td>
2123
 
</tr>
2124
 
<tr>
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>
2127
 
</tr>
2128
 
</tbody>
2129
 
</table></div>
2130
 
</div>
2131
 
<hr>
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 ]"
2135
 
</pre>
2136
 
</div>
2137
 
<hr>
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 ]"
2141
 
</pre>
2142
 
</div>
2143
 
<hr>
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">
 
2008
<colgroup>
 
2009
<col width="150px" class="parameters_name">
 
2010
<col class="parameters_description">
 
2011
<col width="200px" class="parameters_annotations">
 
2012
</colgroup>
 
2013
<tbody><tr>
 
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>
 
2017
</tr></tbody>
 
2018
</table></div>
 
2019
</div>
 
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>
 
2023
<p></p>
 
2024
</div>
 
2025
</div>
 
2026
<hr>
 
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>
 
2033
 has
 
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">
 
2038
<colgroup>
 
2039
<col width="150px" class="parameters_name">
 
2040
<col class="parameters_description">
 
2041
<col width="200px" class="parameters_annotations">
 
2042
</colgroup>
 
2043
<tbody><tr>
 
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>
 
2047
</tr></tbody>
 
2048
</table></div>
 
2049
</div>
 
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>
 
2053
</p>
 
2054
<p></p>
 
2055
</div>
 
2056
</div>
 
2057
<hr>
 
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">
 
2067
<colgroup>
 
2068
<col width="150px" class="parameters_name">
 
2069
<col class="parameters_description">
 
2070
<col width="200px" class="parameters_annotations">
 
2071
</colgroup>
 
2072
<tbody><tr>
 
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>
 
2076
</tr></tbody>
 
2077
</table></div>
 
2078
</div>
 
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>
 
2084
<p></p>
 
2085
</div>
 
2086
</div>
 
2087
<hr>
 
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>
 
2092
</div>
 
2093
<hr>
 
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>
 
2099
</p>
 
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">
 
2103
<colgroup>
 
2104
<col width="150px" class="parameters_name">
 
2105
<col class="parameters_description">
 
2106
<col width="200px" class="parameters_annotations">
 
2107
</colgroup>
 
2108
<tbody><tr>
 
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>
 
2112
</tr></tbody>
 
2113
</table></div>
 
2114
</div>
 
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>
 
2118
.</p>
 
2119
<p></p>
 
2120
</div>
2147
2121
</div>
2148
2122
<hr>
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>
2152
 
<p>
2153
 
Generic caps string for video, for use in pad templates.
2154
 
</p>
2155
 
<div class="variablelist"><table border="0" class="variablelist">
2156
 
<colgroup>
2157
 
<col align="left" valign="top">
2158
 
<col>
2159
 
</colgroup>
2160
 
<tbody><tr>
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>
2164
 
</tr></tbody>
2165
 
</table></div>
2166
 
</div>
2167
 
<hr>
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;
2175
 
</pre>
2176
 
<p>
2177
 
Possible color range values. These constants are defined for 8 bit color
2178
 
values and can be scaled for other bit depths.
2179
 
</p>
2180
 
<div class="variablelist"><table border="0" class="variablelist">
2181
 
<colgroup>
2182
 
<col align="left" valign="top">
2183
 
<col>
2184
 
</colgroup>
2185
 
<tbody>
2186
 
<tr>
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>
2188
 
<td>unknown range
2189
 
</td>
2190
 
</tr>
2191
 
<tr>
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
2194
 
</td>
2195
 
</tr>
2196
 
<tr>
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
2199
 
                [16..240] range.
2200
 
</td>
2201
 
</tr>
2202
 
</tbody>
2203
 
</table></div>
2204
 
</div>
2205
 
<hr>
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;
2216
 
</pre>
2217
 
<p>
2218
 
The color matrix is used to convert between Y'PbPr and
2219
 
non-linear RGB (R'G'B')
2220
 
</p>
2221
 
<div class="variablelist"><table border="0" class="variablelist">
2222
 
<colgroup>
2223
 
<col align="left" valign="top">
2224
 
<col>
2225
 
</colgroup>
2226
 
<tbody>
2227
 
<tr>
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>
2229
 
<td>unknown matrix
2230
 
</td>
2231
 
</tr>
2232
 
<tr>
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>
2234
 
<td>identity matrix
2235
 
</td>
2236
 
</tr>
2237
 
<tr>
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
2240
 
</td>
2241
 
</tr>
2242
 
<tr>
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
2245
 
</td>
2246
 
</tr>
2247
 
<tr>
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
2250
 
</td>
2251
 
</tr>
2252
 
<tr>
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
2255
 
</td>
2256
 
</tr>
2257
 
</tbody>
2258
 
</table></div>
2259
 
</div>
2260
 
<hr>
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;
2276
 
</pre>
2277
 
<p>
2278
 
The video transfer function defines the formula for converting between
2279
 
non-linear RGB (R'G'B') and linear RGB
2280
 
</p>
2281
 
<div class="variablelist"><table border="0" class="variablelist">
2282
 
<colgroup>
2283
 
<col align="left" valign="top">
2284
 
<col>
2285
 
</colgroup>
2286
 
<tbody>
2287
 
<tr>
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
2290
 
</td>
2291
 
</tr>
2292
 
<tr>
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
2295
 
</td>
2296
 
</tr>
2297
 
<tr>
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>
2299
 
<td>Gamma 1.8 curve
2300
 
</td>
2301
 
</tr>
2302
 
<tr>
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>
2304
 
<td>Gamma 2.0 curve
2305
 
</td>
2306
 
</tr>
2307
 
<tr>
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>
2309
 
<td>Gamma 2.2 curve
2310
 
</td>
2311
 
</tr>
2312
 
<tr>
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
2315
 
                          range
2316
 
</td>
2317
 
</tr>
2318
 
<tr>
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
2321
 
                              lower range
2322
 
</td>
2323
 
</tr>
2324
 
<tr>
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
2327
 
                         range
2328
 
</td>
2329
 
</tr>
2330
 
<tr>
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>
2332
 
<td>Gamma 2.8 curve
2333
 
</td>
2334
 
</tr>
2335
 
<tr>
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
2338
 
                            100:1 range
2339
 
</td>
2340
 
</tr>
2341
 
<tr>
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
2344
 
                            316.22777:1 range
2345
 
</td>
2346
 
</tr>
2347
 
</tbody>
2348
 
</table></div>
2349
 
</div>
2350
 
<hr>
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;
2362
 
</pre>
2363
 
<p>
2364
 
The color primaries define the how to transform linear RGB values to and from
2365
 
the CIE XYZ colorspace.
2366
 
</p>
2367
 
<div class="variablelist"><table border="0" class="variablelist">
2368
 
<colgroup>
2369
 
<col align="left" valign="top">
2370
 
<col>
2371
 
</colgroup>
2372
 
<tbody>
2373
 
<tr>
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
2376
 
</td>
2377
 
</tr>
2378
 
<tr>
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>
2380
 
<td>BT709 primaries
2381
 
</td>
2382
 
</tr>
2383
 
<tr>
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
2386
 
</td>
2387
 
</tr>
2388
 
<tr>
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
2391
 
</td>
2392
 
</tr>
2393
 
<tr>
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
2396
 
</td>
2397
 
</tr>
2398
 
<tr>
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
2401
 
</td>
2402
 
</tr>
2403
 
<tr>
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>
2405
 
<td>Generic film
2406
 
</td>
2407
 
</tr>
2408
 
</tbody>
2409
 
</table></div>
2410
 
</div>
2411
 
<hr>
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;
2420
 
</pre>
2421
 
<p>
2422
 
Structure describing the color info.
2423
 
</p>
2424
 
<div class="variablelist"><table border="0" class="variablelist">
2425
 
<colgroup>
2426
 
<col align="left" valign="top">
2427
 
<col>
2428
 
</colgroup>
2429
 
<tbody>
2430
 
<tr>
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>
2434
 
</tr>
2435
 
<tr>
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>
2439
 
</tr>
2440
 
<tr>
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>
2443
 
</tr>
2444
 
<tr>
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>
2447
 
</tr>
2448
 
</tbody>
2449
 
</table></div>
2450
 
</div>
2451
 
<hr>
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>
2456
 
<p>
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>.
2459
 
</p>
2460
 
<div class="variablelist"><table border="0" class="variablelist">
2461
 
<colgroup>
2462
 
<col align="left" valign="top">
2463
 
<col>
2464
 
</colgroup>
2465
 
<tbody>
2466
 
<tr>
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>
2469
 
</td>
2470
 
</tr>
2471
 
<tr>
2472
 
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2473
 
<td>a colorimetry string</td>
2474
 
</tr>
2475
 
<tr>
2476
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2477
 
<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>
2480
 
</tr>
2481
 
</tbody>
2482
 
</table></div>
2483
 
</div>
2484
 
<hr>
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>
2489
 
<p>
2490
 
Parse the colorimetry string and update <em class="parameter"><code>cinfo</code></em> with the parsed
2491
 
values.
2492
 
</p>
2493
 
<div class="variablelist"><table border="0" class="variablelist">
2494
 
<colgroup>
2495
 
<col align="left" valign="top">
2496
 
<col>
2497
 
</colgroup>
2498
 
<tbody>
2499
 
<tr>
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>
2502
 
</td>
2503
 
</tr>
2504
 
<tr>
2505
 
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2506
 
<td>a colorimetry string</td>
2507
 
</tr>
2508
 
<tr>
2509
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2510
 
<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>
2512
 
</tr>
2513
 
</tbody>
2514
 
</table></div>
2515
 
</div>
2516
 
<hr>
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>
2520
 
<p>
2521
 
Make a string representation of <em class="parameter"><code>cinfo</code></em>.
2522
 
</p>
2523
 
<div class="variablelist"><table border="0" class="variablelist">
2524
 
<colgroup>
2525
 
<col align="left" valign="top">
2526
 
<col>
2527
 
</colgroup>
2528
 
<tbody>
2529
 
<tr>
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>
2532
 
</td>
2533
 
</tr>
2534
 
<tr>
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>
2537
 
</tr>
2538
 
</tbody>
2539
 
</table></div>
2540
 
</div>
2541
 
<hr>
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>
2548
 
<p>
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">
 
2130
<colgroup>
 
2131
<col width="150px" class="parameters_name">
 
2132
<col class="parameters_description">
 
2133
<col width="200px" class="parameters_annotations">
 
2134
</colgroup>
 
2135
<tbody><tr>
 
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>
 
2140
</tr></tbody>
 
2141
</table></div>
 
2142
</div>
 
2143
</div>
 
2144
<hr>
 
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>
 
2151
 matches that of the
 
2152
string <em class="parameter"><code>color</code></em>
 
2153
.</p>
 
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">
 
2157
<colgroup>
 
2158
<col width="150px" class="parameters_name">
 
2159
<col class="parameters_description">
 
2160
<col width="200px" class="parameters_annotations">
 
2161
</colgroup>
 
2162
<tbody>
 
2163
<tr>
 
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>
 
2167
</tr>
 
2168
<tr>
 
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>
 
2172
</tr>
 
2173
</tbody>
 
2174
</table></div>
 
2175
</div>
 
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>
 
2181
.</p>
 
2182
<p></p>
 
2183
</div>
 
2184
</div>
 
2185
<hr>
 
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>
 
2192
 with the parsed
 
2193
values.</p>
 
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">
 
2197
<colgroup>
 
2198
<col width="150px" class="parameters_name">
 
2199
<col class="parameters_description">
 
2200
<col width="200px" class="parameters_annotations">
 
2201
</colgroup>
 
2202
<tbody>
 
2203
<tr>
 
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>
 
2207
</tr>
 
2208
<tr>
 
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>
 
2212
</tr>
 
2213
</tbody>
 
2214
</table></div>
 
2215
</div>
 
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>
 
2220
<p></p>
 
2221
</div>
 
2222
</div>
 
2223
<hr>
 
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>
 
2229
.</p>
 
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">
 
2233
<colgroup>
 
2234
<col width="150px" class="parameters_name">
 
2235
<col class="parameters_description">
 
2236
<col width="200px" class="parameters_annotations">
 
2237
</colgroup>
 
2238
<tbody><tr>
 
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>
 
2242
</tr></tbody>
 
2243
</table></div>
 
2244
</div>
 
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>
 
2248
.</p>
 
2249
<p></p>
 
2250
</div>
 
2251
</div>
 
2252
<hr>
 
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>
 
2261
. For each
2550
2262
component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
2551
 
range [0.0 .. 1.0].
2552
 
</p>
2553
 
<p>
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>.
2557
 
</p>
2558
 
<div class="variablelist"><table border="0" class="variablelist">
2559
 
<colgroup>
2560
 
<col align="left" valign="top">
2561
 
<col>
2562
 
</colgroup>
2563
 
<tbody>
2564
 
<tr>
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>
2567
 
</td>
2568
 
</tr>
2569
 
<tr>
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>
2572
 
</td>
2573
 
</tr>
2574
 
<tr>
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>
2577
 
</td>
2578
 
</tr>
2579
 
<tr>
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>
2582
 
</td>
2583
 
</tr>
2584
 
</tbody>
2585
 
</table></div>
2586
 
</div>
2587
 
<hr>
2588
 
<div class="refsect2">
2589
 
<a name="GstVideoInfo"></a><h3>struct GstVideoInfo</h3>
2590
 
<pre class="programlisting">struct GstVideoInfo {
2591
 
  const GstVideoFormatInfo *finfo;
2592
 
 
2593
 
  GstVideoInterlaceMode     interlace_mode;
2594
 
  GstVideoFlags             flags;
2595
 
  gint                      width;
2596
 
  gint                      height;
2597
 
  gsize                     size;
2598
 
  gint                      views;
2599
 
 
2600
 
  GstVideoChromaSite        chroma_site;
2601
 
  GstVideoColorimetry       colorimetry;
2602
 
 
2603
 
  gint                      par_n;
2604
 
  gint                      par_d;
2605
 
  gint                      fps_n;
2606
 
  gint                      fps_d;
2607
 
 
2608
 
  gsize                     offset[GST_VIDEO_MAX_PLANES];
2609
 
  gint                      stride[GST_VIDEO_MAX_PLANES];
2610
 
};
2611
 
</pre>
2612
 
<p>
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>.
2617
 
</p>
2618
 
<p>
2619
 
Use the provided macros to access the info in this structure.
2620
 
</p>
2621
 
<div class="variablelist"><table border="0" class="variablelist">
2622
 
<colgroup>
2623
 
<col align="left" valign="top">
2624
 
<col>
2625
 
</colgroup>
2626
 
<tbody>
2627
 
<tr>
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>
2630
 
</tr>
2631
 
<tr>
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>
2634
 
</tr>
2635
 
<tr>
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>
2638
 
</tr>
2639
 
<tr>
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>
2642
 
</tr>
2643
 
<tr>
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>
2646
 
</tr>
2647
 
<tr>
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>
2650
 
</tr>
2651
 
<tr>
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>
2654
 
</tr>
2655
 
<tr>
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>
2658
 
</tr>
2659
 
<tr>
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>
2662
 
</tr>
2663
 
<tr>
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>
2666
 
</tr>
2667
 
<tr>
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>
2670
 
</tr>
2671
 
<tr>
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>
2674
 
</tr>
2675
 
<tr>
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>
2678
 
</tr>
2679
 
<tr>
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>
2682
 
</tr>
2683
 
<tr>
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>
2686
 
</tr>
2687
 
</tbody>
2688
 
</table></div>
2689
 
</div>
2690
 
<hr>
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;
2699
 
</pre>
2700
 
<p>
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
2702
 
mode of the stream.
2703
 
</p>
2704
 
<div class="variablelist"><table border="0" class="variablelist">
2705
 
<colgroup>
2706
 
<col align="left" valign="top">
2707
 
<col>
2708
 
</colgroup>
2709
 
<tbody>
2710
 
<tr>
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
2713
 
</td>
2714
 
</tr>
2715
 
<tr>
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.
2719
 
</td>
2720
 
</tr>
2721
 
<tr>
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.
2725
 
</td>
2726
 
</tr>
2727
 
<tr>
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 &gt; 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.
2736
 
</td>
2737
 
</tr>
2738
 
</tbody>
2739
 
</table></div>
2740
 
</div>
2741
 
<hr>
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 &lt;&lt; 0),
2747
 
  GST_VIDEO_FLAG_PREMULTIPLIED_ALPHA = (1 &lt;&lt; 1)
2748
 
} GstVideoFlags;
2749
 
</pre>
2750
 
<p>
2751
 
Extra video flags
2752
 
</p>
2753
 
<div class="variablelist"><table border="0" class="variablelist">
2754
 
<colgroup>
2755
 
<col align="left" valign="top">
2756
 
<col>
2757
 
</colgroup>
2758
 
<tbody>
2759
 
<tr>
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>
2761
 
<td>no flags
2762
 
</td>
2763
 
</tr>
2764
 
<tr>
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
2768
 
</td>
2769
 
</tr>
2770
 
<tr>
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
2773
 
    value.
2774
 
</td>
2775
 
</tr>
2776
 
</tbody>
2777
 
</table></div>
 
2266
<em class="parameter"><code>info</code></em>
 
2267
 and <em class="parameter"><code>range</code></em>
 
2268
.</p>
 
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">
 
2272
<colgroup>
 
2273
<col width="150px" class="parameters_name">
 
2274
<col class="parameters_description">
 
2275
<col width="200px" class="parameters_annotations">
 
2276
</colgroup>
 
2277
<tbody>
 
2278
<tr>
 
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>
 
2282
</tr>
 
2283
<tr>
 
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>
 
2287
</tr>
 
2288
<tr>
 
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>
 
2292
</tr>
 
2293
<tr>
 
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>
 
2297
</tr>
 
2298
</tbody>
 
2299
</table></div>
 
2300
</div>
2778
2301
</div>
2779
2302
<hr>
2780
2303
<div class="refsect2">
2976
2499
</div>
2977
2500
<hr>
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>
2981
 
<p>
2982
 
Initialize <em class="parameter"><code>info</code></em> with default values.
2983
 
</p>
2984
 
<div class="variablelist"><table border="0" class="variablelist">
2985
 
<colgroup>
2986
 
<col align="left" valign="top">
2987
 
<col>
2988
 
</colgroup>
2989
 
<tbody><tr>
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>
2992
 
</td>
2993
 
</tr></tbody>
2994
 
</table></div>
2995
 
</div>
2996
 
<hr>
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>
3003
 
<p>
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>.
3005
 
</p>
3006
 
<div class="variablelist"><table border="0" class="variablelist">
3007
 
<colgroup>
3008
 
<col align="left" valign="top">
3009
 
<col>
3010
 
</colgroup>
3011
 
<tbody>
3012
 
<tr>
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>
3015
 
</td>
3016
 
</tr>
3017
 
<tr>
3018
 
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
3019
 
<td>the format</td>
3020
 
</tr>
3021
 
<tr>
3022
 
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
3023
 
<td>a width</td>
3024
 
</tr>
3025
 
<tr>
3026
 
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
3027
 
<td>a height</td>
3028
 
</tr>
3029
 
</tbody>
3030
 
</table></div>
3031
 
</div>
3032
 
<hr>
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>
3037
 
<p>
3038
 
Parse <em class="parameter"><code>caps</code></em> and update <em class="parameter"><code>info</code></em>.
3039
 
</p>
3040
 
<div class="variablelist"><table border="0" class="variablelist">
3041
 
<colgroup>
3042
 
<col align="left" valign="top">
3043
 
<col>
3044
 
</colgroup>
3045
 
<tbody>
3046
 
<tr>
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>
3049
 
</td>
3050
 
</tr>
3051
 
<tr>
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>
3054
 
</td>
3055
 
</tr>
3056
 
<tr>
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>
3059
 
</tr>
3060
 
</tbody>
3061
 
</table></div>
3062
 
</div>
3063
 
<hr>
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>
3067
 
<p>
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>.
3069
 
</p>
3070
 
<div class="variablelist"><table border="0" class="variablelist">
3071
 
<colgroup>
3072
 
<col align="left" valign="top">
3073
 
<col>
3074
 
</colgroup>
3075
 
<tbody>
3076
 
<tr>
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>
3079
 
</td>
3080
 
</tr>
3081
 
<tr>
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>
3084
 
</tr>
3085
 
</tbody>
3086
 
</table></div>
3087
 
</div>
3088
 
<hr>
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>
3096
 
<p>
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">
 
2510
<colgroup>
 
2511
<col width="150px" class="parameters_name">
 
2512
<col class="parameters_description">
 
2513
<col width="200px" class="parameters_annotations">
 
2514
</colgroup>
 
2515
<tbody><tr>
 
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>
 
2519
</tr></tbody>
 
2520
</table></div>
 
2521
</div>
 
2522
</div>
 
2523
<hr>
 
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>
 
2534
.</p>
 
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">
 
2538
<colgroup>
 
2539
<col width="150px" class="parameters_name">
 
2540
<col class="parameters_description">
 
2541
<col width="200px" class="parameters_annotations">
 
2542
</colgroup>
 
2543
<tbody>
 
2544
<tr>
 
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>
 
2548
</tr>
 
2549
<tr>
 
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>
 
2553
</tr>
 
2554
<tr>
 
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>
 
2558
</tr>
 
2559
<tr>
 
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>
 
2563
</tr>
 
2564
</tbody>
 
2565
</table></div>
 
2566
</div>
 
2567
</div>
 
2568
<hr>
 
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>
 
2576
.</p>
 
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">
 
2580
<colgroup>
 
2581
<col width="150px" class="parameters_name">
 
2582
<col class="parameters_description">
 
2583
<col width="200px" class="parameters_annotations">
 
2584
</colgroup>
 
2585
<tbody>
 
2586
<tr>
 
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>
 
2590
</tr>
 
2591
<tr>
 
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>
 
2595
</tr>
 
2596
</tbody>
 
2597
</table></div>
 
2598
</div>
 
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>
 
2602
could be parsed</p>
 
2603
<p></p>
 
2604
</div>
 
2605
</div>
 
2606
<hr>
 
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">
 
2616
<colgroup>
 
2617
<col width="150px" class="parameters_name">
 
2618
<col class="parameters_description">
 
2619
<col width="200px" class="parameters_annotations">
 
2620
</colgroup>
 
2621
<tbody><tr>
 
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>
 
2625
</tr></tbody>
 
2626
</table></div>
 
2627
</div>
 
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>
 
2631
.</p>
 
2632
<p></p>
 
2633
</div>
 
2634
</div>
 
2635
<hr>
 
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.
3101
 
</p>
3102
 
<div class="variablelist"><table border="0" class="variablelist">
3103
 
<colgroup>
3104
 
<col align="left" valign="top">
3105
 
<col>
3106
 
</colgroup>
3107
 
<tbody>
3108
 
<tr>
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>
3111
 
</td>
3112
 
</tr>
3113
 
<tr>
3114
 
<td><p><span class="term"><em class="parameter"><code>src_format</code></em> :</span></p></td>
3115
 
<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>
3117
 
</td>
3118
 
</tr>
3119
 
<tr>
3120
 
<td><p><span class="term"><em class="parameter"><code>src_value</code></em> :</span></p></td>
3121
 
<td>value to convert</td>
3122
 
</tr>
3123
 
<tr>
3124
 
<td><p><span class="term"><em class="parameter"><code>dest_format</code></em> :</span></p></td>
3125
 
<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>
3127
 
</td>
3128
 
</tr>
3129
 
<tr>
3130
 
<td><p><span class="term"><em class="parameter"><code>dest_value</code></em> :</span></p></td>
3131
 
<td>pointer to destination value</td>
3132
 
</tr>
3133
 
<tr>
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>
3136
 
</tr>
3137
 
</tbody>
3138
 
</table></div>
3139
 
</div>
3140
 
<hr>
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>
3145
 
<p>
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
3147
 
</p>
3148
 
<div class="variablelist"><table border="0" class="variablelist">
3149
 
<colgroup>
3150
 
<col align="left" valign="top">
3151
 
<col>
3152
 
</colgroup>
3153
 
<tbody>
3154
 
<tr>
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>
3157
 
</td>
3158
 
</tr>
3159
 
<tr>
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>
3162
 
</td>
3163
 
</tr>
3164
 
<tr>
3165
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3166
 
<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>
3168
 
</tr>
3169
 
</tbody>
3170
 
</table></div>
3171
 
</div>
3172
 
<hr>
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>
3177
 
<p>
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.
3180
 
</p>
3181
 
<p>
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.
3184
 
</p>
3185
 
<div class="variablelist"><table border="0" class="variablelist">
3186
 
<colgroup>
3187
 
<col align="left" valign="top">
3188
 
<col>
3189
 
</colgroup>
3190
 
<tbody>
3191
 
<tr>
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>
3194
 
</td>
3195
 
</tr>
3196
 
<tr>
3197
 
<td><p><span class="term"><em class="parameter"><code>align</code></em> :</span></p></td>
3198
 
<td>alignment parameters</td>
3199
 
</tr>
3200
 
</tbody>
3201
 
</table></div>
3202
 
</div>
3203
 
<hr>
3204
 
<div class="refsect2">
3205
 
<a name="GstVideoFrame"></a><h3>struct GstVideoFrame</h3>
3206
 
<pre class="programlisting">struct GstVideoFrame {
3207
 
  GstVideoInfo info;
3208
 
  GstVideoFrameFlags flags;
3209
 
 
3210
 
  GstBuffer *buffer;
3211
 
  gpointer   meta;
3212
 
  gint       id;
3213
 
 
3214
 
  gpointer   data[GST_VIDEO_MAX_PLANES];
3215
 
  GstMapInfo map[GST_VIDEO_MAX_PLANES];
3216
 
};
3217
 
</pre>
3218
 
<p>
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>
3220
 
</p>
3221
 
<div class="variablelist"><table border="0" class="variablelist">
3222
 
<colgroup>
3223
 
<col align="left" valign="top">
3224
 
<col>
3225
 
</colgroup>
3226
 
<tbody>
3227
 
<tr>
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>
3230
 
</td>
3231
 
</tr>
3232
 
<tr>
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>
3234
 
<td></td>
3235
 
</tr>
3236
 
<tr>
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>
3239
 
</tr>
3240
 
<tr>
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>
3243
 
</tr>
3244
 
<tr>
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>
3248
 
</tr>
3249
 
<tr>
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>
3252
 
</tr>
3253
 
<tr>
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>
3256
 
</tr>
3257
 
</tbody>
3258
 
</table></div>
3259
 
</div>
3260
 
<hr>
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 &lt;&lt; 0),
3266
 
  GST_VIDEO_FRAME_FLAG_TFF          = (1 &lt;&lt; 1),
3267
 
  GST_VIDEO_FRAME_FLAG_RFF          = (1 &lt;&lt; 2),
3268
 
  GST_VIDEO_FRAME_FLAG_ONEFIELD     = (1 &lt;&lt; 3)
3269
 
} GstVideoFrameFlags;
3270
 
</pre>
3271
 
<p>
3272
 
Extra video frame flags
3273
 
</p>
3274
 
<div class="variablelist"><table border="0" class="variablelist">
3275
 
<colgroup>
3276
 
<col align="left" valign="top">
3277
 
<col>
3278
 
</colgroup>
3279
 
<tbody>
3280
 
<tr>
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>
3282
 
<td>no flags
3283
 
</td>
3284
 
</tr>
3285
 
<tr>
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
3289
 
          progressive.
3290
 
</td>
3291
 
</tr>
3292
 
<tr>
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
3295
 
</td>
3296
 
</tr>
3297
 
<tr>
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
3300
 
</td>
3301
 
</tr>
3302
 
<tr>
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
3305
 
</td>
3306
 
</tr>
3307
 
</tbody>
3308
 
</table></div>
3309
 
</div>
3310
 
<hr>
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>
3318
 
<p>
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>.
3321
 
</p>
3322
 
<p>
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.
3325
 
</p>
3326
 
<p>
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-&gt;data</code></em>.
3329
 
</p>
3330
 
<div class="variablelist"><table border="0" class="variablelist">
3331
 
<colgroup>
3332
 
<col align="left" valign="top">
3333
 
<col>
3334
 
</colgroup>
3335
 
<tbody>
3336
 
<tr>
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>
3339
 
</td>
3340
 
</tr>
3341
 
<tr>
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>
3344
 
</td>
3345
 
</tr>
3346
 
<tr>
3347
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
3348
 
<td>the buffer to map</td>
3349
 
</tr>
3350
 
<tr>
3351
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
3352
 
<td>the frame id to map</td>
3353
 
</tr>
3354
 
<tr>
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>
3357
 
</tr>
3358
 
<tr>
3359
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3360
 
<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>
3362
 
</tr>
3363
 
</tbody>
3364
 
</table></div>
3365
 
</div>
3366
 
<hr>
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>
3373
 
<p>
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>.
3375
 
</p>
3376
 
<p>
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-&gt;data</code></em>.
3379
 
</p>
3380
 
<div class="variablelist"><table border="0" class="variablelist">
3381
 
<colgroup>
3382
 
<col align="left" valign="top">
3383
 
<col>
3384
 
</colgroup>
3385
 
<tbody>
3386
 
<tr>
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>
3389
 
</td>
3390
 
</tr>
3391
 
<tr>
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>
3394
 
</td>
3395
 
</tr>
3396
 
<tr>
3397
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
3398
 
<td>the buffer to map</td>
3399
 
</tr>
3400
 
<tr>
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>
3403
 
</tr>
3404
 
<tr>
3405
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
3406
 
<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>
3408
 
</tr>
3409
 
</tbody>
3410
 
</table></div>
3411
 
</div>
3412
 
<hr>
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>
3416
 
<p>
3417
 
Unmap the memory previously mapped with gst_video_frame_map.
3418
 
</p>
3419
 
<div class="variablelist"><table border="0" class="variablelist">
3420
 
<colgroup>
3421
 
<col align="left" valign="top">
3422
 
<col>
 
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">
 
2651
<colgroup>
 
2652
<col width="150px" class="parameters_name">
 
2653
<col class="parameters_description">
 
2654
<col width="200px" class="parameters_annotations">
 
2655
</colgroup>
 
2656
<tbody>
 
2657
<tr>
 
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>
 
2661
</tr>
 
2662
<tr>
 
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>
 
2665
</p></td>
 
2666
<td class="parameter_annotations"> </td>
 
2667
</tr>
 
2668
<tr>
 
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>
 
2672
</tr>
 
2673
<tr>
 
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>
 
2676
</p></td>
 
2677
<td class="parameter_annotations"> </td>
 
2678
</tr>
 
2679
<tr>
 
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>
 
2683
</tr>
 
2684
</tbody>
 
2685
</table></div>
 
2686
</div>
 
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>
 
2690
<p></p>
 
2691
</div>
 
2692
</div>
 
2693
<hr>
 
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">
 
2703
<colgroup>
 
2704
<col width="150px" class="parameters_name">
 
2705
<col class="parameters_description">
 
2706
<col width="200px" class="parameters_annotations">
 
2707
</colgroup>
 
2708
<tbody>
 
2709
<tr>
 
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>
 
2713
</tr>
 
2714
<tr>
 
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>
 
2718
</tr>
 
2719
</tbody>
 
2720
</table></div>
 
2721
</div>
 
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>
 
2727
<p></p>
 
2728
</div>
 
2729
</div>
 
2730
<hr>
 
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>
 
2739
 is respected.</p>
 
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">
 
2746
<colgroup>
 
2747
<col width="150px" class="parameters_name">
 
2748
<col class="parameters_description">
 
2749
<col width="200px" class="parameters_annotations">
 
2750
</colgroup>
 
2751
<tbody>
 
2752
<tr>
 
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>
 
2756
</tr>
 
2757
<tr>
 
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>
 
2761
</tr>
 
2762
</tbody>
 
2763
</table></div>
 
2764
</div>
 
2765
</div>
 
2766
<hr>
 
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>
 
2780
.</p>
 
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-&gt;data</code></em>
 
2788
.</p>
 
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">
 
2792
<colgroup>
 
2793
<col width="150px" class="parameters_name">
 
2794
<col class="parameters_description">
 
2795
<col width="200px" class="parameters_annotations">
 
2796
</colgroup>
 
2797
<tbody>
 
2798
<tr>
 
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>
 
2802
</tr>
 
2803
<tr>
 
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>
 
2807
</tr>
 
2808
<tr>
 
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>
 
2812
</tr>
 
2813
<tr>
 
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>
 
2817
</tr>
 
2818
<tr>
 
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>
 
2822
</tr>
 
2823
</tbody>
 
2824
</table></div>
 
2825
</div>
 
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>
 
2829
<p></p>
 
2830
</div>
 
2831
</div>
 
2832
<hr>
 
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>
 
2843
.</p>
 
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-&gt;data</code></em>
 
2847
.</p>
 
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">
 
2851
<colgroup>
 
2852
<col width="150px" class="parameters_name">
 
2853
<col class="parameters_description">
 
2854
<col width="200px" class="parameters_annotations">
 
2855
</colgroup>
 
2856
<tbody>
 
2857
<tr>
 
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>
 
2861
</tr>
 
2862
<tr>
 
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>
 
2866
</tr>
 
2867
<tr>
 
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>
 
2871
</tr>
 
2872
<tr>
 
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>
 
2876
</tr>
 
2877
</tbody>
 
2878
</table></div>
 
2879
</div>
 
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>
 
2883
<p></p>
 
2884
</div>
 
2885
</div>
 
2886
<hr>
 
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">
 
2895
<colgroup>
 
2896
<col width="150px" class="parameters_name">
 
2897
<col class="parameters_description">
 
2898
<col width="200px" class="parameters_annotations">
3423
2899
</colgroup>
3424
2900
<tbody><tr>
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>
3427
 
</td>
 
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>
3428
2904
</tr></tbody>
3429
2905
</table></div>
3430
2906
</div>
3431
 
<hr>
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>
3436
 
<p>
3437
 
Copy the contents from <em class="parameter"><code>src</code></em> to <em class="parameter"><code>dest</code></em>.
3438
 
</p>
3439
 
<div class="variablelist"><table border="0" class="variablelist">
3440
 
<colgroup>
3441
 
<col align="left" valign="top">
3442
 
<col>
3443
 
</colgroup>
3444
 
<tbody>
3445
 
<tr>
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>
3448
 
</td>
3449
 
</tr>
3450
 
<tr>
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>
3453
 
</td>
3454
 
</tr>
3455
 
<tr>
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>
3458
 
</tr>
3459
 
</tbody>
3460
 
</table></div>
3461
 
</div>
3462
 
<hr>
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>
3468
 
<p>
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>.
3470
 
</p>
3471
 
<div class="variablelist"><table border="0" class="variablelist">
3472
 
<colgroup>
3473
 
<col align="left" valign="top">
3474
 
<col>
3475
 
</colgroup>
3476
 
<tbody>
3477
 
<tr>
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>
3480
 
</td>
3481
 
</tr>
3482
 
<tr>
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>
3485
 
</td>
3486
 
</tr>
3487
 
<tr>
3488
 
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
3489
 
<td>a plane</td>
3490
 
</tr>
3491
 
<tr>
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>
3494
 
</tr>
3495
 
</tbody>
3496
 
</table></div>
 
2907
</div>
 
2908
<hr>
 
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>
 
2916
.</p>
 
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">
 
2920
<colgroup>
 
2921
<col width="150px" class="parameters_name">
 
2922
<col class="parameters_description">
 
2923
<col width="200px" class="parameters_annotations">
 
2924
</colgroup>
 
2925
<tbody>
 
2926
<tr>
 
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>
 
2930
</tr>
 
2931
<tr>
 
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>
 
2935
</tr>
 
2936
</tbody>
 
2937
</table></div>
 
2938
</div>
 
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>
 
2942
<p></p>
 
2943
</div>
 
2944
</div>
 
2945
<hr>
 
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>
 
2955
.</p>
 
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">
 
2959
<colgroup>
 
2960
<col width="150px" class="parameters_name">
 
2961
<col class="parameters_description">
 
2962
<col width="200px" class="parameters_annotations">
 
2963
</colgroup>
 
2964
<tbody>
 
2965
<tr>
 
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>
 
2969
</tr>
 
2970
<tr>
 
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>
 
2974
</tr>
 
2975
<tr>
 
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>
 
2979
</tr>
 
2980
</tbody>
 
2981
</table></div>
 
2982
</div>
 
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>
 
2986
<p></p>
 
2987
</div>
3497
2988
</div>
3498
2989
<hr>
3499
2990
<div class="refsect2">
3639
3130
<pre class="programlisting">#define GST_VIDEO_FRAME_COMP_POFFSET(f,c) GST_VIDEO_INFO_COMP_POFFSET(&amp;(f)-&gt;info,(c))
3640
3131
</pre>
3641
3132
</div>
 
3133
</div>
 
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 {
 
3139
  guint padding_top;
 
3140
  guint padding_bottom;
 
3141
  guint padding_left;
 
3142
  guint padding_right;
 
3143
  guint stride_align[GST_VIDEO_MAX_PLANES];
 
3144
};
 
3145
</pre>
 
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">
 
3152
<colgroup>
 
3153
<col width="300px" class="struct_members_name">
 
3154
<col class="struct_members_description">
 
3155
<col width="200px" class="struct_members_annotations">
 
3156
</colgroup>
 
3157
<tbody>
 
3158
<tr>
 
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>
 
3162
</tr>
 
3163
<tr>
 
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>
 
3167
</tr>
 
3168
<tr>
 
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>
 
3172
</tr>
 
3173
<tr>
 
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>
 
3177
</tr>
 
3178
<tr>
 
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>
 
3182
</tr>
 
3183
</tbody>
 
3184
</table></div>
 
3185
</div>
 
3186
</div>
 
3187
<hr>
 
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"
 
3191
</pre>
 
3192
<p>This metadata is relevant for video streams.</p>
 
3193
<p class="since">Since 1.2</p>
 
3194
</div>
 
3195
<hr>
 
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"
 
3199
</pre>
 
3200
<p>This metadata stays relevant as long as video orientation is unchanged.</p>
 
3201
<p class="since">Since 1.2</p>
 
3202
</div>
 
3203
<hr>
 
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"
 
3207
</pre>
 
3208
<p>This metadata stays relevant as long as video size is unchanged.</p>
 
3209
<p class="since">Since 1.2</p>
 
3210
</div>
 
3211
<hr>
 
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"
 
3215
</pre>
 
3216
<p>This metadata stays relevant as long as video colorspace is unchanged.</p>
 
3217
<p class="since">Since 1.2</p>
 
3218
</div>
 
3219
<hr>
 
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">
 
3226
<colgroup>
 
3227
<col width="300px" class="enum_members_name">
 
3228
<col class="enum_members_description">
 
3229
<col width="200px" class="enum_members_annotations">
 
3230
</colgroup>
 
3231
<tbody>
 
3232
<tr>
 
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>
 
3236
</td>
 
3237
<td class="enum_member_annotations"> </td>
 
3238
</tr>
 
3239
<tr>
 
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>
 
3243
</td>
 
3244
<td class="enum_member_annotations"> </td>
 
3245
</tr>
 
3246
<tr>
 
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>
 
3250
</td>
 
3251
<td class="enum_member_annotations"> </td>
 
3252
</tr>
 
3253
<tr>
 
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>
 
3257
</td>
 
3258
<td class="enum_member_annotations"> </td>
 
3259
</tr>
 
3260
<tr>
 
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>
 
3264
</td>
 
3265
<td class="enum_member_annotations"> </td>
 
3266
</tr>
 
3267
<tr>
 
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>
 
3271
</td>
 
3272
<td class="enum_member_annotations"> </td>
 
3273
</tr>
 
3274
<tr>
 
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>
 
3278
</td>
 
3279
<td class="enum_member_annotations"> </td>
 
3280
</tr>
 
3281
<tr>
 
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>
 
3285
</td>
 
3286
<td class="enum_member_annotations"> </td>
 
3287
</tr>
 
3288
<tr>
 
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>
 
3292
</td>
 
3293
<td class="enum_member_annotations"> </td>
 
3294
</tr>
 
3295
<tr>
 
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>
 
3299
</td>
 
3300
<td class="enum_member_annotations"> </td>
 
3301
</tr>
 
3302
<tr>
 
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>
 
3306
</td>
 
3307
<td class="enum_member_annotations"> </td>
 
3308
</tr>
 
3309
<tr>
 
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>
 
3313
</td>
 
3314
<td class="enum_member_annotations"> </td>
 
3315
</tr>
 
3316
<tr>
 
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>
 
3320
</td>
 
3321
<td class="enum_member_annotations"> </td>
 
3322
</tr>
 
3323
<tr>
 
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>
 
3327
</td>
 
3328
<td class="enum_member_annotations"> </td>
 
3329
</tr>
 
3330
<tr>
 
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>
 
3334
</td>
 
3335
<td class="enum_member_annotations"> </td>
 
3336
</tr>
 
3337
<tr>
 
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">
 
3340
<p>rgb</p>
 
3341
</td>
 
3342
<td class="enum_member_annotations"> </td>
 
3343
</tr>
 
3344
<tr>
 
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">
 
3347
<p>reverse rgb</p>
 
3348
</td>
 
3349
<td class="enum_member_annotations"> </td>
 
3350
</tr>
 
3351
<tr>
 
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>
 
3355
</td>
 
3356
<td class="enum_member_annotations"> </td>
 
3357
</tr>
 
3358
<tr>
 
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>
 
3362
</td>
 
3363
<td class="enum_member_annotations"> </td>
 
3364
</tr>
 
3365
<tr>
 
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>
 
3369
</td>
 
3370
<td class="enum_member_annotations"> </td>
 
3371
</tr>
 
3372
<tr>
 
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>
 
3376
</td>
 
3377
<td class="enum_member_annotations"> </td>
 
3378
</tr>
 
3379
<tr>
 
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>
 
3383
</td>
 
3384
<td class="enum_member_annotations"> </td>
 
3385
</tr>
 
3386
<tr>
 
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>
 
3390
</td>
 
3391
<td class="enum_member_annotations"> </td>
 
3392
</tr>
 
3393
<tr>
 
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>
 
3397
</td>
 
3398
<td class="enum_member_annotations"> </td>
 
3399
</tr>
 
3400
<tr>
 
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>
 
3404
</td>
 
3405
<td class="enum_member_annotations"> </td>
 
3406
</tr>
 
3407
<tr>
 
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>
 
3411
</td>
 
3412
<td class="enum_member_annotations"> </td>
 
3413
</tr>
 
3414
<tr>
 
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>
 
3418
</td>
 
3419
<td class="enum_member_annotations"> </td>
 
3420
</tr>
 
3421
<tr>
 
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>
 
3425
</td>
 
3426
<td class="enum_member_annotations"> </td>
 
3427
</tr>
 
3428
<tr>
 
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>
 
3432
</td>
 
3433
<td class="enum_member_annotations"> </td>
 
3434
</tr>
 
3435
<tr>
 
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>
 
3439
</td>
 
3440
<td class="enum_member_annotations"> </td>
 
3441
</tr>
 
3442
<tr>
 
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>
 
3446
</td>
 
3447
<td class="enum_member_annotations"> </td>
 
3448
</tr>
 
3449
<tr>
 
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>
 
3453
</td>
 
3454
<td class="enum_member_annotations"> </td>
 
3455
</tr>
 
3456
<tr>
 
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>
 
3460
</td>
 
3461
<td class="enum_member_annotations"> </td>
 
3462
</tr>
 
3463
<tr>
 
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>
 
3467
</td>
 
3468
<td class="enum_member_annotations"> </td>
 
3469
</tr>
 
3470
<tr>
 
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>
 
3474
</td>
 
3475
<td class="enum_member_annotations"> </td>
 
3476
</tr>
 
3477
<tr>
 
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>
 
3481
</td>
 
3482
<td class="enum_member_annotations"> </td>
 
3483
</tr>
 
3484
<tr>
 
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>
 
3488
</td>
 
3489
<td class="enum_member_annotations"> </td>
 
3490
</tr>
 
3491
<tr>
 
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>
 
3495
</td>
 
3496
<td class="enum_member_annotations"> </td>
 
3497
</tr>
 
3498
<tr>
 
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>
 
3502
</td>
 
3503
<td class="enum_member_annotations"> </td>
 
3504
</tr>
 
3505
<tr>
 
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>
 
3509
</td>
 
3510
<td class="enum_member_annotations"> </td>
 
3511
</tr>
 
3512
<tr>
 
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>
 
3516
</td>
 
3517
<td class="enum_member_annotations"> </td>
 
3518
</tr>
 
3519
<tr>
 
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>
 
3523
</td>
 
3524
<td class="enum_member_annotations"> </td>
 
3525
</tr>
 
3526
<tr>
 
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>
 
3530
</td>
 
3531
<td class="enum_member_annotations"> </td>
 
3532
</tr>
 
3533
<tr>
 
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>
 
3537
</td>
 
3538
<td class="enum_member_annotations"> </td>
 
3539
</tr>
 
3540
<tr>
 
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>
 
3544
</td>
 
3545
<td class="enum_member_annotations"> </td>
 
3546
</tr>
 
3547
<tr>
 
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>
 
3551
</td>
 
3552
<td class="enum_member_annotations"> </td>
 
3553
</tr>
 
3554
<tr>
 
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>
 
3558
</td>
 
3559
<td class="enum_member_annotations"> </td>
 
3560
</tr>
 
3561
<tr>
 
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>
 
3565
</td>
 
3566
<td class="enum_member_annotations"> </td>
 
3567
</tr>
 
3568
<tr>
 
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>
 
3572
</td>
 
3573
<td class="enum_member_annotations"> </td>
 
3574
</tr>
 
3575
<tr>
 
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>
 
3579
</td>
 
3580
<td class="enum_member_annotations"> </td>
 
3581
</tr>
 
3582
<tr>
 
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>
 
3586
</td>
 
3587
<td class="enum_member_annotations"> </td>
 
3588
</tr>
 
3589
<tr>
 
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>
 
3593
</td>
 
3594
<td class="enum_member_annotations"> </td>
 
3595
</tr>
 
3596
<tr>
 
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>
 
3600
</td>
 
3601
<td class="enum_member_annotations"> </td>
 
3602
</tr>
 
3603
</tbody>
 
3604
</table></div>
 
3605
</div>
 
3606
</div>
 
3607
<hr>
 
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
 
3611
</pre>
 
3612
</div>
 
3613
<hr>
 
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
 
3617
</pre>
 
3618
</div>
 
3619
<hr>
 
3620
<div class="refsect2">
 
3621
<a name="GstVideoFormatInfo"></a><h3>struct GstVideoFormatInfo</h3>
 
3622
<pre class="programlisting">struct GstVideoFormatInfo {
 
3623
  GstVideoFormat format;
 
3624
  const gchar *name;
 
3625
  const gchar *description;
 
3626
  GstVideoFormatFlags flags;
 
3627
  guint bits;
 
3628
  guint n_components;
 
3629
  guint shift[GST_VIDEO_MAX_COMPONENTS];
 
3630
  guint depth[GST_VIDEO_MAX_COMPONENTS];
 
3631
  gint  pixel_stride[GST_VIDEO_MAX_COMPONENTS];
 
3632
  guint n_planes;
 
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];
 
3637
 
 
3638
  GstVideoFormat unpack_format;
 
3639
  GstVideoFormatUnpack unpack_func;
 
3640
  gint pack_lines;
 
3641
  GstVideoFormatPack pack_func;
 
3642
 
 
3643
  gpointer _gst_reserved[GST_PADDING];
 
3644
};
 
3645
</pre>
 
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">
 
3650
<colgroup>
 
3651
<col width="300px" class="struct_members_name">
 
3652
<col class="struct_members_description">
 
3653
<col width="200px" class="struct_members_annotations">
 
3654
</colgroup>
 
3655
<tbody>
 
3656
<tr>
 
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>
 
3660
</tr>
 
3661
<tr>
 
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>
 
3665
</tr>
 
3666
<tr>
 
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>
 
3670
</tr>
 
3671
<tr>
 
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>
 
3675
</tr>
 
3676
<tr>
 
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 &gt; 8 multiple bytes
 
3680
should be read according to the endianness flag before applying the shift
 
3681
and mask.</p></td>
 
3682
<td class="struct_member_annotations"> </td>
 
3683
</tr>
 
3684
<tr>
 
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>
 
3688
</tr>
 
3689
<tr>
 
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>
 
3693
</tr>
 
3694
<tr>
 
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>
 
3698
</tr>
 
3699
<tr>
 
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 &lt; 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>
 
3706
</tr>
 
3707
<tr>
 
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
 
3711
one plane.</p></td>
 
3712
<td class="struct_member_annotations"> </td>
 
3713
</tr>
 
3714
<tr>
 
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>
 
3718
</tr>
 
3719
<tr>
 
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>
 
3724
</tr>
 
3725
<tr>
 
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>
 
3730
</tr>
 
3731
<tr>
 
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>
 
3736
</tr>
 
3737
<tr>
 
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>
 
3742
</tr>
 
3743
<tr>
 
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>
 
3747
</tr>
 
3748
<tr>
 
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>
 
3752
</tr>
 
3753
<tr>
 
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>
 
3757
</tr>
 
3758
<tr>
 
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>
 
3760
<td> </td>
 
3761
<td> </td>
 
3762
</tr>
 
3763
</tbody>
 
3764
</table></div>
 
3765
</div>
 
3766
</div>
 
3767
<hr>
 
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">
 
3774
<colgroup>
 
3775
<col width="300px" class="enum_members_name">
 
3776
<col class="enum_members_description">
 
3777
<col width="200px" class="enum_members_annotations">
 
3778
</colgroup>
 
3779
<tbody>
 
3780
<tr>
 
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>
 
3784
</td>
 
3785
<td class="enum_member_annotations"> </td>
 
3786
</tr>
 
3787
<tr>
 
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">
 
3790
<p>no cositing</p>
 
3791
</td>
 
3792
<td class="enum_member_annotations"> </td>
 
3793
</tr>
 
3794
<tr>
 
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>
 
3798
</td>
 
3799
<td class="enum_member_annotations"> </td>
 
3800
</tr>
 
3801
<tr>
 
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>
 
3805
</td>
 
3806
<td class="enum_member_annotations"> </td>
 
3807
</tr>
 
3808
<tr>
 
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>
 
3812
</td>
 
3813
<td class="enum_member_annotations"> </td>
 
3814
</tr>
 
3815
<tr>
 
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>
 
3819
</td>
 
3820
<td class="enum_member_annotations"> </td>
 
3821
</tr>
 
3822
<tr>
 
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>
 
3826
</td>
 
3827
<td class="enum_member_annotations"> </td>
 
3828
</tr>
 
3829
<tr>
 
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>
 
3833
</td>
 
3834
<td class="enum_member_annotations"> </td>
 
3835
</tr>
 
3836
<tr>
 
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>
 
3840
</td>
 
3841
<td class="enum_member_annotations"> </td>
 
3842
</tr>
 
3843
</tbody>
 
3844
</table></div>
 
3845
</div>
 
3846
</div>
 
3847
<hr>
 
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">
 
3854
<colgroup>
 
3855
<col width="300px" class="enum_members_name">
 
3856
<col class="enum_members_description">
 
3857
<col width="200px" class="enum_members_annotations">
 
3858
</colgroup>
 
3859
<tbody>
 
3860
<tr>
 
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
 
3864
  0=Y, 1=U, 2=V.</p>
 
3865
</td>
 
3866
<td class="enum_member_annotations"> </td>
 
3867
</tr>
 
3868
<tr>
 
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
 
3872
  0=R, 1=G, 2=B.</p>
 
3873
</td>
 
3874
<td class="enum_member_annotations"> </td>
 
3875
</tr>
 
3876
<tr>
 
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
 
3880
  with index 0.</p>
 
3881
</td>
 
3882
<td class="enum_member_annotations"> </td>
 
3883
</tr>
 
3884
<tr>
 
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
 
3888
  the number 3.</p>
 
3889
</td>
 
3890
<td class="enum_member_annotations"> </td>
 
3891
</tr>
 
3892
<tr>
 
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
 
3896
  endianness.</p>
 
3897
</td>
 
3898
<td class="enum_member_annotations"> </td>
 
3899
</tr>
 
3900
<tr>
 
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>
 
3905
</td>
 
3906
<td class="enum_member_annotations"> </td>
 
3907
</tr>
 
3908
<tr>
 
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>
 
3913
</td>
 
3914
<td class="enum_member_annotations"> </td>
 
3915
</tr>
 
3916
<tr>
 
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>
 
3921
</td>
 
3922
<td class="enum_member_annotations"> </td>
 
3923
</tr>
 
3924
</tbody>
 
3925
</table></div>
 
3926
</div>
 
3927
</div>
 
3928
<hr>
 
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">
 
3935
<colgroup>
 
3936
<col width="300px" class="enum_members_name">
 
3937
<col class="enum_members_description">
 
3938
<col width="200px" class="enum_members_annotations">
 
3939
</colgroup>
 
3940
<tbody>
 
3941
<tr>
 
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">
 
3944
<p>No flag</p>
 
3945
</td>
 
3946
<td class="enum_member_annotations"> </td>
 
3947
</tr>
 
3948
<tr>
 
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>
 
3956
</td>
 
3957
<td class="enum_member_annotations"> </td>
 
3958
</tr>
 
3959
<tr>
 
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>
 
3965
</td>
 
3966
<td class="enum_member_annotations"> </td>
 
3967
</tr>
 
3968
</tbody>
 
3969
</table></div>
 
3970
</div>
 
3971
</div>
 
3972
<hr>
 
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 ]"
 
3976
</pre>
 
3977
</div>
 
3978
<hr>
 
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 ]"
 
3982
</pre>
 
3983
</div>
 
3984
<hr>
 
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>
 
3988
</div>
 
3989
<hr>
 
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">
 
3997
<colgroup>
 
3998
<col width="300px" class="enum_members_name">
 
3999
<col class="enum_members_description">
 
4000
<col width="200px" class="enum_members_annotations">
 
4001
</colgroup>
 
4002
<tbody>
 
4003
<tr>
 
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>
 
4007
</td>
 
4008
<td class="enum_member_annotations"> </td>
 
4009
</tr>
 
4010
<tr>
 
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>
 
4014
</td>
 
4015
<td class="enum_member_annotations"> </td>
 
4016
</tr>
 
4017
<tr>
 
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>
 
4022
</td>
 
4023
<td class="enum_member_annotations"> </td>
 
4024
</tr>
 
4025
</tbody>
 
4026
</table></div>
 
4027
</div>
 
4028
</div>
 
4029
<hr>
 
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">
 
4037
<colgroup>
 
4038
<col width="300px" class="enum_members_name">
 
4039
<col class="enum_members_description">
 
4040
<col width="200px" class="enum_members_annotations">
 
4041
</colgroup>
 
4042
<tbody>
 
4043
<tr>
 
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>
 
4047
</td>
 
4048
<td class="enum_member_annotations"> </td>
 
4049
</tr>
 
4050
<tr>
 
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>
 
4054
</td>
 
4055
<td class="enum_member_annotations"> </td>
 
4056
</tr>
 
4057
<tr>
 
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>
 
4061
</td>
 
4062
<td class="enum_member_annotations"> </td>
 
4063
</tr>
 
4064
<tr>
 
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>
 
4068
</td>
 
4069
<td class="enum_member_annotations"> </td>
 
4070
</tr>
 
4071
<tr>
 
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>
 
4075
</td>
 
4076
<td class="enum_member_annotations"> </td>
 
4077
</tr>
 
4078
<tr>
 
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>
 
4082
</td>
 
4083
<td class="enum_member_annotations"> </td>
 
4084
</tr>
 
4085
</tbody>
 
4086
</table></div>
 
4087
</div>
 
4088
</div>
 
4089
<hr>
 
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">
 
4097
<colgroup>
 
4098
<col width="300px" class="enum_members_name">
 
4099
<col class="enum_members_description">
 
4100
<col width="200px" class="enum_members_annotations">
 
4101
</colgroup>
 
4102
<tbody>
 
4103
<tr>
 
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>
 
4107
</td>
 
4108
<td class="enum_member_annotations"> </td>
 
4109
</tr>
 
4110
<tr>
 
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>
 
4114
</td>
 
4115
<td class="enum_member_annotations"> </td>
 
4116
</tr>
 
4117
<tr>
 
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>
 
4121
</td>
 
4122
<td class="enum_member_annotations"> </td>
 
4123
</tr>
 
4124
<tr>
 
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>
 
4128
</td>
 
4129
<td class="enum_member_annotations"> </td>
 
4130
</tr>
 
4131
<tr>
 
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>
 
4135
</td>
 
4136
<td class="enum_member_annotations"> </td>
 
4137
</tr>
 
4138
<tr>
 
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
 
4142
                          range</p>
 
4143
</td>
 
4144
<td class="enum_member_annotations"> </td>
 
4145
</tr>
 
4146
<tr>
 
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
 
4150
                              lower range</p>
 
4151
</td>
 
4152
<td class="enum_member_annotations"> </td>
 
4153
</tr>
 
4154
<tr>
 
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
 
4158
                         range</p>
 
4159
</td>
 
4160
<td class="enum_member_annotations"> </td>
 
4161
</tr>
 
4162
<tr>
 
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>
 
4166
</td>
 
4167
<td class="enum_member_annotations"> </td>
 
4168
</tr>
 
4169
<tr>
 
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
 
4173
                            100:1 range</p>
 
4174
</td>
 
4175
<td class="enum_member_annotations"> </td>
 
4176
</tr>
 
4177
<tr>
 
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>
 
4182
</td>
 
4183
<td class="enum_member_annotations"> </td>
 
4184
</tr>
 
4185
</tbody>
 
4186
</table></div>
 
4187
</div>
 
4188
</div>
 
4189
<hr>
 
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">
 
4197
<colgroup>
 
4198
<col width="300px" class="enum_members_name">
 
4199
<col class="enum_members_description">
 
4200
<col width="200px" class="enum_members_annotations">
 
4201
</colgroup>
 
4202
<tbody>
 
4203
<tr>
 
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>
 
4207
</td>
 
4208
<td class="enum_member_annotations"> </td>
 
4209
</tr>
 
4210
<tr>
 
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>
 
4214
</td>
 
4215
<td class="enum_member_annotations"> </td>
 
4216
</tr>
 
4217
<tr>
 
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>
 
4221
</td>
 
4222
<td class="enum_member_annotations"> </td>
 
4223
</tr>
 
4224
<tr>
 
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>
 
4228
</td>
 
4229
<td class="enum_member_annotations"> </td>
 
4230
</tr>
 
4231
<tr>
 
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>
 
4235
</td>
 
4236
<td class="enum_member_annotations"> </td>
 
4237
</tr>
 
4238
<tr>
 
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>
 
4242
</td>
 
4243
<td class="enum_member_annotations"> </td>
 
4244
</tr>
 
4245
<tr>
 
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">
 
4248
<p>Generic film</p>
 
4249
</td>
 
4250
<td class="enum_member_annotations"> </td>
 
4251
</tr>
 
4252
</tbody>
 
4253
</table></div>
 
4254
</div>
 
4255
</div>
 
4256
<hr>
 
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;
 
4265
</pre>
 
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">
 
4270
<colgroup>
 
4271
<col width="300px" class="struct_members_name">
 
4272
<col class="struct_members_description">
 
4273
<col width="200px" class="struct_members_annotations">
 
4274
</colgroup>
 
4275
<tbody>
 
4276
<tr>
 
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>
 
4281
</tr>
 
4282
<tr>
 
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>
 
4287
</tr>
 
4288
<tr>
 
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>
 
4292
</tr>
 
4293
<tr>
 
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>
 
4297
</tr>
 
4298
</tbody>
 
4299
</table></div>
 
4300
</div>
 
4301
</div>
 
4302
<hr>
 
4303
<div class="refsect2">
 
4304
<a name="GstVideoInfo"></a><h3>struct GstVideoInfo</h3>
 
4305
<pre class="programlisting">struct GstVideoInfo {
 
4306
  const GstVideoFormatInfo *finfo;
 
4307
 
 
4308
  GstVideoInterlaceMode     interlace_mode;
 
4309
  GstVideoFlags             flags;
 
4310
  gint                      width;
 
4311
  gint                      height;
 
4312
  gsize                     size;
 
4313
  gint                      views;
 
4314
 
 
4315
  GstVideoChromaSite        chroma_site;
 
4316
  GstVideoColorimetry       colorimetry;
 
4317
 
 
4318
  gint                      par_n;
 
4319
  gint                      par_d;
 
4320
  gint                      fps_n;
 
4321
  gint                      fps_d;
 
4322
 
 
4323
  gsize                     offset[GST_VIDEO_MAX_PLANES];
 
4324
  gint                      stride[GST_VIDEO_MAX_PLANES];
 
4325
};
 
4326
</pre>
 
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">
 
4335
<colgroup>
 
4336
<col width="300px" class="struct_members_name">
 
4337
<col class="struct_members_description">
 
4338
<col width="200px" class="struct_members_annotations">
 
4339
</colgroup>
 
4340
<tbody>
 
4341
<tr>
 
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>
 
4345
</tr>
 
4346
<tr>
 
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>
 
4350
</tr>
 
4351
<tr>
 
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>
 
4355
</tr>
 
4356
<tr>
 
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>
 
4360
</tr>
 
4361
<tr>
 
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>
 
4365
</tr>
 
4366
<tr>
 
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>
 
4370
</tr>
 
4371
<tr>
 
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>
 
4375
</tr>
 
4376
<tr>
 
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>
 
4380
</tr>
 
4381
<tr>
 
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>
 
4385
</tr>
 
4386
<tr>
 
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>
 
4390
</tr>
 
4391
<tr>
 
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>
 
4395
</tr>
 
4396
<tr>
 
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>
 
4400
</tr>
 
4401
<tr>
 
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>
 
4405
</tr>
 
4406
<tr>
 
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>
 
4410
</tr>
 
4411
<tr>
 
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>
 
4415
</tr>
 
4416
</tbody>
 
4417
</table></div>
 
4418
</div>
 
4419
</div>
 
4420
<hr>
 
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">
 
4428
<colgroup>
 
4429
<col width="300px" class="enum_members_name">
 
4430
<col class="enum_members_description">
 
4431
<col width="200px" class="enum_members_annotations">
 
4432
</colgroup>
 
4433
<tbody>
 
4434
<tr>
 
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>
 
4438
</td>
 
4439
<td class="enum_member_annotations"> </td>
 
4440
</tr>
 
4441
<tr>
 
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>
 
4446
</td>
 
4447
<td class="enum_member_annotations"> </td>
 
4448
</tr>
 
4449
<tr>
 
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>
 
4454
</td>
 
4455
<td class="enum_member_annotations"> </td>
 
4456
</tr>
 
4457
<tr>
 
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 &gt; 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>
 
4467
</td>
 
4468
<td class="enum_member_annotations"> </td>
 
4469
</tr>
 
4470
</tbody>
 
4471
</table></div>
 
4472
</div>
 
4473
</div>
 
4474
<hr>
 
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">
 
4481
<colgroup>
 
4482
<col width="300px" class="enum_members_name">
 
4483
<col class="enum_members_description">
 
4484
<col width="200px" class="enum_members_annotations">
 
4485
</colgroup>
 
4486
<tbody>
 
4487
<tr>
 
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">
 
4490
<p>no flags</p>
 
4491
</td>
 
4492
<td class="enum_member_annotations"> </td>
 
4493
</tr>
 
4494
<tr>
 
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>
 
4499
</td>
 
4500
<td class="enum_member_annotations"> </td>
 
4501
</tr>
 
4502
<tr>
 
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
 
4506
    value.</p>
 
4507
</td>
 
4508
<td class="enum_member_annotations"> </td>
 
4509
</tr>
 
4510
</tbody>
 
4511
</table></div>
 
4512
</div>
 
4513
</div>
 
4514
<hr>
 
4515
<div class="refsect2">
 
4516
<a name="GstVideoFrame"></a><h3>struct GstVideoFrame</h3>
 
4517
<pre class="programlisting">struct GstVideoFrame {
 
4518
  GstVideoInfo info;
 
4519
  GstVideoFrameFlags flags;
 
4520
 
 
4521
  GstBuffer *buffer;
 
4522
  gpointer   meta;
 
4523
  gint       id;
 
4524
 
 
4525
  gpointer   data[GST_VIDEO_MAX_PLANES];
 
4526
  GstMapInfo map[GST_VIDEO_MAX_PLANES];
 
4527
};
 
4528
</pre>
 
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">
 
4533
<colgroup>
 
4534
<col width="300px" class="struct_members_name">
 
4535
<col class="struct_members_description">
 
4536
<col width="200px" class="struct_members_annotations">
 
4537
</colgroup>
 
4538
<tbody>
 
4539
<tr>
 
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>
 
4543
</tr>
 
4544
<tr>
 
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>
 
4546
<td> </td>
 
4547
<td> </td>
 
4548
</tr>
 
4549
<tr>
 
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>
 
4553
</tr>
 
4554
<tr>
 
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>
 
4558
</tr>
 
4559
<tr>
 
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>
 
4564
</tr>
 
4565
<tr>
 
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>
 
4569
</tr>
 
4570
<tr>
 
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>
 
4574
</tr>
 
4575
</tbody>
 
4576
</table></div>
 
4577
</div>
 
4578
</div>
 
4579
<hr>
 
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">
 
4586
<colgroup>
 
4587
<col width="300px" class="enum_members_name">
 
4588
<col class="enum_members_description">
 
4589
<col width="200px" class="enum_members_annotations">
 
4590
</colgroup>
 
4591
<tbody>
 
4592
<tr>
 
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">
 
4595
<p>no flags</p>
 
4596
</td>
 
4597
<td class="enum_member_annotations"> </td>
 
4598
</tr>
 
4599
<tr>
 
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
 
4604
          progressive.</p>
 
4605
</td>
 
4606
<td class="enum_member_annotations"> </td>
 
4607
</tr>
 
4608
<tr>
 
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>
 
4612
</td>
 
4613
<td class="enum_member_annotations"> </td>
 
4614
</tr>
 
4615
<tr>
 
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>
 
4619
</td>
 
4620
<td class="enum_member_annotations"> </td>
 
4621
</tr>
 
4622
<tr>
 
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>
 
4626
</td>
 
4627
<td class="enum_member_annotations"> </td>
 
4628
</tr>
 
4629
</tbody>
 
4630
</table></div>
 
4631
</div>
 
4632
</div>
3642
4633
<hr>
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 &lt;&lt; 0),
3647
 
  GST_VIDEO_BUFFER_FLAG_TFF         = (GST_BUFFER_FLAG_LAST &lt;&lt; 1),
3648
 
  GST_VIDEO_BUFFER_FLAG_RFF         = (GST_BUFFER_FLAG_LAST &lt;&lt; 2),
3649
 
  GST_VIDEO_BUFFER_FLAG_ONEFIELD    = (GST_BUFFER_FLAG_LAST &lt;&lt; 3),
3650
 
 
3651
 
  GST_VIDEO_BUFFER_FLAG_LAST        = (GST_BUFFER_FLAG_LAST &lt;&lt; 8)
3652
 
} GstVideoBufferFlags;
3653
 
</pre>
3654
 
<p>
3655
 
Additional video buffer flags.
3656
 
</p>
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">
3658
4640
<colgroup>
3659
 
<col align="left" valign="top">
3660
 
<col>
 
4641
<col width="300px" class="enum_members_name">
 
4642
<col class="enum_members_description">
 
4643
<col width="200px" class="enum_members_annotations">
3661
4644
</colgroup>
3662
4645
<tbody>
3663
4646
<tr>
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>
3668
4652
</td>
 
4653
<td class="enum_member_annotations"> </td>
3669
4654
</tr>
3670
4655
<tr>
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>
3675
4661
</td>
 
4662
<td class="enum_member_annotations"> </td>
3676
4663
</tr>
3677
4664
<tr>
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)
3681
 
                                    is repeated.
 
4669
                                    is repeated.</p>
3682
4670
</td>
 
4671
<td class="enum_member_annotations"> </td>
3683
4672
</tr>
3684
4673
<tr>
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>
3689
4679
</td>
 
4680
<td class="enum_member_annotations"> </td>
3690
4681
</tr>
3691
4682
<tr>
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>
3693
 
<td></td>
 
4683
<td class="enum_member_name"><p><a name="GST-VIDEO-BUFFER-FLAG-LAST:CAPS"></a>GST_VIDEO_BUFFER_FLAG_LAST</p></td>
 
4684
<td> </td>
 
4685
<td> </td>
3694
4686
</tr>
3695
4687
</tbody>
3696
4688
</table></div>
3697
4689
</div>
3698
4690
</div>
3699
4691
</div>
 
4692
</div>
3700
4693
<div class="footer">
3701
4694
<hr>
3702
 
          Generated by GTK-Doc V1.19</div>
 
4695
          Generated by GTK-Doc V1.20</div>
3703
4696
</body>
3704
4697
</html>
 
 
b'\\ No newline at end of file'