TheoraVideoRTPSink Class Reference

#include <TheoraVideoRTPSink.hh>

Inheritance diagram for TheoraVideoRTPSink:

Collaboration diagram for TheoraVideoRTPSink:

Public Types
typedef void(	onSendErrorFunc) (void *clientData)
typedef void(	afterPlayingFunc) (void *clientData)

Public Member Functions
void	setPacketSizes (unsigned preferredPacketSize, unsigned maxPacketSize)
void	setOnSendErrorFunc (onSendErrorFunc *onSendErrorFunc, void *onSendErrorFuncData)
virtual void	stopPlaying ()
Groupsock const &	groupsockBeingUsed () const
Groupsock &	groupsockBeingUsed ()
unsigned char	rtpPayloadType () const
unsigned	rtpTimestampFrequency () const
void	setRTPTimestampFrequency (unsigned freq)
char const *	rtpPayloadFormatName () const
unsigned	numChannels () const
virtual char *	rtpmapLine () const
u_int16_t	currentSeqNo () const
u_int32_t	presetNextTimestamp ()
RTPTransmissionStatsDB &	transmissionStatsDB () const
Boolean	nextTimestampHasBeenPreset () const
Boolean &	enableRTCPReports ()
void	getTotalBitrate (unsigned &outNumBytes, double &outElapsedTime)
struct timeval const &	creationTime () const
struct timeval const &	initialPresentationTime () const
struct timeval const &	mostRecentPresentationTime () const
void	resetPresentationTimes ()
void	setStreamSocket (int sockNum, unsigned char streamChannelId)
void	addStreamSocket (int sockNum, unsigned char streamChannelId)
void	removeStreamSocket (int sockNum, unsigned char streamChannelId)
unsigned &	estimatedBitrate ()
u_int32_t	SSRC () const
Boolean	startPlaying (MediaSource &source, afterPlayingFunc *afterFunc, void *afterClientData)
FramedSource *	source () const
UsageEnvironment &	envir () const
char const *	name () const
virtual Boolean	isSource () 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 TheoraVideoRTPSink *	createNew (UsageEnvironment &env, Groupsock *RTPgs, u_int8_t rtpPayloadFormat, u_int8_t *identificationHeader, unsigned identificationHeaderSize, u_int8_t *commentHeader, unsigned commentHeaderSize, u_int8_t *setupHeader, unsigned setupHeaderSize, u_int32_t identField=0xFACADE)
static TheoraVideoRTPSink *	createNew (UsageEnvironment &env, Groupsock *RTPgs, u_int8_t rtpPayloadFormat, char const *configStr)
static Boolean	lookupByName (UsageEnvironment &env, char const *sinkName, RTPSink *&resultSink)
static Boolean	lookupByName (UsageEnvironment &env, char const *sinkName, MediaSink *&resultSink)
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
	TheoraVideoRTPSink (UsageEnvironment &env, Groupsock *RTPgs, u_int8_t rtpPayloadFormat, u_int8_t *identificationHeader, unsigned identificationHeaderSize, u_int8_t *commentHeader, unsigned commentHeaderSize, u_int8_t *setupHeader, unsigned setupHeaderSize, u_int32_t identField)
virtual	~TheoraVideoRTPSink ()
virtual Boolean	allowFragmentationAfterStart () const
virtual Boolean	allowOtherFramesAfterLastFragment () const
virtual unsigned	frameSpecificHeaderSize () const
virtual unsigned	computeOverflowForNewFrame (unsigned newFrameSize) const
Boolean	isFirstPacket () const
Boolean	isFirstFrameInPacket () const
unsigned	curFragmentationOffset () const
void	setMarkerBit ()
void	setTimestamp (struct timeval framePresentationTime)
void	setSpecialHeaderWord (unsigned word, unsigned wordPosition=0)
void	setSpecialHeaderBytes (unsigned char const *bytes, unsigned numBytes, unsigned bytePosition=0)
void	setFrameSpecificHeaderWord (unsigned word, unsigned wordPosition=0)
void	setFrameSpecificHeaderBytes (unsigned char const *bytes, unsigned numBytes, unsigned bytePosition=0)
void	setFramePadding (unsigned numPaddingBytes)
unsigned	numFramesUsedSoFar () const
unsigned	ourMaxPacketSize () const
virtual Boolean	continuePlaying ()
u_int32_t	convertToRTPTimestamp (struct timeval tv)
unsigned	packetCount () const
unsigned	octetCount () const
virtual Boolean	sourceIsCompatibleWithUs (MediaSource &source)
void	onSourceClosure ()
TaskToken &	nextTask ()

Static Protected Member Functions
static void	onSourceClosure (void *clientData)

Protected Attributes
RTPInterface	fRTPInterface
unsigned char	fRTPPayloadType
unsigned	fPacketCount
unsigned	fOctetCount
unsigned	fTotalOctetCount
struct timeval fTotalOctetCountStartTime fInitialPresentationTime	fMostRecentPresentationTime
u_int32_t	fCurrentTimestamp
u_int16_t	fSeqNo
FramedSource *	fSource

Private Member Functions
virtual char const *	auxSDPLine ()
virtual void	doSpecialFrameHandling (unsigned fragmentationOffset, unsigned char *frameStart, unsigned numBytesInFrame, struct timeval framePresentationTime, unsigned numRemainingBytes)
virtual Boolean	frameCanAppearAfterPacketStart (unsigned char const *frameStart, unsigned numBytesInFrame) const
virtual unsigned	specialHeaderSize () const

Private Attributes
u_int32_t	fIdent
char *	fFmtpSDPLine

Detailed Description

Definition at line 28 of file TheoraVideoRTPSink.hh.

Member Typedef Documentation

typedef void( MediaSink::afterPlayingFunc) (void *clientData)

inherited

Definition at line 33 of file MediaSink.hh.

typedef void( MultiFramedRTPSink::onSendErrorFunc) (void *clientData)

inherited

Definition at line 33 of file MultiFramedRTPSink.hh.

Constructor & Destructor Documentation

TheoraVideoRTPSink::TheoraVideoRTPSink ( UsageEnvironment &  env, Groupsock *  RTPgs, u_int8_t  rtpPayloadFormat, u_int8_t *  identificationHeader, unsigned  identificationHeaderSize, u_int8_t *  commentHeader, unsigned  commentHeaderSize, u_int8_t *  setupHeader, unsigned  setupHeaderSize, u_int32_t  identField  )

protected

virtual TheoraVideoRTPSink::~TheoraVideoRTPSink ( )

protectedvirtual

Member Function Documentation

void RTPSink::addStreamSocket ( int  sockNum, unsigned char  streamChannelId  )

inlineinherited

Definition at line 81 of file RTPSink.hh.

References RTPInterface::addStreamSocket(), and RTPSink::fRTPInterface.

                                                                   {
    fRTPInterface.addStreamSocket(sockNum, streamChannelId);
  }

virtual Boolean MultiFramedRTPSink::allowFragmentationAfterStart ( ) const

protectedvirtualinherited

Reimplemented in MPEG4ESVideoRTPSink, and MPEG1or2VideoRTPSink.

virtual Boolean MultiFramedRTPSink::allowOtherFramesAfterLastFragment ( ) const

protectedvirtualinherited

virtual char const* TheoraVideoRTPSink::auxSDPLine ( )

privatevirtual

Reimplemented from RTPSink.

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

staticinherited

static void Medium::close ( Medium *  medium )

staticinherited

virtual unsigned MultiFramedRTPSink::computeOverflowForNewFrame ( unsigned  newFrameSize ) const

protectedvirtualinherited

Reimplemented in DVVideoRTPSink.

virtual Boolean MultiFramedRTPSink::continuePlaying ( )

protectedvirtualinherited

Implements MediaSink.

Reimplemented in T140TextRTPSink, and H264or5VideoRTPSink.

u_int32_t RTPSink::convertToRTPTimestamp ( struct timeval  tv )

protectedinherited

static TheoraVideoRTPSink* TheoraVideoRTPSink::createNew ( UsageEnvironment &  env, Groupsock *  RTPgs, u_int8_t  rtpPayloadFormat, u_int8_t *  identificationHeader, unsigned  identificationHeaderSize, u_int8_t *  commentHeader, unsigned  commentHeaderSize, u_int8_t *  setupHeader, unsigned  setupHeaderSize, u_int32_t  identField = 0xFACADE  )

static

static TheoraVideoRTPSink* TheoraVideoRTPSink::createNew ( UsageEnvironment &  env, Groupsock *  RTPgs, u_int8_t  rtpPayloadFormat, char const *  configStr  )

static

struct timeval const& RTPSink::creationTime ( ) const

inlineinherited

Definition at line 72 of file RTPSink.hh.

References RTPSink::fCreationTime.

{ return fCreationTime; }

unsigned MultiFramedRTPSink::curFragmentationOffset ( ) const

inlineprotectedinherited

Definition at line 79 of file MultiFramedRTPSink.hh.

References MultiFramedRTPSink::fCurFragmentationOffset.

{ return fCurFragmentationOffset; }

u_int16_t RTPSink::currentSeqNo ( ) const

inlineinherited

Definition at line 56 of file RTPSink.hh.

References RTPSink::fSeqNo.

{ return fSeqNo; }

virtual void TheoraVideoRTPSink::doSpecialFrameHandling ( unsigned  fragmentationOffset, unsigned char *  frameStart, unsigned  numBytesInFrame, struct timeval  framePresentationTime, unsigned  numRemainingBytes  )

privatevirtual

Reimplemented from MultiFramedRTPSink.

Boolean& RTPSink::enableRTCPReports ( )

inlineinherited

Definition at line 66 of file RTPSink.hh.

References RTPSink::fEnableRTCPReports.

{ return fEnableRTCPReports; }

UsageEnvironment& Medium::envir ( ) const

inlineinherited

Definition at line 59 of file Media.hh.

References Medium::fEnviron.

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

{return fEnviron;}

unsigned& RTPSink::estimatedBitrate ( )

inlineinherited

Definition at line 87 of file RTPSink.hh.

References RTPSink::fEstimatedBitrate.

{ return fEstimatedBitrate; } // kbps; usually 0 (i.e., unset)

virtual Boolean TheoraVideoRTPSink::frameCanAppearAfterPacketStart ( unsigned char const *  frameStart, unsigned  numBytesInFrame  ) const

privatevirtual

Reimplemented from MultiFramedRTPSink.

virtual unsigned MultiFramedRTPSink::frameSpecificHeaderSize ( ) const

protectedvirtualinherited

Reimplemented in VorbisAudioRTPSink.

void RTPSink::getTotalBitrate ( unsigned &  outNumBytes, double &  outElapsedTime  )

inherited

Groupsock const& RTPSink::groupsockBeingUsed ( ) const

inlineinherited

Definition at line 39 of file RTPSink.hh.

References RTPSink::fRTPInterface, and RTPInterface::gs().

{ return *(fRTPInterface.gs()); }

Groupsock& RTPSink::groupsockBeingUsed ( )

inlineinherited

Definition at line 40 of file RTPSink.hh.

References RTPSink::fRTPInterface, and RTPInterface::gs().

{ return *(fRTPInterface.gs()); }

struct timeval const& RTPSink::initialPresentationTime ( ) const

inlineinherited

Definition at line 73 of file RTPSink.hh.

{ return fInitialPresentationTime; }

Boolean MultiFramedRTPSink::isFirstFrameInPacket ( ) const

inlineprotectedinherited

Definition at line 78 of file MultiFramedRTPSink.hh.

References MultiFramedRTPSink::fNumFramesUsedSoFar.

{ return fNumFramesUsedSoFar == 0; }

Boolean MultiFramedRTPSink::isFirstPacket ( ) const

inlineprotectedinherited

Definition at line 77 of file MultiFramedRTPSink.hh.

References MultiFramedRTPSink::fIsFirstPacket.

{ return fIsFirstPacket; }

virtual Boolean Medium::isMediaSession ( ) const

virtualinherited

Reimplemented in MediaSession.

virtual Boolean Medium::isRTCPInstance ( ) const

virtualinherited

Reimplemented in RTCPInstance.

virtual Boolean Medium::isRTSPClient ( ) const

virtualinherited

Reimplemented in RTSPClient.

virtual Boolean Medium::isRTSPServer ( ) const

virtualinherited

Reimplemented in RTSPServer.

virtual Boolean Medium::isServerMediaSession ( ) const

virtualinherited

Reimplemented in ServerMediaSession.

virtual Boolean Medium::isSource ( ) const

virtualinherited

Reimplemented in MediaSource.

static Boolean MediaSink::lookupByName ( UsageEnvironment &  env, char const *  sinkName, MediaSink *&  resultSink  )

staticinherited

static Boolean RTPSink::lookupByName ( UsageEnvironment &  env, char const *  sinkName, RTPSink *&  resultSink  )

staticinherited

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

staticinherited

struct timeval const& RTPSink::mostRecentPresentationTime ( ) const

inlineinherited

Definition at line 74 of file RTPSink.hh.

References RTPSink::fMostRecentPresentationTime.

{ return fMostRecentPresentationTime; }

char const* Medium::name ( ) const

inlineinherited

Definition at line 61 of file Media.hh.

References Medium::fMediumName.

{return fMediumName;}

TaskToken& Medium::nextTask ( )

inlineprotectedinherited

Definition at line 77 of file Media.hh.

References Medium::fNextTask.

                        {
        return fNextTask;
  }

Boolean RTPSink::nextTimestampHasBeenPreset ( ) const

inlineinherited

Definition at line 65 of file RTPSink.hh.

References RTPSink::fNextTimestampHasBeenPreset.

{ return fNextTimestampHasBeenPreset; }

unsigned RTPSink::numChannels ( ) const

inlineinherited

Definition at line 49 of file RTPSink.hh.

References RTPSink::fNumChannels.

{ return fNumChannels; }

unsigned MultiFramedRTPSink::numFramesUsedSoFar ( ) const

inlineprotectedinherited

Definition at line 91 of file MultiFramedRTPSink.hh.

References MultiFramedRTPSink::fNumFramesUsedSoFar.

{ return fNumFramesUsedSoFar; }

unsigned RTPSink::octetCount ( ) const

inlineprotectedinherited

Definition at line 107 of file RTPSink.hh.

References RTPSink::fOctetCount.

{return fOctetCount;}

static void MediaSink::onSourceClosure ( void *  clientData )

staticprotectedinherited

void MediaSink::onSourceClosure ( )

protectedinherited

unsigned MultiFramedRTPSink::ourMaxPacketSize ( ) const

inlineprotectedinherited

Definition at line 92 of file MultiFramedRTPSink.hh.

References MultiFramedRTPSink::fOurMaxPacketSize.

{ return fOurMaxPacketSize; }

unsigned RTPSink::packetCount ( ) const

inlineprotectedinherited

Definition at line 106 of file RTPSink.hh.

References RTPSink::fPacketCount.

{return fPacketCount;}

u_int32_t RTPSink::presetNextTimestamp ( )

inherited

void RTPSink::removeStreamSocket ( int  sockNum, unsigned char  streamChannelId  )

inlineinherited

Definition at line 84 of file RTPSink.hh.

References RTPSink::fRTPInterface, and RTPInterface::removeStreamSocket().

                                                                      {
    fRTPInterface.removeStreamSocket(sockNum, streamChannelId);
  }

void RTPSink::resetPresentationTimes ( )

inherited

virtual char* RTPSink::rtpmapLine ( ) const

virtualinherited

char const* RTPSink::rtpPayloadFormatName ( ) const

inlineinherited

Definition at line 47 of file RTPSink.hh.

References RTPSink::fRTPPayloadFormatName.

{return fRTPPayloadFormatName;}

unsigned char RTPSink::rtpPayloadType ( ) const

inlineinherited

Definition at line 42 of file RTPSink.hh.

References RTPSink::fRTPPayloadType.

{ return fRTPPayloadType; }

unsigned RTPSink::rtpTimestampFrequency ( ) const

inlineinherited

Definition at line 43 of file RTPSink.hh.

References RTPSink::fTimestampFrequency.

{ return fTimestampFrequency; }

void MultiFramedRTPSink::setFramePadding ( unsigned  numPaddingBytes )

protectedinherited

void MultiFramedRTPSink::setFrameSpecificHeaderBytes ( unsigned char const *  bytes, unsigned  numBytes, unsigned  bytePosition = 0  )

protectedinherited

void MultiFramedRTPSink::setFrameSpecificHeaderWord ( unsigned  word, unsigned  wordPosition = 0  )

protectedinherited

void MultiFramedRTPSink::setMarkerBit ( )

protectedinherited

void MultiFramedRTPSink::setOnSendErrorFunc ( onSendErrorFunc *  onSendErrorFunc, void *  onSendErrorFuncData  )

inlineinherited

Definition at line 34 of file MultiFramedRTPSink.hh.

References MultiFramedRTPSink::fOnSendErrorData, and MultiFramedRTPSink::fOnSendErrorFunc.

                                                                                       {
    // Can be used to set a callback function to be called if there's an error sending RTP packets on our socket.
    fOnSendErrorFunc = onSendErrorFunc;
    fOnSendErrorData = onSendErrorFuncData;
  }

void MultiFramedRTPSink::setPacketSizes ( unsigned  preferredPacketSize, unsigned  maxPacketSize  )

inherited

void RTPSink::setRTPTimestampFrequency ( unsigned  freq )

inlineinherited

Definition at line 44 of file RTPSink.hh.

References RTPSink::fTimestampFrequency.

                                               {
    fTimestampFrequency = freq;
  }

void MultiFramedRTPSink::setSpecialHeaderBytes ( unsigned char const *  bytes, unsigned  numBytes, unsigned  bytePosition = 0  )

protectedinherited

void MultiFramedRTPSink::setSpecialHeaderWord ( unsigned  word, unsigned  wordPosition = 0  )

protectedinherited

void RTPSink::setStreamSocket ( int  sockNum, unsigned char  streamChannelId  )

inlineinherited

Definition at line 78 of file RTPSink.hh.

References RTPSink::fRTPInterface, and RTPInterface::setStreamSocket().

                                                                   {
    fRTPInterface.setStreamSocket(sockNum, streamChannelId);
  }

void MultiFramedRTPSink::setTimestamp ( struct timeval  framePresentationTime )

protectedinherited

FramedSource* MediaSink::source ( ) const

inlineinherited

Definition at line 42 of file MediaSink.hh.

References MediaSink::fSource.

{return fSource;}

virtual Boolean MediaSink::sourceIsCompatibleWithUs ( MediaSource &  source )

protectedvirtualinherited

Reimplemented in H265VideoRTPSink, H264VideoRTPSink, AMRAudioRTPSink, MPEG4ESVideoRTPSink, DVVideoRTPSink, AMRAudioFileSink, JPEGVideoRTPSink, and MPEG1or2VideoRTPSink.

virtual unsigned TheoraVideoRTPSink::specialHeaderSize ( ) const

privatevirtual

Reimplemented from MultiFramedRTPSink.

u_int32_t RTPSink::SSRC ( ) const

inlineinherited

Definition at line 89 of file RTPSink.hh.

References RTPSink::fSSRC.

{return fSSRC;}

Boolean MediaSink::startPlaying ( MediaSource &  source, afterPlayingFunc *  afterFunc, void *  afterClientData  )

inherited

virtual void MultiFramedRTPSink::stopPlaying ( )

virtualinherited

Reimplemented from MediaSink.

RTPTransmissionStatsDB& RTPSink::transmissionStatsDB ( ) const

inlineinherited

Definition at line 61 of file RTPSink.hh.

References RTPSink::fTransmissionStatsDB.

                                                      {
    return *fTransmissionStatsDB;
  }

Field Documentation

u_int32_t RTPSink::fCurrentTimestamp

protectedinherited

Definition at line 114 of file RTPSink.hh.

char* TheoraVideoRTPSink::fFmtpSDPLine

private

Definition at line 69 of file TheoraVideoRTPSink.hh.

u_int32_t TheoraVideoRTPSink::fIdent

private

Definition at line 68 of file TheoraVideoRTPSink.hh.

struct timeval fTotalOctetCountStartTime fInitialPresentationTime RTPSink::fMostRecentPresentationTime

protectedinherited

Definition at line 113 of file RTPSink.hh.

Referenced by RTPSink::mostRecentPresentationTime().

unsigned RTPSink::fOctetCount

protectedinherited

Definition at line 112 of file RTPSink.hh.

Referenced by RTPSink::octetCount().

unsigned RTPSink::fPacketCount

protectedinherited

Definition at line 112 of file RTPSink.hh.

Referenced by RTPSink::packetCount().

RTPInterface RTPSink::fRTPInterface

protectedinherited

Definition at line 110 of file RTPSink.hh.

Referenced by RTPSink::addStreamSocket(), RTPSink::groupsockBeingUsed(), RTPSink::removeStreamSocket(), and RTPSink::setStreamSocket().

unsigned char RTPSink::fRTPPayloadType

protectedinherited

Definition at line 111 of file RTPSink.hh.

Referenced by RTPSink::rtpPayloadType().

u_int16_t RTPSink::fSeqNo

protectedinherited

Definition at line 115 of file RTPSink.hh.

Referenced by RTPSink::currentSeqNo().

FramedSource* MediaSink::fSource

protectedinherited

Definition at line 58 of file MediaSink.hh.

Referenced by MediaSink::source().

unsigned RTPSink::fTotalOctetCount

protectedinherited

Definition at line 112 of file RTPSink.hh.

---

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

• liveMedia/include/TheoraVideoRTPSink.hh