QuickTimeFileSink Class Reference

#include <QuickTimeFileSink.hh>

Inheritance diagram for QuickTimeFileSink:

[legend]Collaboration diagram for QuickTimeFileSink:

[legend]

Public Types
typedef void(	afterPlayingFunc )(void *clientData)
Public Member Functions
Boolean	startPlaying (afterPlayingFunc *afterFunc, void *afterClientData)
unsigned	numActiveSubsessions () const
UsageEnvironment &	envir () const
char const *	name () const
virtual Boolean	isSource () 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 QuickTimeFileSink *	createNew (UsageEnvironment &env, MediaSession &inputSession, char const *outputFileName, unsigned bufferSize=20000, unsigned short movieWidth=240, unsigned short movieHeight=180, unsigned movieFPS=15, Boolean packetLossCompensate=False, Boolean syncStreams=False, Boolean generateHintTracks=False, Boolean generateMP4Format=False)
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
TaskToken &	nextTask ()
Private Member Functions
	QuickTimeFileSink (UsageEnvironment &env, MediaSession &inputSession, FILE *outFid, unsigned bufferSize, unsigned short movieWidth, unsigned short movieHeight, unsigned movieFPS, Boolean packetLossCompensate, Boolean syncStreams, Boolean generateHintTracks, Boolean generateMP4Format)
virtual	~QuickTimeFileSink ()
Boolean	continuePlaying ()
void	onSourceClosure1 ()
void	completeOutputFile ()
unsigned	addWord (unsigned word)
unsigned	addHalfWord (unsigned short halfWord)
unsigned	addByte (unsigned char byte)
unsigned	addZeroWords (unsigned numWords)
unsigned	add4ByteString (char const *str)
unsigned	addArbitraryString (char const *str, Boolean oneByteLength=True)
unsigned	addAtomHeader (char const *atomName)
void	setWord (unsigned filePosn, unsigned size)
unsigned	movieTimeScale () const
	_atom (ftyp)
	_atom (moov)
	_atom (mvhd)
	_atom (iods)
	_atom (trak)
	_atom (tkhd)
	_atom (edts)
	_atom (elst)
	_atom (tref)
	_atom (hint)
	_atom (mdia)
	_atom (mdhd)
	_atom (hdlr)
	_atom (minf)
	_atom (smhd)
	_atom (vmhd)
	_atom (gmhd)
	_atom (gmin)
unsigned	addAtom_hdlr2 ()
	_atom (dinf)
	_atom (dref)
	_atom (alis)
	_atom (stbl)
	_atom (stsd)
unsigned	addAtom_genericMedia ()
unsigned	addAtom_soundMediaGeneral ()
	_atom (ulaw)
	_atom (alaw)
	_atom (Qclp)
	_atom (wave)
	_atom (frma)
	_atom (Fclp)
	_atom (Hclp)
	_atom (mp4a)
	_atom (esds)
	_atom (srcq)
	_atom (h263)
	_atom (avc1)
	_atom (avcC)
	_atom (mp4v)
	_atom (rtp)
	_atom (tims)
	_atom (stts)
	_atom (stsc)
	_atom (stsz)
	_atom (stco)
	_atom (udta)
	_atom (name)
	_atom (hnti)
	_atom (sdp)
	_atom (hinf)
	_atom (totl)
	_atom (npck)
	_atom (tpay)
	_atom (trpy)
	_atom (nump)
	_atom (tpyl)
	_atom (dmed)
	_atom (dimm)
	_atom (drep)
	_atom (tmin)
	_atom (tmax)
	_atom (pmax)
	_atom (dmax)
	_atom (payt)
unsigned	addAtom_dummy ()
Static Private Member Functions
static void	afterGettingFrame (void *clientData, unsigned frameSize, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
static void	onSourceClosure (void *clientData)
static void	onRTCPBye (void *clientData)
Private Attributes
MediaSession &	fInputSession
FILE *	fOutFid
unsigned	fBufferSize
Boolean	fPacketLossCompensate
Boolean	fSyncStreams
Boolean	fGenerateMP4Format
timeval fNewestSyncTime	fFirstDataTime
Boolean	fAreCurrentlyBeingPlayed
afterPlayingFunc *	fAfterFunc
void *	fAfterClientData
unsigned	fAppleCreationTime
unsigned	fLargestRTPtimestampFrequency
unsigned	fNumSubsessions
unsigned	fNumSyncedSubsessions
timeval	fStartTime
Boolean	fHaveCompletedOutputFile
unsigned short	fMovieWidth
unsigned short	fMovieHeight
unsigned	fMovieFPS
unsigned	fMDATposition
unsigned	fMVHD_durationPosn
unsigned	fMaxTrackDurationM
SubsessionIOState *	fCurrentIOState
Friends
class	SubsessionIOState

---

Detailed Description

Definition at line 28 of file QuickTimeFileSink.hh.

---

Member Typedef Documentation

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

Definition at line 42 of file QuickTimeFileSink.hh.

---

Constructor & Destructor Documentation

QuickTimeFileSink::QuickTimeFileSink	(	UsageEnvironment &	env,
		MediaSession &	inputSession,
		FILE *	outFid,
		unsigned	bufferSize,
		unsigned short	movieWidth,
		unsigned short	movieHeight,
		unsigned	movieFPS,
		Boolean	packetLossCompensate,
		Boolean	syncStreams,
		Boolean	generateHintTracks,
		Boolean	generateMP4Format
	)			[private]

Definition at line 206 of file QuickTimeFileSink.cpp.

References addAtomHeader(), fAppleCreationTime, fFirstDataTime, fInputSession, fLargestRTPtimestampFrequency, fMDATposition, fMovieFPS, fMovieHeight, fMovieWidth, fNumSubsessions, fOutFid, fStartTime, iter, MediaSubsession::miscPtr, MediaSubsessionIterator::next(), NULL, onRTCPBye(), MediaSubsession::readSource(), MediaSubsession::rtcpInstance(), MediaSubsession::rtpTimestampFrequency(), RTCPInstance::setByeHandler(), SubsessionIOState::setHintTrack(), SubsessionIOState::setQTstate(), subsession, SubsessionIOState, MediaSubsession::videoFPS(), MediaSubsession::videoHeight(), and MediaSubsession::videoWidth().

Referenced by createNew().

  : Medium(env), fInputSession(inputSession), fOutFid(outFid),
    fBufferSize(bufferSize), fPacketLossCompensate(packetLossCompensate),
    fSyncStreams(syncStreams), fGenerateMP4Format(generateMP4Format),
    fAreCurrentlyBeingPlayed(False),
    fLargestRTPtimestampFrequency(0),
    fNumSubsessions(0), fNumSyncedSubsessions(0),
    fHaveCompletedOutputFile(False),
    fMovieWidth(movieWidth), fMovieHeight(movieHeight),
    fMovieFPS(movieFPS), fMaxTrackDurationM(0) {
  fNewestSyncTime.tv_sec = fNewestSyncTime.tv_usec = 0;
  fFirstDataTime.tv_sec = fFirstDataTime.tv_usec = (unsigned)(~0);

  // Set up I/O state for each input subsession:
  MediaSubsessionIterator iter(fInputSession);
  MediaSubsession* subsession;
  while ((subsession = iter.next()) != NULL) {
    // Ignore subsessions without a data source:
    FramedSource* subsessionSource = subsession->readSource();
    if (subsessionSource == NULL) continue;

    // If "subsession's" SDP description specified screen dimension
    // or frame rate parameters, then use these.  (Note that this must
    // be done before the call to "setQTState()" below.)
    if (subsession->videoWidth() != 0) {
      fMovieWidth = subsession->videoWidth();
    }
    if (subsession->videoHeight() != 0) {
      fMovieHeight = subsession->videoHeight();
    }
    if (subsession->videoFPS() != 0) {
      fMovieFPS = subsession->videoFPS();
    }

    SubsessionIOState* ioState
      = new SubsessionIOState(*this, *subsession);
    if (ioState == NULL || !ioState->setQTstate()) {
      // We're not able to output a QuickTime track for this subsession
      delete ioState; ioState = NULL;
      continue;
    }
    subsession->miscPtr = (void*)ioState;

    if (generateHintTracks) {
      // Also create a hint track for this track:
      SubsessionIOState* hintTrack
        = new SubsessionIOState(*this, *subsession);
      SubsessionIOState::setHintTrack(ioState, hintTrack);
      if (!hintTrack->setQTstate()) {
        delete hintTrack;
        SubsessionIOState::setHintTrack(ioState, NULL);
      }
    }

    // Also set a 'BYE' handler for this subsession's RTCP instance:
    if (subsession->rtcpInstance() != NULL) {
      subsession->rtcpInstance()->setByeHandler(onRTCPBye, ioState);
    }

    unsigned rtpTimestampFrequency = subsession->rtpTimestampFrequency();
    if (rtpTimestampFrequency > fLargestRTPtimestampFrequency) {
      fLargestRTPtimestampFrequency = rtpTimestampFrequency;
    }

    ++fNumSubsessions;
  }

  // Use the current time as the file's creation and modification
  // time.  Use Apple's time format: seconds since January 1, 1904

  gettimeofday(&fStartTime, NULL);
  fAppleCreationTime = fStartTime.tv_sec - 0x83dac000;

  // Begin by writing a "mdat" atom at the start of the file.
  // (Later, when we've finished copying data to the file, we'll come
  // back and fill in its size.)
  fMDATposition = ftell(fOutFid);
  addAtomHeader("mdat");
}

QuickTimeFileSink::~QuickTimeFileSink

(

)

[private, virtual]

Definition at line 296 of file QuickTimeFileSink.cpp.

References completeOutputFile(), SubsessionIOState::fHintTrackForUs, fInputSession, iter, MediaSubsession::miscPtr, MediaSubsessionIterator::next(), NULL, and subsession.

                                      {
  completeOutputFile();

  // Then, delete each active "SubsessionIOState":
  MediaSubsessionIterator iter(fInputSession);
  MediaSubsession* subsession;
  while ((subsession = iter.next()) != NULL) {
    SubsessionIOState* ioState
      = (SubsessionIOState*)(subsession->miscPtr); 
    if (ioState == NULL) continue;

    delete ioState->fHintTrackForUs; // if any
    delete ioState;
  }
}

---

Member Function Documentation

QuickTimeFileSink * QuickTimeFileSink::createNew	(	UsageEnvironment &	env,
		MediaSession &	inputSession,
		char const *	outputFileName,
		unsigned	bufferSize = 20000,
		unsigned short	movieWidth = 240,
		unsigned short	movieHeight = 180,
		unsigned	movieFPS = 15,
		Boolean	packetLossCompensate = False,
		Boolean	syncStreams = False,
		Boolean	generateHintTracks = False,
		Boolean	generateMP4Format = False
	)			[static]

Definition at line 313 of file QuickTimeFileSink.cpp.

References env, NULL, OpenOutputFile(), and QuickTimeFileSink().

Referenced by main().

                                                        {
  do {
    FILE* fid = OpenOutputFile(env, outputFileName);
    if (fid == NULL) break;

    return new QuickTimeFileSink(env, inputSession, fid, bufferSize,
                                 movieWidth, movieHeight, movieFPS,
                                 packetLossCompensate, syncStreams,
                                 generateHintTracks, generateMP4Format);
  } while (0);

  return NULL;
}

Boolean QuickTimeFileSink::startPlaying	(	afterPlayingFunc *	afterFunc,
		void *	afterClientData
	)

Definition at line 337 of file QuickTimeFileSink.cpp.

References continuePlaying(), Medium::envir(), fAfterClientData, fAfterFunc, False, fAreCurrentlyBeingPlayed, UsageEnvironment::setResultMsg(), and True.

Referenced by main().

                                                               {
  // Make sure we're not already being played:
  if (fAreCurrentlyBeingPlayed) {
    envir().setResultMsg("This sink has already been played");
    return False;
  }

  fAreCurrentlyBeingPlayed = True;
  fAfterFunc = afterFunc;
  fAfterClientData = afterClientData;

  return continuePlaying();
}

unsigned QuickTimeFileSink::numActiveSubsessions

(

)

const [inline]

Definition at line 46 of file QuickTimeFileSink.hh.

References fNumSubsessions.

Referenced by checkForPacketArrival().

{ return fNumSubsessions; }

Boolean QuickTimeFileSink::continuePlaying

(

)

[private]

Definition at line 352 of file QuickTimeFileSink.cpp.

References afterGettingFrame(), SubsessionBuffer::bytesAvailable(), SubsessionBuffer::dataEnd(), Medium::envir(), False, SubsessionIOState::fBuffer, fInputSession, FramedSource::getNextFrame(), FramedSource::isCurrentlyAwaitingData(), iter, MediaSubsession::miscPtr, MediaSubsessionIterator::next(), NULL, onSourceClosure(), MediaSubsession::readSource(), UsageEnvironment::setResultMsg(), subsession, and True.

Referenced by SubsessionIOState::afterGettingFrame(), afterGettingFrame(), and startPlaying().

                                           {
  // Run through each of our input session's 'subsessions',
  // asking for a frame from each one:
  Boolean haveActiveSubsessions = False; 
  MediaSubsessionIterator iter(fInputSession);
  MediaSubsession* subsession;
  while ((subsession = iter.next()) != NULL) {
    FramedSource* subsessionSource = subsession->readSource();
    if (subsessionSource == NULL) continue;

    if (subsessionSource->isCurrentlyAwaitingData()) continue;

    SubsessionIOState* ioState
      = (SubsessionIOState*)(subsession->miscPtr); 
    if (ioState == NULL) continue;

    haveActiveSubsessions = True;
    unsigned char* toPtr = ioState->fBuffer->dataEnd();
    unsigned toSize = ioState->fBuffer->bytesAvailable();
    subsessionSource->getNextFrame(toPtr, toSize,
                                   afterGettingFrame, ioState,
                                   onSourceClosure, ioState);
  }
  if (!haveActiveSubsessions) {
    envir().setResultMsg("No subsessions are currently active");
    return False;
  }

  return True;
}

void QuickTimeFileSink::afterGettingFrame	(	void *	clientData,
		unsigned	frameSize,
		unsigned	numTruncatedBytes,
		struct timeval	presentationTime,
		unsigned	durationInMicroseconds
	)			[static, private]

Definition at line 384 of file QuickTimeFileSink.cpp.

References SubsessionIOState::afterGettingFrame(), continuePlaying(), SubsessionIOState::fOurSink, and SubsessionIOState::syncOK().

Referenced by continuePlaying().

                                                         {
  SubsessionIOState* ioState = (SubsessionIOState*)clientData;
  if (!ioState->syncOK(presentationTime)) {
    // Ignore this data:
    ioState->fOurSink.continuePlaying();
    return;
  }
  ioState->afterGettingFrame(packetDataSize, presentationTime);
}

void QuickTimeFileSink::onSourceClosure

(

void *

clientData

)

[static, private]

Definition at line 397 of file QuickTimeFileSink.cpp.

References SubsessionIOState::onSourceClosure().

Referenced by continuePlaying().

                                                        {
  SubsessionIOState* ioState = (SubsessionIOState*)clientData;
  ioState->onSourceClosure();
}

void QuickTimeFileSink::onSourceClosure1

(

)

[private]

Definition at line 402 of file QuickTimeFileSink.cpp.

References completeOutputFile(), fAfterClientData, fAfterFunc, fInputSession, SubsessionIOState::fOurSourceIsActive, iter, MediaSubsession::miscPtr, MediaSubsessionIterator::next(), NULL, and subsession.

Referenced by SubsessionIOState::onSourceClosure().

                                         {
  // Check whether *all* of the subsession sources have closed.
  // If not, do nothing for now:
  MediaSubsessionIterator iter(fInputSession);
  MediaSubsession* subsession;
  while ((subsession = iter.next()) != NULL) {
    SubsessionIOState* ioState
      = (SubsessionIOState*)(subsession->miscPtr); 
    if (ioState == NULL) continue;

    if (ioState->fOurSourceIsActive) return; // this source hasn't closed
  }

  completeOutputFile();

  // Call our specified 'after' function:
  if (fAfterFunc != NULL) {
    (*fAfterFunc)(fAfterClientData);
  }
}

void QuickTimeFileSink::onRTCPBye

(

void *

clientData

)

[static, private]

Definition at line 423 of file QuickTimeFileSink.cpp.

References MediaSubsession::codecName(), SubsessionIOState::envir(), SubsessionIOState::fOurSink, SubsessionIOState::fOurSubsession, fStartTime, MediaSubsession::mediumName(), NULL, SubsessionIOState::onSourceClosure(), and subsession.

Referenced by QuickTimeFileSink().

                                                  {
  SubsessionIOState* ioState = (SubsessionIOState*)clientData;

  struct timeval timeNow;
  gettimeofday(&timeNow, NULL);
  unsigned secsDiff
    = timeNow.tv_sec - ioState->fOurSink.fStartTime.tv_sec;

  MediaSubsession& subsession = ioState->fOurSubsession;
  ioState->envir() << "Received RTCP \"BYE\" on \""
                   << subsession.mediumName()
                   << "/" << subsession.codecName()
                   << "\" subsession (after "
                   << secsDiff << " seconds)\n";

  // Handle the reception of a RTCP "BYE" as if the source had closed:
  ioState->onSourceClosure();
}

void QuickTimeFileSink::completeOutputFile

(

)

[private]

Definition at line 449 of file QuickTimeFileSink.cpp.

References fFirstDataTime, fGenerateMP4Format, fHaveCompletedOutputFile, SubsessionIOState::fHeadChunk, SubsessionIOState::fHintTrackForUs, fInputSession, fMDATposition, fOutFid, ChunkDescriptor::fPresentationTime, SubsessionIOState::hasHintTrack(), iter, MediaSubsession::miscPtr, MediaSubsessionIterator::next(), NULL, MediaSubsessionIterator::reset(), SubsessionIOState::setFinalQTstate(), setWord(), subsession, timevalGE(), and True.

Referenced by onSourceClosure1(), and ~QuickTimeFileSink().

                                           {
  if (fHaveCompletedOutputFile || fOutFid == NULL) return;

  // Begin by filling in the initial "mdat" atom with the current
  // file size:
  unsigned curFileSize = ftell(fOutFid);
  setWord(fMDATposition, curFileSize);

  // Then, note the time of the first received data:
  MediaSubsessionIterator iter(fInputSession);
  MediaSubsession* subsession;
  while ((subsession = iter.next()) != NULL) {
    SubsessionIOState* ioState
      = (SubsessionIOState*)(subsession->miscPtr); 
    if (ioState == NULL) continue;

    ChunkDescriptor* const headChunk = ioState->fHeadChunk;
    if (headChunk != NULL
        && timevalGE(fFirstDataTime, headChunk->fPresentationTime)) {
      fFirstDataTime = headChunk->fPresentationTime;
    }
  }

  // Then, update the QuickTime-specific state for each active track:
  iter.reset();
  while ((subsession = iter.next()) != NULL) {
    SubsessionIOState* ioState
      = (SubsessionIOState*)(subsession->miscPtr); 
    if (ioState == NULL) continue;

    ioState->setFinalQTstate();
    // Do the same for a hint track (if any):
    if (ioState->hasHintTrack()) {
      ioState->fHintTrackForUs->setFinalQTstate();
    }
  }

  if (fGenerateMP4Format) {
    // Begin with a "ftyp" atom:
    addAtom_ftyp();
  }

  // Then, add a "moov" atom for the file metadata:
  addAtom_moov();

  // We're done:
  fHaveCompletedOutputFile = True;
}

unsigned QuickTimeFileSink::addWord

(

unsigned

word

)

[private]

Definition at line 1129 of file QuickTimeFileSink.cpp.

References addByte().

Referenced by addAtom_hdlr2(), addAtomHeader(), addZeroWords(), if(), setWord(), SubsessionIOState::useFrame(), and SubsessionIOState::useFrameForHinting().

                                                 {
  addByte(word>>24); addByte(word>>16);
  addByte(word>>8); addByte(word);

  return 4;
}

unsigned QuickTimeFileSink::addHalfWord

(

unsigned short

halfWord

)

[private]

Definition at line 1136 of file QuickTimeFileSink.cpp.

References addByte().

Referenced by addAtom_hdlr2(), and SubsessionIOState::useFrameForHinting().

                                                               {
  addByte((unsigned char)(halfWord>>8)); addByte((unsigned char)halfWord);

  return 2;
}

unsigned QuickTimeFileSink::addByte

(

unsigned char

byte

)

[inline, private]

Definition at line 90 of file QuickTimeFileSink.hh.

References fOutFid.

Referenced by add4ByteString(), addArbitraryString(), addAtom_hdlr2(), addHalfWord(), addWord(), and SubsessionIOState::useFrameForHinting().

                                       {
    putc(byte, fOutFid);
    return 1;
  }

unsigned QuickTimeFileSink::addZeroWords

(

unsigned

numWords

)

[private]

Definition at line 1142 of file QuickTimeFileSink.cpp.

References addWord().

Referenced by addAtom_hdlr2().

                                                          {
  for (unsigned i = 0; i < numWords; ++i) {
    addWord(0);
  }

  return numWords*4;
}

unsigned QuickTimeFileSink::add4ByteString

(

char const *

str

)

[private]

Definition at line 1150 of file QuickTimeFileSink.cpp.

References addByte().

Referenced by addAtom_hdlr2(), and addAtomHeader().

                                                          {
  addByte(str[0]); addByte(str[1]); addByte(str[2]); addByte(str[3]);

  return 4;
}

unsigned QuickTimeFileSink::addArbitraryString	(	char const *	str,
		Boolean	oneByteLength = True
	)			[private]

Definition at line 1156 of file QuickTimeFileSink.cpp.

References addByte(), Medium::envir(), and size.

Referenced by addAtom_hdlr2().

                                                                      {
  unsigned size = 0;
  if (oneByteLength) {
    // Begin with a byte containing the string length:
    unsigned strLength = strlen(str);
    if (strLength >= 256) {
      envir() << "QuickTimeFileSink::addArbitraryString(\""
              << str << "\") saw string longer than we know how to handle ("
              << strLength << "\n";
    }
    size += addByte((unsigned char)strLength);