/usr/include/sipxtapi/mp/MprHook.h is in libsipxtapi-dev 3.3.0~test17-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | //
// 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
/**
* @brief The "Hook" media processing resource.
*
* This resource allows some external entity to read and possibly modify
* buffers.
*/
class MprHook : public MpAudioResource
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/// Pointer to a hook function.
typedef void (*HookFunction)(MpBufPtr &pBuf, uint32_t time, void *pUserData);
/**<
* @param pBuf - audio data. May be NULL.
* @param time - timestamp of audio data (in frames).
*/
/* ============================ CREATORS ================================== */
///@name Creators
//@{
/// Constructor
MprHook(const UtlString& rName);
/// Destructor
virtual
~MprHook();
//@}
/* ============================ MANIPULATORS ============================== */
///@name Manipulators
//@{
/// Set hook function to be called for every received frame.
static OsStatus setHook(const UtlString& namedResource,
OsMsgQ& fgQ,
HookFunction func,
void *pUserData);
/**<
* Note, that you have to manage userdata lifetime by yourself.
*/
//@}
/* ============================ ACCESSORS ================================= */
///@name Accessors
//@{
//@}
/* ============================ INQUIRY =================================== */
///@name Inquiry
//@{
//@}
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
typedef enum
{
MPRM_SET_HOOK = MpResourceMsg::MPRM_EXTERNAL_MESSAGE_START
} AddlMsgTypes;
HookFunction mpHook; ///< Hook function to be called.
void *mpUserData; ///< User data to pass to hook function.
uint32_t mFrameNum; ///< Number of the current frame.
virtual UtlBoolean doProcessFrame(MpBufPtr inBufs[],
MpBufPtr outBufs[],
int inBufsSize,
int outBufsSize,
UtlBoolean isEnabled,
int samplesPerFrame,
int samplesPerSecond);
/// @copydoc MpResource::handleMessage()
virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);
/// Copy constructor (not implemented for this class)
MprHook(const MprHook& rMprHook);
/// Assignment operator (not implemented for this class)
MprHook& operator=(const MprHook& rhs);
};
/* ============================ INLINE METHODS ============================ */
#endif // _MprHook_h_
|