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>ttmlparse: 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-tsparse.html" title="tsparse"> 10<link rel="next" href="gst-plugins-bad-plugins-ttmlrender.html" title="ttmlrender"> 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-bad-plugins-ttmlparse.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-ttmlparse.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-tsparse.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-ttmlrender.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-ttmlparse"></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-ttmlparse.top_of_page"></a>ttmlparse</span></h2> 31<p>ttmlparse</p> 32</td> 33<td class="gallery_image" valign="top" align="right"></td> 34</tr></table></div> 35<a name="GstTtmlParse"></a><div class="refsect1"> 36<a name="gst-plugins-bad-plugins-ttmlparse.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-ttmlparse.html#GstTtmlParse-struct" title="struct GstTtmlParse">GstTtmlParse</a></td> 45</tr></tbody> 46</table></div> 47</div> 48<div class="refsect1"> 49<a name="gst-plugins-bad-plugins-ttmlparse.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> GstTtmlParse 55</pre> 56</div> 57<div class="refsect1"> 58<a name="gst-plugins-bad-plugins-ttmlparse.description"></a><h2>Description</h2> 59<p>Parses timed text subtitle files described using Timed Text Markup Language 60(TTML). Currently, only the EBU-TT-D profile of TTML, designed for 61distribution of subtitles over IP, is supported.</p> 62<p>The parser outputs a <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> for each scene in the input TTML file, a 63scene being a period of time during which a static set of subtitles should 64be visible. The parser places each text element within a scene into its own 65<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstMemory.html#GstMemory-struct"><span class="type">GstMemory</span></a> within the scene's buffer, and attaches metadata to the buffer 66describing the styling and layout associated with all the contained text 67elements. A downstream renderer element uses this information to correctly 68render the text on top of video frames.</p> 69<div class="refsect3"> 70<a name="id-1.2.224.6.4"></a><h4>Example launch lines</h4> 71<div class="informalexample"> 72 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 73 <tbody> 74 <tr> 75 <td class="listing_lines" align="right"><pre>1</pre></td> 76 <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">=<</span>media file location<span class="gtkdoc opt">> !</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">=<</span>subtitle file location<span class="gtkdoc opt">></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> 77 </tr> 78 </tbody> 79 </table> 80</div> 81 82<p> Parse and render TTML subtitles contained in a single XML file over an 83MP4 stream containing H.264 video and AAC audio.</p> 84</div> 85<div class="refsynopsisdiv"> 86<h2>Synopsis</h2> 87<div class="refsect2"> 88<a name="id-1.2.224.6.5.1"></a><h3>Element Information</h3> 89<div class="variablelist"><table border="0" class="variablelist"> 90<colgroup> 91<col align="left" valign="top"> 92<col> 93</colgroup> 94<tbody> 95<tr> 96<td><p><span class="term">plugin</span></p></td> 97<td> 98 <a class="link" href="gst-plugins-bad-plugins-plugin-ttmlsubs.html#plugin-ttmlsubs">ttmlsubs</a> 99 </td> 100</tr> 101<tr> 102<td><p><span class="term">author</span></p></td> 103<td>GStreamer maintainers <gstreamer-devel@lists.sourceforge.net>, Chris Bass <dash@rd.bbc.co.uk></td> 104</tr> 105<tr> 106<td><p><span class="term">class</span></p></td> 107<td>Codec/Parser/Subtitle</td> 108</tr> 109</tbody> 110</table></div> 111</div> 112<hr> 113<div class="refsect2"> 114<a name="id-1.2.224.6.5.2"></a><h3>Element Pads</h3> 115<div class="variablelist"><table border="0" class="variablelist"> 116<colgroup> 117<col align="left" valign="top"> 118<col> 119</colgroup> 120<tbody> 121<tr> 122<td><p><span class="term">name</span></p></td> 123<td>sink</td> 124</tr> 125<tr> 126<td><p><span class="term">direction</span></p></td> 127<td>sink</td> 128</tr> 129<tr> 130<td><p><span class="term">presence</span></p></td> 131<td>always</td> 132</tr> 133<tr> 134<td><p><span class="term">details</span></p></td> 135<td>application/ttml+xml</td> 136</tr> 137</tbody> 138</table></div> 139<div class="variablelist"><table border="0" class="variablelist"> 140<colgroup> 141<col align="left" valign="top"> 142<col> 143</colgroup> 144<tbody> 145<tr> 146<td><p><span class="term">name</span></p></td> 147<td>src</td> 148</tr> 149<tr> 150<td><p><span class="term">direction</span></p></td> 151<td>source</td> 152</tr> 153<tr> 154<td><p><span class="term">presence</span></p></td> 155<td>always</td> 156</tr> 157<tr> 158<td><p><span class="term">details</span></p></td> 159<td>text/x-raw(meta:GstSubtitleMeta)</td> 160</tr> 161</tbody> 162</table></div> 163</div> 164</div> 165</div> 166<div class="refsect1"> 167<a name="gst-plugins-bad-plugins-ttmlparse.functions_details"></a><h2>Functions</h2> 168<p></p> 169</div> 170<div class="refsect1"> 171<a name="gst-plugins-bad-plugins-ttmlparse.other_details"></a><h2>Types and Values</h2> 172<div class="refsect2"> 173<a name="GstTtmlParse-struct"></a><h3>struct GstTtmlParse</h3> 174<pre class="programlisting">struct GstTtmlParse;</pre> 175</div> 176</div> 177</div> 178<div class="footer"> 179<hr>Generated by GTK-Doc V1.28</div> 180</body> 181</html>
