OggPacketiser Class Reference

#include <OggPacketiser.h>

Inheritance diagram for OggPacketiser:

[legend]Collaboration diagram for OggPacketiser:

[legend]List of all members.

Public Types
enum	ePacketiserState { PKRSTATE_OK, PKRSTATE_AWAITING_CONTINUATION, PKRSTATE_INVALID_STREAM }
Public Member Functions
virtual bool	acceptOggPage (OggPage *inOggPage)
	Takes incoming pages, and fires the packets to the packet sink.
unsigned long	numIgnorePackets ()
	How many packets we are ignoring.
	OggPacketiser (IStampedOggPacketSink *inPacketSink)
	OggPacketiser (void)
IStampedOggPacketSink *	packetSink ()
	Returns a pointer to the interface recieving packets.
bool	reset ()
	Reset the packetiser.
void	setNumIgnorePackets (unsigned long inNumIgnorePackets)
	Tell the packetiser to ignore this many following packets.
void	setPacketSink (IStampedOggPacketSink *inPacketSink)
	Set the callback interface where generated packets will go.
virtual	~OggPacketiser (void)
Protected Member Functions
virtual bool	dispatchStampedOggPacket (StampedOggPacket *inPacket)
bool	processPage (OggPage *inOggPage, bool inIncludeFirst, bool inIncludeLast)
Protected Attributes
bool	mLooseMode
unsigned long	mNumIgnorePackets
ePacketiserState	mPacketiserState
IStampedOggPacketSink *	mPacketSink
StampedOggPacket *	mPendingPacket
Private Member Functions
	OggPacketiser (const OggPacketiser &other)
OggPacketiser &	operator= (const OggPacketiser &other)

---

Member Enumeration Documentation

enum OggPacketiser::ePacketiserState

Enumeration values: PKRSTATE_OK  PKRSTATE_AWAITING_CONTINUATION  PKRSTATE_INVALID_STREAM  Definition at line 47 of file OggPacketiser.h.

---

Constructor & Destructor Documentation

OggPacketiser::OggPacketiser (  void   )

Definition at line 34 of file OggPacketiser.cpp. References true.

OggPacketiser::OggPacketiser (  IStampedOggPacketSink *  inPacketSink  )

Definition at line 46 of file OggPacketiser.cpp. References true.

OggPacketiser::~OggPacketiser (  void   )  [virtual]

Definition at line 58 of file OggPacketiser.cpp.

OggPacketiser::OggPacketiser (  const OggPacketiser &  other  )  [private]

---

Member Function Documentation

bool OggPacketiser::acceptOggPage (  OggPage *  inOggPage  )  [virtual]

Takes incoming pages, and fires the packets to the packet sink. ... and there is at least 1 packet... Implements IOggCallback. Definition at line 80 of file OggPacketiser.cpp. References StampedOggPacket::clone(), dispatchStampedOggPacket(), OggPage::getPacket(), OggPage::getStampedPacket(), OggPage::header(), OggPageHeader::HeaderFlags(), OggPacket::isContinuation(), OggPacket::isTruncated(), StampedOggPacket::merge(), mLooseMode, mPacketiserState, mPendingPacket, OggPage::numPackets(), and processPage(). Referenced by OggDemuxPacketSourcePin::acceptOggPage(), OggStream::acceptOggPage(), and OggDemuxPacketSourcePin::CompleteConnect().

Here is the call graph for this function:

bool OggPacketiser::dispatchStampedOggPacket (  StampedOggPacket *  inPacket  )  [protected, virtual]

Definition at line 337 of file OggPacketiser.cpp. References IStampedOggPacketSink::acceptStampedOggPacket(), mNumIgnorePackets, and mPacketSink. Referenced by acceptOggPage(), and processPage().

Here is the call graph for this function:

unsigned long OggPacketiser::numIgnorePackets (   )

How many packets we are ignoring. Definition at line 358 of file OggPacketiser.cpp.

OggPacketiser& OggPacketiser::operator= (  const OggPacketiser &  other  )  [private]

IStampedOggPacketSink * OggPacketiser::packetSink (   )

Returns a pointer to the interface recieving packets. Definition at line 64 of file OggPacketiser.cpp.

bool OggPacketiser::processPage (  OggPage *  inOggPage, bool  inIncludeFirst, bool  inIncludeLast )  [protected]

Definition at line 315 of file OggPacketiser.cpp. References StampedOggPacket::clone(), dispatchStampedOggPacket(), OggPage::getStampedPacket(), and OggPage::numPackets(). Referenced by acceptOggPage().

Here is the call graph for this function:

bool OggPacketiser::reset (   )

Reset the packetiser. Definition at line 70 of file OggPacketiser.cpp. References mNumIgnorePackets, mPacketiserState, and mPendingPacket. Referenced by OggDemuxPacketSourcePin::DeliverEndFlush(), and OggStream::flush().

void OggPacketiser::setNumIgnorePackets (  unsigned long  inNumIgnorePackets  )

Tell the packetiser to ignore this many following packets. Definition at line 355 of file OggPacketiser.cpp. References mNumIgnorePackets. Referenced by OggStream::flush().

void OggPacketiser::setPacketSink (  IStampedOggPacketSink *  inPacketSink  )

Set the callback interface where generated packets will go. Definition at line 67 of file OggPacketiser.cpp. References mPacketSink. Referenced by OggDemuxPacketSourcePin::CompleteConnect(), OggDemuxPacketSourcePin::OggDemuxPacketSourcePin(), and OggStream::OggStream().

---

Member Data Documentation

bool OggPacketiser::mLooseMode [protected]

Definition at line 82 of file OggPacketiser.h. Referenced by acceptOggPage().

unsigned long OggPacketiser::mNumIgnorePackets [protected]

Definition at line 83 of file OggPacketiser.h. Referenced by dispatchStampedOggPacket(), reset(), and setNumIgnorePackets().

ePacketiserState OggPacketiser::mPacketiserState [protected]

Definition at line 87 of file OggPacketiser.h. Referenced by acceptOggPage(), and reset().

IStampedOggPacketSink* OggPacketiser::mPacketSink [protected]

Definition at line 77 of file OggPacketiser.h. Referenced by dispatchStampedOggPacket(), and setPacketSink().

StampedOggPacket* OggPacketiser::mPendingPacket [protected]

Definition at line 78 of file OggPacketiser.h. Referenced by acceptOggPage(), and reset().

---

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

• src/lib/core/ogg/libOOOgg/OggPacketiser.h
• src/lib/core/ogg/libOOOgg/OggPacketiser.cpp

---