Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::Frame Class Reference

A class for encapsulating all the data relating to a frame. More...

#include <frame.h>

Collaboration diagram for dirac::Frame:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Private Member Functions

Private Attributes


Detailed Description

A class for encapsulating all the data relating to a frame - all the component data, including upconverted data.


Constructor & Destructor Documentation

dirac::Frame::Frame const FrameParams fp  ) 
 

Constructor initialises the frame parameters and the data

dirac::Frame::Frame const Frame cpy  ) 
 

virtual dirac::Frame::~Frame  )  [virtual]
 


Member Function Documentation

void dirac::Frame::ClearData  )  [private]
 

void dirac::Frame::Clip  ) 
 

Clips the data to lie between 0 and (1<<video_depth)-1

void dirac::Frame::ClipComponent PicArray pic_data,
CompSort  cs
const [private]
 

void dirac::Frame::ClipUpData  ) 
 

Clips the upconverted data to lie between 0 and (1<<video_depth)-1

void dirac::Frame::CopyContents Frame out  )  const
 

Copy contents of frame into the output frame passed to it retaining the frame dimensions of the output frame.

const PicArray& dirac::Frame::Data CompSort  cs  )  const
 

PicArray& dirac::Frame::Data CompSort  cs  ) 
 

void dirac::Frame::Fill ValueType  val  ) 
 

Initialise contents of frame with value provided

FrameParams& dirac::Frame::GetFparams  )  const [inline]
 

void dirac::Frame::Init  )  [private]
 

Frame& dirac::Frame::operator= const Frame rhs  ) 
 

void dirac::Frame::ReconfigFrame const FrameParams fp  ) 
 

void dirac::Frame::SetFrameSort const FrameSort  fs  )  [inline]
 

void dirac::Frame::SetFrameType const FrameType  ftype  )  [inline]
 

void dirac::Frame::SetReferenceType const ReferenceType  rtype  )  [inline]
 

const PicArray& dirac::Frame::Udata  )  const [inline]
 

PicArray& dirac::Frame::Udata  )  [inline]
 

const PicArray& dirac::Frame::UpData CompSort  cs  )  const
 

PicArray& dirac::Frame::UpData CompSort  cs  ) 
 

const PicArray& dirac::Frame::UpUdata  )  const
 

PicArray& dirac::Frame::UpUdata  ) 
 

const PicArray& dirac::Frame::UpVdata  )  const
 

PicArray& dirac::Frame::UpVdata  ) 
 

const PicArray& dirac::Frame::UpYdata  )  const
 

PicArray& dirac::Frame::UpYdata  ) 
 

const PicArray& dirac::Frame::Vdata  )  const [inline]
 

PicArray& dirac::Frame::Vdata  )  [inline]
 

const PicArray& dirac::Frame::Ydata  )  const [inline]
 

PicArray& dirac::Frame::Ydata  )  [inline]
 


Member Data Documentation

FrameParams dirac::Frame::m_fparams [mutable, private]
 

bool dirac::Frame::m_redo_upUdata [mutable, private]
 

bool dirac::Frame::m_redo_upVdata [mutable, private]
 

bool dirac::Frame::m_redo_upYdata [mutable, private]
 

PicArray* dirac::Frame::m_U_data [private]
 

PicArray* dirac::Frame::m_upU_data [mutable, private]
 

PicArray* dirac::Frame::m_upV_data [mutable, private]
 

PicArray* dirac::Frame::m_upY_data [mutable, private]
 

PicArray* dirac::Frame::m_V_data [private]
 

PicArray* dirac::Frame::m_Y_data [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.