MprSpeakerSelector.h

Go to the documentation of this file.

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

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

#ifndef _MprSpeakerSelector_h_
#define _MprSpeakerSelector_h_

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

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

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

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


   MprSpeakerSelector(const UtlString& rName,
                      int maxInputs,
                      int maxOutputs,
                      int maxActiveSpeakers,
                      const UtlString &algorithmName = "");

   MprSpeakerSelector(const UtlString& rName,
                      int maxInputs,
                      int maxOutputs,
                      int maxActiveSpeakers,
                      MpSpeakerSelectBase *pSS);
   virtual ~MprSpeakerSelector();


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


   OsStatus chageAlgorithm(const UtlString& namedResource, 
                           OsMsgQ& fgQ,
                           const UtlString &algorithmName);

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



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



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

   typedef enum
   {
      MPRM_CHANGE_ALGORITHM = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START
   } AddlMsgTypes;
   
   struct RankIndexPair
   {
      unsigned mRank;  
      int      mIndex; 
   };

   UtlBoolean           mDynamicInputMapping; 
   int                  mNumStreams; 
   MpSpeakerSelectBase *mpSS;        
   UtlBoolean           mSsFresh;    
   MpSpeechParams     **mpFrameParams; 
   int                  mMaxActiveSpeakers; 
   RankIndexPair       *mTopRanks;   
   int                 *mInToOutMap; 
   int                 *mOutToInMap; 
   uint32_t             mMapTime;
   int                 *mChangeMapTime;

   UtlBoolean connectInput(MpResource& rFrom, int fromPortIdx, int toPortIdx);

   UtlBoolean connectOutput(MpResource& rTo, int toPortIdx, int fromPortIdx);

   UtlBoolean disconnectInput(int outPortIdx);

   UtlBoolean disconnectOutput(int outPortIdx);

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);

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

   UtlBoolean handleMessage(MpResourceMsg& rMsg);

   UtlBoolean handleEnable();

   UtlBoolean handleDisable();

   UtlBoolean handleChangeAlgorithm(const UtlString &algorithmName);

   void enableConnectedStreams();
   static void peekTopSpeakers(MpSpeechParams **frameParams, int frameParamsNum,
                               RankIndexPair *topRanks, int topRanksNum);

   void updateMapping(RankIndexPair *topRanks, int topRanksNum);
   inline int getOldestOutput();
   inline int getOutputForInput(int inputNum);

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

   MprSpeakerSelector(const MprSpeakerSelector& rMprSpeakerSelector);

   MprSpeakerSelector& operator=(const MprSpeakerSelector& rhs);

};

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

#endif  // _MprSpeakerSelector_h_