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"
36 #include "os_support.h"
45 #ifndef IPV6_ADD_MEMBERSHIP
46 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
47 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
57 struct sockaddr_storage dest_addr;
61 /* Circular Buffer variables for use in UDP receive code */
62 int circular_buffer_size;
64 int circular_buffer_error;
66 pthread_t circular_buffer_thread;
70 #define UDP_TX_BUF_SIZE 32768
71 #define UDP_MAX_PKT_SIZE 65536
73 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
74 struct sockaddr *addr)
76 #ifdef IP_MULTICAST_TTL
77 if (addr->sa_family == AF_INET) {
78 if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
79 av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL): %s\n", strerror(errno));
84 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
85 if (addr->sa_family == AF_INET6) {
86 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
87 av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS): %s\n", strerror(errno));
95 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr)
97 #ifdef IP_ADD_MEMBERSHIP
98 if (addr->sa_family == AF_INET) {
101 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
102 mreq.imr_interface.s_addr= INADDR_ANY;
103 if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
104 av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP): %s\n", strerror(errno));
109 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
110 if (addr->sa_family == AF_INET6) {
111 struct ipv6_mreq mreq6;
113 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
114 mreq6.ipv6mr_interface= 0;
115 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
116 av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP): %s\n", strerror(errno));
124 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr)
126 #ifdef IP_DROP_MEMBERSHIP
127 if (addr->sa_family == AF_INET) {
130 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
131 mreq.imr_interface.s_addr= INADDR_ANY;
132 if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
133 av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP): %s\n", strerror(errno));
138 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
139 if (addr->sa_family == AF_INET6) {
140 struct ipv6_mreq mreq6;
142 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
143 mreq6.ipv6mr_interface= 0;
144 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
145 av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP): %s\n", strerror(errno));
153 static struct addrinfo* udp_resolve_host(const char *hostname, int port,
154 int type, int family, int flags)
156 struct addrinfo hints, *res = 0;
159 const char *node = 0, *service = "0";
162 snprintf(sport, sizeof(sport), "%d", port);
165 if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
168 memset(&hints, 0, sizeof(hints));
169 hints.ai_socktype = type;
170 hints.ai_family = family;
171 hints.ai_flags = flags;
172 if ((error = getaddrinfo(node, service, &hints, &res))) {
174 av_log(NULL, AV_LOG_ERROR, "udp_resolve_host: %s\n", gai_strerror(error));
180 static int udp_set_url(struct sockaddr_storage *addr,
181 const char *hostname, int port)
183 struct addrinfo *res0;
186 res0 = udp_resolve_host(hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
187 if (res0 == 0) return AVERROR(EIO);
188 memcpy(addr, res0->ai_addr, res0->ai_addrlen);
189 addr_len = res0->ai_addrlen;
195 static int udp_socket_create(UDPContext *s,
196 struct sockaddr_storage *addr, int *addr_len)
199 struct addrinfo *res0 = NULL, *res = NULL;
200 int family = AF_UNSPEC;
202 if (((struct sockaddr *) &s->dest_addr)->sa_family)
203 family = ((struct sockaddr *) &s->dest_addr)->sa_family;
204 res0 = udp_resolve_host(0, s->local_port, SOCK_DGRAM, family, AI_PASSIVE);
207 for (res = res0; res; res=res->ai_next) {
208 udp_fd = socket(res->ai_family, SOCK_DGRAM, 0);
209 if (udp_fd > 0) break;
210 av_log(NULL, AV_LOG_ERROR, "socket: %s\n", strerror(errno));
216 memcpy(addr, res->ai_addr, res->ai_addrlen);
217 *addr_len = res->ai_addrlen;
231 static int udp_port(struct sockaddr_storage *addr, int addr_len)
233 char sbuf[sizeof(int)*3+1];
235 if (getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0, sbuf, sizeof(sbuf), NI_NUMERICSERV) != 0) {
236 av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", strerror(errno));
240 return strtol(sbuf, NULL, 10);
245 * If no filename is given to av_open_input_file because you want to
246 * get the local port first, then you must call this function to set
247 * the remote server address.
249 * url syntax: udp://host:port[?option=val...]
250 * option: 'ttl=n' : set the ttl value (for multicast only)
251 * 'localport=n' : set the local port
252 * 'pkt_size=n' : set max packet size
253 * 'reuse=1' : enable reusing the socket
255 * @param h media file context
256 * @param uri of the remote server
257 * @return zero if no error.
259 int ff_udp_set_remote_url(URLContext *h, const char *uri)
261 UDPContext *s = h->priv_data;
262 char hostname[256], buf[10];
266 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
268 /* set the destination address */
269 s->dest_addr_len = udp_set_url(&s->dest_addr, hostname, port);
270 if (s->dest_addr_len < 0) {
273 s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
274 p = strchr(uri, '?');
276 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
277 int was_connected = s->is_connected;
278 s->is_connected = strtol(buf, NULL, 10);
279 if (s->is_connected && !was_connected) {
280 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
283 av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
294 * Return the local port used by the UDP connection
295 * @param h media file context
296 * @return the local port number
298 int ff_udp_get_local_port(URLContext *h)
300 UDPContext *s = h->priv_data;
301 return s->local_port;
305 * Return the udp file handle for select() usage to wait for several RTP
306 * streams at the same time.
307 * @param h media file context
309 static int udp_get_file_handle(URLContext *h)
311 UDPContext *s = h->priv_data;
315 static void *circular_buffer_task( void *_URLContext)
317 URLContext *h = _URLContext;
318 UDPContext *s = h->priv_data;
327 if (url_interrupt_cb()) {
328 s->circular_buffer_error = EINTR;
333 FD_SET(s->udp_fd, &rfds);
336 ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
338 if (ff_neterrno() == AVERROR(EINTR))
340 s->circular_buffer_error = EIO;
344 if (!(ret > 0 && FD_ISSET(s->udp_fd, &rfds)))
347 /* How much do we have left to the end of the buffer */
348 /* Whats the minimum we can read so that we dont comletely fill the buffer */
349 left = av_fifo_space(s->fifo);
350 left = FFMIN(left, s->fifo->end - s->fifo->wptr);
352 /* No Space left, error, what do we do now */
354 av_log(h, AV_LOG_ERROR, "circular_buffer: OVERRUN\n");
355 s->circular_buffer_error = EIO;
359 len = recv(s->udp_fd, s->fifo->wptr, left, 0);
361 if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
362 s->circular_buffer_error = EIO;
366 s->fifo->wptr += len;
367 if (s->fifo->wptr >= s->fifo->end)
368 s->fifo->wptr = s->fifo->buffer;
369 s->fifo->wndx += len;
375 /* put it in UDP context */
376 /* return non zero if error */
377 static int udp_open(URLContext *h, const char *uri, int flags)
380 int port, udp_fd = -1, tmp, bind_ret = -1;
381 UDPContext *s = NULL;
385 struct sockaddr_storage my_addr;
387 int reuse_specified = 0;
390 h->max_packet_size = 1472;
392 is_output = !(flags & AVIO_FLAG_READ);
394 s = av_mallocz(sizeof(UDPContext));
396 return AVERROR(ENOMEM);
400 s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
402 s->circular_buffer_size = 7*188*4096;
404 p = strchr(uri, '?');
406 if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
408 s->reuse_socket = strtol(buf, &endptr, 10);
409 /* assume if no digits were found it is a request to enable it */
414 if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
415 s->ttl = strtol(buf, NULL, 10);
417 if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
418 s->local_port = strtol(buf, NULL, 10);
420 if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
421 h->max_packet_size = strtol(buf, NULL, 10);
423 if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
424 s->buffer_size = strtol(buf, NULL, 10);
426 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
427 s->is_connected = strtol(buf, NULL, 10);
429 if (av_find_info_tag(buf, sizeof(buf), "fifo_size", p)) {
430 s->circular_buffer_size = strtol(buf, NULL, 10)*188;
434 /* fill the dest addr */
435 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
437 /* XXX: fix av_url_split */
438 if (hostname[0] == '\0' || hostname[0] == '?') {
439 /* only accepts null hostname if input */
440 if (!(flags & AVIO_FLAG_READ))
443 if (ff_udp_set_remote_url(h, uri) < 0)
447 if ((s->is_multicast || !s->local_port) && (h->flags & AVIO_FLAG_READ))
448 s->local_port = port;
449 udp_fd = udp_socket_create(s, &my_addr, &len);
453 /* Follow the requested reuse option, unless it's multicast in which
454 * case enable reuse unless explicitely disabled.
456 if (s->reuse_socket || (s->is_multicast && !reuse_specified)) {
458 if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
462 /* the bind is needed to give a port to the socket now */
463 /* if multicast, try the multicast address bind first */
464 if (s->is_multicast && (h->flags & AVIO_FLAG_READ)) {
465 bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
467 /* bind to the local address if not multicast or if the multicast
469 if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0)
472 len = sizeof(my_addr);
473 getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
474 s->local_port = udp_port(&my_addr, len);
476 if (s->is_multicast) {
477 if (!(h->flags & AVIO_FLAG_READ)) {
479 if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
483 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
489 /* limit the tx buf size to limit latency */
490 tmp = s->buffer_size;
491 if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
492 av_log(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF): %s\n", strerror(errno));
496 /* set udp recv buffer size to the largest possible udp packet size to
497 * avoid losing data on OSes that set this too low by default. */
498 tmp = s->buffer_size;
499 if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
500 av_log(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF): %s\n", strerror(errno));
502 /* make the socket non-blocking */
503 ff_socket_nonblock(udp_fd, 1);
505 if (s->is_connected) {
506 if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
507 av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
515 if (!is_output && s->circular_buffer_size) {
516 /* start the task going */
517 s->fifo = av_fifo_alloc(s->circular_buffer_size);
518 if (pthread_create(&s->circular_buffer_thread, NULL, circular_buffer_task, h)) {
519 av_log(h, AV_LOG_ERROR, "pthread_create failed\n");
529 av_fifo_free(s->fifo);
534 static int udp_read(URLContext *h, uint8_t *buf, int size)
536 UDPContext *s = h->priv_data;
545 avail = av_fifo_size(s->fifo);
546 if (avail) { // >=size) {
548 // Maximum amount available
549 size = FFMIN( avail, size);
550 av_fifo_generic_read(s->fifo, buf, size, NULL);
555 FD_SET(s->udp_fd, &rfds);
558 ret = select(s->udp_fd + 1, &rfds, NULL, NULL, &tv);
565 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
566 ret = ff_network_wait_fd(s->udp_fd, 0);
570 ret = recv(s->udp_fd, buf, size, 0);
572 return ret < 0 ? ff_neterrno() : ret;
575 static int udp_write(URLContext *h, const uint8_t *buf, int size)
577 UDPContext *s = h->priv_data;
580 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
581 ret = ff_network_wait_fd(s->udp_fd, 1);
586 if (!s->is_connected) {
587 ret = sendto (s->udp_fd, buf, size, 0,
588 (struct sockaddr *) &s->dest_addr,
591 ret = send(s->udp_fd, buf, size, 0);
593 return ret < 0 ? ff_neterrno() : ret;
596 static int udp_close(URLContext *h)
598 UDPContext *s = h->priv_data;
600 if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
601 udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
602 closesocket(s->udp_fd);
603 av_fifo_free(s->fifo);
608 URLProtocol ff_udp_protocol = {
610 .url_open = udp_open,
611 .url_read = udp_read,
612 .url_write = udp_write,
613 .url_close = udp_close,
614 .url_get_file_handle = udp_get_file_handle,