TComOutputBitstream Class Reference

#include <TComBitStream.h>

Inheritance diagram for TComOutputBitstream:

Collaboration diagram for TComOutputBitstream:

Public Member Functions
Void	resetBits ()
Int	getNumBitsUntilByteAligned () const
UInt	getNumberOfWrittenBits () const
std::vector< uint8_t > &	getFIFO ()
UChar	getHeldBits ()
const std::vector< uint8_t > &	getFIFO () const
	TComOutputBitstream ()
	this value is always msb-aligned, bigendian. More...
	~TComOutputBitstream ()
Void	write (UInt uiBits, UInt uiNumberOfBits)
Void	writeAlignOne ()
Void	writeAlignZero ()
UChar *	getByteStream () const
UInt	getByteStreamLength ()
Void	clear ()
Void	insertAt (const TComOutputBitstream &src, UInt pos)
Void	addSubstream (TComOutputBitstream *pcSubstream)
Void	writeByteAlignment ()
Int	countStartCodeEmulations ()
	returns the number of start code emulations contained in the current buffer More...
Public Member Functions inherited from TComBitIf
virtual	~TComBitIf ()

Private Attributes
std::vector< uint8_t >	m_fifo
UInt	m_num_held_bits
UChar	m_held_bits
	number of bits not flushed to bytestream. More...

Detailed Description

Model of a writable bitstream that accumulates bits to produce a bytestream.

Definition at line 74 of file TComBitStream.h.

Member Function Documentation

std::vector<uint8_t>& TComOutputBitstream::getFIFO ( )

inline

Return a reference to the internal fifo

Definition at line 145 of file TComBitStream.h.

const std::vector<uint8_t>& TComOutputBitstream::getFIFO ( ) const

inline

Return a reference to the internal fifo

Definition at line 151 of file TComBitStream.h.

UChar TComOutputBitstream::getHeldBits ( )

inline

Definition at line 147 of file TComBitStream.h.

UInt TComOutputBitstream::getNumberOfWrittenBits ( ) const

inlinevirtual

Return the number of bits that have been written since the last clear()

Implements TComBitIf.

Definition at line 138 of file TComBitStream.h.

Int TComOutputBitstream::getNumBitsUntilByteAligned ( ) const

inlinevirtual

returns the number of bits that need to be written to achieve byte alignment.

Implements TComBitIf.

Definition at line 133 of file TComBitStream.h.

Void TComOutputBitstream::resetBits ( )

inlinevirtual

this function should never be called

Implements TComBitIf.

Definition at line 107 of file TComBitStream.h.

Member Data Documentation

std::vector<uint8_t> TComOutputBitstream::m_fifo

private

FIFO for storage of bytes. Use:

• fifo.push_back(x) to append words
• fifo.clear() to empty the FIFO
• &fifo.front() to get a pointer to the data array. NB, this pointer is only valid until the next push_back()/clear()

Definition at line 83 of file TComBitStream.h.

UChar TComOutputBitstream::m_held_bits

private

number of bits not flushed to bytestream.

Definition at line 86 of file TComBitStream.h.

UInt TComOutputBitstream::m_num_held_bits

private

Definition at line 85 of file TComBitStream.h.

---

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

• Lib/TLibCommon/TComBitStream.h
• Lib/TLibCommon/TComBitStream.cpp