MpJitterBuffer.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2014 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 _MpJitterBuffer_h_
#define _MpJitterBuffer_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/MpRtpBuf.h"
#include "mp/MpAudioBuf.h"
#include "mp/MpResampler.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpDecoderPayloadMap;
class MpPlcBase;
class MpVadBase;
class MpAgcBase;
class MpFlowGraphBase;

class MpJitterBuffer
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   MpJitterBuffer(MpDecoderPayloadMap *pPayloadMap = NULL,
                  const UtlString& resourceName = "unknown");
   void init(unsigned int samplesPerSec, unsigned int samplesPerFrame);
   ~MpJitterBuffer();


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


   void reset();

   OsStatus pushPacket(const MpRtpBufPtr &rtpPacket,
                       int minBufferSamples,
                       int wantedBufferSamples,
                       int &decodedSamples,
                       int &adjustment,
                       UtlBoolean &played);
   void getFrame(MpAudioBufPtr &pFrame, int &numOriginalSamples);
   void setCodecList(MpDecoderPayloadMap *pPayloadMap);

   void setPlc(const UtlString &plcName);



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


   void setFlowGraph(MpFlowGraphBase* pFlowgraph);

   inline
   int getSamplesNum() const;

   OsStatus setVadParam(const UtlString& name, int value);


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



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

   int adjustStream(MpAudioSample *pBuffer, int bufferSize, unsigned numSamples,
                    int wantedAdjustment);

   OsStatus sliceToFrames(int decodedSamples, int codecSampleRate,
                          const MpSpeechParams &speechParams);

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

   enum {
      FRAMES_TO_STORE = 32,         
      DECODED_DATA_MAX_LENGTH = 10 * 160 
   };


   int mStreamSampleRate;           
   int mOutputSampleRate;           
   int mSamplesPerFrame;            
   MpAudioSample mDecodedData[DECODED_DATA_MAX_LENGTH]; 
   MpResamplerBase *mpResampler;    



   unsigned mCurFrameNum;           
   unsigned mRemainingSamplesNum;   
   MpAudioBufPtr mFrames[FRAMES_TO_STORE]; 
   int mOriginalSamples[FRAMES_TO_STORE]; 



   UtlBoolean mIsFirstPacket;       
   RtpSeq mStreamSeq;               
   RtpTimestamp mStreamTimestamp;   
   uint8_t mStreamRtpPayload;       
   MpDecoderPayloadMap *mpPayloadMap; 
   unsigned mSamplesPerPacket;      


   UtlString  mPlcName;             
   MpPlcBase *mpPlc;                
   MpVadBase *mpVad;                
   MpAgcBase *mpAgc;                
   MpFlowGraphBase* mpFlowGraph;    

   MpJitterBuffer(const MpJitterBuffer& rMpJitterBuffer);

   MpJitterBuffer& operator=(const MpJitterBuffer& rhs);
};

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

int MpJitterBuffer::getSamplesNum() const
{
   return mRemainingSamplesNum;
}

#endif  // _MpJitterBuffer_h_