Dirac - A Video Codec

Created by the British Broadcasting Corporation.

---

dirac_instr::OverlayParams Class Reference

Class holding instrumentation overlay information.

#include <overlay.h>

List of all members.

Public Member Functions

• OverlayOption Option () const

  Get functions.
  

• int Reference () const

  Returns which reference is to be used.
  

• int Background () const

  Returns true if input picture background is used, false if grey.
  

• int Legend () const

  Returns true if colour legend is displayed.
  

• int MvClip () const

  Returns clip value for motion vectors.
  

• int SADClip () const

  Returns clip value for sad.
  

• void SetOption (OverlayOption o)

  Set functions.
  

• void SetReference (int r)

  Set which reference picture is to be used.
  

• void SetBackground (bool b)

  Set whether input picture or grey is used as background.
  

• void SetLegend (bool l)

  Set display of colour legend.
  

• void SetMvClip (int c)

  Set clip for motion vectors.
  

• void SetSADClip (int c)

  Set clip for sad.
  

Private Attributes

• OverlayOption m_option

  Instrumentation command line option.
  

• int m_ref

  Reference picture.
  

• bool m_bg

  Background - original luma or mid-grey.
  

• bool m_legend

  Instrumentation legend off.
  

• int m_mv_clip

  Motion vector clip value.
  

• int m_sad_clip

  SAD clip value.
  

---

Member Function Documentation

int dirac_instr::OverlayParams::Background (   )  const [inline]

int dirac_instr::OverlayParams::Legend (   )  const [inline]

int dirac_instr::OverlayParams::MvClip (   )  const [inline]

OverlayOption dirac_instr::OverlayParams::Option (   )  const [inline]

.. Returns instrumentation command line option

int dirac_instr::OverlayParams::Reference (   )  const [inline]

int dirac_instr::OverlayParams::SADClip (   )  const [inline]

void dirac_instr::OverlayParams::SetBackground (  bool  b  )  [inline]

void dirac_instr::OverlayParams::SetLegend (  bool  l  )  [inline]

void dirac_instr::OverlayParams::SetMvClip (  int  c  )  [inline]

void dirac_instr::OverlayParams::SetOption (  OverlayOption  o  )  [inline]

.. Set type of instrumentation

void dirac_instr::OverlayParams::SetReference (  int  r  )  [inline]

void dirac_instr::OverlayParams::SetSADClip (  int  c  )  [inline]

---

Member Data Documentation

bool dirac_instr::OverlayParams::m_bg [private]

bool dirac_instr::OverlayParams::m_legend [private]

int dirac_instr::OverlayParams::m_mv_clip [private]

OverlayOption dirac_instr::OverlayParams::m_option [private]

int dirac_instr::OverlayParams::m_ref [private]

int dirac_instr::OverlayParams::m_sad_clip [private]

---

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

• overlay.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.