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