FramedSource Class Reference

#include <FramedSource.hh>

Inheritance diagram for FramedSource:

Collaboration diagram for FramedSource:

Public Types
typedef void()	afterGettingFunc(void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
typedef void()	onCloseFunc(void *clientData)

Public Member Functions
void	getNextFrame (unsigned char *to, unsigned maxSize, afterGettingFunc *afterGettingFunc, void *afterGettingClientData, onCloseFunc *onCloseFunc, void *onCloseClientData)
void	handleClosure ()
void	stopGettingFrames ()
virtual unsigned	maxFrameSize () const
virtual void	doGetNextFrame ()=0
Boolean	isCurrentlyAwaitingData () const
virtual void	getAttributes () const
virtual char const *	MIMEtype () const
virtual Boolean	isRTPSource () const
virtual Boolean	isMPEG1or2VideoStreamFramer () const
virtual Boolean	isMPEG4VideoStreamFramer () const
virtual Boolean	isH264VideoStreamFramer () const
virtual Boolean	isH265VideoStreamFramer () const
virtual Boolean	isDVVideoStreamFramer () const
virtual Boolean	isJPEGVideoSource () const
virtual Boolean	isAMRAudioSource () const
virtual Boolean	isMPEG2TransportStreamMultiplexor () const
UsageEnvironment &	envir () const
char const *	name () const
virtual Boolean	isSink () const
virtual Boolean	isRTCPInstance () const
virtual Boolean	isRTSPClient () const
virtual Boolean	isRTSPServer () const
virtual Boolean	isMediaSession () const
virtual Boolean	isServerMediaSession () const

Static Public Member Functions
static Boolean	lookupByName (UsageEnvironment &env, char const *sourceName, FramedSource *&resultSource)
static void	handleClosure (void *clientData)
static void	afterGetting (FramedSource *source)
static Boolean	lookupByName (UsageEnvironment &env, char const *sourceName, MediaSource *&resultSource)
static Boolean	lookupByName (UsageEnvironment &env, char const *mediumName, Medium *&resultMedium)
static void	close (UsageEnvironment &env, char const *mediumName)
static void	close (Medium *medium)

Protected Member Functions
	FramedSource (UsageEnvironment &env)
virtual	~FramedSource ()
virtual void	doStopGettingFrames ()
TaskToken &	nextTask ()

Protected Attributes
unsigned char *	fTo
unsigned	fMaxSize
unsigned	fFrameSize
unsigned	fNumTruncatedBytes
struct timeval	fPresentationTime
unsigned	fDurationInMicroseconds

Private Member Functions
virtual Boolean	isFramedSource () const
virtual Boolean	isSource () const

Private Attributes
afterGettingFunc *	fAfterGettingFunc
void *	fAfterGettingClientData
onCloseFunc *	fOnCloseFunc
void *	fOnCloseClientData
Boolean	fIsCurrentlyAwaitingData
UsageEnvironment &	fEnviron
char	fMediumName [mediumNameMaxLen]
TaskToken	fNextTask

Detailed Description

Definition at line 31 of file FramedSource.hh.

Member Typedef Documentation

afterGettingFunc

typedef void() FramedSource::afterGettingFunc(void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)

Definition at line 36 of file FramedSource.hh.

onCloseFunc

typedef void() FramedSource::onCloseFunc(void *clientData)

Definition at line 40 of file FramedSource.hh.

Constructor & Destructor Documentation

FramedSource()

FramedSource::FramedSource ( UsageEnvironment &  env )

protected

~FramedSource()

virtual FramedSource::~FramedSource ( )

protectedvirtual

Member Function Documentation

afterGetting()

static void FramedSource::afterGetting ( FramedSource *  source )

static

close() [1/2]

static void Medium::close ( Medium *  medium )

staticinherited

close() [2/2]

static void Medium::close ( UsageEnvironment &  env, char const *  mediumName  )

staticinherited

doGetNextFrame()

virtual void FramedSource::doGetNextFrame ( )

pure virtual

Implemented in AC3AudioStreamFramer, ADTSAudioFileSource, ADTSAudioStreamDiscreteFramer, AMRAudioFileSource, BasicUDPSource, ByteStreamFileSource, ByteStreamMemoryBufferSource, ByteStreamMultiFileSource, DeviceSource, DVVideoStreamFramer, H263plusVideoStreamFramer, H264or5VideoStreamDiscreteFramer, H264or5VideoStreamFramer, ADUFromMP3Source, MP3FromADUSource, MP3ADUinterleaver, MP3ADUdeinterleaver, MP3ADUTranscoder, MP3FileSource, MPEG1or2AudioStreamFramer, MPEG1or2DemuxedElementaryStream, MPEG1or2VideoStreamDiscreteFramer, MPEG2IFrameIndexFromTransportStream, MPEG2TransportStreamAccumulator, MPEG2TransportStreamFramer, MPEG2TransportStreamMultiplexor, MPEG2TransportStreamTrickModeFilter, MPEG4VideoStreamDiscreteFramer, MPEGVideoStreamFramer, MultiFramedRTPSource, PresentationTimeSubsessionNormalizer, T140IdleFilter, uLawFromPCMAudioSource, PCMFromuLawAudioSource, NetworkFromHostOrder16, HostFromNetworkOrder16, EndianSwap16, EndianSwap24, WAVAudioFileSource, MatroskaDemuxedTrack, MPEG2TransportStreamDemuxedTrack, and OggDemuxedTrack.

doStopGettingFrames()

virtual void FramedSource::doStopGettingFrames ( )

protectedvirtual

Reimplemented in BasicUDPSource, ByteStreamFileSource, FramedFilter, MPEG1or2DemuxedElementaryStream, MPEG2TransportStreamFramer, MPEG2TransportStreamFromESSource, MPEG2TransportStreamFromPESSource, MPEG2TransportStreamTrickModeFilter, MPEGVideoStreamFramer, MultiFramedRTPSource, T140IdleFilter, WAVAudioFileSource, and MatroskaDemuxedTrack.

envir()

UsageEnvironment & Medium::envir ( ) const

inlineinherited

Definition at line 59 of file Media.hh.

{return fEnviron;}

References Medium::fEnviron.

Referenced by MediaSubsession::env(), GenericMediaServer::ClientConnection::envir(), GenericMediaServer::ClientSession::envir(), and RTPInterface::envir().

getAttributes()

virtual void MediaSource::getAttributes ( ) const

virtualinherited

Reimplemented in FramedFilter, MP3ADUTranscoder, MP3FileSource, and RTPSource.

getNextFrame()

void FramedSource::getNextFrame	(	unsigned char *	to,
		unsigned	maxSize,
		afterGettingFunc *	afterGettingFunc,
		void *	afterGettingClientData,
		onCloseFunc *	onCloseFunc,
		void *	onCloseClientData
	)

handleClosure() [1/2]

void FramedSource::handleClosure

(

)

handleClosure() [2/2]

static void FramedSource::handleClosure ( void *  clientData )

static

isAMRAudioSource()

virtual Boolean MediaSource::isAMRAudioSource ( ) const

virtualinherited

Reimplemented in AMRAudioSource.

isCurrentlyAwaitingData()

Boolean FramedSource::isCurrentlyAwaitingData ( ) const

inline

Definition at line 61 of file FramedSource.hh.

{return fIsCurrentlyAwaitingData;}

References fIsCurrentlyAwaitingData.

isDVVideoStreamFramer()

virtual Boolean MediaSource::isDVVideoStreamFramer ( ) const

virtualinherited

Reimplemented in DVVideoStreamFramer.

isFramedSource()

virtual Boolean FramedSource::isFramedSource ( ) const

privatevirtual

Reimplemented from MediaSource.

isH264VideoStreamFramer()

virtual Boolean MediaSource::isH264VideoStreamFramer ( ) const

virtualinherited

Reimplemented in H264VideoStreamDiscreteFramer, and H264VideoStreamFramer.

isH265VideoStreamFramer()

virtual Boolean MediaSource::isH265VideoStreamFramer ( ) const

virtualinherited

Reimplemented in H265VideoStreamDiscreteFramer, and H265VideoStreamFramer.

isJPEGVideoSource()

virtual Boolean MediaSource::isJPEGVideoSource ( ) const

virtualinherited

Reimplemented in JPEGVideoSource.

isMediaSession()

virtual Boolean Medium::isMediaSession ( ) const

virtualinherited

Reimplemented in MediaSession.

isMPEG1or2VideoStreamFramer()

virtual Boolean MediaSource::isMPEG1or2VideoStreamFramer ( ) const

virtualinherited

Reimplemented in MPEG1or2VideoStreamFramer.

isMPEG2TransportStreamMultiplexor()

virtual Boolean MediaSource::isMPEG2TransportStreamMultiplexor ( ) const

virtualinherited

Reimplemented in MPEG2TransportStreamMultiplexor.

isMPEG4VideoStreamFramer()

virtual Boolean MediaSource::isMPEG4VideoStreamFramer ( ) const

virtualinherited

Reimplemented in MPEG4VideoStreamFramer.

isRTCPInstance()

virtual Boolean Medium::isRTCPInstance ( ) const

virtualinherited

Reimplemented in RTCPInstance.

isRTPSource()

virtual Boolean MediaSource::isRTPSource ( ) const

virtualinherited

Reimplemented in RTPSource.

isRTSPClient()

virtual Boolean Medium::isRTSPClient ( ) const

virtualinherited

Reimplemented in RTSPClient.

isRTSPServer()

virtual Boolean Medium::isRTSPServer ( ) const

virtualinherited

Reimplemented in RTSPServer.

isServerMediaSession()

virtual Boolean Medium::isServerMediaSession ( ) const

virtualinherited

Reimplemented in ServerMediaSession.

isSink()

virtual Boolean Medium::isSink ( ) const

virtualinherited

Reimplemented in MediaSink.

isSource()

virtual Boolean MediaSource::isSource ( ) const

privatevirtualinherited

Reimplemented from Medium.

lookupByName() [1/3]

static Boolean Medium::lookupByName ( UsageEnvironment &  env, char const *  mediumName, Medium *&  resultMedium  )

staticinherited

lookupByName() [2/3]

static Boolean FramedSource::lookupByName ( UsageEnvironment &  env, char const *  sourceName, FramedSource *&  resultSource  )

static

lookupByName() [3/3]

static Boolean MediaSource::lookupByName ( UsageEnvironment &  env, char const *  sourceName, MediaSource *&  resultSource  )

staticinherited

maxFrameSize()

virtual unsigned FramedSource::maxFrameSize ( ) const

virtual

Reimplemented in BasicUDPSource, and MPEG1or2DemuxedElementaryStream.

MIMEtype()

virtual char const * MediaSource::MIMEtype ( ) const

virtualinherited

Reimplemented in AC3AudioRTPSource, AMRAudioSource, DVVideoRTPSource, FramedFilter, H261VideoRTPSource, H263plusVideoRTPSource, H264VideoRTPSource, H265VideoRTPSource, JPEG2000VideoRTPSource, JPEGVideoRTPSource, ADUFromMP3Source, MP3FromADUSource, MP3ADURTPSource, MP3FileSource, MPEG1or2AudioRTPSource, MPEG1or2DemuxedElementaryStream, MPEG1or2VideoRTPSource, MPEG4ESVideoRTPSource, MPEG4GenericRTPSource, MPEG4LATMAudioRTPSource, QuickTimeGenericRTPSource, RawVideoRTPSource, SimpleRTPSource, TheoraVideoRTPSource, VorbisAudioRTPSource, VP8VideoRTPSource, VP9VideoRTPSource, MatroskaDemuxedTrack, and OggDemuxedTrack.

name()

char const * Medium::name ( ) const

inlineinherited

Definition at line 61 of file Media.hh.

{return fMediumName;}

References Medium::fMediumName.

nextTask()

TaskToken & Medium::nextTask ( )

inlineprotectedinherited

Definition at line 77 of file Media.hh.

                        {
        return fNextTask;
  }

References Medium::fNextTask.

stopGettingFrames()

void FramedSource::stopGettingFrames

(

)

Field Documentation

fAfterGettingClientData

void* FramedSource::fAfterGettingClientData

private

Definition at line 88 of file FramedSource.hh.

fAfterGettingFunc

afterGettingFunc* FramedSource::fAfterGettingFunc

private

Definition at line 87 of file FramedSource.hh.

fDurationInMicroseconds

unsigned FramedSource::fDurationInMicroseconds

protected

Definition at line 80 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::durationInMicroseconds(), and OggDemuxedTrack::durationInMicroseconds().

fEnviron

UsageEnvironment& Medium::fEnviron

privateinherited

Definition at line 82 of file Media.hh.

Referenced by Medium::envir().

fFrameSize

unsigned FramedSource::fFrameSize

protected

Definition at line 77 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::frameSize(), MPEG2TransportStreamDemuxedTrack::frameSize(), and OggDemuxedTrack::frameSize().

fIsCurrentlyAwaitingData

Boolean FramedSource::fIsCurrentlyAwaitingData

private

Definition at line 92 of file FramedSource.hh.

Referenced by isCurrentlyAwaitingData().

fMaxSize

unsigned FramedSource::fMaxSize

protected

Definition at line 76 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::maxSize(), MPEG2TransportStreamDemuxedTrack::maxSize(), and OggDemuxedTrack::maxSize().

fMediumName

char Medium::fMediumName[mediumNameMaxLen]

privateinherited

Definition at line 83 of file Media.hh.

Referenced by Medium::name().

fNextTask

TaskToken Medium::fNextTask

privateinherited

Definition at line 84 of file Media.hh.

Referenced by Medium::nextTask().

fNumTruncatedBytes

unsigned FramedSource::fNumTruncatedBytes

protected

Definition at line 78 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::numTruncatedBytes(), MPEG2TransportStreamDemuxedTrack::numTruncatedBytes(), and OggDemuxedTrack::numTruncatedBytes().

fOnCloseClientData

void* FramedSource::fOnCloseClientData

private

Definition at line 90 of file FramedSource.hh.

fOnCloseFunc

onCloseFunc* FramedSource::fOnCloseFunc

private

Definition at line 89 of file FramedSource.hh.

fPresentationTime

struct timeval FramedSource::fPresentationTime

protected

Definition at line 79 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::presentationTime(), MPEG2TransportStreamDemuxedTrack::presentationTime(), and OggDemuxedTrack::presentationTime().

fTo

unsigned char* FramedSource::fTo

protected

Definition at line 75 of file FramedSource.hh.

Referenced by MatroskaDemuxedTrack::to(), MPEG2TransportStreamDemuxedTrack::to(), and OggDemuxedTrack::to().

---

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

• liveMedia/include/FramedSource.hh