Dirac - A Video Codec

Created by the British Broadcasting Corporation.

---

dirac::BitInputManager Class Reference

A class for managing bit-wise and byte-wise input.

#include <bit_manager.h>

List of all members.

Public Member Functions

• BitInputManager (std::istream *in_data)

  Constructor.
  

• ~BitInputManager ()

  Destructor.
  

• bool InputBit ()

  Obtain the next bit.
  

• bool InputBit (int &count)

  Obtain the next bit, incrementing count.
  

• bool InputBit (int &count, const int max_count)

  Obtain the next bit, incrementing count, if count<max_count; else return 0 (false).
  

• char InputByte ()

  Obtain the next byte.
  

• void InputBytes (char *cptr, int num)

  Obtain a number of bytes.
  

• void FlushInput ()

  Move onto the next byte. Needed if a data unit is not an exact number of bytes.
  

• bool End () const

  Returns true if we're at the end of the input, false otherwise.
  

Private Member Functions

• void InitInputStream ()

Private Attributes

• std::istream * m_ip_ptr
• char m_current_byte
• int m_input_bits_left
• unsigned int m_shift

---

Constructor & Destructor Documentation

dirac::BitInputManager::BitInputManager

(

std::istream *

in_data

)

Constructor. Wraps around an istream object.

dirac::BitInputManager::~BitInputManager

(

)

[inline]

---

Member Function Documentation

bool dirac::BitInputManager::InputBit

(

)

bool dirac::BitInputManager::InputBit

(

int &

count

)

bool dirac::BitInputManager::InputBit	(	int &	count,
		const int	max_count
	)

char dirac::BitInputManager::InputByte

(

)

void dirac::BitInputManager::InputBytes	(	char *	cptr,
		int	num
	)

void dirac::BitInputManager::FlushInput

(

)

bool dirac::BitInputManager::End

(

)

const

void dirac::BitInputManager::InitInputStream

(

)

[private]

---

Member Data Documentation

std::istream* dirac::BitInputManager::m_ip_ptr [private]

char dirac::BitInputManager::m_current_byte [private]

int dirac::BitInputManager::m_input_bits_left [private]

unsigned int dirac::BitInputManager::m_shift [private]

---

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

• bit_manager.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.