MpInputDeviceDriver.h

Go to the documentation of this file.

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

// Author: Dan Petrie <dpetrie AT SIPez DOT com>

#ifndef _MpInputDeviceDriver_h_
#define _MpInputDeviceDriver_h_

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

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

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

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

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


    MpInputDeviceDriver(const UtlString& name,
                        MpInputDeviceManager& deviceManager);
    virtual
    ~MpInputDeviceDriver();


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

    virtual OsStatus enableDevice(unsigned samplesPerFrame, 
                                  unsigned samplesPerSec,
                                  MpFrameTime currentFrameTime=0
                                  ) = 0;
    virtual OsStatus disableDevice() = 0;
    virtual OsStatus setDeviceId(MpInputDeviceHandle deviceId);

    virtual OsStatus clearDeviceId();


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


    virtual MpInputDeviceHandle getDeviceId() const;

    inline uint32_t getSamplesPerSec() const;

    inline uint32_t getSamplesPerFrame() const;

    inline MpFrameTime getFramePeriod();

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

    inline MpFrameTime getCurrentFrameTime() const;

    inline const UtlString &getDeviceName() const;


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


    virtual UtlBoolean isEnabled();

    virtual UtlBoolean isDeviceValid() = 0;


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

    MpInputDeviceManager* mpInputDeviceManager;  
    UtlBoolean mIsEnabled;         
    MpInputDeviceHandle mDeviceId; 
    unsigned mSamplesPerFrame;     
    unsigned mSamplesPerSec;       
    MpFrameTime mCurrentFrameTime; 
    

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

    MpInputDeviceDriver(const MpInputDeviceDriver& rMpInputDeviceDriver);

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

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

uint32_t MpInputDeviceDriver::getSamplesPerSec() const
{
   return mSamplesPerSec;
}

uint32_t MpInputDeviceDriver::getSamplesPerFrame() const
{
   return mSamplesPerFrame;
}

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

MpFrameTime MpInputDeviceDriver::getFramePeriod(unsigned int samplesPerFrame,
                                                unsigned int samplesPerSec)
{
   return (1000*samplesPerFrame)/samplesPerSec;
}

MpFrameTime MpInputDeviceDriver::getCurrentFrameTime() const
{
   return mCurrentFrameTime;
}

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

#endif  // _MpInputDeviceDriver_h_