Dirac - A Video Codec

Created by the British Broadcasting Corporation.


Public Member Functions | Protected Member Functions | Protected Attributes
dirac::Picture Class Reference

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

#include <picture.h>

Inheritance diagram for dirac::Picture:
Inheritance graph
[legend]
Collaboration diagram for dirac::Picture:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Picture (const PictureParams &pp)
 Constructor.
 Picture (const Picture &cpy)
 Copy constructor. Private as not currently used [may want to implement reference counting later.].
virtual ~Picture ()
 Destructor.
Pictureoperator= (const Picture &rhs)
 Assignment =. Private as not currently used [may want to implement reference counting later.].
void Fill (ValueType val)
 Picture Fill.
PictureParamsGetPparams () const
 Gets the picture parameters.
void SetPictureSort (const PictureSort ps)
 Sets the picture sort.
void SetPictureType (const PictureType ftype)
 Sets the picture type.
void SetReferenceType (const ReferenceType rtype)
 Sets the picture type.
void ReconfigPicture (const PictureParams &pp)
 Reconfigures to the new parameters.
PicArrayData (CompSort cs)
 Returns a given component.
const PicArrayData (CompSort cs) const
 Returns a given component.
PicArrayUpData (CompSort cs)
 Returns a given upconverted component.
const PicArrayUpData (CompSort cs) const
 Returns a given upconverted component.
const CoeffArrayWltData (CompSort c) const
 Returns the wavelet coefficient data.
CoeffArrayWltData (CompSort c)
 Returns the wavelet coefficient data.
void InitWltData (const int transform_depth)
 Initialises the wavelet coefficient data arrays;.
void Clip ()
 Clip the data to prevent overshoot.
void ClipUpData ()
 Clip the upconverted data to prevent overshoot.

Protected Member Functions

virtual void Init ()
 Initialises the picture once the picture parameters have been set.
virtual void ClearData ()
 Delete all the data.
void ClipComponent (PicArray &pic_data, CompSort cs) const
 Clip an individual component.

Protected Attributes

PictureParams m_pparams
PicArraym_pic_data [3]
PicArraym_up_pic_data [3]
CoeffArray m_wlt_data [3]

Detailed Description

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


Constructor & Destructor Documentation

dirac::Picture::Picture ( const PictureParams pp)

Constructor initialises the picture parameters and the data

dirac::Picture::Picture ( const Picture cpy)
virtual dirac::Picture::~Picture ( )
virtual

Member Function Documentation

virtual void dirac::Picture::ClearData ( )
protectedvirtual

Reimplemented in dirac::EncPicture.

void dirac::Picture::Clip ( )

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

void dirac::Picture::ClipComponent ( PicArray pic_data,
CompSort  cs 
) const
protected
void dirac::Picture::ClipUpData ( )

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

PicArray& dirac::Picture::Data ( CompSort  cs)
inline

References m_pic_data.

const PicArray& dirac::Picture::Data ( CompSort  cs) const
inline

References m_pic_data.

void dirac::Picture::Fill ( ValueType  val)

Initialise contents of picture with value provided

PictureParams& dirac::Picture::GetPparams ( ) const
inline

References m_pparams.

virtual void dirac::Picture::Init ( )
protectedvirtual
void dirac::Picture::InitWltData ( const int  transform_depth)
Picture& dirac::Picture::operator= ( const Picture rhs)
void dirac::Picture::ReconfigPicture ( const PictureParams pp)
void dirac::Picture::SetPictureSort ( const PictureSort  ps)
inline
void dirac::Picture::SetPictureType ( const PictureType  ftype)
inline
void dirac::Picture::SetReferenceType ( const ReferenceType  rtype)
inline
PicArray& dirac::Picture::UpData ( CompSort  cs)
const PicArray& dirac::Picture::UpData ( CompSort  cs) const
const CoeffArray& dirac::Picture::WltData ( CompSort  c) const
inline

References m_wlt_data.

CoeffArray& dirac::Picture::WltData ( CompSort  c)
inline

References m_wlt_data.


Member Data Documentation

PicArray* dirac::Picture::m_pic_data[3]
protected

Referenced by Data().

PictureParams dirac::Picture::m_pparams
mutableprotected
PicArray* dirac::Picture::m_up_pic_data[3]
mutableprotected
CoeffArray dirac::Picture::m_wlt_data[3]
protected

Referenced by WltData().


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.