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)

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

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

bankSize()

unsigned StreamParser::bankSize ( ) const

protectedinherited

continueParsing() [1/2]

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

static

continueParsing() [2/2]

void OggFileParser::continueParsing

(

)

curOffset()

unsigned StreamParser::curOffset ( ) const

inlineprotectedinherited

Definition at line 107 of file StreamParser.hh.

{ return fCurParserIndex; }

References StreamParser::fCurParserIndex.

deliverPacketWithinPage()

Boolean OggFileParser::deliverPacketWithinPage ( )

private

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.

needHeaders()

Boolean OggFileParser::needHeaders ( )

inlineprivate

Definition at line 62 of file OggFileParser.hh.

{ return fNumUnfulfilledTracks > 0; }

References fNumUnfulfilledTracks.

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 MPEG2TransportStreamParser, MPEGVideoStreamParser, H263plusVideoStreamParser, and MatroskaFileParser.

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

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.

fInputSource

FramedSource* OggFileParser::fInputSource

private

Definition at line 79 of file OggFileParser.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.

fSavedPacket

u_int8_t* OggFileParser::fSavedPacket

private

Definition at line 88 of file OggFileParser.hh.

---

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

• liveMedia/OggFileParser.hh