<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>tiger</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-stereo.html" title="stereo">
<link rel="next" href="gst-plugins-bad-plugins-timidity.html" title="timidity">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins">
<link rel="chapter" href="ch03.html" title="gst-plugins-bad Classes">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-bad-plugins-stereo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Bad Plugins 0.10 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-bad-plugins-timidity.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-bad-plugins-tiger.synopsis" class="shortcut">Top</a>
|
<a href="#gst-plugins-bad-plugins-tiger.description" class="shortcut">Description</a>
|
<a href="#gst-plugins-bad-plugins-tiger.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="tiger">
<a name="gst-plugins-bad-plugins-tiger"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-tiger.top_of_page"></a>tiger</span></h2>
<p>tiger</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gst-plugins-bad-plugins-tiger.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger" title="GstKateTiger">GstKateTiger</a>;
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="gst-plugins-bad-plugins-tiger.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--category" title='The "category" property'>category</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-alpha" title='The "default-background-alpha" property'>default-background-alpha</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-blue" title='The "default-background-blue" property'>default-background-blue</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-green" title='The "default-background-green" property'>default-background-green</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-red" title='The "default-background-red" property'>default-background-red</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-alpha" title='The "default-font-alpha" property'>default-font-alpha</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-blue" title='The "default-font-blue" property'>default-font-blue</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-desc" title='The "default-font-desc" property'>default-font-desc</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-effect" title='The "default-font-effect" property'>default-font-effect</a>" <span class="type">GstFontEffect</span> : Read / Write / Construct
"<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>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-green" title='The "default-font-green" property'>default-font-green</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-red" title='The "default-font-red" property'>default-font-red</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--language" title='The "language" property'>language</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--original-canvas-height" title='The "original-canvas-height" property'>original-canvas-height</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--original-canvas-width" title='The "original-canvas-width" property'>original-canvas-width</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read
"<a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--quality" title='The "quality" property'>quality</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gst-plugins-bad-plugins-tiger.description"></a><h2>Description</h2>
<p>
</p>
<div class="refsect2" title="Example pipeline">
<a name="id407600"></a><h3>Example pipeline</h3>
<p>
This element decodes and renders Kate streams
<a class="ulink" href="http://libkate.googlecode.com/" target="_top">Kate</a> is a free codec
for text based data, such as subtitles. Any number of kate streams can be
embedded in an Ogg stream.
</p>
<p>
libkate (see above url) and <a class="ulink" href="http://libtiger.googlecode.com/" target="_top">libtiger</a>
are needed to build this element.
</p>
<p>
This pipeline renders a Kate stream on top of a Theora video multiplexed
in the same stream:
</p>
<pre class="programlisting">
gst-launch \
filesrc location=video.ogg ! oggdemux name=demux \
demux. ! queue ! theoradec ! ffmpegcolorspace ! tiger name=tiger \
demux. ! queue ! kateparse ! tiger. \
tiger. ! ffmpegcolorspace ! autovideosink
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1" title="Details">
<a name="gst-plugins-bad-plugins-tiger.details"></a><h2>Details</h2>
<div class="refsect2" title="GstKateTiger">
<a name="GstKateTiger"></a><h3>GstKateTiger</h3>
<pre class="programlisting">typedef struct {
GstElement element;
GstPad *katesinkpad;
GstPad *videosinkpad;
GstPad *srcpad;
GstKateDecoderBase decoder;
tiger_renderer *tr;
gdouble quality;
gchar *default_font_desc;
gboolean default_font_effect;
gdouble default_font_effect_strength;
guchar default_font_r;
guchar default_font_g;
guchar default_font_b;
guchar default_font_a;
guchar default_background_r;
guchar default_background_g;
guchar default_background_b;
guchar default_background_a;
gint video_width;
gint video_height;
GMutex *mutex;
} GstKateTiger;
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="gst-plugins-bad-plugins-tiger.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "category" property'>
<a name="GstKateTiger--category"></a><h3>The <code class="literal">"category"</code> property</h3>
<pre class="programlisting"> "category" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>The category of the stream.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2" title='The "default-background-alpha" property'>
<a name="GstKateTiger--default-background-alpha"></a><h3>The <code class="literal">"default-background-alpha"</code> property</h3>
<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> : Read / Write</pre>
<p>Default background color (alpha component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-background-blue" property'>
<a name="GstKateTiger--default-background-blue"></a><h3>The <code class="literal">"default-background-blue"</code> property</h3>
<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> : Read / Write</pre>
<p>Default background color (blue component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-background-green" property'>
<a name="GstKateTiger--default-background-green"></a><h3>The <code class="literal">"default-background-green"</code> property</h3>
<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> : Read / Write</pre>
<p>Default background color (green component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-background-red" property'>
<a name="GstKateTiger--default-background-red"></a><h3>The <code class="literal">"default-background-red"</code> property</h3>
<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> : Read / Write</pre>
<p>Default background color (red component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-alpha" property'>
<a name="GstKateTiger--default-font-alpha"></a><h3>The <code class="literal">"default-font-alpha"</code> property</h3>
<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> : Read / Write</pre>
<p>Default font color (alpha component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-blue" property'>
<a name="GstKateTiger--default-font-blue"></a><h3>The <code class="literal">"default-font-blue"</code> property</h3>
<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> : Read / Write</pre>
<p>Default font color (blue component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-desc" property'>
<a name="GstKateTiger--default-font-desc"></a><h3>The <code class="literal">"default-font-desc"</code> property</h3>
<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>* : Read / Write</pre>
<p>Default font description (Pango style) to render text with.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-effect" property'>
<a name="GstKateTiger--default-font-effect"></a><h3>The <code class="literal">"default-font-effect"</code> property</h3>
<pre class="programlisting"> "default-font-effect" <span class="type">GstFontEffect</span> : Read / Write / Construct</pre>
<p>Whether to apply an effect to text by default, for increased readability.</p>
<p>Default value: none</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-effect-strength" property'>
<a name="GstKateTiger--default-font-effect-strength"></a><h3>The <code class="literal">"default-font-effect-strength"</code> property</h3>
<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> : Read / Write</pre>
<p>How pronounced should the font effect be (effect dependent).</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-green" property'>
<a name="GstKateTiger--default-font-green"></a><h3>The <code class="literal">"default-font-green"</code> property</h3>
<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> : Read / Write</pre>
<p>Default font color (green component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "default-font-red" property'>
<a name="GstKateTiger--default-font-red"></a><h3>The <code class="literal">"default-font-red"</code> property</h3>
<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> : Read / Write</pre>
<p>Default font color (red component, between 0 and 255) to render text with.</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2" title='The "language" property'>
<a name="GstKateTiger--language"></a><h3>The <code class="literal">"language"</code> property</h3>
<pre class="programlisting"> "language" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>The language of the stream.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2" title='The "original-canvas-height" property'>
<a name="GstKateTiger--original-canvas-height"></a><h3>The <code class="literal">"original-canvas-height"</code> property</h3>
<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> : Read</pre>
<p>The canvas height this stream was authored for (0 is unspecified).</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "original-canvas-width" property'>
<a name="GstKateTiger--original-canvas-width"></a><h3>The <code class="literal">"original-canvas-width"</code> property</h3>
<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> : Read</pre>
<p>The canvas width this stream was authored for.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "quality" property'>
<a name="GstKateTiger--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
<pre class="programlisting"> "quality" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
<p>Rendering quality (0 is faster, 1 is best and slower).</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="gst-plugins-bad-plugins-tiger.see-also"></a><h2>See Also</h2>
katedec
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
