MpAgcBase.h

Go to the documentation of this file.

//  
// 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

class MpAgcBase
{
/* //////////////////////////////// PUBLIC //////////////////////////////// */
public:

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


   static MpAgcBase *createAgc(const UtlString &name = "");
   virtual OsStatus init(int samplerate) = 0;
   virtual ~MpAgcBase() {};

   virtual void reset() = 0;


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


   virtual OsStatus processFrame(const MpAudioSample* data, int count) = 0;

   static void setDefaultAlgorithm(const UtlString& name);

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


   virtual OsStatus getAmplitude(MpAudioSample& amp, UtlBoolean &isClipped) = 0;


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




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

   static UtlString smDefaultAlgorithm; 

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

};

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

#endif  // _MpAgcBase_h_