OggFileParser Class Reference

#include <OggFileParser.hh>

Inheritance diagram for OggFileParser:

Collaboration diagram for OggFileParser:

Public Member Functions
	OggFileParser (OggFile &ourFile, FramedSource *inputSource, FramedSource::onCloseFunc *onEndFunc, void *onEndClientData, OggDemux *ourDemux=NULL)
virtual	~OggFileParser ()
void	continueParsing ()
virtual void	flushInput ()

Static Public Member Functions
static void	continueParsing (void *clientData, unsigned char *ptr, unsigned size, struct timeval presentationTime)

Protected Types
typedef void()	clientContinueFunc(void *clientData, unsigned char *ptr, unsigned size, struct timeval presentationTime)

Protected Member Functions
void	saveParserState ()
virtual void	restoreSavedParserState ()
u_int32_t	get4Bytes ()
u_int32_t	test4Bytes ()
u_int16_t	get2Bytes ()
u_int16_t	test2Bytes ()
u_int8_t	get1Byte ()
u_int8_t	test1Byte ()
void	getBytes (u_int8_t *to, unsigned numBytes)
void	testBytes (u_int8_t *to, unsigned numBytes)
void	skipBytes (unsigned numBytes)
void	skipBits (unsigned numBits)
unsigned	getBits (unsigned numBits)
unsigned	curOffset () const
unsigned &	totNumValidBytes ()
Boolean	haveSeenEOF () const
unsigned	bankSize () const

Private Member Functions
Boolean	needHeaders ()
Boolean	parse ()
Boolean	parseStartOfFile ()
u_int8_t	parseInitialPage ()
void	parseAndDeliverPages ()
Boolean	parseAndDeliverPage ()
Boolean	deliverPacketWithinPage ()
void	parseStartOfPage (u_int8_t &header_type_flag, u_int32_t &bitstream_serial_number)
Boolean	validateHeader (OggTrack *track, u_int8_t const *p, unsigned headerSize)
unsigned char *	curBank ()
unsigned char *	nextToParse ()
unsigned char *	lastParsed ()
void	ensureValidBytes (unsigned numBytesNeeded)
void	ensureValidBytes1 (unsigned numBytesNeeded)
void	afterGettingBytes1 (unsigned numBytesRead, struct timeval presentationTime)
void	onInputClosure1 ()

Static Private Member Functions
static void	afterGettingBytes (void *clientData, unsigned numBytesRead, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
static void	onInputClosure (void *clientData)

Private Attributes
OggFile &	fOurFile
FramedSource *	fInputSource
FramedSource::onCloseFunc *	fOnEndFunc
void *	fOnEndClientData
OggDemux *	fOurDemux
OggParseState	fCurrentParseState
unsigned	fNumUnfulfilledTracks
PacketSizeTable *	fPacketSizeTable
u_int32_t	fCurrentTrackNumber
u_int8_t *	fSavedPacket
FramedSource::onCloseFunc *	fClientOnInputCloseFunc
void *	fClientOnInputCloseClientData
clientContinueFunc *	fClientContinueFunc
void *	fClientContinueClientData
unsigned char *	fBank [2]
unsigned char	fCurBankNum
unsigned char *	fCurBank
unsigned	fSavedParserIndex
unsigned char	fSavedRemainingUnparsedBits
unsigned	fCurParserIndex
unsigned char	fRemainingUnparsedBits
unsigned	fTotNumValidBytes
Boolean	fHaveSeenEOF
struct timeval	fLastSeenPresentationTime

Detailed Description

Definition at line 50 of file OggFileParser.hh.

Member Typedef Documentation

clientContinueFunc

typedef void() StreamParser::clientContinueFunc(void *clientData, unsigned char *ptr, unsigned size, struct timeval presentationTime)

protectedinherited

Definition at line 33 of file StreamParser.hh.

Constructor & Destructor Documentation

OggFileParser()

OggFileParser::OggFileParser	(	OggFile &	ourFile,
		FramedSource *	inputSource,
		FramedSource::onCloseFunc *	onEndFunc,
		void *	onEndClientData,
		OggDemux *	ourDemux = NULL
	)

~OggFileParser()

virtual OggFileParser::~OggFileParser ( )

virtual

Member Function Documentation

afterGettingBytes()

static void StreamParser::afterGettingBytes ( void *  clientData, unsigned  numBytesRead, unsigned  numTruncatedBytes, struct timeval  presentationTime, unsigned  durationInMicroseconds  )

staticprivateinherited

afterGettingBytes1()

void StreamParser::afterGettingBytes1 ( unsigned  numBytesRead, struct timeval  presentationTime  )

privateinherited

bankSize()

unsigned StreamParser::bankSize ( ) const

protectedinherited

continueParsing() [1/2]

void OggFileParser::continueParsing

(

)

continueParsing() [2/2]

static void OggFileParser::continueParsing ( void *  clientData, unsigned char *  ptr, unsigned  size, struct timeval  presentationTime  )

static

curBank()

unsigned char * StreamParser::curBank ( )

inlineprivateinherited

Definition at line 116 of file StreamParser.hh.

{ return fCurBank; }

References StreamParser::fCurBank.

Referenced by StreamParser::get1Byte(), StreamParser::lastParsed(), and StreamParser::nextToParse().

curOffset()

unsigned StreamParser::curOffset ( ) const

inlineprotectedinherited

Definition at line 107 of file StreamParser.hh.

{ return fCurParserIndex; }

References StreamParser::fCurParserIndex.

deliverPacketWithinPage()

Boolean OggFileParser::deliverPacketWithinPage ( )

private

ensureValidBytes()

void StreamParser::ensureValidBytes ( unsigned  numBytesNeeded )

inlineprivateinherited

Definition at line 121 of file StreamParser.hh.

                                                 {
    // common case: inlined:
    if (fCurParserIndex + numBytesNeeded <= fTotNumValidBytes) return;
 
    ensureValidBytes1(numBytesNeeded);
  }

References StreamParser::ensureValidBytes1(), StreamParser::fCurParserIndex, and StreamParser::fTotNumValidBytes.

Referenced by StreamParser::get1Byte(), StreamParser::get2Bytes(), StreamParser::skipBytes(), StreamParser::test1Byte(), StreamParser::test2Bytes(), StreamParser::test4Bytes(), and StreamParser::testBytes().

ensureValidBytes1()

void StreamParser::ensureValidBytes1 ( unsigned  numBytesNeeded )

privateinherited

Referenced by StreamParser::ensureValidBytes().

flushInput()

virtual void StreamParser::flushInput ( )

virtualinherited

get1Byte()

u_int8_t StreamParser::get1Byte ( )

inlineprotectedinherited

Definition at line 79 of file StreamParser.hh.

                      { // byte-aligned
    ensureValidBytes(1);
    fRemainingUnparsedBits = 0;
    return curBank()[fCurParserIndex++];
  }

References StreamParser::curBank(), StreamParser::ensureValidBytes(), StreamParser::fCurParserIndex, and StreamParser::fRemainingUnparsedBits.

Referenced by MPEGVideoStreamParser::saveToNextCode(), and MPEGVideoStreamParser::skipToNextCode().

get2Bytes()

u_int16_t StreamParser::get2Bytes ( )

inlineprotectedinherited

Definition at line 60 of file StreamParser.hh.

                        {
    ensureValidBytes(2);
 
    unsigned char const* ptr = nextToParse();
    u_int16_t result = (ptr[0]<<8)|ptr[1];
 
    fCurParserIndex += 2;
    fRemainingUnparsedBits = 0;
 
    return result;
  }

References StreamParser::ensureValidBytes(), StreamParser::fCurParserIndex, StreamParser::fRemainingUnparsedBits, and StreamParser::nextToParse().

get4Bytes()

u_int32_t StreamParser::get4Bytes ( )

inlineprotectedinherited

Definition at line 46 of file StreamParser.hh.

                        { // byte-aligned; returned in big-endian order
    u_int32_t result = test4Bytes();
    fCurParserIndex += 4;
    fRemainingUnparsedBits = 0;
 
    return result;
  }

References StreamParser::fCurParserIndex, StreamParser::fRemainingUnparsedBits, and StreamParser::test4Bytes().

Referenced by MPEGVideoStreamParser::saveToNextCode(), and MPEGVideoStreamParser::skipToNextCode().

getBits()

unsigned StreamParser::getBits ( unsigned  numBits )

protectedinherited

getBytes()

void StreamParser::getBytes ( u_int8_t *  to, unsigned  numBytes  )

inlineprotectedinherited

Definition at line 89 of file StreamParser.hh.

                                                 {
    testBytes(to, numBytes);
    fCurParserIndex += numBytes;
    fRemainingUnparsedBits = 0;
  }

References StreamParser::fCurParserIndex, StreamParser::fRemainingUnparsedBits, and StreamParser::testBytes().

haveSeenEOF()

Boolean StreamParser::haveSeenEOF ( ) const

inlineprotectedinherited

Definition at line 111 of file StreamParser.hh.

{ return fHaveSeenEOF; }

References StreamParser::fHaveSeenEOF.

lastParsed()

unsigned char * StreamParser::lastParsed ( )

inlineprivateinherited

Definition at line 118 of file StreamParser.hh.

{ return &curBank()[fCurParserIndex-1]; }

References StreamParser::curBank(), and StreamParser::fCurParserIndex.

needHeaders()

Boolean OggFileParser::needHeaders ( )

inlineprivate

Definition at line 62 of file OggFileParser.hh.

{ return fNumUnfulfilledTracks > 0; }

References fNumUnfulfilledTracks.

nextToParse()

unsigned char * StreamParser::nextToParse ( )

inlineprivateinherited

Definition at line 117 of file StreamParser.hh.

{ return &curBank()[fCurParserIndex]; }

References StreamParser::curBank(), and StreamParser::fCurParserIndex.

Referenced by StreamParser::get2Bytes(), StreamParser::test1Byte(), StreamParser::test2Bytes(), StreamParser::test4Bytes(), and StreamParser::testBytes().

onInputClosure()

static void StreamParser::onInputClosure ( void *  clientData )

staticprivateinherited

onInputClosure1()

void StreamParser::onInputClosure1 ( )

privateinherited

parse()

Boolean OggFileParser::parse ( )

private

parseAndDeliverPage()

Boolean OggFileParser::parseAndDeliverPage ( )

private

parseAndDeliverPages()

void OggFileParser::parseAndDeliverPages ( )

private

parseInitialPage()

u_int8_t OggFileParser::parseInitialPage ( )

private

parseStartOfFile()

Boolean OggFileParser::parseStartOfFile ( )

private

parseStartOfPage()

void OggFileParser::parseStartOfPage ( u_int8_t &  header_type_flag, u_int32_t &  bitstream_serial_number  )

private

restoreSavedParserState()

virtual void StreamParser::restoreSavedParserState ( )

protectedvirtualinherited

Reimplemented in H263plusVideoStreamParser, MatroskaFileParser, MPEG2TransportStreamParser, and MPEGVideoStreamParser.

saveParserState()

void StreamParser::saveParserState ( )

protectedinherited

Referenced by MPEGVideoStreamParser::setParseState().

skipBits()

void StreamParser::skipBits ( unsigned  numBits )

protectedinherited

skipBytes()

void StreamParser::skipBytes ( unsigned  numBytes )

inlineprotectedinherited

Definition at line 98 of file StreamParser.hh.

                                    {
    ensureValidBytes(numBytes);
    fCurParserIndex += numBytes;
  }

References StreamParser::ensureValidBytes(), and StreamParser::fCurParserIndex.

test1Byte()

u_int8_t StreamParser::test1Byte ( )

inlineprotectedinherited

Definition at line 84 of file StreamParser.hh.

                       { // as above, but doesn't advance ptr
    ensureValidBytes(1);
    return nextToParse()[0];
  }

References StreamParser::ensureValidBytes(), and StreamParser::nextToParse().

test2Bytes()

u_int16_t StreamParser::test2Bytes ( )

inlineprotectedinherited

Definition at line 71 of file StreamParser.hh.

                         {
    ensureValidBytes(2);
 
    unsigned char const* ptr = nextToParse();
    return (ptr[0]<<8)|ptr[1];
  }

References StreamParser::ensureValidBytes(), and StreamParser::nextToParse().

test4Bytes()

u_int32_t StreamParser::test4Bytes ( )

inlineprotectedinherited

Definition at line 53 of file StreamParser.hh.

                         { // as above, but doesn't advance ptr
    ensureValidBytes(4);
 
    unsigned char const* ptr = nextToParse();
    return (ptr[0]<<24)|(ptr[1]<<16)|(ptr[2]<<8)|ptr[3];
  }

References StreamParser::ensureValidBytes(), and StreamParser::nextToParse().

Referenced by StreamParser::get4Bytes().

testBytes()

void StreamParser::testBytes ( u_int8_t *  to, unsigned  numBytes  )

inlineprotectedinherited

Definition at line 94 of file StreamParser.hh.

                                                  { // as above, but doesn't advance ptr
    ensureValidBytes(numBytes);
    memmove(to, nextToParse(), numBytes);
  }

References StreamParser::ensureValidBytes(), and StreamParser::nextToParse().

Referenced by StreamParser::getBytes().

totNumValidBytes()

unsigned & StreamParser::totNumValidBytes ( )

inlineprotectedinherited

Definition at line 109 of file StreamParser.hh.

{ return fTotNumValidBytes; }

References StreamParser::fTotNumValidBytes.

validateHeader()

Boolean OggFileParser::validateHeader ( OggTrack *  track, u_int8_t const *  p, unsigned  headerSize  )

private

Field Documentation

fBank

unsigned char* StreamParser::fBank[2]

privateinherited

Definition at line 146 of file StreamParser.hh.

fClientContinueClientData

void* StreamParser::fClientContinueClientData

privateinherited

Definition at line 143 of file StreamParser.hh.

fClientContinueFunc

clientContinueFunc* StreamParser::fClientContinueFunc

privateinherited

Definition at line 142 of file StreamParser.hh.

fClientOnInputCloseClientData

void* StreamParser::fClientOnInputCloseClientData

privateinherited

Definition at line 141 of file StreamParser.hh.

fClientOnInputCloseFunc

FramedSource::onCloseFunc* StreamParser::fClientOnInputCloseFunc

privateinherited

Definition at line 140 of file StreamParser.hh.

fCurBank

unsigned char* StreamParser::fCurBank

privateinherited

Definition at line 148 of file StreamParser.hh.

Referenced by StreamParser::curBank().

fCurBankNum

unsigned char StreamParser::fCurBankNum

privateinherited

Definition at line 147 of file StreamParser.hh.

fCurParserIndex

unsigned StreamParser::fCurParserIndex

privateinherited

Definition at line 155 of file StreamParser.hh.

Referenced by StreamParser::curOffset(), StreamParser::ensureValidBytes(), StreamParser::get1Byte(), StreamParser::get2Bytes(), StreamParser::get4Bytes(), StreamParser::getBytes(), StreamParser::lastParsed(), StreamParser::nextToParse(), and StreamParser::skipBytes().

fCurrentParseState

OggParseState OggFileParser::fCurrentParseState

private

Definition at line 83 of file OggFileParser.hh.

fCurrentTrackNumber

u_int32_t OggFileParser::fCurrentTrackNumber

private

Definition at line 87 of file OggFileParser.hh.

fHaveSeenEOF

Boolean StreamParser::fHaveSeenEOF

privateinherited

Definition at line 162 of file StreamParser.hh.

Referenced by StreamParser::haveSeenEOF().

fInputSource

FramedSource* OggFileParser::fInputSource

private

Definition at line 79 of file OggFileParser.hh.

fLastSeenPresentationTime

struct timeval StreamParser::fLastSeenPresentationTime

privateinherited

Definition at line 164 of file StreamParser.hh.

fNumUnfulfilledTracks

unsigned OggFileParser::fNumUnfulfilledTracks

private

Definition at line 85 of file OggFileParser.hh.

Referenced by needHeaders().

fOnEndClientData

void* OggFileParser::fOnEndClientData

private

Definition at line 81 of file OggFileParser.hh.

fOnEndFunc

FramedSource::onCloseFunc* OggFileParser::fOnEndFunc

private

Definition at line 80 of file OggFileParser.hh.

fOurDemux

OggDemux* OggFileParser::fOurDemux

private

Definition at line 82 of file OggFileParser.hh.

fOurFile

OggFile& OggFileParser::fOurFile

private

Definition at line 78 of file OggFileParser.hh.

fPacketSizeTable

PacketSizeTable* OggFileParser::fPacketSizeTable

private

Definition at line 86 of file OggFileParser.hh.

fRemainingUnparsedBits

unsigned char StreamParser::fRemainingUnparsedBits

privateinherited

Definition at line 156 of file StreamParser.hh.

Referenced by StreamParser::get1Byte(), StreamParser::get2Bytes(), StreamParser::get4Bytes(), and StreamParser::getBytes().

fSavedPacket

u_int8_t* OggFileParser::fSavedPacket

private

Definition at line 88 of file OggFileParser.hh.

fSavedParserIndex

unsigned StreamParser::fSavedParserIndex

privateinherited

Definition at line 151 of file StreamParser.hh.

fSavedRemainingUnparsedBits

unsigned char StreamParser::fSavedRemainingUnparsedBits

privateinherited

Definition at line 152 of file StreamParser.hh.

fTotNumValidBytes

unsigned StreamParser::fTotNumValidBytes

privateinherited

Definition at line 159 of file StreamParser.hh.

Referenced by StreamParser::ensureValidBytes(), and StreamParser::totNumValidBytes().

---

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

• liveMedia/OggFileParser.hh