Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::MvDataElementByteIO Class Reference

Represents compressed sequence-parameter data used in an AccessUnit.

#include <mvdataelement_byteio.h>

Inheritance diagram for dirac::MvDataElementByteIO:
Collaboration diagram for dirac::MvDataElementByteIO:

Public Member Functions

 MvDataElementByteIO ()
 Constructor.
 MvDataElementByteIO (ByteIO &byte_io)
 Constructor.
virtual ~MvDataElementByteIO ()
 Destructor.
void Output ()
 Outputs motion vector data Dirac byte-format.
void Input ()
 Inputs motion vector information.
virtual const std::string GetBytes ()
 Get string containing coded bytes.
ByteIODataBlock ()
 Return pointer to the block data ByteIO stream.
unsigned int DataBlockSize ()
 Return the input block data size.
int GetSize () const
 Return the size.
Public Member Functions inherited from dirac::ByteIO
 ByteIO (bool new_stream=true)
 Default constructor.
 ByteIO (const ByteIO &stream_data)
 Constructor.
virtual ~ByteIO ()
 Destructor.
virtual void CollateByteStats (DiracByteStats &dirac_byte_stats)
 Gathers byte-stream statistics.
int GetReadBytePosition () const
 Get position of read stream pointer.
void SetByteParams (const ByteIO &byte_io)
 Copies stream source/destination info.
void ByteAlignOutput ()
 Sync input for byte-alignment.
void WriteUint (unsigned int value)
 Ouputs an unsigned integer in interleaved exp Golomb format.
void SetBitsLeft (int left_bits)
 Sets input size in bits.
int BitsLeft (void)
 Sets input size in bits.

Protected Attributes

ByteIO m_block_data
 block data
unsigned int m_block_size
 In block data size.
Protected Attributes inherited from dirac::ByteIO
std::stringstream * mp_stream
 Input/output steam.

Additional Inherited Members

Protected Member Functions inherited from dirac::ByteIO
bool CanRead () const
bool GetBit (unsigned char &c, int pos) const
void SetBit (unsigned char &c, int pos) const
void SetBits (unsigned char &c, unsigned char bits) const
void ByteAlignInput ()
 Sync input for byte-alignment.
bool ReadBool ()
 Reads boolean value.
bool ReadBoolB ()
 Reads boolean value - bounded i/o.
int ReadBit ()
 Reads next bit.
int ReadBitB ()
 Reads next bit - bounded i/o.
unsigned int ReadNBits (int count)
 Reads next 'count' bits.
void InputBytes (char *data, int count)
 Reads from stream.
void FlushInputB ()
 Flushes the bounde input.
int ReadSint ()
 Reads a signed integer in interleaved exp-Golomb format return Signed integer read.
int ReadSintB ()
 Reads a signed integer in interleaved exp-Golomb format from bounded input return Signed integer read.
unsigned int ReadUint ()
 Reads an unsigned integer in interleaved exp Golomb format.
unsigned int ReadUintB ()
 Reads an unsigned integer in interleaved exp Golomb format from bounded input.
unsigned int ReadUintLit (const int byte_size)
 Reads a fixed length unsigned integer from the stream in big endian.
unsigned char InputUnByte ()
 Reads a byte from the stream.
std::string InputUnString (const int count)
 Reads a series of bytes from a stream.
void WriteBit (const bool &bit)
 Outputs a bit.
int WriteNBits (unsigned int val)
 Outputs an unsigned integer.
void WriteNBits (unsigned int val, int count)
 Outputs an n bit integer.
void OutputBytes (const std::string &bytes)
 Outputs a series of bytes.
void OutputCurrentByte ()
 Outputs current byte contents.
void WriteSint (int val)
 Outputs an integer in Golomb signed integer format.
void WriteUintLit (const unsigned int &value, const int &length)
 Output unsigned int value in big endian format.
void RemoveRedundantBytes (const int count)
 Removes portion of byte-stream no longer required.
void SeekGet (const int offset, std::ios_base::seekdir dir)

Constructor & Destructor Documentation

◆ MvDataElementByteIO() [1/2]

dirac::MvDataElementByteIO::MvDataElementByteIO ( )

◆ MvDataElementByteIO() [2/2]

dirac::MvDataElementByteIO::MvDataElementByteIO ( ByteIO & byte_io)
Parameters
byte_ioInput/Output Byte stream

References dirac::ByteIO::ByteIO().

◆ ~MvDataElementByteIO()

virtual dirac::MvDataElementByteIO::~MvDataElementByteIO ( )
virtual

Member Function Documentation

◆ DataBlock()

ByteIO * dirac::MvDataElementByteIO::DataBlock ( )
inline

◆ DataBlockSize()

unsigned int dirac::MvDataElementByteIO::DataBlockSize ( )
inline

References m_block_size.

◆ GetBytes()

virtual const std::string dirac::MvDataElementByteIO::GetBytes ( )
virtual

Reimplemented from dirac::ByteIO.

◆ GetSize()

int dirac::MvDataElementByteIO::GetSize ( ) const
virtual

Reimplemented from dirac::ByteIO.

◆ Input()

void dirac::MvDataElementByteIO::Input ( )

◆ Output()

void dirac::MvDataElementByteIO::Output ( )

Member Data Documentation

◆ m_block_data

ByteIO dirac::MvDataElementByteIO::m_block_data
protected

Referenced by DataBlock().

◆ m_block_size

unsigned int dirac::MvDataElementByteIO::m_block_size
protected

Referenced by DataBlockSize().


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.