Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::Picture Class Reference

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

#include <picture.h>

Inheritance diagram for dirac::Picture:
Collaboration diagram for dirac::Picture:

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

◆ Picture() [1/2]

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

Constructor initialises the picture parameters and the data

Referenced by operator=(), and Picture().

◆ Picture() [2/2]

dirac::Picture::Picture ( const Picture & cpy)

References Picture().

◆ ~Picture()

virtual dirac::Picture::~Picture ( )
virtual

Member Function Documentation

◆ ClearData()

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

Reimplemented in dirac::EncPicture.

◆ Clip()

void dirac::Picture::Clip ( )

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

◆ ClipComponent()

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

◆ ClipUpData()

void dirac::Picture::ClipUpData ( )

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

◆ Data() [1/2]

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

References m_pic_data.

◆ Data() [2/2]

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

References m_pic_data.

◆ Fill()

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

Initialise contents of picture with value provided

◆ GetPparams()

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

References m_pparams.

◆ Init()

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

◆ InitWltData()

void dirac::Picture::InitWltData ( const int transform_depth)

◆ operator=()

Picture & dirac::Picture::operator= ( const Picture & rhs)

References Picture().

◆ ReconfigPicture()

void dirac::Picture::ReconfigPicture ( const PictureParams & pp)

◆ SetPictureSort()

void dirac::Picture::SetPictureSort ( const PictureSort ps)
inline

References m_pparams.

◆ SetPictureType()

void dirac::Picture::SetPictureType ( const PictureType ftype)
inline

References m_pparams.

◆ SetReferenceType()

void dirac::Picture::SetReferenceType ( const ReferenceType rtype)
inline

References m_pparams.

◆ UpData() [1/2]

PicArray & dirac::Picture::UpData ( CompSort cs)

◆ UpData() [2/2]

const PicArray & dirac::Picture::UpData ( CompSort cs) const

◆ WltData() [1/2]

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

References m_wlt_data.

◆ WltData() [2/2]

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

References m_wlt_data.

Member Data Documentation

◆ m_pic_data

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

Referenced by Data(), and Data().

◆ m_pparams

PictureParams dirac::Picture::m_pparams
mutableprotected

◆ m_up_pic_data

PicArray* dirac::Picture::m_up_pic_data[3]
mutableprotected

◆ m_wlt_data

CoeffArray dirac::Picture::m_wlt_data[3]
protected

Referenced by WltData(), and 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.