MprSpeexEchoCancel.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2006 ProfitFuel Inc.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// $$
#ifndef _MprSpeexEchoCancel_h_
#define _MprSpeexEchoCancel_h_

// SYSTEM INCLUDES
#include <speex/speex_echo.h>

// APPLICATION INCLUDES
#include "mp/MpAudioResource.h"
#include "mp/MpBufPool.h"
#include "mp/MpResourceMsg.h"

// DEFINES

#ifdef ANDROID
#  define SPEEX_DEFAULT_AEC_FILTER_LENGTH 240
#else
#  define SPEEX_DEFAULT_AEC_FILTER_LENGTH 200
#endif

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


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

   static const UtlContainableType TYPE; 

   enum {
#ifdef WIN32
      MAX_ECHO_QUEUE=21,
      DEFAULT_ECHO_QUEUE_LEN=130
#elif defined(ANDROID)
      MAX_ECHO_QUEUE=40,
      DEFAULT_ECHO_QUEUE_LEN=300
#else
      MAX_ECHO_QUEUE=20,
      DEFAULT_ECHO_QUEUE_LEN=90
#endif
   };

   enum GlobalEnableState {
      GLOBAL_ENABLE,   
      GLOBAL_DISABLE,  
      LOCAL_MODE       
   };

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


   MprSpeexEchoCancel(const UtlString& rName,
                      OsMsgQ* pSpkrQ=NULL,
                      int spkrQDelayMs=DEFAULT_ECHO_QUEUE_LEN,
                      int filterLength=SPEEX_DEFAULT_AEC_FILTER_LENGTH);
   virtual
   ~MprSpeexEchoCancel();


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


   OsStatus setSpkrQ(const UtlString& namedResource, 
                     OsMsgQ& fgQ,
                     OsMsgQ *pSpkrQ);
   static inline void setGlobalEnableState(GlobalEnableState state);
   static inline GlobalEnableState getGlobalEnableState();

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


   UtlContainableType getContainableType() const;

   inline SpeexEchoState *getSpeexEchoState() const;

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



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

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

   typedef enum
   {
      MPRM_SET_SPEAKER_QUEUE = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START
   } AddlResMsgTypes;

   SpeexEchoState *mpEchoState;       
   bool            mStartedCanceling; 
   int             mFilterLength;     
   OsMsgQ         *mpSpkrQ;           
   const int       mSpkrQDelayMs;     
   int             mSpkrQDelayFrames; 
   MpAudioBufPtr   mpSilenceBuf;      

   static volatile GlobalEnableState smGlobalEnableState;

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

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);
   MprSpeexEchoCancel(const MprSpeexEchoCancel& rMprSpeexEchoCancel);

   MprSpeexEchoCancel& operator=(const MprSpeexEchoCancel& rhs);

};

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

void MprSpeexEchoCancel::setGlobalEnableState(GlobalEnableState state)
{
   smGlobalEnableState = state;
}

MprSpeexEchoCancel::GlobalEnableState  MprSpeexEchoCancel::getGlobalEnableState()
{
   return(smGlobalEnableState);
}

SpeexEchoState *MprSpeexEchoCancel::getSpeexEchoState() const
{
   return mpEchoState;
}

#endif  // _MprSpeexEchoCancel_h_