MprVoiceActivityNotifier.h

Go to the documentation of this file.

//  
// Copyright (C) 2008 SIPfoundry Inc. 
// Licensed by SIPfoundry under the LGPL license. 
//  
// Copyright (C) 2008 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//  
// $$ 

// Author: Alexander Chemeris <Alexander DOT Chemeris AT SIPez DOT com>

#ifndef _MprVoiceActivityNotifier_h_
#define _MprVoiceActivityNotifier_h_

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

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

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

   static const int smDefaultLevelPeriodMs;
   static const int smDefaultInactivityTimeoutMs;

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


   MprVoiceActivityNotifier(const UtlString& rName,
                            int notificationPeriodMs = smDefaultLevelPeriodMs,
                            int inactivityTimeoutMs = smDefaultInactivityTimeoutMs);


   ~MprVoiceActivityNotifier();


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


   static
   OsStatus chageNotificationPeriod(const UtlString& namedResource, 
                                    OsMsgQ& fgQ,
                                    int notificationPeriodMs);

   static
   OsStatus changeInactivityTimeout(const UtlString& namedResource, 
                                    OsMsgQ& fgQ,
                                    int inactivityTimeoutMs);


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




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

   


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

   enum
   {
      MPRM_CHANGE_NOTIFICATION_PERIOD = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_CHANGE_INACTIVITY_TIMEOUT
   };

   enum StreamState
   {
      STREAM_ACTIVE,
      STREAM_SILENT
   };

   int mLevelPeriodMs;          
   int mLevelPeriodSmp;         
   int mLevelSamplesPassed;     
   int mInactivityTimeoutMs;    
   int mInactivityTimeoutSmp;   
   int mInactivitySamples;      
   int mEnergyLevelMax;         
   StreamState mStreamState;    

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

   UtlBoolean handleMessage(MpResourceMsg& rMsg);

   UtlBoolean handleChangeNotificationPeriod(int periodMs);

   UtlBoolean handleChangeInactivityTimeout(int timeout);

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);

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

};

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

#endif  // _MprVoiceActivityNotifier_h_