MprFromFile.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2008 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _MprFromFile_h_
#define _MprFromFile_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/MpFlowGraphMsg.h"
#include "mp/MpAudioResource.h"
#include "os/OsProtectEvent.h"
#include "mp/MpResourceMsg.h"
#include "mp/MpResNotificationMsg.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class MprFromFile : public MpAudioResource
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */


   MprFromFile(const UtlString& rName);

   virtual
   ~MprFromFile();

   typedef enum
   {
      PLAY_FINISHED,
      PLAY_STOPPED,
      PLAYING,
      READ_ERROR,
      PLAY_IDLE,
      INVALID_SETUP
   } Completion;


/* ============================ MANIPULATORS ============================== */


    static OsStatus playBuffer(const UtlString& namedResource, 
                               OsMsgQ& fgQ, 
                               const char* audioBuffer, 
                               unsigned long bufSize, 
                               uint32_t inRate, uint32_t fgRate, 
                               int type, UtlBoolean repeat, 
                               OsProtectedEvent* notify,
                               UtlBoolean autoStopAfterFinish = TRUE);
   static OsStatus playFile(const UtlString& namedResource,
                            OsMsgQ& fgQ,
                            uint32_t fgSampleRate,
                            const UtlString& filename,
                            const UtlBoolean& repeat,
                            UtlBoolean autoStopAfterFinish = TRUE);
   static OsStatus stopFile(const UtlString& namedResource,
                            OsMsgQ& fgQ);
   static OsStatus pauseFile(const UtlString& namedResource,
                             OsMsgQ& fgQ);
   static OsStatus resumeFile(const UtlString& namedResource,
                             OsMsgQ& fgQ);
   static OsStatus sendProgressPeriod(const UtlString& namedResource,
                                      OsMsgQ& fgQ,
                                      int32_t updatePeriodMS);
   static OsStatus readAudioFile(uint32_t fgSampleRate,
       UtlString*& audioBuffer,
       const char* audioFileName);

/* ============================ ACCESSORS ================================= */



/* ============================ INQUIRY =================================== */



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   typedef enum
   {
      MPRM_FROMFILE_START = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_FROMFILE_PAUSE,      
      MPRM_FROMFILE_RESUME,     
      MPRM_FROMFILE_SEND_PROGRESS, 
      MPRM_FROMFILE_STOP,       
      MPRM_FROMFILE_ERROR       
   } AddlMsgTypes;

   typedef enum
   {
      STATE_IDLE,      
      STATE_PLAYING,   
      STATE_PAUSED,    
      STATE_FINISHED   
   } State;

   static const unsigned int sFromFileReadBufferSize;

   UtlString* mpFileBuffer;
   int mFileBufferIndex;
   UtlBoolean mFileRepeat;
   State mState;
   UtlBoolean mAutoStopAfterFinish; 

   OsTime mLastProgressUpdate;
   int32_t mProgressIntervalMS; 

   static OsStatus genericAudioBufToFGAudioBuf(
                                             UtlString*& fgAudioBuf,
                                             const char* audioBuffer, 
                                             unsigned long bufSize, 
                                             uint32_t inRate,
                                             uint32_t fgRate,
                                             int type);
   static UtlBoolean allocateAndResample(const char* inAudBuf, 
                                         const uint32_t inAudBufSz, 
                                         const uint32_t inRate, 
                                         char*& outAudBuf, 
                                         uint32_t& outAudBufSz, 
                                         const uint32_t outRate);
   virtual UtlBoolean doProcessFrame(MpBufPtr inBufs[],
                                     MpBufPtr outBufs[],
                                     int inBufsSize,
                                     int outBufsSize,
                                     UtlBoolean isEnabled,
                                     int samplesPerFrame,
                                     int samplesPerSecond);

   UtlBoolean handlePlay(UtlString* pBuffer, UtlBoolean repeat,
                         UtlBoolean autoStopAfterFinish);

   UtlBoolean handleFinish();

   UtlBoolean handleStop();

   UtlBoolean handlePause();

   UtlBoolean handleResume();

   UtlBoolean handleSetUpdatePeriod(int32_t periodMS);

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   MprFromFile(const MprFromFile& rMprFromFile);

   MprFromFile& operator=(const MprFromFile& rhs);

};

/* ============================ INLINE METHODS ============================ */

#endif  // _MprFromFile_h_