MprToneDetect.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2015 SIPez LLC.  All rights reserved.
//
// $$

#ifndef _MprToneDetect_h_
#define _MprToneDetect_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <mp/MpFlowGraphMsg.h>
#include <mp/MpResourceMsg.h>
#include <mp/MpAudioResource.h>

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

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

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


   MprToneDetect(const UtlString& rName);

   virtual ~MprToneDetect();


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


   static OsStatus changeTargetFrequency(const UtlString& namedResource, 
                                         OsMsgQ& fgQ,
                                         int targetFreq);

   static OsStatus changeDetectionThreshold(const UtlString& namedResource, 
                                            OsMsgQ& fgQ,
                                            int threshold);

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

   // ideally this should do a lookup on the named resource and
   // return the value for that
   double getAvgMagnitude(const UtlString& resName);


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



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

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

   enum
   {
      MPRM_CHANGE_TARGET_FREQ = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_CHANGE_THRESHOLD
   };

   typedef enum
   {
      SET_TARGET_FREQ = MpFlowGraphMsg::RESOURCE_SPECIFIC_START,
      SET_THRESHOLD
   } AddlMsgTypes;

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

   virtual UtlBoolean handleMessage(MpFlowGraphMsg& fgMsg);

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);
   MprToneDetect(const MprToneDetect& rMprToneDetect);

   MprToneDetect& operator=(const MprToneDetect& rhs);

   double getAvgMag() const;

   static const double DEFAULT_TARGET_FREQ;
   static const double DEFAULT_SAMPLING_RATE;
   static const double DEFAULT_THRESHOLD;
   static const unsigned DEFAULT_BLOCK_SIZE;
   static const int DEFAULT_WINDOW_SIZE;

   double mCoeff;
   double mQ1;
   double mQ2;
   double mThreshold;
   double mTargetFreq;
   unsigned mBlockCnt;
   bool mCurTd;
   bool mToneSignaled;
   double mAvg3Mag;
   double mSampleRate;
   unsigned mBlockSize;
   int mWindowSize;
   MpFlowGraphBase* mpFlowGraph;

   double *mFilterData;
   void resetGoertzel(void);
   void initGoertzel(void);
   void processSample(MpAudioSample sample);
   double getMagnitudeSquared(void);
   void initFilter();
   double filterSample(MpAudioSample sample, uint32_t n);
};

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

#endif  // _MprToneDetect_h_