Dirac - A Video Codec

Created by the British Broadcasting Corporation.


Public Member Functions | Private Attributes
dirac::DecoderParams Class Reference

Parameters for the decoding process. More...

#include <common.h>

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

List of all members.

Public Member Functions

 DecoderParams (const VideoFormat &video_format=VIDEO_FORMAT_CIF, PictureType ftype=INTRA_PICTURE, unsigned int num_refs=0, bool set_defaults=false)
 Default constructor.
bool Verbose () const
 Returns true if we're operating verbosely, false otherwise.
void SetVerbose (bool v)
 Sets verbosity on or off.
- Public Member Functions inherited from dirac::CodecParams
 CodecParams (const VideoFormat &video_format=VIDEO_FORMAT_CUSTOM, PictureType ftype=INTRA_PICTURE, unsigned int num_refs=0, bool set_defaults=true)
 Default constructor.
int PictureCodingMode () const
 Returns the picture coding mode (independent of source format)
bool FieldCoding () const
 Returns true if the pictures are being coded as fields (mode 1 or 3)
bool TopFieldFirst () const
 Returns true if the topmost field comes first in time when coding.
int Xl () const
 Return the picture/field luma width.
int Yl () const
 Return the picture/field luma height.
int ChromaXl () const
 Return the picture/field chroma width.
int ChromaYl () const
 Return the picture/field chroma height.
unsigned int LumaDepth () const
 Returns the luma depth.
unsigned int ChromaDepth () const
 Returns the chroma depth.
bool ZeroTransform () const
 Return zero transform flag being used for picture (de)coding.
WltFilter TransformFilter () const
 Return the wavelet filter currently being used for picture (de)coding.
unsigned int TransformDepth () const
 Return the transform depth being used for picture (de)coding.
CodeBlockMode GetCodeBlockMode () const
 Return multiple quantisers flag being used for picture (de)coding.
bool SpatialPartition () const
 Return the spatial partitioning flag being used for picture (de)coding.
const CodeBlocksGetCodeBlocks (unsigned int level) const
 Return the code blocks for a particular level.
VideoFormat GetVideoFormat () const
 Return the video format currently being used for picture (de)coding.
PicturePredParamsGetPicPredParams ()
 Return the picture prediction params.
const PicturePredParamsGetPicPredParams () const
 Return the picture prediction params.
void SetPictureCodingMode (int pic_coding)
 Sets whether input is coded as fields or quincunxially.
void SetTopFieldFirst (bool topf)
 Sets whether the topmost field comes first in time [NB: TBD since this duplicates metadata in the sequence header].
void SetXl (const int x)
 Set the picture/field luma width.
void SetYl (const int y)
 Set the picture/field luma height.
void SetChromaXl (const int x)
 Set the frame/field chroma width.
void SetChromaYl (const int y)
 Set the frame/field chroma height.
void SetLumaDepth (unsigned int luma_depth)
 Set Luma Depth.
void SetChromaDepth (unsigned int chroma_depth)
 Set Chroma Depth.
void SetZeroTransform (bool zero_transform)
 Set the zero transform flag being used for picture (de)coding.
void SetTransformFilter (const WltFilter wf)
 Set the wavelet filter used for picture (de)coding.
void SetTransformFilter (unsigned int wf_idx)
 Set the wavelet filter used for picture (de)coding.
void SetTransformDepth (unsigned int wd)
 Set the transform depth used for picture (de)coding and allocate for the code blocks array.
void SetCodeBlockMode (unsigned int cb_mode)
 Set the multiple quantisers flag usedto picture (de)coding.
void SetSpatialPartition (bool spatial_partition)
 Set the spatial partition flag usedto picture (de)coding.
void SetCodeBlocks (unsigned int level, unsigned int hblocks, unsigned int vblocks)
 Set the number of code blocks for a particular level.
void SetVideoFormat (const VideoFormat vd)
 Set the video format used for picture (de)coding.

Private Attributes

bool m_verbose
 Code/decode with commentary if true.

Additional Inherited Members

- Protected Member Functions inherited from dirac::CodecParams
WltFilter TransformFilter (unsigned int wf_idx)
 Return the Wavelet filter associated with the wavelet index.

Detailed Description

Parameters for the decoding process. Derived from CodecParams.


Constructor & Destructor Documentation

dirac::DecoderParams::DecoderParams ( const VideoFormat video_format = VIDEO_FORMAT_CIF,
PictureType  ftype = INTRA_PICTURE,
unsigned int  num_refs = 0,
bool  set_defaults = false 
)

Member Function Documentation

void dirac::DecoderParams::SetVerbose ( bool  v)
inline

References m_verbose.

bool dirac::DecoderParams::Verbose ( ) const
inline

References m_verbose.


Member Data Documentation

bool dirac::DecoderParams::m_verbose
private

Referenced by SetVerbose(), and Verbose().


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.