rtcppacket.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### RTCP Packet                                                      ####
// ####                                                                  ####
// ####           Copyright (C) 1999-2012 by Thomas Dreibholz            ####
// ####                                                                  ####
// #### Contact:                                                         ####
// ####    EMail: dreibh@iem.uni-due.de                                  ####
// ####    WWW:   https://www.nntb.no/~dreibh/rtpaudio                ####
// ####                                                                  ####
// #### ---------------------------------------------------------------- ####
// ####                                                                  ####
// #### This program is free software: you can redistribute it and/or    ####
// #### modify it under the terms of the GNU General Public License as   ####
// #### published by the Free Software Foundation, either version 3 of   ####
// #### the License, or (at your option) any later version.              ####
// ####                                                                  ####
// #### This program is distributed in the hope that it will be useful,  ####
// #### but WITHOUT ANY WARRANTY; without even the implied warranty of   ####
// #### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    ####
// #### GNU General Public License for more details.                     ####
// ####                                                                  ####
// #### You should have received a copy of the GNU General Public        ####
// #### License along with this program.  If not, see                    ####
// #### <http://www.gnu.org/licenses/>.                                  ####
// ####                                                                  ####
// ##########################################################################
// $Id: rtcppacket.h 1315 2011-12-23 11:33:17Z dreibh $


#ifndef RTCPPACKET_H
#define RTCPPACKET_H


#include "tdsystem.h"
#include "rtppacket.h"


enum RTCP_Type
{
  RTCP_SR   = 200,
  RTCP_RR   = 201,
  RTCP_SDES = 202,
  RTCP_BYE  = 203,
  RTCP_APP  = 204
};


enum RTCP_SDES_Type
{
  RTCP_SDES_END   = 0,
  RTCP_SDES_CNAME = 1,
  RTCP_SDES_NAME  = 2,
  RTCP_SDES_EMAIL = 3,
  RTCP_SDES_PHONE = 4,
  RTCP_SDES_LOC   = 5,
  RTCP_SDES_TOOL  = 6,
  RTCP_SDES_NOTE  = 7,
  RTCP_SDES_PRIV  = 8
};


struct RTCPCommonHeader
{
   // ====== Constructor ====================================================
   public:
   RTCPCommonHeader();


   // ====== Get methods ====================================================
   inline card8 getVersion() const;

   inline card8 getPadding() const;

   inline card8 getCount() const;

   inline card8 getPacketType() const;

   inline card16 getLength() const;


   // ====== Set methods ====================================================
   inline void setVersion(const card8 version);

   inline void setPadding(const card8 padding);

   inline void setCount(const card8 count);

   inline void setPacketType(const card8 packetType);

   inline void setLength(const card16 length);


   // ====== Protected data =================================================
   protected:
#if BYTE_ORDER == BIG_ENDIAN
   card8 V:2;                         // Protocol Version
   card8 P:1;                         // Padding Flag
   card8 C:5;                         // Count varies by Packet Type (RC/SC)
#elif BYTE_ORDER == LITTLE_ENDIAN
   card8 C:5;                         // Count varies by Packet Type (RC/SC)
   card8 P:1;                         // Padding Flag
   card8 V:2;                         // Protocol Version
#else
#error "Unknown CPU_BYTEORDER setting!"
#endif
   card8 PT:8;                         // RTCP Packet Type
   card16 Length;                      // Packet length in words minus one
} __attribute__((packed));


struct RTCPSenderInfoBlock
{
   // ====== Constructor ====================================================
   public:
   RTCPSenderInfoBlock();


   // ====== Get methods ====================================================
   inline card64 getNTPTimeStamp() const;

   inline card32 getRTPTimeStamp() const;


   inline card32 getPacketsSent() const;

   inline card32 getOctetsSent() const;


   // ====== Set methods ====================================================
   inline void setNTPTimeStamp(const card64 timeStamp);

   inline void setRTPTimeStamp(const card32 timeStamp);

   inline void setPacketsSent(const card32 packets);

   inline void setOctetsSent(const card32 octets);


   // ====== Protected data =================================================
   protected:
   card32 NTP_MostSignificant;     // NTP Timestamp (most  significant word)
   card32 NTP_LeastSignificant;    // NTP Timestamp (least significant word)
   card32 RTPTimeStamp;            // RTP Timestamp
   card32 PacketsSent;             // Packets sent
   card32 OctetsSent;              // Octets sent
} __attribute__((packed));


struct RTCPReceptionReportBlock
{
   // ====== Constructor ====================================================
   public:
   RTCPReceptionReportBlock();

   RTCPReceptionReportBlock(const card32 ssrc);


   void init(const card32 ssrc);


   // ====== Get methods ====================================================
   inline card32 getSSRC() const;

   inline double getFractionLost() const;

   inline card32 getPacketsLost() const;

   inline card32 getLastSeqNum() const;

   inline card32 getJitter() const;

   inline card32 getLSR() const;

   inline card32 getDLSR() const;


   // ====== Set methods ====================================================
   inline void setSSRC(card32 ssrc);

   inline void setFractionLost(const double fraction);

   inline void setPacketsLost(const card32 packetsLost);

   inline void setLastSeqNum(const card32 lastSeq);

   inline void setJitter(const card32 jitter);

   inline void setLSR(const card32 lsr);

   inline void setDLSR(const card32 dlsr);


   // ====== Protected data =================================================
   protected:
   card32 SSRC;                           // Data Source being reported
   card32 Fraction:8;                     // Fraction lost since last SR/RR
   card32 Lost:24;                        // Cumulative no. of Packets lost (signed!)
   card32 LastSeq;                        // Extended last sequence no. received
   card32 Jitter;                         // Interarrival Jitter
   card32 LSR;                            // Last SR Packet from this source
   card32 DLSR;                           // Delay since last SR Packet
} __attribute__((packed));


struct RTCPReport : public RTCPCommonHeader
{
   // ====== Constructor ====================================================
   public:
   RTCPReport();


   // ====== Get methods ====================================================
   inline card32 getSSRC() const;


   // ====== Set methods ====================================================
   inline void setSSRC(const card32 ssrc);


   // ====== Protected data =================================================
   protected:
   card32 SSRC;                  // Sender or Receiver generating this report
} __attribute__((packed));


struct RTCPSenderReport : public RTCPReport, public RTCPSenderInfoBlock
{
   // ====== Constructor ====================================================
   public:
   RTCPSenderReport();

   RTCPSenderReport(const card32 syncSource, const card8 count = 0);


   void init(const card32 syncSource, const card8 count = 0);


   RTCPReceptionReportBlock rr[];      // Variable length RR list
} __attribute__((packed));


struct RTCPReceiverReport : public RTCPReport
{
   // ====== Constructor ====================================================
   public:
   RTCPReceiverReport();

   RTCPReceiverReport(const card32 syncSource, const card8 count = 0);


   void init(const card32 syncSource, const card8 count = 0);


   RTCPReceptionReportBlock rr[];      // Variable length RR list
} __attribute__((packed));


struct RTCPSourceDescriptionItem
{
   public:
   card8 Type;

   card8 Length;

   char Data[];
} __attribute__((packed));


struct RTCPSourceDescriptionChunk
{
   public:
   card32 SRC;

   RTCPSourceDescriptionItem Item[];
} __attribute__((packed));


struct RTCPSourceDescription : public RTCPCommonHeader
{
   // ====== Constructor ====================================================
   public:
   RTCPSourceDescription();

   RTCPSourceDescription(const card8 count);


   void init(const card8 count);


   RTCPSourceDescriptionChunk Chunk[1];
} __attribute__((packed));


struct RTCPBye : public RTCPCommonHeader
{
   // ====== Constructor ====================================================
   public:
   RTCPBye();

   RTCPBye(const card8 count);


   void init(const card8 count);


   // ====== Get methods ====================================================
   inline card32 getSource(const cardinal index) const;


   // ====== Set methods ====================================================
   inline void setSource(const cardinal index, const card32 source);


   // ====== Private data ===================================================
   private:
   card32 Source[];
} __attribute__((packed));


struct RTCPApp : public RTCPCommonHeader
{
   // ====== Constructor ====================================================
   public:
   RTCPApp();

   RTCPApp(const card8 subtype);


   /*
     * Initialize.
     * @param subtype RTCP APP subtype.
     */
   void init(const card8 subtype);


   // ====== Get methods ====================================================
   inline card32 getSource() const;

   inline char* getName();

   inline char* getData();


   // ====== Set methods ====================================================
   inline void setSource(const card32 source);

   inline void setName(const char* name);


   // ====== Private data ===================================================
   private:
   card32 Source;
   char   Name[4];
   char   Data[];
} __attribute__((packed));


#include "rtcppacket.icc"


#endif