MprDelay.h

Go to the documentation of this file.

//  
// Copyright (C) 2008 SIPfoundry Inc. 
// Licensed by SIPfoundry under the LGPL license. 
//  
// Copyright (C) 2008 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//  
// $$ 

// Author: Sergey Kostanbaev <Sergey DOT Kostanbaev AT sipez DOT com>

#ifndef _MprDelay_h_
#define _MprDelay_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/MpAudioResource.h"
#include "mp/MpAudioBuf.h"
#include "mp/MpResourceMsg.h"


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


class MprDelay : public MpAudioResource
{
/* //////////////////////////////// PUBLIC //////////////////////////////// */
public:
   enum
   {
      DEFAULT_FIFO_CAPACITY = 1000
   };
/* =============================== CREATORS =============================== */

   MprDelay(const UtlString& rName, int capacity = DEFAULT_FIFO_CAPACITY);

   ~MprDelay();


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


   static UtlBoolean startPlay(const UtlString& namedResource, 
                               OsMsgQ& fgQ);

   static UtlBoolean stopPlay(const UtlString& namedResource, 
                              OsMsgQ& fgQ);


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




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

   
   int getDelayMs();

   int getDelaySamples();

   int getDelayFrames();


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

   UtlBoolean doDelay(MpBufPtr& inBuf,
                      MpBufPtr& outBuf,
                      int samplesPerFrame,
                      int samplesPerSecond);
   
   UtlBoolean handleMessage(MpResourceMsg& rMsg);

   UtlBoolean doProcessFrame(MpBufPtr inBufs[],
                             MpBufPtr outBufs[],
                             int inBufsSize,
                             int outBufsSize,
                             UtlBoolean isEnabled,
                             int samplesPerFrame,
                             int samplesPerSecond);


/* /////////////////////////////// PRIVATE //////////////////////////////// */
private:
   enum MprDelayState
   {
      MPDS_WAITING,
      MPDS_BUFFERING,
      MPDS_PLAYING,
      MPDS_PLAYING_WITHOUT_DELAY
   };

   typedef enum
   {
      MPRM_DELAY_START_PLAY = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_DELAY_STOP_PLAY
   } AddlMsgTypes;

   class MprDelayFifo
   {
   /* ///////////////////////////// PUBLIC //////////////////////////////// */
   public:

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

      MprDelayFifo(int capacity);

      ~MprDelayFifo();


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

      void reset();

      void pushData(MpAudioBufPtr& databuff);

      void popData(MpAudioBufPtr& databuff);

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


      int getFifoLength() const;



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


      UtlBoolean isQuiescent() const;

      UtlBoolean isEmpty() const;


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

   /* //////////////////////////// PRIVATE //////////////////////////////// */
   private:
      MpAudioBufPtr* mBuff;
      int mBuffSize;
      int mEndPosition;
      int mStartPosition;
      int mNumActiveFrames;
   };

   MprDelayState mState; 
   UtlBoolean mIsQuiescenceNotified; 
   MprDelayFifo mFifo;   
};

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

#endif  // _MprDelay_h_