MprEncode.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 _MprEncode_h_
#define _MprEncode_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/MpAudioResource.h"
#include "sdp/SdpCodec.h"
#include "mp/MpFlowGraphMsg.h"
#include "mp/MpResourceMsg.h"
#include "mp/MprToNet.h"
#include "mp/MpMisc.h"
#include "mp/MpResampler.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpEncoderBase;

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

   static const UtlContainableType TYPE; 

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


     // Constructor
   MprEncode(const UtlString& rName);

     // Destructor
   virtual
   ~MprEncode();


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


   static OsStatus selectCodecs(const UtlString& namedResource,
                                OsMsgQ& fgQ,
                                SdpCodec* pPrimaryCodec,
                                SdpCodec* pDtmfCodec);

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

   void setMyToNet(MprToNet* myToNet);
   static OsStatus startTone(const UtlString& namedResource,
                             OsMsgQ& fgQ,
                             int toneId);

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

   static OsStatus enableDtx(const UtlString& namedResource,
                             OsMsgQ& fgQ,
                             UtlBoolean dtx);
   static OsStatus setMaxPacketTime(const UtlString& namedResource,
                                    OsMsgQ& fgQ,
                                    unsigned int maxPacketTime);


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


   UtlContainableType getContainableType() const;


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



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

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

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

   typedef enum
   {
      MPRM_DESELECT_CODECS = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_START_TONE,
      MPRM_STOP_TONE,
      MPRM_SET_MAX_PACKET_TIME,
      MPRM_ENABLE_DTX,
      MPRM_DISABLE_DTX
   } AddlResMsgTypes;


   enum {
      TONE_STOP_PACKETS = 3, 
      HANGOVER_PACKETS = 25  
   };

   static const int RTP_KEEP_ALIVE_FRAME_INTERVAL;


   MpEncoderBase* mpPrimaryCodec;
   unsigned char* mpPacket1Payload; 
   int   mMaxPacketSamples;         
   int   mPacket1PayloadBytes;      
   int   mPayloadBytesUsed;         
   unsigned int mSamplesPacked;     
   unsigned int mStartTimestamp1;   
   UtlBoolean mActiveAudio1;        
   UtlBoolean mMarkNext1;           
   int   mConsecutiveInactive1;     
   int   mConsecutiveActive1;
   int   mConsecutiveUnsentFrames1;
   UtlBoolean mDoesVad1;    
   UtlBoolean mDisableDTX;  
   UtlBoolean mEnableG722Hack;   
   UtlBoolean mDoG722Hack;       



   UtlBoolean  mNeedResample;    
   MpResamplerBase *mpResampler; 
   unsigned int mResampleBufLen; 
   MpAudioSample *mpResampleBuf; 



   MpEncoderBase* mpDtmfCodec;
   unsigned char* mpPacket2Payload; 
   int   mPacket2PayloadBytes;      
   unsigned int   mStartTimestamp2; 
   unsigned int   mLastDtmfSendTimestamp;
   int   mDtmfSampleInterval;       
   int   mCurrentTone;  
   int   mNumToneStops; 
   int   mTotalTime;    
   UtlBoolean mNewTone;      




   unsigned int   mCurrentTimestamp;
   unsigned int   mMaxPacketTime;  

   MprToNet* mpToNet;  


   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   OsStatus allocPacketBuffer(const MpEncoderBase& rEncoder,
                              unsigned char*& rpPacketPayload,
                              int& rPacketPayloadBytes);

   void handleSelectCodecs(int newCodecsCount, SdpCodec** newCodecs);

   void handleDeselectCodecs(void);

   int lookupTone(int toneId);

   void handleStartTone(int toneId);

   void handleEnableDTX(UtlBoolean dtx);

   void handleSetMaxPacketTime(unsigned maxPacketTime);

   void handleStopTone(void);

   void doPrimaryCodec(MpAudioBufPtr in);

   void doDtmfCodec(int samplesPerFrame, int samplesPerSecond);

   void notifyStartTx();

   void notifyStopTx();

   MprEncode(const MprEncode& rMprEncode);

   MprEncode& operator=(const MprEncode& rhs);

};

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

#endif  // _MprEncode_h_