MprToOutputDevice.h

Go to the documentation of this file.

//  
// Copyright (C) 2007-2013 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 _MprToOutputDevice_h_
#define _MprToOutputDevice_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <mp/MpAudioResource.h>
#include <mp/MpResourceMsg.h>
#include <mp/MpResampler.h>
#include <os/OsMsgPool.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpOutputDeviceManager;
class MpIntResourceMsg;

class MprToOutputDevice : public MpAudioResource
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   MprToOutputDevice(const UtlString& rName, 
                     MpOutputDeviceManager* deviceManager,
                     MpOutputDeviceHandle deviceId);

   virtual
   ~MprToOutputDevice();


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


   static OsStatus setDeviceId(const UtlString& resourceName,
                               OsMsgQ& flowgraphMessageQueue,
                               MpOutputDeviceHandle deviceId);
   static OsStatus enableCopyQ(const UtlString& namedResource, 
                               OsMsgQ& fgQ,
                               UtlBoolean enable);
   OsStatus enableCopyQ(UtlBoolean enable);

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


   inline OsMsgQ *getCopyQ();


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



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    UtlBoolean handleSetOutputDeviceId(const MpIntResourceMsg& message);

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

   typedef enum
   {
      MPRM_ENABLE_COPY_QUEUE = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START,
      MPRM_DISABLE_COPY_QUEUE,
      MPRM_SET_OUTPUT_DEVICE_ID
   } AddlResMsgTypes;

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

   MpOutputDeviceManager* mpOutputDeviceManager;
   UtlBoolean mFrameTimeInitialized;
   MpFrameTime mFrameTime;
   MpFrameTime mMixerBufferPosition;
   MpFrameTime mLastPushedTime;
   MpOutputDeviceHandle mDeviceId;
   MpResamplerBase *mpResampler;

   OsMsgQ mCopyQ;    
   OsMsgPool mCopyQPool; 
   UtlBoolean mIsCopyQEnabled; 

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   virtual UtlBoolean handleEnable();

   MprToOutputDevice(const MprToOutputDevice& rMprToOutputDevice);

   MprToOutputDevice& operator=(const MprToOutputDevice& rhs);

};

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

OsMsgQ *MprToOutputDevice::getCopyQ()
{
   return &mCopyQ;
}

#endif  // _MprToOutputDevice_h_