<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="previous" href="Theora.Encoder.html"> <link rel="next" href="Theora.Skeleton.html"> <link rel="Up" href="Theora.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Theora" rel="Chapter" href="Theora.html"><title>Theora.Decoder</title> </head> <body> <div class="navbar"><a href="Theora.Encoder.html">Previous</a> <a href="Theora.html">Up</a> <a href="Theora.Skeleton.html">Next</a> </div> <center><h1>Module <a href="type_Theora.Decoder.html">Theora.Decoder</a></h1></center> <br> <pre><span class="keyword">module</span> Decoder: <code class="code">sig</code> <a href="Theora.Decoder.html">..</a> <code class="code">end</code></pre><hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t </pre> <pre><span class="keyword">val</span> <a name="VALcheck"></a>check : <code class="type">Ogg.Stream.packet -> bool</code></pre><div class="info"> Check wether an ogg logical stream contains theora data <p> This function shall be called just after you put the first page in the stream. See examples/thdecode.ml <p> Raises <code class="code">Ogg.Bad_data</code> if the stream does not contain theora data.<br> </div> <pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">Ogg.Stream.packet -><br> Ogg.Stream.packet -><br> Ogg.Stream.packet -><br> <a href="Theora.Decoder.html#TYPEt">t</a> * <a href="Theora.html#TYPEinfo">Theora.info</a> * string * (string * string) list</code></pre><div class="info"> Initialize the decoding structure. Needs the first 3 packets of the logical stream.<br> </div> <pre><span class="keyword">val</span> <a name="VALget_yuv"></a>get_yuv : <code class="type"><a href="Theora.Decoder.html#TYPEt">t</a> -> Ogg.Stream.t -> <a href="Theora.html#TYPEyuv_buffer">Theora.yuv_buffer</a></code></pre><div class="info"> Output the next available frame of decoded YUV data. <p> Raises <code class="code">Ogg.Not_enough_data</code> if the Ogg.Stream.t which has been used to initialize the handler does not contain enought data. You should submit a new page to it, and run this function again until it returns.<br> </div> </body></html>