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