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  xlen,
int  ylen,
int  c_xlen,
int  c_ylen,
unsigned int  video_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 SeqParams sparams  ) 
 

dirac::FrameParams::FrameParams const SeqParams sparams,
const FrameSort fs
 


Member Function Documentation

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

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

int dirac::FrameParams::ChromaYl  )  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]
 

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

bool dirac::FrameParams::IsBFrame  )  const
 

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

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

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

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

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

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

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

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

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

void dirac::FrameParams::SetChromaYl 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::SetReferenceType const ReferenceType  rtype  ) 
 

void dirac::FrameParams::SetVideoDepth int  vd  )  [inline]
 

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

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

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

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


Member Data Documentation

ChromaFormat dirac::FrameParams::m_cformat [private]
 

int dirac::FrameParams::m_chroma_xl [private]
 

int dirac::FrameParams::m_chroma_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]
 

bool dirac::FrameParams::m_output [private]
 

ReferenceType dirac::FrameParams::m_reference_type [private]
 

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

std::vector<int> dirac::FrameParams::m_retd_list [mutable, private]
 

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

int dirac::FrameParams::m_xl [private]
 

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