MprBridge.h

Go to the documentation of this file.

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

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <mp/MpAudioResource.h>
#include <mp/MpFlowGraphMsg.h>
#include <mp/MpDspUtils.h>
#include <mp/MpBridgeAlgBase.h>
#include <os/OsIntTypes.h>

// DEFINES
#define TEST_PRINT_CONTRIBUTORS
#undef  TEST_PRINT_CONTRIBUTORS

//#define PRINT_CLIPPING_STATS
#define PRINT_CLIPPING_FREQUENCY 100

// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// MACROS
// FORWARD DECLARATIONS
#ifdef TEST_PRINT_CONTRIBUTORS  // [
class MpContributorVector;
#endif // TEST_PRINT_CONTRIBUTORS ]

class MprBridge : public MpAudioResource
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
   
   enum AlgType
   {
      ALG_SIMPLE, 
      ALG_LINEAR  
   };

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


   MprBridge(const UtlString& rName,
             int maxInOutputs,
             UtlBoolean mixSilence=TRUE,
             AlgType algorithm=ALG_LINEAR);

   virtual
   ~MprBridge();


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


   OsStatus setMixWeightsForOutput(int bridgeOutputPort,
                                   int numWeights,
                                   const MpBridgeGain gain[]);
   static OsStatus setMixWeightsForOutput(const UtlString& namedResource, 
                                          OsMsgQ& fgQ,
                                          int bridgeOutputPort,
                                          int numWeights,
                                          const MpBridgeGain gains[]);
   OsStatus setMixWeightsForInput(int bridgeInputPort,
                                  int numWeights,
                                  const MpBridgeGain gain[]);
   static OsStatus setMixWeightsForInput(const UtlString& namedResource, 
                                         OsMsgQ& fgQ,
                                         int bridgeInputPort,
                                         int numWeights,
                                         const MpBridgeGain gains[]);

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



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



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

   typedef enum
   {
      SET_WEIGHTS_FOR_INPUT = MpFlowGraphMsg::RESOURCE_SPECIFIC_START,
      SET_WEIGHTS_FOR_OUTPUT
   } AddlMsgTypes;

#ifdef TEST_PRINT_CONTRIBUTORS  // [
   MpContributorVector*  mpMixContributors;
   MpContributorVector** mpLastOutputContributors;
#endif // TEST_PRINT_CONTRIBUTORS ]

   AlgType mAlgType;              
   MpBridgeAlgBase *mpBridgeAlg;  
   UtlBoolean mMixSilence;        

#ifdef PRINT_CLIPPING_STATS
   int mClippedFramesCounted;
   int* mpOutputClippingCount;
#endif

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);
   UtlBoolean doMix(MpBufPtr inBufs[], int inBufsSize,
                    MpBufPtr outBufs[], int outBufsSize,
                    int samplesPerFrame);

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

   virtual UtlBoolean handleMessage(MpFlowGraphMsg& rMsg);

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   virtual UtlBoolean handleSetMixWeightsForOutput(int bridgeOutputPort,
                                                   int numWeights,
                                                   const MpBridgeGain gain[]);
   virtual UtlBoolean handleSetMixWeightsForInput(int bridgeInputPort,
                                                  int numWeights,
                                                  const MpBridgeGain gain[]);
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   MprBridge(const MprBridge& rMprBridge);

   MprBridge& operator=(const MprBridge& rhs);

};

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

#endif  // _MprBridge_h_