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