MP3FileSource Class Reference

#include <MP3FileSource.hh>

Inheritance diagram for MP3FileSource:

[legend]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
void	setPresentationTimeScale (unsigned scale)
void	seekWithinFile (float seekNPT)
void	getNextFrame (unsigned char to, unsigned maxSize, afterGettingFunc afterGettingFunc, void afterGettingClientData, onCloseFunc onCloseFunc, void *onCloseClientData)
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	isJPEGVideoSource () const
virtual Boolean	isAMRAudioSource () 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
virtual Boolean	isDarwinInjector () 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	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 ()
Static Protected Member Functions
static void	afterGetting (FramedSource *source)
Protected Attributes
FILE *	fFid
unsigned char *	fTo
unsigned	fMaxSize
unsigned	fFrameSize
unsigned	fNumTruncatedBytes
timeval	fPresentationTime
unsigned	fDurationInMicroseconds
Private Member Functions
virtual void	doGetNextFrame ()
virtual char const *	MIMEtype () const
virtual void	getAttributes () const
virtual Boolean	doGetNextFrame1 ()
Private Attributes
MP3StreamState *	fStreamState
Boolean	fHaveJustInitialized
timeval	fFirstFramePresentationTime

Detailed Description

Definition at line 30 of file MP3FileSource.hh.

Member Typedef Documentation

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

Definition at line 36 of file FramedSource.hh.

typedef void( FramedSource::onCloseFunc)(void *clientData) [inherited]

Definition at line 40 of file FramedSource.hh.

Constructor & Destructor Documentation

MP3FileSource::MP3FileSource	(	UsageEnvironment &	env,
		FILE *	fid
	)			`[protected]`

Definition at line 27 of file MP3FileSource.cpp.

Referenced by createNew().

00028   : FramedFileSource(env, fid),
00029     fStreamState(new MP3StreamState(env)) {
00030 }

MP3FileSource::~MP3FileSource ( ) [protected, virtual]

Definition at line 32 of file MP3FileSource.cpp.

References fStreamState.

00032                               {
00033   delete fStreamState;
00034 }

Member Function Documentation

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

Definition at line 40 of file MP3FileSource.cpp.

References assignStream(), Medium::close(), env, GetFileSize(), initializeStream(), MP3FileSource(), NULL, and OpenInputFile().

Referenced by MP3AudioFileServerMediaSubsession::createNewStreamSource().

00040                                                                                    {
00041   MP3FileSource* newSource = NULL;
00042 
00043   do {
00044     FILE* fid;
00045 
00046     fid = OpenInputFile(env, fileName);
00047     if (fid == NULL) break;
00048 
00049     newSource = new MP3FileSource(env, fid);
00050     if (newSource == NULL) break;
00051 
00052     unsigned fileSize = (unsigned)GetFileSize(fileName, fid);
00053     newSource->assignStream(fid, fileSize);
00054     if (!newSource->initializeStream()) break;
00055 
00056     return newSource;
00057   } while (0);
00058 
00059   Medium::close(newSource);
00060   return NULL;
00061 }

float MP3FileSource::filePlayTime ( ) const

Definition at line 63 of file MP3FileSource.cpp.

References MP3StreamState::filePlayTime(), and fStreamState.

Referenced by MP3AudioFileServerMediaSubsession::createNewStreamSource().

00063                                         {
00064   return fStreamState->filePlayTime();
00065 }

void MP3FileSource::setPresentationTimeScale ( unsigned scale )

Definition at line 67 of file MP3FileSource.cpp.

References fStreamState, and MP3StreamState::setPresentationTimeScale().

Referenced by MP3AudioFileServerMediaSubsession::setStreamSourceScale().

00067                                                            {
00068   fStreamState->setPresentationTimeScale(scale);
00069 }

void MP3FileSource::seekWithinFile ( float seekNPT )

Definition at line 71 of file MP3FileSource.cpp.

References fStreamState, and MP3StreamState::seekWithinFile().

Referenced by MP3AudioFileServerMediaSubsession::seekStreamSource().

00071                                                 {
00072   fStreamState->seekWithinFile(seekNPT);
00073 }

void MP3FileSource::assignStream	(	FILE *	fid,
		unsigned	filesize
	)			`[protected]`

Definition at line 123 of file MP3FileSource.cpp.

References MP3StreamState::assignStream(), and fStreamState.

Referenced by MP3HTTPSource::createNew(), and createNew().

00123                                                              {
00124   fStreamState->assignStream(fid, fileSize);
00125 }

Boolean MP3FileSource::initializeStream ( ) [protected]

Definition at line 128 of file MP3FileSource.cpp.

References MP3StreamState::checkForXingHeader(), Medium::envir(), False, fFirstFramePresentationTime, fHaveJustInitialized, MP3StreamState::findNextHeader(), fStreamState, Medium::name(), UsageEnvironment::setResultMsg(), and True.

Referenced by MP3HTTPSource::createNew(), and createNew().

00128                                         {
00129   // Make sure the file has an appropriate header near the start:
00130   if (fStreamState->findNextHeader(fFirstFramePresentationTime) == 0) {
00131       envir().setResultMsg("not an MPEG audio file");
00132       return False;
00133   }
00134 
00135   fStreamState->checkForXingHeader(); // in case this is a VBR file
00136 
00137   fHaveJustInitialized = True;
00138   // Hack: It's possible that our environment's 'result message' has been
00139   // reset within this function, so set it again to our name now:
00140   envir().setResultMsg(name());
00141   return True;
00142 }

MP3StreamState* MP3FileSource::streamState ( ) [inline, protected]

Definition at line 48 of file MP3FileSource.hh.

References fStreamState.

Referenced by MP3HTTPSource::writeGetCmd().

00048 {return fStreamState;}

void MP3FileSource::doGetNextFrame ( ) [private, virtual]

Implements FramedSource.

Definition at line 81 of file MP3FileSource.cpp.

References FramedSource::afterGetting(), doGetNextFrame1(), Medium::envir(), FramedSource::handleClosure(), Medium::nextTask(), TaskScheduler::scheduleDelayedTask(), and UsageEnvironment::taskScheduler().

00081                                    {
00082   if (!doGetNextFrame1()) {
00083     handleClosure(this);
00084     return;
00085   }
00086 
00087   // Switch to another task:
00088 #if defined(__WIN32__) || defined(_WIN32)
00089   // HACK: liveCaster/lc uses an implementation of scheduleDelayedTask()
00090   // that performs very badly (chewing up lots of CPU time, apparently polling)
00091   // on Windows.  Until this is fixed, we just call our "afterGetting()"
00092   // function directly.  This avoids infinite recursion, as long as our sink
00093   // is discontinuous, which is the case for the RTP sink that liveCaster/lc
00094   // uses. #####
00095   afterGetting(this);
00096 #else
00097   nextTask() = envir().taskScheduler().scheduleDelayedTask(0,
00098                                 (TaskFunc*)afterGetting, this);
00099 #endif
00100 }

char const * MP3FileSource::MIMEtype ( ) const [private, virtual]

Reimplemented from MediaSource.

Definition at line 36 of file MP3FileSource.cpp.

00036                                           {
00037   return "audio/MPEG";
00038 }

void MP3FileSource::getAttributes ( ) const [private, virtual]

Reimplemented from MediaSource.

Definition at line 75 of file MP3FileSource.cpp.

References Medium::envir(), fStreamState, MP3StreamState::getAttributes(), and UsageEnvironment::setResultMsg().

00075                                         {
00076   char buffer[200];
00077   fStreamState->getAttributes(buffer, sizeof buffer);
00078   envir().setResultMsg(buffer);
00079 }

Boolean MP3FileSource::doGetNextFrame1 ( ) [private, virtual]

Definition at line 102 of file MP3FileSource.cpp.

References Medium::envir(), False, FramedSource::fDurationInMicroseconds, fFirstFramePresentationTime, FramedSource::fFrameSize, fHaveJustInitialized, MP3StreamState::findNextHeader(), FramedSource::fMaxSize, FramedSource::fPresentationTime, fStreamState, FramedSource::fTo, MP3StreamState::readFrame(), UsageEnvironment::setResultMsg(), and True.

Referenced by doGetNextFrame().

00102                                        {
00103   if (!fHaveJustInitialized) {
00104     if (fStreamState->findNextHeader(fPresentationTime) == 0) return False;
00105   } else {
00106     fPresentationTime = fFirstFramePresentationTime;
00107     fHaveJustInitialized = False;
00108   }
00109 
00110   if (!fStreamState->readFrame(fTo, fMaxSize, fFrameSize, fDurationInMicroseconds)) {
00111     char tmp[200];
00112     sprintf(tmp,
00113             "Insufficient buffer size %d for reading MPEG audio frame (needed %d)\n",
00114             fMaxSize, fFrameSize);
00115     envir().setResultMsg(tmp);
00116     fFrameSize = fMaxSize;
00117     return False;
00118   }
00119 
00120   return True;
00121 }

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

Definition at line 41 of file FramedSource.cpp.

References env, False, MediaSource::isFramedSource(), MediaSource::lookupByName(), NULL, and True.

Referenced by MP3ADUinterleaverBase::getInputSource().

00042                                                                 {
00043   resultSource = NULL; // unless we succeed
00044 
00045   MediaSource* source;
00046   if (!MediaSource::lookupByName(env, sourceName, source)) return False;
00047 
00048   if (!source->isFramedSource()) {
00049     env.setResultMsg(sourceName, " is not a framed source");
00050     return False;
00051   }
00052 
00053   resultSource = (FramedSource*)source;
00054   return True;
00055 }

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

Definition at line 62 of file MediaSource.cpp.

References env, False, Medium::isSource(), Medium::lookupByName(), NULL, and True.

Referenced by RTPSource::lookupByName(), and FramedSource::lookupByName().

00064                                                               {
00065   resultSource = NULL; // unless we succeed
00066 
00067   Medium* medium;
00068   if (!Medium::lookupByName(env, sourceName, medium)) return False;
00069 
00070   if (!medium->isSource()) {
00071     env.setResultMsg(sourceName, " is not a media source");
00072     return False;
00073   }
00074 
00075   resultSource = (MediaSource*)medium;
00076   return True;
00077 }

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

Definition at line 65 of file Media.cpp.

References env, False, MediaLookupTable::lookup(), NULL, MediaLookupTable::ourMedia(), UsageEnvironment::setResultMsg(), and True.

Referenced by ServerMediaSession::lookupByName(), RTSPServer::lookupByName(), RTSPClient::lookupByName(), RTCPInstance::lookupByName(), MediaSource::lookupByName(), MediaSink::lookupByName(), MediaSession::lookupByName(), and DarwinInjector::lookupByName().

00066                                                          {
00067   resultMedium = MediaLookupTable::ourMedia(env)->lookup(mediumName);
00068   if (resultMedium == NULL) {
00069     env.setResultMsg("Medium ", mediumName, " does not exist");
00070     return False;
00071   }
00072 
00073   return True;
00074 }

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

Definition at line 57 of file FramedSource.cpp.

References FramedSource::doGetNextFrame(), Medium::envir(), FramedSource::fAfterGettingClientData, FramedSource::fAfterGettingFunc, FramedSource::fDurationInMicroseconds, FramedSource::fIsCurrentlyAwaitingData, FramedSource::fMaxSize, FramedSource::fNumTruncatedBytes, FramedSource::fOnCloseClientData, FramedSource::fOnCloseFunc, FramedSource::fTo, and True.

00061                                                          {
00062   // Make sure we're not already being read:
00063   if (fIsCurrentlyAwaitingData) {
00064     envir() << "FramedSource[" << this << "]::getNextFrame(): attempting to read more than once at the same time!\n";
00065     exit(1);
00066   }
00067 
00068   fTo = to;
00069   fMaxSize = maxSize;
00070   fNumTruncatedBytes = 0; // by default; could be changed by doGetNextFrame()
00071   fDurationInMicroseconds = 0; // by default; could be changed by doGetNextFrame()
00072   fAfterGettingFunc = afterGettingFunc;
00073   fAfterGettingClientData = afterGettingClientData;
00074   fOnCloseFunc = onCloseFunc;
00075   fOnCloseClientData = onCloseClientData;
00076   fIsCurrentlyAwaitingData = True;
00077 
00078   doGetNextFrame();
00079 }

void FramedSource::handleClosure ( void * clientData ) [static, inherited]

Definition at line 95 of file FramedSource.cpp.

References False, FramedSource::fIsCurrentlyAwaitingData, FramedSource::fOnCloseClientData, FramedSource::fOnCloseFunc, and NULL.

00095                                                  {
00096   FramedSource* source = (FramedSource*)clientData;
00097   source->fIsCurrentlyAwaitingData = False; // because we got a close instead
00098   if (source->fOnCloseFunc != NULL) {
00099     (*(source->fOnCloseFunc))(source->fOnCloseClientData);
00100   }
00101 }

void FramedSource::stopGettingFrames ( ) [inherited]

Definition at line 103 of file FramedSource.cpp.

References FramedSource::doStopGettingFrames(), False, and FramedSource::fIsCurrentlyAwaitingData.

Referenced by MPEG2TransportStreamFromPESSource::doStopGettingFrames(), FramedFilter::doStopGettingFrames(), AMRDeinterleaver::doStopGettingFrames(), and MediaSink::stopPlaying().

00103                                      {
00104   fIsCurrentlyAwaitingData = False; // indicates that we can be read again
00105 
00106   // Perform any specialized action now:
00107   doStopGettingFrames();
00108 }

unsigned FramedSource::maxFrameSize ( ) const [virtual, inherited]

Reimplemented in MPEG1or2DemuxedElementaryStream.

Definition at line 116 of file FramedSource.cpp.

Referenced by StreamParser::ensureValidBytes1().

00116                                           {
00117   // By default, this source has no maximum frame size.
00118   return 0;
00119 }

Boolean FramedSource::isCurrentlyAwaitingData ( ) const [inline, inherited]

Definition at line 60 of file FramedSource.hh.

References FramedSource::fIsCurrentlyAwaitingData.

Referenced by afterPlaying(), InputESSourceRecord::askForNewData(), MPEG2TransportStreamFromESSource::awaitNewBuffer(), QuickTimeFileSink::continuePlaying(), AVIFileSink::continuePlaying(), DeviceSource::deliverFrame(), QCELPDeinterleaver::doGetNextFrame(), AMRDeinterleaver::doGetNextFrame(), ByteStreamFileSource::fileReadableHandler(), and BasicUDPSource::incomingPacketHandler1().

00060 {return fIsCurrentlyAwaitingData;}

void FramedSource::afterGetting ( FramedSource * source ) [static, protected, inherited]

Definition at line 81 of file FramedSource.cpp.

References FramedSource::fAfterGettingClientData, FramedSource::fAfterGettingFunc, False, FramedSource::fDurationInMicroseconds, FramedSource::fFrameSize, FramedSource::fIsCurrentlyAwaitingData, FramedSource::fNumTruncatedBytes, FramedSource::fPresentationTime, and NULL.

00081                                                     {
00082   source->fIsCurrentlyAwaitingData = False;
00083       // indicates that we can be read again
00084       // Note that this needs to be done here, in case the "fAfterFunc"
00085       // called below tries to read another frame (which it usually will)
00086 
00087   if (source->fAfterGettingFunc != NULL) {
00088     (*(source->fAfterGettingFunc))(source->fAfterGettingClientData,
00089                                    source->fFrameSize, source->fNumTruncatedBytes,
00090                                    source->fPresentationTime,
00091                                    source->fDurationInMicroseconds);
00092   }
00093 }

void FramedSource::doStopGettingFrames ( ) [protected, virtual, inherited]

Reimplemented in AMRDeinterleaver, BasicUDPSource, ByteStreamFileSource, FramedFilter, MPEG1or2DemuxedElementaryStream, MPEG2TransportStreamFramer, MPEG2TransportStreamFromESSource, MPEG2TransportStreamFromPESSource, MPEG2TransportStreamTrickModeFilter, and MultiFramedRTPSource.

Definition at line 110 of file FramedSource.cpp.

Referenced by FramedSource::stopGettingFrames().

00110                                        {
00111   // Default implementation: Do nothing
00112   // Subclasses may wish to specialize this so as to ensure that a
00113   // subsequent reader can pick up where this one left off.
00114 }

Boolean MediaSource::isRTPSource ( ) const [virtual, inherited]

Reimplemented in RTPSource.

Definition at line 43 of file MediaSource.cpp.

References False.

Referenced by RTPSource::lookupByName().

00043                                        {
00044   return False; // default implementation
00045 }

Boolean MediaSource::isMPEG1or2VideoStreamFramer ( ) const [virtual, inherited]

Reimplemented in MPEG1or2VideoStreamFramer.

Definition at line 46 of file MediaSource.cpp.

References False.

Referenced by MPEG1or2VideoRTPSink::sourceIsCompatibleWithUs().

00046                                                        {
00047   return False; // default implementation
00048 }

Boolean MediaSource::isMPEG4VideoStreamFramer ( ) const [virtual, inherited]

Reimplemented in MPEG4VideoStreamFramer.

Definition at line 49 of file MediaSource.cpp.

References False.

Referenced by MPEG4ESVideoRTPSink::sourceIsCompatibleWithUs().

00049                                                     {
00050   return False; // default implementation
00051 }

Boolean MediaSource::isH264VideoStreamFramer ( ) const [virtual, inherited]

Reimplemented in H264VideoStreamFramer.

Definition at line 52 of file MediaSource.cpp.

References False.

Referenced by H264VideoRTPSink::sourceIsCompatibleWithUs().

00052                                                    {
00053   return False; // default implementation
00054 }

Boolean MediaSource::isJPEGVideoSource ( ) const [virtual, inherited]

Reimplemented in JPEGVideoSource.

Definition at line 55 of file MediaSource.cpp.

References False.

Referenced by JPEGVideoRTPSink::sourceIsCompatibleWithUs().

00055                                              {
00056   return False; // default implementation
00057 }

Boolean MediaSource::isAMRAudioSource ( ) const [virtual, inherited]

Reimplemented in AMRAudioSource.

Definition at line 58 of file MediaSource.cpp.

References False.

Referenced by AMRAudioRTPSink::sourceIsCompatibleWithUs(), and AMRAudioFileSink::sourceIsCompatibleWithUs().

00058                                             {
00059   return False; // default implementation
00060 }

void Medium::close	(	UsageEnvironment &	env,
		char const *	mediumName
	)			`[static, inherited]`

Definition at line 76 of file Media.cpp.

References env, MediaLookupTable::ourMedia(), and MediaLookupTable::remove().

00076                                                           {
00077   MediaLookupTable::ourMedia(env)->remove(name);
00078 }

void Medium::close ( Medium * medium ) [static, inherited]

Definition at line 80 of file Media.cpp.

References Medium::close(), Medium::envir(), Medium::name(), and NULL.

00080                                  {
00081   if (medium == NULL) return;
00082 
00083   close(medium->envir(), medium->name());
00084 }

UsageEnvironment& Medium::envir ( ) const [inline, inherited]

Definition at line 59 of file Media.hh.

References Medium::fEnviron.

MP3FileSource Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation