MprHook.h

Go to the documentation of this file.

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

#ifndef _MprHook_h_
#define _MprHook_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/MpAudioResource.h"
#include "mp/MpResourceMsg.h"

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

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

   typedef void (*HookFunction)(MpBufPtr &pBuf, uint32_t time, void *pUserData);
/* ============================ CREATORS ================================== */

   MprHook(const UtlString& rName);

   virtual
   ~MprHook();


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


   static OsStatus setHook(const UtlString& namedResource,
                           OsMsgQ& fgQ,
                           HookFunction func,
                           void *pUserData);

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



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



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

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

   typedef enum
   {
      MPRM_SET_HOOK = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START
   } AddlMsgTypes;

   HookFunction  mpHook;     
   void         *mpUserData; 
   uint32_t      mFrameNum;  

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

   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);

   MprHook(const MprHook& rMprHook);

   MprHook& operator=(const MprHook& rhs);

};

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

#endif  // _MprHook_h_