MpVadBase.h

Go to the documentation of this file.

//
// Copyright (C) 2008-2014 SIPez LLC. All rights reserved.
//
// Copyright (C) 2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

// Author: Sergey Kostanbaev <Sergey DOT Kostanbaev AT sipez DOT com>

#ifndef _MpVadBase_h_
#define _MpVadBase_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <utl/UtlDefs.h>
#include <os/OsStatus.h>
#include <utl/UtlString.h>
#include "mp/MpTypes.h"

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

class MpVadBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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

   virtual OsStatus init(int samplesPerSec) = 0;
   static MpVadBase *createVad(const UtlString &name = "");
   virtual ~MpVadBase() {};


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


   virtual MpSpeechType processFrame(uint32_t packetTimeStamp,
                                     const MpAudioSample* pBuf,
                                     unsigned inSamplesNum,
                                     const MpSpeechParams &speechParams,
                                     UtlBoolean calcEnergyOnly = FALSE) = 0;
   virtual OsStatus setParam(const char* paramName, void* value) = 0;
   static void setDefaultAlgorithm(const UtlString& name);
   virtual void reset() = 0;

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

   virtual int getEnergy() const = 0;

   void setName(const UtlString& name);


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



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

   static UtlString smDefaultAlgorithm; 

   UtlString mName; 

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

};

#endif // _MpVadBase_h_