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