Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::FrameParams Class Reference

Parameters for initialising frame class objects.

#include <common.h>

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]
 

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

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

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

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

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

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

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

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

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

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

bool dirac::FrameParams::IsBFrame  )  const
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void dirac::FrameParams::SetOrigXl int  orig_xlen  ) 
 

void dirac::FrameParams::SetOrigYl int  orig_ylen  ) 
 

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

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

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

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


Member Data Documentation

ChromaFormat dirac::FrameParams::m_cformat [private]
 

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

int dirac::FrameParams::m_dwt_chroma_xl [private]
 

int dirac::FrameParams::m_dwt_chroma_yl [private]
 

int dirac::FrameParams::m_dwt_xl [private]
 

int dirac::FrameParams::m_dwt_yl [private]
 

int dirac::FrameParams::m_expiry_time [private]
 

int dirac::FrameParams::m_fnum [private]
 

FrameType dirac::FrameParams::m_frame_type [private]
 

FrameSort dirac::FrameParams::m_fsort [private]
 

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

int dirac::FrameParams::m_orig_cxl [private]
 

int dirac::FrameParams::m_orig_cyl [private]
 

int dirac::FrameParams::m_orig_xl [private]
 

int dirac::FrameParams::m_orig_yl [private]
 

bool dirac::FrameParams::m_output [private]
 

ReferenceType dirac::FrameParams::m_reference_type [private]
 

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

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

bool dirac::FrameParams::m_using_ac [private]
 


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.