<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Dirac Video Codec</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <h1 align="center" color="#606080"> Dirac - A Video Codec </h1> <p align="center"> Created by the <a href="http://www.bbc.co.uk">British Broadcasting Corporation</a>. </p> <hr> <!-- Generated by Doxygen 1.5.9 --> <div class="navpath"><a class="el" href="a00234.html">dirac</a>::<a class="el" href="a00138.html">StreamPicInput</a> </div> <div class="contents"> <h1>dirac::StreamPicInput Class Reference</h1><!-- doxytag: class="dirac::StreamPicInput" --><a class="el" href="a00108.html" title="A class for encapsulating all the data relating to a picture.">Picture</a> input class. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="a00211_source.html">pic_io.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for dirac::StreamPicInput:</div> <div class="dynsection"> <p><center><img src="a00138.png" usemap="#dirac::StreamPicInput_map" border="0" alt=""></center> <map name="dirac::StreamPicInput_map"> <area href="a00134.html" alt="dirac::StreamFieldInput" shape="rect" coords="0,56,149,80"> <area href="a00136.html" alt="dirac::StreamFrameInput" shape="rect" coords="159,56,308,80"> </map> </div> <p> <a href="a00322.html">List of all members.</a><h2>Public Member Functions</h2> <ul> <li><a class="el" href="a00138.html#a41ef62b7939b66ec2826290a491a70d">StreamPicInput</a> () <dl class="el"><dd class="mdescRight">Default Constructor. <a href="#a41ef62b7939b66ec2826290a491a70d"></a><br></dl><li><a class="el" href="a00138.html#35552bbe7cfbe4991f6dfec7da033509">StreamPicInput</a> (std::istream *ip_pic_ptr, const <a class="el" href="a00131.html">SourceParams</a> &sparams) <dl class="el"><dd class="mdescRight">Constructor. <a href="#35552bbe7cfbe4991f6dfec7da033509"></a><br></dl><li>virtual <a class="el" href="a00138.html#4b56f3a9f906ca4f734794083d77e942">~StreamPicInput</a> () <dl class="el"><dd class="mdescRight">Destructor. <a href="#4b56f3a9f906ca4f734794083d77e942"></a><br></dl><li>virtual void <a class="el" href="a00138.html#873291a91d6e069b0fa5eba5c338aec1">Skip</a> (const int n)=0 <dl class="el"><dd class="mdescRight">Skip n frames of input. <a href="#873291a91d6e069b0fa5eba5c338aec1"></a><br></dl><li>virtual bool <a class="el" href="a00138.html#2b9500dae0c386c082e4c223230dee78">ReadNextPicture</a> (<a class="el" href="a00108.html">Picture</a> &mypic)=0 <dl class="el"><dd class="mdescRight">Read the next picture frame/field from the file. <a href="#2b9500dae0c386c082e4c223230dee78"></a><br></dl><li><a class="el" href="a00131.html">SourceParams</a> & <a class="el" href="a00138.html#afac75b70bedddde3deb6af2ea86a3a8">GetSourceParams</a> () const <dl class="el"><dd class="mdescRight">Get the source parameters. <a href="#afac75b70bedddde3deb6af2ea86a3a8"></a><br></dl><li>bool <a class="el" href="a00138.html#430b11d91bbdf8bcfcfa8e13cad19196">End</a> () const <dl class="el"><dd class="mdescRight">Returns true if we're at the end of the input, false otherwise. <a href="#430b11d91bbdf8bcfcfa8e13cad19196"></a><br></dl></ul> <h2>Protected Attributes</h2> <ul> <li><a class="el" href="a00131.html">SourceParams</a> <a class="el" href="a00138.html#f751849b0029e864f406f7c3530d9fda">m_sparams</a> <dl class="el"><dd class="mdescRight">Source parameters. <a href="#f751849b0029e864f406f7c3530d9fda"></a><br></dl><li>std::istream * <a class="el" href="a00138.html#b2ec8cbbea8c5b2a6415fe39c218d9db">m_ip_pic_ptr</a> <dl class="el"><dd class="mdescRight">Input stream. <a href="#b2ec8cbbea8c5b2a6415fe39c218d9db"></a><br></dl></ul> <hr><a name="_details"></a><h2>Detailed Description</h2> Abstract Class for reading picture data from a stream. <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a41ef62b7939b66ec2826290a491a70d"></a><!-- doxytag: member="dirac::StreamPicInput::StreamPicInput" ref="a41ef62b7939b66ec2826290a491a70d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dirac::StreamPicInput::StreamPicInput </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="35552bbe7cfbe4991f6dfec7da033509"></a><!-- doxytag: member="dirac::StreamPicInput::StreamPicInput" ref="35552bbe7cfbe4991f6dfec7da033509" args="(std::istream *ip_pic_ptr, const SourceParams &sparams)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dirac::StreamPicInput::StreamPicInput </td> <td>(</td> <td class="paramtype">std::istream * </td> <td class="paramname"> <em>ip_pic_ptr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00131.html">SourceParams</a> & </td> <td class="paramname"> <em>sparams</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor, takes <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>ip_pic_ptr</em> </td><td>input stream to read from </td></tr> <tr><td valign="top"></td><td valign="top"><em>sparams</em> </td><td>Source parameters </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="4b56f3a9f906ca4f734794083d77e942"></a><!-- doxytag: member="dirac::StreamPicInput::~StreamPicInput" ref="4b56f3a9f906ca4f734794083d77e942" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual dirac::StreamPicInput::~StreamPicInput </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="430b11d91bbdf8bcfcfa8e13cad19196"></a><!-- doxytag: member="dirac::StreamPicInput::End" ref="430b11d91bbdf8bcfcfa8e13cad19196" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool dirac::StreamPicInput::End </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="afac75b70bedddde3deb6af2ea86a3a8"></a><!-- doxytag: member="dirac::StreamPicInput::GetSourceParams" ref="afac75b70bedddde3deb6af2ea86a3a8" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00131.html">SourceParams</a>& dirac::StreamPicInput::GetSourceParams </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>References <a class="el" href="a00211_source.html#l00334">m_sparams</a>.</p> <p>Referenced by <a class="el" href="a00211_source.html#l00512">dirac::FileStreamInput::GetSourceParams()</a>, and <a class="el" href="a00211_source.html#l00423">dirac::MemoryStreamInput::GetSourceParams()</a>.</p> </div> </div><p> <a class="anchor" name="2b9500dae0c386c082e4c223230dee78"></a><!-- doxytag: member="dirac::StreamPicInput::ReadNextPicture" ref="2b9500dae0c386c082e4c223230dee78" args="(Picture &mypic)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool dirac::StreamPicInput::ReadNextPicture </td> <td>(</td> <td class="paramtype"><a class="el" href="a00108.html">Picture</a> & </td> <td class="paramname"> <em>mypic</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implemented in <a class="el" href="a00136.html#b58b2ca22cb482bfd712fb0e033022b6">dirac::StreamFrameInput</a>, and <a class="el" href="a00134.html#1f3cdc39deb441df8c207999b47e1614">dirac::StreamFieldInput</a>.</p> </div> </div><p> <a class="anchor" name="873291a91d6e069b0fa5eba5c338aec1"></a><!-- doxytag: member="dirac::StreamPicInput::Skip" ref="873291a91d6e069b0fa5eba5c338aec1" args="(const int n)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void dirac::StreamPicInput::Skip </td> <td>(</td> <td class="paramtype">const int </td> <td class="paramname"> <em>n</em> </td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Implemented in <a class="el" href="a00136.html#94e7083de2183718bedc37434efe6f62">dirac::StreamFrameInput</a>, and <a class="el" href="a00134.html#62ec5727b6b4896cb8c3d19fb5d924c6">dirac::StreamFieldInput</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="b2ec8cbbea8c5b2a6415fe39c218d9db"></a><!-- doxytag: member="dirac::StreamPicInput::m_ip_pic_ptr" ref="b2ec8cbbea8c5b2a6415fe39c218d9db" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::istream* <a class="el" href="a00138.html#b2ec8cbbea8c5b2a6415fe39c218d9db">dirac::StreamPicInput::m_ip_pic_ptr</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="f751849b0029e864f406f7c3530d9fda"></a><!-- doxytag: member="dirac::StreamPicInput::m_sparams" ref="f751849b0029e864f406f7c3530d9fda" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00131.html">SourceParams</a> <a class="el" href="a00138.html#f751849b0029e864f406f7c3530d9fda">dirac::StreamPicInput::m_sparams</a><code> [mutable, protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Referenced by <a class="el" href="a00211_source.html#l00326">GetSourceParams()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="a00211_source.html">pic_io.h</a></ul> </div> <hr> <p align="center"><small> © 2004 British Broadcasting Corporation. Dirac code licensed under the <a href="http://www.mozilla.org/MPL/">Mozilla Public License (MPL) Version 1.1</a>.<br> HTML documentation generated by Dimitri van Heesch's excellent <a href="http://www.doxygen.org">Doxygen</a> tool. </small></p> </body> </html>