MpSineWaveGeneratorDeviceDriver.h

Go to the documentation of this file.

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

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

#ifndef _MpSineWaveGeneratorDeviceDriver_h_
#define _MpSineWaveGeneratorDeviceDriver_h_

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

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

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

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

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


    MpSineWaveGeneratorDeviceDriver(const UtlString& name,
                                    MpInputDeviceManager& deviceManager,
                                    unsigned int magnitude,
                                    unsigned int periodInMicroseconds,
                                    int relativeSpeed);
    virtual
    ~MpSineWaveGeneratorDeviceDriver();


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

    virtual OsStatus enableDevice(unsigned samplesPerFrame, 
                                  unsigned samplesPerSec,
                                  MpFrameTime currentFrameTime);
    virtual OsStatus disableDevice();
    virtual OsStatus setTone(unsigned int periodInMicroseconds);

    virtual OsStatus setMagnitude(unsigned int magnitude);

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



    static MpAudioSample calculateSample(MpFrameTime frameStartTime,
                                         unsigned int magnitude,
                                         unsigned int periodInMicroseconds,
                                         unsigned int frameSampleIndex,
                                         unsigned int samplesPerFrame, 
                                         unsigned int samplesPerSecond);

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


    inline UtlBoolean isDeviceValid();



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


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

    MpSineWaveGeneratorDeviceDriver(const MpSineWaveGeneratorDeviceDriver& rMpSineWaveGeneratorDeviceDriver);

    MpSineWaveGeneratorDeviceDriver& operator=(const MpSineWaveGeneratorDeviceDriver& rhs);

    unsigned int mMagnitude;
    unsigned int mPeriodInMicroseconds;
    int mRelativeSpeed;
    OsServerTask* mpReaderTask;
};

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

UtlBoolean MpSineWaveGeneratorDeviceDriver::isDeviceValid()
{
   // This test driver is always valid.
   return TRUE;
}

#endif  // _MpSineWaveGeneratorDeviceDriver_h_