MprToneGen.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _MprToneGen_h_
#define _MprToneGen_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/dtmflib.h"
#include "mp/MpFlowGraphMsg.h"
#include "mp/MpAudioResource.h"

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

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

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


   MprToneGen(const UtlString& rName, const char* locale);

   virtual
   ~MprToneGen();


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


#ifdef LATER
/* Later (soon) this will be incorporated, but this is not quite the right
implementation.  At least these changes are needed:
(1) this should be an overriding virtual function, named
    handleSetSamplesPerSec.
(2) MpResource (the base class) needs to be enhanced so that the base
    virtual function exists to be overridden.
*/

   virtual UtlBoolean setSamplesPerSec(int samplesPerSec);
     // Returns FALSE if the specified rate is not supported, TRUE otherwise.
#endif

   OsStatus startTone(int toneId);
   static OsStatus startTone(const UtlString& namedResource,
                             OsMsgQ& fgQ,
                             int toneId);
   OsStatus stopTone(void);
   static OsStatus stopTone(const UtlString& namedResource,
                            OsMsgQ& fgQ);

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



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



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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   typedef enum
   {
      START_TONE = MpFlowGraphMsg::RESOURCE_SPECIFIC_START,
      STOP_TONE
   } AddlMsgTypes;

   static const int MIN_SAMPLE_RATE;
   static const int MAX_SAMPLE_RATE;

   MpToneGenPtr mpToneGenState;
   const char*  mpLocale;

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

   virtual UtlBoolean handleMessage(MpFlowGraphMsg& fgMsg);

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);
   MprToneGen(const MprToneGen& rMprToneGen);

   MprToneGen& operator=(const MprToneGen& rhs);

};

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

#endif  // _MprToneGen_h_