6571ab5d42c491b6be5c66529b0bde915cd31896
[ffmpeg.git] / libavformat / udp.c
1 /*
2  * UDP prototype streaming system
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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  * UDP protocol
25  */
26
27 #define _BSD_SOURCE     /* Needed for using struct ip_mreq with recent glibc */
28
29 #include "avformat.h"
30 #include "avio_internal.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/avstring.h"
33 #include <unistd.h>
34 #include "internal.h"
35 #include "network.h"
36 #include "os_support.h"
37 #include "url.h"
38 #include <sys/time.h>
39
40 #ifndef IPV6_ADD_MEMBERSHIP
41 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
42 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
43 #endif
44
45 typedef struct {
46     int udp_fd;
47     int ttl;
48     int buffer_size;
49     int is_multicast;
50     int local_port;
51     int reuse_socket;
52     struct sockaddr_storage dest_addr;
53     int dest_addr_len;
54     int is_connected;
55 } UDPContext;
56
57 #define UDP_TX_BUF_SIZE 32768
58 #define UDP_MAX_PKT_SIZE 65536
59
60 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
61                                  struct sockaddr *addr)
62 {
63 #ifdef IP_MULTICAST_TTL
64     if (addr->sa_family == AF_INET) {
65         if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
66             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL): %s\n", strerror(errno));
67             return -1;
68         }
69     }
70 #endif
71 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
72     if (addr->sa_family == AF_INET6) {
73         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
74             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS): %s\n", strerror(errno));
75             return -1;
76         }
77     }
78 #endif
79     return 0;
80 }
81
82 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr)
83 {
84 #ifdef IP_ADD_MEMBERSHIP
85     if (addr->sa_family == AF_INET) {
86         struct ip_mreq mreq;
87
88         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
89         mreq.imr_interface.s_addr= INADDR_ANY;
90         if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
91             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP): %s\n", strerror(errno));
92             return -1;
93         }
94     }
95 #endif
96 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
97     if (addr->sa_family == AF_INET6) {
98         struct ipv6_mreq mreq6;
99
100         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
101         mreq6.ipv6mr_interface= 0;
102         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
103             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP): %s\n", strerror(errno));
104             return -1;
105         }
106     }
107 #endif
108     return 0;
109 }
110
111 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr)
112 {
113 #ifdef IP_DROP_MEMBERSHIP
114     if (addr->sa_family == AF_INET) {
115         struct ip_mreq mreq;
116
117         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
118         mreq.imr_interface.s_addr= INADDR_ANY;
119         if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
120             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP): %s\n", strerror(errno));
121             return -1;
122         }
123     }
124 #endif
125 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
126     if (addr->sa_family == AF_INET6) {
127         struct ipv6_mreq mreq6;
128
129         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
130         mreq6.ipv6mr_interface= 0;
131         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
132             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP): %s\n", strerror(errno));
133             return -1;
134         }
135     }
136 #endif
137     return 0;
138 }
139
140 static struct addrinfo* udp_resolve_host(const char *hostname, int port,
141                                          int type, int family, int flags)
142 {
143     struct addrinfo hints = { 0 }, *res = 0;
144     int error;
145     char sport[16];
146     const char *node = 0, *service = "0";
147
148     if (port > 0) {
149         snprintf(sport, sizeof(sport), "%d", port);
150         service = sport;
151     }
152     if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
153         node = hostname;
154     }
155     hints.ai_socktype = type;
156     hints.ai_family   = family;
157     hints.ai_flags = flags;
158     if ((error = getaddrinfo(node, service, &hints, &res))) {
159         res = NULL;
160         av_log(NULL, AV_LOG_ERROR, "udp_resolve_host: %s\n", gai_strerror(error));
161     }
162
163     return res;
164 }
165
166 static int udp_set_url(struct sockaddr_storage *addr,
167                        const char *hostname, int port)
168 {
169     struct addrinfo *res0;
170     int addr_len;
171
172     res0 = udp_resolve_host(hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
173     if (res0 == 0) return AVERROR(EIO);
174     memcpy(addr, res0->ai_addr, res0->ai_addrlen);
175     addr_len = res0->ai_addrlen;
176     freeaddrinfo(res0);
177
178     return addr_len;
179 }
180
181 static int udp_socket_create(UDPContext *s, struct sockaddr_storage *addr,
182                              int *addr_len, const char *localaddr)
183 {
184     int udp_fd = -1;
185     struct addrinfo *res0 = NULL, *res = NULL;
186     int family = AF_UNSPEC;
187
188     if (((struct sockaddr *) &s->dest_addr)->sa_family)
189         family = ((struct sockaddr *) &s->dest_addr)->sa_family;
190     res0 = udp_resolve_host(localaddr[0] ? localaddr : NULL, s->local_port,
191                             SOCK_DGRAM, family, AI_PASSIVE);
192     if (res0 == 0)
193         goto fail;
194     for (res = res0; res; res=res->ai_next) {
195         udp_fd = socket(res->ai_family, SOCK_DGRAM, 0);
196         if (udp_fd > 0) break;
197         av_log(NULL, AV_LOG_ERROR, "socket: %s\n", strerror(errno));
198     }
199
200     if (udp_fd < 0)
201         goto fail;
202
203     memcpy(addr, res->ai_addr, res->ai_addrlen);
204     *addr_len = res->ai_addrlen;
205
206     freeaddrinfo(res0);
207
208     return udp_fd;
209
210  fail:
211     if (udp_fd >= 0)
212         closesocket(udp_fd);
213     if(res0)
214         freeaddrinfo(res0);
215     return -1;
216 }
217
218 static int udp_port(struct sockaddr_storage *addr, int addr_len)
219 {
220     char sbuf[sizeof(int)*3+1];
221
222     if (getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0,  sbuf, sizeof(sbuf), NI_NUMERICSERV) != 0) {
223         av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", strerror(errno));
224         return -1;
225     }
226
227     return strtol(sbuf, NULL, 10);
228 }
229
230
231 /**
232  * If no filename is given to av_open_input_file because you want to
233  * get the local port first, then you must call this function to set
234  * the remote server address.
235  *
236  * url syntax: udp://host:port[?option=val...]
237  * option: 'ttl=n'       : set the ttl value (for multicast only)
238  *         'localport=n' : set the local port
239  *         'pkt_size=n'  : set max packet size
240  *         'reuse=1'     : enable reusing the socket
241  *
242  * @param h media file context
243  * @param uri of the remote server
244  * @return zero if no error.
245  */
246 int ff_udp_set_remote_url(URLContext *h, const char *uri)
247 {
248     UDPContext *s = h->priv_data;
249     char hostname[256], buf[10];
250     int port;
251     const char *p;
252
253     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
254
255     /* set the destination address */
256     s->dest_addr_len = udp_set_url(&s->dest_addr, hostname, port);
257     if (s->dest_addr_len < 0) {
258         return AVERROR(EIO);
259     }
260     s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
261     p = strchr(uri, '?');
262     if (p) {
263         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
264             int was_connected = s->is_connected;
265             s->is_connected = strtol(buf, NULL, 10);
266             if (s->is_connected && !was_connected) {
267                 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
268                             s->dest_addr_len)) {
269                     s->is_connected = 0;
270                     av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
271                     return AVERROR(EIO);
272                 }
273             }
274         }
275     }
276
277     return 0;
278 }
279
280 /**
281  * Return the local port used by the UDP connection
282  * @param h media file context
283  * @return the local port number
284  */
285 int ff_udp_get_local_port(URLContext *h)
286 {
287     UDPContext *s = h->priv_data;
288     return s->local_port;
289 }
290
291 /**
292  * Return the udp file handle for select() usage to wait for several RTP
293  * streams at the same time.
294  * @param h media file context
295  */
296 static int udp_get_file_handle(URLContext *h)
297 {
298     UDPContext *s = h->priv_data;
299     return s->udp_fd;
300 }
301
302 /* put it in UDP context */
303 /* return non zero if error */
304 static int udp_open(URLContext *h, const char *uri, int flags)
305 {
306     char hostname[1024], localaddr[1024] = "";
307     int port, udp_fd = -1, tmp, bind_ret = -1;
308     UDPContext *s = h->priv_data;
309     int is_output;
310     const char *p;
311     char buf[256];
312     struct sockaddr_storage my_addr;
313     int len;
314     int reuse_specified = 0;
315
316     h->is_streamed = 1;
317     h->max_packet_size = 1472;
318
319     is_output = !(flags & AVIO_FLAG_READ);
320
321     s->ttl = 16;
322     s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
323
324     p = strchr(uri, '?');
325     if (p) {
326         if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
327             char *endptr = NULL;
328             s->reuse_socket = strtol(buf, &endptr, 10);
329             /* assume if no digits were found it is a request to enable it */
330             if (buf == endptr)
331                 s->reuse_socket = 1;
332             reuse_specified = 1;
333         }
334         if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
335             s->ttl = strtol(buf, NULL, 10);
336         }
337         if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
338             s->local_port = strtol(buf, NULL, 10);
339         }
340         if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
341             h->max_packet_size = strtol(buf, NULL, 10);
342         }
343         if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
344             s->buffer_size = strtol(buf, NULL, 10);
345         }
346         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
347             s->is_connected = strtol(buf, NULL, 10);
348         }
349         if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
350             av_strlcpy(localaddr, buf, sizeof(localaddr));
351         }
352     }
353
354     /* fill the dest addr */
355     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
356
357     /* XXX: fix av_url_split */
358     if (hostname[0] == '\0' || hostname[0] == '?') {
359         /* only accepts null hostname if input */
360         if (!(flags & AVIO_FLAG_READ))
361             goto fail;
362     } else {
363         if (ff_udp_set_remote_url(h, uri) < 0)
364             goto fail;
365     }
366
367     if ((s->is_multicast || !s->local_port) && (h->flags & AVIO_FLAG_READ))
368         s->local_port = port;
369     udp_fd = udp_socket_create(s, &my_addr, &len, localaddr);
370     if (udp_fd < 0)
371         goto fail;
372
373     /* Follow the requested reuse option, unless it's multicast in which
374      * case enable reuse unless explicitly disabled.
375      */
376     if (s->reuse_socket || (s->is_multicast && !reuse_specified)) {
377         s->reuse_socket = 1;
378         if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
379             goto fail;
380     }
381
382     /* If multicast, try binding the multicast address first, to avoid
383      * receiving UDP packets from other sources aimed at the same UDP
384      * port. This fails on windows. This makes sending to the same address
385      * using sendto() fail, so only do it if we're opened in read-only mode. */
386     if (s->is_multicast && !(h->flags & AVIO_FLAG_WRITE)) {
387         bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
388     }
389     /* bind to the local address if not multicast or if the multicast
390      * bind failed */
391     /* the bind is needed to give a port to the socket now */
392     if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0) {
393         av_log(h, AV_LOG_ERROR, "bind failed: %s\n", strerror(errno));
394         goto fail;
395     }
396
397     len = sizeof(my_addr);
398     getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
399     s->local_port = udp_port(&my_addr, len);
400
401     if (s->is_multicast) {
402         if (h->flags & AVIO_FLAG_WRITE) {
403             /* output */
404             if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
405                 goto fail;
406         }
407         if (h->flags & AVIO_FLAG_READ) {
408             /* input */
409             if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
410                 goto fail;
411         }
412     }
413
414     if (is_output) {
415         /* limit the tx buf size to limit latency */
416         tmp = s->buffer_size;
417         if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
418             av_log(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF): %s\n", strerror(errno));
419             goto fail;
420         }
421     } else {
422         /* set udp recv buffer size to the largest possible udp packet size to
423          * avoid losing data on OSes that set this too low by default. */
424         tmp = s->buffer_size;
425         if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
426             av_log(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF): %s\n", strerror(errno));
427         }
428         /* make the socket non-blocking */
429         ff_socket_nonblock(udp_fd, 1);
430     }
431     if (s->is_connected) {
432         if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
433             av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
434             goto fail;
435         }
436     }
437
438     s->udp_fd = udp_fd;
439     return 0;
440  fail:
441     if (udp_fd >= 0)
442         closesocket(udp_fd);
443     return AVERROR(EIO);
444 }
445
446 static int udp_read(URLContext *h, uint8_t *buf, int size)
447 {
448     UDPContext *s = h->priv_data;
449     int ret;
450
451     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
452         ret = ff_network_wait_fd(s->udp_fd, 0);
453         if (ret < 0)
454             return ret;
455     }
456     ret = recv(s->udp_fd, buf, size, 0);
457     return ret < 0 ? ff_neterrno() : ret;
458 }
459
460 static int udp_write(URLContext *h, const uint8_t *buf, int size)
461 {
462     UDPContext *s = h->priv_data;
463     int ret;
464
465     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
466         ret = ff_network_wait_fd(s->udp_fd, 1);
467         if (ret < 0)
468             return ret;
469     }
470
471     if (!s->is_connected) {
472         ret = sendto (s->udp_fd, buf, size, 0,
473                       (struct sockaddr *) &s->dest_addr,
474                       s->dest_addr_len);
475     } else
476         ret = send(s->udp_fd, buf, size, 0);
477
478     return ret < 0 ? ff_neterrno() : ret;
479 }
480
481 static int udp_close(URLContext *h)
482 {
483     UDPContext *s = h->priv_data;
484
485     if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
486         udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
487     closesocket(s->udp_fd);
488     return 0;
489 }
490
491 URLProtocol ff_udp_protocol = {
492     .name                = "udp",
493     .url_open            = udp_open,
494     .url_read            = udp_read,
495     .url_write           = udp_write,
496     .url_close           = udp_close,
497     .url_get_file_handle = udp_get_file_handle,
498     .priv_data_size      = sizeof(UDPContext),
499     .flags               = URL_PROTOCOL_FLAG_NETWORK,
500 };