• 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>assrender: 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-asfparse.html" title="asfparse">
10<link rel="next" href="gst-plugins-bad-plugins-audiobuffersplit.html" title="audiobuffersplit">
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-assrender.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-assrender.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-assrender.properties" class="shortcut">Properties</a></span>
21</td>
22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24<td><a accesskey="p" href="gst-plugins-bad-plugins-asfparse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25<td><a accesskey="n" href="gst-plugins-bad-plugins-audiobuffersplit.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26</tr></table>
27<div class="refentry">
28<a name="gst-plugins-bad-plugins-assrender"></a><div class="titlepage"></div>
29<div class="refnamediv"><table width="100%"><tr>
30<td valign="top">
31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-assrender.top_of_page"></a>assrender</span></h2>
32<p>assrender</p>
33</td>
34<td class="gallery_image" valign="top" align="right"></td>
35</tr></table></div>
36<div class="refsect1">
37<a name="gst-plugins-bad-plugins-assrender.properties"></a><h2>Properties</h2>
38<div class="informaltable"><table class="informaltable" border="0">
39<colgroup>
40<col width="150px" class="properties_type">
41<col width="300px" class="properties_name">
42<col width="200px" class="properties_flags">
43</colgroup>
44<tbody>
45<tr>
46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-assrender.html#GstAssRender--embeddedfonts" title="The “embeddedfonts” property">embeddedfonts</a></td>
48<td class="property_flags">Read / Write</td>
49</tr>
50<tr>
51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-assrender.html#GstAssRender--enable" title="The “enable” property">enable</a></td>
53<td class="property_flags">Read / Write</td>
54</tr>
55<tr>
56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-assrender.html#GstAssRender--wait-text" title="The “wait-text” property">wait-text</a></td>
58<td class="property_flags">Read / Write</td>
59</tr>
60</tbody>
61</table></div>
62</div>
63<a name="GstAssRender"></a><div class="refsect1">
64<a name="gst-plugins-bad-plugins-assrender.other"></a><h2>Types and Values</h2>
65<div class="informaltable"><table class="informaltable" width="100%" border="0">
66<colgroup>
67<col width="150px" class="name">
68<col class="description">
69</colgroup>
70<tbody><tr>
71<td class="datatype_keyword">struct</td>
72<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-assrender.html#GstAssRender-struct" title="struct GstAssRender">GstAssRender</a></td>
73</tr></tbody>
74</table></div>
75</div>
76<div class="refsect1">
77<a name="gst-plugins-bad-plugins-assrender.object-hierarchy"></a><h2>Object Hierarchy</h2>
78<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
79    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
80        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
81            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
82                <span class="lineart">╰──</span> GstAssRender
83</pre>
84</div>
85<div class="refsect1">
86<a name="gst-plugins-bad-plugins-assrender.description"></a><h2>Description</h2>
87<p>Renders timestamped SSA/ASS subtitles on top of a video stream.</p>
88<div class="refsect3">
89<a name="id-1.2.10.7.3"></a><h4>Example launch line</h4>
90<div class="informalexample">
91  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
92    <tbody>
93      <tr>
94        <td class="listing_lines" align="right"><pre>1</pre></td>
95        <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> <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>mkv <span class="gtkdoc opt">!</span> matroskademux name<span class="gtkdoc opt">=</span>d <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> mpegaudioparse <span class="gtkdoc opt">!</span> mpg123audiodec <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> autoaudiosink  d<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> h264parse <span class="gtkdoc opt">!</span> avdec_h264 <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> r<span class="gtkdoc opt">.</span>   d<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> <span class="string">&quot;application/x-ass&quot;</span> <span class="gtkdoc opt">!</span> assrender name<span class="gtkdoc opt">=</span>r <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td>
96      </tr>
97    </tbody>
98  </table>
99</div>
100
101<p> This pipeline demuxes a Matroska file with h.264 video, MP3 audio and embedded ASS subtitles and renders the subtitles on top of the video.</p>
102</div>
103<div class="refsynopsisdiv">
104<h2>Synopsis</h2>
105<div class="refsect2">
106<a name="id-1.2.10.7.4.1"></a><h3>Element Information</h3>
107<div class="variablelist"><table border="0" class="variablelist">
108<colgroup>
109<col align="left" valign="top">
110<col>
111</colgroup>
112<tbody>
113<tr>
114<td><p><span class="term">plugin</span></p></td>
115<td>
116            <a class="link" href="gst-plugins-bad-plugins-plugin-assrender.html#plugin-assrender">assrender</a>
117          </td>
118</tr>
119<tr>
120<td><p><span class="term">author</span></p></td>
121<td>Benjamin Schmitz &lt;vortex@wolpzone.de&gt;, Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
122</tr>
123<tr>
124<td><p><span class="term">class</span></p></td>
125<td>Mixer/Video/Overlay/Subtitle</td>
126</tr>
127</tbody>
128</table></div>
129</div>
130<hr>
131<div class="refsect2">
132<a name="id-1.2.10.7.4.2"></a><h3>Element Pads</h3>
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>text_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>application/x-ass</td>
154</tr>
155<tr>
156<td><p><span class="term"></span></p></td>
157<td> application/x-ssa</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>video_sink</td>
170</tr>
171<tr>
172<td><p><span class="term">direction</span></p></td>
173<td>sink</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 class="variablelist"><table border="0" class="variablelist">
190<colgroup>
191<col align="left" valign="top">
192<col>
193</colgroup>
194<tbody>
195<tr>
196<td><p><span class="term">name</span></p></td>
197<td>src</td>
198</tr>
199<tr>
200<td><p><span class="term">direction</span></p></td>
201<td>source</td>
202</tr>
203<tr>
204<td><p><span class="term">presence</span></p></td>
205<td>always</td>
206</tr>
207<tr>
208<td><p><span class="term">details</span></p></td>
209<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>
210</tr>
211<tr>
212<td><p><span class="term"></span></p></td>
213<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>
214</tr>
215</tbody>
216</table></div>
217</div>
218</div>
219</div>
220<div class="refsect1">
221<a name="gst-plugins-bad-plugins-assrender.functions_details"></a><h2>Functions</h2>
222<p></p>
223</div>
224<div class="refsect1">
225<a name="gst-plugins-bad-plugins-assrender.other_details"></a><h2>Types and Values</h2>
226<div class="refsect2">
227<a name="GstAssRender-struct"></a><h3>struct GstAssRender</h3>
228<pre class="programlisting">struct GstAssRender;</pre>
229</div>
230</div>
231<div class="refsect1">
232<a name="gst-plugins-bad-plugins-assrender.property-details"></a><h2>Property Details</h2>
233<div class="refsect2">
234<a name="GstAssRender--embeddedfonts"></a><h3>The <code class="literal">“embeddedfonts”</code> property</h3>
235<pre class="programlisting">  “embeddedfonts”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
236<p>Extract and use fonts embedded in the stream.</p>
237<p>Flags: Read / Write</p>
238<p>Default value: TRUE</p>
239</div>
240<hr>
241<div class="refsect2">
242<a name="GstAssRender--enable"></a><h3>The <code class="literal">“enable”</code> property</h3>
243<pre class="programlisting">  “enable”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
244<p>Enable rendering of subtitles.</p>
245<p>Flags: Read / Write</p>
246<p>Default value: TRUE</p>
247</div>
248<hr>
249<div class="refsect2">
250<a name="GstAssRender--wait-text"></a><h3>The <code class="literal">“wait-text”</code> property</h3>
251<pre class="programlisting">  “wait-text”                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
252<p>Whether to wait for subtitles.</p>
253<p>Flags: Read / Write</p>
254<p>Default value: TRUE</p>
255</div>
256</div>
257</div>
258<div class="footer">
259<hr>Generated by GTK-Doc V1.28</div>
260</body>
261</html>