Dirac - A Video Codec

Created by the British Broadcasting Corporation.


Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
dirac::EndOfSequenceByteIO Class Reference

Signals the end of a sequence in a Dirac-formatted bitstream. More...

#include <endofsequence_byteio.h>

Inheritance diagram for dirac::EndOfSequenceByteIO:
Inheritance graph
[legend]
Collaboration diagram for dirac::EndOfSequenceByteIO:
Collaboration graph
[legend]

Public Member Functions

 EndOfSequenceByteIO (const ByteIO &stream_data)
 Constructor. More...
 
 ~EndOfSequenceByteIO ()
 Destructor. More...
 
ParseUnitType GetType () const
 Gets parse-unit type. More...
 
void CollateByteStats (DiracByteStats &dirac_byte_stats)
 Gathers byte stats on the end of sequence data. More...
 
- Public Member Functions inherited from dirac::ParseUnitByteIO
 ParseUnitByteIO ()
 Constructor. More...
 
 ParseUnitByteIO (const ByteIO &byte_io)
 Constructor. More...
 
 ParseUnitByteIO (const ParseUnitByteIO &parseunit_byteio)
 Constructor. More...
 
 ~ParseUnitByteIO ()
 Destructor. More...
 
virtual void CollateByteStats (DiracByteStats &dirac_byte_stats)
 Gathers byte stats on the parse-unit data. More...
 
bool Input ()
 Reads from byte-stream to find parse data. More...
 
bool IsValid ()
 Accesses validity of a unit by comparing it with an adjacent unit. More...
 
bool CanSkip ()
 Can Skip past the entire parse-unit. More...
 
virtual const std::string GetBytes ()
 Gets string containing coded bytes. More...
 
void SetAdjacentParseUnits (ParseUnitByteIO *p_prev_parseunit)
 Set next/previous parse-unit values. More...
 
virtual int GetSize () const
 Gets size (in bytes) More...
 
int GetNextParseOffset () const
 Gets expected number of bytes to start of next parse-unit. More...
 
int GetPreviousParseOffset () const
 Gets number of bytes to start of previous parse-unit. More...
 
virtual ParseUnitType GetType () const
 Gets parse-unit type. More...
 
bool IsSeqHeader () const
 Returns true is parse unit is a Sequence Header. More...
 
bool IsEndOfSequence () const
 Returns true is parse unit is an End of Sequence unit. More...
 
bool IsAuxiliaryData () const
 Returns true is parse unit is Auxiliary Data. More...
 
bool IsPaddingData () const
 Returns true is parse unit is Padding data. More...
 
bool IsPicture () const
 Returns true is parse unit is Picture data. More...
 
bool IsLowDelay () const
 Returns true is parse unit is Low Delay Sybtax unit. More...
 
bool IsCoreSyntax () const
 Returns true is parse unit is Core syntax unit. More...
 
bool IsUsingAC () const
 Returns true is parse unit uses Arithmetic coding. More...
 
- Public Member Functions inherited from dirac::ByteIO
 ByteIO (bool new_stream=true)
 Default constructor. More...
 
 ByteIO (const ByteIO &stream_data)
 Constructor. More...
 
virtual ~ByteIO ()
 Destructor. More...
 
virtual void CollateByteStats (DiracByteStats &dirac_byte_stats)
 Gathers byte-stream statistics. More...
 
virtual const std::string GetBytes ()
 Get bytes in Dirac-bytestream format. More...
 
int GetReadBytePosition () const
 Get position of read stream pointer. More...
 
virtual int GetSize () const
 Gets size (in bytes) More...
 
void SetByteParams (const ByteIO &byte_io)
 Copies stream source/destination info. More...
 
void ByteAlignOutput ()
 Sync input for byte-alignment. More...
 
void WriteUint (unsigned int value)
 Ouputs an unsigned integer in interleaved exp Golomb format. More...
 
void SetBitsLeft (int left_bits)
 Sets input size in bits. More...
 
int BitsLeft (void)
 Sets input size in bits. More...
 

Protected Member Functions

int CalcNextUnitOffset ()
 Calculates number of bytes to start of next unit. More...
 
- Protected Member Functions inherited from dirac::ParseUnitByteIO
virtual int CalcNextUnitOffset ()
 Calculates number of bytes to start of next unit. More...
 
virtual unsigned char CalcParseCode () const
 Pure virtual method for calculating parse-code. More...
 
bool SyncToUnitStart ()
 Locates start of parse-unit. More...
 
unsigned char GetParseCode () const
 Get parse code. More...
 
- 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. More...
 
bool ReadBool ()
 Reads boolean value. More...
 
bool ReadBoolB ()
 Reads boolean value - bounded i/o. More...
 
int ReadBit ()
 Reads next bit. More...
 
int ReadBitB ()
 Reads next bit - bounded i/o. More...
 
unsigned int ReadNBits (int count)
 Reads next 'count' bits. More...
 
void InputBytes (char *data, int count)
 Reads from stream. More...
 
void FlushInputB ()
 Flushes the bounde input. More...
 
int ReadSint ()
 Reads a signed integer in interleaved exp-Golomb format return Signed integer read. More...
 
int ReadSintB ()
 Reads a signed integer in interleaved exp-Golomb format from bounded input return Signed integer read. More...
 
unsigned int ReadUint ()
 Reads an unsigned integer in interleaved exp Golomb format. More...
 
unsigned int ReadUintB ()
 Reads an unsigned integer in interleaved exp Golomb format from bounded input. More...
 
unsigned int ReadUintLit (const int byte_size)
 Reads a fixed length unsigned integer from the stream in big endian. More...
 
unsigned char InputUnByte ()
 Reads a byte from the stream. More...
 
std::string InputUnString (const int count)
 Reads a series of bytes from a stream. More...
 
void WriteBit (const bool &bit)
 Outputs a bit. More...
 
int WriteNBits (unsigned int val)
 Outputs an unsigned integer. More...
 
void WriteNBits (unsigned int val, int count)
 Outputs an n bit integer. More...
 
void OutputBytes (const std::string &bytes)
 Outputs a series of bytes. More...
 
void OutputCurrentByte ()
 Outputs current byte contents. More...
 
void WriteSint (int val)
 Outputs an integer in Golomb signed integer format. More...
 
void WriteUintLit (const unsigned int &value, const int &length)
 Output unsigned int value in big endian format. More...
 
void RemoveRedundantBytes (const int count)
 Removes portion of byte-stream no longer required. More...
 
void SeekGet (const int offset, std::ios_base::seekdir dir)
 

Private Member Functions

unsigned char CalcParseCode () const
 Calculates parse-code based on picture parameters. More...
 

Additional Inherited Members

- Protected Attributes inherited from dirac::ByteIO
std::stringstream * mp_stream
 Input/output steam. More...
 

Detailed Description

Current Accessunit parameters are no longer valid for subsequent frames

Constructor & Destructor Documentation

◆ EndOfSequenceByteIO()

dirac::EndOfSequenceByteIO::EndOfSequenceByteIO ( const ByteIO stream_data)
Parameters
stream_dataStream parameters

◆ ~EndOfSequenceByteIO()

dirac::EndOfSequenceByteIO::~EndOfSequenceByteIO ( )

Member Function Documentation

◆ CalcNextUnitOffset()

int dirac::EndOfSequenceByteIO::CalcNextUnitOffset ( )
inlineprotectedvirtual
Returns
Zero(0) End of sequence does not specify a 'next'unit

Reimplemented from dirac::ParseUnitByteIO.

◆ CalcParseCode()

unsigned char dirac::EndOfSequenceByteIO::CalcParseCode ( ) const
privatevirtual
Returns
Char bit-set

Reimplemented from dirac::ParseUnitByteIO.

◆ CollateByteStats()

void dirac::EndOfSequenceByteIO::CollateByteStats ( DiracByteStats dirac_byte_stats)
virtual
Parameters
dirac_byte_statsStat container

Reimplemented from dirac::ParseUnitByteIO.

◆ GetType()

ParseUnitType dirac::EndOfSequenceByteIO::GetType ( ) const
inlinevirtual

Reimplemented from dirac::ParseUnitByteIO.

References dirac::PU_END_OF_SEQUENCE.


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.