MpidWinMM.h

Go to the documentation of this file.

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

// Author: Keith Kyzivat <kkyzivat AT SIPez DOT com>

#ifndef _MpidWinMM_h_
#define _MpidWinMM_h_

// SYSTEM INCLUDES
#define WIN32_LEAN_AND_MEAN
//#include <Windows.h>
#include <MMSystem.h>

// APPLICATION INCLUDES
#include "mp/MpInputDeviceDriver.h"

// DEFINES
#define DEFAULT_N_INPUT_BUFS 32

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpInputDeviceManager;
struct IMMDeviceEnumerator;
struct IMMNotificationClient;

class MpidWinMM : public MpInputDeviceDriver
{
    friend class MpodWinMM;

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   MpidWinMM(const UtlString& name,
                          MpInputDeviceManager& deviceManager,
                          unsigned nInputBuffers = DEFAULT_N_INPUT_BUFS);
   virtual
   ~MpidWinMM();


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


    OsStatus enableDevice(unsigned samplesPerFrame, 
                          unsigned samplesPerSec,
                          MpFrameTime currentFrameTime);
    OsStatus disableDevice();
     
/* ============================ ACCESSORS ================================= */


   static UtlString getDefaultDeviceName();


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


    inline UtlBoolean isDeviceValid();


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

    WAVEHDR* initWaveHeader(int n);
    void processAudioInput(HWAVEIN hwi, 
                           UINT uMsg, 
                           void* dwParam1);
    static void CALLBACK waveInCallbackStatic(HWAVEIN hwi,
                                              UINT uMsg,
                                              void* dwInstance,
                                              void* dwParam1,
                                              void* dwParam2);
    static bool nameIsSame(const UtlString& a, const UtlString& b);

      // Windows device accessors
    class MpWinInputAudioDeviceNotifier;
    static IMMDeviceEnumerator* getWinDeviceEnumerator();
    static void registerDeviceEnumerator(IMMDeviceEnumerator* deviceEnumeratorPtr, IMMNotificationClient* winAudioDeviceChangeCallback);
    static void unregisterDeviceEnumerator(IMMDeviceEnumerator* deviceEnumeratorPtr, IMMNotificationClient* winAudioDeviceChangeCallback);
    static void getWinNameForDevice(IMMDeviceEnumerator* deviceEnumeratorPtr, const LPCWSTR winDeviceId, UtlString& deviceName);

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

    int mWinMMDeviceId;       
    HWAVEIN mDevHandle;       
    unsigned mNumInBuffers;   
    unsigned mWaveBufSize;    
    WAVEHDR* mpWaveHeaders;   
    LPSTR* mpWaveBuffers;     
    UtlBoolean mIsOpen;       
    unsigned mnAddBufferFailures;  
    IMMNotificationClient* mWinAudioDeviceChangeCallback; 
    IMMDeviceEnumerator* mDeviceEnumeratorPtr;

    MpidWinMM(const MpInputDeviceDriver& rMpInputDeviceDriver);

    MpidWinMM& operator=(const MpInputDeviceDriver& rhs);
};

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

UtlBoolean MpidWinMM::isDeviceValid()
{
   return (mWinMMDeviceId >= 0);
}


#endif  // _MpidWinMM_h_