<!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="a00134.html">StreamFieldInput</a>
</div>
<div class="contents">
<h1>dirac::StreamFieldInput Class Reference</h1><!-- doxytag: class="dirac::StreamFieldInput" --><!-- doxytag: inherits="dirac::StreamPicInput" --><code>#include <<a class="el" href="a00211_source.html">pic_io.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dirac::StreamFieldInput:</div>
<div class="dynsection">
<p><center><img src="a00134.png" usemap="#dirac::StreamFieldInput_map" border="0" alt=""></center>
<map name="dirac::StreamFieldInput_map">
<area href="a00138.html" alt="dirac::StreamPicInput" shape="rect" coords="0,0,141,24">
</map>
</div>
<p>
<a href="a00324.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="a00134.html#d8416a0cb86407caf917ce07885e2573">StreamFieldInput</a> ()
<dl class="el"><dd class="mdescRight">Default Constructor. <a href="#d8416a0cb86407caf917ce07885e2573"></a><br></dl><li><a class="el" href="a00134.html#ed898ba200ea9d4556c0deb44a7878a5">StreamFieldInput</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="#ed898ba200ea9d4556c0deb44a7878a5"></a><br></dl><li>virtual <a class="el" href="a00134.html#ad0b29eee1bb4cc747b4a70ca56e1382">~StreamFieldInput</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <a href="#ad0b29eee1bb4cc747b4a70ca56e1382"></a><br></dl><li>virtual void <a class="el" href="a00134.html#62ec5727b6b4896cb8c3d19fb5d924c6">Skip</a> (const int n)
<dl class="el"><dd class="mdescRight">Skip n frames of input. <a href="#62ec5727b6b4896cb8c3d19fb5d924c6"></a><br></dl><li>virtual bool <a class="el" href="a00134.html#1f3cdc39deb441df8c207999b47e1614">ReadNextPicture</a> (<a class="el" href="a00108.html">Picture</a> &myfield)
<dl class="el"><dd class="mdescRight">Read the next field from the file. <a href="#1f3cdc39deb441df8c207999b47e1614"></a><br></dl><li>bool <a class="el" href="a00134.html#ec4dd57c98e6109de4670bc378897782">ReadNextFrame</a> (<a class="el" href="a00108.html">Picture</a> &field1, <a class="el" href="a00108.html">Picture</a> &field2)
<dl class="el"><dd class="mdescRight">Read the next frame from the file. <a href="#ec4dd57c98e6109de4670bc378897782"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<ul>
<li>bool <a class="el" href="a00134.html#df68b7072270e5134dfbca98da52505f">ReadFieldComponent</a> (<a class="el" href="a00107.html">PicArray</a> &pic_data1, <a class="el" href="a00107.html">PicArray</a> &pic_data2, const <a class="el" href="a00234.html#39dd89c4c7484412efd87d41548271cd">CompSort</a> &cs)
<dl class="el"><dd class="mdescRight">Read both Field components from the file. <a href="#df68b7072270e5134dfbca98da52505f"></a><br></dl><li>bool <a class="el" href="a00134.html#eee6caa82454e64590514a95d8593bf3">ReadFieldComponent</a> (bool is_field1, <a class="el" href="a00107.html">PicArray</a> &pic_data, const <a class="el" href="a00234.html#39dd89c4c7484412efd87d41548271cd">CompSort</a> &cs)
<dl class="el"><dd class="mdescRight">Read one Field component from the file. <a href="#eee6caa82454e64590514a95d8593bf3"></a><br></dl></ul>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d8416a0cb86407caf917ce07885e2573"></a><!-- doxytag: member="dirac::StreamFieldInput::StreamFieldInput" ref="d8416a0cb86407caf917ce07885e2573" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dirac::StreamFieldInput::StreamFieldInput </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="ed898ba200ea9d4556c0deb44a7878a5"></a><!-- doxytag: member="dirac::StreamFieldInput::StreamFieldInput" ref="ed898ba200ea9d4556c0deb44a7878a5" args="(std::istream *ip_pic_ptr, const SourceParams &sparams)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dirac::StreamFieldInput::StreamFieldInput </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="ad0b29eee1bb4cc747b4a70ca56e1382"></a><!-- doxytag: member="dirac::StreamFieldInput::~StreamFieldInput" ref="ad0b29eee1bb4cc747b4a70ca56e1382" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual dirac::StreamFieldInput::~StreamFieldInput </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="eee6caa82454e64590514a95d8593bf3"></a><!-- doxytag: member="dirac::StreamFieldInput::ReadFieldComponent" ref="eee6caa82454e64590514a95d8593bf3" args="(bool is_field1, PicArray &pic_data, const CompSort &cs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dirac::StreamFieldInput::ReadFieldComponent </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>is_field1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00107.html">PicArray</a> & </td>
<td class="paramname"> <em>pic_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00234.html#39dd89c4c7484412efd87d41548271cd">CompSort</a> & </td>
<td class="paramname"> <em>cs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="df68b7072270e5134dfbca98da52505f"></a><!-- doxytag: member="dirac::StreamFieldInput::ReadFieldComponent" ref="df68b7072270e5134dfbca98da52505f" args="(PicArray &pic_data1, PicArray &pic_data2, const CompSort &cs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dirac::StreamFieldInput::ReadFieldComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00107.html">PicArray</a> & </td>
<td class="paramname"> <em>pic_data1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00107.html">PicArray</a> & </td>
<td class="paramname"> <em>pic_data2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00234.html#39dd89c4c7484412efd87d41548271cd">CompSort</a> & </td>
<td class="paramname"> <em>cs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ec4dd57c98e6109de4670bc378897782"></a><!-- doxytag: member="dirac::StreamFieldInput::ReadNextFrame" ref="ec4dd57c98e6109de4670bc378897782" args="(Picture &field1, Picture &field2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dirac::StreamFieldInput::ReadNextFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00108.html">Picture</a> & </td>
<td class="paramname"> <em>field1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00108.html">Picture</a> & </td>
<td class="paramname"> <em>field2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1f3cdc39deb441df8c207999b47e1614"></a><!-- doxytag: member="dirac::StreamFieldInput::ReadNextPicture" ref="1f3cdc39deb441df8c207999b47e1614" args="(Picture &myfield)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool dirac::StreamFieldInput::ReadNextPicture </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00108.html">Picture</a> & </td>
<td class="paramname"> <em>myfield</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implements <a class="el" href="a00138.html#2b9500dae0c386c082e4c223230dee78">dirac::StreamPicInput</a>.</p>
</div>
</div><p>
<a class="anchor" name="62ec5727b6b4896cb8c3d19fb5d924c6"></a><!-- doxytag: member="dirac::StreamFieldInput::Skip" ref="62ec5727b6b4896cb8c3d19fb5d924c6" args="(const int n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void dirac::StreamFieldInput::Skip </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implements <a class="el" href="a00138.html#873291a91d6e069b0fa5eba5c338aec1">dirac::StreamPicInput</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>
