ReceiverReport.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2013 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2006 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.
//
// $$


//  Border Guard
#ifndef _ReceiverReport_h
#define _ReceiverReport_h

#include "rtcp/RtcpConfig.h"

//  Includes
#include "RTPHeader.h"
#include "RTCPHeader.h"
#include "IReceiverReport.h"
#include "IGetReceiverStatistics.h"
#include "ISetReceiverStatistics.h"



class CReceiverReport : public CBaseClass,
                                 // Inherits CBaseClass implementation
                        public CRTCPHeader,
                                 // Inherits the CRTCPHeader implementation
                        public IReceiverReport,
                                 // Receiver Report Control Interface
                        public IGetReceiverStatistics,
                                 // Get Receiver Statistics Interface
                        public ISetReceiverStatistics
                                 // Set Receiver Statistics Interface
 {

//  Public Methods
public:

    CReceiverReport(ssrc_t ulSSRC=0, unsigned long ulVersion=2);


    ~CReceiverReport(void);


    void SetRTPStatistics(IRTPHeader *piRTPHeader);


    void SetLastRcvdSRTime(uint32_t aulNTPTimestamp[]);


    void GetReceiverStatistics(uint32_t  *pulFractionalLoss,
                               uint32_t  *pulCumulativeLoss,
                               uint32_t  *pulHighestSequenceNo,
                               uint32_t  *pulInterarrivalJitter,
                               uint32_t  *pulSRTimestamp,
                               uint32_t  *pulPacketDelay);



    unsigned long FormatReceiverReport(bool           bSRPresent,
                                       unsigned char *puchReportBuffer,
                                       unsigned long ulBufferSize);



    unsigned long  ParseReceiverReport(bool bHeader,
                                    unsigned char *puchReportBuffer);

    ssrc_t GetSSRC(void);

    virtual void SetSSRC(ssrc_t ulSSRC);


DECLARE_IBASE_M

   private:     // Private Methods


    void SetRemoteSSRC(IRTPHeader *piRTPHeader);

    void UpdateJitter(IRTPHeader *pIRTPHeader);


    void UpdateSequence(IRTPHeader *piRTPHeader);

    void UpdateSequenceNumbers(ssrc_t ulSequenceNo);

    void IncrementPacketCounters(void);


    void UpdateLostPackets(void);


    unsigned long LoadRemoteSSRC(ssrc_t *pulPayloadBuffer);

    unsigned long LoadLossStatistics(uint32_t *pulPayloadBuffer);

    unsigned long LoadExtendedSequence(uint32_t *pulPayloadBuffer);

    unsigned long LoadJitter(uint32_t *pulPayloadBuffer);

    unsigned long LoadReportTimes(uint32_t *pulPayloadBuffer);

    unsigned long ExtractRemoteSSRC(uint32_t *pulPayloadBuffer);

    unsigned long ExtractLossStatistics(uint32_t *pulPayloadBuffer);

    unsigned long ExtractExtendedSequence(uint32_t *pulPayloadBuffer);

    unsigned long ExtractJitter(uint32_t *pulPayloadBuffer);

    unsigned long ExtractReportTimes(uint32_t *pulPayloadBuffer);


    void ResetPeriodCounts(void);

    void ResetStatistics(void);


   private:     // Private Data Members


      CRITICAL_SECTION m_csSynchronized;

      ssrc_t m_ulRemoteSSRC;

      uint32_t m_ulTotalPacketCount;

      uint32_t m_ulPeriodPacketCount;

      uint32_t m_ulPeriodPacketLoss;

      uint32_t m_ulFractionalLoss;


      uint32_t m_ulCumulativeLoss;

     uint32_t m_ulFirstSequenceNo;

     uint32_t m_ulLastSequenceNo;

     uint32_t m_ulSequenceWraps;


     uint32_t m_ulHighestSequenceNo;

     uint32_t m_ulLastPeriodExpectedCount;


     uint32_t m_ulLastPeriodPacketCount;

     uint32_t m_ulLastPacketSendTime;

     uint32_t m_ulLastPacketReceiveTime;


     uint32_t  m_ulMeanJitter;


     uint32_t m_ulLastSRTimestamp;

     double m_dLastSRRcvdTimestamp;


     uint32_t  m_ulSRDelay;

     uint32_t  m_ulCachedFractionalLoss;
     uint32_t  m_ulCachedCumulativeLoss;
     uint32_t  m_ulCachedHighestSequenceNo;
     uint32_t  m_ulCachedMeanJitter;
     uint32_t  m_ulCachedLastSRTimestamp;
     uint32_t  m_ulCachedSRDelay;

     int mTotalPackets;
     int mTotalWarnings;

};

inline ssrc_t CReceiverReport::GetSSRC(void)
{

    return(CRTCPHeader::GetSSRC());

}

#endif