Dirac - A Video Codec
Created by the British Broadcasting Corporation.
dirac::CodecParams Class Reference
Parameters common to coder and decoder operation.
More...
#include <common.h>
Inheritance diagram for dirac::CodecParams:
[legend]Collaboration diagram for dirac::CodecParams:
[legend]List of all members.Public Member Functions
- CodecParams (const VideoFormat &video_format=VIDEO_FORMAT_CUSTOM, PictureType ftype=INTRA_PICTURE, unsigned int num_refs=0, bool set_defaults=true)
- Default constructor.
- int XNumMB () const
- Return the number of macroblocks horizontally.
- int YNumMB () const
- Return the number of macroblocks vertically.
- int XNumBlocks () const
- Return the number of blocks horizontally.
- int YNumBlocks () const
- Returns the number of blocks vertically.
- 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.
- const OLBParams & LumaBParams (int n) const
- Return the Luma block parameters for each macroblock splitting level.
- const OLBParams & ChromaBParams (int n) const
- Return the Chroma block parameters for each macroblock splitting level.
- MVPrecisionType MVPrecision () const
- Return the number of accuracy bits used for motion vectors.
- 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 CodeBlocks & GetCodeBlocks (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.
- bool UsingGlobalMotion () const
- Return the global motion flag used for encoding/decoding.
- unsigned int PictureWeightsBits () const
- Return the number of picture weight precision bits.
- int Ref1Weight () const
- Return the Ref1 weight.
- int Ref2Weight () const
- Return the Ref2 weight.
- bool CustomRefWeights ()
- void SetXNumMB (const int xn)
- Set how many MBs there are horizontally.
- void SetYNumMB (const int yn)
- Set how many MBs there are vertically.
- void SetXNumBlocks (const int xn)
- Set how many blocks there are horizontally.
- void SetYNumBlocks (const int yn)
- Set how many blocks there are vertically.
- 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 SetBlockSizes (const OLBParams &olbparams, const ChromaFormat cformat)
- Set the block sizes for all MB splitting levels given these prototype block sizes for level=2.
- void SetLumaBlockParams (const OLBParams &olbparams)
- Set block level luma params.
- void SetMVPrecision (const MVPrecisionType p)
- Set the number of accuracy bits for motion vectors.
- void SetMVPrecision (const MVPrecisionType p) const
- 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.
- void SetUsingGlobalMotion (bool gm)
- Set the wavelet filter used for picture (de)coding.
- void SetPictureWeightsPrecision (unsigned int wt_prec)
- Set the picture weight precision bits used for (de)coding.
- void SetRef1Weight (int wt)
- Set the ref 1 picture weight.
- void SetRef2Weight (int wt)
- Set the ref 2 picture weight.
Protected Member Functions
Private Attributes
Detailed Description
Parameters used throughout both the encoder and the decoder
Constructor & Destructor Documentation
dirac::CodecParams::CodecParams |
( |
const VideoFormat & |
video_format = VIDEO_FORMAT_CUSTOM , |
|
|
PictureType |
ftype = INTRA_PICTURE , |
|
|
unsigned int |
num_refs = 0 , |
|
|
bool |
set_defaults = true |
|
) |
|
|
Member Function Documentation
const OLBParams& dirac::CodecParams::ChromaBParams |
( |
int |
n |
) |
const [inline] |
|
unsigned int dirac::CodecParams::ChromaDepth |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::ChromaXl |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::ChromaYl |
( |
|
) |
const [inline] |
|
bool dirac::CodecParams::CustomRefWeights |
( |
|
) |
[inline] |
|
bool dirac::CodecParams::FieldCoding |
( |
|
) |
const [inline] |
|
CodeBlockMode dirac::CodecParams::GetCodeBlockMode |
( |
|
) |
const [inline] |
|
const CodeBlocks& dirac::CodecParams::GetCodeBlocks |
( |
unsigned int |
level |
) |
const |
|
VideoFormat dirac::CodecParams::GetVideoFormat |
( |
|
) |
const [inline] |
|
const OLBParams& dirac::CodecParams::LumaBParams |
( |
int |
n |
) |
const [inline] |
|
unsigned int dirac::CodecParams::LumaDepth |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::PictureCodingMode |
( |
|
) |
const [inline] |
|
|
Returns the picture coding mode (independent of source format) 0 = Frame coding (no quincunx) 1 = Field coding (no quincunx) |
unsigned int dirac::CodecParams::PictureWeightsBits |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::Ref1Weight |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::Ref2Weight |
( |
|
) |
const [inline] |
|
void dirac::CodecParams::SetChromaDepth |
( |
unsigned int |
chroma_depth |
) |
[inline] |
|
void dirac::CodecParams::SetChromaXl |
( |
const int |
x |
) |
[inline] |
|
void dirac::CodecParams::SetChromaYl |
( |
const int |
y |
) |
[inline] |
|
void dirac::CodecParams::SetCodeBlockMode |
( |
unsigned int |
cb_mode |
) |
|
|
void dirac::CodecParams::SetCodeBlocks |
( |
unsigned int |
level, |
|
|
unsigned int |
hblocks, |
|
|
unsigned int |
vblocks |
|
) |
|
|
void dirac::CodecParams::SetLumaBlockParams |
( |
const OLBParams & |
olbparams |
) |
[inline] |
|
void dirac::CodecParams::SetLumaDepth |
( |
unsigned int |
luma_depth |
) |
[inline] |
|
void dirac::CodecParams::SetMVPrecision |
( |
const MVPrecisionType |
p |
) |
const [inline] |
|
void dirac::CodecParams::SetMVPrecision |
( |
const MVPrecisionType |
p |
) |
[inline] |
|
void dirac::CodecParams::SetPictureCodingMode |
( |
int |
pic_coding |
) |
[inline] |
|
void dirac::CodecParams::SetPictureWeightsPrecision |
( |
unsigned int |
wt_prec |
) |
[inline] |
|
void dirac::CodecParams::SetRef1Weight |
( |
int |
wt |
) |
[inline] |
|
void dirac::CodecParams::SetRef2Weight |
( |
int |
wt |
) |
[inline] |
|
void dirac::CodecParams::SetSpatialPartition |
( |
bool |
spatial_partition |
) |
[inline] |
|
void dirac::CodecParams::SetTopFieldFirst |
( |
bool |
topf |
) |
[inline] |
|
void dirac::CodecParams::SetTransformDepth |
( |
unsigned int |
wd |
) |
|
|
void dirac::CodecParams::SetTransformFilter |
( |
unsigned int |
wf_idx |
) |
|
|
void dirac::CodecParams::SetTransformFilter |
( |
const WltFilter |
wf |
) |
[inline] |
|
void dirac::CodecParams::SetUsingGlobalMotion |
( |
bool |
gm |
) |
[inline] |
|
void dirac::CodecParams::SetVideoFormat |
( |
const VideoFormat |
vd |
) |
[inline] |
|
void dirac::CodecParams::SetXl |
( |
const int |
x |
) |
[inline] |
|
void dirac::CodecParams::SetXNumBlocks |
( |
const int |
xn |
) |
[inline] |
|
void dirac::CodecParams::SetXNumMB |
( |
const int |
xn |
) |
[inline] |
|
void dirac::CodecParams::SetYl |
( |
const int |
y |
) |
[inline] |
|
void dirac::CodecParams::SetYNumBlocks |
( |
const int |
yn |
) |
[inline] |
|
void dirac::CodecParams::SetYNumMB |
( |
const int |
yn |
) |
[inline] |
|
void dirac::CodecParams::SetZeroTransform |
( |
bool |
zero_transform |
) |
[inline] |
|
bool dirac::CodecParams::SpatialPartition |
( |
|
) |
const [inline] |
|
bool dirac::CodecParams::TopFieldFirst |
( |
|
) |
const [inline] |
|
unsigned int dirac::CodecParams::TransformDepth |
( |
|
) |
const [inline] |
|
WltFilter dirac::CodecParams::TransformFilter |
( |
unsigned int |
wf_idx |
) |
[protected] |
|
WltFilter dirac::CodecParams::TransformFilter |
( |
|
) |
const [inline] |
|
bool dirac::CodecParams::UsingGlobalMotion |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::Xl |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::XNumBlocks |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::XNumMB |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::Yl |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::YNumBlocks |
( |
|
) |
const [inline] |
|
int dirac::CodecParams::YNumMB |
( |
|
) |
const [inline] |
|
bool dirac::CodecParams::ZeroTransform |
( |
|
) |
const [inline] |
|
Member Data Documentation
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.