MpAudioOutputConnection.h

Go to the documentation of this file.

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

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

#ifndef _MpAudioOutputConnection_h_
#define _MpAudioOutputConnection_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <mp/MpTypes.h>
#include <mp/MpOutputDeviceDriver.h>
#include <utl/UtlInt.h>
#include <os/OsMutex.h>
#include <os/OsCallback.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class MpAudioOutputConnection : public UtlInt
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   MpAudioOutputConnection(MpOutputDeviceHandle deviceId,
                           MpOutputDeviceDriver *deviceDriver);
   virtual
   ~MpAudioOutputConnection();


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


   OsStatus enableDevice(unsigned samplesPerFrame, 
                         unsigned samplesPerSec,
                         MpFrameTime currentFrameTime,
                         MpFrameTime mixerBufferLength);
   OsStatus disableDevice();
   OsStatus enableFlowgraphTicker(OsNotification *pFlowgraphTicker);
   OsStatus disableFlowgraphTicker();
   OsStatus pushFrameBeginning(unsigned int numSamples,
                               const MpAudioSample* samples,
                               MpFrameTime &frameTime);
   OsStatus pushFrame(unsigned int numSamples,
                      const MpAudioSample* samples,
                      MpFrameTime frameTime);
   inline
   unsigned increaseUseCount();
   inline
   unsigned decreaseUseCount();

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


   inline
   MpOutputDeviceDriver* getDeviceDriver() const;

   inline
   MpFrameTime getMixerBufferLength() const;

   inline
   unsigned getUseCount() const;
   inline
   unsigned getSamplesPerFrame() const;

   MpFrameTime getCurrentFrameTime() const;


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



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



   OsStatus initMixerBuffer(unsigned mixerBufferLength);
   OsStatus freeMixerBuffer();
   OsStatus mixFrame(unsigned frameOffset,
                     const MpAudioSample* samples,
                     unsigned numSamples);
   inline OsStatus isLateToMix(unsigned frameOffset,
                               unsigned numSamples) const;
   OsStatus advanceMixerBuffer(unsigned numSamples);
   static
   void readyForDataCallback(const intptr_t userData, const intptr_t eventData);

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

   mutable OsMutex mMutex;        
   int mUseCount;                 

   MpOutputDeviceDriver* mpDeviceDriver; 
   MpFrameTime mCurrentFrameTime; 

   unsigned mMixerBufferLength;   
   MpAudioSample *mpMixerBuffer;  
   unsigned mMixerBufferBegin;    

   OsCallback readyForDataCallbackNotf;  
   OsNotification *mpFlowgraphTicker; 


   MpAudioOutputConnection(const MpAudioOutputConnection& rMpAudioOutputConnection);

   MpAudioOutputConnection& operator=(const MpAudioOutputConnection& rhs);

};

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

unsigned MpAudioOutputConnection::increaseUseCount()
{
   return ++mUseCount;
}

unsigned MpAudioOutputConnection::decreaseUseCount()
{
   return --mUseCount;
}

MpOutputDeviceDriver* MpAudioOutputConnection::getDeviceDriver() const
{
   return mpDeviceDriver;
};

MpFrameTime MpAudioOutputConnection::getMixerBufferLength() const
{
   return mMixerBufferLength*1000/getDeviceDriver()->getSamplesPerSec();
}

unsigned MpAudioOutputConnection::getUseCount() const
{
   return mUseCount;
}

unsigned MpAudioOutputConnection::getSamplesPerFrame() const
{
   return getDeviceDriver()->getSamplesPerFrame();
}

OsStatus MpAudioOutputConnection::isLateToMix(unsigned frameOffset,
                                              unsigned numSamples) const
{

   // Whole frame should fit into buffer to be accepted.
   if (frameOffset+numSamples > mMixerBufferLength)
   {
      return OS_LIMIT_REACHED;
   }
   return OS_SUCCESS;
}

#endif  // _MpAudioOutputConnection_h_