Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::CodeBlock Class Reference

Class for encapsulating metadata concerning a block of coefficients in a subband.

#include <wavelet_utils.h>

Public Member Functions

 CodeBlock ()
 Constructor.
 CodeBlock (const int xstart, const int ystart, const int xend, const int yend)
 Constructor.
int Xstart () const
 Returns the horizontal start of the block.
int Ystart () const
 Returns the vertical start of the block.
int Xend () const
 Returns one past the last coefficient coord, horizontally.
int Yend () const
 Returns one past the last coefficient coord, vertically.
int Xl () const
 Returns the width of the code block.
int Yl () const
 Returns the height of the code block.
int QuantIndex () const
 Returns the quantisation index associated to the code block.
bool Skipped () const
 Returns true if the code-block is skipped, false if not.
void SetQuantIndex (const int quantindex)
 Sets the quantisation index.
void SetSkip (bool skip)
 Sets whether the code block is skipped or not.

Private Member Functions

void Init (const int xstart, const int ystart, const int xend, const int yend)
 Initialise the code block.

Private Attributes

int m_xstart
int m_ystart
int m_xend
int m_yend
int m_xl
int m_yl
int m_quantindex
bool m_skipped

Friends

class Subband

Constructor & Destructor Documentation

◆ CodeBlock() [1/2]

dirac::CodeBlock::CodeBlock ( )

◆ CodeBlock() [2/2]

dirac::CodeBlock::CodeBlock ( const int xstart,
const int ystart,
const int xend,
const int yend )

Member Function Documentation

◆ Init()

void dirac::CodeBlock::Init ( const int xstart,
const int ystart,
const int xend,
const int yend )
private

◆ QuantIndex()

int dirac::CodeBlock::QuantIndex ( ) const
inline

◆ SetQuantIndex()

void dirac::CodeBlock::SetQuantIndex ( const int quantindex)
inline

References m_quantindex.

◆ SetSkip()

void dirac::CodeBlock::SetSkip ( bool skip)
inline

◆ Skipped()

bool dirac::CodeBlock::Skipped ( ) const
inline

References m_skipped.

◆ Xend()

◆ Xl()

int dirac::CodeBlock::Xl ( ) const
inline

References m_xl.

◆ Xstart()

◆ Yend()

◆ Yl()

int dirac::CodeBlock::Yl ( ) const
inline

References m_yl.

◆ Ystart()

◆ Subband

friend class Subband
friend

References Subband.

Referenced by Subband.

Member Data Documentation

◆ m_quantindex

int dirac::CodeBlock::m_quantindex
private

Referenced by QuantIndex(), and SetQuantIndex().

◆ m_skipped

bool dirac::CodeBlock::m_skipped
private

Referenced by SetSkip(), and Skipped().

◆ m_xend

int dirac::CodeBlock::m_xend
private

Referenced by Xend().

◆ m_xl

int dirac::CodeBlock::m_xl
private

Referenced by Xl().

◆ m_xstart

int dirac::CodeBlock::m_xstart
private

Referenced by Xstart().

◆ m_yend

int dirac::CodeBlock::m_yend
private

Referenced by Yend().

◆ m_yl

int dirac::CodeBlock::m_yl
private

Referenced by Yl().

◆ m_ystart

int dirac::CodeBlock::m_ystart
private

Referenced by Ystart().


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.