MpInputDeviceManager.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: Dan Petrie <dpetrie AT SIPez DOT com>

#ifndef _MpInputDeviceManager_h_
#define _MpInputDeviceManager_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
#define MP_INVALID_INPUT_DEVICE_HANDLE -1

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpInputDeviceDriver;
class UtlString;
class MpBufPtr;
class MpBufPool;
class OsMsgDispatcher;
class MpResNotificationMsg;

class MpInputDeviceManager
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   MpInputDeviceManager(unsigned defaultSamplesPerFrame, 
                        unsigned defaultSamplesPerSecond,
                        unsigned defaultNumBufferedFrames,
                        MpBufPool& bufferPool);
   virtual
      ~MpInputDeviceManager();

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


   MpInputDeviceHandle addDevice(MpInputDeviceDriver& newDevice);
   MpInputDeviceDriver* removeDevice(MpInputDeviceHandle deviceId);
   int removeAllDevices();
   OsStatus setupDevice(MpInputDeviceHandle deviceId,
                        uint32_t samplesPerFrame = 0,
                        uint32_t samplesPerSec = 0);
   OsStatus enableDevice(MpInputDeviceHandle deviceId);
   OsStatus disableDevice(MpInputDeviceHandle deviceId);
   OsStatus disableAllDevicesExcept(int exceptCount = 0, MpInputDeviceHandle exceptIdArray[] = NULL);
   OsStatus pushFrame(MpInputDeviceHandle deviceId,
                      unsigned numSamples,
                      MpAudioSample *samples,
                      MpFrameTime frameTime);
   OsStatus getFrame(MpInputDeviceHandle deviceId,
                     MpFrameTime &frameTime,
                     MpBufPtr& buffer,
                     unsigned& numFramesBefore,
                     unsigned& numFramesAfter);

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


   OsStatus getDeviceName(MpInputDeviceHandle deviceId, UtlString& deviceName) const;
   OsStatus getDeviceId(const UtlString& deviceName,
                        MpInputDeviceHandle& deviceId) const;
   MpFrameTime getCurrentFrameTime(MpInputDeviceHandle deviceId) const;
   OsStatus getDeviceSamplesPerSec(MpInputDeviceHandle deviceId, 
                                   uint32_t& samplesPerSec) const;
   OsStatus getDeviceSamplesPerFrame(MpInputDeviceHandle deviceId,
                                     uint32_t& samplesPerFrame) const;
   OsStatus getTimeDerivatives(MpInputDeviceHandle deviceId,
                               unsigned& nDerivatives,
                               double*& derivativeBuf) const;
   OsMsgDispatcher* getNotificationDispatcher();
   OsStatus addNotificationDispatcher(OsMsgDispatcher* notifyDispatcher); // , connectionId, streamId);
   OsStatus removeNotificationDispatcher(OsMsgDispatcher* notifyDispatcher); // , connectionId, streamId);
   OsStatus postNotification(const MpResNotificationMsg& msg);// resourceName);

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


   UtlBoolean isDeviceEnabled(MpInputDeviceHandle deviceId) const;

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


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

   mutable OsRWMutex mRwMutex;
   MpInputDeviceHandle mLastDeviceId;
   unsigned mDefaultSamplesPerFrame;
   unsigned mDefaultSamplesPerSecond;
   unsigned mDefaultNumBufferedFrames;
   MpBufPool* mpBufferPool;
   UtlSList mNotifiers;
   UtlHashMap mConnectionsByDeviceName;
   UtlHashBag mConnectionsByDeviceId;
   OsTime mTimeZero;

  MpInputDeviceManager(const MpInputDeviceManager& rMpInputDeviceManager);

  MpInputDeviceManager& operator=(const MpInputDeviceManager& rhs);

};

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

#endif  // _MpInputDeviceManager_h_