git.sesse.net Git - ffmpeg/blob - libavformat/rtpdec.c

   1 /*
   2  * RTP input format
   3  * Copyright (c) 2002 Fabrice Bellard
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /* needed for gethostname() */
  23 #define _XOPEN_SOURCE 600
  24
  25 #include "libavcodec/get_bits.h"
  26 #include "avformat.h"
  27 #include "mpegts.h"
  28
  29 #include <unistd.h>
  30 #include "network.h"
  31
  32 #include "rtpdec.h"
  33 #include "rtpdec_formats.h"
  34
  35 //#define DEBUG
  36
  37 /* TODO: - add RTCP statistics reporting (should be optional).
  38
  39          - add support for h263/mpeg4 packetized output : IDEA: send a
  40          buffer to 'rtp_write_packet' contains all the packets for ONE
  41          frame. Each packet should have a four byte header containing
  42          the length in big endian format (same trick as
  43          'url_open_dyn_packet_buf')
  44 */
  45
  46 /* statistics functions */
  47 RTPDynamicProtocolHandler *RTPFirstDynamicPayloadHandler= NULL;
  48
  49 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler)
  50 {
  51     handler->next= RTPFirstDynamicPayloadHandler;
  52     RTPFirstDynamicPayloadHandler= handler;
  53 }
  54
  55 void av_register_rtp_dynamic_payload_handlers(void)
  56 {
  57     ff_register_dynamic_payload_handler(&ff_mp4v_es_dynamic_handler);
  58     ff_register_dynamic_payload_handler(&ff_mpeg4_generic_dynamic_handler);
  59     ff_register_dynamic_payload_handler(&ff_amr_nb_dynamic_handler);
  60     ff_register_dynamic_payload_handler(&ff_amr_wb_dynamic_handler);
  61     ff_register_dynamic_payload_handler(&ff_h263_1998_dynamic_handler);
  62     ff_register_dynamic_payload_handler(&ff_h263_2000_dynamic_handler);
  63     ff_register_dynamic_payload_handler(&ff_h264_dynamic_handler);
  64     ff_register_dynamic_payload_handler(&ff_vorbis_dynamic_handler);
  65     ff_register_dynamic_payload_handler(&ff_theora_dynamic_handler);
  66     ff_register_dynamic_payload_handler(&ff_qdm2_dynamic_handler);
  67     ff_register_dynamic_payload_handler(&ff_svq3_dynamic_handler);
  68
  69     ff_register_dynamic_payload_handler(&ff_ms_rtp_asf_pfv_handler);
  70     ff_register_dynamic_payload_handler(&ff_ms_rtp_asf_pfa_handler);
  71 }
  72
  73 static int rtcp_parse_packet(RTPDemuxContext *s, const unsigned char *buf, int len)
  74 {
  75     if (buf[1] != 200)
  76         return -1;
  77     s->last_rtcp_ntp_time = AV_RB64(buf + 8);
  78     if (s->first_rtcp_ntp_time == AV_NOPTS_VALUE)
  79         s->first_rtcp_ntp_time = s->last_rtcp_ntp_time;
  80     s->last_rtcp_timestamp = AV_RB32(buf + 16);
  81     return 0;
  82 }
  83
  84 #define RTP_SEQ_MOD (1<<16)
  85
  86 /**
  87 * called on parse open packet
  88 */
  89 static void rtp_init_statistics(RTPStatistics *s, uint16_t base_sequence) // called on parse open packet.
  90 {
  91     memset(s, 0, sizeof(RTPStatistics));
  92     s->max_seq= base_sequence;
  93     s->probation= 1;
  94 }
  95
  96 /**
  97 * called whenever there is a large jump in sequence numbers, or when they get out of probation...
  98 */
  99 static void rtp_init_sequence(RTPStatistics *s, uint16_t seq)
 100 {
 101     s->max_seq= seq;
 102     s->cycles= 0;
 103     s->base_seq= seq -1;
 104     s->bad_seq= RTP_SEQ_MOD + 1;
 105     s->received= 0;
 106     s->expected_prior= 0;
 107     s->received_prior= 0;
 108     s->jitter= 0;
 109     s->transit= 0;
 110 }
 111
 112 /**
 113 * returns 1 if we should handle this packet.
 114 */
 115 static int rtp_valid_packet_in_sequence(RTPStatistics *s, uint16_t seq)
 116 {
 117     uint16_t udelta= seq - s->max_seq;
 118     const int MAX_DROPOUT= 3000;
 119     const int MAX_MISORDER = 100;
 120     const int MIN_SEQUENTIAL = 2;
 121
 122     /* source not valid until MIN_SEQUENTIAL packets with sequence seq. numbers have been received */
 123     if(s->probation)
 124     {
 125         if(seq==s->max_seq + 1) {
 126             s->probation--;
 127             s->max_seq= seq;
 128             if(s->probation==0) {
 129                 rtp_init_sequence(s, seq);
 130                 s->received++;
 131                 return 1;
 132             }
 133         } else {
 134             s->probation= MIN_SEQUENTIAL - 1;
 135             s->max_seq = seq;
 136         }
 137     } else if (udelta < MAX_DROPOUT) {
 138         // in order, with permissible gap
 139         if(seq < s->max_seq) {
 140             //sequence number wrapped; count antother 64k cycles
 141             s->cycles += RTP_SEQ_MOD;
 142         }
 143         s->max_seq= seq;
 144     } else if (udelta <= RTP_SEQ_MOD - MAX_MISORDER) {
 145         // sequence made a large jump...
 146         if(seq==s->bad_seq) {
 147             // two sequential packets-- assume that the other side restarted without telling us; just resync.
 148             rtp_init_sequence(s, seq);
 149         } else {
 150             s->bad_seq= (seq + 1) & (RTP_SEQ_MOD-1);
 151             return 0;
 152         }
 153     } else {
 154         // duplicate or reordered packet...
 155     }
 156     s->received++;
 157     return 1;
 158 }
 159
 160 #if 0
 161 /**
 162 * This function is currently unused; without a valid local ntp time, I don't see how we could calculate the
 163 * difference between the arrival and sent timestamp.  As a result, the jitter and transit statistics values
 164 * never change.  I left this in in case someone else can see a way. (rdm)
 165 */
 166 static void rtcp_update_jitter(RTPStatistics *s, uint32_t sent_timestamp, uint32_t arrival_timestamp)
 167 {
 168     uint32_t transit= arrival_timestamp - sent_timestamp;
 169     int d;
 170     s->transit= transit;
 171     d= FFABS(transit - s->transit);
 172     s->jitter += d - ((s->jitter + 8)>>4);
 173 }
 174 #endif
 175
 176 int rtp_check_and_send_back_rr(RTPDemuxContext *s, int count)
 177 {
 178     ByteIOContext *pb;
 179     uint8_t *buf;
 180     int len;
 181     int rtcp_bytes;
 182     RTPStatistics *stats= &s->statistics;
 183     uint32_t lost;
 184     uint32_t extended_max;
 185     uint32_t expected_interval;
 186     uint32_t received_interval;
 187     uint32_t lost_interval;
 188     uint32_t expected;
 189     uint32_t fraction;
 190     uint64_t ntp_time= s->last_rtcp_ntp_time; // TODO: Get local ntp time?
 191
 192     if (!s->rtp_ctx || (count < 1))
 193         return -1;
 194
 195     /* TODO: I think this is way too often; RFC 1889 has algorithm for this */
 196     /* XXX: mpeg pts hardcoded. RTCP send every 0.5 seconds */
 197     s->octet_count += count;
 198     rtcp_bytes = ((s->octet_count - s->last_octet_count) * RTCP_TX_RATIO_NUM) /
 199         RTCP_TX_RATIO_DEN;
 200     rtcp_bytes /= 50; // mmu_man: that's enough for me... VLC sends much less btw !?
 201     if (rtcp_bytes < 28)
 202         return -1;
 203     s->last_octet_count = s->octet_count;
 204
 205     if (url_open_dyn_buf(&pb) < 0)
 206         return -1;
 207
 208     // Receiver Report
 209     put_byte(pb, (RTP_VERSION << 6) + 1); /* 1 report block */
 210     put_byte(pb, 201);
 211     put_be16(pb, 7); /* length in words - 1 */
 212     put_be32(pb, s->ssrc); // our own SSRC
 213     put_be32(pb, s->ssrc); // XXX: should be the server's here!
 214     // some placeholders we should really fill...
 215     // RFC 1889/p64
 216     extended_max= stats->cycles + stats->max_seq;
 217     expected= extended_max - stats->base_seq + 1;
 218     lost= expected - stats->received;
 219     lost= FFMIN(lost, 0xffffff); // clamp it since it's only 24 bits...
 220     expected_interval= expected - stats->expected_prior;
 221     stats->expected_prior= expected;
 222     received_interval= stats->received - stats->received_prior;
 223     stats->received_prior= stats->received;
 224     lost_interval= expected_interval - received_interval;
 225     if (expected_interval==0 || lost_interval<=0) fraction= 0;
 226     else fraction = (lost_interval<<8)/expected_interval;
 227
 228     fraction= (fraction<<24) | lost;
 229
 230     put_be32(pb, fraction); /* 8 bits of fraction, 24 bits of total packets lost */
 231     put_be32(pb, extended_max); /* max sequence received */
 232     put_be32(pb, stats->jitter>>4); /* jitter */
 233
 234     if(s->last_rtcp_ntp_time==AV_NOPTS_VALUE)
 235     {
 236         put_be32(pb, 0); /* last SR timestamp */
 237         put_be32(pb, 0); /* delay since last SR */
 238     } else {
 239         uint32_t middle_32_bits= s->last_rtcp_ntp_time>>16; // this is valid, right? do we need to handle 64 bit values special?
 240         uint32_t delay_since_last= ntp_time - s->last_rtcp_ntp_time;
 241
 242         put_be32(pb, middle_32_bits); /* last SR timestamp */
 243         put_be32(pb, delay_since_last); /* delay since last SR */
 244     }
 245
 246     // CNAME
 247     put_byte(pb, (RTP_VERSION << 6) + 1); /* 1 report block */
 248     put_byte(pb, 202);
 249     len = strlen(s->hostname);
 250     put_be16(pb, (6 + len + 3) / 4); /* length in words - 1 */
 251     put_be32(pb, s->ssrc);
 252     put_byte(pb, 0x01);
 253     put_byte(pb, len);
 254     put_buffer(pb, s->hostname, len);
 255     // padding
 256     for (len = (6 + len) % 4; len % 4; len++) {
 257         put_byte(pb, 0);
 258     }
 259
 260     put_flush_packet(pb);
 261     len = url_close_dyn_buf(pb, &buf);
 262     if ((len > 0) && buf) {
 263         int result;
 264         dprintf(s->ic, "sending %d bytes of RR\n", len);
 265         result= url_write(s->rtp_ctx, buf, len);
 266         dprintf(s->ic, "result from url_write: %d\n", result);
 267         av_free(buf);
 268     }
 269     return 0;
 270 }
 271
 272 void rtp_send_punch_packets(URLContext* rtp_handle)
 273 {
 274     ByteIOContext *pb;
 275     uint8_t *buf;
 276     int len;
 277
 278     /* Send a small RTP packet */
 279     if (url_open_dyn_buf(&pb) < 0)
 280         return;
 281
 282     put_byte(pb, (RTP_VERSION << 6));
 283     put_byte(pb, 0); /* Payload type */
 284     put_be16(pb, 0); /* Seq */
 285     put_be32(pb, 0); /* Timestamp */
 286     put_be32(pb, 0); /* SSRC */
 287
 288     put_flush_packet(pb);
 289     len = url_close_dyn_buf(pb, &buf);
 290     if ((len > 0) && buf)
 291         url_write(rtp_handle, buf, len);
 292     av_free(buf);
 293
 294     /* Send a minimal RTCP RR */
 295     if (url_open_dyn_buf(&pb) < 0)
 296         return;
 297
 298     put_byte(pb, (RTP_VERSION << 6));
 299     put_byte(pb, 201); /* receiver report */
 300     put_be16(pb, 1); /* length in words - 1 */
 301     put_be32(pb, 0); /* our own SSRC */
 302
 303     put_flush_packet(pb);
 304     len = url_close_dyn_buf(pb, &buf);
 305     if ((len > 0) && buf)
 306         url_write(rtp_handle, buf, len);
 307     av_free(buf);
 308 }
 309
 310
 311 /**
 312  * open a new RTP parse context for stream 'st'. 'st' can be NULL for
 313  * MPEG2TS streams to indicate that they should be demuxed inside the
 314  * rtp demux (otherwise CODEC_ID_MPEG2TS packets are returned)
 315  */
 316 RTPDemuxContext *rtp_parse_open(AVFormatContext *s1, AVStream *st, URLContext *rtpc, int payload_type)
 317 {
 318     RTPDemuxContext *s;
 319
 320     s = av_mallocz(sizeof(RTPDemuxContext));
 321     if (!s)
 322         return NULL;
 323     s->payload_type = payload_type;
 324     s->last_rtcp_ntp_time = AV_NOPTS_VALUE;
 325     s->first_rtcp_ntp_time = AV_NOPTS_VALUE;
 326     s->ic = s1;
 327     s->st = st;
 328     rtp_init_statistics(&s->statistics, 0); // do we know the initial sequence from sdp?
 329     if (!strcmp(ff_rtp_enc_name(payload_type), "MP2T")) {
 330         s->ts = ff_mpegts_parse_open(s->ic);
 331         if (s->ts == NULL) {
 332             av_free(s);
 333             return NULL;
 334         }
 335     } else {
 336         av_set_pts_info(st, 32, 1, 90000);
 337         switch(st->codec->codec_id) {
 338         case CODEC_ID_MPEG1VIDEO:
 339         case CODEC_ID_MPEG2VIDEO:
 340         case CODEC_ID_MP2:
 341         case CODEC_ID_MP3:
 342         case CODEC_ID_MPEG4:
 343         case CODEC_ID_H263:
 344         case CODEC_ID_H264:
 345             st->need_parsing = AVSTREAM_PARSE_FULL;
 346             break;
 347         default:
 348             if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 349                 av_set_pts_info(st, 32, 1, st->codec->sample_rate);
 350             }
 351             break;
 352         }
 353     }
 354     // needed to send back RTCP RR in RTSP sessions
 355     s->rtp_ctx = rtpc;
 356     gethostname(s->hostname, sizeof(s->hostname));
 357     return s;
 358 }
 359
 360 void
 361 rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx,
 362                                RTPDynamicProtocolHandler *handler)
 363 {
 364     s->dynamic_protocol_context = ctx;
 365     s->parse_packet = handler->parse_packet;
 366 }
 367
 368 /**
 369  * This was the second switch in rtp_parse packet.  Normalizes time, if required, sets stream_index, etc.
 370  */
 371 static void finalize_packet(RTPDemuxContext *s, AVPacket *pkt, uint32_t timestamp)
 372 {
 373     if (s->last_rtcp_ntp_time != AV_NOPTS_VALUE && timestamp != RTP_NOTS_VALUE) {
 374         int64_t addend;
 375         int delta_timestamp;
 376
 377         /* compute pts from timestamp with received ntp_time */
 378         delta_timestamp = timestamp - s->last_rtcp_timestamp;
 379         /* convert to the PTS timebase */
 380         addend = av_rescale(s->last_rtcp_ntp_time - s->first_rtcp_ntp_time, s->st->time_base.den, (uint64_t)s->st->time_base.num << 32);
 381         pkt->pts = s->range_start_offset + addend + delta_timestamp;
 382     }
 383 }
 384
 385 /**
 386  * Parse an RTP or RTCP packet directly sent as a buffer.
 387  * @param s RTP parse context.
 388  * @param pkt returned packet
 389  * @param buf input buffer or NULL to read the next packets
 390  * @param len buffer len
 391  * @return 0 if a packet is returned, 1 if a packet is returned and more can follow
 392  * (use buf as NULL to read the next). -1 if no packet (error or no more packet).
 393  */
 394 int rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt,
 395                      const uint8_t *buf, int len)
 396 {
 397     unsigned int ssrc, h;
 398     int payload_type, seq, ret, flags = 0;
 399     AVStream *st;
 400     uint32_t timestamp;
 401     int rv= 0;
 402
 403     if (!buf) {
 404         /* return the next packets, if any */
 405         if(s->st && s->parse_packet) {
 406             /* timestamp should be overwritten by parse_packet, if not,
 407              * the packet is left with pts == AV_NOPTS_VALUE */
 408             timestamp = RTP_NOTS_VALUE;
 409             rv= s->parse_packet(s->ic, s->dynamic_protocol_context,
 410                                 s->st, pkt, &timestamp, NULL, 0, flags);
 411             finalize_packet(s, pkt, timestamp);
 412             return rv;
 413         } else {
 414             // TODO: Move to a dynamic packet handler (like above)
 415             if (s->read_buf_index >= s->read_buf_size)
 416                 return -1;
 417             ret = ff_mpegts_parse_packet(s->ts, pkt, s->buf + s->read_buf_index,
 418                                       s->read_buf_size - s->read_buf_index);
 419             if (ret < 0)
 420                 return -1;
 421             s->read_buf_index += ret;
 422             if (s->read_buf_index < s->read_buf_size)
 423                 return 1;
 424             else
 425                 return 0;
 426         }
 427     }
 428
 429     if (len < 12)
 430         return -1;
 431
 432     if ((buf[0] & 0xc0) != (RTP_VERSION << 6))
 433         return -1;
 434     if (buf[1] >= 200 && buf[1] <= 204) {
 435         rtcp_parse_packet(s, buf, len);
 436         return -1;
 437     }
 438     payload_type = buf[1] & 0x7f;
 439     if (buf[1] & 0x80)
 440         flags |= RTP_FLAG_MARKER;
 441     seq  = AV_RB16(buf + 2);
 442     timestamp = AV_RB32(buf + 4);
 443     ssrc = AV_RB32(buf + 8);
 444     /* store the ssrc in the RTPDemuxContext */
 445     s->ssrc = ssrc;
 446
 447     /* NOTE: we can handle only one payload type */
 448     if (s->payload_type != payload_type)
 449         return -1;
 450
 451     st = s->st;
 452     // only do something with this if all the rtp checks pass...
 453     if(!rtp_valid_packet_in_sequence(&s->statistics, seq))
 454     {
 455         av_log(st?st->codec:NULL, AV_LOG_ERROR, "RTP: PT=%02x: bad cseq %04x expected=%04x\n",
 456                payload_type, seq, ((s->seq + 1) & 0xffff));
 457         return -1;
 458     }
 459
 460     s->seq = seq;
 461     len -= 12;
 462     buf += 12;
 463
 464     if (!st) {
 465         /* specific MPEG2TS demux support */
 466         ret = ff_mpegts_parse_packet(s->ts, pkt, buf, len);
 467         if (ret < 0)
 468             return -1;
 469         if (ret < len) {
 470             s->read_buf_size = len - ret;
 471             memcpy(s->buf, buf + ret, s->read_buf_size);
 472             s->read_buf_index = 0;
 473             return 1;
 474         }
 475         return 0;
 476     } else if (s->parse_packet) {
 477         rv = s->parse_packet(s->ic, s->dynamic_protocol_context,
 478                              s->st, pkt, &timestamp, buf, len, flags);
 479     } else {
 480         // at this point, the RTP header has been stripped;  This is ASSUMING that there is only 1 CSRC, which in't wise.
 481         switch(st->codec->codec_id) {
 482         case CODEC_ID_MP2:
 483         case CODEC_ID_MP3:
 484             /* better than nothing: skip mpeg audio RTP header */
 485             if (len <= 4)
 486                 return -1;
 487             h = AV_RB32(buf);
 488             len -= 4;
 489             buf += 4;
 490             av_new_packet(pkt, len);
 491             memcpy(pkt->data, buf, len);
 492             break;
 493         case CODEC_ID_MPEG1VIDEO:
 494         case CODEC_ID_MPEG2VIDEO:
 495             /* better than nothing: skip mpeg video RTP header */
 496             if (len <= 4)
 497                 return -1;
 498             h = AV_RB32(buf);
 499             buf += 4;
 500             len -= 4;
 501             if (h & (1 << 26)) {
 502                 /* mpeg2 */
 503                 if (len <= 4)
 504                     return -1;
 505                 buf += 4;
 506                 len -= 4;
 507             }
 508             av_new_packet(pkt, len);
 509             memcpy(pkt->data, buf, len);
 510             break;
 511         default:
 512             av_new_packet(pkt, len);
 513             memcpy(pkt->data, buf, len);
 514             break;
 515         }
 516
 517         pkt->stream_index = st->index;
 518     }
 519
 520     // now perform timestamp things....
 521     finalize_packet(s, pkt, timestamp);
 522
 523     return rv;
 524 }
 525
 526 void rtp_parse_close(RTPDemuxContext *s)
 527 {
 528     if (!strcmp(ff_rtp_enc_name(s->payload_type), "MP2T")) {
 529         ff_mpegts_parse_close(s->ts);
 530     }
 531     av_free(s);
 532 }
 533
 534 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
 535                   int (*parse_fmtp)(AVStream *stream,
 536                                     PayloadContext *data,
 537                                     char *attr, char *value))
 538 {
 539     char attr[256];
 540     char *value;
 541     int res;
 542     int value_size = strlen(p) + 1;
 543
 544     if (!(value = av_malloc(value_size))) {
 545         av_log(stream, AV_LOG_ERROR, "Failed to allocate data for FMTP.");
 546         return AVERROR(ENOMEM);
 547     }
 548
 549     // remove protocol identifier
 550     while (*p && *p == ' ') p++; // strip spaces
 551     while (*p && *p != ' ') p++; // eat protocol identifier
 552     while (*p && *p == ' ') p++; // strip trailing spaces
 553
 554     while (ff_rtsp_next_attr_and_value(&p,
 555                                        attr, sizeof(attr),
 556                                        value, value_size)) {
 557
 558         res = parse_fmtp(stream, data, attr, value);
 559         if (res < 0 && res != AVERROR_PATCHWELCOME) {
 560             av_free(value);
 561             return res;
 562         }
 563     }
 564     av_free(value);
 565     return 0;
 566 }