MprDejitter.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2010 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// 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 _MprDejitter_h_
#define _MprDejitter_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsStatus.h"
#include "os/OsBSem.h"
#include "mp/MpRtpBuf.h"
#include "utl/UtlString.h"

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

class MprDejitter
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   enum {
      MAX_RTP_PACKETS = 256   
   };

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


   MprDejitter(MpConnectionID connId=MP_INVALID_CONNECTION_ID, int streamId=-1);

   virtual
   ~MprDejitter();


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


   void reset();

   OsStatus pushPacket(MpRtpBufPtr &pRtp);
   MpRtpBufPtr pullPacket();
   MpRtpBufPtr pullPacket(RtpTimestamp timestamp,
                          UtlBoolean *nextFrameAvailable = NULL,
                          bool lockTimestamp=true);
   void setConnectionId(MpConnectionID connId);

   void setStreamId(int streamId);

   void setFlowgrapName(const UtlString &fgName);


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


   inline int getNumPackets() const;

   inline int getNumLatePackets() const;

   OsStatus getFirstPacketInfo(RtpSeq& packetSeq, RtpTimestamp& packetTime) const;


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



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

   MpRtpBufPtr   mpPackets[MAX_RTP_PACKETS];
   int           mNumPackets;
   int           mNumLatePackets;
   int           mNumDiscarded;
   int           mLastPushed;
   UtlBoolean    mIsFirstPulledPacket;
   RtpSeq        mMaxPulledSeqNo;
   MpConnectionID mConnectionId;
   int           mStreamId;
   UtlString     mFlowgraphName;
   UtlString     mResourceName;

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

   MprDejitter(const MprDejitter& rMprDejitter);

   MprDejitter& operator=(const MprDejitter& rhs);

};

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

int MprDejitter::getNumPackets() const
{
   return mNumPackets;
}

int MprDejitter::getNumLatePackets() const
{
   return mNumLatePackets;
}

#endif  // _MprDejitter_h_