MpOutputDeviceDriver.h

Go to the documentation of this file.

//  
// Copyright (C) 2007-2017 SIPez LLC.  All rights reserved.
//
//
// $$

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

#ifndef _MpOutputDeviceDriver_h_
#define _MpOutputDeviceDriver_h_

// SYSTEM INCLUDES
//#include <utl/UtlDefs.h>
#include <os/OsStatus.h>
#include <os/OsAtomics.h>
#include <utl/UtlString.h>

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

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

class MpOutputDeviceDriver : public UtlString
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   explicit
   MpOutputDeviceDriver(const UtlString& name);
   virtual
   ~MpOutputDeviceDriver();


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


   virtual OsStatus enableDevice(unsigned samplesPerFrame, 
                                 unsigned samplesPerSec,
                                 MpFrameTime currentFrameTime,
                                 OsCallback &frameTicker) = 0;
   virtual OsStatus disableDevice() = 0;
   virtual
   OsStatus pushFrame(unsigned int numSamples,
                      const MpAudioSample* samples,
                      MpFrameTime frameTime) = 0;

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


   inline
   MpFrameTime getFramePeriod() const;

   inline
   unsigned getSamplesPerFrame() const;

   inline
   unsigned getSamplesPerSec() const;

   static inline
   MpFrameTime getFramePeriod(unsigned samplesPerFrame,
                              unsigned samplesPerSec);

    inline
    const UtlString &getDeviceName() const;


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

   virtual OsStatus canEnable() {return(OS_SUCCESS);};
   virtual UtlBoolean isEnabled() const;


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

   OsAtomicLightBool mIsEnabled;         
   OsAtomicLightUInt mSamplesPerFrame;   
   OsAtomicLightUInt mSamplesPerSec;     
   OsCallback       *mpTickerNotification; 

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

   MpOutputDeviceDriver(const MpOutputDeviceDriver& rMpOutputDeviceDriver);

   MpOutputDeviceDriver& operator=(const MpOutputDeviceDriver& rhs);
};


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

MpFrameTime MpOutputDeviceDriver::getFramePeriod() const
{
   return getFramePeriod(mSamplesPerFrame, mSamplesPerSec);
}

MpFrameTime MpOutputDeviceDriver::getFramePeriod(unsigned samplesPerFrame,
                                                 unsigned samplesPerSec)
{
    assert(samplesPerSec);
    return(samplesPerSec ? ((1000*samplesPerFrame)/samplesPerSec) : 0);
}

unsigned MpOutputDeviceDriver::getSamplesPerFrame() const
{
   return mSamplesPerFrame;
}

unsigned MpOutputDeviceDriver::getSamplesPerSec() const
{
   return mSamplesPerSec;
}

const UtlString &MpOutputDeviceDriver::getDeviceName() const
{
   return *this;
}

#endif  // _MpOutputDeviceDriver_h_