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>tiger: 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-testsrcbin.html" title="testsrc"> 10<link rel="next" href="gst-plugins-bad-plugins-timecodestamper.html" title="timecodestamper"> 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-tiger.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-tiger.properties" class="shortcut">Properties</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-testsrcbin.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-timecodestamper.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-tiger"></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-tiger.top_of_page"></a>tiger</span></h2> 31<p>tiger</p> 32</td> 33<td class="gallery_image" valign="top" align="right"></td> 34</tr></table></div> 35<div class="refsect1"> 36<a name="gst-plugins-bad-plugins-tiger.properties"></a><h2>Properties</h2> 37<div class="informaltable"><table class="informaltable" border="0"> 38<colgroup> 39<col width="150px" class="properties_type"> 40<col width="300px" class="properties_name"> 41<col width="200px" class="properties_flags"> 42</colgroup> 43<tbody> 44<tr> 45<td class="property_type"> 46<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--category" title="The “category” property">category</a></td> 48<td class="property_flags">Read</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-alpha" title="The “default-background-alpha” property">default-background-alpha</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#gint"><span class="type">gint</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-blue" title="The “default-background-blue” property">default-background-blue</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 62<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-green" title="The “default-background-green” property">default-background-green</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-red" title="The “default-background-red” property">default-background-red</a></td> 68<td class="property_flags">Read / Write</td> 69</tr> 70<tr> 71<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 72<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-alpha" title="The “default-font-alpha” property">default-font-alpha</a></td> 73<td class="property_flags">Read / Write</td> 74</tr> 75<tr> 76<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 77<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-blue" title="The “default-font-blue” property">default-font-blue</a></td> 78<td class="property_flags">Read / Write</td> 79</tr> 80<tr> 81<td class="property_type"> 82<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 83<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-desc" title="The “default-font-desc” property">default-font-desc</a></td> 84<td class="property_flags">Read / Write</td> 85</tr> 86<tr> 87<td class="property_type"><span class="type">GstFontEffect</span></td> 88<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-effect" title="The “default-font-effect” property">default-font-effect</a></td> 89<td class="property_flags">Read / Write / Construct</td> 90</tr> 91<tr> 92<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 93<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-effect-strength" title="The “default-font-effect-strength” property">default-font-effect-strength</a></td> 94<td class="property_flags">Read / Write</td> 95</tr> 96<tr> 97<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 98<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-green" title="The “default-font-green” property">default-font-green</a></td> 99<td class="property_flags">Read / Write</td> 100</tr> 101<tr> 102<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 103<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-red" title="The “default-font-red” property">default-font-red</a></td> 104<td class="property_flags">Read / Write</td> 105</tr> 106<tr> 107<td class="property_type"> 108<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 109<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--language" title="The “language” property">language</a></td> 110<td class="property_flags">Read</td> 111</tr> 112<tr> 113<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 114<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--original-canvas-height" title="The “original-canvas-height” property">original-canvas-height</a></td> 115<td class="property_flags">Read</td> 116</tr> 117<tr> 118<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 119<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--original-canvas-width" title="The “original-canvas-width” property">original-canvas-width</a></td> 120<td class="property_flags">Read</td> 121</tr> 122<tr> 123<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 124<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--quality" title="The “quality” property">quality</a></td> 125<td class="property_flags">Read / Write</td> 126</tr> 127</tbody> 128</table></div> 129</div> 130<div class="refsect1"> 131<a name="gst-plugins-bad-plugins-tiger.other"></a><h2>Types and Values</h2> 132<div class="informaltable"><table class="informaltable" width="100%" border="0"> 133<colgroup> 134<col width="150px" class="name"> 135<col class="description"> 136</colgroup> 137<tbody><tr> 138<td class="datatype_keyword">struct</td> 139<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger" title="struct GstKateTiger">GstKateTiger</a></td> 140</tr></tbody> 141</table></div> 142</div> 143<div class="refsect1"> 144<a name="gst-plugins-bad-plugins-tiger.description"></a><h2>Description</h2> 145<p>This element decodes and renders Kate streams</p> 146<a class="ulink" href="http://libkate.googlecode.com/" target="_top">Kate</a> is a free codec 147<p>for text based data, such as subtitles. Any number of kate streams can be 148embedded in an Ogg stream.</p> 149<p>libkate (see above url) and <a class="ulink" href="http://libtiger.googlecode.com/" target="_top">libtiger</a> 150are needed to build this element.</p> 151<div class="refsect3"> 152<a name="id-1.2.219.5.6"></a><h4>Example pipeline</h4> 153<p>This pipeline renders a Kate stream on top of a Theora video multiplexed 154in the same stream:</p> 155<div class="informalexample"> 156 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 157 <tbody> 158 <tr> 159 <td class="listing_lines" align="right"><pre>1 1602 1613 1624 1635</pre></td> 164 <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> \ 165 filesrc location<span class="gtkdoc opt">=</span>video<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux name<span class="gtkdoc opt">=</span>demux \ 166 demux<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> theoradec <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> tiger name<span class="gtkdoc opt">=</span>tiger \ 167 demux<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> kateparse <span class="gtkdoc opt">!</span> tiger<span class="gtkdoc opt">.</span> \ 168 tiger<span class="gtkdoc opt">. !</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 169 </tr> 170 </tbody> 171 </table> 172</div> 173 174<p></p> 175</div> 176</div> 177<div class="refsect1"> 178<a name="gst-plugins-bad-plugins-tiger.functions_details"></a><h2>Functions</h2> 179<p></p> 180</div> 181<div class="refsect1"> 182<a name="gst-plugins-bad-plugins-tiger.other_details"></a><h2>Types and Values</h2> 183<div class="refsect2"> 184<a name="GstKateTiger"></a><h3>struct GstKateTiger</h3> 185<pre class="programlisting">struct GstKateTiger { 186 GstKateDecoderBase decoder; 187 188 GstPad *katesinkpad; 189 GstPad *videosinkpad; 190 GstPad *srcpad; 191 192 tiger_renderer *tr; 193 194 gdouble quality; 195 gchar *default_font_desc; 196 gboolean default_font_effect; 197 gdouble default_font_effect_strength; 198 guchar default_font_r; 199 guchar default_font_g; 200 guchar default_font_b; 201 guchar default_font_a; 202 guchar default_background_r; 203 guchar default_background_g; 204 guchar default_background_b; 205 guchar default_background_a; 206 gboolean silent; 207 208 GstVideoFormat video_format; 209 gint video_width; 210 gint video_height; 211 gboolean swap_rgb; 212 GstBuffer *render_buffer; 213 GstVideoOverlayComposition *composition; 214 215 GMutex *mutex; 216 GCond *cond; 217 218 GstSegment video_segment; 219 gboolean video_flushing; 220 gboolean seen_header; 221}; 222</pre> 223</div> 224</div> 225<div class="refsect1"> 226<a name="gst-plugins-bad-plugins-tiger.property-details"></a><h2>Property Details</h2> 227<div class="refsect2"> 228<a name="GstKateTiger--category"></a><h3>The <code class="literal">“category”</code> property</h3> 229<pre class="programlisting"> “category” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 230<p>The category of the stream.</p> 231<p>Flags: Read</p> 232<p>Default value: ""</p> 233</div> 234<hr> 235<div class="refsect2"> 236<a name="GstKateTiger--default-background-alpha"></a><h3>The <code class="literal">“default-background-alpha”</code> property</h3> 237<pre class="programlisting"> “default-background-alpha” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 238<p>Default background color (alpha component, between 0 and 255) to render text with.</p> 239<p>Flags: Read / Write</p> 240<p>Allowed values: [0,255]</p> 241<p>Default value: 255</p> 242</div> 243<hr> 244<div class="refsect2"> 245<a name="GstKateTiger--default-background-blue"></a><h3>The <code class="literal">“default-background-blue”</code> property</h3> 246<pre class="programlisting"> “default-background-blue” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 247<p>Default background color (blue component, between 0 and 255) to render text with.</p> 248<p>Flags: Read / Write</p> 249<p>Allowed values: [0,255]</p> 250<p>Default value: 255</p> 251</div> 252<hr> 253<div class="refsect2"> 254<a name="GstKateTiger--default-background-green"></a><h3>The <code class="literal">“default-background-green”</code> property</h3> 255<pre class="programlisting"> “default-background-green” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 256<p>Default background color (green component, between 0 and 255) to render text with.</p> 257<p>Flags: Read / Write</p> 258<p>Allowed values: [0,255]</p> 259<p>Default value: 255</p> 260</div> 261<hr> 262<div class="refsect2"> 263<a name="GstKateTiger--default-background-red"></a><h3>The <code class="literal">“default-background-red”</code> property</h3> 264<pre class="programlisting"> “default-background-red” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 265<p>Default background color (red component, between 0 and 255) to render text with.</p> 266<p>Flags: Read / Write</p> 267<p>Allowed values: [0,255]</p> 268<p>Default value: 255</p> 269</div> 270<hr> 271<div class="refsect2"> 272<a name="GstKateTiger--default-font-alpha"></a><h3>The <code class="literal">“default-font-alpha”</code> property</h3> 273<pre class="programlisting"> “default-font-alpha” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 274<p>Default font color (alpha component, between 0 and 255) to render text with.</p> 275<p>Flags: Read / Write</p> 276<p>Allowed values: [0,255]</p> 277<p>Default value: 255</p> 278</div> 279<hr> 280<div class="refsect2"> 281<a name="GstKateTiger--default-font-blue"></a><h3>The <code class="literal">“default-font-blue”</code> property</h3> 282<pre class="programlisting"> “default-font-blue” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 283<p>Default font color (blue component, between 0 and 255) to render text with.</p> 284<p>Flags: Read / Write</p> 285<p>Allowed values: [0,255]</p> 286<p>Default value: 255</p> 287</div> 288<hr> 289<div class="refsect2"> 290<a name="GstKateTiger--default-font-desc"></a><h3>The <code class="literal">“default-font-desc”</code> property</h3> 291<pre class="programlisting"> “default-font-desc” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 292<p>Default font description (Pango style) to render text with.</p> 293<p>Flags: Read / Write</p> 294<p>Default value: ""</p> 295</div> 296<hr> 297<div class="refsect2"> 298<a name="GstKateTiger--default-font-effect"></a><h3>The <code class="literal">“default-font-effect”</code> property</h3> 299<pre class="programlisting"> “default-font-effect” <span class="type">GstFontEffect</span></pre> 300<p>Whether to apply an effect to text by default, for increased readability.</p> 301<p>Flags: Read / Write / Construct</p> 302<p>Default value: outline</p> 303</div> 304<hr> 305<div class="refsect2"> 306<a name="GstKateTiger--default-font-effect-strength"></a><h3>The <code class="literal">“default-font-effect-strength”</code> property</h3> 307<pre class="programlisting"> “default-font-effect-strength” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 308<p>How pronounced should the font effect be (effect dependent).</p> 309<p>Flags: Read / Write</p> 310<p>Allowed values: [0,1]</p> 311<p>Default value: 0.5</p> 312</div> 313<hr> 314<div class="refsect2"> 315<a name="GstKateTiger--default-font-green"></a><h3>The <code class="literal">“default-font-green”</code> property</h3> 316<pre class="programlisting"> “default-font-green” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 317<p>Default font color (green component, between 0 and 255) to render text with.</p> 318<p>Flags: Read / Write</p> 319<p>Allowed values: [0,255]</p> 320<p>Default value: 255</p> 321</div> 322<hr> 323<div class="refsect2"> 324<a name="GstKateTiger--default-font-red"></a><h3>The <code class="literal">“default-font-red”</code> property</h3> 325<pre class="programlisting"> “default-font-red” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 326<p>Default font color (red component, between 0 and 255) to render text with.</p> 327<p>Flags: Read / Write</p> 328<p>Allowed values: [0,255]</p> 329<p>Default value: 255</p> 330</div> 331<hr> 332<div class="refsect2"> 333<a name="GstKateTiger--language"></a><h3>The <code class="literal">“language”</code> property</h3> 334<pre class="programlisting"> “language” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 335<p>The language of the stream.</p> 336<p>Flags: Read</p> 337<p>Default value: ""</p> 338</div> 339<hr> 340<div class="refsect2"> 341<a name="GstKateTiger--original-canvas-height"></a><h3>The <code class="literal">“original-canvas-height”</code> property</h3> 342<pre class="programlisting"> “original-canvas-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 343<p>The canvas height this stream was authored for (0 is unspecified).</p> 344<p>Flags: Read</p> 345<p>Allowed values: >= 0</p> 346<p>Default value: 0</p> 347</div> 348<hr> 349<div class="refsect2"> 350<a name="GstKateTiger--original-canvas-width"></a><h3>The <code class="literal">“original-canvas-width”</code> property</h3> 351<pre class="programlisting"> “original-canvas-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 352<p>The canvas width this stream was authored for.</p> 353<p>Flags: Read</p> 354<p>Allowed values: >= 0</p> 355<p>Default value: 0</p> 356</div> 357<hr> 358<div class="refsect2"> 359<a name="GstKateTiger--quality"></a><h3>The <code class="literal">“quality”</code> property</h3> 360<pre class="programlisting"> “quality” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 361<p>Rendering quality (0 is faster, 1 is best and slower).</p> 362<p>Flags: Read / Write</p> 363<p>Allowed values: [0,1]</p> 364<p>Default value: 1</p> 365</div> 366</div> 367<div class="refsect1"> 368<a name="gst-plugins-bad-plugins-tiger.see-also"></a><h2>See Also</h2> 369<p>katedec</p> 370</div> 371</div> 372<div class="footer"> 373<hr>Generated by GTK-Doc V1.28</div> 374</body> 375</html>
