802cbd5975a11c88e04ca7805876a39b7fe04c45
[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
29 #include "avformat.h"
30 #include "avio_internal.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/fifo.h"
33 #include <unistd.h>
34 #include "internal.h"
35 #include "network.h"
36 #include "os_support.h"
37 #include "url.h"
38 #include <pthread.h>
39 #include <sys/time.h>
40
41 #ifndef IPV6_ADD_MEMBERSHIP
42 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
43 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
44 #endif
45
46 typedef struct {
47     int udp_fd;
48     int ttl;
49     int buffer_size;
50     int is_multicast;
51     int local_port;
52     int reuse_socket;
53     struct sockaddr_storage dest_addr;
54     int dest_addr_len;
55     int is_connected;
56
57     /* Circular Buffer variables for use in UDP receive code */
58     int circular_buffer_size;
59     AVFifoBuffer *fifo;
60     int circular_buffer_available_max;
61     int circular_buffer_error;
62     pthread_t circular_buffer_thread;
63 } UDPContext;
64
65 #define UDP_TX_BUF_SIZE 32768
66 #define UDP_MAX_PKT_SIZE 65536
67
68 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
69                                  struct sockaddr *addr)
70 {
71 #ifdef IP_MULTICAST_TTL
72     if (addr->sa_family == AF_INET) {
73         if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
74             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL): %s\n", strerror(errno));
75             return -1;
76         }
77     }
78 #endif
79 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
80     if (addr->sa_family == AF_INET6) {
81         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
82             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS): %s\n", strerror(errno));
83             return -1;
84         }
85     }
86 #endif
87     return 0;
88 }
89
90 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr)
91 {
92 #ifdef IP_ADD_MEMBERSHIP
93     if (addr->sa_family == AF_INET) {
94         struct ip_mreq mreq;
95
96         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
97         mreq.imr_interface.s_addr= INADDR_ANY;
98         if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
99             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP): %s\n", strerror(errno));
100             return -1;
101         }
102     }
103 #endif
104 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
105     if (addr->sa_family == AF_INET6) {
106         struct ipv6_mreq mreq6;
107
108         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
109         mreq6.ipv6mr_interface= 0;
110         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
111             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP): %s\n", strerror(errno));
112             return -1;
113         }
114     }
115 #endif
116     return 0;
117 }
118
119 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr)
120 {
121 #ifdef IP_DROP_MEMBERSHIP
122     if (addr->sa_family == AF_INET) {
123         struct ip_mreq mreq;
124
125         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
126         mreq.imr_interface.s_addr= INADDR_ANY;
127         if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
128             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP): %s\n", strerror(errno));
129             return -1;
130         }
131     }
132 #endif
133 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
134     if (addr->sa_family == AF_INET6) {
135         struct ipv6_mreq mreq6;
136
137         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
138         mreq6.ipv6mr_interface= 0;
139         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
140             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP): %s\n", strerror(errno));
141             return -1;
142         }
143     }
144 #endif
145     return 0;
146 }
147
148 static struct addrinfo* udp_resolve_host(const char *hostname, int port,
149                                          int type, int family, int flags)
150 {
151     struct addrinfo hints, *res = 0;
152     int error;
153     char sport[16];
154     const char *node = 0, *service = "0";
155
156     if (port > 0) {
157         snprintf(sport, sizeof(sport), "%d", port);
158         service = sport;
159     }
160     if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
161         node = hostname;
162     }
163     memset(&hints, 0, sizeof(hints));
164     hints.ai_socktype = type;
165     hints.ai_family   = family;
166     hints.ai_flags = flags;
167     if ((error = getaddrinfo(node, service, &hints, &res))) {
168         res = NULL;
169         av_log(NULL, AV_LOG_ERROR, "udp_resolve_host: %s\n", gai_strerror(error));
170     }
171
172     return res;
173 }
174
175 static int udp_set_url(struct sockaddr_storage *addr,
176                        const char *hostname, int port)
177 {
178     struct addrinfo *res0;
179     int addr_len;
180
181     res0 = udp_resolve_host(hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
182     if (res0 == 0) return AVERROR(EIO);
183     memcpy(addr, res0->ai_addr, res0->ai_addrlen);
184     addr_len = res0->ai_addrlen;
185     freeaddrinfo(res0);
186
187     return addr_len;
188 }
189
190 static int udp_socket_create(UDPContext *s,
191                              struct sockaddr_storage *addr, int *addr_len)
192 {
193     int udp_fd = -1;
194     struct addrinfo *res0 = NULL, *res = NULL;
195     int family = AF_UNSPEC;
196
197     if (((struct sockaddr *) &s->dest_addr)->sa_family)
198         family = ((struct sockaddr *) &s->dest_addr)->sa_family;
199     res0 = udp_resolve_host(0, s->local_port, SOCK_DGRAM, family, AI_PASSIVE);
200     if (res0 == 0)
201         goto fail;
202     for (res = res0; res; res=res->ai_next) {
203         udp_fd = socket(res->ai_family, SOCK_DGRAM, 0);
204         if (udp_fd > 0) break;
205         av_log(NULL, AV_LOG_ERROR, "socket: %s\n", strerror(errno));
206     }
207
208     if (udp_fd < 0)
209         goto fail;
210
211     memcpy(addr, res->ai_addr, res->ai_addrlen);
212     *addr_len = res->ai_addrlen;
213
214     freeaddrinfo(res0);
215
216     return udp_fd;
217
218  fail:
219     if (udp_fd >= 0)
220         closesocket(udp_fd);
221     if(res0)
222         freeaddrinfo(res0);
223     return -1;
224 }
225
226 static int udp_port(struct sockaddr_storage *addr, int addr_len)
227 {
228     char sbuf[sizeof(int)*3+1];
229
230     if (getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0,  sbuf, sizeof(sbuf), NI_NUMERICSERV) != 0) {
231         av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", strerror(errno));
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                     av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
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 static void *circular_buffer_task( void *_URLContext)
311 {
312     URLContext *h = _URLContext;
313     UDPContext *s = h->priv_data;
314     fd_set rfds;
315     struct timeval tv;
316
317     for(;;) {
318         int left;
319         int ret;
320         int len;
321
322         if (url_interrupt_cb()) {
323             s->circular_buffer_error = EINTR;
324             return NULL;
325         }
326
327         FD_ZERO(&rfds);
328         FD_SET(s->udp_fd, &rfds);
329         tv.tv_sec = 1;
330         tv.tv_usec = 0;
331         ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
332         if (ret < 0) {
333             if (ff_neterrno() == AVERROR(EINTR))
334                 continue;
335             s->circular_buffer_error = EIO;
336             return NULL;
337         }
338
339         if (!(ret > 0 && FD_ISSET(s->udp_fd, &rfds)))
340             continue;
341
342         /* How much do we have left to the end of the buffer */
343         /* Whats the minimum we can read so that we dont comletely fill the buffer */
344         left = av_fifo_space(s->fifo);
345         left = FFMIN(left, s->fifo->end - s->fifo->wptr);
346
347         /* No Space left, error, what do we do now */
348         if( !left) {
349             av_log(h, AV_LOG_ERROR, "circular_buffer: OVERRUN\n");
350             s->circular_buffer_error = EIO;
351             return NULL;
352         }
353
354         len = recv(s->udp_fd, s->fifo->wptr, left, 0);
355         if (len < 0) {
356             if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
357                 s->circular_buffer_error = EIO;
358                 return NULL;
359             }
360         }
361         s->fifo->wptr += len;
362         if (s->fifo->wptr >= s->fifo->end)
363             s->fifo->wptr = s->fifo->buffer;
364         s->fifo->wndx += len;
365     }
366
367     return NULL;
368 }
369
370 /* put it in UDP context */
371 /* return non zero if error */
372 static int udp_open(URLContext *h, const char *uri, int flags)
373 {
374     char hostname[1024];
375     int port, udp_fd = -1, tmp, bind_ret = -1;
376     UDPContext *s = NULL;
377     int is_output;
378     const char *p;
379     char buf[256];
380     struct sockaddr_storage my_addr;
381     int len;
382     int reuse_specified = 0;
383
384     h->is_streamed = 1;
385     h->max_packet_size = 1472;
386
387     is_output = !(flags & AVIO_FLAG_READ);
388
389     s = av_mallocz(sizeof(UDPContext));
390     if (!s)
391         return AVERROR(ENOMEM);
392
393     h->priv_data = s;
394     s->ttl = 16;
395     s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
396
397     s->circular_buffer_size = 7*188*4096;
398
399     p = strchr(uri, '?');
400     if (p) {
401         if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
402             char *endptr=NULL;
403             s->reuse_socket = strtol(buf, &endptr, 10);
404             /* assume if no digits were found it is a request to enable it */
405             if (buf == endptr)
406                 s->reuse_socket = 1;
407             reuse_specified = 1;
408         }
409         if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
410             s->ttl = strtol(buf, NULL, 10);
411         }
412         if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
413             s->local_port = strtol(buf, NULL, 10);
414         }
415         if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
416             h->max_packet_size = strtol(buf, NULL, 10);
417         }
418         if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
419             s->buffer_size = strtol(buf, NULL, 10);
420         }
421         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
422             s->is_connected = strtol(buf, NULL, 10);
423         }
424         if (av_find_info_tag(buf, sizeof(buf), "buf_size", p)) {
425             s->circular_buffer_size = strtol(buf, NULL, 10)*188;
426         }
427     }
428
429     /* fill the dest addr */
430     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
431
432     /* XXX: fix av_url_split */
433     if (hostname[0] == '\0' || hostname[0] == '?') {
434         /* only accepts null hostname if input */
435         if (!(flags & AVIO_FLAG_READ))
436             goto fail;
437     } else {
438         if (ff_udp_set_remote_url(h, uri) < 0)
439             goto fail;
440     }
441
442     if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
443         s->local_port = port;
444     udp_fd = udp_socket_create(s, &my_addr, &len);
445     if (udp_fd < 0)
446         goto fail;
447
448     /* Follow the requested reuse option, unless it's multicast in which
449      * case enable reuse unless explicitely disabled.
450      */
451     if (s->reuse_socket || (s->is_multicast && !reuse_specified)) {
452         s->reuse_socket = 1;
453         if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
454             goto fail;
455     }
456
457     /* the bind is needed to give a port to the socket now */
458     /* if multicast, try the multicast address bind first */
459     if (s->is_multicast && (h->flags & AVIO_FLAG_READ)) {
460         bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
461     }
462     /* bind to the local address if not multicast or if the multicast
463      * bind failed */
464     if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0)
465         goto fail;
466
467     len = sizeof(my_addr);
468     getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
469     s->local_port = udp_port(&my_addr, len);
470
471     if (s->is_multicast) {
472         if (!(h->flags & AVIO_FLAG_READ)) {
473             /* output */
474             if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
475                 goto fail;
476         } else {
477             /* input */
478             if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
479                 goto fail;
480         }
481     }
482
483     if (is_output) {
484         /* limit the tx buf size to limit latency */
485         tmp = s->buffer_size;
486         if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
487             av_log(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF): %s\n", strerror(errno));
488             goto fail;
489         }
490     } else {
491         /* set udp recv buffer size to the largest possible udp packet size to
492          * avoid losing data on OSes that set this too low by default. */
493         tmp = s->buffer_size;
494         if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
495             av_log(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF): %s\n", strerror(errno));
496         }
497         /* make the socket non-blocking */
498         ff_socket_nonblock(udp_fd, 1);
499     }
500     if (s->is_connected) {
501         if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
502             av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
503             goto fail;
504         }
505     }
506
507     s->udp_fd = udp_fd;
508
509     if (!is_output && s->circular_buffer_size) {
510         /* start the task going */
511         s->fifo = av_fifo_alloc(s->circular_buffer_size);
512         if (pthread_create(&s->circular_buffer_thread, NULL, circular_buffer_task, h)) {
513             av_log(h, AV_LOG_ERROR, "pthread_create failed\n");
514             goto fail;
515         }
516     }
517
518     return 0;
519  fail:
520     if (udp_fd >= 0)
521         closesocket(udp_fd);
522         av_fifo_free(s->fifo);
523     av_free(s);
524     return AVERROR(EIO);
525 }
526
527 static int udp_read(URLContext *h, uint8_t *buf, int size)
528 {
529     UDPContext *s = h->priv_data;
530     int ret;
531     int avail;
532     int left;
533     fd_set rfds;
534     struct timeval tv;
535
536     if (s->fifo) {
537
538         do {
539             avail = av_fifo_size(s->fifo);
540             if (avail) { // >=size) {
541
542                 // Maximum amount available
543                 size = FFMIN( avail, size);
544                 av_fifo_generic_read(s->fifo, buf, size, NULL);
545                 return size;
546             }
547             else {
548                 FD_ZERO(&rfds);
549                 FD_SET(s->udp_fd, &rfds);
550                 tv.tv_sec = 1;
551                 tv.tv_usec = 0;
552                 ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
553                 if (ret<0)
554                     return ret;
555             }
556         } while( 1);
557     }
558
559     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
560         ret = ff_network_wait_fd(s->udp_fd, 0);
561         if (ret < 0)
562             return ret;
563     }
564     ret = recv(s->udp_fd, buf, size, 0);
565
566     return ret < 0 ? ff_neterrno() : ret;
567 }
568
569 static int udp_write(URLContext *h, const uint8_t *buf, int size)
570 {
571     UDPContext *s = h->priv_data;
572     int ret;
573
574     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
575         ret = ff_network_wait_fd(s->udp_fd, 1);
576         if (ret < 0)
577             return ret;
578     }
579
580     if (!s->is_connected) {
581         ret = sendto (s->udp_fd, buf, size, 0,
582                       (struct sockaddr *) &s->dest_addr,
583                       s->dest_addr_len);
584     } else
585         ret = send(s->udp_fd, buf, size, 0);
586
587     return ret < 0 ? ff_neterrno() : ret;
588 }
589
590 static int udp_close(URLContext *h)
591 {
592     UDPContext *s = h->priv_data;
593
594     if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
595         udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
596     closesocket(s->udp_fd);
597     av_log( h, AV_LOG_INFO, "circular_buffer_info max:%d%%\r\n", (s->circular_buffer_available_max*100)/s->circular_buffer_size);
598     av_fifo_free(s->fifo);
599     av_free(s);
600     return 0;
601 }
602
603 URLProtocol ff_udp_protocol = {
604     .name                = "udp",
605     .url_open            = udp_open,
606     .url_read            = udp_read,
607     .url_write           = udp_write,
608     .url_close           = udp_close,
609     .url_get_file_handle = udp_get_file_handle,
610 };