Dirac - A Video Codec

Created by the British Broadcasting Corporation.

---

dirac::SeqParams Class Reference

Parameters relating to the video sequence being encoded/decoded.

#include <common.h>

List of all members.

Public Member Functions

• SeqParams ()

  Default Constructor.
  

• int Xl () const

  Returns the picture width.
  

• int Yl () const

  Returns the picture height.
  

• ChromaFormat CFormat () const

  Returns the chroma format of the sequence (Y only, 420, 422 etc).
  

• int ChromaWidth () const

  Returns the chroma width.
  

• int ChromaHeight () const

  Returns the chroma height.
  

• bool Interlace () const

  Returns true if the sequence is interlaced.
  

• bool TopFieldFirst () const

  Returns true if the top field comes first in time.
  

• int FrameRate () const

  Returns the number of frames to be displayed per second.
  

• int BitstreamVersion () const

  Returns the bitstream version.
  

• void SetXl (int xlen)

  Sets the picture width.
  

• void SetYl (int ylen)

  Sets the picture height.
  

• void SetCFormat (ChromaFormat cf)

  Sets the chroma format (Y only, 420, 422 etc).
  

• void SetInterlace (bool ilace)

  Sets the interlace flag: true if the sequence is interlaced, false otherwise.
  

• void SetTopFieldFirst (bool tff)

  Sets the 'top field first' flag: true if the top field comes first in time.
  

• void SetFrameRate (int fr)

  Sets the number of frames to be displayed per second.
  

• void SetBitstreamVersion (int bs_ver)

  Sets the bitstream version.
  

Private Attributes

• int m_xl

  Width of video.
  

• int m_yl

  Height of video.
  

• ChromaFormat m_cformat

  Presence of chroma and/or chroma sampling structure.
  

• bool m_interlace

  True if interlaced.
  

• bool m_topfieldfirst

  If interlaced, true if the top field is first in temporal order.
  

• int m_framerate

  Frame rate, per second.
  

• unsigned char m_bs_ver

  Bitsream version.
  

---

Constructor & Destructor Documentation

dirac::SeqParams::SeqParams (   )

---

Member Function Documentation

int dirac::SeqParams::BitstreamVersion (   )  const [inline]

ChromaFormat dirac::SeqParams::CFormat (   )  const [inline]

int dirac::SeqParams::ChromaHeight (   )  const

int dirac::SeqParams::ChromaWidth (   )  const

int dirac::SeqParams::FrameRate (   )  const [inline]

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

void dirac::SeqParams::SetBitstreamVersion (  int  bs_ver  )  [inline]

void dirac::SeqParams::SetCFormat (  ChromaFormat  cf  )  [inline]

void dirac::SeqParams::SetFrameRate (  int  fr  )  [inline]

void dirac::SeqParams::SetInterlace (  bool  ilace  )  [inline]

void dirac::SeqParams::SetTopFieldFirst (  bool  tff  )  [inline]

void dirac::SeqParams::SetXl (  int  xlen  )  [inline]

void dirac::SeqParams::SetYl (  int  ylen  )  [inline]

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

int dirac::SeqParams::Xl (   )  const [inline]

int dirac::SeqParams::Yl (   )  const [inline]

---

Member Data Documentation

unsigned char dirac::SeqParams::m_bs_ver [private]

ChromaFormat dirac::SeqParams::m_cformat [private]

int dirac::SeqParams::m_framerate [private]

bool dirac::SeqParams::m_interlace [private]

bool dirac::SeqParams::m_topfieldfirst [private]

int dirac::SeqParams::m_xl [private]

int dirac::SeqParams::m_yl [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.