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