MpMediaTask.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2021 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2006 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 _MpMediaTask_h_
#define _MpMediaTask_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "utl/UtlHistogram.h"
#include "os/OsDefs.h"
#include "os/OsRWMutex.h"
#include "os/OsServerTask.h"
#include "os/OsMsgPool.h"
#include "os/OsCallback.h"
#include "mp/MpMediaTaskMsg.h"

// DEFINES

//#define _PROFILE

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

// FORWARD DECLARATIONS
class MpFlowGraphBase;
class OsNotification;

class MpMediaTask : public OsServerTask
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
   enum {
       DEF_TIME_LIMIT_USECS    = 6000,  
       DEF_SEM_WAIT_MSECS      = 500,   
       MEDIA_TASK_PRIORITY     = 0      
   };


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


   static MpMediaTask* createMediaTask(int maxFlowGraph,
                                       UtlBoolean enableLocalAudio = true);

   static MpMediaTask* getMediaTask();

   virtual
   ~MpMediaTask();


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


   OsStatus manageFlowGraph(MpFlowGraphBase& rFlowGraph);
   OsStatus unmanageFlowGraph(MpFlowGraphBase& rFlowGraph);
   OsStatus setDebug(UtlBoolean enableFlag);
   OsStatus setFocus(MpFlowGraphBase* pFlowGraph);
   OsStatus setTimeLimit(int usecs);
   OsStatus setWaitTimeout(int msecs);
   OsStatus startFlowGraph(MpFlowGraphBase& rFlowGraph);
   OsStatus stopFlowGraph(MpFlowGraphBase& rFlowGraph);
   static OsStatus signalFrameStart(const OsTime &timeout = OsTime::OS_INFINITY);
   OsStatus sendToAllFlowgraphs(OsMsgQ& queuedMessages);

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


   int numHandledMsgErrs();

   UtlBoolean getDebugMode(void) const;

   MpFlowGraphBase* getFocus(void) const;

   int getLimitExceededCnt(void) const;

   OsStatus getManagedFlowGraphs(MpFlowGraphBase* flowGraphs[], const int size,
                                 int& numItems);
   int getTimeLimit(void) const;

   int getWaitTimeout(void) const;
   int getWaitTimeoutCnt(void) const;

   int numManagedFlowGraphs(void) const;

   int numProcessedFrames(void) const;
   int numStartedFlowGraphs(void) const;
   OsMsgPool* getBufferMsgPool(void) const;

   inline OsNotification *getTickerNotification();
   static MpFlowGraphBase* mediaInfo(void);

   static int maxNumManagedFlowGraphs(void);


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


   UtlBoolean isManagedFlowGraph(MpFlowGraphBase* pFlowGraph);
   void getQueueUsage(int& numMsgs, int& softLimit,
                      int& hardLimit);


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

   MpMediaTask(int maxFlowGraph, UtlBoolean enableLocalAudio);

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

   OsMutex   mMutex;         
   UtlBoolean mDebugEnabled; 

   int       mTimeLimitCnt;  
   unsigned  mProcessedCnt;  
   int       mManagedCnt;    
   int       mStartedCnt;    
   OsTime    mSemTimeout;    
   int       mSemTimeoutCnt; 
   UtlBoolean mWaitForSignal;
   MpFlowGraphBase* mpFocus; 
   MpFlowGraphBase** mManagedFGs; 
   static int mMaxFlowGraph;
   int       mLimitUsecs;    
   int       mHandleMsgErrs; 
   OsMsgPool* mpBufferMsgPool; 
   OsMsgPool* mpSignalMsgPool; 
   static const OsTime smOperationQueueTimeout; 
   OsCallback mFlowgraphTicker; 
   UtlBoolean mIsLocalAudioEnabled; 
   static UtlBoolean mIsBlockingReported; 

   //  Static data members used to enforce Singleton behavior
   static MpMediaTask* volatile  spInstance;  
   static OsBSem       sLock;       

#ifdef _PROFILE /* [ */
   long long mStartTicks;
   long long mStopTicks;
   unsigned long long mLimitTicks;

   UtlHistogram mStartToEndTime;
   UtlHistogram mStartToStartTime;
   UtlHistogram mEndToStartTime;
   UtlHistogram mSignalTime;
   UtlHistogram mSignalToStartTime;
   UtlHistogram mOtherMessages;
#endif /* _PROFILE ] */

   int run(void* pArg);

   UtlBoolean handleMessage(OsMsg& rMsg);
   UtlBoolean handleManage(MpFlowGraphBase* pFlowGraph);
   UtlBoolean handleSetFocus(MpFlowGraphBase* pFlowGraph);
   UtlBoolean handleStart(MpFlowGraphBase* pFlowGraph);
   UtlBoolean handleStop(MpFlowGraphBase* pFlowGraph);
   UtlBoolean handleUnmanage(MpFlowGraphBase* pFlowGraph);
   UtlBoolean handleWaitForSignal(MpMediaTaskMsg*);
   static
   void flowgraphTickerCallback(const intptr_t userData, const  intptr_t eventData);
   MpMediaTask(const MpMediaTask& rMpMediaTask);

   MpMediaTask& operator=(const MpMediaTask& rhs);

};

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

OsNotification *MpMediaTask::getTickerNotification()
{
   return &mFlowgraphTicker;
}

#endif  // _MpMediaTask_h_