<!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="a00096.html">OLBParams</a>
</div>
<div class="contents">
<h1>dirac::OLBParams Class Reference</h1><!-- doxytag: class="dirac::OLBParams" -->Parameters for overlapped block motion compensation.
<p>
<code>#include <<a class="el" href="a00171_source.html">common.h</a>></code>
<p>
<p>
<a href="a00294.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="a00096.html#7b631775c43c7773095785c67dd3b626">OLBParams</a> ()
<dl class="el"><dd class="mdescRight">Default constructor does nothing. <a href="#7b631775c43c7773095785c67dd3b626"></a><br></dl><li><a class="el" href="a00096.html#ab7429a3296c283c8e43460216587dfa">OLBParams</a> (const int xblen, const int yblen, const int xbsep, const int ybsep)
<dl class="el"><dd class="mdescRight">Constructor. <a href="#ab7429a3296c283c8e43460216587dfa"></a><br></dl><li>int <a class="el" href="a00096.html#463d96359a7d599473070c9a7c6f1f5e">Xblen</a> () const
<dl class="el"><dd class="mdescRight">Returns the horizontal block length. <a href="#463d96359a7d599473070c9a7c6f1f5e"></a><br></dl><li>int <a class="el" href="a00096.html#2f40697e66034478eef0a484f21f19ef">Yblen</a> () const
<dl class="el"><dd class="mdescRight">Returns the vertical block length. <a href="#2f40697e66034478eef0a484f21f19ef"></a><br></dl><li>int <a class="el" href="a00096.html#d147441c2688c186c08dddc25b2ee3e9">Xbsep</a> () const
<dl class="el"><dd class="mdescRight">Returns the horizontal block separation. <a href="#d147441c2688c186c08dddc25b2ee3e9"></a><br></dl><li>int <a class="el" href="a00096.html#3b9acfab08f00c5cc9c992319626f3e6">Ybsep</a> () const
<dl class="el"><dd class="mdescRight">Returns the vertical block separation. <a href="#3b9acfab08f00c5cc9c992319626f3e6"></a><br></dl><li>int <a class="el" href="a00096.html#3d7e5aef09e9b8eb5a6e247c3637ebf1">Xoffset</a> () const
<dl class="el"><dd class="mdescRight">The offset in the horizontal start of the block caused by overlap,=(XBLEN-XBSEP)/2. <a href="#3d7e5aef09e9b8eb5a6e247c3637ebf1"></a><br></dl><li>int <a class="el" href="a00096.html#3978b720a5689e11c6fe3f3ef8614ddb">Yoffset</a> () const
<dl class="el"><dd class="mdescRight">The offset in the vertical start of the block caused by overlap,=(YBLEN-YBSEP)/2. <a href="#3978b720a5689e11c6fe3f3ef8614ddb"></a><br></dl><li>void <a class="el" href="a00096.html#841cb8025065d980c7ea5faa2fb8bfa7">SetXblen</a> (int xblen)
<dl class="el"><dd class="mdescRight">Sets the block width. <a href="#841cb8025065d980c7ea5faa2fb8bfa7"></a><br></dl><li>void <a class="el" href="a00096.html#a1430aadc8175b304e28cb10a72e46dd">SetYblen</a> (int yblen)
<dl class="el"><dd class="mdescRight">Sets the block height. <a href="#a1430aadc8175b304e28cb10a72e46dd"></a><br></dl><li>void <a class="el" href="a00096.html#b4498339c141c8e3bbd03b93570c0249">SetXbsep</a> (int xbsep)
<dl class="el"><dd class="mdescRight">Sets the block horizontal separation. <a href="#b4498339c141c8e3bbd03b93570c0249"></a><br></dl><li>void <a class="el" href="a00096.html#95bb609322fcdbbd4af10421a08c8b75">SetYbsep</a> (int ybsep)
<dl class="el"><dd class="mdescRight">Sets the block vertical separation. <a href="#95bb609322fcdbbd4af10421a08c8b75"></a><br></dl><li>bool <a class="el" href="a00096.html#400c741383072ef5e32374f3ceb0823e">operator==</a> (const <a class="el" href="a00096.html">OLBParams</a> bparams) const
</ul>
<h2>Private Attributes</h2>
<ul>
<li>int <a class="el" href="a00096.html#5ef048388fefd9d680e5ee43101db561">m_xblen</a>
<li>int <a class="el" href="a00096.html#5328e83485d3b16c5d53ddcf22382eb2">m_yblen</a>
<li>int <a class="el" href="a00096.html#dbc50bed229aefd574d2183f68437717">m_xbsep</a>
<li>int <a class="el" href="a00096.html#318ceed3678adfaebd8eea1c3ff9c9b2">m_ybsep</a>
<li>int <a class="el" href="a00096.html#7acf837c03d9800f5a4f949b9b061e16">m_xoffset</a>
<li>int <a class="el" href="a00096.html#467ed3a54eb9127c1f3cd35fd7c6d6b6">m_yoffset</a>
</ul>
<h2>Friends</h2>
<ul>
<li>std::ostream & <a class="el" href="a00096.html#8589235100403eef0086fc5d8d807b8e">operator<<</a> (std::ostream &, <a class="el" href="a00096.html">OLBParams</a> &)
<li>std::istream & <a class="el" href="a00096.html#5b8dca4880cd3c59c0266be3ba8634c7">operator>></a> (std::istream &, <a class="el" href="a00096.html">OLBParams</a> &)
</ul>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7b631775c43c7773095785c67dd3b626"></a><!-- doxytag: member="dirac::OLBParams::OLBParams" ref="7b631775c43c7773095785c67dd3b626" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dirac::OLBParams::OLBParams </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ab7429a3296c283c8e43460216587dfa"></a><!-- doxytag: member="dirac::OLBParams::OLBParams" ref="ab7429a3296c283c8e43460216587dfa" args="(const int xblen, const int yblen, const int xbsep, const int ybsep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dirac::OLBParams::OLBParams </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>xblen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>yblen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>xbsep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>ybsep</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>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="400c741383072ef5e32374f3ceb0823e"></a><!-- doxytag: member="dirac::OLBParams::operator==" ref="400c741383072ef5e32374f3ceb0823e" args="(const OLBParams bparams) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dirac::OLBParams::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00096.html">OLBParams</a> </td>
<td class="paramname"> <em>bparams</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="841cb8025065d980c7ea5faa2fb8bfa7"></a><!-- doxytag: member="dirac::OLBParams::SetXblen" ref="841cb8025065d980c7ea5faa2fb8bfa7" args="(int xblen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::OLBParams::SetXblen </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>xblen</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00171_source.html#l00881">m_xblen</a>, <a class="el" href="a00171_source.html#l00883">m_xbsep</a>, and <a class="el" href="a00171_source.html#l00885">m_xoffset</a>.</p>
</div>
</div><p>
<a class="anchor" name="b4498339c141c8e3bbd03b93570c0249"></a><!-- doxytag: member="dirac::OLBParams::SetXbsep" ref="b4498339c141c8e3bbd03b93570c0249" args="(int xbsep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::OLBParams::SetXbsep </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>xbsep</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00171_source.html#l00881">m_xblen</a>, <a class="el" href="a00171_source.html#l00883">m_xbsep</a>, and <a class="el" href="a00171_source.html#l00885">m_xoffset</a>.</p>
</div>
</div><p>
<a class="anchor" name="a1430aadc8175b304e28cb10a72e46dd"></a><!-- doxytag: member="dirac::OLBParams::SetYblen" ref="a1430aadc8175b304e28cb10a72e46dd" args="(int yblen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::OLBParams::SetYblen </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>yblen</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00171_source.html#l00882">m_yblen</a>, <a class="el" href="a00171_source.html#l00884">m_ybsep</a>, and <a class="el" href="a00171_source.html#l00886">m_yoffset</a>.</p>
</div>
</div><p>
<a class="anchor" name="95bb609322fcdbbd4af10421a08c8b75"></a><!-- doxytag: member="dirac::OLBParams::SetYbsep" ref="95bb609322fcdbbd4af10421a08c8b75" args="(int ybsep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dirac::OLBParams::SetYbsep </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ybsep</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="a00171_source.html#l00882">m_yblen</a>, <a class="el" href="a00171_source.html#l00884">m_ybsep</a>, and <a class="el" href="a00171_source.html#l00886">m_yoffset</a>.</p>
</div>
</div><p>
<a class="anchor" name="463d96359a7d599473070c9a7c6f1f5e"></a><!-- doxytag: member="dirac::OLBParams::Xblen" ref="463d96359a7d599473070c9a7c6f1f5e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::OLBParams::Xblen </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="a00171_source.html#l00881">m_xblen</a>.</p>
</div>
</div><p>
<a class="anchor" name="d147441c2688c186c08dddc25b2ee3e9"></a><!-- doxytag: member="dirac::OLBParams::Xbsep" ref="d147441c2688c186c08dddc25b2ee3e9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::OLBParams::Xbsep </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="a00171_source.html#l00883">m_xbsep</a>.</p>
</div>
</div><p>
<a class="anchor" name="3d7e5aef09e9b8eb5a6e247c3637ebf1"></a><!-- doxytag: member="dirac::OLBParams::Xoffset" ref="3d7e5aef09e9b8eb5a6e247c3637ebf1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::OLBParams::Xoffset </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="a00171_source.html#l00885">m_xoffset</a>.</p>
</div>
</div><p>
<a class="anchor" name="2f40697e66034478eef0a484f21f19ef"></a><!-- doxytag: member="dirac::OLBParams::Yblen" ref="2f40697e66034478eef0a484f21f19ef" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::OLBParams::Yblen </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="a00171_source.html#l00882">m_yblen</a>.</p>
</div>
</div><p>
<a class="anchor" name="3b9acfab08f00c5cc9c992319626f3e6"></a><!-- doxytag: member="dirac::OLBParams::Ybsep" ref="3b9acfab08f00c5cc9c992319626f3e6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::OLBParams::Ybsep </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="a00171_source.html#l00884">m_ybsep</a>.</p>
</div>
</div><p>
<a class="anchor" name="3978b720a5689e11c6fe3f3ef8614ddb"></a><!-- doxytag: member="dirac::OLBParams::Yoffset" ref="3978b720a5689e11c6fe3f3ef8614ddb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dirac::OLBParams::Yoffset </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="a00171_source.html#l00886">m_yoffset</a>.</p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="8589235100403eef0086fc5d8d807b8e"></a><!-- doxytag: member="dirac::OLBParams::operator<<" ref="8589235100403eef0086fc5d8d807b8e" args="(std::ostream &, OLBParams &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream& operator<< </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00096.html">OLBParams</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5b8dca4880cd3c59c0266be3ba8634c7"></a><!-- doxytag: member="dirac::OLBParams::operator>>" ref="5b8dca4880cd3c59c0266be3ba8634c7" args="(std::istream &, OLBParams &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::istream& operator>> </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00096.html">OLBParams</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="5ef048388fefd9d680e5ee43101db561"></a><!-- doxytag: member="dirac::OLBParams::m_xblen" ref="5ef048388fefd9d680e5ee43101db561" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00096.html#5ef048388fefd9d680e5ee43101db561">dirac::OLBParams::m_xblen</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00171_source.html#l00861">SetXblen()</a>, <a class="el" href="a00171_source.html#l00867">SetXbsep()</a>, and <a class="el" href="a00171_source.html#l00841">Xblen()</a>.</p>
</div>
</div><p>
<a class="anchor" name="dbc50bed229aefd574d2183f68437717"></a><!-- doxytag: member="dirac::OLBParams::m_xbsep" ref="dbc50bed229aefd574d2183f68437717" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00096.html#dbc50bed229aefd574d2183f68437717">dirac::OLBParams::m_xbsep</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00171_source.html#l00861">SetXblen()</a>, <a class="el" href="a00171_source.html#l00867">SetXbsep()</a>, and <a class="el" href="a00171_source.html#l00847">Xbsep()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7acf837c03d9800f5a4f949b9b061e16"></a><!-- doxytag: member="dirac::OLBParams::m_xoffset" ref="7acf837c03d9800f5a4f949b9b061e16" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00096.html#7acf837c03d9800f5a4f949b9b061e16">dirac::OLBParams::m_xoffset</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00171_source.html#l00861">SetXblen()</a>, <a class="el" href="a00171_source.html#l00867">SetXbsep()</a>, and <a class="el" href="a00171_source.html#l00853">Xoffset()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5328e83485d3b16c5d53ddcf22382eb2"></a><!-- doxytag: member="dirac::OLBParams::m_yblen" ref="5328e83485d3b16c5d53ddcf22382eb2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00096.html#5328e83485d3b16c5d53ddcf22382eb2">dirac::OLBParams::m_yblen</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00171_source.html#l00864">SetYblen()</a>, <a class="el" href="a00171_source.html#l00870">SetYbsep()</a>, and <a class="el" href="a00171_source.html#l00844">Yblen()</a>.</p>
</div>
</div><p>
<a class="anchor" name="318ceed3678adfaebd8eea1c3ff9c9b2"></a><!-- doxytag: member="dirac::OLBParams::m_ybsep" ref="318ceed3678adfaebd8eea1c3ff9c9b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00096.html#318ceed3678adfaebd8eea1c3ff9c9b2">dirac::OLBParams::m_ybsep</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00171_source.html#l00864">SetYblen()</a>, <a class="el" href="a00171_source.html#l00870">SetYbsep()</a>, and <a class="el" href="a00171_source.html#l00850">Ybsep()</a>.</p>
</div>
</div><p>
<a class="anchor" name="467ed3a54eb9127c1f3cd35fd7c6d6b6"></a><!-- doxytag: member="dirac::OLBParams::m_yoffset" ref="467ed3a54eb9127c1f3cd35fd7c6d6b6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00096.html#467ed3a54eb9127c1f3cd35fd7c6d6b6">dirac::OLBParams::m_yoffset</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="a00171_source.html#l00864">SetYblen()</a>, <a class="el" href="a00171_source.html#l00870">SetYbsep()</a>, and <a class="el" href="a00171_source.html#l00856">Yoffset()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00171_source.html">common.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>
distrib
>
Mandriva
>
2010.0
>
x86_64
>
media
>
main-release
>
by-pkgid
>
f250c16c2b84c9364a2f35a71121aaa2
>
files
>
161
