org.gagravarr.ogg

Class BitsReader

java.lang.Object

org.gagravarr.ogg.BitsReader

public class BitsReader
extends Object

Utilities for reading (and hopefully later writing) a stream of arbitrary bits, in big endian encoding, eg "give me the next 3 bits" or "give me bits to the byte boundary"

Constructor Summary

Constructors

Constructor and Description
BitsReader(InputStream input)

Method Summary

Modifier and Type	Method and Description
int	bitsToNextOne() Counts the number of bits until the next one (true) bit is set
int	bitsToNextZero() Counts the number of bits until the next zero (false) bit is set
boolean	isEOF() Has the End-Of-File / End-of-Stream been hit?
int	read(int numBits)
int	readToByteBoundary() Reads the number to the next byte boundary, or -1 if already there.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BitsReader

public BitsReader(InputStream input)

Method Detail

read

public int read(int numBits)
         throws IOException

Throws:

IOException

bitsToNextZero

public int bitsToNextZero()
                   throws IOException

Counts the number of bits until the next zero (false) bit is set

eg 1110 is 3, 0 is 0, 10 is 1.

Returns:

the number of bits until the next zero

Throws:

IOException

bitsToNextOne

public int bitsToNextOne()
                  throws IOException

Counts the number of bits until the next one (true) bit is set

eg b1 is 0, b001 is 2, b0000001 is 6

Returns:

the number of bits until the next one

Throws:

IOException

readToByteBoundary

public int readToByteBoundary()
                       throws IOException

Reads the number to the next byte boundary, or -1 if already there.

Throws:

IOException

isEOF

public boolean isEOF()

Has the End-Of-File / End-of-Stream been hit?