PictureParams Class Reference

Parameters for initialising picture class objects.

#include <common.h>

Collaboration diagram for PictureParams:

Public Member Functions
	PictureParams ()
	Default constructor.
	PictureParams (const ChromaFormat &cf, int xlen, int ylen, unsigned int luma_depth, unsigned int chroma_depth)
	Constructor.
	PictureParams (const ChromaFormat &cf, const PictureSort &fs)
	Constructor.
	PictureParams (const SourceParams &sparams)
	Constructor.
const ChromaFormat &	CFormat () const
	Returns the chroma format of the picture.
int	Xl () const
	Returns the picture width.
int	Yl () const
	Returns the picture height.
int	ChromaXl () const
	Returns the chroma width of the picture.
int	ChromaYl () const
	Returns the chroma height of the picture.
unsigned int	LumaDepth () const
	Returns the luma depth.
unsigned int	ChromaDepth () const
	Returns the chroma depth.
const PictureSort &	PicSort () const
	Returns the type of the picture.
int	PictureNum () const
	Returns the number of the picture (in time order).
int	RetiredPictureNum () const
	Returns the retired reference picture number.
bool	IsBPicture () const
	Returns whether the picture is bi-directionally predicted by checking references.
int	ExpiryTime () const
	Returns the number of pictures after the current picture number after which the picture can be discarded.
bool	Output () const
	Returns an indication of whether the picture has been output yet.
const std::vector< int > &	Refs () const
	Returns a const C++ reference to the set of reference picture numbers (will be empty if the picture is an I picture).
std::vector< int > &	Refs ()
	Returns non-const C++ referece to the vector of reference pictures, to allow them to be set.
unsigned int	NumRefs () const
	Return the number of reference pictures.
PictureType	GetPictureType () const
	Returns type of picture (see enum).
ReferenceType	GetReferenceType () const
	Returns reference picture type (see enum).
bool	UsingAC () const
	Returns true is entropy coding using Arithmetic coding.
void	SetPicSort (const PictureSort &ps)
	Sets the type of picture.
void	SetPictureType (const PictureType ftype)
	Sets the picture to be Intra/Inter.
void	SetReferenceType (const ReferenceType rtype)
	Sets the picture to be a reference or not.
void	SetPictureNum (const int fn)
	Sets the picture number.
void	SetExpiryTime (const int expt)
	Sets how long the picture will stay in the buffer (encoder only).
void	SetAsOutput ()
	Sets a flag to indicate that the picture has been output.
void	SetCFormat (ChromaFormat cf)
	Sets the chroma format.
void	SetXl (int xlen)
	Sets the picture width.
void	SetYl (int ylen)
	Sets the picture height.
void	SetLumaDepth (unsigned int luma_depth)
	Set Luma Depth.
void	SetChromaDepth (unsigned int chroma_depth)
	Set Chroma Depth.
void	SetRetiredPictureNum (int retd_fnum)
	Sets the retired reference picture number.
void	SetUsingAC (bool using_ac)
	Sets the arithmetic coding flag.

Private Attributes
ChromaFormat	m_cformat
	The chroma format.
PictureSort	m_psort
	The picture sort.
std::vector< int >	m_refs
	The set of picture numbers of reference pictures.
int	m_expiry_time
	The number of pictures, after the current picture number, after the (de)coding of which the picture can be deleted.
int	m_fnum
	The picture number, in temporal order.
PictureType	m_picture_type
	Picture type.
ReferenceType	m_reference_type
	Reference type.
bool	m_output
	True if the picture has been output, false if not.
int	m_retd_fnum
	The picture number of the retired picture.
int	m_xl
	Picture luma width.
int	m_yl
	Picture luma height.
int	m_cxl
	Picture chroma width.
int	m_cyl
	Picture chroma height.
unsigned int	m_luma_depth
	Luma depth - number of bits required for lumz.
unsigned int	m_chroma_depth
	chroma depth - number of bits required for luma
bool	m_using_ac
	arithmetic coding flag

Constructor & Destructor Documentation

PictureParams() [1/4]

dirac::PictureParams::PictureParams

(

)

PictureParams() [2/4]

dirac::PictureParams::PictureParams	(	const ChromaFormat &	cf,
		int	xlen,
		int	ylen,
		unsigned int	luma_depth,
		unsigned int	chroma_depth )

Picture chroma format is set Picture sort defaults to I picture.

PictureParams() [3/4]

dirac::PictureParams::PictureParams	(	const ChromaFormat &	cf,
		const PictureSort &	fs )

Picture chroma format and picture sort are set.

PictureParams() [4/4]

dirac::PictureParams::PictureParams

(

const SourceParams &

sparams

)

Constructor. Parameters are derived from the source parameters

Member Function Documentation

CFormat()

const ChromaFormat & dirac::PictureParams::CFormat ( ) const

inline

ChromaDepth()

unsigned int dirac::PictureParams::ChromaDepth ( ) const

inline

ChromaXl()

int dirac::PictureParams::ChromaXl ( ) const

inline

ChromaYl()

int dirac::PictureParams::ChromaYl ( ) const

inline

ExpiryTime()

int dirac::PictureParams::ExpiryTime ( ) const

inline

GetPictureType()

PictureType dirac::PictureParams::GetPictureType ( ) const

inline

GetReferenceType()

ReferenceType dirac::PictureParams::GetReferenceType ( ) const

inline

IsBPicture()

bool dirac::PictureParams::IsBPicture

(

)

const

LumaDepth()

unsigned int dirac::PictureParams::LumaDepth ( ) const

inline

NumRefs()

unsigned int dirac::PictureParams::NumRefs ( ) const

inline

Output()

bool dirac::PictureParams::Output ( ) const

inline

PicSort()

const PictureSort & dirac::PictureParams::PicSort ( ) const

inline

PictureNum()

int dirac::PictureParams::PictureNum ( ) const

inline

Refs() [1/2]

std::vector< int > & dirac::PictureParams::Refs ( )

inline

Refs() [2/2]

const std::vector< int > & dirac::PictureParams::Refs ( ) const

inline

RetiredPictureNum()

int dirac::PictureParams::RetiredPictureNum ( ) const

inline

SetAsOutput()

void dirac::PictureParams::SetAsOutput ( )

inline

SetCFormat()

void dirac::PictureParams::SetCFormat ( ChromaFormat cf )

inline

SetChromaDepth()

void dirac::PictureParams::SetChromaDepth ( unsigned int chroma_depth )

inline

SetExpiryTime()

void dirac::PictureParams::SetExpiryTime ( const int expt )

inline

SetLumaDepth()

void dirac::PictureParams::SetLumaDepth ( unsigned int luma_depth )

inline

SetPicSort()

void dirac::PictureParams::SetPicSort

(

const PictureSort &

ps

)

SetPictureNum()

void dirac::PictureParams::SetPictureNum ( const int fn )

inline

SetPictureType()

void dirac::PictureParams::SetPictureType

(

const PictureType

ftype

)

SetReferenceType()

void dirac::PictureParams::SetReferenceType

(

const ReferenceType

rtype

)

SetRetiredPictureNum()

void dirac::PictureParams::SetRetiredPictureNum ( int retd_fnum )

inline

SetUsingAC()

void dirac::PictureParams::SetUsingAC ( bool using_ac )

inline

SetXl()

void dirac::PictureParams::SetXl

(

int

xlen

)

SetYl()

void dirac::PictureParams::SetYl

(

int

ylen

)

UsingAC()

bool dirac::PictureParams::UsingAC ( ) const

inline

Xl()

int dirac::PictureParams::Xl ( ) const

inline

Yl()

int dirac::PictureParams::Yl ( ) const

inline

Member Data Documentation

m_cformat

ChromaFormat dirac::PictureParams::m_cformat

private

m_chroma_depth

unsigned int dirac::PictureParams::m_chroma_depth

private

m_cxl

int dirac::PictureParams::m_cxl

private

m_cyl

int dirac::PictureParams::m_cyl

private

m_expiry_time

int dirac::PictureParams::m_expiry_time

private

m_fnum

int dirac::PictureParams::m_fnum

private

m_luma_depth

unsigned int dirac::PictureParams::m_luma_depth

private

m_output

bool dirac::PictureParams::m_output

private

m_picture_type

PictureType dirac::PictureParams::m_picture_type

private

m_psort

PictureSort dirac::PictureParams::m_psort

private

m_reference_type

ReferenceType dirac::PictureParams::m_reference_type

private

m_refs

std::vector<int> dirac::PictureParams::m_refs

private

m_retd_fnum

int dirac::PictureParams::m_retd_fnum

mutableprivate

m_using_ac

bool dirac::PictureParams::m_using_ac

private

m_xl

int dirac::PictureParams::m_xl

private

m_yl

int dirac::PictureParams::m_yl

private

---

The documentation for this class was generated from the following file:

• common.h