MpOutputDeviceManager.h

Go to the documentation of this file.

//  
// Copyright (C) 2007-2021 SIPez LLC. All rights reserved.
//
// Copyright (C) 2007-2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

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

#ifndef _MpOutputDeviceManager_h_
#define _MpOutputDeviceManager_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <os/OsRWMutex.h>
#include <utl/UtlHashMap.h>
#include <utl/UtlHashBag.h>
#include <utl/UtlSList.h>
#include "mp/MpTypes.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpOutputDeviceDriver;
class MpAudioOutputConnection;
class UtlString;
class MpBufPtr;
class OsNotification;
class OsMsgDispatcher;
class MpResNotificationMsg;

class MpOutputDeviceManager
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   MpOutputDeviceManager(unsigned defaultSamplesPerFrame,
                         unsigned defaultSamplesPerSecond,
                         MpFrameTime defaultMixerBufferLength);
   virtual
   ~MpOutputDeviceManager();

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


   MpOutputDeviceHandle addDevice(MpOutputDeviceDriver  *newDevice);
   MpOutputDeviceDriver* removeDevice(MpOutputDeviceHandle deviceId);
   int removeAllDevices();
   OsStatus enableDevice(MpOutputDeviceHandle deviceId,
                         MpFrameTime mixerBufferLength = 0,
                         uint32_t samplesPerFrame = 0,
                         uint32_t samplesPerSec = 0);
   OsStatus disableDevice(MpOutputDeviceHandle deviceId);
   OsStatus disableAllDevicesExcept(int exceptCount = 0, MpOutputDeviceHandle exceptIdArray[] = NULL);
   OsStatus pushFrameFirst(MpOutputDeviceHandle deviceId,
                           MpFrameTime &frameTime,
                           const MpBufPtr& frame,
                           UtlBoolean initFrameTime = FALSE);
   OsStatus pushFrame(MpOutputDeviceHandle deviceId,
                      MpFrameTime frameTime,
                      const MpBufPtr& frame);
   OsStatus setFlowgraphTickerSource(MpOutputDeviceHandle deviceId,
                                     OsNotification *pFlowgraphTicker);

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


   OsStatus getDeviceName(MpOutputDeviceHandle deviceId, UtlString& deviceName) const;
   OsStatus getDeviceId(const UtlString& deviceName, MpOutputDeviceHandle &deviceId) const;
   OsStatus getMixerBufferLength(MpOutputDeviceHandle deviceId, MpFrameTime &length) const;
   MpFrameTime getCurrentFrameTime(MpOutputDeviceHandle deviceId) const;
   OsStatus getDeviceSamplesPerSec(MpOutputDeviceHandle deviceId, 
                                   uint32_t& samplesPerSec) const;
   OsStatus getDeviceSamplesPerFrame(MpOutputDeviceHandle deviceId,
                                     uint32_t& samplesPerFrame) const;
   OsMsgDispatcher* getNotificationDispatcher();
   OsStatus addNotificationDispatcher(OsMsgDispatcher* notifyDispatcher); // , connectionId, streamId);
   OsStatus removeNotificationDispatcher(OsMsgDispatcher* notifyDispatcher); // , connectionId, streamId);
   OsStatus postNotification(const MpResNotificationMsg& msg);// resourceName);

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


   UtlBoolean isDeviceEnabled(MpOutputDeviceHandle deviceId) const;

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

   MpAudioOutputConnection* findConnectionBlocking(MpOutputDeviceHandle deviceId,
                                                   int tries=10) const;
   // Try 10 times (this is a blind guess).
   // Checking every 10ms over 100ms seems reasonable.


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

  mutable OsRWMutex mRwMutex;         
  MpOutputDeviceHandle mLastDeviceId;
  unsigned mDefaultSamplesPerFrame;
  unsigned mDefaultSamplesPerSecond;
  MpFrameTime mDefaultBufferLength;
  UtlHashMap mConnectionsByDeviceName;
  UtlHashBag mConnectionsByDeviceId;
  OsTime mTimeZero;
  MpOutputDeviceHandle mCurrentTickerDevice;
  UtlSList mNotifiers;

  MpOutputDeviceManager(const MpOutputDeviceManager& rMpOutputDeviceManager);

  MpOutputDeviceManager& operator=(const MpOutputDeviceManager& rhs);

};

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

#endif  // _MpOutputDeviceManager_h_