MprDecode.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2014 SIPez LLC.  All rights reserved.
//
// 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 _MprDecode_h_ /* [ */
#define _MprDecode_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/MpMisc.h"
#include "mp/MpRtpBuf.h"
#include "mp/MpAudioResource.h"
#include "mp/MpFlowGraphMsg.h"
#include "mp/MpResourceMsg.h"
#include "mp/MpDecoderPayloadMap.h"
#include "mp/MpJitterBufferEstimation.h"
#include "sdp/SdpCodec.h"
#include "os/OsBSem.h"

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

// FORWARD DECLARATIONS
class UtlSerialized;
class MpDecoderBase;
class MprRecorder;
class MpJitterBuffer;
class MprDejitter;
class MpPlcBase;

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

   typedef enum
   {
      MPRM_SET_PLC = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_DESELCT_CODECS,
      MPRM_RESET,
      MPRM_SET_VAD_PARAM
   } AddlResMsgTypes;

   static const UtlContainableType TYPE; 

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


   MprDecode(const UtlString &rName,
             const UtlString &plcName = "");

   virtual
   ~MprDecode();


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


   static OsStatus reset(const UtlString& namedResource, OsMsgQ& fgQ);

   virtual void reset();

   static OsStatus selectCodecs(const UtlString& namedResource,
                                OsMsgQ& fgQ,
                                SdpCodec* codecs[],
                                int numCodecs);

   static OsStatus deselectCodecs(const UtlString& namedResource,
                                  OsMsgQ& fgQ);

   static OsStatus setPlc(const UtlString& namedResource,
                          OsMsgQ& fgQ,
                          const UtlString& plcName = "");
   void setMyDejitter(MprDejitter* newDJ, UtlBoolean ownDj);
   virtual OsStatus pushBuffer(int inputPort, MpBufPtr& inputBuffer);

   OsStatus pushPacket(MpRtpBufPtr &pRtp);
   void setConnectionId(MpConnectionID connectionId);

   void setStreamId(int connectionId);


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


   UtlContainableType getContainableType() const;

   virtual OsStatus getCurrentLatency(int &latency, int input=0, int output=0) const;


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



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

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

   MpJitterBuffer* mpJB;            
   UtlBoolean mIsJBInitialized;     

   MprDejitter* mpMyDJ;             
   UtlBoolean   mOwnDJ;             
   UtlBoolean mIsStreamInitialized; 
   struct StreamState
   {
      unsigned sampleRate;          
      UtlBoolean isFirstRtpPulled;  
      RtpSeq rtpStreamSeq;          
      RtpTimestamp rtpStreamPosition; 
      int32_t rtpStreamHint;        
      uint32_t playbackStreamPosition; 
      unsigned playbackFrameSize;   
      uint8_t rtpPayloadType;       
      uint32_t dejitterLength;      
   } mStreamState;

   RtpSeq mLastPulledSeq;           

   MpJitterBufferEstimation *mpJbEstimationState; 


   MpDecoderBase** mpCurrentCodecs;
   int             mNumCurrentCodecs; 
   UtlBoolean mEnableG722Hack;   
   int mG722HackPayloadType;     


   MpDecoderBase** mpPrevCodecs;
   int             mNumPrevCodecs; 

   MpDecoderPayloadMap mDecoderMap; 

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

   UtlBoolean tryDecodeAsSignalling(const MpRtpBufPtr &rtp);
   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   UtlBoolean handleSelectCodecs(SdpCodec* pCodecs[], int numCodecs);
   UtlBoolean handleDeselectCodecs(UtlBoolean shouldLock = TRUE);

   UtlBoolean handleDeselectCodec(MpDecoderBase* pDecoder);
   UtlBoolean handleSetPlc(const UtlString &plcName);

   UtlBoolean handleReset();

   UtlBoolean handleDisable();

   UtlBoolean handleSetVadParam(UtlSerialized& serialData);

   void deletePriorCodecs();

   MprDecode(const MprDecode& rMprDecode);

   MprDecode& operator=(const MprDecode& rhs);

};

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

#endif  /* _MprDecode_h_ ] */