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"
46 #include "TargetConditionals.h"
52 /* On many Linux systems, udplite.h is missing but the kernel supports UDP-Lite.
53 * So, we provide a fallback here.
55 #define UDPLITE_SEND_CSCOV 10
56 #define UDPLITE_RECV_CSCOV 11
59 #ifndef IPPROTO_UDPLITE
60 #define IPPROTO_UDPLITE 136
63 #if HAVE_PTHREAD_CANCEL
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 bitrate; /* number of bits to send per second */
99 #if HAVE_PTHREAD_CANCEL
100 pthread_t circular_buffer_thread;
101 pthread_mutex_t mutex;
105 uint8_t tmp[UDP_MAX_PKT_SIZE+4];
109 struct sockaddr_storage local_addr_storage;
114 #define OFFSET(x) offsetof(UDPContext, x)
115 #define D AV_OPT_FLAG_DECODING_PARAM
116 #define E AV_OPT_FLAG_ENCODING_PARAM
117 static const AVOption options[] = {
118 { "buffer_size", "System data size (in bytes)", OFFSET(buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
119 { "bitrate", "Bits to send per second", OFFSET(bitrate), AV_OPT_TYPE_INT64, { .i64 = 0 }, 0, INT64_MAX, .flags = E },
120 { "burst_bits", "Max length of bursts in bits (when using bitrate)", OFFSET(burst_bits), AV_OPT_TYPE_INT64, { .i64 = 0 }, 0, INT64_MAX, .flags = E },
121 { "localport", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, D|E },
122 { "local_port", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
123 { "localaddr", "Local address", OFFSET(localaddr), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
124 { "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 },
125 { "pkt_size", "Maximum UDP packet size", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = 1472 }, -1, INT_MAX, .flags = D|E },
126 { "reuse", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, D|E },
127 { "reuse_socket", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, .flags = D|E },
128 { "broadcast", "explicitly allow or disallow broadcast destination", OFFSET(is_broadcast), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
129 { "ttl", "Time to live (multicast only)", OFFSET(ttl), AV_OPT_TYPE_INT, { .i64 = 16 }, 0, INT_MAX, E },
130 { "connect", "set if connect() should be called on socket", OFFSET(is_connected), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, .flags = D|E },
131 { "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 },
132 { "overrun_nonfatal", "survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, D },
133 { "timeout", "set raise error timeout (only in read mode)", OFFSET(timeout), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
134 { "sources", "Source list", OFFSET(sources), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
135 { "block", "Block list", OFFSET(block), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
139 static const AVClass udp_class = {
141 .item_name = av_default_item_name,
143 .version = LIBAVUTIL_VERSION_INT,
146 static const AVClass udplite_context_class = {
147 .class_name = "udplite",
148 .item_name = av_default_item_name,
150 .version = LIBAVUTIL_VERSION_INT,
153 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
154 struct sockaddr *addr)
156 #ifdef IP_MULTICAST_TTL
157 if (addr->sa_family == AF_INET) {
158 if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
159 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL)");
164 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
165 if (addr->sa_family == AF_INET6) {
166 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
167 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS)");
175 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
177 #ifdef IP_ADD_MEMBERSHIP
178 if (addr->sa_family == AF_INET) {
181 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
183 mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
185 mreq.imr_interface.s_addr= INADDR_ANY;
186 if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
187 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP)");
192 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
193 if (addr->sa_family == AF_INET6) {
194 struct ipv6_mreq mreq6;
196 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
197 mreq6.ipv6mr_interface= 0;
198 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
199 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP)");
207 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
209 #ifdef IP_DROP_MEMBERSHIP
210 if (addr->sa_family == AF_INET) {
213 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
215 mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
217 mreq.imr_interface.s_addr= INADDR_ANY;
218 if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
219 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP)");
224 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
225 if (addr->sa_family == AF_INET6) {
226 struct ipv6_mreq mreq6;
228 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
229 mreq6.ipv6mr_interface= 0;
230 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
231 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP)");
239 static struct addrinfo *udp_resolve_host(URLContext *h,
240 const char *hostname, int port,
241 int type, int family, int flags)
243 struct addrinfo hints = { 0 }, *res = 0;
246 const char *node = 0, *service = "0";
249 snprintf(sport, sizeof(sport), "%d", port);
252 if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
255 hints.ai_socktype = type;
256 hints.ai_family = family;
257 hints.ai_flags = flags;
258 if ((error = getaddrinfo(node, service, &hints, &res))) {
260 av_log(h, AV_LOG_ERROR, "getaddrinfo(%s, %s): %s\n",
261 node ? node : "unknown",
263 gai_strerror(error));
269 static int udp_set_multicast_sources(URLContext *h,
270 int sockfd, struct sockaddr *addr,
271 int addr_len, char **sources,
272 int nb_sources, int include)
274 #if HAVE_STRUCT_GROUP_SOURCE_REQ && defined(MCAST_BLOCK_SOURCE) && !defined(_WIN32) && (!defined(TARGET_OS_TV) || !TARGET_OS_TV)
275 /* These ones are available in the microsoft SDK, but don't seem to work
276 * as on linux, so just prefer the v4-only approach there for now. */
278 for (i = 0; i < nb_sources; i++) {
279 struct group_source_req mreqs;
280 int level = addr->sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
281 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
282 SOCK_DGRAM, AF_UNSPEC,
285 return AVERROR(ENOENT);
287 mreqs.gsr_interface = 0;
288 memcpy(&mreqs.gsr_group, addr, addr_len);
289 memcpy(&mreqs.gsr_source, sourceaddr->ai_addr, sourceaddr->ai_addrlen);
290 freeaddrinfo(sourceaddr);
292 if (setsockopt(sockfd, level,
293 include ? MCAST_JOIN_SOURCE_GROUP : MCAST_BLOCK_SOURCE,
294 (const void *)&mreqs, sizeof(mreqs)) < 0) {
296 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_JOIN_SOURCE_GROUP)");
298 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_BLOCK_SOURCE)");
299 return ff_neterrno();
302 #elif HAVE_STRUCT_IP_MREQ_SOURCE && defined(IP_BLOCK_SOURCE)
304 if (addr->sa_family != AF_INET) {
305 av_log(NULL, AV_LOG_ERROR,
306 "Setting multicast sources only supported for IPv4\n");
307 return AVERROR(EINVAL);
309 for (i = 0; i < nb_sources; i++) {
310 struct ip_mreq_source mreqs;
311 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
312 SOCK_DGRAM, AF_UNSPEC,
315 return AVERROR(ENOENT);
316 if (sourceaddr->ai_addr->sa_family != AF_INET) {
317 freeaddrinfo(sourceaddr);
318 av_log(NULL, AV_LOG_ERROR, "%s is of incorrect protocol family\n",
320 return AVERROR(EINVAL);
323 mreqs.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
324 mreqs.imr_interface.s_addr = INADDR_ANY;
325 mreqs.imr_sourceaddr.s_addr = ((struct sockaddr_in *)sourceaddr->ai_addr)->sin_addr.s_addr;
326 freeaddrinfo(sourceaddr);
328 if (setsockopt(sockfd, IPPROTO_IP,
329 include ? IP_ADD_SOURCE_MEMBERSHIP : IP_BLOCK_SOURCE,
330 (const void *)&mreqs, sizeof(mreqs)) < 0) {
332 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_SOURCE_MEMBERSHIP)");
334 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_BLOCK_SOURCE)");
335 return ff_neterrno();
339 return AVERROR(ENOSYS);
343 static int udp_set_url(URLContext *h,
344 struct sockaddr_storage *addr,
345 const char *hostname, int port)
347 struct addrinfo *res0;
350 res0 = udp_resolve_host(h, hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
351 if (!res0) return AVERROR(EIO);
352 memcpy(addr, res0->ai_addr, res0->ai_addrlen);
353 addr_len = res0->ai_addrlen;
359 static int udp_socket_create(URLContext *h, struct sockaddr_storage *addr,
360 socklen_t *addr_len, const char *localaddr)
362 UDPContext *s = h->priv_data;
364 struct addrinfo *res0, *res;
365 int family = AF_UNSPEC;
367 if (((struct sockaddr *) &s->dest_addr)->sa_family)
368 family = ((struct sockaddr *) &s->dest_addr)->sa_family;
369 res0 = udp_resolve_host(h, (localaddr && localaddr[0]) ? localaddr : NULL,
371 SOCK_DGRAM, family, AI_PASSIVE);
374 for (res = res0; res; res=res->ai_next) {
375 if (s->udplite_coverage)
376 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, IPPROTO_UDPLITE);
378 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, 0);
379 if (udp_fd != -1) break;
380 ff_log_net_error(NULL, AV_LOG_ERROR, "socket");
386 memcpy(addr, res->ai_addr, res->ai_addrlen);
387 *addr_len = res->ai_addrlen;
401 static int udp_port(struct sockaddr_storage *addr, int addr_len)
403 char sbuf[sizeof(int)*3+1];
406 if ((error = getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0, sbuf, sizeof(sbuf), NI_NUMERICSERV)) != 0) {
407 av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", gai_strerror(error));
411 return strtol(sbuf, NULL, 10);
416 * If no filename is given to av_open_input_file because you want to
417 * get the local port first, then you must call this function to set
418 * the remote server address.
420 * url syntax: udp://host:port[?option=val...]
421 * option: 'ttl=n' : set the ttl value (for multicast only)
422 * 'localport=n' : set the local port
423 * 'pkt_size=n' : set max packet size
424 * 'reuse=1' : enable reusing the socket
425 * 'overrun_nonfatal=1': survive in case of circular buffer overrun
427 * @param h media file context
428 * @param uri of the remote server
429 * @return zero if no error.
431 int ff_udp_set_remote_url(URLContext *h, const char *uri)
433 UDPContext *s = h->priv_data;
434 char hostname[256], buf[10];
438 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
440 /* set the destination address */
441 s->dest_addr_len = udp_set_url(h, &s->dest_addr, hostname, port);
442 if (s->dest_addr_len < 0) {
445 s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
446 p = strchr(uri, '?');
448 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
449 int was_connected = s->is_connected;
450 s->is_connected = strtol(buf, NULL, 10);
451 if (s->is_connected && !was_connected) {
452 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
455 ff_log_net_error(h, AV_LOG_ERROR, "connect");
466 * Return the local port used by the UDP connection
467 * @param h media file context
468 * @return the local port number
470 int ff_udp_get_local_port(URLContext *h)
472 UDPContext *s = h->priv_data;
473 return s->local_port;
477 * Return the udp file handle for select() usage to wait for several RTP
478 * streams at the same time.
479 * @param h media file context
481 static int udp_get_file_handle(URLContext *h)
483 UDPContext *s = h->priv_data;
487 #if HAVE_PTHREAD_CANCEL
488 static void *circular_buffer_task_rx( void *_URLContext)
490 URLContext *h = _URLContext;
491 UDPContext *s = h->priv_data;
494 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
495 pthread_mutex_lock(&s->mutex);
496 if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
497 av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
498 s->circular_buffer_error = AVERROR(EIO);
504 pthread_mutex_unlock(&s->mutex);
505 /* Blocking operations are always cancellation points;
506 see "General Information" / "Thread Cancelation Overview"
508 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
509 len = recv(s->udp_fd, s->tmp+4, sizeof(s->tmp)-4, 0);
510 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
511 pthread_mutex_lock(&s->mutex);
513 if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
514 s->circular_buffer_error = ff_neterrno();
519 AV_WL32(s->tmp, len);
521 if(av_fifo_space(s->fifo) < len + 4) {
523 if (s->overrun_nonfatal) {
524 av_log(h, AV_LOG_WARNING, "Circular buffer overrun. "
525 "Surviving due to overrun_nonfatal option\n");
528 av_log(h, AV_LOG_ERROR, "Circular buffer overrun. "
529 "To avoid, increase fifo_size URL option. "
530 "To survive in such case, use overrun_nonfatal option\n");
531 s->circular_buffer_error = AVERROR(EIO);
535 av_fifo_generic_write(s->fifo, s->tmp, len+4, NULL);
536 pthread_cond_signal(&s->cond);
540 pthread_cond_signal(&s->cond);
541 pthread_mutex_unlock(&s->mutex);
545 static void *circular_buffer_task_tx( void *_URLContext)
547 URLContext *h = _URLContext;
548 UDPContext *s = h->priv_data;
550 int64_t target_timestamp = av_gettime_relative();
551 int64_t start_timestamp = av_gettime_relative();
552 int64_t sent_bits = 0;
553 int64_t burst_interval = s->bitrate ? (s->burst_bits * 1000000 / s->bitrate) : 0;
554 int64_t max_delay = s->bitrate ? ((int64_t)h->max_packet_size * 8 * 1000000 / s->bitrate + 1) : 0;
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);
571 len=av_fifo_size(s->fifo);
576 if (pthread_cond_wait(&s->cond, &s->mutex) < 0) {
579 len=av_fifo_size(s->fifo);
582 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
585 av_assert0(len >= 0);
586 av_assert0(len <= sizeof(s->tmp));
588 av_fifo_generic_read(s->fifo, s->tmp, len, NULL);
590 pthread_mutex_unlock(&s->mutex);
591 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
594 timestamp = av_gettime_relative();
595 if (timestamp < target_timestamp) {
596 int64_t delay = target_timestamp - timestamp;
597 if (delay > max_delay) {
599 start_timestamp = timestamp + delay;
604 if (timestamp - burst_interval > target_timestamp) {
605 start_timestamp = timestamp - burst_interval;
609 sent_bits += len * 8;
610 target_timestamp = start_timestamp + sent_bits * 1000000 / s->bitrate;
617 if (!s->is_connected) {
618 ret = sendto (s->udp_fd, p, len, 0,
619 (struct sockaddr *) &s->dest_addr,
622 ret = send(s->udp_fd, p, len, 0);
628 if (ret != AVERROR(EAGAIN) && ret != AVERROR(EINTR)) {
629 pthread_mutex_lock(&s->mutex);
630 s->circular_buffer_error = ret;
631 pthread_mutex_unlock(&s->mutex);
637 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
638 pthread_mutex_lock(&s->mutex);
642 pthread_mutex_unlock(&s->mutex);
649 static int parse_source_list(char *buf, char **sources, int *num_sources,
656 char *next = strchr(source_start, ',');
659 sources[*num_sources] = av_strdup(source_start);
660 if (!sources[*num_sources])
661 return AVERROR(ENOMEM);
662 source_start = next + 1;
664 if (*num_sources >= max_sources || !next)
670 /* put it in UDP context */
671 /* return non zero if error */
672 static int udp_open(URLContext *h, const char *uri, int flags)
674 char hostname[1024], localaddr[1024] = "";
675 int port, udp_fd = -1, tmp, bind_ret = -1, dscp = -1;
676 UDPContext *s = h->priv_data;
680 struct sockaddr_storage my_addr;
682 int i, num_include_sources = 0, num_exclude_sources = 0;
683 char *include_sources[32], *exclude_sources[32];
687 is_output = !(flags & AVIO_FLAG_READ);
688 if (s->buffer_size < 0)
689 s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
692 if (parse_source_list(s->sources, include_sources,
693 &num_include_sources,
694 FF_ARRAY_ELEMS(include_sources)))
699 if (parse_source_list(s->block, exclude_sources, &num_exclude_sources,
700 FF_ARRAY_ELEMS(exclude_sources)))
705 h->max_packet_size = s->pkt_size;
707 p = strchr(uri, '?');
709 if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
711 s->reuse_socket = strtol(buf, &endptr, 10);
712 /* assume if no digits were found it is a request to enable it */
716 if (av_find_info_tag(buf, sizeof(buf), "overrun_nonfatal", p)) {
718 s->overrun_nonfatal = strtol(buf, &endptr, 10);
719 /* assume if no digits were found it is a request to enable it */
721 s->overrun_nonfatal = 1;
722 if (!HAVE_PTHREAD_CANCEL)
723 av_log(h, AV_LOG_WARNING,
724 "'overrun_nonfatal' option was set but it is not supported "
725 "on this build (pthread support is required)\n");
727 if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
728 s->ttl = strtol(buf, NULL, 10);
730 if (av_find_info_tag(buf, sizeof(buf), "udplite_coverage", p)) {
731 s->udplite_coverage = strtol(buf, NULL, 10);
733 if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
734 s->local_port = strtol(buf, NULL, 10);
736 if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
737 s->pkt_size = strtol(buf, NULL, 10);
739 if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
740 s->buffer_size = strtol(buf, NULL, 10);
742 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
743 s->is_connected = strtol(buf, NULL, 10);
745 if (av_find_info_tag(buf, sizeof(buf), "dscp", p)) {
746 dscp = strtol(buf, NULL, 10);
748 if (av_find_info_tag(buf, sizeof(buf), "fifo_size", p)) {
749 s->circular_buffer_size = strtol(buf, NULL, 10);
750 if (!HAVE_PTHREAD_CANCEL)
751 av_log(h, AV_LOG_WARNING,
752 "'circular_buffer_size' option was set but it is not supported "
753 "on this build (pthread support is required)\n");
755 if (av_find_info_tag(buf, sizeof(buf), "bitrate", p)) {
756 s->bitrate = strtoll(buf, NULL, 10);
757 if (!HAVE_PTHREAD_CANCEL)
758 av_log(h, AV_LOG_WARNING,
759 "'bitrate' option was set but it is not supported "
760 "on this build (pthread support is required)\n");
762 if (av_find_info_tag(buf, sizeof(buf), "burst_bits", p)) {
763 s->burst_bits = strtoll(buf, NULL, 10);
765 if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
766 av_strlcpy(localaddr, buf, sizeof(localaddr));
768 if (av_find_info_tag(buf, sizeof(buf), "sources", p)) {
769 if (parse_source_list(buf, include_sources, &num_include_sources,
770 FF_ARRAY_ELEMS(include_sources)))
773 if (av_find_info_tag(buf, sizeof(buf), "block", p)) {
774 if (parse_source_list(buf, exclude_sources, &num_exclude_sources,
775 FF_ARRAY_ELEMS(exclude_sources)))
778 if (!is_output && av_find_info_tag(buf, sizeof(buf), "timeout", p))
779 s->timeout = strtol(buf, NULL, 10);
780 if (is_output && av_find_info_tag(buf, sizeof(buf), "broadcast", p))
781 s->is_broadcast = strtol(buf, NULL, 10);
783 /* handling needed to support options picking from both AVOption and URL */
784 s->circular_buffer_size *= 188;
785 if (flags & AVIO_FLAG_WRITE) {
786 h->max_packet_size = s->pkt_size;
788 h->max_packet_size = UDP_MAX_PKT_SIZE;
790 h->rw_timeout = s->timeout;
792 /* fill the dest addr */
793 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
795 /* XXX: fix av_url_split */
796 if (hostname[0] == '\0' || hostname[0] == '?') {
797 /* only accepts null hostname if input */
798 if (!(flags & AVIO_FLAG_READ))
801 if (ff_udp_set_remote_url(h, uri) < 0)
805 if ((s->is_multicast || s->local_port <= 0) && (h->flags & AVIO_FLAG_READ))
806 s->local_port = port;
809 udp_fd = udp_socket_create(h, &my_addr, &len, localaddr);
811 udp_fd = udp_socket_create(h, &my_addr, &len, s->localaddr);
815 s->local_addr_storage=my_addr; //store for future multicast join
817 /* Follow the requested reuse option, unless it's multicast in which
818 * case enable reuse unless explicitly disabled.
820 if (s->reuse_socket > 0 || (s->is_multicast && s->reuse_socket < 0)) {
822 if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
826 if (s->is_broadcast) {
828 if (setsockopt (udp_fd, SOL_SOCKET, SO_BROADCAST, &(s->is_broadcast), sizeof(s->is_broadcast)) != 0)
833 /* Set the checksum coverage for UDP-Lite (RFC 3828) for sending and receiving.
834 * The receiver coverage has to be less than or equal to the sender coverage.
835 * Otherwise, the receiver will drop all packets.
837 if (s->udplite_coverage) {
838 if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
839 av_log(h, AV_LOG_WARNING, "socket option UDPLITE_SEND_CSCOV not available");
841 if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
842 av_log(h, AV_LOG_WARNING, "socket option UDPLITE_RECV_CSCOV not available");
847 if (setsockopt (udp_fd, IPPROTO_IP, IP_TOS, &dscp, sizeof(dscp)) != 0)
851 /* If multicast, try binding the multicast address first, to avoid
852 * receiving UDP packets from other sources aimed at the same UDP
853 * port. This fails on windows. This makes sending to the same address
854 * using sendto() fail, so only do it if we're opened in read-only mode. */
855 if (s->is_multicast && !(h->flags & AVIO_FLAG_WRITE)) {
856 bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
858 /* bind to the local address if not multicast or if the multicast
860 /* the bind is needed to give a port to the socket now */
861 if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0) {
862 ff_log_net_error(h, AV_LOG_ERROR, "bind failed");
866 len = sizeof(my_addr);
867 getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
868 s->local_port = udp_port(&my_addr, len);
870 if (s->is_multicast) {
871 if (h->flags & AVIO_FLAG_WRITE) {
873 if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
876 if (h->flags & AVIO_FLAG_READ) {
878 if (num_include_sources && num_exclude_sources) {
879 av_log(h, AV_LOG_ERROR, "Simultaneously including and excluding multicast sources is not supported\n");
882 if (num_include_sources) {
883 if (udp_set_multicast_sources(h, udp_fd,
884 (struct sockaddr *)&s->dest_addr,
887 num_include_sources, 1) < 0)
890 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage) < 0)
893 if (num_exclude_sources) {
894 if (udp_set_multicast_sources(h, udp_fd,
895 (struct sockaddr *)&s->dest_addr,
898 num_exclude_sources, 0) < 0)
905 /* limit the tx buf size to limit latency */
906 tmp = s->buffer_size;
907 if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
908 ff_log_net_error(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF)");
912 /* set udp recv buffer size to the requested value (default 64K) */
913 tmp = s->buffer_size;
914 if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
915 ff_log_net_error(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF)");
918 if (getsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, &len) < 0) {
919 ff_log_net_error(h, AV_LOG_WARNING, "getsockopt(SO_RCVBUF)");
921 av_log(h, AV_LOG_DEBUG, "end receive buffer size reported is %d\n", tmp);
922 if(tmp < s->buffer_size)
923 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);
926 /* make the socket non-blocking */
927 ff_socket_nonblock(udp_fd, 1);
929 if (s->is_connected) {
930 if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
931 ff_log_net_error(h, AV_LOG_ERROR, "connect");
936 for (i = 0; i < num_include_sources; i++)
937 av_freep(&include_sources[i]);
938 for (i = 0; i < num_exclude_sources; i++)
939 av_freep(&exclude_sources[i]);
943 #if HAVE_PTHREAD_CANCEL
945 Create thread in case of:
946 1. Input and circular_buffer_size is set
947 2. Output and bitrate and circular_buffer_size is set
950 if (is_output && s->bitrate && !s->circular_buffer_size) {
951 /* Warn user in case of 'circular_buffer_size' is not set */
952 av_log(h, AV_LOG_WARNING,"'bitrate' option was set but 'circular_buffer_size' is not, but required\n");
955 if ((!is_output && s->circular_buffer_size) || (is_output && s->bitrate && s->circular_buffer_size)) {
958 /* start the task going */
959 s->fifo = av_fifo_alloc(s->circular_buffer_size);
960 ret = pthread_mutex_init(&s->mutex, NULL);
962 av_log(h, AV_LOG_ERROR, "pthread_mutex_init failed : %s\n", strerror(ret));
965 ret = pthread_cond_init(&s->cond, NULL);
967 av_log(h, AV_LOG_ERROR, "pthread_cond_init failed : %s\n", strerror(ret));
970 ret = pthread_create(&s->circular_buffer_thread, NULL, is_output?circular_buffer_task_tx:circular_buffer_task_rx, h);
972 av_log(h, AV_LOG_ERROR, "pthread_create failed : %s\n", strerror(ret));
975 s->thread_started = 1;
980 #if HAVE_PTHREAD_CANCEL
982 pthread_cond_destroy(&s->cond);
984 pthread_mutex_destroy(&s->mutex);
989 av_fifo_freep(&s->fifo);
990 for (i = 0; i < num_include_sources; i++)
991 av_freep(&include_sources[i]);
992 for (i = 0; i < num_exclude_sources; i++)
993 av_freep(&exclude_sources[i]);
997 static int udplite_open(URLContext *h, const char *uri, int flags)
999 UDPContext *s = h->priv_data;
1001 // set default checksum coverage
1002 s->udplite_coverage = UDP_HEADER_SIZE;
1004 return udp_open(h, uri, flags);
1007 static int udp_read(URLContext *h, uint8_t *buf, int size)
1009 UDPContext *s = h->priv_data;
1011 #if HAVE_PTHREAD_CANCEL
1012 int avail, nonblock = h->flags & AVIO_FLAG_NONBLOCK;
1015 pthread_mutex_lock(&s->mutex);
1017 avail = av_fifo_size(s->fifo);
1018 if (avail) { // >=size) {
1021 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
1022 avail= AV_RL32(tmp);
1024 av_log(h, AV_LOG_WARNING, "Part of datagram lost due to insufficient buffer size\n");
1028 av_fifo_generic_read(s->fifo, buf, avail, NULL);
1029 av_fifo_drain(s->fifo, AV_RL32(tmp) - avail);
1030 pthread_mutex_unlock(&s->mutex);
1032 } else if(s->circular_buffer_error){
1033 int err = s->circular_buffer_error;
1034 pthread_mutex_unlock(&s->mutex);
1036 } else if(nonblock) {
1037 pthread_mutex_unlock(&s->mutex);
1038 return AVERROR(EAGAIN);
1041 /* FIXME: using the monotonic clock would be better,
1042 but it does not exist on all supported platforms. */
1043 int64_t t = av_gettime() + 100000;
1044 struct timespec tv = { .tv_sec = t / 1000000,
1045 .tv_nsec = (t % 1000000) * 1000 };
1046 if (pthread_cond_timedwait(&s->cond, &s->mutex, &tv) < 0) {
1047 pthread_mutex_unlock(&s->mutex);
1048 return AVERROR(errno == ETIMEDOUT ? EAGAIN : errno);
1056 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1057 ret = ff_network_wait_fd(s->udp_fd, 0);
1061 ret = recv(s->udp_fd, buf, size, 0);
1063 return ret < 0 ? ff_neterrno() : ret;
1066 static int udp_write(URLContext *h, const uint8_t *buf, int size)
1068 UDPContext *s = h->priv_data;
1071 #if HAVE_PTHREAD_CANCEL
1075 pthread_mutex_lock(&s->mutex);
1078 Return error if last tx failed.
1079 Here we can't know on which packet error was, but it needs to know that error exists.
1081 if (s->circular_buffer_error<0) {
1082 int err=s->circular_buffer_error;
1083 pthread_mutex_unlock(&s->mutex);
1087 if(av_fifo_space(s->fifo) < size + 4) {
1088 /* What about a partial packet tx ? */
1089 pthread_mutex_unlock(&s->mutex);
1090 return AVERROR(ENOMEM);
1093 av_fifo_generic_write(s->fifo, tmp, 4, NULL); /* size of packet */
1094 av_fifo_generic_write(s->fifo, (uint8_t *)buf, size, NULL); /* the data */
1095 pthread_cond_signal(&s->cond);
1096 pthread_mutex_unlock(&s->mutex);
1100 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1101 ret = ff_network_wait_fd(s->udp_fd, 1);
1106 if (!s->is_connected) {
1107 ret = sendto (s->udp_fd, buf, size, 0,
1108 (struct sockaddr *) &s->dest_addr,
1111 ret = send(s->udp_fd, buf, size, 0);
1113 return ret < 0 ? ff_neterrno() : ret;
1116 static int udp_close(URLContext *h)
1118 UDPContext *s = h->priv_data;
1120 #if HAVE_PTHREAD_CANCEL
1121 // Request close once writing is finished
1122 if (s->thread_started && !(h->flags & AVIO_FLAG_READ)) {
1123 pthread_mutex_lock(&s->mutex);
1125 pthread_cond_signal(&s->cond);
1126 pthread_mutex_unlock(&s->mutex);
1130 if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
1131 udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage);
1132 #if HAVE_PTHREAD_CANCEL
1133 if (s->thread_started) {
1135 // Cancel only read, as write has been signaled as success to the user
1136 if (h->flags & AVIO_FLAG_READ)
1137 pthread_cancel(s->circular_buffer_thread);
1138 ret = pthread_join(s->circular_buffer_thread, NULL);
1140 av_log(h, AV_LOG_ERROR, "pthread_join(): %s\n", strerror(ret));
1141 pthread_mutex_destroy(&s->mutex);
1142 pthread_cond_destroy(&s->cond);
1145 closesocket(s->udp_fd);
1146 av_fifo_freep(&s->fifo);
1150 const URLProtocol ff_udp_protocol = {
1152 .url_open = udp_open,
1153 .url_read = udp_read,
1154 .url_write = udp_write,
1155 .url_close = udp_close,
1156 .url_get_file_handle = udp_get_file_handle,
1157 .priv_data_size = sizeof(UDPContext),
1158 .priv_data_class = &udp_class,
1159 .flags = URL_PROTOCOL_FLAG_NETWORK,
1162 const URLProtocol ff_udplite_protocol = {
1164 .url_open = udplite_open,
1165 .url_read = udp_read,
1166 .url_write = udp_write,
1167 .url_close = udp_close,
1168 .url_get_file_handle = udp_get_file_handle,
1169 .priv_data_size = sizeof(UDPContext),
1170 .priv_data_class = &udplite_context_class,
1171 .flags = URL_PROTOCOL_FLAG_NETWORK,