MP3FileSource Class Reference

#include <MP3FileSource.hh>

Inheritance diagram for MP3FileSource:

Collaboration diagram for MP3FileSource:

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

Public Member Functions
float	filePlayTime () const
unsigned	fileSize () const
void	setPresentationTimeScale (unsigned scale)
void	seekWithinFile (double seekNPT, double streamDuration)
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 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 MP3FileSource *	createNew (UsageEnvironment &env, char const *fileName)
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
	MP3FileSource (UsageEnvironment &env, FILE *fid)
virtual	~MP3FileSource ()
void	assignStream (FILE *fid, unsigned filesize)
Boolean	initializeStream ()
MP3StreamState *	streamState ()
virtual void	doStopGettingFrames ()
TaskToken &	nextTask ()

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

Private Member Functions
virtual void	doGetNextFrame ()
virtual char const *	MIMEtype () const
virtual void	getAttributes () const
virtual Boolean	isFramedSource () const
virtual Boolean	isSource () const

Static Private Member Functions
static void	fileReadableHandler (MP3FileSource *source, int mask)

Private Attributes
MP3StreamState *	fStreamState
Boolean	fFidIsSeekable
Boolean	fHaveStartedReading
unsigned	fHaveBeenInitialized
struct timeval	fFirstFramePresentationTime
Boolean	fLimitNumBytesToStream
unsigned	fNumBytesToStream
afterGettingFunc *	fAfterGettingFunc
void *	fAfterGettingClientData
onCloseFunc *	fOnCloseFunc
void *	fOnCloseClientData
Boolean	fIsCurrentlyAwaitingData
UsageEnvironment &	fEnviron
char	fMediumName [mediumNameMaxLen]
TaskToken	fNextTask

Detailed Description

Definition at line 30 of file MP3FileSource.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

MP3FileSource()

MP3FileSource::MP3FileSource ( UsageEnvironment &  env, FILE *  fid  )

protected

~MP3FileSource()

virtual MP3FileSource::~MP3FileSource ( )

protectedvirtual

Member Function Documentation

afterGetting()

static void FramedSource::afterGetting ( FramedSource *  source )

staticinherited

assignStream()

void MP3FileSource::assignStream ( FILE *  fid, unsigned  filesize  )

protected

close() [1/2]

static void Medium::close ( Medium *  medium )

staticinherited

close() [2/2]

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

staticinherited

createNew()

static MP3FileSource * MP3FileSource::createNew ( UsageEnvironment &  env, char const *  fileName  )

static

doGetNextFrame()

virtual void MP3FileSource::doGetNextFrame ( )

privatevirtual

Implements FramedSource.

doStopGettingFrames()

virtual void FramedSource::doStopGettingFrames ( )

protectedvirtualinherited

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

filePlayTime()

float MP3FileSource::filePlayTime

(

)

const

fileReadableHandler()

static void MP3FileSource::fileReadableHandler ( MP3FileSource *  source, int  mask  )

staticprivate

fileSize()

unsigned MP3FileSource::fileSize

(

)

const

getAttributes()

virtual void MP3FileSource::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

initializeStream()

Boolean MP3FileSource::initializeStream ( )

protected

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

staticinherited

lookupByName() [3/3]

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

staticinherited

maxFrameSize()

virtual unsigned FramedSource::maxFrameSize ( ) const

virtualinherited

Reimplemented in BasicUDPSource, and MPEG1or2DemuxedElementaryStream.

MIMEtype()

virtual char const * MP3FileSource::MIMEtype ( ) const

privatevirtual

Reimplemented from MediaSource.

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.

seekWithinFile()

void MP3FileSource::seekWithinFile	(	double	seekNPT,
		double	streamDuration
	)

setPresentationTimeScale()

void MP3FileSource::setPresentationTimeScale

(

unsigned

scale

)

stopGettingFrames()

void FramedSource::stopGettingFrames ( )

inherited

streamState()

MP3StreamState * MP3FileSource::streamState ( )

inlineprotected

Definition at line 50 of file MP3FileSource.hh.

{return fStreamState;}

References fStreamState.

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

fFid

FILE* FramedFileSource::fFid

protectedinherited

Definition at line 34 of file FramedFileSource.hh.

fFidIsSeekable

Boolean MP3FileSource::fFidIsSeekable

private

Definition at line 63 of file MP3FileSource.hh.

fFirstFramePresentationTime

struct timeval MP3FileSource::fFirstFramePresentationTime

private

Definition at line 66 of file MP3FileSource.hh.

fFrameSize

unsigned FramedSource::fFrameSize

protectedinherited

Definition at line 77 of file FramedSource.hh.

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

fHaveBeenInitialized

unsigned MP3FileSource::fHaveBeenInitialized

private

Definition at line 65 of file MP3FileSource.hh.

fHaveStartedReading

Boolean MP3FileSource::fHaveStartedReading

private

Definition at line 64 of file MP3FileSource.hh.

fIsCurrentlyAwaitingData

Boolean FramedSource::fIsCurrentlyAwaitingData

privateinherited

Definition at line 92 of file FramedSource.hh.

Referenced by FramedSource::isCurrentlyAwaitingData().

fLimitNumBytesToStream

Boolean MP3FileSource::fLimitNumBytesToStream

private

Definition at line 67 of file MP3FileSource.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 Medium::name().

fNextTask

TaskToken Medium::fNextTask

privateinherited

Definition at line 84 of file Media.hh.

Referenced by Medium::nextTask().

fNumBytesToStream

unsigned MP3FileSource::fNumBytesToStream

private

Definition at line 68 of file MP3FileSource.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.

fPresentationTime

struct timeval FramedSource::fPresentationTime

protectedinherited

Definition at line 79 of file FramedSource.hh.

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

fStreamState

MP3StreamState* MP3FileSource::fStreamState

private

Definition at line 62 of file MP3FileSource.hh.

Referenced by streamState().

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