Dirac - A Video Codec

Created by the British Broadcasting Corporation.

---

dirac::CodecParams Class Reference

Parameters common to coder and decoder operation. More...

#include <common.h>

Inheritance diagram for dirac::CodecParams:

[legend]Collaboration diagram for dirac::CodecParams:

[legend]List of all members.

Public Member Functions

• CodecParams ()

  Default constructor.
  

• int XNumMB () const

  Return the number of macroblocks horizontally.
  

• int YNumMB () const

  Return the number of macroblocks vertically.
  

• int XNumBlocks () const

  Return the number of blocks horizontally.
  

• int YNumBlocks () const

  Returns the number of blocks vertically.
  

• bool Verbose () const

  Returns true if we're operating verbosely, false otherwise.
  

• bool Interlace () const

  Returns true if we're operatung using interlace tools [not currently defined].
  

• bool TopFieldFirst () const

  Returns true if the topmost field comes first in time [NB: TBD since this duplicates metadata in the sequence header].
  

• const OLBParams & LumaBParams (int n) const

  Return the Luma block parameters for each macroblock splitting level.
  

• const OLBParams & ChromaBParams (int n) const

  Return the Chroma block parameters for each macroblock splitting level.
  

• int OrigXl () const

  Return the original frame width.
  

• int OrigYl () const

  Return the original frame height.
  

• void SetXNumMB (const int xn)

  Set how many MBs there are horizontally.
  

• void SetYNumMB (const int yn)

  Set how many MBs there are vertically.
  

• void SetXNumBlocks (const int xn)

  Set how many blocks there are horizontally.
  

• void SetYNumBlocks (const int yn)

  Set how many blocks there are vertically.
  

• void SetVerbose (bool v)

  Sets verbosity on or off.
  

• void SetInterlace (bool intlc)

  Sets whether interlace tools are to be used.
  

• void SetTopFieldFirst (bool topf)

  Sets whether the topmost field comes first in time [NB: TBD since this duplicates metadata in the sequence header].
  

• void SetBlockSizes (const OLBParams &olbparams, const ChromaFormat cformat)

  Set the block sizes for all MB splitting levels given these prototype block sizes for level=2.
  

• void SetOrigXl (const int x)

  Set the original frame width.
  

• void SetOrigYl (const int y)

  Set the original frame height.
  

Private Attributes

• int m_x_num_mb

  The number of macroblocks horizontally.
  

• int m_y_num_mb

  The number of macroblocks verticaly.
  

• int m_x_num_blocks

  The number of blocks horizontally.
  

• int m_y_num_blocks

  The number of blocks vertically.
  

• bool m_verbose

  Code/decode with commentary if true.
  

• bool m_interlace

  True if input is interlaced, false otherwise.
  

• bool m_topfieldfirst

  True if interlaced and top field is first in temporal order.
  

• OneDArray< OLBParams > m_lbparams
• OneDArray< OLBParams > m_cbparams
• int m_orig_xl

  The original frame width.
  

• int m_orig_yl

  The original frame height.
  

---

Detailed Description

Parameters used throughout both the encoder and the decoder

---

Constructor & Destructor Documentation

dirac::CodecParams::CodecParams (   )

---

Member Function Documentation

const OLBParams& dirac::CodecParams::ChromaBParams (  int  n  )  const [inline]

bool dirac::CodecParams::Interlace (   )  const [inline]

const OLBParams& dirac::CodecParams::LumaBParams (  int  n  )  const [inline]

int dirac::CodecParams::OrigXl (   )  const [inline]

int dirac::CodecParams::OrigYl (   )  const [inline]

void dirac::CodecParams::SetBlockSizes (  const OLBParams &  olbparams, const ChromaFormat  cformat )

void dirac::CodecParams::SetInterlace (  bool  intlc  )  [inline]

void dirac::CodecParams::SetOrigXl (  const int  x  )  [inline]

void dirac::CodecParams::SetOrigYl (  const int  y  )  [inline]

void dirac::CodecParams::SetTopFieldFirst (  bool  topf  )  [inline]

void dirac::CodecParams::SetVerbose (  bool  v  )  [inline]

void dirac::CodecParams::SetXNumBlocks (  const int  xn  )  [inline]

void dirac::CodecParams::SetXNumMB (  const int  xn  )  [inline]

void dirac::CodecParams::SetYNumBlocks (  const int  yn  )  [inline]

void dirac::CodecParams::SetYNumMB (  const int  yn  )  [inline]

bool dirac::CodecParams::TopFieldFirst (   )  const [inline]

bool dirac::CodecParams::Verbose (   )  const [inline]

int dirac::CodecParams::XNumBlocks (   )  const [inline]

int dirac::CodecParams::XNumMB (   )  const [inline]

int dirac::CodecParams::YNumBlocks (   )  const [inline]

int dirac::CodecParams::YNumMB (   )  const [inline]

---

Member Data Documentation

OneDArray<OLBParams> dirac::CodecParams::m_cbparams [private]

bool dirac::CodecParams::m_interlace [private]

OneDArray<OLBParams> dirac::CodecParams::m_lbparams [private]

int dirac::CodecParams::m_orig_xl [private]

int dirac::CodecParams::m_orig_yl [private]

bool dirac::CodecParams::m_topfieldfirst [private]

bool dirac::CodecParams::m_verbose [private]

int dirac::CodecParams::m_x_num_blocks [private]

int dirac::CodecParams::m_x_num_mb [private]

int dirac::CodecParams::m_y_num_blocks [private]

int dirac::CodecParams::m_y_num_mb [private]

---

The documentation for this class was generated from the following file:

• common.h

---

© 2004 British Broadcasting Corporation. Dirac code licensed under the Mozilla Public License (MPL) Version 1.1.
HTML documentation generated by Dimitri van Heesch's excellent Doxygen tool.