avformat/dashenc: Added comments
[ffmpeg.git] / libavformat / rtpproto.c
1 /*
2  * RTP network protocol
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 /**
23  * @file
24  * RTP protocol
25  */
26
27 #include "libavutil/parseutils.h"
28 #include "libavutil/avstring.h"
29 #include "libavutil/opt.h"
30 #include "avformat.h"
31 #include "avio_internal.h"
32 #include "rtp.h"
33 #include "rtpproto.h"
34 #include "url.h"
35 #include "ip.h"
36
37 #include <stdarg.h>
38 #include "internal.h"
39 #include "network.h"
40 #include "os_support.h"
41 #include <fcntl.h>
42 #if HAVE_POLL_H
43 #include <poll.h>
44 #endif
45
46 typedef struct RTPContext {
47     const AVClass *class;
48     URLContext *rtp_hd, *rtcp_hd, *fec_hd;
49     int rtp_fd, rtcp_fd;
50     IPSourceFilters filters;
51     int write_to_source;
52     struct sockaddr_storage last_rtp_source, last_rtcp_source;
53     socklen_t last_rtp_source_len, last_rtcp_source_len;
54     int ttl;
55     int buffer_size;
56     int rtcp_port, local_rtpport, local_rtcpport;
57     int connect;
58     int pkt_size;
59     int dscp;
60     char *sources;
61     char *block;
62     char *fec_options_str;
63 } RTPContext;
64
65 #define OFFSET(x) offsetof(RTPContext, x)
66 #define D AV_OPT_FLAG_DECODING_PARAM
67 #define E AV_OPT_FLAG_ENCODING_PARAM
68 static const AVOption options[] = {
69     { "ttl",                "Time to live (in milliseconds, multicast only)",                   OFFSET(ttl),             AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
70     { "buffer_size",        "Send/Receive buffer size (in bytes)",                              OFFSET(buffer_size),     AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
71     { "rtcp_port",          "Custom rtcp port",                                                 OFFSET(rtcp_port),       AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
72     { "local_rtpport",      "Local rtp port",                                                   OFFSET(local_rtpport),   AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
73     { "local_rtcpport",     "Local rtcp port",                                                  OFFSET(local_rtcpport),  AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
74     { "connect",            "Connect socket",                                                   OFFSET(connect),         AV_OPT_TYPE_BOOL,   { .i64 =  0 },     0, 1,       .flags = D|E },
75     { "write_to_source",    "Send packets to the source address of the latest received packet", OFFSET(write_to_source), AV_OPT_TYPE_BOOL,   { .i64 =  0 },     0, 1,       .flags = D|E },
76     { "pkt_size",           "Maximum packet size",                                              OFFSET(pkt_size),        AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
77     { "dscp",               "DSCP class",                                                       OFFSET(dscp),            AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
78     { "sources",            "Source list",                                                      OFFSET(sources),         AV_OPT_TYPE_STRING, { .str = NULL },               .flags = D|E },
79     { "block",              "Block list",                                                       OFFSET(block),           AV_OPT_TYPE_STRING, { .str = NULL },               .flags = D|E },
80     { "fec",                "FEC",                                                              OFFSET(fec_options_str), AV_OPT_TYPE_STRING, { .str = NULL },               .flags = E },
81     { NULL }
82 };
83
84 static const AVClass rtp_class = {
85     .class_name = "rtp",
86     .item_name  = av_default_item_name,
87     .option     = options,
88     .version    = LIBAVUTIL_VERSION_INT,
89 };
90
91 /**
92  * If no filename is given to av_open_input_file because you want to
93  * get the local port first, then you must call this function to set
94  * the remote server address.
95  *
96  * @param h media file context
97  * @param uri of the remote server
98  * @return zero if no error.
99  */
100
101 int ff_rtp_set_remote_url(URLContext *h, const char *uri)
102 {
103     RTPContext *s = h->priv_data;
104     char hostname[256];
105     int port, rtcp_port;
106     const char *p;
107
108     char buf[1024];
109     char path[1024];
110
111     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port,
112                  path, sizeof(path), uri);
113     rtcp_port = port + 1;
114
115     p = strchr(uri, '?');
116     if (p) {
117         if (av_find_info_tag(buf, sizeof(buf), "rtcpport", p)) {
118             rtcp_port = strtol(buf, NULL, 10);
119         }
120     }
121
122     ff_url_join(buf, sizeof(buf), "udp", NULL, hostname, port, "%s", path);
123     ff_udp_set_remote_url(s->rtp_hd, buf);
124
125     ff_url_join(buf, sizeof(buf), "udp", NULL, hostname, rtcp_port, "%s", path);
126     ff_udp_set_remote_url(s->rtcp_hd, buf);
127     return 0;
128 }
129
130 static int get_port(const struct sockaddr_storage *ss)
131 {
132     if (ss->ss_family == AF_INET)
133         return ntohs(((const struct sockaddr_in *)ss)->sin_port);
134 #if HAVE_STRUCT_SOCKADDR_IN6
135     if (ss->ss_family == AF_INET6)
136         return ntohs(((const struct sockaddr_in6 *)ss)->sin6_port);
137 #endif
138     return 0;
139 }
140
141 static void set_port(struct sockaddr_storage *ss, int port)
142 {
143     if (ss->ss_family == AF_INET)
144         ((struct sockaddr_in *)ss)->sin_port = htons(port);
145 #if HAVE_STRUCT_SOCKADDR_IN6
146     else if (ss->ss_family == AF_INET6)
147         ((struct sockaddr_in6 *)ss)->sin6_port = htons(port);
148 #endif
149 }
150
151 /**
152  * add option to url of the form:
153  * "http://host:port/path?option1=val1&option2=val2...
154  */
155
156 static av_printf_format(3, 4) void url_add_option(char *buf, int buf_size, const char *fmt, ...)
157 {
158     char buf1[1024];
159     va_list ap;
160
161     va_start(ap, fmt);
162     if (strchr(buf, '?'))
163         av_strlcat(buf, "&", buf_size);
164     else
165         av_strlcat(buf, "?", buf_size);
166     vsnprintf(buf1, sizeof(buf1), fmt, ap);
167     av_strlcat(buf, buf1, buf_size);
168     va_end(ap);
169 }
170
171 static void build_udp_url(RTPContext *s,
172                           char *buf, int buf_size,
173                           const char *hostname,
174                           int port, int local_port,
175                           const char *include_sources,
176                           const char *exclude_sources)
177 {
178     ff_url_join(buf, buf_size, "udp", NULL, hostname, port, NULL);
179     if (local_port >= 0)
180         url_add_option(buf, buf_size, "localport=%d", local_port);
181     if (s->ttl >= 0)
182         url_add_option(buf, buf_size, "ttl=%d", s->ttl);
183     if (s->buffer_size >= 0)
184         url_add_option(buf, buf_size, "buffer_size=%d", s->buffer_size);
185     if (s->pkt_size >= 0)
186         url_add_option(buf, buf_size, "pkt_size=%d", s->pkt_size);
187     if (s->connect)
188         url_add_option(buf, buf_size, "connect=1");
189     if (s->dscp >= 0)
190         url_add_option(buf, buf_size, "dscp=%d", s->dscp);
191     url_add_option(buf, buf_size, "fifo_size=0");
192     if (include_sources && include_sources[0])
193         url_add_option(buf, buf_size, "sources=%s", include_sources);
194     if (exclude_sources && exclude_sources[0])
195         url_add_option(buf, buf_size, "block=%s", exclude_sources);
196 }
197
198 /**
199  * url syntax: rtp://host:port[?option=val...]
200  * option: 'ttl=n'            : set the ttl value (for multicast only)
201  *         'rtcpport=n'       : set the remote rtcp port to n
202  *         'localrtpport=n'   : set the local rtp port to n
203  *         'localrtcpport=n'  : set the local rtcp port to n
204  *         'pkt_size=n'       : set max packet size
205  *         'connect=0/1'      : do a connect() on the UDP socket
206  *         'sources=ip[,ip]'  : list allowed source IP addresses
207  *         'block=ip[,ip]'    : list disallowed source IP addresses
208  *         'write_to_source=0/1' : send packets to the source address of the latest received packet
209  *         'dscp=n'           : set DSCP value to n (QoS)
210  * deprecated option:
211  *         'localport=n'      : set the local port to n
212  *
213  * if rtcpport isn't set the rtcp port will be the rtp port + 1
214  * if local rtp port isn't set any available port will be used for the local
215  * rtp and rtcp ports
216  * if the local rtcp port is not set it will be the local rtp port + 1
217  */
218
219 static int rtp_open(URLContext *h, const char *uri, int flags)
220 {
221     RTPContext *s = h->priv_data;
222     AVDictionary *fec_opts = NULL;
223     int rtp_port;
224     char hostname[256], include_sources[1024] = "", exclude_sources[1024] = "";
225     char *sources = include_sources, *block = exclude_sources;
226     char *fec_protocol = NULL;
227     char buf[1024];
228     char path[1024];
229     const char *p;
230     int i, max_retry_count = 3;
231     int rtcpflags;
232
233     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &rtp_port,
234                  path, sizeof(path), uri);
235     /* extract parameters */
236     if (s->rtcp_port < 0)
237         s->rtcp_port = rtp_port + 1;
238
239     p = strchr(uri, '?');
240     if (p) {
241         if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
242             s->ttl = strtol(buf, NULL, 10);
243         }
244         if (av_find_info_tag(buf, sizeof(buf), "rtcpport", p)) {
245             s->rtcp_port = strtol(buf, NULL, 10);
246         }
247         if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
248             s->local_rtpport = strtol(buf, NULL, 10);
249         }
250         if (av_find_info_tag(buf, sizeof(buf), "localrtpport", p)) {
251             s->local_rtpport = strtol(buf, NULL, 10);
252         }
253         if (av_find_info_tag(buf, sizeof(buf), "localrtcpport", p)) {
254             s->local_rtcpport = strtol(buf, NULL, 10);
255         }
256         if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
257             s->pkt_size = strtol(buf, NULL, 10);
258         }
259         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
260             s->connect = strtol(buf, NULL, 10);
261         }
262         if (av_find_info_tag(buf, sizeof(buf), "write_to_source", p)) {
263             s->write_to_source = strtol(buf, NULL, 10);
264         }
265         if (av_find_info_tag(buf, sizeof(buf), "dscp", p)) {
266             s->dscp = strtol(buf, NULL, 10);
267         }
268         if (av_find_info_tag(buf, sizeof(buf), "sources", p)) {
269             av_strlcpy(include_sources, buf, sizeof(include_sources));
270             ff_ip_parse_sources(h, buf, &s->filters);
271         } else {
272             ff_ip_parse_sources(h, s->sources, &s->filters);
273             sources = s->sources;
274         }
275         if (av_find_info_tag(buf, sizeof(buf), "block", p)) {
276             av_strlcpy(exclude_sources, buf, sizeof(exclude_sources));
277             ff_ip_parse_blocks(h, buf, &s->filters);
278         } else {
279             ff_ip_parse_blocks(h, s->block, &s->filters);
280             block = s->block;
281         }
282     }
283
284     if (s->fec_options_str) {
285         p = s->fec_options_str;
286
287         if (!(fec_protocol = av_get_token(&p, "="))) {
288             av_log(h, AV_LOG_ERROR, "Failed to parse the FEC protocol value\n");
289             goto fail;
290         }
291         if (strcmp(fec_protocol, "prompeg")) {
292             av_log(h, AV_LOG_ERROR, "Unsupported FEC protocol %s\n", fec_protocol);
293             goto fail;
294         }
295
296         p = s->fec_options_str + strlen(fec_protocol);
297         while (*p && *p == '=') p++;
298
299         if (av_dict_parse_string(&fec_opts, p, "=", ":", 0) < 0) {
300             av_log(h, AV_LOG_ERROR, "Failed to parse the FEC options\n");
301             goto fail;
302         }
303         if (s->ttl > 0) {
304             snprintf(buf, sizeof (buf), "%d", s->ttl);
305             av_dict_set(&fec_opts, "ttl", buf, 0);
306         }
307     }
308
309     for (i = 0; i < max_retry_count; i++) {
310         build_udp_url(s, buf, sizeof(buf),
311                       hostname, rtp_port, s->local_rtpport,
312                       sources, block);
313         if (ffurl_open_whitelist(&s->rtp_hd, buf, flags, &h->interrupt_callback,
314                                  NULL, h->protocol_whitelist, h->protocol_blacklist, h) < 0)
315             goto fail;
316         s->local_rtpport = ff_udp_get_local_port(s->rtp_hd);
317         if(s->local_rtpport == 65535) {
318             s->local_rtpport = -1;
319             continue;
320         }
321         rtcpflags = flags | AVIO_FLAG_WRITE;
322         if (s->local_rtcpport < 0) {
323             s->local_rtcpport = s->local_rtpport + 1;
324             build_udp_url(s, buf, sizeof(buf),
325                           hostname, s->rtcp_port, s->local_rtcpport,
326                           sources, block);
327             if (ffurl_open_whitelist(&s->rtcp_hd, buf, rtcpflags,
328                                      &h->interrupt_callback, NULL,
329                                      h->protocol_whitelist, h->protocol_blacklist, h) < 0) {
330                 s->local_rtpport = s->local_rtcpport = -1;
331                 continue;
332             }
333             break;
334         }
335         build_udp_url(s, buf, sizeof(buf),
336                       hostname, s->rtcp_port, s->local_rtcpport,
337                       sources, block);
338         if (ffurl_open_whitelist(&s->rtcp_hd, buf, rtcpflags, &h->interrupt_callback,
339                                  NULL, h->protocol_whitelist, h->protocol_blacklist, h) < 0)
340             goto fail;
341         break;
342     }
343
344     s->fec_hd = NULL;
345     if (fec_protocol) {
346         ff_url_join(buf, sizeof(buf), fec_protocol, NULL, hostname, rtp_port, NULL);
347         if (ffurl_open_whitelist(&s->fec_hd, buf, flags, &h->interrupt_callback,
348                              &fec_opts, h->protocol_whitelist, h->protocol_blacklist, h) < 0)
349             goto fail;
350     }
351
352     /* just to ease handle access. XXX: need to suppress direct handle
353        access */
354     s->rtp_fd = ffurl_get_file_handle(s->rtp_hd);
355     s->rtcp_fd = ffurl_get_file_handle(s->rtcp_hd);
356
357     h->max_packet_size = s->rtp_hd->max_packet_size;
358     h->is_streamed = 1;
359
360     av_free(fec_protocol);
361     av_dict_free(&fec_opts);
362
363     return 0;
364
365  fail:
366     if (s->rtp_hd)
367         ffurl_close(s->rtp_hd);
368     if (s->rtcp_hd)
369         ffurl_close(s->rtcp_hd);
370     ffurl_closep(&s->fec_hd);
371     av_free(fec_protocol);
372     av_dict_free(&fec_opts);
373     return AVERROR(EIO);
374 }
375
376 static int rtp_read(URLContext *h, uint8_t *buf, int size)
377 {
378     RTPContext *s = h->priv_data;
379     int len, n, i;
380     struct pollfd p[2] = {{s->rtp_fd, POLLIN, 0}, {s->rtcp_fd, POLLIN, 0}};
381     int poll_delay = h->flags & AVIO_FLAG_NONBLOCK ? 0 : 100;
382     struct sockaddr_storage *addrs[2] = { &s->last_rtp_source, &s->last_rtcp_source };
383     socklen_t *addr_lens[2] = { &s->last_rtp_source_len, &s->last_rtcp_source_len };
384
385     for(;;) {
386         if (ff_check_interrupt(&h->interrupt_callback))
387             return AVERROR_EXIT;
388         n = poll(p, 2, poll_delay);
389         if (n > 0) {
390             /* first try RTCP, then RTP */
391             for (i = 1; i >= 0; i--) {
392                 if (!(p[i].revents & POLLIN))
393                     continue;
394                 *addr_lens[i] = sizeof(*addrs[i]);
395                 len = recvfrom(p[i].fd, buf, size, 0,
396                                 (struct sockaddr *)addrs[i], addr_lens[i]);
397                 if (len < 0) {
398                     if (ff_neterrno() == AVERROR(EAGAIN) ||
399                         ff_neterrno() == AVERROR(EINTR))
400                         continue;
401                     return AVERROR(EIO);
402                 }
403                 if (ff_ip_check_source_lists(addrs[i], &s->filters))
404                     continue;
405                 return len;
406             }
407         } else if (n < 0) {
408             if (ff_neterrno() == AVERROR(EINTR))
409                 continue;
410             return AVERROR(EIO);
411         }
412         if (h->flags & AVIO_FLAG_NONBLOCK)
413             return AVERROR(EAGAIN);
414     }
415 }
416
417 static int rtp_write(URLContext *h, const uint8_t *buf, int size)
418 {
419     RTPContext *s = h->priv_data;
420     int ret, ret_fec;
421     URLContext *hd;
422
423     if (size < 2)
424         return AVERROR(EINVAL);
425
426     if ((buf[0] & 0xc0) != (RTP_VERSION << 6))
427         av_log(h, AV_LOG_WARNING, "Data doesn't look like RTP packets, "
428                                   "make sure the RTP muxer is used\n");
429
430     if (s->write_to_source) {
431         int fd;
432         struct sockaddr_storage *source, temp_source;
433         socklen_t *source_len, temp_len;
434         if (!s->last_rtp_source.ss_family && !s->last_rtcp_source.ss_family) {
435             av_log(h, AV_LOG_ERROR,
436                    "Unable to send packet to source, no packets received yet\n");
437             // Intentionally not returning an error here
438             return size;
439         }
440
441         if (RTP_PT_IS_RTCP(buf[1])) {
442             fd = s->rtcp_fd;
443             source     = &s->last_rtcp_source;
444             source_len = &s->last_rtcp_source_len;
445         } else {
446             fd = s->rtp_fd;
447             source     = &s->last_rtp_source;
448             source_len = &s->last_rtp_source_len;
449         }
450         if (!source->ss_family) {
451             source      = &temp_source;
452             source_len  = &temp_len;
453             if (RTP_PT_IS_RTCP(buf[1])) {
454                 temp_source = s->last_rtp_source;
455                 temp_len    = s->last_rtp_source_len;
456                 set_port(source, get_port(source) + 1);
457                 av_log(h, AV_LOG_INFO,
458                        "Not received any RTCP packets yet, inferring peer port "
459                        "from the RTP port\n");
460             } else {
461                 temp_source = s->last_rtcp_source;
462                 temp_len    = s->last_rtcp_source_len;
463                 set_port(source, get_port(source) - 1);
464                 av_log(h, AV_LOG_INFO,
465                        "Not received any RTP packets yet, inferring peer port "
466                        "from the RTCP port\n");
467             }
468         }
469
470         if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
471             ret = ff_network_wait_fd(fd, 1);
472             if (ret < 0)
473                 return ret;
474         }
475         ret = sendto(fd, buf, size, 0, (struct sockaddr *) source,
476                      *source_len);
477
478         return ret < 0 ? ff_neterrno() : ret;
479     }
480
481     if (RTP_PT_IS_RTCP(buf[1])) {
482         /* RTCP payload type */
483         hd = s->rtcp_hd;
484     } else {
485         /* RTP payload type */
486         hd = s->rtp_hd;
487     }
488
489     if ((ret = ffurl_write(hd, buf, size)) < 0) {
490         return ret;
491     }
492
493     if (s->fec_hd && !RTP_PT_IS_RTCP(buf[1])) {
494         if ((ret_fec = ffurl_write(s->fec_hd, buf, size)) < 0) {
495             av_log(h, AV_LOG_ERROR, "Failed to send FEC\n");
496             return ret_fec;
497         }
498     }
499
500     return ret;
501 }
502
503 static int rtp_close(URLContext *h)
504 {
505     RTPContext *s = h->priv_data;
506
507     ff_ip_reset_filters(&s->filters);
508
509     ffurl_close(s->rtp_hd);
510     ffurl_close(s->rtcp_hd);
511     ffurl_closep(&s->fec_hd);
512     return 0;
513 }
514
515 /**
516  * Return the local rtp port used by the RTP connection
517  * @param h media file context
518  * @return the local port number
519  */
520
521 int ff_rtp_get_local_rtp_port(URLContext *h)
522 {
523     RTPContext *s = h->priv_data;
524     return ff_udp_get_local_port(s->rtp_hd);
525 }
526
527 /**
528  * Return the local rtcp port used by the RTP connection
529  * @param h media file context
530  * @return the local port number
531  */
532
533 static int rtp_get_file_handle(URLContext *h)
534 {
535     RTPContext *s = h->priv_data;
536     return s->rtp_fd;
537 }
538
539 static int rtp_get_multi_file_handle(URLContext *h, int **handles,
540                                      int *numhandles)
541 {
542     RTPContext *s = h->priv_data;
543     int *hs       = *handles = av_malloc(sizeof(**handles) * 2);
544     if (!hs)
545         return AVERROR(ENOMEM);
546     hs[0] = s->rtp_fd;
547     hs[1] = s->rtcp_fd;
548     *numhandles = 2;
549     return 0;
550 }
551
552 const URLProtocol ff_rtp_protocol = {
553     .name                      = "rtp",
554     .url_open                  = rtp_open,
555     .url_read                  = rtp_read,
556     .url_write                 = rtp_write,
557     .url_close                 = rtp_close,
558     .url_get_file_handle       = rtp_get_file_handle,
559     .url_get_multi_file_handle = rtp_get_multi_file_handle,
560     .priv_data_size            = sizeof(RTPContext),
561     .flags                     = URL_PROTOCOL_FLAG_NETWORK,
562     .priv_data_class           = &rtp_class,
563 };