MprSpeexPreProcess.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 _MprSpeexPreprocess_h_
#define _MprSpeexPreprocess_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/MpAudioResource.h"
#include "mp/MpFlowGraphMsg.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
struct SpeexPreprocessState_;
typedef SpeexPreprocessState_ SpeexPreprocessState;


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

   enum GlobalEnableState {
      GLOBAL_ENABLE,   
      GLOBAL_DISABLE,  
      LOCAL_MODE       
   };

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

   MprSpeexPreprocess(const UtlString& rName, UtlBoolean isAgcEnabled=FALSE,
                      UtlBoolean isNoiseReductionEnabled=FALSE);

   virtual
   ~MprSpeexPreprocess();


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

   UtlBoolean setAGC(UtlBoolean enable);

   UtlBoolean setNoiseReduction(UtlBoolean enable);

   static inline void setGlobalAgcEnableState(GlobalEnableState state);
   static inline void setGlobalNoiseReductionEnableState(GlobalEnableState state);
/* ============================ ACCESSORS ================================= */

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

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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   typedef enum
   {
      SET_AGC  = MpFlowGraphMsg::RESOURCE_SPECIFIC_START,
      SET_NOISE_REDUCTION
   } AddlMsgTypes;

   SpeexPreprocessState *mpPreprocessState; 
   UtlBoolean mIsAgcEnabled;                
   UtlBoolean mIsNoiseReductionEnabled;     

   static volatile GlobalEnableState smGlobalAgcEnableState;
   UtlBoolean mIsAgcEnabledReal; 
   static volatile GlobalEnableState smGlobalNoiseReductionEnableState;
   UtlBoolean mIsNoiseReductionEnabledReal; 

   inline UtlBoolean getRealAgcState() const;
   inline UtlBoolean getRealNoiseReductionState() const;

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

   virtual UtlBoolean handleMessage(MpFlowGraphMsg& rMsg);

   UtlBoolean handleSetAGC(UtlBoolean enable);

   UtlBoolean handleSetNoiseReduction(UtlBoolean enable);

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);
   UtlBoolean connectInput(MpResource& rFrom, int fromPortIdx, int toPortIdx);

   UtlBoolean disconnectInput(int outPortIdx);

   MprSpeexPreprocess(const MprSpeexPreprocess& rMprSpeexPreprocess);

   MprSpeexPreprocess& operator=(const MprSpeexPreprocess& rhs);

};

void MprSpeexPreprocess::setGlobalAgcEnableState(GlobalEnableState state)
{
   smGlobalAgcEnableState = state;
}

void MprSpeexPreprocess::setGlobalNoiseReductionEnableState(GlobalEnableState state)
{
   smGlobalNoiseReductionEnableState = state;
}

UtlBoolean MprSpeexPreprocess::getRealAgcState() const
{
   return (smGlobalAgcEnableState==LOCAL_MODE) ? mIsAgcEnabled
          : (smGlobalAgcEnableState==GLOBAL_ENABLE);
}

UtlBoolean MprSpeexPreprocess::getRealNoiseReductionState() const
{
   return (smGlobalNoiseReductionEnableState==LOCAL_MODE) ? mIsNoiseReductionEnabled
          : (smGlobalAgcEnableState==GLOBAL_ENABLE);
}

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

#endif  // _MprSpeexPreprocess_h_