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>theoradec: GStreamer Base 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 Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-textrender.html" title="textrender"> 10<link rel="next" href="gst-plugins-base-plugins-theoraenc.html" title="theoraenc"> 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-base-plugins-theoradec.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-theoradec.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-theoradec.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-base-plugins-textrender.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-base-plugins-theoraenc.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-base-plugins-theoradec"></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-base-plugins-theoradec.top_of_page"></a>theoradec</span></h2> 32<p>theoradec</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-base-plugins-theoradec.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#gint"><span class="type">gint</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-base-plugins-theoradec.html#GstTheoraDec--visualize-bit-usage" title="The “visualize-bit-usage” property">visualize-bit-usage</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#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-base-plugins-theoradec.html#GstTheoraDec--visualize-macroblock-modes" title="The “visualize-macroblock-modes” property">visualize-macroblock-modes</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-base-plugins-theoradec.html#GstTheoraDec--visualize-motion-vectors" title="The “visualize-motion-vectors” property">visualize-motion-vectors</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-base-plugins-theoradec.html#GstTheoraDec--visualize-quantization-modes" title="The “visualize-quantization-modes” property">visualize-quantization-modes</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65</tbody> 66</table></div> 67</div> 68<a name="GstTheoraDec"></a><div class="refsect1"> 69<a name="gst-plugins-base-plugins-theoradec.other"></a><h2>Types and Values</h2> 70<div class="informaltable"><table class="informaltable" width="100%" border="0"> 71<colgroup> 72<col width="150px" class="name"> 73<col class="description"> 74</colgroup> 75<tbody><tr> 76<td class="datatype_keyword">struct</td> 77<td class="function_name"><a class="link" href="gst-plugins-base-plugins-theoradec.html#GstTheoraDec-struct" title="struct GstTheoraDec">GstTheoraDec</a></td> 78</tr></tbody> 79</table></div> 80</div> 81<div class="refsect1"> 82<a name="gst-plugins-base-plugins-theoradec.object-hierarchy"></a><h2>Object Hierarchy</h2> 83<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 84 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 85 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 86 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 87 <span class="lineart">╰──</span> <a href="../html/GstVideoDecoder.html#GstVideoDecoder-struct">GstVideoDecoder</a> 88 <span class="lineart">╰──</span> GstTheoraDec 89</pre> 90</div> 91<div class="refsect1"> 92<a name="gst-plugins-base-plugins-theoradec.description"></a><h2>Description</h2> 93<p>This element decodes theora streams into raw video</p> 94<a class="ulink" href="http://www.theora.org/" target="_top">Theora</a> is a royalty-free 95<p>video codec maintained by the <a class="ulink" href="http://www.xiph.org/" target="_top">Xiph.org 96Foundation</a>, based on the VP3 codec.</p> 97<div class="refsect3"> 98<a name="id-1.2.99.7.5"></a><h4>Example pipeline</h4> 99<div class="informalexample"> 100 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 101 <tbody> 102 <tr> 103 <td class="listing_lines" align="right"><pre>1</pre></td> 104 <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>videotestsrc<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> theoradec <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> videoscale <span class="gtkdoc opt">!</span> autovideosink</pre></td> 105 </tr> 106 </tbody> 107 </table> 108</div> 109 110<p> 111 This example pipeline will decode an ogg stream and decodes the theora video in it. 112Refer to the theoraenc example to create the ogg file.</p> 113</div> 114<div class="refsynopsisdiv"> 115<h2>Synopsis</h2> 116<div class="refsect2"> 117<a name="id-1.2.99.7.6.1"></a><h3>Element Information</h3> 118<div class="variablelist"><table border="0" class="variablelist"> 119<colgroup> 120<col align="left" valign="top"> 121<col> 122</colgroup> 123<tbody> 124<tr> 125<td><p><span class="term">plugin</span></p></td> 126<td> 127 <a class="link" href="gst-plugins-base-plugins-plugin-theora.html#plugin-theora">theora</a> 128 </td> 129</tr> 130<tr> 131<td><p><span class="term">author</span></p></td> 132<td>Benjamin Otte <otte@gnome.org>, Wim Taymans <wim@fluendo.com></td> 133</tr> 134<tr> 135<td><p><span class="term">class</span></p></td> 136<td>Codec/Decoder/Video</td> 137</tr> 138</tbody> 139</table></div> 140</div> 141<hr> 142<div class="refsect2"> 143<a name="id-1.2.99.7.6.2"></a><h3>Element Pads</h3> 144<div class="variablelist"><table border="0" class="variablelist"> 145<colgroup> 146<col align="left" valign="top"> 147<col> 148</colgroup> 149<tbody> 150<tr> 151<td><p><span class="term">name</span></p></td> 152<td>sink</td> 153</tr> 154<tr> 155<td><p><span class="term">direction</span></p></td> 156<td>sink</td> 157</tr> 158<tr> 159<td><p><span class="term">presence</span></p></td> 160<td>always</td> 161</tr> 162<tr> 163<td><p><span class="term">details</span></p></td> 164<td>video/x-theora</td> 165</tr> 166</tbody> 167</table></div> 168<div class="variablelist"><table border="0" class="variablelist"> 169<colgroup> 170<col align="left" valign="top"> 171<col> 172</colgroup> 173<tbody> 174<tr> 175<td><p><span class="term">name</span></p></td> 176<td>src</td> 177</tr> 178<tr> 179<td><p><span class="term">direction</span></p></td> 180<td>source</td> 181</tr> 182<tr> 183<td><p><span class="term">presence</span></p></td> 184<td>always</td> 185</tr> 186<tr> 187<td><p><span class="term">details</span></p></td> 188<td>video/x-raw, format=(string){ I420, Y42B, Y444 }, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</td> 189</tr> 190</tbody> 191</table></div> 192</div> 193</div> 194</div> 195<div class="refsect1"> 196<a name="gst-plugins-base-plugins-theoradec.functions_details"></a><h2>Functions</h2> 197<p></p> 198</div> 199<div class="refsect1"> 200<a name="gst-plugins-base-plugins-theoradec.other_details"></a><h2>Types and Values</h2> 201<div class="refsect2"> 202<a name="GstTheoraDec-struct"></a><h3>struct GstTheoraDec</h3> 203<pre class="programlisting">struct GstTheoraDec;</pre> 204<p>Opaque object data structure.</p> 205</div> 206</div> 207<div class="refsect1"> 208<a name="gst-plugins-base-plugins-theoradec.property-details"></a><h2>Property Details</h2> 209<div class="refsect2"> 210<a name="GstTheoraDec--visualize-bit-usage"></a><h3>The <code class="literal">“visualize-bit-usage”</code> property</h3> 211<pre class="programlisting"> “visualize-bit-usage” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 212<p>Sets the bitstream breakdown visualization mode. Values influence the width of the bit usage bars to show.</p> 213<p>Flags: Read / Write</p> 214<p>Allowed values: [0,255]</p> 215<p>Default value: 0</p> 216</div> 217<hr> 218<div class="refsect2"> 219<a name="GstTheoraDec--visualize-macroblock-modes"></a><h3>The <code class="literal">“visualize-macroblock-modes”</code> property</h3> 220<pre class="programlisting"> “visualize-macroblock-modes” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 221<p>Show macroblock mode selection overlaid on image. Value gives a mask for macroblock (MB) modes to show.</p> 222<p>Flags: Read / Write</p> 223<p>Allowed values: [0,65535]</p> 224<p>Default value: 0</p> 225</div> 226<hr> 227<div class="refsect2"> 228<a name="GstTheoraDec--visualize-motion-vectors"></a><h3>The <code class="literal">“visualize-motion-vectors”</code> property</h3> 229<pre class="programlisting"> “visualize-motion-vectors” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 230<p>Show motion vector selection overlaid on image. Value gives a mask for motion vector (MV) modes to show.</p> 231<p>Flags: Read / Write</p> 232<p>Allowed values: [0,65535]</p> 233<p>Default value: 0</p> 234</div> 235<hr> 236<div class="refsect2"> 237<a name="GstTheoraDec--visualize-quantization-modes"></a><h3>The <code class="literal">“visualize-quantization-modes”</code> property</h3> 238<pre class="programlisting"> “visualize-quantization-modes” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 239<p>Show adaptive quantization mode selection overlaid on image. Value gives a mask for quantization (QI) modes to show.</p> 240<p>Flags: Read / Write</p> 241<p>Allowed values: [0,65535]</p> 242<p>Default value: 0</p> 243</div> 244</div> 245<div class="refsect1"> 246<a name="gst-plugins-base-plugins-theoradec.see-also"></a><h2>See Also</h2> 247<p>theoraenc, oggdemux</p> 248</div> 249</div> 250<div class="footer"> 251<hr>Generated by GTK-Doc V1.28</div> 252</body> 253</html>
