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