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 _DEFAULT_SOURCE
28 #define _BSD_SOURCE /* Needed for using struct ip_mreq with recent glibc */
31 #include "avio_internal.h"
32 #include "libavutil/avassert.h"
33 #include "libavutil/parseutils.h"
34 #include "libavutil/fifo.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/avstring.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/log.h"
39 #include "libavutil/time.h"
42 #include "os_support.h"
48 /* On many Linux systems, udplite.h is missing but the kernel supports UDP-Lite.
49 * So, we provide a fallback here.
51 #define UDPLITE_SEND_CSCOV 10
52 #define UDPLITE_RECV_CSCOV 11
55 #ifndef IPPROTO_UDPLITE
56 #define IPPROTO_UDPLITE 136
59 #if HAVE_PTHREAD_CANCEL
63 #ifndef HAVE_PTHREAD_CANCEL
64 #define HAVE_PTHREAD_CANCEL 0
67 #ifndef IPV6_ADD_MEMBERSHIP
68 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
69 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
72 #define UDP_TX_BUF_SIZE 32768
73 #define UDP_MAX_PKT_SIZE 65536
74 #define UDP_HEADER_SIZE 8
76 typedef struct UDPContext {
88 struct sockaddr_storage dest_addr;
92 /* Circular Buffer variables for use in UDP receive code */
93 int circular_buffer_size;
95 int circular_buffer_error;
96 int64_t packet_gap; /* delay between transmitted packets */
98 #if HAVE_PTHREAD_CANCEL
99 pthread_t circular_buffer_thread;
100 pthread_mutex_t mutex;
104 uint8_t tmp[UDP_MAX_PKT_SIZE+4];
108 struct sockaddr_storage local_addr_storage;
113 #define OFFSET(x) offsetof(UDPContext, x)
114 #define D AV_OPT_FLAG_DECODING_PARAM
115 #define E AV_OPT_FLAG_ENCODING_PARAM
116 static const AVOption options[] = {
117 { "buffer_size", "System data size (in bytes)", OFFSET(buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
118 { "packet_gap", "Delay between packets", OFFSET(packet_gap), AV_OPT_TYPE_DURATION, { .i64 = 0 }, 0, INT_MAX, .flags = E },
119 { "localport", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, D|E },
120 { "local_port", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
121 { "localaddr", "Local address", OFFSET(localaddr), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
122 { "udplite_coverage", "choose UDPLite head size which should be validated by checksum", OFFSET(udplite_coverage), AV_OPT_TYPE_INT, {.i64 = 0}, 0, INT_MAX, D|E },
123 { "pkt_size", "Maximum UDP packet size", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = 1472 }, -1, INT_MAX, .flags = D|E },
124 { "reuse", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, D|E },
125 { "reuse_socket", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, .flags = D|E },
126 { "broadcast", "explicitly allow or disallow broadcast destination", OFFSET(is_broadcast), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
127 { "ttl", "Time to live (multicast only)", OFFSET(ttl), AV_OPT_TYPE_INT, { .i64 = 16 }, 0, INT_MAX, E },
128 { "connect", "set if connect() should be called on socket", OFFSET(is_connected), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, .flags = D|E },
129 { "fifo_size", "set the UDP receiving circular buffer size, expressed as a number of packets with size of 188 bytes", OFFSET(circular_buffer_size), AV_OPT_TYPE_INT, {.i64 = 7*4096}, 0, INT_MAX, D },
130 { "overrun_nonfatal", "survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, D },
131 { "timeout", "set raise error timeout (only in read mode)", OFFSET(timeout), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
132 { "sources", "Source list", OFFSET(sources), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
133 { "block", "Block list", OFFSET(block), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
137 static const AVClass udp_class = {
139 .item_name = av_default_item_name,
141 .version = LIBAVUTIL_VERSION_INT,
144 static const AVClass udplite_context_class = {
145 .class_name = "udplite",
146 .item_name = av_default_item_name,
148 .version = LIBAVUTIL_VERSION_INT,
151 static void log_net_error(void *ctx, int level, const char* prefix)
154 av_strerror(ff_neterrno(), errbuf, sizeof(errbuf));
155 av_log(ctx, level, "%s: %s\n", prefix, errbuf);
158 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
159 struct sockaddr *addr)
161 #ifdef IP_MULTICAST_TTL
162 if (addr->sa_family == AF_INET) {
163 if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
164 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL)");
169 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
170 if (addr->sa_family == AF_INET6) {
171 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
172 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS)");
180 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
182 #ifdef IP_ADD_MEMBERSHIP
183 if (addr->sa_family == AF_INET) {
186 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
188 mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
190 mreq.imr_interface.s_addr= INADDR_ANY;
191 if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
192 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP)");
197 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
198 if (addr->sa_family == AF_INET6) {
199 struct ipv6_mreq mreq6;
201 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
202 mreq6.ipv6mr_interface= 0;
203 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
204 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP)");
212 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
214 #ifdef IP_DROP_MEMBERSHIP
215 if (addr->sa_family == AF_INET) {
218 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
220 mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
222 mreq.imr_interface.s_addr= INADDR_ANY;
223 if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
224 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP)");
229 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
230 if (addr->sa_family == AF_INET6) {
231 struct ipv6_mreq mreq6;
233 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
234 mreq6.ipv6mr_interface= 0;
235 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
236 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP)");
244 static struct addrinfo *udp_resolve_host(URLContext *h,
245 const char *hostname, int port,
246 int type, int family, int flags)
248 struct addrinfo hints = { 0 }, *res = 0;
251 const char *node = 0, *service = "0";
254 snprintf(sport, sizeof(sport), "%d", port);
257 if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
260 hints.ai_socktype = type;
261 hints.ai_family = family;
262 hints.ai_flags = flags;
263 if ((error = getaddrinfo(node, service, &hints, &res))) {
265 av_log(h, AV_LOG_ERROR, "getaddrinfo(%s, %s): %s\n",
266 node ? node : "unknown",
267 service ? service : "unknown",
268 gai_strerror(error));
274 static int udp_set_multicast_sources(URLContext *h,
275 int sockfd, struct sockaddr *addr,
276 int addr_len, char **sources,
277 int nb_sources, int include)
279 #if HAVE_STRUCT_GROUP_SOURCE_REQ && defined(MCAST_BLOCK_SOURCE) && !defined(_WIN32)
280 /* These ones are available in the microsoft SDK, but don't seem to work
281 * as on linux, so just prefer the v4-only approach there for now. */
283 for (i = 0; i < nb_sources; i++) {
284 struct group_source_req mreqs;
285 int level = addr->sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
286 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
287 SOCK_DGRAM, AF_UNSPEC,
290 return AVERROR(ENOENT);
292 mreqs.gsr_interface = 0;
293 memcpy(&mreqs.gsr_group, addr, addr_len);
294 memcpy(&mreqs.gsr_source, sourceaddr->ai_addr, sourceaddr->ai_addrlen);
295 freeaddrinfo(sourceaddr);
297 if (setsockopt(sockfd, level,
298 include ? MCAST_JOIN_SOURCE_GROUP : MCAST_BLOCK_SOURCE,
299 (const void *)&mreqs, sizeof(mreqs)) < 0) {
301 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_JOIN_SOURCE_GROUP)");
303 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_BLOCK_SOURCE)");
304 return ff_neterrno();
307 #elif HAVE_STRUCT_IP_MREQ_SOURCE && defined(IP_BLOCK_SOURCE)
309 if (addr->sa_family != AF_INET) {
310 av_log(NULL, AV_LOG_ERROR,
311 "Setting multicast sources only supported for IPv4\n");
312 return AVERROR(EINVAL);
314 for (i = 0; i < nb_sources; i++) {
315 struct ip_mreq_source mreqs;
316 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
317 SOCK_DGRAM, AF_UNSPEC,
320 return AVERROR(ENOENT);
321 if (sourceaddr->ai_addr->sa_family != AF_INET) {
322 freeaddrinfo(sourceaddr);
323 av_log(NULL, AV_LOG_ERROR, "%s is of incorrect protocol family\n",
325 return AVERROR(EINVAL);
328 mreqs.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
329 mreqs.imr_interface.s_addr = INADDR_ANY;
330 mreqs.imr_sourceaddr.s_addr = ((struct sockaddr_in *)sourceaddr->ai_addr)->sin_addr.s_addr;
331 freeaddrinfo(sourceaddr);
333 if (setsockopt(sockfd, IPPROTO_IP,
334 include ? IP_ADD_SOURCE_MEMBERSHIP : IP_BLOCK_SOURCE,
335 (const void *)&mreqs, sizeof(mreqs)) < 0) {
337 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_SOURCE_MEMBERSHIP)");
339 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_BLOCK_SOURCE)");
340 return ff_neterrno();
344 return AVERROR(ENOSYS);
348 static int udp_set_url(URLContext *h,
349 struct sockaddr_storage *addr,
350 const char *hostname, int port)
352 struct addrinfo *res0;
355 res0 = udp_resolve_host(h, hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
356 if (!res0) return AVERROR(EIO);
357 memcpy(addr, res0->ai_addr, res0->ai_addrlen);
358 addr_len = res0->ai_addrlen;
364 static int udp_socket_create(URLContext *h, struct sockaddr_storage *addr,
365 socklen_t *addr_len, const char *localaddr)
367 UDPContext *s = h->priv_data;
369 struct addrinfo *res0, *res;
370 int family = AF_UNSPEC;
372 if (((struct sockaddr *) &s->dest_addr)->sa_family)
373 family = ((struct sockaddr *) &s->dest_addr)->sa_family;
374 res0 = udp_resolve_host(h, (localaddr && localaddr[0]) ? localaddr : NULL,
376 SOCK_DGRAM, family, AI_PASSIVE);
379 for (res = res0; res; res=res->ai_next) {
380 if (s->udplite_coverage)
381 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, IPPROTO_UDPLITE);
383 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, 0);
384 if (udp_fd != -1) break;
385 log_net_error(NULL, AV_LOG_ERROR, "socket");
391 memcpy(addr, res->ai_addr, res->ai_addrlen);
392 *addr_len = res->ai_addrlen;
406 static int udp_port(struct sockaddr_storage *addr, int addr_len)
408 char sbuf[sizeof(int)*3+1];
411 if ((error = getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0, sbuf, sizeof(sbuf), NI_NUMERICSERV)) != 0) {
412 av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", gai_strerror(error));
416 return strtol(sbuf, NULL, 10);
421 * If no filename is given to av_open_input_file because you want to
422 * get the local port first, then you must call this function to set
423 * the remote server address.
425 * url syntax: udp://host:port[?option=val...]
426 * option: 'ttl=n' : set the ttl value (for multicast only)
427 * 'localport=n' : set the local port
428 * 'pkt_size=n' : set max packet size
429 * 'reuse=1' : enable reusing the socket
430 * 'overrun_nonfatal=1': survive in case of circular buffer overrun
432 * @param h media file context
433 * @param uri of the remote server
434 * @return zero if no error.
436 int ff_udp_set_remote_url(URLContext *h, const char *uri)
438 UDPContext *s = h->priv_data;
439 char hostname[256], buf[10];
443 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
445 /* set the destination address */
446 s->dest_addr_len = udp_set_url(h, &s->dest_addr, hostname, port);
447 if (s->dest_addr_len < 0) {
450 s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
451 p = strchr(uri, '?');
453 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
454 int was_connected = s->is_connected;
455 s->is_connected = strtol(buf, NULL, 10);
456 if (s->is_connected && !was_connected) {
457 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
460 log_net_error(h, AV_LOG_ERROR, "connect");
471 * Return the local port used by the UDP connection
472 * @param h media file context
473 * @return the local port number
475 int ff_udp_get_local_port(URLContext *h)
477 UDPContext *s = h->priv_data;
478 return s->local_port;
482 * Return the udp file handle for select() usage to wait for several RTP
483 * streams at the same time.
484 * @param h media file context
486 static int udp_get_file_handle(URLContext *h)
488 UDPContext *s = h->priv_data;
492 #if HAVE_PTHREAD_CANCEL
493 static void *circular_buffer_task_rx( void *_URLContext)
495 URLContext *h = _URLContext;
496 UDPContext *s = h->priv_data;
499 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
500 pthread_mutex_lock(&s->mutex);
501 if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
502 av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
503 s->circular_buffer_error = AVERROR(EIO);
509 pthread_mutex_unlock(&s->mutex);
510 /* Blocking operations are always cancellation points;
511 see "General Information" / "Thread Cancelation Overview"
513 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
514 len = recv(s->udp_fd, s->tmp+4, sizeof(s->tmp)-4, 0);
515 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
516 pthread_mutex_lock(&s->mutex);
518 if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
519 s->circular_buffer_error = ff_neterrno();
524 AV_WL32(s->tmp, len);
526 if(av_fifo_space(s->fifo) < len + 4) {
528 if (s->overrun_nonfatal) {
529 av_log(h, AV_LOG_WARNING, "Circular buffer overrun. "
530 "Surviving due to overrun_nonfatal option\n");
533 av_log(h, AV_LOG_ERROR, "Circular buffer overrun. "
534 "To avoid, increase fifo_size URL option. "
535 "To survive in such case, use overrun_nonfatal option\n");
536 s->circular_buffer_error = AVERROR(EIO);
540 av_fifo_generic_write(s->fifo, s->tmp, len+4, NULL);
541 pthread_cond_signal(&s->cond);
545 pthread_cond_signal(&s->cond);
546 pthread_mutex_unlock(&s->mutex);
550 static void *circular_buffer_task_tx( void *_URLContext)
552 URLContext *h = _URLContext;
553 UDPContext *s = h->priv_data;
556 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
557 pthread_mutex_lock(&s->mutex);
559 if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
560 av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
561 s->circular_buffer_error = AVERROR(EIO);
570 len=av_fifo_size(s->fifo);
575 if (pthread_cond_wait(&s->cond, &s->mutex) < 0) {
578 len=av_fifo_size(s->fifo);
581 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
584 av_assert0(len >= 0);
585 av_assert0(len <= sizeof(s->tmp));
587 av_fifo_generic_read(s->fifo, s->tmp, len, NULL);
589 pthread_mutex_unlock(&s->mutex);
590 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
596 if (!s->is_connected) {
597 ret = sendto (s->udp_fd, p, len, 0,
598 (struct sockaddr *) &s->dest_addr,
601 ret = send(s->udp_fd, p, len, 0);
607 if (ret != AVERROR(EAGAIN) && ret != AVERROR(EINTR)) {
608 pthread_mutex_lock(&s->mutex);
609 s->circular_buffer_error = ret;
610 pthread_mutex_unlock(&s->mutex);
616 av_usleep(s->packet_gap);
618 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
619 pthread_mutex_lock(&s->mutex);
623 pthread_mutex_unlock(&s->mutex);
630 static int parse_source_list(char *buf, char **sources, int *num_sources,
637 char *next = strchr(source_start, ',');
640 sources[*num_sources] = av_strdup(source_start);
641 if (!sources[*num_sources])
642 return AVERROR(ENOMEM);
643 source_start = next + 1;
645 if (*num_sources >= max_sources || !next)
651 /* put it in UDP context */
652 /* return non zero if error */
653 static int udp_open(URLContext *h, const char *uri, int flags)
655 char hostname[1024], localaddr[1024] = "";
656 int port, udp_fd = -1, tmp, bind_ret = -1, dscp = -1;
657 UDPContext *s = h->priv_data;
661 struct sockaddr_storage my_addr;
663 int i, num_include_sources = 0, num_exclude_sources = 0;
664 char *include_sources[32], *exclude_sources[32];
668 is_output = !(flags & AVIO_FLAG_READ);
669 if (s->buffer_size < 0)
670 s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
673 if (parse_source_list(s->sources, include_sources,
674 &num_include_sources,
675 FF_ARRAY_ELEMS(include_sources)))
680 if (parse_source_list(s->block, exclude_sources, &num_exclude_sources,
681 FF_ARRAY_ELEMS(exclude_sources)))
686 h->max_packet_size = s->pkt_size;
688 p = strchr(uri, '?');
690 if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
692 s->reuse_socket = strtol(buf, &endptr, 10);
693 /* assume if no digits were found it is a request to enable it */
697 if (av_find_info_tag(buf, sizeof(buf), "overrun_nonfatal", p)) {
699 s->overrun_nonfatal = strtol(buf, &endptr, 10);
700 /* assume if no digits were found it is a request to enable it */
702 s->overrun_nonfatal = 1;
703 if (!HAVE_PTHREAD_CANCEL)
704 av_log(h, AV_LOG_WARNING,
705 "'overrun_nonfatal' option was set but it is not supported "
706 "on this build (pthread support is required)\n");
708 if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
709 s->ttl = strtol(buf, NULL, 10);
711 if (av_find_info_tag(buf, sizeof(buf), "udplite_coverage", p)) {
712 s->udplite_coverage = strtol(buf, NULL, 10);
714 if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
715 s->local_port = strtol(buf, NULL, 10);
717 if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
718 s->pkt_size = strtol(buf, NULL, 10);
720 if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
721 s->buffer_size = strtol(buf, NULL, 10);
723 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
724 s->is_connected = strtol(buf, NULL, 10);
726 if (av_find_info_tag(buf, sizeof(buf), "dscp", p)) {
727 dscp = strtol(buf, NULL, 10);
729 if (av_find_info_tag(buf, sizeof(buf), "fifo_size", p)) {
730 s->circular_buffer_size = strtol(buf, NULL, 10);
731 if (!HAVE_PTHREAD_CANCEL)
732 av_log(h, AV_LOG_WARNING,
733 "'circular_buffer_size' option was set but it is not supported "
734 "on this build (pthread support is required)\n");
736 if (av_find_info_tag(buf, sizeof(buf), "packet_gap", p)) {
737 if (av_parse_time(&s->packet_gap, buf, 1)<0) {
738 av_log(h, AV_LOG_ERROR, "Can't parse 'packet_gap'");
741 if (!HAVE_PTHREAD_CANCEL)
742 av_log(h, AV_LOG_WARNING,
743 "'packet_gap' option was set but it is not supported "
744 "on this build (pthread support is required)\n");
746 if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
747 av_strlcpy(localaddr, buf, sizeof(localaddr));
749 if (av_find_info_tag(buf, sizeof(buf), "sources", p)) {
750 if (parse_source_list(buf, include_sources, &num_include_sources,
751 FF_ARRAY_ELEMS(include_sources)))
754 if (av_find_info_tag(buf, sizeof(buf), "block", p)) {
755 if (parse_source_list(buf, exclude_sources, &num_exclude_sources,
756 FF_ARRAY_ELEMS(exclude_sources)))
759 if (!is_output && av_find_info_tag(buf, sizeof(buf), "timeout", p))
760 s->timeout = strtol(buf, NULL, 10);
761 if (is_output && av_find_info_tag(buf, sizeof(buf), "broadcast", p))
762 s->is_broadcast = strtol(buf, NULL, 10);
764 /* handling needed to support options picking from both AVOption and URL */
765 s->circular_buffer_size *= 188;
766 if (flags & AVIO_FLAG_WRITE) {
767 h->max_packet_size = s->pkt_size;
769 h->max_packet_size = UDP_MAX_PKT_SIZE;
771 h->rw_timeout = s->timeout;
773 /* fill the dest addr */
774 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
776 /* XXX: fix av_url_split */
777 if (hostname[0] == '\0' || hostname[0] == '?') {
778 /* only accepts null hostname if input */
779 if (!(flags & AVIO_FLAG_READ))
782 if (ff_udp_set_remote_url(h, uri) < 0)
786 if ((s->is_multicast || s->local_port <= 0) && (h->flags & AVIO_FLAG_READ))
787 s->local_port = port;
790 udp_fd = udp_socket_create(h, &my_addr, &len, localaddr);
792 udp_fd = udp_socket_create(h, &my_addr, &len, s->localaddr);
796 s->local_addr_storage=my_addr; //store for future multicast join
798 /* Follow the requested reuse option, unless it's multicast in which
799 * case enable reuse unless explicitly disabled.
801 if (s->reuse_socket > 0 || (s->is_multicast && s->reuse_socket < 0)) {
803 if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
807 if (s->is_broadcast) {
809 if (setsockopt (udp_fd, SOL_SOCKET, SO_BROADCAST, &(s->is_broadcast), sizeof(s->is_broadcast)) != 0)
814 /* Set the checksum coverage for UDP-Lite (RFC 3828) for sending and receiving.
815 * The receiver coverage has to be less than or equal to the sender coverage.
816 * Otherwise, the receiver will drop all packets.
818 if (s->udplite_coverage) {
819 if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
820 av_log(h, AV_LOG_WARNING, "socket option UDPLITE_SEND_CSCOV not available");
822 if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
823 av_log(h, AV_LOG_WARNING, "socket option UDPLITE_RECV_CSCOV not available");
828 if (setsockopt (udp_fd, IPPROTO_IP, IP_TOS, &dscp, sizeof(dscp)) != 0)
832 /* If multicast, try binding the multicast address first, to avoid
833 * receiving UDP packets from other sources aimed at the same UDP
834 * port. This fails on windows. This makes sending to the same address
835 * using sendto() fail, so only do it if we're opened in read-only mode. */
836 if (s->is_multicast && !(h->flags & AVIO_FLAG_WRITE)) {
837 bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
839 /* bind to the local address if not multicast or if the multicast
841 /* the bind is needed to give a port to the socket now */
842 if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0) {
843 log_net_error(h, AV_LOG_ERROR, "bind failed");
847 len = sizeof(my_addr);
848 getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
849 s->local_port = udp_port(&my_addr, len);
851 if (s->is_multicast) {
852 if (h->flags & AVIO_FLAG_WRITE) {
854 if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
857 if (h->flags & AVIO_FLAG_READ) {
859 if (num_include_sources && num_exclude_sources) {
860 av_log(h, AV_LOG_ERROR, "Simultaneously including and excluding multicast sources is not supported\n");
863 if (num_include_sources) {
864 if (udp_set_multicast_sources(h, udp_fd,
865 (struct sockaddr *)&s->dest_addr,
868 num_include_sources, 1) < 0)
871 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage) < 0)
874 if (num_exclude_sources) {
875 if (udp_set_multicast_sources(h, udp_fd,
876 (struct sockaddr *)&s->dest_addr,
879 num_exclude_sources, 0) < 0)
886 /* limit the tx buf size to limit latency */
887 tmp = s->buffer_size;
888 if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
889 log_net_error(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF)");
893 /* set udp recv buffer size to the requested value (default 64K) */
894 tmp = s->buffer_size;
895 if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
896 log_net_error(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF)");
899 if (getsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, &len) < 0) {
900 log_net_error(h, AV_LOG_WARNING, "getsockopt(SO_RCVBUF)");
902 av_log(h, AV_LOG_DEBUG, "end receive buffer size reported is %d\n", tmp);
903 if(tmp < s->buffer_size)
904 av_log(h, AV_LOG_WARNING, "attempted to set receive buffer to size %d but it only ended up set as %d", s->buffer_size, tmp);
907 /* make the socket non-blocking */
908 ff_socket_nonblock(udp_fd, 1);
910 if (s->is_connected) {
911 if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
912 log_net_error(h, AV_LOG_ERROR, "connect");
917 for (i = 0; i < num_include_sources; i++)
918 av_freep(&include_sources[i]);
919 for (i = 0; i < num_exclude_sources; i++)
920 av_freep(&exclude_sources[i]);
924 #if HAVE_PTHREAD_CANCEL
926 Create thread in case of:
927 1. Input and circular_buffer_size is set
928 2. Output and packet_gap and circular_buffer_size is set
931 if (is_output && s->packet_gap && !s->circular_buffer_size) {
932 /* Warn user in case of 'circular_buffer_size' is not set */
933 av_log(h, AV_LOG_WARNING,"'packet_gap' option was set but 'circular_buffer_size' is not, but required\n");
936 if ((!is_output && s->circular_buffer_size) || (is_output && s->packet_gap && s->circular_buffer_size)) {
939 /* start the task going */
940 s->fifo = av_fifo_alloc(s->circular_buffer_size);
941 ret = pthread_mutex_init(&s->mutex, NULL);
943 av_log(h, AV_LOG_ERROR, "pthread_mutex_init failed : %s\n", strerror(ret));
946 ret = pthread_cond_init(&s->cond, NULL);
948 av_log(h, AV_LOG_ERROR, "pthread_cond_init failed : %s\n", strerror(ret));
951 ret = pthread_create(&s->circular_buffer_thread, NULL, is_output?circular_buffer_task_tx:circular_buffer_task_rx, h);
953 av_log(h, AV_LOG_ERROR, "pthread_create failed : %s\n", strerror(ret));
956 s->thread_started = 1;
961 #if HAVE_PTHREAD_CANCEL
963 pthread_cond_destroy(&s->cond);
965 pthread_mutex_destroy(&s->mutex);
970 av_fifo_freep(&s->fifo);
971 for (i = 0; i < num_include_sources; i++)
972 av_freep(&include_sources[i]);
973 for (i = 0; i < num_exclude_sources; i++)
974 av_freep(&exclude_sources[i]);
978 static int udplite_open(URLContext *h, const char *uri, int flags)
980 UDPContext *s = h->priv_data;
982 // set default checksum coverage
983 s->udplite_coverage = UDP_HEADER_SIZE;
985 return udp_open(h, uri, flags);
988 static int udp_read(URLContext *h, uint8_t *buf, int size)
990 UDPContext *s = h->priv_data;
992 #if HAVE_PTHREAD_CANCEL
993 int avail, nonblock = h->flags & AVIO_FLAG_NONBLOCK;
996 pthread_mutex_lock(&s->mutex);
998 avail = av_fifo_size(s->fifo);
999 if (avail) { // >=size) {
1002 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
1003 avail= AV_RL32(tmp);
1005 av_log(h, AV_LOG_WARNING, "Part of datagram lost due to insufficient buffer size\n");
1009 av_fifo_generic_read(s->fifo, buf, avail, NULL);
1010 av_fifo_drain(s->fifo, AV_RL32(tmp) - avail);
1011 pthread_mutex_unlock(&s->mutex);
1013 } else if(s->circular_buffer_error){
1014 int err = s->circular_buffer_error;
1015 pthread_mutex_unlock(&s->mutex);
1017 } else if(nonblock) {
1018 pthread_mutex_unlock(&s->mutex);
1019 return AVERROR(EAGAIN);
1022 /* FIXME: using the monotonic clock would be better,
1023 but it does not exist on all supported platforms. */
1024 int64_t t = av_gettime() + 100000;
1025 struct timespec tv = { .tv_sec = t / 1000000,
1026 .tv_nsec = (t % 1000000) * 1000 };
1027 if (pthread_cond_timedwait(&s->cond, &s->mutex, &tv) < 0) {
1028 pthread_mutex_unlock(&s->mutex);
1029 return AVERROR(errno == ETIMEDOUT ? EAGAIN : errno);
1037 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1038 ret = ff_network_wait_fd(s->udp_fd, 0);
1042 ret = recv(s->udp_fd, buf, size, 0);
1044 return ret < 0 ? ff_neterrno() : ret;
1047 static int udp_write(URLContext *h, const uint8_t *buf, int size)
1049 UDPContext *s = h->priv_data;
1052 #if HAVE_PTHREAD_CANCEL
1056 pthread_mutex_lock(&s->mutex);
1059 Return error if last tx failed.
1060 Here we can't know on which packet error was, but it needs to know that error exists.
1062 if (s->circular_buffer_error<0) {
1063 int err=s->circular_buffer_error;
1064 pthread_mutex_unlock(&s->mutex);
1068 if(av_fifo_space(s->fifo) < size + 4) {
1069 /* What about a partial packet tx ? */
1070 pthread_mutex_unlock(&s->mutex);
1071 return AVERROR(ENOMEM);
1074 av_fifo_generic_write(s->fifo, tmp, 4, NULL); /* size of packet */
1075 av_fifo_generic_write(s->fifo, (uint8_t *)buf, size, NULL); /* the data */
1076 pthread_cond_signal(&s->cond);
1077 pthread_mutex_unlock(&s->mutex);
1081 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1082 ret = ff_network_wait_fd(s->udp_fd, 1);
1087 if (!s->is_connected) {
1088 ret = sendto (s->udp_fd, buf, size, 0,
1089 (struct sockaddr *) &s->dest_addr,
1092 ret = send(s->udp_fd, buf, size, 0);
1094 return ret < 0 ? ff_neterrno() : ret;
1097 static int udp_close(URLContext *h)
1099 UDPContext *s = h->priv_data;
1101 #if HAVE_PTHREAD_CANCEL
1102 // Request close once writing is finished
1103 if (s->thread_started && !(h->flags & AVIO_FLAG_READ)) {
1104 pthread_mutex_lock(&s->mutex);
1106 pthread_cond_signal(&s->cond);
1107 pthread_mutex_unlock(&s->mutex);
1111 if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
1112 udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage);
1113 #if HAVE_PTHREAD_CANCEL
1114 if (s->thread_started) {
1116 // Cancel only read, as write has been signaled as success to the user
1117 if (h->flags & AVIO_FLAG_READ)
1118 pthread_cancel(s->circular_buffer_thread);
1119 ret = pthread_join(s->circular_buffer_thread, NULL);
1121 av_log(h, AV_LOG_ERROR, "pthread_join(): %s\n", strerror(ret));
1122 pthread_mutex_destroy(&s->mutex);
1123 pthread_cond_destroy(&s->cond);
1126 closesocket(s->udp_fd);
1127 av_fifo_freep(&s->fifo);
1131 const URLProtocol ff_udp_protocol = {
1133 .url_open = udp_open,
1134 .url_read = udp_read,
1135 .url_write = udp_write,
1136 .url_close = udp_close,
1137 .url_get_file_handle = udp_get_file_handle,
1138 .priv_data_size = sizeof(UDPContext),
1139 .priv_data_class = &udp_class,
1140 .flags = URL_PROTOCOL_FLAG_NETWORK,
1143 const URLProtocol ff_udplite_protocol = {
1145 .url_open = udplite_open,
1146 .url_read = udp_read,
1147 .url_write = udp_write,
1148 .url_close = udp_close,
1149 .url_get_file_handle = udp_get_file_handle,
1150 .priv_data_size = sizeof(UDPContext),
1151 .priv_data_class = &udplite_context_class,
1152 .flags = URL_PROTOCOL_FLAG_NETWORK,