RTPSource Class Reference

#include <RTPSource.hh>

Inheritance diagram for RTPSource:

Collaboration diagram for RTPSource:

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

Public Member Functions
Boolean	curPacketMarkerBit () const
unsigned char	rtpPayloadFormat () const
virtual Boolean	hasBeenSynchronizedUsingRTCP ()
Groupsock *	RTPgs () const
virtual void	setPacketReorderingThresholdTime (unsigned uSeconds)=0
void	setCrypto (SRTPCryptographicContext *crypto)
u_int32_t	SSRC () const
void	registerForMultiplexedRTCPPackets (class RTCPInstance *rtcpInstance)
void	deregisterForMultiplexedRTCPPackets ()
unsigned	timestampFrequency () const
RTPReceptionStatsDB &	receptionStatsDB () const
u_int32_t	lastReceivedSSRC () const
Boolean &	enableRTCPReports ()
Boolean const &	enableRTCPReports () const
void	setStreamSocket (int sockNum, unsigned char streamChannelId, TLSState *tlsState)
void	setAuxilliaryReadHandler (AuxHandlerFunc *handlerFunc, void *handlerClientData)
u_int16_t	curPacketRTPSeqNum () const
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 char const *	MIMEtype () 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, RTPSource *&resultSource)
static Boolean	lookupByName (UsageEnvironment &env, char const *sourceName, FramedSource *&resultSource)
static Boolean	lookupByName (UsageEnvironment &env, char const *sourceName, MediaSource *&resultSource)
static Boolean	lookupByName (UsageEnvironment &env, char const *mediumName, Medium *&resultMedium)
static void	handleClosure (void *clientData)
static void	afterGetting (FramedSource *source)
static void	close (UsageEnvironment &env, char const *mediumName)
static void	close (Medium *medium)

Protected Member Functions
	RTPSource (UsageEnvironment &env, Groupsock *RTPgs, unsigned char rtpPayloadFormat, u_int32_t rtpTimestampFrequency)
virtual	~RTPSource ()
virtual void	doStopGettingFrames ()
TaskToken &	nextTask ()

Protected Attributes
RTPInterface	fRTPInterface
u_int16_t	fCurPacketRTPSeqNum
u_int32_t	fCurPacketRTPTimestamp
Boolean	fCurPacketMarkerBit
Boolean	fCurPacketHasBeenSynchronizedUsingRTCP
u_int32_t	fLastReceivedSSRC
class RTCPInstance *	fRTCPInstanceForMultiplexedRTCPPackets
SRTPCryptographicContext *	fCrypto
unsigned char *	fTo
unsigned	fMaxSize
unsigned	fFrameSize
unsigned	fNumTruncatedBytes
struct timeval	fPresentationTime
unsigned	fDurationInMicroseconds

Private Member Functions
u_int32_t	curPacketRTPTimestamp () const
virtual Boolean	isRTPSource () const
virtual void	getAttributes () const
virtual Boolean	isFramedSource () const
virtual Boolean	isSource () const

Private Attributes
unsigned char	fRTPPayloadFormat
unsigned	fTimestampFrequency
u_int32_t	fSSRC
Boolean	fEnableRTCPReports
RTPReceptionStatsDB *	fReceptionStatsDB
afterGettingFunc *	fAfterGettingFunc
void *	fAfterGettingClientData
onCloseFunc *	fOnCloseFunc
void *	fOnCloseClientData
Boolean	fIsCurrentlyAwaitingData
UsageEnvironment &	fEnviron
char	fMediumName [mediumNameMaxLen]
TaskToken	fNextTask

Friends
class	MediaSubsession

Detailed Description

Definition at line 36 of file RTPSource.hh.

Member Typedef Documentation

afterGettingFunc

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

inherited

Definition at line 36 of file FramedSource.hh.

onCloseFunc

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

inherited

Definition at line 40 of file FramedSource.hh.

Constructor & Destructor Documentation

RTPSource()

RTPSource::RTPSource ( UsageEnvironment &  env, Groupsock *  RTPgs, unsigned char  rtpPayloadFormat, u_int32_t  rtpTimestampFrequency  )

protected

~RTPSource()

virtual RTPSource::~RTPSource ( )

protectedvirtual

Member Function Documentation

afterGetting()

static void FramedSource::afterGetting ( FramedSource *  source )

staticinherited

close() [1/2]

static void Medium::close ( Medium *  medium )

staticinherited

close() [2/2]

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

staticinherited

curPacketMarkerBit()

Boolean RTPSource::curPacketMarkerBit ( ) const

inline

Definition at line 41 of file RTPSource.hh.

{ return fCurPacketMarkerBit; }

References fCurPacketMarkerBit.

curPacketRTPSeqNum()

u_int16_t RTPSource::curPacketRTPSeqNum ( ) const

inline

Definition at line 88 of file RTPSource.hh.

{ return fCurPacketRTPSeqNum; }

References fCurPacketRTPSeqNum.

curPacketRTPTimestamp()

u_int32_t RTPSource::curPacketRTPTimestamp ( ) const

inlineprivate

Definition at line 90 of file RTPSource.hh.

{ return fCurPacketRTPTimestamp; }

References fCurPacketRTPTimestamp.

deregisterForMultiplexedRTCPPackets()

void RTPSource::deregisterForMultiplexedRTCPPackets ( )

inline

Definition at line 60 of file RTPSource.hh.

{ registerForMultiplexedRTCPPackets(NULL); }

References NULL, and registerForMultiplexedRTCPPackets().

doGetNextFrame()

virtual void FramedSource::doGetNextFrame ( )

pure virtualinherited

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 ( )

protectedvirtualinherited

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

enableRTCPReports() [1/2]

Boolean & RTPSource::enableRTCPReports ( )

inline

Definition at line 71 of file RTPSource.hh.

{ return fEnableRTCPReports; }

References fEnableRTCPReports.

enableRTCPReports() [2/2]

Boolean const & RTPSource::enableRTCPReports ( ) const

inline

Definition at line 72 of file RTPSource.hh.

{ return fEnableRTCPReports; }

References fEnableRTCPReports.

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 RTPSource::getAttributes ( ) const

privatevirtual

Reimplemented from MediaSource.

getNextFrame()

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

inherited

handleClosure() [1/2]

void FramedSource::handleClosure ( )

inherited

handleClosure() [2/2]

static void FramedSource::handleClosure ( void *  clientData )

staticinherited

hasBeenSynchronizedUsingRTCP()

virtual Boolean RTPSource::hasBeenSynchronizedUsingRTCP ( )

virtual

isAMRAudioSource()

virtual Boolean MediaSource::isAMRAudioSource ( ) const

virtualinherited

Reimplemented in AMRAudioSource.

isCurrentlyAwaitingData()

Boolean FramedSource::isCurrentlyAwaitingData ( ) const

inlineinherited

Definition at line 61 of file FramedSource.hh.

{return fIsCurrentlyAwaitingData;}

References FramedSource::fIsCurrentlyAwaitingData.

isDVVideoStreamFramer()

virtual Boolean MediaSource::isDVVideoStreamFramer ( ) const

virtualinherited

Reimplemented in DVVideoStreamFramer.

isFramedSource()

virtual Boolean FramedSource::isFramedSource ( ) const

privatevirtualinherited

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 RTPSource::isRTPSource ( ) const

privatevirtual

Reimplemented from MediaSource.

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.

lastReceivedSSRC()

u_int32_t RTPSource::lastReceivedSSRC ( ) const

inline

Definition at line 68 of file RTPSource.hh.

{ return fLastReceivedSSRC; }

References fLastReceivedSSRC.

lookupByName() [1/4]

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

staticinherited

lookupByName() [2/4]

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

staticinherited

lookupByName() [3/4]

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

staticinherited

lookupByName() [4/4]

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

static

maxFrameSize()

virtual unsigned FramedSource::maxFrameSize ( ) const

virtualinherited

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.

receptionStatsDB()

RTPReceptionStatsDB & RTPSource::receptionStatsDB ( ) const

inline

Definition at line 64 of file RTPSource.hh.

                                                {
    return *fReceptionStatsDB;
  }

References fReceptionStatsDB.

registerForMultiplexedRTCPPackets()

void RTPSource::registerForMultiplexedRTCPPackets ( class RTCPInstance *  rtcpInstance )

inline

Definition at line 57 of file RTPSource.hh.

                                                                           {
    fRTCPInstanceForMultiplexedRTCPPackets = rtcpInstance;
  }

References fRTCPInstanceForMultiplexedRTCPPackets.

Referenced by deregisterForMultiplexedRTCPPackets().

RTPgs()

Groupsock * RTPSource::RTPgs ( ) const

inline

Definition at line 47 of file RTPSource.hh.

{ return fRTPInterface.gs(); }

References fRTPInterface, and RTPInterface::gs().

rtpPayloadFormat()

unsigned char RTPSource::rtpPayloadFormat ( ) const

inline

Definition at line 43 of file RTPSource.hh.

{ return fRTPPayloadFormat; }

References fRTPPayloadFormat.

setAuxilliaryReadHandler()

void RTPSource::setAuxilliaryReadHandler ( AuxHandlerFunc *  handlerFunc, void *  handlerClientData  )

inline

Definition at line 79 of file RTPSource.hh.

                                                         {
    fRTPInterface.setAuxilliaryReadHandler(handlerFunc,
                                           handlerClientData);
  }

References fRTPInterface, and RTPInterface::setAuxilliaryReadHandler().

setCrypto()

void RTPSource::setCrypto ( SRTPCryptographicContext *  crypto )

inline

Definition at line 51 of file RTPSource.hh.

{ fCrypto = crypto; }

References fCrypto.

setPacketReorderingThresholdTime()

virtual void RTPSource::setPacketReorderingThresholdTime ( unsigned  uSeconds )

pure virtual

Implemented in MultiFramedRTPSource.

setStreamSocket()

void RTPSource::setStreamSocket ( int  sockNum, unsigned char  streamChannelId, TLSState *  tlsState  )

inline

Definition at line 74 of file RTPSource.hh.

                                                                                       {
    // hack to allow sending RTP over TCP (RFC 2236, section 10.12)
    fRTPInterface.setStreamSocket(sockNum, streamChannelId, tlsState);
  }

References fRTPInterface, and RTPInterface::setStreamSocket().

SSRC()

u_int32_t RTPSource::SSRC ( ) const

inline

Definition at line 54 of file RTPSource.hh.

{ return fSSRC; }

References fSSRC.

stopGettingFrames()

void FramedSource::stopGettingFrames ( )

inherited

timestampFrequency()

unsigned RTPSource::timestampFrequency ( ) const

inline

Definition at line 62 of file RTPSource.hh.

{return fTimestampFrequency;}

References fTimestampFrequency.

Friends And Related Function Documentation

MediaSubsession

friend class MediaSubsession

friend

Definition at line 89 of file RTPSource.hh.

Field Documentation

fAfterGettingClientData

void* FramedSource::fAfterGettingClientData

privateinherited

Definition at line 88 of file FramedSource.hh.

fAfterGettingFunc

afterGettingFunc* FramedSource::fAfterGettingFunc

privateinherited

Definition at line 87 of file FramedSource.hh.

fCrypto

SRTPCryptographicContext* RTPSource::fCrypto

protected

Definition at line 106 of file RTPSource.hh.

Referenced by setCrypto().

fCurPacketHasBeenSynchronizedUsingRTCP

Boolean RTPSource::fCurPacketHasBeenSynchronizedUsingRTCP

protected

Definition at line 103 of file RTPSource.hh.

fCurPacketMarkerBit

Boolean RTPSource::fCurPacketMarkerBit

protected

Definition at line 102 of file RTPSource.hh.

Referenced by curPacketMarkerBit().

fCurPacketRTPSeqNum

u_int16_t RTPSource::fCurPacketRTPSeqNum

protected

Definition at line 100 of file RTPSource.hh.

Referenced by curPacketRTPSeqNum().

fCurPacketRTPTimestamp

u_int32_t RTPSource::fCurPacketRTPTimestamp

protected

Definition at line 101 of file RTPSource.hh.

Referenced by curPacketRTPTimestamp().

fDurationInMicroseconds

unsigned FramedSource::fDurationInMicroseconds

protectedinherited

Definition at line 80 of file FramedSource.hh.

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

fEnableRTCPReports

Boolean RTPSource::fEnableRTCPReports

private

Definition at line 117 of file RTPSource.hh.

Referenced by enableRTCPReports().

fEnviron

UsageEnvironment& Medium::fEnviron

privateinherited

Definition at line 82 of file Media.hh.

Referenced by Medium::envir().

fFrameSize

unsigned FramedSource::fFrameSize

protectedinherited

Definition at line 77 of file FramedSource.hh.

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

fIsCurrentlyAwaitingData

Boolean FramedSource::fIsCurrentlyAwaitingData

privateinherited

Definition at line 92 of file FramedSource.hh.

Referenced by FramedSource::isCurrentlyAwaitingData().

fLastReceivedSSRC

u_int32_t RTPSource::fLastReceivedSSRC

protected

Definition at line 104 of file RTPSource.hh.

Referenced by lastReceivedSSRC().

fMaxSize

unsigned FramedSource::fMaxSize

protectedinherited

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

protectedinherited

Definition at line 78 of file FramedSource.hh.

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

fOnCloseClientData

void* FramedSource::fOnCloseClientData

privateinherited

Definition at line 90 of file FramedSource.hh.

fOnCloseFunc

onCloseFunc* FramedSource::fOnCloseFunc

privateinherited

Definition at line 89 of file FramedSource.hh.

fPresentationTime

struct timeval FramedSource::fPresentationTime

protectedinherited

Definition at line 79 of file FramedSource.hh.

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

fReceptionStatsDB

RTPReceptionStatsDB* RTPSource::fReceptionStatsDB

private

Definition at line 119 of file RTPSource.hh.

Referenced by receptionStatsDB().

fRTCPInstanceForMultiplexedRTCPPackets

class RTCPInstance* RTPSource::fRTCPInstanceForMultiplexedRTCPPackets

protected

Definition at line 105 of file RTPSource.hh.

Referenced by registerForMultiplexedRTCPPackets().

fRTPInterface

RTPInterface RTPSource::fRTPInterface

protected

Definition at line 99 of file RTPSource.hh.

Referenced by RTPgs(), setAuxilliaryReadHandler(), and setStreamSocket().

fRTPPayloadFormat

unsigned char RTPSource::fRTPPayloadFormat

private

Definition at line 114 of file RTPSource.hh.

Referenced by rtpPayloadFormat().

fSSRC

u_int32_t RTPSource::fSSRC

private

Definition at line 116 of file RTPSource.hh.

Referenced by SSRC().

fTimestampFrequency

unsigned RTPSource::fTimestampFrequency

private

Definition at line 115 of file RTPSource.hh.

Referenced by timestampFrequency().

fTo

unsigned char* FramedSource::fTo

protectedinherited

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/RTPSource.hh