rtp.h

/*
  The oRTP library is an RTP (Realtime Transport Protocol - rfc3550) stack.
  Copyright (C) 2001  Simon MORLAT simon.morlat@linphone.org
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library 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
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
 
#ifndef RTP_H
#define RTP_H
 
#include <ortp/port.h>
#include <ortp/str_utils.h>
 
#define IPMAXLEN 20
#define UDP_MAX_SIZE 1500
#define RTP_FIXED_HEADER_SIZE 12
#define RTP_DEFAULT_JITTER_TIME 80       /*miliseconds*/
#define RTP_DEFAULT_MULTICAST_TTL 5      /*hops*/
#define RTP_DEFAULT_MULTICAST_LOOPBACK 0 /*false*/
#define RTP_DEFAULT_DSCP 0x00            /*best effort*/
 
typedef struct rtp_header {
#ifdef ORTP_BIGENDIAN
  uint16_t version : 2;
  uint16_t padbit : 1;
  uint16_t extbit : 1;
  uint16_t cc : 4;
  uint16_t markbit : 1;
  uint16_t paytype : 7;
#else
  uint16_t cc : 4;
  uint16_t extbit : 1;
  uint16_t padbit : 1;
  uint16_t version : 2;
  uint16_t paytype : 7;
  uint16_t markbit : 1;
#endif
  uint16_t seq_number;
  uint32_t timestamp;
  uint32_t ssrc;
  uint32_t csrc[16];
} rtp_header_t;
 
#define ONE_BYTE_EXTENSION_ID 0xBEDE
#define ONE_BYTE_EXTENSION_SIZE 1
#define ONE_BYTE_EXTENSION_RESERVED_ID 15
#define ONE_BYTE_EXTENSION_PADDING_ID 0
 
#define RTPEXT_SSRCAUDIOLEVEL 1
#define RTPEXT_SDESMID 2
#define RTPEXT_ABSOLUTESENDTIME 3
 
typedef struct rtp_stats {
  uint64_t packet_sent;
  uint64_t sent;            /* bytes sent */
  uint64_t recv;            /* bytes of payload received and delivered in time to the application */
  uint64_t hw_recv;         /* bytes of payload received */
  uint64_t packet_recv;     /* number of packets received */
  uint64_t unavaillable;    /* totally useless*/
  uint64_t outoftime;       /* number of packets that were received too late */
  uint64_t cum_packet_loss; /* cumulative number of packet lost */
  uint64_t bad;             /* packets that did not appear to be RTP */
  uint64_t discarded;       /* incoming packets discarded because the queue exceeds its max size */
  float average_jitter;
 
  uint64_t voip_metrics_loss_count;
  uint64_t voip_metrics_discard_count;
  uint64_t voip_metrics_pkt_received_count;
  uint64_t gmin;
  uint64_t voip_metrics_lost_within_current_burst;
 
  uint64_t c11;
  uint64_t c14;
  uint64_t c13;
  uint64_t c22;
  uint64_t c23;
  uint64_t c31;
  uint64_t c32;
  uint64_t c33;
 
  float burst_density;
  float gap_density;
  uint64_t burst_length;
  uint64_t gap_length;
  uint64_t frameduration_ms;
} rtp_stats_t;
 
typedef struct rtp_extended_stats {
  double rtt;                        /* round trip time (sec) extracted from RTCP reports */
  double cur_packet_loss_fraction;   /* current packet loss fraction (percentage) */
  uint16_t djb_nominal_delay;        /* De-jitter buffer nominal delay (ms) */
  uint16_t djb_max_delay;            /* De-jitter buffer maximum delay (ms) */
  uint16_t djb_nominal_delay_hwmark; /* De-jitter buffer nominal delay high-water mark (ms) */
  uint16_t djb_max_delay_lwmark;     /* De-jitter buffer nominal delay low-water mark (ms) */
 
  double remote_cur_packet_loss_fraction; /* current packet loss fraction (percentage) */
} rtp_extended_stats_t;
 
#define RTP_TIMESTAMP_IS_NEWER_THAN(ts1, ts2) ((uint32_t)((uint32_t)(ts1) - (uint32_t)(ts2)) < (UINT32_C(1) << 31))
 
#define RTP_TIMESTAMP_IS_STRICTLY_NEWER_THAN(ts1, ts2) (((uint32_t)((uint32_t)(ts1) - (uint32_t)(ts2)) < (UINT32_C(1) << 31)) && (ts1) != (ts2))
 
#define TIME_IS_NEWER_THAN(t1, t2) RTP_TIMESTAMP_IS_NEWER_THAN(t1, t2)
 
#define TIME_IS_STRICTLY_NEWER_THAN(t1, t2) RTP_TIMESTAMP_IS_STRICTLY_NEWER_THAN(t1, t2)
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* packet api */
/* the first argument is a mblk_t. The header is supposed to be not splitted  */
#define rtp_set_markbit(mp, value) ((rtp_header_t *) ((mp)->b_rptr))->markbit = (value)
#define rtp_set_seqnumber(mp, seq) ((rtp_header_t *) ((mp)->b_rptr))->seq_number = (seq)
#define rtp_set_timestamp(mp, ts) ((rtp_header_t *) ((mp)->b_rptr))->timestamp = (ts)
#define rtp_set_ssrc(mp, _ssrc) ((rtp_header_t *) ((mp)->b_rptr))->ssrc = (_ssrc)
void rtp_add_csrc(mblk_t *mp, uint32_t csrc);
#define rtp_set_payload_type(mp, pt) ((rtp_header_t *) ((mp)->b_rptr))->paytype = (pt)
#define rtp_set_extbit(mp, value) ((rtp_header_t *) ((mp)->b_rptr))->extbit = (value)
 
#define rtp_get_markbit(mp) (((rtp_header_t *) ((mp)->b_rptr))->markbit)
#define rtp_get_timestamp(mp) (((rtp_header_t *) ((mp)->b_rptr))->timestamp)
#define rtp_get_seqnumber(mp) (((rtp_header_t *) ((mp)->b_rptr))->seq_number)
#define rtp_get_payload_type(mp) (((rtp_header_t *) ((mp)->b_rptr))->paytype)
#define rtp_get_ssrc(mp) (((rtp_header_t *) ((mp)->b_rptr))->ssrc)
#define rtp_get_cc(mp) (((rtp_header_t *) ((mp)->b_rptr))->cc)
#define rtp_get_csrc(mp, idx) (((rtp_header_t *) ((mp)->b_rptr))->csrc[idx])
#define rtp_get_extbit(mp) (((rtp_header_t *) ((mp)->b_rptr))->extbit)
#define rtp_get_padbit(mp) (((rtp_header_t *) ((mp)->b_rptr))->padbit)
 
int rtp_get_payload(mblk_t *packet, unsigned char **start);
 
#ifdef __cplusplus
}
#endif
 
#endif