SenderReport.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 _SenderReport_h
#define _SenderReport_h

#include "rtcp/RtcpConfig.h"

//  Includes
#ifndef WIN32
#include <time.h>
#endif

#include "RTCPHeader.h"
#include "ISenderReport.h"
#include "IGetSenderStatistics.h"
#include "ISetSenderStatistics.h"
#include "ISetReceiverStatistics.h"


class CSenderReport:
       public CBaseClass,           // Inherits the CBaseClass implementation
       public CRTCPHeader,          // Inherits the CRTCPHeader implementation
       public ISenderReport,        // Sender Report Control Interface
       public IGetSenderStatistics, // Get Sender Statistics Interface
       public ISetSenderStatistics  // Set Sender Statistics Interface
{

//  Public Methods
public:

    CSenderReport(ssrc_t ulSSRC,
                  ISetReceiverStatistics *piSetStatistics=NULL);



    ~CSenderReport(void);


    void IncrementCounts(uint32_t ulOctetCount, rtpts_t RTPTimestampBase, rtpts_t RTPTimestamp, ssrc_t ssrc);

    void CSR_SetRTPTimestamp(uint32_t ulRandomOffset,
                         uint32_t ulSamplesPerSecond = SAMPLES_PER_SEC);



    virtual void SetSRAdjustUSecs(int iUSecs = 0);


    void GetSenderStatistics(uint32_t *ulPacketCount,
                             uint32_t *ulOctetCount);

    ssrc_t GetSSRC(void);


    virtual void SetSSRC(ssrc_t ulSSRC);

    bool WasMediaSent(void);


    unsigned long FormatSenderReport(unsigned char *puchReportBuffer,
                                     unsigned long ulBufferSize=0);


unsigned long ParseSenderReport(unsigned char *puchReportBuffer);

DECLARE_IBASE_M

private:        // Private Methods


    void ResetStatistics(void);

    unsigned long LoadTimestamps(uint32_t *paulTimeStamps);



    unsigned long  LoadSenderStats(uint32_t *paulSenderStats);


    unsigned long ExtractTimestamps(uint32_t *paulTimestamps);


    unsigned long  ExtractSenderStats(uint32_t *aulSenderStats);



private:        // Private Data Members


      ISetReceiverStatistics *m_piSetReceiverStatistics;

      uint32_t m_ulPacketCount;

      uint32_t m_ulOctetCount;

      bool          m_bMediaSent;

      uint32_t m_aulNTPTimestamp[2];


      uint32_t m_aulNTPStartTime[2];

      rtpts_t m_ulRTPTimestamp;

    rtpts_t m_ulRTPTimestampBase;
    rtpts_t m_ulRTPTimestamps[2];
    uint32_t m_ulNTPSeconds[2];
    uint32_t m_ulNTPuSecs[2];

    int m_iTSCollectState;

/*
 * And this is a fudge-factor to be applied to the RTP timestamp
 *  calculation in the SR generation.  It is the (signed) number of
 *  microseconds to adjust the clock time by when extrapolating the
 *  RTP timestamp, to compensate for delay in the MpMedia system.
 * Yes, it is a bit of a hack...
 */

    int m_iUSecAdjust;
};


inline ssrc_t CSenderReport::GetSSRC(void)
{

    return(CRTCPHeader::GetSSRC());

}

#endif