Dirac - A Video Codec

Created by the British Broadcasting Corporation.

---

dirac::FrameByteIO Class Reference

A compressed frame in Dirac bytestream format.

#include <frame_byteio.h>

Inheritance diagram for dirac::FrameByteIO:

List of all members.

Public Member Functions

• FrameByteIO (FrameParams &frame_params, int frame_num)

  Constructor.
  

• FrameByteIO (FrameParams &frame_params, const ParseUnitByteIO &parseunit_byteio)

  Constructor.
  

• virtual ~FrameByteIO ()

  Destructor.
  

• void CollateByteStats (DiracByteStats &dirac_byte_stats)

  Gathers byte stats on the frame data.
  

• bool Input ()

  Inputs data from Dirac stream-format.
  

• void Output ()

  Outputs frame values to Dirac stream-format.
  

• const std::string GetBytes ()

  Gets string containing coded bytes.
  

• int GetSize () const

  Gets size (in bytes).
  

• ParseUnitType GetType () const

  Gets parse-unit type.
  

• int IsRef () const

  Returns true is frame in Reference frame.
  

• int IsNonRef () const

  Returns true is frame in Non-Reference frame.
  

• int NumRefs () const

  Gets parse-unit type.
  

• bool IsIntra () const

  Returns true is frame is Intra frame.
  

• bool IsInter () const

  Returns true is frame is Inter frame.
  

• void SetMvData (MvDataByteIO *mv_data)
• void SetTransformData (TransformByteIO *transform_data)

Private Member Functions

• unsigned char CalcParseCode () const

  Calculates parse-code based on frame parameters.
  

• void InputReferencePictures ()

  Reads reference-frame data.
  

• void InputRetiredPicture ()

  Reads retired picture number.
  

• void SetFrameType ()

  Calculates frame-type (eg INTRA/INTER) of frame.
  

• void SetReferenceType ()

  Calculates reference-type of frame.
  

• void SetEntropyCodingFlag ()

  Sets the entropy coding flag in the frame parameters.
  

Private Attributes

• FrameParams & m_frame_params

  Frame parameters.
  

• int m_frame_num

  Frame number.
  

• MvDataByteIO * m_mv_data

  MV data.
  

• TransformByteIO * m_transform_data

  Transform data.
  

---

Constructor & Destructor Documentation

dirac::FrameByteIO::FrameByteIO	(	FrameParams &	frame_params,
		int	frame_num
	)

Parameters:

	frame_params	Frame parameters
	frame_num	Frame number

dirac::FrameByteIO::FrameByteIO	(	FrameParams &	frame_params,
		const ParseUnitByteIO &	parseunit_byteio
	)

Parameters:

	frame_params	Destination of data
	parseunit_byteio	Source of data

virtual dirac::FrameByteIO::~FrameByteIO

(

)

[virtual]

---

Member Function Documentation

void dirac::FrameByteIO::CollateByteStats

(

DiracByteStats &

dirac_byte_stats

)

[virtual]

Parameters:

dirac_byte_stats

Stat container

Reimplemented from dirac::ParseUnitByteIO.

bool dirac::FrameByteIO::Input

(

)

Reimplemented from dirac::ParseUnitByteIO.

void dirac::FrameByteIO::Output

(

)

const std::string dirac::FrameByteIO::GetBytes

(

)

[virtual]

Reimplemented from dirac::ParseUnitByteIO.

int dirac::FrameByteIO::GetSize

(

)

const [virtual]

Reimplemented from dirac::ParseUnitByteIO.

ParseUnitType dirac::FrameByteIO::GetType

(

)

const [inline, virtual]

Reimplemented from dirac::ParseUnitByteIO.

int dirac::FrameByteIO::IsRef

(

)

const [inline]

int dirac::FrameByteIO::IsNonRef

(

)

const [inline]

int dirac::FrameByteIO::NumRefs

(

)

const [inline]

bool dirac::FrameByteIO::IsIntra

(

)

const [inline]

bool dirac::FrameByteIO::IsInter

(

)

const [inline]

void dirac::FrameByteIO::SetMvData

(

MvDataByteIO *

mv_data

)

[inline]

void dirac::FrameByteIO::SetTransformData

(

TransformByteIO *

transform_data

)

[inline]

unsigned char dirac::FrameByteIO::CalcParseCode

(

)

const [private, virtual]

Returns:

Char bit-set

Reimplemented from dirac::ParseUnitByteIO.

void dirac::FrameByteIO::InputReferencePictures

(

)

[private]

void dirac::FrameByteIO::InputRetiredPicture

(

)

[private]

void dirac::FrameByteIO::SetFrameType

(

)

[private]

void dirac::FrameByteIO::SetReferenceType

(

)

[private]

void dirac::FrameByteIO::SetEntropyCodingFlag

(

)

[private]

---

Member Data Documentation

FrameParams& dirac::FrameByteIO::m_frame_params [private]

int dirac::FrameByteIO::m_frame_num [private]

MvDataByteIO* dirac::FrameByteIO::m_mv_data [private]

TransformByteIO* dirac::FrameByteIO::m_transform_data [private]

---

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

• frame_byteio.h

---

© 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.