2 * UDP prototype streaming system
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
27 #define _BSD_SOURCE /* Needed for using struct ip_mreq with recent glibc */
30 #include "avio_internal.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/fifo.h"
33 #include "libavutil/intreadwrite.h"
34 #include "libavutil/avstring.h"
38 #include "os_support.h"
47 #ifndef IPV6_ADD_MEMBERSHIP
48 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
49 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
52 #define UDP_TX_BUF_SIZE 32768
53 #define UDP_MAX_PKT_SIZE 65536
62 struct sockaddr_storage dest_addr;
66 /* Circular Buffer variables for use in UDP receive code */
67 int circular_buffer_size;
69 int circular_buffer_error;
71 pthread_t circular_buffer_thread;
73 uint8_t tmp[UDP_MAX_PKT_SIZE+4];
77 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
78 struct sockaddr *addr)
80 #ifdef IP_MULTICAST_TTL
81 if (addr->sa_family == AF_INET) {
82 if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
83 av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL): %s\n", strerror(errno));
88 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
89 if (addr->sa_family == AF_INET6) {
90 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
91 av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS): %s\n", strerror(errno));
99 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr)
101 #ifdef IP_ADD_MEMBERSHIP
102 if (addr->sa_family == AF_INET) {
105 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
106 mreq.imr_interface.s_addr= INADDR_ANY;
107 if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
108 av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP): %s\n", strerror(errno));
113 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
114 if (addr->sa_family == AF_INET6) {
115 struct ipv6_mreq mreq6;
117 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
118 mreq6.ipv6mr_interface= 0;
119 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
120 av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP): %s\n", strerror(errno));
128 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr)
130 #ifdef IP_DROP_MEMBERSHIP
131 if (addr->sa_family == AF_INET) {
134 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
135 mreq.imr_interface.s_addr= INADDR_ANY;
136 if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
137 av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP): %s\n", strerror(errno));
142 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
143 if (addr->sa_family == AF_INET6) {
144 struct ipv6_mreq mreq6;
146 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
147 mreq6.ipv6mr_interface= 0;
148 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
149 av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP): %s\n", strerror(errno));
157 static struct addrinfo* udp_resolve_host(const char *hostname, int port,
158 int type, int family, int flags)
160 struct addrinfo hints, *res = 0;
163 const char *node = 0, *service = "0";
166 snprintf(sport, sizeof(sport), "%d", port);
169 if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
172 memset(&hints, 0, sizeof(hints));
173 hints.ai_socktype = type;
174 hints.ai_family = family;
175 hints.ai_flags = flags;
176 if ((error = getaddrinfo(node, service, &hints, &res))) {
178 av_log(NULL, AV_LOG_ERROR, "udp_resolve_host: %s\n", gai_strerror(error));
184 static int udp_set_url(struct sockaddr_storage *addr,
185 const char *hostname, int port)
187 struct addrinfo *res0;
190 res0 = udp_resolve_host(hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
191 if (res0 == 0) return AVERROR(EIO);
192 memcpy(addr, res0->ai_addr, res0->ai_addrlen);
193 addr_len = res0->ai_addrlen;
199 static int udp_socket_create(UDPContext *s, struct sockaddr_storage *addr,
200 int *addr_len, const char *localaddr)
203 struct addrinfo *res0 = NULL, *res = NULL;
204 int family = AF_UNSPEC;
206 if (((struct sockaddr *) &s->dest_addr)->sa_family)
207 family = ((struct sockaddr *) &s->dest_addr)->sa_family;
208 res0 = udp_resolve_host(localaddr[0] ? localaddr : NULL, s->local_port,
209 SOCK_DGRAM, family, AI_PASSIVE);
212 for (res = res0; res; res=res->ai_next) {
213 udp_fd = socket(res->ai_family, SOCK_DGRAM, 0);
214 if (udp_fd > 0) break;
215 av_log(NULL, AV_LOG_ERROR, "socket: %s\n", strerror(errno));
221 memcpy(addr, res->ai_addr, res->ai_addrlen);
222 *addr_len = res->ai_addrlen;
236 static int udp_port(struct sockaddr_storage *addr, int addr_len)
238 char sbuf[sizeof(int)*3+1];
240 if (getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0, sbuf, sizeof(sbuf), NI_NUMERICSERV) != 0) {
241 av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", strerror(errno));
245 return strtol(sbuf, NULL, 10);
250 * If no filename is given to av_open_input_file because you want to
251 * get the local port first, then you must call this function to set
252 * the remote server address.
254 * url syntax: udp://host:port[?option=val...]
255 * option: 'ttl=n' : set the ttl value (for multicast only)
256 * 'localport=n' : set the local port
257 * 'pkt_size=n' : set max packet size
258 * 'reuse=1' : enable reusing the socket
260 * @param h media file context
261 * @param uri of the remote server
262 * @return zero if no error.
264 int ff_udp_set_remote_url(URLContext *h, const char *uri)
266 UDPContext *s = h->priv_data;
267 char hostname[256], buf[10];
271 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
273 /* set the destination address */
274 s->dest_addr_len = udp_set_url(&s->dest_addr, hostname, port);
275 if (s->dest_addr_len < 0) {
278 s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
279 p = strchr(uri, '?');
281 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
282 int was_connected = s->is_connected;
283 s->is_connected = strtol(buf, NULL, 10);
284 if (s->is_connected && !was_connected) {
285 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
288 av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
299 * Return the local port used by the UDP connection
300 * @param h media file context
301 * @return the local port number
303 int ff_udp_get_local_port(URLContext *h)
305 UDPContext *s = h->priv_data;
306 return s->local_port;
310 * Return the udp file handle for select() usage to wait for several RTP
311 * streams at the same time.
312 * @param h media file context
314 static int udp_get_file_handle(URLContext *h)
316 UDPContext *s = h->priv_data;
320 static void *circular_buffer_task( void *_URLContext)
322 URLContext *h = _URLContext;
323 UDPContext *s = h->priv_data;
332 if (url_interrupt_cb()) {
333 s->circular_buffer_error = EINTR;
338 FD_SET(s->udp_fd, &rfds);
341 ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
343 if (ff_neterrno() == AVERROR(EINTR))
345 s->circular_buffer_error = EIO;
349 if (!(ret > 0 && FD_ISSET(s->udp_fd, &rfds)))
352 /* How much do we have left to the end of the buffer */
353 /* Whats the minimum we can read so that we dont comletely fill the buffer */
354 left = av_fifo_space(s->fifo);
356 /* No Space left, error, what do we do now */
357 if(left < UDP_MAX_PKT_SIZE + 4) {
358 av_log(h, AV_LOG_ERROR, "circular_buffer: OVERRUN\n");
359 s->circular_buffer_error = EIO;
362 left = FFMIN(left, s->fifo->end - s->fifo->wptr);
363 len = recv(s->udp_fd, s->tmp+4, sizeof(s->tmp)-4, 0);
365 if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
366 s->circular_buffer_error = EIO;
371 AV_WL32(s->tmp, len);
372 av_fifo_generic_write(s->fifo, s->tmp, len+4, NULL);
378 /* put it in UDP context */
379 /* return non zero if error */
380 static int udp_open(URLContext *h, const char *uri, int flags)
382 char hostname[1024], localaddr[1024] = "";
383 int port, udp_fd = -1, tmp, bind_ret = -1;
384 UDPContext *s = NULL;
388 struct sockaddr_storage my_addr;
390 int reuse_specified = 0;
393 h->max_packet_size = 1472;
395 is_output = !(flags & AVIO_FLAG_READ);
397 s = av_mallocz(sizeof(UDPContext));
399 return AVERROR(ENOMEM);
403 s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
405 s->circular_buffer_size = 7*188*4096;
407 p = strchr(uri, '?');
409 if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
411 s->reuse_socket = strtol(buf, &endptr, 10);
412 /* assume if no digits were found it is a request to enable it */
417 if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
418 s->ttl = strtol(buf, NULL, 10);
420 if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
421 s->local_port = strtol(buf, NULL, 10);
423 if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
424 h->max_packet_size = strtol(buf, NULL, 10);
426 if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
427 s->buffer_size = strtol(buf, NULL, 10);
429 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
430 s->is_connected = strtol(buf, NULL, 10);
432 if (av_find_info_tag(buf, sizeof(buf), "fifo_size", p)) {
433 s->circular_buffer_size = strtol(buf, NULL, 10)*188;
435 if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
436 av_strlcpy(localaddr, buf, sizeof(localaddr));
440 /* fill the dest addr */
441 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
443 /* XXX: fix av_url_split */
444 if (hostname[0] == '\0' || hostname[0] == '?') {
445 /* only accepts null hostname if input */
446 if (!(flags & AVIO_FLAG_READ))
449 if (ff_udp_set_remote_url(h, uri) < 0)
453 if ((s->is_multicast || !s->local_port) && (h->flags & AVIO_FLAG_READ))
454 s->local_port = port;
455 udp_fd = udp_socket_create(s, &my_addr, &len, localaddr);
459 /* Follow the requested reuse option, unless it's multicast in which
460 * case enable reuse unless explicitely disabled.
462 if (s->reuse_socket || (s->is_multicast && !reuse_specified)) {
464 if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
468 /* the bind is needed to give a port to the socket now */
469 /* if multicast, try the multicast address bind first */
470 if (s->is_multicast && (h->flags & AVIO_FLAG_READ)) {
471 bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
473 /* bind to the local address if not multicast or if the multicast
475 if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0)
478 len = sizeof(my_addr);
479 getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
480 s->local_port = udp_port(&my_addr, len);
482 if (s->is_multicast) {
483 if (!(h->flags & AVIO_FLAG_READ)) {
485 if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
489 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
495 /* limit the tx buf size to limit latency */
496 tmp = s->buffer_size;
497 if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
498 av_log(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF): %s\n", strerror(errno));
502 /* set udp recv buffer size to the largest possible udp packet size to
503 * avoid losing data on OSes that set this too low by default. */
504 tmp = s->buffer_size;
505 if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
506 av_log(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF): %s\n", strerror(errno));
508 /* make the socket non-blocking */
509 ff_socket_nonblock(udp_fd, 1);
511 if (s->is_connected) {
512 if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
513 av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
521 if (!is_output && s->circular_buffer_size) {
522 /* start the task going */
523 s->fifo = av_fifo_alloc(s->circular_buffer_size);
524 if (pthread_create(&s->circular_buffer_thread, NULL, circular_buffer_task, h)) {
525 av_log(h, AV_LOG_ERROR, "pthread_create failed\n");
535 av_fifo_free(s->fifo);
540 static int udp_read(URLContext *h, uint8_t *buf, int size)
542 UDPContext *s = h->priv_data;
551 avail = av_fifo_size(s->fifo);
552 if (avail) { // >=size) {
555 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
558 av_log(h, AV_LOG_WARNING, "Part of datagram lost due to insufficient buffer size\n");
562 av_fifo_generic_read(s->fifo, buf, avail, NULL);
563 av_fifo_drain(s->fifo, AV_RL32(tmp) - avail);
568 FD_SET(s->udp_fd, &rfds);
571 ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
578 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
579 ret = ff_network_wait_fd(s->udp_fd, 0);
583 ret = recv(s->udp_fd, buf, size, 0);
585 return ret < 0 ? ff_neterrno() : ret;
588 static int udp_write(URLContext *h, const uint8_t *buf, int size)
590 UDPContext *s = h->priv_data;
593 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
594 ret = ff_network_wait_fd(s->udp_fd, 1);
599 if (!s->is_connected) {
600 ret = sendto (s->udp_fd, buf, size, 0,
601 (struct sockaddr *) &s->dest_addr,
604 ret = send(s->udp_fd, buf, size, 0);
606 return ret < 0 ? ff_neterrno() : ret;
609 static int udp_close(URLContext *h)
611 UDPContext *s = h->priv_data;
613 if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
614 udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
615 closesocket(s->udp_fd);
616 av_fifo_free(s->fifo);
621 URLProtocol ff_udp_protocol = {
623 .url_open = udp_open,
624 .url_read = udp_read,
625 .url_write = udp_write,
626 .url_close = udp_close,
627 .url_get_file_handle = udp_get_file_handle,