Dirac - A Video Codec

Created by the British Broadcasting Corporation.

---

dirac::EncoderParams Class Reference

Parameters for the encoding process. More...

#include <common.h>

Inheritance diagram for dirac::EncoderParams:

[legend]Collaboration diagram for dirac::EncoderParams:

[legend]List of all members.

Public Member Functions

• EncoderParams ()

  Default constructor.
  

• float Qf () const

  Get the quality factor.
  

• int NumL1 () const

  Return the nominal number of L1 frames before the next I frame.
  

• int L1Sep () const

  Return the separation between L1 frames (and between L1 and I frames).
  

• float UFactor () const

  Return the amount we're weighting noise in the U component.
  

• float VFactor () const

  Return the amount we're weighting noise in the V component.
  

• float CPD () const

  Return the number of cycles per degree at the nominal viewing distance for the raster.
  

• float ILambda () const

  Return the Lagrangian parameter to be used for I frames.
  

• float L1Lambda () const

  Return the Lagrangian parameter to be used for L1 frames.
  

• float L2Lambda () const

  Return the Lagrangian parameter to be used for L2 frames.
  

• float Lambda (const FrameSort &fsort) const

  Return the Lagrangian parameter to be used for frames.
  

• float L1MELambda () const

  Return the Lagrangian ME parameter to be used for L1 frames.
  

• float L2MELambda () const

  Return the Lagrangian ME parameter to be used for L2 frames.
  

• char * OutputPath () const

  Return the output path to be used for storing diagnositic data.
  

• const EntropyCorrector & EntropyFactors () const

  Return a reference to the entropy factors.
  

• EntropyCorrector & EntropyFactors ()

  Return a reference to the entropy factors - we need to be able to change the values of the entropy factors in situ.
  

• const SequenceOutputManager & BitsOut () const

  Return a reference to the bit output class.
  

• SequenceOutputManager & BitsOut ()

  Return a reference to the bit output class - we need to output, so non-const.
  

• void SetQf (const float qfac)

  Set the quality factor.
  

• void SetNumL1 (const int nl)

  Set the nominal number of L1 frames between I frames.
  

• void SetL1Sep (const int lsep)

  Set the separation between L1 frames.
  

• void SetUFactor (const float uf)

  Set the amount to weight noise in the U component.
  

• void SetVFactor (const float vf)

  Set the amount to weight noise in the V component.
  

• void SetCPD (const float cpd)

  Set the number of cycles per degree at the nominal viewing distance.
  

• void SetILambda (const float l)

  Set the Lagrangian parameter to be used for I frames.
  

• void SetL1Lambda (const float l)

  Set the Lagrangian parameter to be used for L1 frames.
  

• void SetL2Lambda (const float l)

  Set the Lagrangian parameter to be used for L2 frames.
  

• void SetLambda (const FrameSort &fsort, const float l)

  Set the Lagrangian parameters to be used for frames.
  

• void SetL1MELambda (const float l)

  Set the Lagrangian parameter to be used for L1 motion estimation.
  

• void SetL2MELambda (const float l)

  Set the Lagrangian parameter to be used for L2 motion estimation.
  

• void SetOutputPath (const char *op)

  Set the output path to be used for diagnostic data.
  

• void SetEntropyFactors (EntropyCorrector *entcorrect)

  Sets the entropy factors - TBD: set this up in a constructor and pass encoder params around entirely by reference.
  

• void SetBitsOut (SequenceOutputManager *so)

  Sets the bit output - TBD: set this up in a constructor and pass encoder params around entirely by reference.
  

Private Attributes

• float m_qf

  Quality factor (between 0 and 10).
  

• int m_num_L1

  Number of L1 frames before next I frame.
  

• int m_L1_sep

  Separation between L1 frames.
  

• float m_ufactor

  factor for weighting U component quantisation errors
  

• float m_vfactor

  factor for weighting V component quantisation errors
  

• float m_cpd

  Cycles per degree assumed for viewing the video.
  

• float m_I_lambda

  Lagrangian parameter for Intra frame coding.
  

• float m_L1_lambda

  Lagrangian parameter for L1 frame coding.
  

• float m_L2_lambda

  Lagrangian parameter for L2 frame coding.
  

• float m_L1_me_lambda

  Lagrangian param for L1 motion estimation.
  

• float m_L2_me_lambda

  Lagrangian param for L2 motion estimation.
  

• EntropyCorrector * m_ent_correct

  Correction factors for quantiser selection.
  

• SequenceOutputManager * m_bit_out

  Pointer to object for managing bitstream output.
  

• std::string m_output_path

  Output file path.
  

---

Detailed Description

Parameters for the encoding process, derived from CodecParams.

---

Constructor & Destructor Documentation

dirac::EncoderParams::EncoderParams (   )

---

Member Function Documentation

SequenceOutputManager& dirac::EncoderParams::BitsOut (   )  [inline]

const SequenceOutputManager& dirac::EncoderParams::BitsOut (   )  const [inline]

float dirac::EncoderParams::CPD (   )  const [inline]

EntropyCorrector& dirac::EncoderParams::EntropyFactors (   )  [inline]

const EntropyCorrector& dirac::EncoderParams::EntropyFactors (   )  const [inline]

float dirac::EncoderParams::ILambda (   )  const [inline]

float dirac::EncoderParams::L1Lambda (   )  const [inline]

float dirac::EncoderParams::L1MELambda (   )  const [inline]

int dirac::EncoderParams::L1Sep (   )  const [inline]

float dirac::EncoderParams::L2Lambda (   )  const [inline]

float dirac::EncoderParams::L2MELambda (   )  const [inline]

float dirac::EncoderParams::Lambda (  const FrameSort &  fsort  )  const

int dirac::EncoderParams::NumL1 (   )  const [inline]

Return the nominal number of L1 frames before the next I frame. Can be overridden by I-frame insertion

char* dirac::EncoderParams::OutputPath (   )  const [inline]

float dirac::EncoderParams::Qf (   )  const [inline]

void dirac::EncoderParams::SetBitsOut (  SequenceOutputManager *  so  )  [inline]

void dirac::EncoderParams::SetCPD (  const float  cpd  )  [inline]

void dirac::EncoderParams::SetEntropyFactors (  EntropyCorrector *  entcorrect  )  [inline]

void dirac::EncoderParams::SetILambda (  const float  l  )  [inline]

void dirac::EncoderParams::SetL1Lambda (  const float  l  )  [inline]

void dirac::EncoderParams::SetL1MELambda (  const float  l  )  [inline]

void dirac::EncoderParams::SetL1Sep (  const int  lsep  )  [inline]

void dirac::EncoderParams::SetL2Lambda (  const float  l  )  [inline]

void dirac::EncoderParams::SetL2MELambda (  const float  l  )  [inline]

void dirac::EncoderParams::SetLambda (  const FrameSort &  fsort, const float  l )

void dirac::EncoderParams::SetNumL1 (  const int  nl  )  [inline]

void dirac::EncoderParams::SetOutputPath (  const char *  op  )  [inline]

void dirac::EncoderParams::SetQf (  const float  qfac  )  [inline]

void dirac::EncoderParams::SetUFactor (  const float  uf  )  [inline]

void dirac::EncoderParams::SetVFactor (  const float  vf  )  [inline]

float dirac::EncoderParams::UFactor (   )  const [inline]

float dirac::EncoderParams::VFactor (   )  const [inline]

---

Member Data Documentation

SequenceOutputManager* dirac::EncoderParams::m_bit_out [private]

float dirac::EncoderParams::m_cpd [private]

EntropyCorrector* dirac::EncoderParams::m_ent_correct [private]

float dirac::EncoderParams::m_I_lambda [private]

float dirac::EncoderParams::m_L1_lambda [private]

float dirac::EncoderParams::m_L1_me_lambda [private]

int dirac::EncoderParams::m_L1_sep [private]

float dirac::EncoderParams::m_L2_lambda [private]

float dirac::EncoderParams::m_L2_me_lambda [private]

int dirac::EncoderParams::m_num_L1 [private]

std::string dirac::EncoderParams::m_output_path [private]

float dirac::EncoderParams::m_qf [private]

float dirac::EncoderParams::m_ufactor [private]

float dirac::EncoderParams::m_vfactor [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.