MpPlcBase.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 _MpPlcBase_h_
#define _MpPlcBase_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 MpPlcBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


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

   virtual void reset() = 0;

   virtual void fullReset() = 0;


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


   virtual OsStatus insertToHistory(int frameNum,
                                    const MpSpeechParams &speechParams,
                                    MpAudioSample* pBuf,
                                    unsigned inSamplesNum) = 0;
   virtual OsStatus processFrame(MpSpeechParams &speechParams,
                                 MpAudioSample* pBuf,
                                 unsigned bufferSize,
                                 unsigned inSamplesNum,
                                 unsigned outSamplesNum,
                                 int wantedAdjustment,
                                 int &madeAdjustment) = 0;
   static void setDefaultAlgorithm(const UtlString& name);

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


   virtual int getMaxDelayedFramesNum() const = 0;
   virtual int getMaxFutureFramesNum() const = 0;
   virtual int getAlgorithmicDelay() const = 0;


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



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

   static UtlString smDefaultAlgorithm; 

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

};

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

#endif //_MpPlcBase_h_