1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>GstVideo Ancillary: GStreamer Base Plugins 1.0 Library Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual"> 8<link rel="up" href="gstreamer-video.html" title="Video Library"> 9<link rel="prev" href="GstNavigation.html" title="GstNavigation"> 10<link rel="next" href="gl.html" title="OpenGL Integration Library"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><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-Ancillary.description" class="shortcut">Description</a></span> 19</td> 20<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 21<td><a accesskey="u" href="gstreamer-video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 22<td><a accesskey="p" href="GstNavigation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 23<td><a accesskey="n" href="gl.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 24</tr></table> 25<div class="refentry"> 26<a name="gst-plugins-base-libs-GstVideo-Ancillary"></a><div class="titlepage"></div> 27<div class="refnamediv"><table width="100%"><tr> 28<td valign="top"> 29<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstVideo-Ancillary.top_of_page"></a>GstVideo Ancillary</span></h2> 30<p>GstVideo Ancillary — Utilities for Ancillary data, VBI and Closed Caption</p> 31</td> 32<td class="gallery_image" valign="top" align="right"></td> 33</tr></table></div> 34<div class="refsect1"> 35<a name="gst-plugins-base-libs-GstVideo-Ancillary.functions"></a><h2>Functions</h2> 36<div class="informaltable"><table class="informaltable" width="100%" border="0"> 37<colgroup> 38<col width="150px" class="functions_return"> 39<col class="functions_name"> 40</colgroup> 41<tbody> 42<tr> 43<td class="define_keyword">#define</td> 44<td class="function_name"> 45<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GST-VIDEO-ANCILLARY-DID16:CAPS" title="GST_VIDEO_ANCILLARY_DID16()">GST_VIDEO_ANCILLARY_DID16</a><span class="c_punctuation">()</span> 46</td> 47</tr> 48<tr> 49<td class="function_type"> 50<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="returnvalue">GstVideoVBIParser</span></a> * 51</td> 52<td class="function_name"> 53<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-new" title="gst_video_vbi_parser_new ()">gst_video_vbi_parser_new</a> <span class="c_punctuation">()</span> 54</td> 55</tr> 56<tr> 57<td class="function_type"> 58<span class="returnvalue">void</span> 59</td> 60<td class="function_name"> 61<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-free" title="gst_video_vbi_parser_free ()">gst_video_vbi_parser_free</a> <span class="c_punctuation">()</span> 62</td> 63</tr> 64<tr> 65<td class="function_type"> 66<span class="returnvalue">void</span> 67</td> 68<td class="function_name"> 69<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-add-line" title="gst_video_vbi_parser_add_line ()">gst_video_vbi_parser_add_line</a> <span class="c_punctuation">()</span> 70</td> 71</tr> 72<tr> 73<td class="function_type"> 74<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParserResult" title="enum GstVideoVBIParserResult"><span class="returnvalue">GstVideoVBIParserResult</span></a> 75</td> 76<td class="function_name"> 77<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-get-ancillary" title="gst_video_vbi_parser_get_ancillary ()">gst_video_vbi_parser_get_ancillary</a> <span class="c_punctuation">()</span> 78</td> 79</tr> 80<tr> 81<td class="function_type"> 82<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="returnvalue">GstVideoVBIParser</span></a> * 83</td> 84<td class="function_name"> 85<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-copy" title="gst_video_vbi_parser_copy ()">gst_video_vbi_parser_copy</a> <span class="c_punctuation">()</span> 86</td> 87</tr> 88<tr> 89<td class="function_type"> 90<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="returnvalue">GstVideoVBIEncoder</span></a> * 91</td> 92<td class="function_name"> 93<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-encoder-new" title="gst_video_vbi_encoder_new ()">gst_video_vbi_encoder_new</a> <span class="c_punctuation">()</span> 94</td> 95</tr> 96<tr> 97<td class="function_type"> 98<span class="returnvalue">void</span> 99</td> 100<td class="function_name"> 101<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-encoder-free" title="gst_video_vbi_encoder_free ()">gst_video_vbi_encoder_free</a> <span class="c_punctuation">()</span> 102</td> 103</tr> 104<tr> 105<td class="function_type"> 106<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 107</td> 108<td class="function_name"> 109<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-encoder-add-ancillary" title="gst_video_vbi_encoder_add_ancillary ()">gst_video_vbi_encoder_add_ancillary</a> <span class="c_punctuation">()</span> 110</td> 111</tr> 112<tr> 113<td class="function_type"> 114<span class="returnvalue">void</span> 115</td> 116<td class="function_name"> 117<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-encoder-write-line" title="gst_video_vbi_encoder_write_line ()">gst_video_vbi_encoder_write_line</a> <span class="c_punctuation">()</span> 118</td> 119</tr> 120<tr> 121<td class="function_type"> 122<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="returnvalue">GstVideoVBIEncoder</span></a> * 123</td> 124<td class="function_name"> 125<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-encoder-copy" title="gst_video_vbi_encoder_copy ()">gst_video_vbi_encoder_copy</a> <span class="c_punctuation">()</span> 126</td> 127</tr> 128<tr> 129<td class="define_keyword">#define</td> 130<td class="function_name"> 131<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-buffer-get-video-caption-meta" title="gst_buffer_get_video_caption_meta()">gst_buffer_get_video_caption_meta</a><span class="c_punctuation">()</span> 132</td> 133</tr> 134<tr> 135<td class="function_type"> 136<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="returnvalue">GstVideoCaptionMeta</span></a> * 137</td> 138<td class="function_name"> 139<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-buffer-add-video-caption-meta" title="gst_buffer_add_video_caption_meta ()">gst_buffer_add_video_caption_meta</a> <span class="c_punctuation">()</span> 140</td> 141</tr> 142<tr> 143<td class="function_type"> 144<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="returnvalue">GstVideoCaptionType</span></a> 145</td> 146<td class="function_name"> 147<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-caption-type-from-caps" title="gst_video_caption_type_from_caps ()">gst_video_caption_type_from_caps</a> <span class="c_punctuation">()</span> 148</td> 149</tr> 150<tr> 151<td class="function_type"> 152<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="returnvalue">GstCaps</span></a> * 153</td> 154<td class="function_name"> 155<a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-caption-type-to-caps" title="gst_video_caption_type_to_caps ()">gst_video_caption_type_to_caps</a> <span class="c_punctuation">()</span> 156</td> 157</tr> 158</tbody> 159</table></div> 160</div> 161<div class="refsect1"> 162<a name="gst-plugins-base-libs-GstVideo-Ancillary.other"></a><h2>Types and Values</h2> 163<div class="informaltable"><table class="informaltable" width="100%" border="0"> 164<colgroup> 165<col width="150px" class="name"> 166<col class="description"> 167</colgroup> 168<tbody> 169<tr> 170<td class="datatype_keyword">struct</td> 171<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillary" title="struct GstVideoAncillary">GstVideoAncillary</a></td> 172</tr> 173<tr> 174<td class="datatype_keyword">enum</td> 175<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillaryDID" title="enum GstVideoAncillaryDID">GstVideoAncillaryDID</a></td> 176</tr> 177<tr> 178<td class="datatype_keyword">enum</td> 179<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillaryDID16" title="enum GstVideoAncillaryDID16">GstVideoAncillaryDID16</a></td> 180</tr> 181<tr> 182<td class="datatype_keyword"> </td> 183<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser">GstVideoVBIParser</a></td> 184</tr> 185<tr> 186<td class="datatype_keyword">enum</td> 187<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParserResult" title="enum GstVideoVBIParserResult">GstVideoVBIParserResult</a></td> 188</tr> 189<tr> 190<td class="datatype_keyword"> </td> 191<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder">GstVideoVBIEncoder</a></td> 192</tr> 193<tr> 194<td class="datatype_keyword">enum</td> 195<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType">GstVideoCaptionType</a></td> 196</tr> 197<tr> 198<td class="datatype_keyword"> </td> 199<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta">GstVideoCaptionMeta</a></td> 200</tr> 201</tbody> 202</table></div> 203</div> 204<div class="refsect1"> 205<a name="gst-plugins-base-libs-GstVideo-Ancillary.includes"></a><h2>Includes</h2> 206<pre class="synopsis">#include <gst/video/video.h> 207</pre> 208</div> 209<div class="refsect1"> 210<a name="gst-plugins-base-libs-GstVideo-Ancillary.description"></a><h2>Description</h2> 211<p>A collection of objects and methods to assist with handling Ancillary Data 212present in Vertical Blanking Interval as well as Closed Caption.</p> 213</div> 214<div class="refsect1"> 215<a name="gst-plugins-base-libs-GstVideo-Ancillary.functions_details"></a><h2>Functions</h2> 216<div class="refsect2"> 217<a name="GST-VIDEO-ANCILLARY-DID16:CAPS"></a><h3>GST_VIDEO_ANCILLARY_DID16()</h3> 218<pre class="programlisting">#define GST_VIDEO_ANCILLARY_DID16(anc) ((guint16)((anc)->DID) << 8 | (guint16)((anc)->SDID_block_number)) 219</pre> 220<p>Returns the <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillaryDID16" title="enum GstVideoAncillaryDID16"><span class="type">GstVideoAncillaryDID16</span></a> of the ancillary data.</p> 221<div class="refsect3"> 222<a name="GST-VIDEO-ANCILLARY-DID16.parameters"></a><h4>Parameters</h4> 223<div class="informaltable"><table class="informaltable" width="100%" border="0"> 224<colgroup> 225<col width="150px" class="parameters_name"> 226<col class="parameters_description"> 227<col width="200px" class="parameters_annotations"> 228</colgroup> 229<tbody><tr> 230<td class="parameter_name"><p>anc</p></td> 231<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillary" title="struct GstVideoAncillary"><span class="type">GstVideoAncillary</span></a></p></td> 232<td class="parameter_annotations"> </td> 233</tr></tbody> 234</table></div> 235</div> 236<div class="refsect3"> 237<a name="GST-VIDEO-ANCILLARY-DID16.returns"></a><h4>Returns</h4> 238<p> a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillaryDID16" title="enum GstVideoAncillaryDID16"><span class="type">GstVideoAncillaryDID16</span></a> identifier</p> 239</div> 240<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 241</div> 242<hr> 243<div class="refsect2"> 244<a name="gst-video-vbi-parser-new"></a><h3>gst_video_vbi_parser_new ()</h3> 245<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="returnvalue">GstVideoVBIParser</span></a> * 246gst_video_vbi_parser_new (<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>, 247 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> pixel_width</code></em>);</pre> 248<p>Create a new <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a> for the specified <em class="parameter"><code>format</code></em> 249 and <em class="parameter"><code>pixel_width</code></em> 250.</p> 251<div class="refsect3"> 252<a name="gst-video-vbi-parser-new.parameters"></a><h4>Parameters</h4> 253<div class="informaltable"><table class="informaltable" width="100%" border="0"> 254<colgroup> 255<col width="150px" class="parameters_name"> 256<col class="parameters_description"> 257<col width="200px" class="parameters_annotations"> 258</colgroup> 259<tbody> 260<tr> 261<td class="parameter_name"><p>format</p></td> 262<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> 263<td class="parameter_annotations"> </td> 264</tr> 265<tr> 266<td class="parameter_name"><p>pixel_width</p></td> 267<td class="parameter_description"><p>The width in pixel to use</p></td> 268<td class="parameter_annotations"> </td> 269</tr> 270</tbody> 271</table></div> 272</div> 273<div class="refsect3"> 274<a name="gst-video-vbi-parser-new.returns"></a><h4>Returns</h4> 275<p> The new <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <em class="parameter"><code>format</code></em> 276and/or <em class="parameter"><code>pixel_width</code></em> 277is not supported.</p> 278</div> 279<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 280</div> 281<hr> 282<div class="refsect2"> 283<a name="gst-video-vbi-parser-free"></a><h3>gst_video_vbi_parser_free ()</h3> 284<pre class="programlisting"><span class="returnvalue">void</span> 285gst_video_vbi_parser_free (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a> *parser</code></em>);</pre> 286<p>Frees the <em class="parameter"><code>parser</code></em> 287.</p> 288<div class="refsect3"> 289<a name="gst-video-vbi-parser-free.parameters"></a><h4>Parameters</h4> 290<div class="informaltable"><table class="informaltable" width="100%" border="0"> 291<colgroup> 292<col width="150px" class="parameters_name"> 293<col class="parameters_description"> 294<col width="200px" class="parameters_annotations"> 295</colgroup> 296<tbody><tr> 297<td class="parameter_name"><p>parser</p></td> 298<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a></p></td> 299<td class="parameter_annotations"> </td> 300</tr></tbody> 301</table></div> 302</div> 303<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 304</div> 305<hr> 306<div class="refsect2"> 307<a name="gst-video-vbi-parser-add-line"></a><h3>gst_video_vbi_parser_add_line ()</h3> 308<pre class="programlisting"><span class="returnvalue">void</span> 309gst_video_vbi_parser_add_line (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a> *parser</code></em>, 310 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>);</pre> 311<p>Provide a new line of data to the <em class="parameter"><code>parser</code></em> 312. Call <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-get-ancillary" title="gst_video_vbi_parser_get_ancillary ()"><code class="function">gst_video_vbi_parser_get_ancillary()</code></a> 313to get the Ancillary data that might be present on that line.</p> 314<div class="refsect3"> 315<a name="gst-video-vbi-parser-add-line.parameters"></a><h4>Parameters</h4> 316<div class="informaltable"><table class="informaltable" width="100%" border="0"> 317<colgroup> 318<col width="150px" class="parameters_name"> 319<col class="parameters_description"> 320<col width="200px" class="parameters_annotations"> 321</colgroup> 322<tbody> 323<tr> 324<td class="parameter_name"><p>parser</p></td> 325<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a></p></td> 326<td class="parameter_annotations"> </td> 327</tr> 328<tr> 329<td class="parameter_name"><p>data</p></td> 330<td class="parameter_description"><p>The line of data to parse. </p></td> 331<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> 332</tr> 333</tbody> 334</table></div> 335</div> 336<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 337</div> 338<hr> 339<div class="refsect2"> 340<a name="gst-video-vbi-parser-get-ancillary"></a><h3>gst_video_vbi_parser_get_ancillary ()</h3> 341<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParserResult" title="enum GstVideoVBIParserResult"><span class="returnvalue">GstVideoVBIParserResult</span></a> 342gst_video_vbi_parser_get_ancillary (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a> *parser</code></em>, 343 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillary" title="struct GstVideoAncillary"><span class="type">GstVideoAncillary</span></a> *anc</code></em>);</pre> 344<p>Parse the line provided previously by <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#gst-video-vbi-parser-add-line" title="gst_video_vbi_parser_add_line ()"><code class="function">gst_video_vbi_parser_add_line()</code></a>.</p> 345<div class="refsect3"> 346<a name="gst-video-vbi-parser-get-ancillary.parameters"></a><h4>Parameters</h4> 347<div class="informaltable"><table class="informaltable" width="100%" border="0"> 348<colgroup> 349<col width="150px" class="parameters_name"> 350<col class="parameters_description"> 351<col width="200px" class="parameters_annotations"> 352</colgroup> 353<tbody> 354<tr> 355<td class="parameter_name"><p>parser</p></td> 356<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a></p></td> 357<td class="parameter_annotations"> </td> 358</tr> 359<tr> 360<td class="parameter_name"><p>anc</p></td> 361<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillary" title="struct GstVideoAncillary"><span class="type">GstVideoAncillary</span></a> to start the eventual ancillary data. </p></td> 362<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td> 363</tr> 364</tbody> 365</table></div> 366</div> 367<div class="refsect3"> 368<a name="gst-video-vbi-parser-get-ancillary.returns"></a><h4>Returns</h4> 369<p> <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GST-VIDEO-VBI-PARSER-RESULT-OK:CAPS"><code class="literal">GST_VIDEO_VBI_PARSER_RESULT_OK</code></a> if ancillary data was found and 370<em class="parameter"><code>anc</code></em> 371was filled. <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GST-VIDEO-VBI-PARSER-RESULT-DONE:CAPS"><code class="literal">GST_VIDEO_VBI_PARSER_RESULT_DONE</code></a> if there wasn't any 372data.</p> 373</div> 374<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 375</div> 376<hr> 377<div class="refsect2"> 378<a name="gst-video-vbi-parser-copy"></a><h3>gst_video_vbi_parser_copy ()</h3> 379<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="returnvalue">GstVideoVBIParser</span></a> * 380gst_video_vbi_parser_copy (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a> *parser</code></em>);</pre> 381</div> 382<hr> 383<div class="refsect2"> 384<a name="gst-video-vbi-encoder-new"></a><h3>gst_video_vbi_encoder_new ()</h3> 385<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="returnvalue">GstVideoVBIEncoder</span></a> * 386gst_video_vbi_encoder_new (<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>, 387 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> pixel_width</code></em>);</pre> 388<p>Create a new <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a> for the specified <em class="parameter"><code>format</code></em> 389 and <em class="parameter"><code>pixel_width</code></em> 390.</p> 391<div class="refsect3"> 392<a name="gst-video-vbi-encoder-new.parameters"></a><h4>Parameters</h4> 393<div class="informaltable"><table class="informaltable" width="100%" border="0"> 394<colgroup> 395<col width="150px" class="parameters_name"> 396<col class="parameters_description"> 397<col width="200px" class="parameters_annotations"> 398</colgroup> 399<tbody> 400<tr> 401<td class="parameter_name"><p>format</p></td> 402<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> 403<td class="parameter_annotations"> </td> 404</tr> 405<tr> 406<td class="parameter_name"><p>pixel_width</p></td> 407<td class="parameter_description"><p>The width in pixel to use</p></td> 408<td class="parameter_annotations"> </td> 409</tr> 410</tbody> 411</table></div> 412</div> 413<div class="refsect3"> 414<a name="gst-video-vbi-encoder-new.returns"></a><h4>Returns</h4> 415<p> The new <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <em class="parameter"><code>format</code></em> 416and/or <em class="parameter"><code>pixel_width</code></em> 417is not supported.</p> 418</div> 419<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 420</div> 421<hr> 422<div class="refsect2"> 423<a name="gst-video-vbi-encoder-free"></a><h3>gst_video_vbi_encoder_free ()</h3> 424<pre class="programlisting"><span class="returnvalue">void</span> 425gst_video_vbi_encoder_free (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a> *encoder</code></em>);</pre> 426<p>Frees the <em class="parameter"><code>encoder</code></em> 427.</p> 428<div class="refsect3"> 429<a name="gst-video-vbi-encoder-free.parameters"></a><h4>Parameters</h4> 430<div class="informaltable"><table class="informaltable" width="100%" border="0"> 431<colgroup> 432<col width="150px" class="parameters_name"> 433<col class="parameters_description"> 434<col width="200px" class="parameters_annotations"> 435</colgroup> 436<tbody><tr> 437<td class="parameter_name"><p>encoder</p></td> 438<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a></p></td> 439<td class="parameter_annotations"> </td> 440</tr></tbody> 441</table></div> 442</div> 443<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 444</div> 445<hr> 446<div class="refsect2"> 447<a name="gst-video-vbi-encoder-add-ancillary"></a><h3>gst_video_vbi_encoder_add_ancillary ()</h3> 448<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 449gst_video_vbi_encoder_add_ancillary (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a> *encoder</code></em>, 450 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> composite</code></em>, 451 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> DID</code></em>, 452 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> SDID_block_number</code></em>, 453 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>, 454 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> data_count</code></em>);</pre> 455<p>Stores Video Ancillary data, according to SMPTE-291M specification.</p> 456<p>Note that the contents of the data are always read as 8bit data (i.e. do not contain 457the parity check bits).</p> 458<div class="refsect3"> 459<a name="gst-video-vbi-encoder-add-ancillary.parameters"></a><h4>Parameters</h4> 460<div class="informaltable"><table class="informaltable" width="100%" border="0"> 461<colgroup> 462<col width="150px" class="parameters_name"> 463<col class="parameters_description"> 464<col width="200px" class="parameters_annotations"> 465</colgroup> 466<tbody> 467<tr> 468<td class="parameter_name"><p>encoder</p></td> 469<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a></p></td> 470<td class="parameter_annotations"> </td> 471</tr> 472<tr> 473<td class="parameter_name"><p>composite</p></td> 474<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if composite ADF should be created, component otherwise</p></td> 475<td class="parameter_annotations"> </td> 476</tr> 477<tr> 478<td class="parameter_name"><p>DID</p></td> 479<td class="parameter_description"><p>The Data Identifier</p></td> 480<td class="parameter_annotations"> </td> 481</tr> 482<tr> 483<td class="parameter_name"><p>SDID_block_number</p></td> 484<td class="parameter_description"><p>The Secondary Data Identifier (if type 2) or the Data 485Block Number (if type 1)</p></td> 486<td class="parameter_annotations"> </td> 487</tr> 488<tr> 489<td class="parameter_name"><p>data_count</p></td> 490<td class="parameter_description"><p>The amount of data (in bytes) in <em class="parameter"><code>data</code></em> 491(max 255 bytes)</p></td> 492<td class="parameter_annotations"> </td> 493</tr> 494<tr> 495<td class="parameter_name"><p>data</p></td> 496<td class="parameter_description"><p>The user data content of the Ancillary packet. 497Does not contain the ADF, DID, SDID nor CS. </p></td> 498<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=data_count]</span></td> 499</tr> 500</tbody> 501</table></div> 502</div> 503<div class="refsect3"> 504<a name="gst-video-vbi-encoder-add-ancillary.returns"></a><h4>Returns</h4> 505<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if enough space was left in the current line, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> 506otherwise.</p> 507</div> 508<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 509</div> 510<hr> 511<div class="refsect2"> 512<a name="gst-video-vbi-encoder-write-line"></a><h3>gst_video_vbi_encoder_write_line ()</h3> 513<pre class="programlisting"><span class="returnvalue">void</span> 514gst_video_vbi_encoder_write_line (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a> *encoder</code></em>, 515 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>);</pre> 516</div> 517<hr> 518<div class="refsect2"> 519<a name="gst-video-vbi-encoder-copy"></a><h3>gst_video_vbi_encoder_copy ()</h3> 520<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="returnvalue">GstVideoVBIEncoder</span></a> * 521gst_video_vbi_encoder_copy (<em class="parameter"><code>const <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIEncoder" title="GstVideoVBIEncoder"><span class="type">GstVideoVBIEncoder</span></a> *encoder</code></em>);</pre> 522</div> 523<hr> 524<div class="refsect2"> 525<a name="gst-buffer-get-video-caption-meta"></a><h3>gst_buffer_get_video_caption_meta()</h3> 526<pre class="programlisting">#define gst_buffer_get_video_caption_meta(b)</pre> 527<p>Gets the <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="type">GstVideoCaptionMeta</span></a> that might be present on <em class="parameter"><code>b</code></em> 528.</p> 529<div class="refsect3"> 530<a name="gst-buffer-get-video-caption-meta.parameters"></a><h4>Parameters</h4> 531<div class="informaltable"><table class="informaltable" width="100%" border="0"> 532<colgroup> 533<col width="150px" class="parameters_name"> 534<col class="parameters_description"> 535<col width="200px" class="parameters_annotations"> 536</colgroup> 537<tbody><tr> 538<td class="parameter_name"><p>b</p></td> 539<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a></p></td> 540<td class="parameter_annotations"> </td> 541</tr></tbody> 542</table></div> 543</div> 544<div class="refsect3"> 545<a name="gst-buffer-get-video-caption-meta.returns"></a><h4>Returns</h4> 546<p> The first <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="type">GstVideoCaptionMeta</span></a> present on <em class="parameter"><code>b</code></em> 547, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if 548no <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="type">GstVideoCaptionMeta</span></a> are present</p> 549</div> 550<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 551</div> 552<hr> 553<div class="refsect2"> 554<a name="gst-buffer-add-video-caption-meta"></a><h3>gst_buffer_add_video_caption_meta ()</h3> 555<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="returnvalue">GstVideoCaptionMeta</span></a> * 556gst_buffer_add_video_caption_meta (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *buffer</code></em>, 557 <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="type">GstVideoCaptionType</span></a> caption_type</code></em>, 558 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *data</code></em>, 559 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> size</code></em>);</pre> 560<p>Attaches <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="type">GstVideoCaptionMeta</span></a> metadata to <em class="parameter"><code>buffer</code></em> 561 with the given 562parameters.</p> 563<div class="refsect3"> 564<a name="gst-buffer-add-video-caption-meta.parameters"></a><h4>Parameters</h4> 565<div class="informaltable"><table class="informaltable" width="100%" border="0"> 566<colgroup> 567<col width="150px" class="parameters_name"> 568<col class="parameters_description"> 569<col width="200px" class="parameters_annotations"> 570</colgroup> 571<tbody> 572<tr> 573<td class="parameter_name"><p>buffer</p></td> 574<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a></p></td> 575<td class="parameter_annotations"> </td> 576</tr> 577<tr> 578<td class="parameter_name"><p>caption_type</p></td> 579<td class="parameter_description"><p>The type of Closed Caption to add</p></td> 580<td class="parameter_annotations"> </td> 581</tr> 582<tr> 583<td class="parameter_name"><p>data</p></td> 584<td class="parameter_description"><p>The Closed Caption data. </p></td> 585<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> 586</tr> 587<tr> 588<td class="parameter_name"><p>size</p></td> 589<td class="parameter_description"><p>The size of <em class="parameter"><code>data</code></em> 590in bytes</p></td> 591<td class="parameter_annotations"> </td> 592</tr> 593</tbody> 594</table></div> 595</div> 596<div class="refsect3"> 597<a name="gst-buffer-add-video-caption-meta.returns"></a><h4>Returns</h4> 598<p>the <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionMeta" title="GstVideoCaptionMeta"><span class="type">GstVideoCaptionMeta</span></a> on <em class="parameter"><code>buffer</code></em> 599. </p> 600<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> 601</div> 602<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 603</div> 604<hr> 605<div class="refsect2"> 606<a name="gst-video-caption-type-from-caps"></a><h3>gst_video_caption_type_from_caps ()</h3> 607<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="returnvalue">GstVideoCaptionType</span></a> 608gst_video_caption_type_from_caps (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *caps</code></em>);</pre> 609<p>Parses fixed Closed Caption <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> and returns the corresponding caption 610type, or <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GST-VIDEO-CAPTION-TYPE-UNKNOWN:CAPS"><code class="literal">GST_VIDEO_CAPTION_TYPE_UNKNOWN</code></a>.</p> 611<div class="refsect3"> 612<a name="gst-video-caption-type-from-caps.parameters"></a><h4>Parameters</h4> 613<div class="informaltable"><table class="informaltable" width="100%" border="0"> 614<colgroup> 615<col width="150px" class="parameters_name"> 616<col class="parameters_description"> 617<col width="200px" class="parameters_annotations"> 618</colgroup> 619<tbody><tr> 620<td class="parameter_name"><p>caps</p></td> 621<td class="parameter_description"><p>Fixed <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> to parse</p></td> 622<td class="parameter_annotations"> </td> 623</tr></tbody> 624</table></div> 625</div> 626<div class="refsect3"> 627<a name="gst-video-caption-type-from-caps.returns"></a><h4>Returns</h4> 628<p> <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="type">GstVideoCaptionType</span></a>.</p> 629</div> 630<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 631</div> 632<hr> 633<div class="refsect2"> 634<a name="gst-video-caption-type-to-caps"></a><h3>gst_video_caption_type_to_caps ()</h3> 635<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="returnvalue">GstCaps</span></a> * 636gst_video_caption_type_to_caps (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="type">GstVideoCaptionType</span></a> type</code></em>);</pre> 637<p>Creates new caps corresponding to <em class="parameter"><code>type</code></em> 638.</p> 639<div class="refsect3"> 640<a name="gst-video-caption-type-to-caps.parameters"></a><h4>Parameters</h4> 641<div class="informaltable"><table class="informaltable" width="100%" border="0"> 642<colgroup> 643<col width="150px" class="parameters_name"> 644<col class="parameters_description"> 645<col width="200px" class="parameters_annotations"> 646</colgroup> 647<tbody><tr> 648<td class="parameter_name"><p>type</p></td> 649<td class="parameter_description"><p><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="type">GstVideoCaptionType</span></a></p></td> 650<td class="parameter_annotations"> </td> 651</tr></tbody> 652</table></div> 653</div> 654<div class="refsect3"> 655<a name="gst-video-caption-type-to-caps.returns"></a><h4>Returns</h4> 656<p>new <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a>. </p> 657<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> 658</div> 659<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 660</div> 661</div> 662<div class="refsect1"> 663<a name="gst-plugins-base-libs-GstVideo-Ancillary.other_details"></a><h2>Types and Values</h2> 664<div class="refsect2"> 665<a name="GstVideoAncillary"></a><h3>struct GstVideoAncillary</h3> 666<pre class="programlisting">struct GstVideoAncillary { 667 guint8 DID; 668 guint8 SDID_block_number; 669 guint8 data_count; 670 guint8 data[256]; 671}; 672</pre> 673<p>Video Ancillary data, according to SMPTE-291M specification.</p> 674<p>Note that the contents of the data are always stored as 8bit data (i.e. do not contain 675the parity check bits).</p> 676<div class="refsect3"> 677<a name="GstVideoAncillary.members"></a><h4>Members</h4> 678<div class="informaltable"><table class="informaltable" width="100%" border="0"> 679<colgroup> 680<col width="300px" class="struct_members_name"> 681<col class="struct_members_description"> 682<col width="200px" class="struct_members_annotations"> 683</colgroup> 684<tbody> 685<tr> 686<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> <em class="structfield"><code><a name="GstVideoAncillary.DID"></a>DID</code></em>;</p></td> 687<td class="struct_member_description"><p>The Data Identifier</p></td> 688<td class="struct_member_annotations"> </td> 689</tr> 690<tr> 691<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> <em class="structfield"><code><a name="GstVideoAncillary.SDID-block-number"></a>SDID_block_number</code></em>;</p></td> 692<td class="struct_member_description"><p>The Secondary Data Identifier (if type 2) or the Data 693Block Number (if type 1)</p></td> 694<td class="struct_member_annotations"> </td> 695</tr> 696<tr> 697<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> <em class="structfield"><code><a name="GstVideoAncillary.data-count"></a>data_count</code></em>;</p></td> 698<td class="struct_member_description"><p>The amount of data (in bytes) in <em class="parameter"><code>data</code></em> 699(max 255 bytes)</p></td> 700<td class="struct_member_annotations"> </td> 701</tr> 702<tr> 703<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> <em class="structfield"><code><a name="GstVideoAncillary.data"></a>data</code></em>[256];</p></td> 704<td class="struct_member_description"><p>The user data content of the Ancillary packet. 705Does not contain the ADF, DID, SDID nor CS. </p></td> 706<td class="struct_member_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=data_count]</span></td> 707</tr> 708</tbody> 709</table></div> 710</div> 711<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 712</div> 713<hr> 714<div class="refsect2"> 715<a name="GstVideoAncillaryDID"></a><h3>enum GstVideoAncillaryDID</h3> 716<div class="refsect3"> 717<a name="GstVideoAncillaryDID.members"></a><h4>Members</h4> 718<div class="informaltable"><table class="informaltable" width="100%" border="0"> 719<colgroup> 720<col width="300px" class="enum_members_name"> 721<col class="enum_members_description"> 722<col width="200px" class="enum_members_annotations"> 723</colgroup> 724<tbody> 725<tr> 726<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-UNDEFINED:CAPS"></a>GST_VIDEO_ANCILLARY_DID_UNDEFINED</p></td> 727<td> </td> 728<td> </td> 729</tr> 730<tr> 731<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-DELETION:CAPS"></a>GST_VIDEO_ANCILLARY_DID_DELETION</p></td> 732<td> </td> 733<td> </td> 734</tr> 735<tr> 736<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-3G-AUDIO-DATA-FIRST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_FIRST</p></td> 737<td> </td> 738<td> </td> 739</tr> 740<tr> 741<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-3G-AUDIO-DATA-LAST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_3G_AUDIO_DATA_LAST</p></td> 742<td> </td> 743<td> </td> 744</tr> 745<tr> 746<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-HDTV-AUDIO-DATA-FIRST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_FIRST</p></td> 747<td> </td> 748<td> </td> 749</tr> 750<tr> 751<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-HDTV-AUDIO-DATA-LAST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_HDTV_AUDIO_DATA_LAST</p></td> 752<td> </td> 753<td> </td> 754</tr> 755<tr> 756<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-SDTV-AUDIO-DATA-1-FIRST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_FIRST</p></td> 757<td> </td> 758<td> </td> 759</tr> 760<tr> 761<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-SDTV-AUDIO-DATA-1-LAST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_1_LAST</p></td> 762<td> </td> 763<td> </td> 764</tr> 765<tr> 766<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-CAMERA-POSITION:CAPS"></a>GST_VIDEO_ANCILLARY_DID_CAMERA_POSITION</p></td> 767<td> </td> 768<td> </td> 769</tr> 770<tr> 771<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-ERROR-DETECTION:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_ERROR_DETECTION</p></td> 772<td> </td> 773<td> </td> 774</tr> 775<tr> 776<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-SDTV-AUDIO-DATA-2-FIRST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_FIRST</p></td> 777<td> </td> 778<td> </td> 779</tr> 780<tr> 781<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID-HANC-SDTV-AUDIO-DATA-2-LAST:CAPS"></a>GST_VIDEO_ANCILLARY_DID_HANC_SDTV_AUDIO_DATA_2_LAST</p></td> 782<td> </td> 783<td> </td> 784</tr> 785</tbody> 786</table></div> 787</div> 788<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 789</div> 790<hr> 791<div class="refsect2"> 792<a name="GstVideoAncillaryDID16"></a><h3>enum GstVideoAncillaryDID16</h3> 793<p>Some know types of Ancillary Data identifiers.</p> 794<div class="refsect3"> 795<a name="GstVideoAncillaryDID16.members"></a><h4>Members</h4> 796<div class="informaltable"><table class="informaltable" width="100%" border="0"> 797<colgroup> 798<col width="300px" class="enum_members_name"> 799<col class="enum_members_description"> 800<col width="200px" class="enum_members_annotations"> 801</colgroup> 802<tbody> 803<tr> 804<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID16-S334-EIA-708:CAPS"></a>GST_VIDEO_ANCILLARY_DID16_S334_EIA_708</p></td> 805<td class="enum_member_description"> 806<p>CEA 708 Ancillary data according to SMPTE 334</p> 807</td> 808<td class="enum_member_annotations"> </td> 809</tr> 810<tr> 811<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID16-S334-EIA-608:CAPS"></a>GST_VIDEO_ANCILLARY_DID16_S334_EIA_608</p></td> 812<td class="enum_member_description"> 813<p>CEA 608 Ancillary data according to SMPTE 334</p> 814</td> 815<td class="enum_member_annotations"> </td> 816</tr> 817<tr> 818<td class="enum_member_name"><p><a name="GST-VIDEO-ANCILLARY-DID16-S2016-3-AFD-BAR:CAPS"></a>GST_VIDEO_ANCILLARY_DID16_S2016_3_AFD_BAR</p></td> 819<td class="enum_member_description"> 820<p>AFD/Bar Ancillary data according to SMPTE 2016-3 (Since: 1.18)</p> 821</td> 822<td class="enum_member_annotations"> </td> 823</tr> 824</tbody> 825</table></div> 826</div> 827<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 828</div> 829<hr> 830<div class="refsect2"> 831<a name="GstVideoVBIParser"></a><h3>GstVideoVBIParser</h3> 832<pre class="programlisting">typedef struct _GstVideoVBIParser GstVideoVBIParser;</pre> 833<p>A parser for detecting and extracting <em class="parameter"><code>GstVideoAncillary</code></em> 834 data from 835Vertical Blanking Interval lines of component signals.</p> 836<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 837</div> 838<hr> 839<div class="refsect2"> 840<a name="GstVideoVBIParserResult"></a><h3>enum GstVideoVBIParserResult</h3> 841<p>Return values for <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoVBIParser" title="GstVideoVBIParser"><span class="type">GstVideoVBIParser</span></a></p> 842<div class="refsect3"> 843<a name="GstVideoVBIParserResult.members"></a><h4>Members</h4> 844<div class="informaltable"><table class="informaltable" width="100%" border="0"> 845<colgroup> 846<col width="300px" class="enum_members_name"> 847<col class="enum_members_description"> 848<col width="200px" class="enum_members_annotations"> 849</colgroup> 850<tbody> 851<tr> 852<td class="enum_member_name"><p><a name="GST-VIDEO-VBI-PARSER-RESULT-DONE:CAPS"></a>GST_VIDEO_VBI_PARSER_RESULT_DONE</p></td> 853<td class="enum_member_description"> 854<p>No line were provided, or no more Ancillary data was found.</p> 855</td> 856<td class="enum_member_annotations"> </td> 857</tr> 858<tr> 859<td class="enum_member_name"><p><a name="GST-VIDEO-VBI-PARSER-RESULT-OK:CAPS"></a>GST_VIDEO_VBI_PARSER_RESULT_OK</p></td> 860<td class="enum_member_description"> 861<p>A <a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoAncillary" title="struct GstVideoAncillary"><span class="type">GstVideoAncillary</span></a> was found.</p> 862</td> 863<td class="enum_member_annotations"> </td> 864</tr> 865<tr> 866<td class="enum_member_name"><p><a name="GST-VIDEO-VBI-PARSER-RESULT-ERROR:CAPS"></a>GST_VIDEO_VBI_PARSER_RESULT_ERROR</p></td> 867<td class="enum_member_description"> 868<p>An error occured</p> 869</td> 870<td class="enum_member_annotations"> </td> 871</tr> 872</tbody> 873</table></div> 874</div> 875<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 876</div> 877<hr> 878<div class="refsect2"> 879<a name="GstVideoVBIEncoder"></a><h3>GstVideoVBIEncoder</h3> 880<pre class="programlisting">typedef struct _GstVideoVBIEncoder GstVideoVBIEncoder;</pre> 881<p>An encoder for writing ancillary data to the 882Vertical Blanking Interval lines of component signals.</p> 883<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 884</div> 885<hr> 886<div class="refsect2"> 887<a name="GstVideoCaptionType"></a><h3>enum GstVideoCaptionType</h3> 888<p>The various known types of Closed Caption (CC).</p> 889<div class="refsect3"> 890<a name="GstVideoCaptionType.members"></a><h4>Members</h4> 891<div class="informaltable"><table class="informaltable" width="100%" border="0"> 892<colgroup> 893<col width="300px" class="enum_members_name"> 894<col class="enum_members_description"> 895<col width="200px" class="enum_members_annotations"> 896</colgroup> 897<tbody> 898<tr> 899<td class="enum_member_name"><p><a name="GST-VIDEO-CAPTION-TYPE-UNKNOWN:CAPS"></a>GST_VIDEO_CAPTION_TYPE_UNKNOWN</p></td> 900<td class="enum_member_description"> 901<p>Unknown type of CC</p> 902</td> 903<td class="enum_member_annotations"> </td> 904</tr> 905<tr> 906<td class="enum_member_name"><p><a name="GST-VIDEO-CAPTION-TYPE-CEA608-RAW:CAPS"></a>GST_VIDEO_CAPTION_TYPE_CEA608_RAW</p></td> 907<td class="enum_member_description"> 908<p>CEA-608 as byte pairs. Note that 909 this format is not recommended since is does not specify to 910 which field the caption comes from and therefore assumes 911 it comes from the first field (and that there is no information 912 on the second field). Use <em class="parameter"><code>GST_VIDEO_CAPTION_TYPE_CEA708_RAW</code></em> 913 914 if you wish to store CEA-608 from two fields and prefix each byte pair 915 with 0xFC for the first field and 0xFD for the second field.</p> 916</td> 917<td class="enum_member_annotations"> </td> 918</tr> 919<tr> 920<td class="enum_member_name"><p><a name="GST-VIDEO-CAPTION-TYPE-CEA608-S334-1A:CAPS"></a>GST_VIDEO_CAPTION_TYPE_CEA608_S334_1A</p></td> 921<td class="enum_member_description"> 922<p>CEA-608 as byte triplets as defined 923 in SMPTE S334-1 Annex A. The second and third byte of the byte triplet 924 is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is 925 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and 926 bits 4 to 0 are a 5 bit unsigned integer that represents the line 927 offset relative to the base-line of the original image format (line 9 928 for 525-line field 1, line 272 for 525-line field 2, line 5 for 929 625-line field 1 and line 318 for 625-line field 2).</p> 930</td> 931<td class="enum_member_annotations"> </td> 932</tr> 933<tr> 934<td class="enum_member_name"><p><a name="GST-VIDEO-CAPTION-TYPE-CEA708-RAW:CAPS"></a>GST_VIDEO_CAPTION_TYPE_CEA708_RAW</p></td> 935<td class="enum_member_description"> 936<p>CEA-708 as cc_data byte triplets. They 937 can also contain 608-in-708 and the first byte of each triplet has to 938 be inspected for detecting the type.</p> 939</td> 940<td class="enum_member_annotations"> </td> 941</tr> 942<tr> 943<td class="enum_member_name"><p><a name="GST-VIDEO-CAPTION-TYPE-CEA708-CDP:CAPS"></a>GST_VIDEO_CAPTION_TYPE_CEA708_CDP</p></td> 944<td class="enum_member_description"> 945<p>CEA-708 (and optionally CEA-608) in 946 a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. 947 Contains the whole CDP (starting with 0x9669).</p> 948</td> 949<td class="enum_member_annotations"> </td> 950</tr> 951</tbody> 952</table></div> 953</div> 954<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 955</div> 956<hr> 957<div class="refsect2"> 958<a name="GstVideoCaptionMeta"></a><h3>GstVideoCaptionMeta</h3> 959<pre class="programlisting">typedef struct { 960 GstMeta meta; 961 962 GstVideoCaptionType caption_type; 963 guint8 *data; 964 gsize size; 965} GstVideoCaptionMeta; 966</pre> 967<p>Extra buffer metadata providing Closed Caption.</p> 968<div class="refsect3"> 969<a name="GstVideoCaptionMeta.members"></a><h4>Members</h4> 970<div class="informaltable"><table class="informaltable" width="100%" border="0"> 971<colgroup> 972<col width="300px" class="struct_members_name"> 973<col class="struct_members_description"> 974<col width="200px" class="struct_members_annotations"> 975</colgroup> 976<tbody> 977<tr> 978<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a> <em class="structfield"><code><a name="GstVideoCaptionMeta.meta"></a>meta</code></em>;</p></td> 979<td class="struct_member_description"><p>parent <a href="/usr/share/gtk-doc/html/gstreamer-1.0/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a></p></td> 980<td class="struct_member_annotations"> </td> 981</tr> 982<tr> 983<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-GstVideo-Ancillary.html#GstVideoCaptionType" title="enum GstVideoCaptionType"><span class="type">GstVideoCaptionType</span></a> <em class="structfield"><code><a name="GstVideoCaptionMeta.caption-type"></a>caption_type</code></em>;</p></td> 984<td class="struct_member_description"><p>The type of Closed Caption contained in the meta.</p></td> 985<td class="struct_member_annotations"> </td> 986</tr> 987<tr> 988<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *<em class="structfield"><code><a name="GstVideoCaptionMeta.data"></a>data</code></em>;</p></td> 989<td class="struct_member_description"><p>The Closed Caption data. </p></td> 990<td class="struct_member_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size]</span></td> 991</tr> 992<tr> 993<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> <em class="structfield"><code><a name="GstVideoCaptionMeta.size"></a>size</code></em>;</p></td> 994<td class="struct_member_description"><p>The size in bytes of <em class="parameter"><code>data</code></em> 995</p></td> 996<td class="struct_member_annotations"> </td> 997</tr> 998</tbody> 999</table></div> 1000</div> 1001<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 1002</div> 1003</div> 1004</div> 1005<div class="footer"> 1006<hr>Generated by GTK-Doc V1.28</div> 1007</body> 1008</html>
