RTCPRender.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 _RTCPRender_h
#define _RTCPRender_h

#include "rtcp/RtcpConfig.h"

//  Includes
#include "SenderReport.h"
#include "ReceiverReport.h"
#include "SourceDescription.h"
#include "ByeReport.h"
#include "INetworkRender.h"
#include "IRTPDispatch.h"
#include "IRTCPRender.h"
#include "IRTCPStatistics.h"
#include "IRTCPNotify.h"




class CRTCPRender:
      public CBaseClass,     // Inherits CBaseClass implementation
      public IRTPDispatch,   // Inbound RTP Dispatch Interface
      public IRTCPRender,    // RTCP Sender Control Interface
      public IRTCPStatistics // RTCP Statistics Retrieval Interface

 {

//  Public Methods
public:

    CRTCPRender(ssrc_t ulSSRC,
                IRTCPNotify *piRTCPNotify,
                ISDESReport *piSDESReport=NULL);


    virtual ~CRTCPRender(void);


    bool Initialize(void);

    void GetReceiveStatInterface(ISetReceiverStatistics **ppiSetReceiverStats);

    void GetSenderStatInterface(ISetSenderStatistics    **ppiSetSenderStats);

    void SetNetworkRender(INetworkRender *piNetworkRender);

    void ClearNetworkRender(void);

    void ForwardRTPHeader(IRTPHeader *piRTPHeader);


    unsigned long ForwardSDESReport(ISDESReport *piSDESReport);


    unsigned long ForwardByeReport(IByeReport *piByeReport);

    unsigned long GenerateRTCPReports(unsigned char *puchRTCPReport=NULL,
                                      unsigned long  ulReportLength=0);

    unsigned long GenerateByeReport(ssrc_t aulCSRC[],
                                    unsigned long ulCSRCs,
                                    unsigned char *puchByeReason);


    void ReassignSSRC(ssrc_t ulSSRC);



    ssrc_t GetRemoteSSRC(void);
    bool isRemoteSSRCValid(void);

    void GetStatistics(IGetSrcDescription     **piGetSrcDescription,
                       IGetSenderStatistics   **piSenderStatistics,
                       IGetReceiverStatistics **piReceiverStatistics,
                       IGetByeInfo            **piGetByeInfo);

DECLARE_IBASE_M


private:        // Private Data Members

      IRTCPNotify * m_piRTCPNotify;

      INetworkRender *m_piNetworkRender;

      ISDESReport *m_piSDESReport;


      CSenderReport *m_poSenderReport;

      CReceiverReport *m_poReceiverReport;


      CByeReport *m_poByeReport;


      unsigned long m_ulReportCount;

      ssrc_t m_ulLocalSSRC;

      ssrc_t m_ulRemoteSSRC;

      int m_iRemoteSSRCFound;

      int mPacketCount;

};

inline ssrc_t CRTCPRender::GetRemoteSSRC(void) { return m_ulRemoteSSRC; }
inline bool CRTCPRender::isRemoteSSRCValid(void) { return (0 != m_iRemoteSSRCFound); }

inline void CRTCPRender::SetNetworkRender(INetworkRender *piNetworkRender)
{

//  Store the Network Render interface
    m_piNetworkRender = piNetworkRender;
    m_piNetworkRender->AddRef(ADD_RELEASE_CALL_ARGS(__LINE__));

}

inline void CRTCPRender::ClearNetworkRender(void)
{

//  Clear the Network Render interface
    if(m_piNetworkRender)
    {
        m_piNetworkRender->Release(ADD_RELEASE_CALL_ARGS(__LINE__));
        m_piNetworkRender = NULL;
    }

}

#endif