ByteStreamFileSource Class Reference

#include <ByteStreamFileSource.hh>

Inheritance diagram for ByteStreamFileSource:

Collaboration diagram for ByteStreamFileSource:

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

Public Member Functions
u_int64_t	fileSize () const
void	seekToByteAbsolute (u_int64_t byteNumber, u_int64_t numBytesToStream=0)
void	seekToByteRelative (int64_t offset, u_int64_t numBytesToStream=0)
void	seekToEnd ()
void	getNextFrame (unsigned char *to, unsigned maxSize, afterGettingFunc *afterGettingFunc, void *afterGettingClientData, onCloseFunc *onCloseFunc, void *onCloseClientData)
void	handleClosure ()
void	stopGettingFrames ()
virtual unsigned	maxFrameSize () const
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 ByteStreamFileSource *	createNew (UsageEnvironment &env, char const *fileName, unsigned preferredFrameSize=0, unsigned playTimePerFrame=0)
static ByteStreamFileSource *	createNew (UsageEnvironment &env, FILE *fid, unsigned preferredFrameSize=0, unsigned playTimePerFrame=0)
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
	ByteStreamFileSource (UsageEnvironment &env, FILE *fid, unsigned preferredFrameSize, unsigned playTimePerFrame)
virtual	~ByteStreamFileSource ()
void	doReadFromFile ()
TaskToken &	nextTask ()

Static Protected Member Functions
static void	fileReadableHandler (ByteStreamFileSource *source, int mask)

Protected Attributes
u_int64_t	fFileSize
FILE *	fFid
unsigned char *	fTo
unsigned	fMaxSize
unsigned	fFrameSize
unsigned	fNumTruncatedBytes
struct timeval	fPresentationTime
unsigned	fDurationInMicroseconds

Private Member Functions
virtual void	doGetNextFrame ()
virtual void	doStopGettingFrames ()
virtual Boolean	isFramedSource () const
virtual Boolean	isSource () const

Private Attributes
unsigned	fPreferredFrameSize
unsigned	fPlayTimePerFrame
Boolean	fFidIsSeekable
unsigned	fLastPlayTime
Boolean	fHaveStartedReading
Boolean	fLimitNumBytesToStream
u_int64_t	fNumBytesToStream
afterGettingFunc *	fAfterGettingFunc
void *	fAfterGettingClientData
onCloseFunc *	fOnCloseFunc
void *	fOnCloseClientData
Boolean	fIsCurrentlyAwaitingData
UsageEnvironment &	fEnviron
char	fMediumName [mediumNameMaxLen]
TaskToken	fNextTask

Detailed Description

Definition at line 28 of file ByteStreamFileSource.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

ByteStreamFileSource()

ByteStreamFileSource::ByteStreamFileSource ( UsageEnvironment & env, FILE * fid, unsigned preferredFrameSize, unsigned playTimePerFrame )

protected

Referenced by createNew(), createNew(), and fileReadableHandler().

~ByteStreamFileSource()

virtual ByteStreamFileSource::~ByteStreamFileSource ( )

protectedvirtual

Member Function Documentation

afterGetting()

void FramedSource::afterGetting ( FramedSource * source )

staticinherited

References FramedSource().

close() [1/2]

void Medium::close ( Medium * medium )

staticinherited

References Medium().

close() [2/2]

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

staticinherited

createNew() [1/2]

ByteStreamFileSource * ByteStreamFileSource::createNew ( UsageEnvironment & env, char const * fileName, unsigned preferredFrameSize = 0, unsigned playTimePerFrame = 0 )

static

References ByteStreamFileSource().

createNew() [2/2]

ByteStreamFileSource * ByteStreamFileSource::createNew ( UsageEnvironment & env, FILE * fid, unsigned preferredFrameSize = 0, unsigned playTimePerFrame = 0 )

static

References ByteStreamFileSource().

doGetNextFrame()

virtual void ByteStreamFileSource::doGetNextFrame ( )

privatevirtual

Implements FramedSource.

doReadFromFile()

void ByteStreamFileSource::doReadFromFile ( )

protected

doStopGettingFrames()

virtual void ByteStreamFileSource::doStopGettingFrames ( )

privatevirtual

Reimplemented from FramedSource.

envir()

UsageEnvironment & Medium::envir ( ) const

inlineinherited

Definition at line 59 of file Media.hh.

{return fEnviron;}

References fEnviron.

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

fileReadableHandler()

void ByteStreamFileSource::fileReadableHandler ( ByteStreamFileSource * source, int mask )

staticprotected

References ByteStreamFileSource().

fileSize()

u_int64_t ByteStreamFileSource::fileSize ( ) const

inline

Definition at line 44 of file ByteStreamFileSource.hh.

{ return fFileSize; }

References fFileSize.

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 )

inherited

handleClosure() [1/2]

void FramedSource::handleClosure ( )

inherited

handleClosure() [2/2]

void FramedSource::handleClosure ( void * clientData )

staticinherited

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 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 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]

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

staticinherited

References FramedSource().

lookupByName() [2/3]

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

staticinherited

References MediaSource().

lookupByName() [3/3]

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

staticinherited

References Medium().

maxFrameSize()

virtual unsigned FramedSource::maxFrameSize ( ) const

virtualinherited

Reimplemented in BasicUDPSource, and MPEG1or2DemuxedElementaryStream.

MIMEtype()

virtual char const * MediaSource::MIMEtype ( ) const

virtualinherited

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

name()

char const * Medium::name ( ) const

inlineinherited

Definition at line 61 of file Media.hh.

{return fMediumName;}

References fMediumName.

Referenced by QuickTimeFileSink::_atom(), RTSPServer::lookupByName(), RTCPInstance::sendAppPacket(), and OnDemandServerMediaSubsession::sendRTCPAppPacket().

nextTask()

TaskToken & Medium::nextTask ( )

inlineprotectedinherited

Definition at line 77 of file Media.hh.

                        {
        return fNextTask;
  }

References fNextTask.

seekToByteAbsolute()

void ByteStreamFileSource::seekToByteAbsolute	(	u_int64_t	byteNumber,
		u_int64_t	numBytesToStream = 0 )

seekToByteRelative()

void ByteStreamFileSource::seekToByteRelative	(	int64_t	offset,
		u_int64_t	numBytesToStream = 0 )

seekToEnd()

void ByteStreamFileSource::seekToEnd

(

)

stopGettingFrames()

void FramedSource::stopGettingFrames ( )

inherited

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.

fDurationInMicroseconds

unsigned FramedSource::fDurationInMicroseconds

protectedinherited

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

fFid

FILE* FramedFileSource::fFid

protectedinherited

Definition at line 34 of file FramedFileSource.hh.

fFidIsSeekable

Boolean ByteStreamFileSource::fFidIsSeekable

private

Definition at line 75 of file ByteStreamFileSource.hh.

fFileSize

u_int64_t ByteStreamFileSource::fFileSize

protected

Definition at line 70 of file ByteStreamFileSource.hh.

Referenced by fileSize().

fFrameSize

unsigned FramedSource::fFrameSize

protectedinherited

Definition at line 77 of file FramedSource.hh.

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

fHaveStartedReading

Boolean ByteStreamFileSource::fHaveStartedReading

private

Definition at line 77 of file ByteStreamFileSource.hh.

fIsCurrentlyAwaitingData

Boolean FramedSource::fIsCurrentlyAwaitingData

privateinherited

Definition at line 92 of file FramedSource.hh.

Referenced by isCurrentlyAwaitingData().

fLastPlayTime

unsigned ByteStreamFileSource::fLastPlayTime

private

Definition at line 76 of file ByteStreamFileSource.hh.

fLimitNumBytesToStream

Boolean ByteStreamFileSource::fLimitNumBytesToStream

private

Definition at line 78 of file ByteStreamFileSource.hh.

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

fNextTask

TaskToken Medium::fNextTask

privateinherited

Definition at line 84 of file Media.hh.

Referenced by nextTask().

fNumBytesToStream

u_int64_t ByteStreamFileSource::fNumBytesToStream

private

Definition at line 79 of file ByteStreamFileSource.hh.

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.

fPlayTimePerFrame

unsigned ByteStreamFileSource::fPlayTimePerFrame

private

Definition at line 74 of file ByteStreamFileSource.hh.

fPreferredFrameSize

unsigned ByteStreamFileSource::fPreferredFrameSize

private

Definition at line 73 of file ByteStreamFileSource.hh.

fPresentationTime

struct timeval FramedSource::fPresentationTime

protectedinherited

Definition at line 79 of file FramedSource.hh.

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

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