This file is indexed.

/usr/include/sipxtapi/mp/MpDecoderBase.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
//  
// Copyright (C) 2006-2013 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2008 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 _MpDecoderBase_h_
#define _MpDecoderBase_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/MpCodecInfo.h"
#include "mp/MpRtpBuf.h"
#include "mp/MpTypes.h"
#include "os/OsStatus.h"
#include "mp/MpPlgStaffV1.h"

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

// FORWARD DECLARATIONS
class OsNotification;

/// Base class for all media processing decoders.
class MpDecoderBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */
///@name Creators
//@{

     /// Constructor
   MpDecoderBase(int payloadType,
                 const MpCodecCallInfoV1& callInfo,
                 const MppCodecInfoV1_1& codecInfo,
                 const char* defaultFmtp);
     /**<
     *  @param[in] payloadType - RTP payload type associated with this decoder
     */

     /// Destructor
   ~MpDecoderBase();

     /// Initializes a codec data structure for use as a decoder.
   OsStatus initDecode(const char* codecFmtString);
     /**<
     *  @retval OS_SUCCESS - Success
     *  @retval OS_NO_MEMORY - Memory allocation failure
     */

     /// Initializes a codec data structure for use as a decoder using default fmtp.
   OsStatus initDecode();
     /**<
     *  @retval OS_SUCCESS - Success
     *  @retval OS_NO_MEMORY - Memory allocation failure
     */

//@}

/* ============================ MANIPULATORS ============================== */
///@name Manipulators
//@{

     /// Decode incoming RTP packet
   int decode(const MpRtpBufPtr &pPacket,
              unsigned decodedBufferLength,
              MpAudioSample *samplesBuffer);
     /**<
     *  This method is called by MprDecode for every incoming RTP packet. If
     *  codec have internal PLC, then this method is also called for every lost
     *  packet with \p pPacket=NULL to leverage codec's internal PLC.
     *  For signaling codecs (namely RFC2833/4733) right after decode()
     *  MprDecode calls getSignalingData() to retrieve decoded signaling data.
     *  That is decoder should cache this data internally between decode()
     *  and getSignalingData() calls.
     *
     *  @see getSignalingData()
     *
     *  @param[in]  pPacket - Pointer to a RTP packet. May be NULL if packet
     *              was lost.
     *  @param[in]  decodedBufferLength - Length of the samplesBuffer (in samples).
     *  @param[out] samplesBuffer - Buffer for decoded samples.
     *
     *  @returns Number of decoded samples.
     */

//@}

/* ============================ ACCESSORS ================================= */
///@name Accessors
//@{

     /// Get information about the decoder.
   const MpCodecInfo* getInfo() const;
     /**<
     *  @returns A pointer to a MpCodecInfo object that provides
     *           information about the decoder. For codecs with only one mode
     *           supported (like G.711 and GSM) it may return pointer to
     *           static class member. More complex codecs (like Speex) may
     *           return pointer to usual class member.
     */

     /// Returns the RTP payload type associated with this decoder.
   int getPayloadType();

     /// Get signaling data from last decoded packet.
   OsStatus getSignalingData(uint8_t &event,
                             UtlBoolean &isStarted,
                             UtlBoolean &isStopped,
                             uint16_t &duration);
     /**<
     *  If codec is signaling, that is it is able to carry signaling data,
     *  this function is called right after decode() to get signaling data
     *  from last decoded RTP packet.
     *
     *  @note Only DTMF digits are supported. Other signaling data is not yet
     *        supported.
     *  @note Default implementation just return OS_NOT_SUPPORTED.
     *
     *  @see decode()
     *
     *  @retval OS_SUCCESS - Last decoded packet had signaling data, \p key,
     *          \p pressState and \p duration were filled with decoded values.
     *  @retval OS_NO_MORE_DATA - Last packet had no meaningful signaling data.
     *  @retval OS_NOT_SUPPORTED - This codec is pure audio codec and could not
     *          carry any signaling data.
     */

//@}

/* ============================ INQUIRY =================================== */
///@name Inquiry
//@{

//@}

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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   int mPayloadType;         ///< RTP payload type associated with this decoder.
   MpCodecInfo mCodecInfo;   ///< Info structure for this codec
   const MpCodecCallInfoV1& mCallInfo; ///< Pointers to actual methods of
                             ///< this codec.
   void* plgHandle;          ///< Codec internal handle.
   const char* mDefaultFmtp; ///< Fmtp to use if not passed to initDecode().

   bool isInitialized() const;  ///< Is codec initialized?

   void freeDecode();

     /// Copy constructor
   MpDecoderBase(const MpDecoderBase& rMpDecoderBase);

     /// Assignment operator
   MpDecoderBase& operator=(const MpDecoderBase& rhs);
};

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

inline bool MpDecoderBase::isInitialized() const
{
   return (NULL != plgHandle);
}

#endif  // _MpDecoderBase_h_