/usr/include/sipxtapi/mp/MpAgcBase.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 | //
// Copyright (C) 2008 SIPez LLC.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$
///////////////////////////////////////////////////////////////////////////////
// Author: Sergey Kostanbaev <Sergey DOT Kostanbaev AT sipez DOT com>
#ifndef _MpAgcBase_h_
#define _MpAgcBase_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlString.h"
#include "mp/MpTypes.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
/**
* @brief Base class for AGC algorithm.
*
* @nosubgrouping
*/
class MpAgcBase
{
/* //////////////////////////////// PUBLIC //////////////////////////////// */
public:
/* =============================== CREATORS =============================== */
///@name Creators
//@{
/// Factory method for VAD algorithms creation.
static MpAgcBase *createAgc(const UtlString &name = "");
/**<
* @param[in] name - name of AGC algorithm to use. Use empty string
* to get default algorithm.
*
* @returns Method never returns NULL. If appropriate AGC algorithm is
* not found, default one is returned.
*/
/// Initialize AGC with given sample rate.
virtual OsStatus init(int samplerate) = 0;
/**<
* Should be called before any other class methods.
*/
/// Destructor
virtual ~MpAgcBase() {};
/// Reset
virtual void reset() = 0;
//@}
/* ============================= MANIPULATORS ============================= */
///@name Manipulators
//@{
/// Calculate amplitude of the frame.
virtual OsStatus processFrame(const MpAudioSample* data, int count) = 0;
/// Set algorithm to be used by default.
static void setDefaultAlgorithm(const UtlString& name);
/**<
* Initially default algorithm is defined at compile time. Using this
* function you can change default algorithm at run-time or switch back to
* compile-time default.
*
* @param[in] name - name of algorithm to use by default. Reverts to
* compile-time default if empty.
*/
//@}
/* ============================== ACCESSORS =============================== */
///@name Accessors
//@{
/// Get amplitude of the last processed frame.
virtual OsStatus getAmplitude(MpAudioSample& amp, UtlBoolean &isClipped) = 0;
//@}
/* =============================== INQUIRY ================================ */
///@name Inquiry
//@{
//@}
/* ////////////////////////////// PROTECTED /////////////////////////////// */
protected:
static UtlString smDefaultAlgorithm; ///< Name of algorithm to be used by default.
/* /////////////////////////////// PRIVATE //////////////////////////////// */
private:
};
/* ============================ INLINE METHODS ============================ */
#endif // _MpAgcBase_h_
|