Dirac - A Video Codec

Created by the British Broadcasting Corporation.


dirac::CodingParamsByteIO Class Reference

Represents compressed sequence-parameter data used in an AccessUnit.

#include <codingparams_byteio.h>

Inheritance diagram for dirac::CodingParamsByteIO:
Collaboration diagram for dirac::CodingParamsByteIO:

Public Member Functions

 CodingParamsByteIO (const SourceParams &src_params, CodecParams &codec_params, const SourceParams &default_source_params, const ByteIO &stream_data)
 Constructor.
 ~CodingParamsByteIO ()
 Destructor.
void Input ()
 Reads sequence information from Dirac byte-format.
void Output ()
 Outputs sequence information to Dirac byte-format.
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.
virtual const std::string GetBytes ()
 Get bytes in Dirac-bytestream format.
int GetReadBytePosition () const
 Get position of read stream pointer.
virtual int GetSize () const
 Gets size (in bytes)
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.

Private Member Functions

void InputVideoDepth ()
 Reads number of bits used to compress input signal.
void InputPictureCodingMode ()
 Reads picture coding mode - 0 - frames, 1 - fields.
void OutputVideoDepth ()
 Outputs number of bits used to compress input signal.
void OutputPictureCodingMode ()
 Outputs how input was coded - i.e.

Private Attributes

const SourceParamsm_src_params
 Source paramters for intput/output.
CodecParamsm_codec_params
 Coding paramters for intput/output.
const SourceParamsm_default_source_params
 Default source parameters.

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)
Protected Attributes inherited from dirac::ByteIO
std::stringstream * mp_stream
 Input/output steam.

Constructor & Destructor Documentation

◆ CodingParamsByteIO()

dirac::CodingParamsByteIO::CodingParamsByteIO ( const SourceParams & src_params,
CodecParams & codec_params,
const SourceParams & default_source_params,
const ByteIO & stream_data )
Parameters
src_paramsSource parameters
codec_paramsCoding parameters
default_source_paramsDefault source parameters
stream_dataSource/Destination of data

References dirac::ByteIO::ByteIO().

◆ ~CodingParamsByteIO()

dirac::CodingParamsByteIO::~CodingParamsByteIO ( )

Member Function Documentation

◆ Input()

void dirac::CodingParamsByteIO::Input ( )

◆ InputPictureCodingMode()

void dirac::CodingParamsByteIO::InputPictureCodingMode ( )
private

◆ InputVideoDepth()

void dirac::CodingParamsByteIO::InputVideoDepth ( )
private

◆ Output()

void dirac::CodingParamsByteIO::Output ( )

◆ OutputPictureCodingMode()

void dirac::CodingParamsByteIO::OutputPictureCodingMode ( )
private

frames or fields

◆ OutputVideoDepth()

void dirac::CodingParamsByteIO::OutputVideoDepth ( )
private

Member Data Documentation

◆ m_codec_params

CodecParams& dirac::CodingParamsByteIO::m_codec_params
private

◆ m_default_source_params

const SourceParams& dirac::CodingParamsByteIO::m_default_source_params
private

◆ m_src_params

const SourceParams& dirac::CodingParamsByteIO::m_src_params
private

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.