MpodWinMM.h

Go to the documentation of this file.

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

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

#ifndef _MpodWinMM_h_
#define _MpodWinMM_h_

// SYSTEM INCLUDES
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>
#include <malloc.h>
#include <MMSystem.h>
#include <os/OsMutex.h>
#include <os/OsCallback.h>
#include <utl/UtlSList.h>
#include <utl/UtlVoidPtr.h>

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

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

// DEFINES
#define DEFAULT_N_OUTPUT_BUFS 32

//#define DONTUSE_SLIST
#if !defined(_WIN32_WINNT) || (_WIN32_WINNT < 0x0600)
#  define DONTUSE_SLIST
#endif

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class OsNotification;
class MpOutputDeviceManager;
class MpMMTimer;
struct IMMNotificationClient;

class MpodWinMM : public MpOutputDeviceDriver, OsCallback
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   explicit
   MpodWinMM(const UtlString& name,
             MpOutputDeviceManager* outputManger,
             unsigned nOutputBuffers = DEFAULT_N_OUTPUT_BUFS);
   ~MpodWinMM();


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


   OsStatus enableDevice(unsigned samplesPerFrame, 
                         unsigned samplesPerSec,
                         MpFrameTime currentFrameTime,
                         OsCallback &frameTicker);

   OsStatus disableDevice();

   OsStatus pushFrame(unsigned int numSamples,
                      const MpAudioSample* samples,
                      MpFrameTime frameTime);

   OsStatus switchToMMTimer();

   virtual OsStatus signal(const intptr_t eventData);


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


   static UtlString getDefaultDeviceName();


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


   inline UtlBoolean isDeviceValid();


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

   WAVEHDR* initWaveHeader(int n);
   void finalizeProcessedHeader(WAVEHDR* pWaveHdr);
   static void CALLBACK waveOutCallbackStatic(HWAVEOUT hwo, UINT uMsg, 
                                              void* dwInstance,
                                              void* dwParam1, void* dwParam2);
protected:
   OsStatus internalPushFrame(unsigned int numSamples, 
                              const MpAudioSample* samples, 
                              MpFrameTime frameTime);

protected:
   MpOutputDeviceManager* mpOutputManger; 
   OsMutex  mEmptyHdrVPtrListsMutex; 
   int      mWinMMDeviceId;    
   HWAVEOUT mDevHandle;        
   MpFrameTime mCurFrameTime;  
   unsigned mNumOutBuffers;    
   unsigned mWaveBufSize;      
   WAVEHDR* mpWaveHeaders;     
   LPSTR*   mpWaveBuffers;     
   UtlSList mEmptyHeaderList;  
   UtlSList mUnusedVPtrList;   
   int      mUnderrunLength;   
   DWORD    mTotSampleCount;   
   IMMNotificationClient* mWinAudioDeviceChangeCallback; 
   IMMDeviceEnumerator* mDeviceEnumeratorPtr;
   HANDLE   mCallbackThread;   
   HANDLE   mCallbackEvent;    
   OsAtomicLightBool mExitFlag; 
   MpMMTimer* mpTickerTimer;   

#ifndef DONTUSE_SLIST
   struct WinAudioDataChain
   {
      SLIST_ENTRY ItemEntry;
      UINT mCbParamMsg;
      WAVEHDR* mCbParamHdr;
   };

   SLIST_HEADER mPoolSignaled; 
   SLIST_HEADER mPoolFree;     
#else
   class WinAudioData : public UtlVoidPtr
   {
   public:
      WinAudioData() { setValue(this); }

      UINT mCbParamMsg;
      WAVEHDR* mCbParamHdr;
   };

   UtlSList mListSignaled; 
   UtlSList mListFree;     
#endif

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

   MpodWinMM(const MpodWinMM& rMpodWinMM);

   MpodWinMM& operator=(const MpodWinMM& rhs);

   class MpWinOutputAudioDeviceNotifier;

   static DWORD WINAPI ThreadMMProc(LPVOID lpMessage);
   OsStatus resetDevice();
};


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

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

#endif  // _MpodWinMM_h_