Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::FrameParams Class Reference

Parameters for initialising frame class objects.

#include <common.h>

Collaboration diagram for dirac::FrameParams:

Collaboration graph
[legend]

List of all members.

Public Member Functions

Private Attributes


Constructor & Destructor Documentation

dirac::FrameParams::FrameParams (  ) 

dirac::FrameParams::FrameParams ( const ChromaFormat cf,
int  orig_xlen,
int  orig_ylen,
int  dwt_xlen,
int  dwt_ylen,
int  c_dwt_xlen,
int  c_dwt_ylen,
unsigned int  luma_depth,
unsigned int  chroma_depth 
)

Frame chroma format is set Frame sort defaults to I frame.

dirac::FrameParams::FrameParams ( const ChromaFormat cf,
const FrameSort fs 
)

Frame chroma format and frame sort are set.

dirac::FrameParams::FrameParams ( const SourceParams sparams  ) 

dirac::FrameParams::FrameParams ( const SourceParams sparams,
const FrameSort fs 
)


Member Function Documentation

const ChromaFormat& dirac::FrameParams::CFormat (  )  const [inline]

References m_cformat.

int dirac::FrameParams::DwtXl (  )  const [inline]

References m_dwt_xl.

int dirac::FrameParams::DwtYl (  )  const [inline]

References m_dwt_yl.

int dirac::FrameParams::DwtChromaXl (  )  const [inline]

References m_dwt_chroma_xl.

int dirac::FrameParams::DwtChromaYl (  )  const [inline]

References m_dwt_chroma_yl.

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

References m_orig_xl.

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

References m_orig_yl.

int dirac::FrameParams::OrigChromaXl (  )  const [inline]

References m_orig_cxl.

int dirac::FrameParams::OrigChromaYl (  )  const [inline]

References m_orig_cyl.

unsigned int dirac::FrameParams::LumaDepth (  )  const [inline]

References m_luma_depth.

unsigned int dirac::FrameParams::ChromaDepth (  )  const [inline]

References m_chroma_depth.

const FrameSort& dirac::FrameParams::FSort (  )  const [inline]

References m_fsort.

int dirac::FrameParams::FrameNum (  )  const [inline]

References m_fnum.

int dirac::FrameParams::RetiredFrameNum (  )  const [inline]

References m_retd_fnum.

bool dirac::FrameParams::IsBFrame (  )  const

int dirac::FrameParams::ExpiryTime (  )  const [inline]

References m_expiry_time.

bool dirac::FrameParams::Output (  )  const [inline]

References m_output.

const std::vector<int>& dirac::FrameParams::Refs (  )  const [inline]

References m_refs.

std::vector<int>& dirac::FrameParams::Refs (  )  [inline]

References m_refs.

unsigned int dirac::FrameParams::NumRefs (  )  const [inline]

References m_refs.

FrameType dirac::FrameParams::GetFrameType (  )  const [inline]

References m_frame_type.

ReferenceType dirac::FrameParams::GetReferenceType (  )  const [inline]

References m_reference_type.

bool dirac::FrameParams::UsingAC (  )  const [inline]

References m_using_ac.

void dirac::FrameParams::SetFSort ( const FrameSort fs  ) 

void dirac::FrameParams::SetFrameType ( const FrameType  ftype  ) 

void dirac::FrameParams::SetReferenceType ( const ReferenceType  rtype  ) 

void dirac::FrameParams::SetFrameNum ( const int  fn  )  [inline]

References m_fnum.

void dirac::FrameParams::SetExpiryTime ( const int  expt  )  [inline]

References m_expiry_time.

void dirac::FrameParams::SetAsOutput (  )  [inline]

References m_output.

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

References m_cformat.

void dirac::FrameParams::SetDwtXl ( int  xl  )  [inline]

References m_dwt_xl.

void dirac::FrameParams::SetDwtYl ( int  yl  )  [inline]

References m_dwt_yl.

void dirac::FrameParams::SetOrigXl ( int  orig_xlen  ) 

void dirac::FrameParams::SetOrigYl ( int  orig_ylen  ) 

void dirac::FrameParams::SetDwtChromaXl ( int  xl  )  [inline]

References m_dwt_chroma_xl.

void dirac::FrameParams::SetDwtChromaYl ( int  yl  )  [inline]

References m_dwt_chroma_yl.

void dirac::FrameParams::SetLumaDepth ( unsigned int  luma_depth  )  [inline]

References m_luma_depth.

void dirac::FrameParams::SetChromaDepth ( unsigned int  chroma_depth  )  [inline]

References m_chroma_depth.

void dirac::FrameParams::SetRetiredFrameNum ( int  retd_fnum  )  [inline]

References m_retd_fnum.

void dirac::FrameParams::SetUsingAC ( bool  using_ac  )  [inline]

References m_using_ac.


Member Data Documentation

Referenced by CFormat(), and SetCFormat().

Referenced by DwtXl(), and SetDwtXl().

Referenced by DwtYl(), and SetDwtYl().

Referenced by FSort().

std::vector<int> dirac::FrameParams::m_refs [private]

Referenced by NumRefs(), and Refs().

Referenced by ExpiryTime(), and SetExpiryTime().

Referenced by FrameNum(), and SetFrameNum().

Referenced by GetFrameType().

Referenced by GetReferenceType().

Referenced by Output(), and SetAsOutput().

Referenced by DwtChromaXl(), and SetDwtChromaXl().

Referenced by DwtChromaYl(), and SetDwtChromaYl().

int dirac::FrameParams::m_retd_fnum [mutable, private]

Referenced by OrigXl().

Referenced by OrigYl().

Referenced by OrigChromaXl().

Referenced by OrigChromaYl().

unsigned int dirac::FrameParams::m_luma_depth [private]

Referenced by LumaDepth(), and SetLumaDepth().

unsigned int dirac::FrameParams::m_chroma_depth [private]

Referenced by ChromaDepth(), and SetChromaDepth().

Referenced by SetUsingAC(), and UsingAC().


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

© 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.