Move multicast address identification fallback macros to network.h from udp.c
[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 is_multicast_address(struct sockaddr_storage *addr)
181 {
182     if (addr->ss_family == AF_INET) {
183         return IN_MULTICAST(ntohl(((struct sockaddr_in *)addr)->sin_addr.s_addr));
184     }
185 #if HAVE_STRUCT_SOCKADDR_IN6
186     if (addr->ss_family == AF_INET6) {
187         return IN6_IS_ADDR_MULTICAST(&((struct sockaddr_in6 *)addr)->sin6_addr);
188     }
189 #endif
190
191     return 0;
192 }
193
194 static int udp_socket_create(UDPContext *s,
195                              struct sockaddr_storage *addr, int *addr_len)
196 {
197     int udp_fd = -1;
198     struct addrinfo *res0 = NULL, *res = NULL;
199     int family = AF_UNSPEC;
200
201     if (((struct sockaddr *) &s->dest_addr)->sa_family)
202         family = ((struct sockaddr *) &s->dest_addr)->sa_family;
203     res0 = udp_resolve_host(0, s->local_port, SOCK_DGRAM, family, AI_PASSIVE);
204     if (res0 == 0)
205         goto fail;
206     for (res = res0; res; res=res->ai_next) {
207         udp_fd = socket(res->ai_family, SOCK_DGRAM, 0);
208         if (udp_fd > 0) break;
209         av_log(NULL, AV_LOG_ERROR, "socket: %s\n", strerror(errno));
210     }
211
212     if (udp_fd < 0)
213         goto fail;
214
215     memcpy(addr, res->ai_addr, res->ai_addrlen);
216     *addr_len = res->ai_addrlen;
217
218     freeaddrinfo(res0);
219
220     return udp_fd;
221
222  fail:
223     if (udp_fd >= 0)
224         closesocket(udp_fd);
225     if(res0)
226         freeaddrinfo(res0);
227     return -1;
228 }
229
230 static int udp_port(struct sockaddr_storage *addr, int addr_len)
231 {
232     char sbuf[sizeof(int)*3+1];
233
234     if (getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0,  sbuf, sizeof(sbuf), NI_NUMERICSERV) != 0) {
235         av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", strerror(errno));
236         return -1;
237     }
238
239     return strtol(sbuf, NULL, 10);
240 }
241
242
243 /**
244  * If no filename is given to av_open_input_file because you want to
245  * get the local port first, then you must call this function to set
246  * the remote server address.
247  *
248  * url syntax: udp://host:port[?option=val...]
249  * option: 'ttl=n'       : set the ttl value (for multicast only)
250  *         'localport=n' : set the local port
251  *         'pkt_size=n'  : set max packet size
252  *         'reuse=1'     : enable reusing the socket
253  *
254  * @param h media file context
255  * @param uri of the remote server
256  * @return zero if no error.
257  */
258 int udp_set_remote_url(URLContext *h, const char *uri)
259 {
260     UDPContext *s = h->priv_data;
261     char hostname[256];
262     int port;
263
264     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
265
266     /* set the destination address */
267     s->dest_addr_len = udp_set_url(&s->dest_addr, hostname, port);
268     if (s->dest_addr_len < 0) {
269         return AVERROR(EIO);
270     }
271     s->is_multicast = is_multicast_address(&s->dest_addr);
272
273     return 0;
274 }
275
276 /**
277  * Return the local port used by the UDP connection
278  * @param h media file context
279  * @return the local port number
280  */
281 int udp_get_local_port(URLContext *h)
282 {
283     UDPContext *s = h->priv_data;
284     return s->local_port;
285 }
286
287 /**
288  * Return the udp file handle for select() usage to wait for several RTP
289  * streams at the same time.
290  * @param h media file context
291  */
292 #if (LIBAVFORMAT_VERSION_MAJOR >= 53)
293 static
294 #endif
295 int udp_get_file_handle(URLContext *h)
296 {
297     UDPContext *s = h->priv_data;
298     return s->udp_fd;
299 }
300
301 /* put it in UDP context */
302 /* return non zero if error */
303 static int udp_open(URLContext *h, const char *uri, int flags)
304 {
305     char hostname[1024];
306     int port, udp_fd = -1, tmp, bind_ret = -1;
307     UDPContext *s = NULL;
308     int is_output;
309     const char *p;
310     char buf[256];
311     struct sockaddr_storage my_addr;
312     int len;
313
314     h->is_streamed = 1;
315     h->max_packet_size = 1472;
316
317     is_output = (flags & URL_WRONLY);
318
319     s = av_mallocz(sizeof(UDPContext));
320     if (!s)
321         return AVERROR(ENOMEM);
322
323     h->priv_data = s;
324     s->ttl = 16;
325     s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
326
327     p = strchr(uri, '?');
328     if (p) {
329         s->reuse_socket = find_info_tag(buf, sizeof(buf), "reuse", p);
330         if (find_info_tag(buf, sizeof(buf), "ttl", p)) {
331             s->ttl = strtol(buf, NULL, 10);
332         }
333         if (find_info_tag(buf, sizeof(buf), "localport", p)) {
334             s->local_port = strtol(buf, NULL, 10);
335         }
336         if (find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
337             h->max_packet_size = strtol(buf, NULL, 10);
338         }
339         if (find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
340             s->buffer_size = strtol(buf, NULL, 10);
341         }
342     }
343
344     /* fill the dest addr */
345     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
346
347     /* XXX: fix av_url_split */
348     if (hostname[0] == '\0' || hostname[0] == '?') {
349         /* only accepts null hostname if input */
350         if (flags & URL_WRONLY)
351             goto fail;
352     } else {
353         if (udp_set_remote_url(h, uri) < 0)
354             goto fail;
355     }
356
357     if (s->is_multicast && !(h->flags & URL_WRONLY))
358         s->local_port = port;
359     udp_fd = udp_socket_create(s, &my_addr, &len);
360     if (udp_fd < 0)
361         goto fail;
362
363     if (s->reuse_socket)
364         if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
365             goto fail;
366
367     /* the bind is needed to give a port to the socket now */
368     /* if multicast, try the multicast address bind first */
369     if (s->is_multicast && !(h->flags & URL_WRONLY)) {
370         bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
371     }
372     /* bind to the local address if not multicast or if the multicast
373      * bind failed */
374     if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0)
375         goto fail;
376
377     len = sizeof(my_addr);
378     getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
379     s->local_port = udp_port(&my_addr, len);
380
381     if (s->is_multicast) {
382         if (h->flags & URL_WRONLY) {
383             /* output */
384             if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
385                 goto fail;
386         } else {
387             /* input */
388             if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
389                 goto fail;
390         }
391     }
392
393     if (is_output) {
394         /* limit the tx buf size to limit latency */
395         tmp = s->buffer_size;
396         if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
397             av_log(NULL, AV_LOG_ERROR, "setsockopt(SO_SNDBUF): %s\n", strerror(errno));
398             goto fail;
399         }
400     } else {
401         /* set udp recv buffer size to the largest possible udp packet size to
402          * avoid losing data on OSes that set this too low by default. */
403         tmp = s->buffer_size;
404         if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
405             av_log(NULL, AV_LOG_WARNING, "setsockopt(SO_RECVBUF): %s\n", strerror(errno));
406         }
407         /* make the socket non-blocking */
408         ff_socket_nonblock(udp_fd, 1);
409     }
410
411     s->udp_fd = udp_fd;
412     return 0;
413  fail:
414     if (udp_fd >= 0)
415         closesocket(udp_fd);
416     av_free(s);
417     return AVERROR(EIO);
418 }
419
420 static int udp_read(URLContext *h, uint8_t *buf, int size)
421 {
422     UDPContext *s = h->priv_data;
423     int len;
424     fd_set rfds;
425     int ret;
426     struct timeval tv;
427
428     for(;;) {
429         if (url_interrupt_cb())
430             return AVERROR(EINTR);
431         FD_ZERO(&rfds);
432         FD_SET(s->udp_fd, &rfds);
433         tv.tv_sec = 0;
434         tv.tv_usec = 100 * 1000;
435         ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
436         if (ret < 0) {
437             if (ff_neterrno() == FF_NETERROR(EINTR))
438                 continue;
439             return AVERROR(EIO);
440         }
441         if (!(ret > 0 && FD_ISSET(s->udp_fd, &rfds)))
442             continue;
443         len = recv(s->udp_fd, buf, size, 0);
444         if (len < 0) {
445             if (ff_neterrno() != FF_NETERROR(EAGAIN) &&
446                 ff_neterrno() != FF_NETERROR(EINTR))
447                 return AVERROR(EIO);
448         } else {
449             break;
450         }
451     }
452     return len;
453 }
454
455 static int udp_write(URLContext *h, const uint8_t *buf, int size)
456 {
457     UDPContext *s = h->priv_data;
458     int ret;
459
460     for(;;) {
461         ret = sendto (s->udp_fd, buf, size, 0,
462                       (struct sockaddr *) &s->dest_addr,
463                       s->dest_addr_len);
464         if (ret < 0) {
465             if (ff_neterrno() != FF_NETERROR(EINTR) &&
466                 ff_neterrno() != FF_NETERROR(EAGAIN))
467                 return ff_neterrno();
468         } else {
469             break;
470         }
471     }
472     return size;
473 }
474
475 static int udp_close(URLContext *h)
476 {
477     UDPContext *s = h->priv_data;
478
479     if (s->is_multicast && !(h->flags & URL_WRONLY))
480         udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
481     closesocket(s->udp_fd);
482     av_free(s);
483     return 0;
484 }
485
486 URLProtocol udp_protocol = {
487     "udp",
488     udp_open,
489     udp_read,
490     udp_write,
491     NULL, /* seek */
492     udp_close,
493     .url_get_file_handle = udp_get_file_handle,
494 };