2 * UDP prototype streaming system
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
5 * This file is part of Libav.
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.
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.
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
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/avstring.h"
33 #include "libavutil/opt.h"
36 #include "os_support.h"
39 #ifndef IPV6_ADD_MEMBERSHIP
40 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
41 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
44 typedef struct UDPContext {
53 struct sockaddr_storage dest_addr;
61 #define UDP_TX_BUF_SIZE 32768
62 #define UDP_MAX_PKT_SIZE 65536
64 #define OFFSET(x) offsetof(UDPContext, x)
65 #define D AV_OPT_FLAG_DECODING_PARAM
66 #define E AV_OPT_FLAG_ENCODING_PARAM
67 static const AVOption options[] = {
68 { "ttl", "Time to live (in milliseconds, multicast only)", OFFSET(ttl), AV_OPT_TYPE_INT, { .i64 = 16 }, 0, INT_MAX, .flags = D|E },
69 { "buffer_size", "System data size (in bytes)", OFFSET(buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
70 { "local_port", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
71 { "reuse_socket", "Reuse socket", OFFSET(reuse_socket), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, .flags = D|E },
72 { "connect", "Connect socket", OFFSET(is_connected), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, .flags = D|E },
73 { "pkt_size", "Maximum packet size", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
74 { "localaddr", "Local address", OFFSET(localaddr), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
75 { "sources", "Source list", OFFSET(sources), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
76 { "block", "Block list", OFFSET(block), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
80 static const AVClass udp_class = {
82 .item_name = av_default_item_name,
84 .version = LIBAVUTIL_VERSION_INT,
87 static void log_net_error(void *ctx, int level, const char* prefix)
90 av_strerror(ff_neterrno(), errbuf, sizeof(errbuf));
91 av_log(ctx, level, "%s: %s\n", prefix, errbuf);
94 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
95 struct sockaddr *addr)
97 #ifdef IP_MULTICAST_TTL
98 if (addr->sa_family == AF_INET) {
99 if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
100 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL)");
105 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
106 if (addr->sa_family == AF_INET6) {
107 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
108 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS)");
116 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr)
118 #ifdef IP_ADD_MEMBERSHIP
119 if (addr->sa_family == AF_INET) {
122 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
123 mreq.imr_interface.s_addr= INADDR_ANY;
124 if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
125 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP)");
130 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
131 if (addr->sa_family == AF_INET6) {
132 struct ipv6_mreq mreq6;
134 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
135 mreq6.ipv6mr_interface= 0;
136 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
137 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP)");
145 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr)
147 #ifdef IP_DROP_MEMBERSHIP
148 if (addr->sa_family == AF_INET) {
151 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
152 mreq.imr_interface.s_addr= INADDR_ANY;
153 if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
154 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP)");
159 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
160 if (addr->sa_family == AF_INET6) {
161 struct ipv6_mreq mreq6;
163 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
164 mreq6.ipv6mr_interface= 0;
165 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
166 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP)");
174 static struct addrinfo *udp_resolve_host(URLContext *h,
175 const char *hostname, int port,
176 int type, int family, int flags)
178 struct addrinfo hints = { 0 }, *res = 0;
181 const char *node = 0, *service = "0";
184 snprintf(sport, sizeof(sport), "%d", port);
187 if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
190 hints.ai_socktype = type;
191 hints.ai_family = family;
192 hints.ai_flags = flags;
193 if ((error = getaddrinfo(node, service, &hints, &res))) {
195 av_log(h, AV_LOG_ERROR, "udp_resolve_host: %s\n",
196 gai_strerror(error));
202 static int udp_set_multicast_sources(URLContext *h,
203 int sockfd, struct sockaddr *addr,
204 int addr_len, char **sources,
205 int nb_sources, int include)
207 #if HAVE_STRUCT_GROUP_SOURCE_REQ && defined(MCAST_BLOCK_SOURCE) && !defined(_WIN32)
208 /* These ones are available in the microsoft SDK, but don't seem to work
209 * as on linux, so just prefer the v4-only approach there for now. */
211 for (i = 0; i < nb_sources; i++) {
212 struct group_source_req mreqs;
213 int level = addr->sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
214 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
215 SOCK_DGRAM, AF_UNSPEC,
218 return AVERROR(ENOENT);
220 mreqs.gsr_interface = 0;
221 memcpy(&mreqs.gsr_group, addr, addr_len);
222 memcpy(&mreqs.gsr_source, sourceaddr->ai_addr, sourceaddr->ai_addrlen);
223 freeaddrinfo(sourceaddr);
225 if (setsockopt(sockfd, level,
226 include ? MCAST_JOIN_SOURCE_GROUP : MCAST_BLOCK_SOURCE,
227 (const void *)&mreqs, sizeof(mreqs)) < 0) {
229 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_JOIN_SOURCE_GROUP)");
231 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_BLOCK_SOURCE)");
232 return ff_neterrno();
235 #elif HAVE_STRUCT_IP_MREQ_SOURCE && defined(IP_BLOCK_SOURCE)
237 if (addr->sa_family != AF_INET) {
238 av_log(NULL, AV_LOG_ERROR,
239 "Setting multicast sources only supported for IPv4\n");
240 return AVERROR(EINVAL);
242 for (i = 0; i < nb_sources; i++) {
243 struct ip_mreq_source mreqs;
244 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
245 SOCK_DGRAM, AF_UNSPEC,
248 return AVERROR(ENOENT);
249 if (sourceaddr->ai_addr->sa_family != AF_INET) {
250 freeaddrinfo(sourceaddr);
251 av_log(NULL, AV_LOG_ERROR, "%s is of incorrect protocol family\n",
253 return AVERROR(EINVAL);
256 mreqs.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
257 mreqs.imr_interface.s_addr = INADDR_ANY;
258 mreqs.imr_sourceaddr.s_addr = ((struct sockaddr_in *)sourceaddr->ai_addr)->sin_addr.s_addr;
259 freeaddrinfo(sourceaddr);
261 if (setsockopt(sockfd, IPPROTO_IP,
262 include ? IP_ADD_SOURCE_MEMBERSHIP : IP_BLOCK_SOURCE,
263 (const void *)&mreqs, sizeof(mreqs)) < 0) {
265 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_SOURCE_MEMBERSHIP)");
267 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_BLOCK_SOURCE)");
268 return ff_neterrno();
272 return AVERROR(ENOSYS);
276 static int udp_set_url(URLContext *h,
277 struct sockaddr_storage *addr,
278 const char *hostname, int port)
280 struct addrinfo *res0;
283 res0 = udp_resolve_host(h, hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
284 if (res0 == 0) return AVERROR(EIO);
285 memcpy(addr, res0->ai_addr, res0->ai_addrlen);
286 addr_len = res0->ai_addrlen;
292 static int udp_socket_create(URLContext *h, struct sockaddr_storage *addr,
293 socklen_t *addr_len, const char *localaddr)
295 UDPContext *s = h->priv_data;
297 struct addrinfo *res0 = NULL, *res = NULL;
298 int family = AF_UNSPEC;
300 if (((struct sockaddr *) &s->dest_addr)->sa_family)
301 family = ((struct sockaddr *) &s->dest_addr)->sa_family;
302 res0 = udp_resolve_host(h, (localaddr && localaddr[0]) ? localaddr : NULL,
304 SOCK_DGRAM, family, AI_PASSIVE);
307 for (res = res0; res; res=res->ai_next) {
308 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, 0);
309 if (udp_fd != -1) break;
310 log_net_error(NULL, AV_LOG_ERROR, "socket");
316 memcpy(addr, res->ai_addr, res->ai_addrlen);
317 *addr_len = res->ai_addrlen;
331 static int udp_port(struct sockaddr_storage *addr, int addr_len)
333 char sbuf[sizeof(int)*3+1];
336 if ((error = getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0, sbuf, sizeof(sbuf), NI_NUMERICSERV)) != 0) {
337 av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", gai_strerror(error));
341 return strtol(sbuf, NULL, 10);
346 * If no filename is given to av_open_input_file because you want to
347 * get the local port first, then you must call this function to set
348 * the remote server address.
350 * url syntax: udp://host:port[?option=val...]
351 * option: 'ttl=n' : set the ttl value (for multicast only)
352 * 'localport=n' : set the local port
353 * 'pkt_size=n' : set max packet size
354 * 'reuse=1' : enable reusing the socket
356 * @param h media file context
357 * @param uri of the remote server
358 * @return zero if no error.
360 int ff_udp_set_remote_url(URLContext *h, const char *uri)
362 UDPContext *s = h->priv_data;
363 char hostname[256], buf[10];
367 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
369 /* set the destination address */
370 s->dest_addr_len = udp_set_url(h, &s->dest_addr, hostname, port);
371 if (s->dest_addr_len < 0) {
374 s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
375 p = strchr(uri, '?');
377 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
378 int was_connected = s->is_connected;
379 s->is_connected = strtol(buf, NULL, 10);
380 if (s->is_connected && !was_connected) {
381 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
384 log_net_error(h, AV_LOG_ERROR, "connect");
395 * Return the local port used by the UDP connection
396 * @param h media file context
397 * @return the local port number
399 int ff_udp_get_local_port(URLContext *h)
401 UDPContext *s = h->priv_data;
402 return s->local_port;
406 * Return the udp file handle for select() usage to wait for several RTP
407 * streams at the same time.
408 * @param h media file context
410 static int udp_get_file_handle(URLContext *h)
412 UDPContext *s = h->priv_data;
416 static int parse_source_list(char *buf, char **sources, int *num_sources,
423 char *next = strchr(source_start, ',');
426 sources[*num_sources] = av_strdup(source_start);
427 if (!sources[*num_sources])
428 return AVERROR(ENOMEM);
429 source_start = next + 1;
431 if (*num_sources >= max_sources || !next)
437 /* put it in UDP context */
438 /* return non zero if error */
439 static int udp_open(URLContext *h, const char *uri, int flags)
441 char hostname[1024], localaddr[1024] = "";
442 int port, udp_fd = -1, tmp, bind_ret = -1;
443 UDPContext *s = h->priv_data;
447 struct sockaddr_storage my_addr;
449 int i, num_include_sources = 0, num_exclude_sources = 0;
450 char *include_sources[32], *exclude_sources[32];
453 h->max_packet_size = 1472;
455 is_output = !(flags & AVIO_FLAG_READ);
457 if (s->buffer_size < 0)
458 s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
461 if (parse_source_list(s->sources, include_sources,
462 &num_include_sources,
463 FF_ARRAY_ELEMS(include_sources)))
468 if (parse_source_list(s->block, exclude_sources, &num_exclude_sources,
469 FF_ARRAY_ELEMS(exclude_sources)))
474 h->max_packet_size = s->pkt_size;
476 p = strchr(uri, '?');
478 if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
480 s->reuse_socket = strtol(buf, &endptr, 10);
481 /* assume if no digits were found it is a request to enable it */
485 if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
486 s->ttl = strtol(buf, NULL, 10);
488 if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
489 s->local_port = strtol(buf, NULL, 10);
491 if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
492 h->max_packet_size = strtol(buf, NULL, 10);
494 if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
495 s->buffer_size = strtol(buf, NULL, 10);
497 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
498 s->is_connected = strtol(buf, NULL, 10);
500 if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
501 av_strlcpy(localaddr, buf, sizeof(localaddr));
503 if (av_find_info_tag(buf, sizeof(buf), "sources", p)) {
504 if (parse_source_list(buf, include_sources, &num_include_sources,
505 FF_ARRAY_ELEMS(include_sources)))
508 if (av_find_info_tag(buf, sizeof(buf), "block", p)) {
509 if (parse_source_list(buf, exclude_sources, &num_exclude_sources,
510 FF_ARRAY_ELEMS(exclude_sources)))
515 /* fill the dest addr */
516 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
518 /* XXX: fix av_url_split */
519 if (hostname[0] == '\0' || hostname[0] == '?') {
520 /* only accepts null hostname if input */
521 if (!(flags & AVIO_FLAG_READ))
524 if (ff_udp_set_remote_url(h, uri) < 0)
528 if ((s->is_multicast || s->local_port < 0) && (h->flags & AVIO_FLAG_READ))
529 s->local_port = port;
532 udp_fd = udp_socket_create(h, &my_addr, &len, localaddr);
534 udp_fd = udp_socket_create(h, &my_addr, &len, s->localaddr);
538 /* Follow the requested reuse option, unless it's multicast in which
539 * case enable reuse unless explicitly disabled.
541 if (s->reuse_socket > 0 || (s->is_multicast && s->reuse_socket < 0)) {
543 if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
547 /* If multicast, try binding the multicast address first, to avoid
548 * receiving UDP packets from other sources aimed at the same UDP
549 * port. This fails on windows. This makes sending to the same address
550 * using sendto() fail, so only do it if we're opened in read-only mode. */
551 if (s->is_multicast && !(h->flags & AVIO_FLAG_WRITE)) {
552 bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
554 /* bind to the local address if not multicast or if the multicast
556 /* the bind is needed to give a port to the socket now */
557 if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0) {
558 log_net_error(h, AV_LOG_ERROR, "bind failed");
562 len = sizeof(my_addr);
563 getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
564 s->local_port = udp_port(&my_addr, len);
566 if (s->is_multicast) {
567 if (h->flags & AVIO_FLAG_WRITE) {
569 if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
572 if (h->flags & AVIO_FLAG_READ) {
574 if (num_include_sources && num_exclude_sources) {
575 av_log(h, AV_LOG_ERROR, "Simultaneously including and excluding multicast sources is not supported\n");
578 if (num_include_sources) {
579 if (udp_set_multicast_sources(h, udp_fd,
580 (struct sockaddr *)&s->dest_addr,
583 num_include_sources, 1) < 0)
586 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
589 if (num_exclude_sources) {
590 if (udp_set_multicast_sources(h, udp_fd,
591 (struct sockaddr *)&s->dest_addr,
594 num_exclude_sources, 0) < 0)
601 /* limit the tx buf size to limit latency */
602 tmp = s->buffer_size;
603 if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
604 log_net_error(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF)");
608 /* set udp recv buffer size to the largest possible udp packet size to
609 * avoid losing data on OSes that set this too low by default. */
610 tmp = s->buffer_size;
611 if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
612 log_net_error(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF)");
614 /* make the socket non-blocking */
615 ff_socket_nonblock(udp_fd, 1);
617 if (s->is_connected) {
618 if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
619 log_net_error(h, AV_LOG_ERROR, "connect");
624 for (i = 0; i < num_include_sources; i++)
625 av_freep(&include_sources[i]);
626 for (i = 0; i < num_exclude_sources; i++)
627 av_freep(&exclude_sources[i]);
634 for (i = 0; i < num_include_sources; i++)
635 av_freep(&include_sources[i]);
636 for (i = 0; i < num_exclude_sources; i++)
637 av_freep(&exclude_sources[i]);
641 static int udp_read(URLContext *h, uint8_t *buf, int size)
643 UDPContext *s = h->priv_data;
646 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
647 ret = ff_network_wait_fd(s->udp_fd, 0);
651 ret = recv(s->udp_fd, buf, size, 0);
652 return ret < 0 ? ff_neterrno() : ret;
655 static int udp_write(URLContext *h, const uint8_t *buf, int size)
657 UDPContext *s = h->priv_data;
660 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
661 ret = ff_network_wait_fd(s->udp_fd, 1);
666 if (!s->is_connected) {
667 ret = sendto (s->udp_fd, buf, size, 0,
668 (struct sockaddr *) &s->dest_addr,
671 ret = send(s->udp_fd, buf, size, 0);
673 return ret < 0 ? ff_neterrno() : ret;
676 static int udp_close(URLContext *h)
678 UDPContext *s = h->priv_data;
680 if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
681 udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
682 closesocket(s->udp_fd);
686 URLProtocol ff_udp_protocol = {
688 .url_open = udp_open,
689 .url_read = udp_read,
690 .url_write = udp_write,
691 .url_close = udp_close,
692 .url_get_file_handle = udp_get_file_handle,
693 .priv_data_size = sizeof(UDPContext),
694 .flags = URL_PROTOCOL_FLAG_NETWORK,
695 .priv_data_class = &udp_class,