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]

References m_cformat.

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

References m_xl.

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

References m_yl.

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

References m_chroma_xl.

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

References m_chroma_yl.

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

References m_fsort.

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

References m_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.

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

References m_video_depth.

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::SetXl ( int  xl  )  [inline]

References m_xl.

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

References m_yl.

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

References m_chroma_xl.

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

References m_chroma_yl.

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

References m_video_depth.

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

References m_retd_list.

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

References m_retd_list.


Member Data Documentation

Referenced by CFormat(), and SetCFormat().

int dirac::FrameParams::m_xl [private]

Referenced by SetXl(), and Xl().

int dirac::FrameParams::m_yl [private]

Referenced by SetYl(), and Yl().

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 ChromaXl(), and SetChromaXl().

Referenced by ChromaYl(), and SetChromaYl().

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

Referenced by RetiredFrames().

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

Referenced by GetVideoDepth(), and SetVideoDepth().


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.