• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>ttmlrender: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-ttmlparse.html" title="ttmlparse">
10<link rel="next" href="gst-plugins-bad-plugins-tunnel.html" title="tunnel">
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">|</span18                  <a href="#gst-plugins-bad-plugins-ttmlrender.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-ttmlrender.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23<td><a accesskey="p" href="gst-plugins-bad-plugins-ttmlparse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24<td><a accesskey="n" href="gst-plugins-bad-plugins-tunnel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25</tr></table>
26<div class="refentry">
27<a name="gst-plugins-bad-plugins-ttmlrender"></a><div class="titlepage"></div>
28<div class="refnamediv"><table width="100%"><tr>
29<td valign="top">
30<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-ttmlrender.top_of_page"></a>ttmlrender</span></h2>
31<p>ttmlrender</p>
32</td>
33<td class="gallery_image" valign="top" align="right"></td>
34</tr></table></div>
35<a name="GstTtmlRender"></a><div class="refsect1">
36<a name="gst-plugins-bad-plugins-ttmlrender.other"></a><h2>Types and Values</h2>
37<div class="informaltable"><table class="informaltable" width="100%" border="0">
38<colgroup>
39<col width="150px" class="name">
40<col class="description">
41</colgroup>
42<tbody><tr>
43<td class="datatype_keyword">struct</td>
44<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-ttmlrender.html#GstTtmlRender-struct" title="struct GstTtmlRender">GstTtmlRender</a></td>
45</tr></tbody>
46</table></div>
47</div>
48<div class="refsect1">
49<a name="gst-plugins-bad-plugins-ttmlrender.object-hierarchy"></a><h2>Object Hierarchy</h2>
50<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
51    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
52        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
53            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
54                <span class="lineart">╰──</span> GstTtmlRender
55</pre>
56</div>
57<div class="refsect1">
58<a name="gst-plugins-bad-plugins-ttmlrender.description"></a><h2>Description</h2>
59<p>Renders timed text on top of a video stream. It receives text in buffers
60from a ttmlparse element; each text string is in its own <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> within
61the GstBuffer, and the styling and layout associated with each text string
62is in metadata attached to the <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a>.</p>
63<div class="refsect3">
64<a name="id-1.2.225.6.3"></a><h4>Example launch lines</h4>
65<div class="informalexample">
66  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
67    <tbody>
68      <tr>
69        <td class="listing_lines" align="right"><pre>1</pre></td>
70        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> filesrc location<span class="gtkdoc opt">=&lt;</span>media file location<span class="gtkdoc opt">&gt; !</span> video<span class="gtkdoc opt">/</span>quicktime <span class="gtkdoc opt">!</span> qtdemux name<span class="gtkdoc opt">=</span>q ttmlrender name<span class="gtkdoc opt">=</span>r q<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> h264parse <span class="gtkdoc opt">!</span> avdec_h264 <span class="gtkdoc opt">!</span> autovideoconvert <span class="gtkdoc opt">!</span> r<span class="gtkdoc opt">.</span>video_sink filesrc location<span class="gtkdoc opt">=&lt;</span>subtitle file location<span class="gtkdoc opt">&gt;</span> blocksize<span class="gtkdoc opt">=</span><span class="number">16777216</span> <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> ttmlparse <span class="gtkdoc opt">!</span> r<span class="gtkdoc opt">.</span>text_sink r<span class="gtkdoc opt">. !</span> ximagesink q<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> aacparse <span class="gtkdoc opt">!</span> avdec_aac <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td>
71      </tr>
72    </tbody>
73  </table>
74</div>
75
76<p> Parse and render TTML subtitles contained in a single XML file over an
77MP4 stream containing H.264 video and AAC audio:</p>
78</div>
79<div class="refsynopsisdiv">
80<h2>Synopsis</h2>
81<div class="refsect2">
82<a name="id-1.2.225.6.4.1"></a><h3>Element Information</h3>
83<div class="variablelist"><table border="0" class="variablelist">
84<colgroup>
85<col align="left" valign="top">
86<col>
87</colgroup>
88<tbody>
89<tr>
90<td><p><span class="term">plugin</span></p></td>
91<td>
92            <a class="link" href="gst-plugins-bad-plugins-plugin-ttmlsubs.html#plugin-ttmlsubs">ttmlsubs</a>
93          </td>
94</tr>
95<tr>
96<td><p><span class="term">author</span></p></td>
97<td>David Schleef &lt;ds@schleef.org&gt;, Zeeshan Ali &lt;zeeshan.ali@nokia.com&gt;, Chris Bass &lt;dash@rd.bbc.co.uk&gt;</td>
98</tr>
99<tr>
100<td><p><span class="term">class</span></p></td>
101<td>Overlay/Subtitle</td>
102</tr>
103</tbody>
104</table></div>
105</div>
106<hr>
107<div class="refsect2">
108<a name="id-1.2.225.6.4.2"></a><h3>Element Pads</h3>
109<div class="variablelist"><table border="0" class="variablelist">
110<colgroup>
111<col align="left" valign="top">
112<col>
113</colgroup>
114<tbody>
115<tr>
116<td><p><span class="term">name</span></p></td>
117<td>text_sink</td>
118</tr>
119<tr>
120<td><p><span class="term">direction</span></p></td>
121<td>sink</td>
122</tr>
123<tr>
124<td><p><span class="term">presence</span></p></td>
125<td>always</td>
126</tr>
127<tr>
128<td><p><span class="term">details</span></p></td>
129<td>text/x-raw(meta:GstSubtitleMeta)</td>
130</tr>
131</tbody>
132</table></div>
133<div class="variablelist"><table border="0" class="variablelist">
134<colgroup>
135<col align="left" valign="top">
136<col>
137</colgroup>
138<tbody>
139<tr>
140<td><p><span class="term">name</span></p></td>
141<td>video_sink</td>
142</tr>
143<tr>
144<td><p><span class="term">direction</span></p></td>
145<td>sink</td>
146</tr>
147<tr>
148<td><p><span class="term">presence</span></p></td>
149<td>always</td>
150</tr>
151<tr>
152<td><p><span class="term">details</span></p></td>
153<td>video/x-raw, format=(string){ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
154</tr>
155<tr>
156<td><p><span class="term"></span></p></td>
157<td> video/x-raw(ANY), format=(string){ I420, YV12, YUY2, UYVY, AYUV, VUYA, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, Y210, Y410, NV12, NV21, GRAY8, GRAY16_BE, GRAY16_LE, v308, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10BE, I420_10LE, I422_10BE, I422_10LE, Y444_10BE, Y444_10LE, GBR, GBR_10BE, GBR_10LE, NV16, NV24, NV12_64Z32, A420_10BE, A420_10LE, A422_10BE, A422_10LE, A444_10BE, A444_10LE, NV61, P010_10BE, P010_10LE, IYU2, VYUY, GBRA, GBRA_10BE, GBRA_10LE, BGR10A2_LE, GBR_12BE, GBR_12LE, GBRA_12BE, GBRA_12LE, I420_12BE, I420_12LE, I422_12BE, I422_12LE, Y444_12BE, Y444_12LE, GRAY10_LE32, NV12_10LE32, NV16_10LE32, NV12_10LE40 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
158</tr>
159</tbody>
160</table></div>
161<div class="variablelist"><table border="0" class="variablelist">
162<colgroup>
163<col align="left" valign="top">
164<col>
165</colgroup>
166<tbody>
167<tr>
168<td><p><span class="term">name</span></p></td>
169<td>src</td>
170</tr>
171<tr>
172<td><p><span class="term">direction</span></p></td>
173<td>source</td>
174</tr>
175<tr>
176<td><p><span class="term">presence</span></p></td>
177<td>always</td>
178</tr>
179<tr>
180<td><p><span class="term">details</span></p></td>
181<td>video/x-raw, format=(string){ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
182</tr>
183<tr>
184<td><p><span class="term"></span></p></td>
185<td> video/x-raw(ANY), format=(string){ I420, YV12, YUY2, UYVY, AYUV, VUYA, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, Y210, Y410, NV12, NV21, GRAY8, GRAY16_BE, GRAY16_LE, v308, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10BE, I420_10LE, I422_10BE, I422_10LE, Y444_10BE, Y444_10LE, GBR, GBR_10BE, GBR_10LE, NV16, NV24, NV12_64Z32, A420_10BE, A420_10LE, A422_10BE, A422_10LE, A444_10BE, A444_10LE, NV61, P010_10BE, P010_10LE, IYU2, VYUY, GBRA, GBRA_10BE, GBRA_10LE, BGR10A2_LE, GBR_12BE, GBR_12LE, GBRA_12BE, GBRA_12LE, I420_12BE, I420_12LE, I422_12BE, I422_12LE, Y444_12BE, Y444_12LE, GRAY10_LE32, NV12_10LE32, NV16_10LE32, NV12_10LE40 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
186</tr>
187</tbody>
188</table></div>
189</div>
190</div>
191</div>
192<div class="refsect1">
193<a name="gst-plugins-bad-plugins-ttmlrender.functions_details"></a><h2>Functions</h2>
194<p></p>
195</div>
196<div class="refsect1">
197<a name="gst-plugins-bad-plugins-ttmlrender.other_details"></a><h2>Types and Values</h2>
198<div class="refsect2">
199<a name="GstTtmlRender-struct"></a><h3>struct GstTtmlRender</h3>
200<pre class="programlisting">struct GstTtmlRender;</pre>
201</div>
202</div>
203</div>
204<div class="footer">
205<hr>Generated by GTK-Doc V1.28</div>
206</body>
207</html>