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 HAVE_PTHREAD_CANCEL
68 #define HAVE_PTHREAD_CANCEL 0
71 #ifndef IPV6_ADD_MEMBERSHIP
72 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
73 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
76 #define UDP_TX_BUF_SIZE 32768
77 #define UDP_MAX_PKT_SIZE 65536
78 #define UDP_HEADER_SIZE 8
80 typedef struct UDPContext {
92 struct sockaddr_storage dest_addr;
96 /* Circular Buffer variables for use in UDP receive code */
97 int circular_buffer_size;
99 int circular_buffer_error;
100 int64_t bitrate; /* number of bits to send per second */
103 #if HAVE_PTHREAD_CANCEL
104 pthread_t circular_buffer_thread;
105 pthread_mutex_t mutex;
109 uint8_t tmp[UDP_MAX_PKT_SIZE+4];
113 struct sockaddr_storage local_addr_storage;
118 #define OFFSET(x) offsetof(UDPContext, x)
119 #define D AV_OPT_FLAG_DECODING_PARAM
120 #define E AV_OPT_FLAG_ENCODING_PARAM
121 static const AVOption options[] = {
122 { "buffer_size", "System data size (in bytes)", OFFSET(buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
123 { "bitrate", "Bits to send per second", OFFSET(bitrate), AV_OPT_TYPE_INT64, { .i64 = 0 }, 0, INT64_MAX, .flags = E },
124 { "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 },
125 { "localport", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, D|E },
126 { "local_port", "Local port", OFFSET(local_port), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
127 { "localaddr", "Local address", OFFSET(localaddr), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
128 { "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 },
129 { "pkt_size", "Maximum UDP packet size", OFFSET(pkt_size), AV_OPT_TYPE_INT, { .i64 = 1472 }, -1, INT_MAX, .flags = D|E },
130 { "reuse", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, D|E },
131 { "reuse_socket", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, .flags = D|E },
132 { "broadcast", "explicitly allow or disallow broadcast destination", OFFSET(is_broadcast), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, E },
133 { "ttl", "Time to live (multicast only)", OFFSET(ttl), AV_OPT_TYPE_INT, { .i64 = 16 }, 0, INT_MAX, E },
134 { "connect", "set if connect() should be called on socket", OFFSET(is_connected), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, .flags = D|E },
135 { "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 },
136 { "overrun_nonfatal", "survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, D },
137 { "timeout", "set raise error timeout (only in read mode)", OFFSET(timeout), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, D },
138 { "sources", "Source list", OFFSET(sources), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
139 { "block", "Block list", OFFSET(block), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
143 static const AVClass udp_class = {
145 .item_name = av_default_item_name,
147 .version = LIBAVUTIL_VERSION_INT,
150 static const AVClass udplite_context_class = {
151 .class_name = "udplite",
152 .item_name = av_default_item_name,
154 .version = LIBAVUTIL_VERSION_INT,
157 static void log_net_error(void *ctx, int level, const char* prefix)
160 av_strerror(ff_neterrno(), errbuf, sizeof(errbuf));
161 av_log(ctx, level, "%s: %s\n", prefix, errbuf);
164 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
165 struct sockaddr *addr)
167 #ifdef IP_MULTICAST_TTL
168 if (addr->sa_family == AF_INET) {
169 if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
170 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL)");
175 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
176 if (addr->sa_family == AF_INET6) {
177 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
178 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS)");
186 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
188 #ifdef IP_ADD_MEMBERSHIP
189 if (addr->sa_family == AF_INET) {
192 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
194 mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
196 mreq.imr_interface.s_addr= INADDR_ANY;
197 if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
198 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP)");
203 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
204 if (addr->sa_family == AF_INET6) {
205 struct ipv6_mreq mreq6;
207 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
208 mreq6.ipv6mr_interface= 0;
209 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
210 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP)");
218 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
220 #ifdef IP_DROP_MEMBERSHIP
221 if (addr->sa_family == AF_INET) {
224 mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
226 mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
228 mreq.imr_interface.s_addr= INADDR_ANY;
229 if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
230 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP)");
235 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
236 if (addr->sa_family == AF_INET6) {
237 struct ipv6_mreq mreq6;
239 memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
240 mreq6.ipv6mr_interface= 0;
241 if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
242 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP)");
250 static struct addrinfo *udp_resolve_host(URLContext *h,
251 const char *hostname, int port,
252 int type, int family, int flags)
254 struct addrinfo hints = { 0 }, *res = 0;
257 const char *node = 0, *service = "0";
260 snprintf(sport, sizeof(sport), "%d", port);
263 if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
266 hints.ai_socktype = type;
267 hints.ai_family = family;
268 hints.ai_flags = flags;
269 if ((error = getaddrinfo(node, service, &hints, &res))) {
271 av_log(h, AV_LOG_ERROR, "getaddrinfo(%s, %s): %s\n",
272 node ? node : "unknown",
274 gai_strerror(error));
280 static int udp_set_multicast_sources(URLContext *h,
281 int sockfd, struct sockaddr *addr,
282 int addr_len, char **sources,
283 int nb_sources, int include)
285 #if HAVE_STRUCT_GROUP_SOURCE_REQ && defined(MCAST_BLOCK_SOURCE) && !defined(_WIN32) && (!defined(TARGET_OS_TV) || !TARGET_OS_TV)
286 /* These ones are available in the microsoft SDK, but don't seem to work
287 * as on linux, so just prefer the v4-only approach there for now. */
289 for (i = 0; i < nb_sources; i++) {
290 struct group_source_req mreqs;
291 int level = addr->sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
292 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
293 SOCK_DGRAM, AF_UNSPEC,
296 return AVERROR(ENOENT);
298 mreqs.gsr_interface = 0;
299 memcpy(&mreqs.gsr_group, addr, addr_len);
300 memcpy(&mreqs.gsr_source, sourceaddr->ai_addr, sourceaddr->ai_addrlen);
301 freeaddrinfo(sourceaddr);
303 if (setsockopt(sockfd, level,
304 include ? MCAST_JOIN_SOURCE_GROUP : MCAST_BLOCK_SOURCE,
305 (const void *)&mreqs, sizeof(mreqs)) < 0) {
307 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_JOIN_SOURCE_GROUP)");
309 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_BLOCK_SOURCE)");
310 return ff_neterrno();
313 #elif HAVE_STRUCT_IP_MREQ_SOURCE && defined(IP_BLOCK_SOURCE)
315 if (addr->sa_family != AF_INET) {
316 av_log(NULL, AV_LOG_ERROR,
317 "Setting multicast sources only supported for IPv4\n");
318 return AVERROR(EINVAL);
320 for (i = 0; i < nb_sources; i++) {
321 struct ip_mreq_source mreqs;
322 struct addrinfo *sourceaddr = udp_resolve_host(h, sources[i], 0,
323 SOCK_DGRAM, AF_UNSPEC,
326 return AVERROR(ENOENT);
327 if (sourceaddr->ai_addr->sa_family != AF_INET) {
328 freeaddrinfo(sourceaddr);
329 av_log(NULL, AV_LOG_ERROR, "%s is of incorrect protocol family\n",
331 return AVERROR(EINVAL);
334 mreqs.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
335 mreqs.imr_interface.s_addr = INADDR_ANY;
336 mreqs.imr_sourceaddr.s_addr = ((struct sockaddr_in *)sourceaddr->ai_addr)->sin_addr.s_addr;
337 freeaddrinfo(sourceaddr);
339 if (setsockopt(sockfd, IPPROTO_IP,
340 include ? IP_ADD_SOURCE_MEMBERSHIP : IP_BLOCK_SOURCE,
341 (const void *)&mreqs, sizeof(mreqs)) < 0) {
343 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_SOURCE_MEMBERSHIP)");
345 log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_BLOCK_SOURCE)");
346 return ff_neterrno();
350 return AVERROR(ENOSYS);
354 static int udp_set_url(URLContext *h,
355 struct sockaddr_storage *addr,
356 const char *hostname, int port)
358 struct addrinfo *res0;
361 res0 = udp_resolve_host(h, hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
362 if (!res0) return AVERROR(EIO);
363 memcpy(addr, res0->ai_addr, res0->ai_addrlen);
364 addr_len = res0->ai_addrlen;
370 static int udp_socket_create(URLContext *h, struct sockaddr_storage *addr,
371 socklen_t *addr_len, const char *localaddr)
373 UDPContext *s = h->priv_data;
375 struct addrinfo *res0, *res;
376 int family = AF_UNSPEC;
378 if (((struct sockaddr *) &s->dest_addr)->sa_family)
379 family = ((struct sockaddr *) &s->dest_addr)->sa_family;
380 res0 = udp_resolve_host(h, (localaddr && localaddr[0]) ? localaddr : NULL,
382 SOCK_DGRAM, family, AI_PASSIVE);
385 for (res = res0; res; res=res->ai_next) {
386 if (s->udplite_coverage)
387 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, IPPROTO_UDPLITE);
389 udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, 0);
390 if (udp_fd != -1) break;
391 log_net_error(NULL, AV_LOG_ERROR, "socket");
397 memcpy(addr, res->ai_addr, res->ai_addrlen);
398 *addr_len = res->ai_addrlen;
412 static int udp_port(struct sockaddr_storage *addr, int addr_len)
414 char sbuf[sizeof(int)*3+1];
417 if ((error = getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0, sbuf, sizeof(sbuf), NI_NUMERICSERV)) != 0) {
418 av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", gai_strerror(error));
422 return strtol(sbuf, NULL, 10);
427 * If no filename is given to av_open_input_file because you want to
428 * get the local port first, then you must call this function to set
429 * the remote server address.
431 * url syntax: udp://host:port[?option=val...]
432 * option: 'ttl=n' : set the ttl value (for multicast only)
433 * 'localport=n' : set the local port
434 * 'pkt_size=n' : set max packet size
435 * 'reuse=1' : enable reusing the socket
436 * 'overrun_nonfatal=1': survive in case of circular buffer overrun
438 * @param h media file context
439 * @param uri of the remote server
440 * @return zero if no error.
442 int ff_udp_set_remote_url(URLContext *h, const char *uri)
444 UDPContext *s = h->priv_data;
445 char hostname[256], buf[10];
449 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
451 /* set the destination address */
452 s->dest_addr_len = udp_set_url(h, &s->dest_addr, hostname, port);
453 if (s->dest_addr_len < 0) {
456 s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
457 p = strchr(uri, '?');
459 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
460 int was_connected = s->is_connected;
461 s->is_connected = strtol(buf, NULL, 10);
462 if (s->is_connected && !was_connected) {
463 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
466 log_net_error(h, AV_LOG_ERROR, "connect");
477 * Return the local port used by the UDP connection
478 * @param h media file context
479 * @return the local port number
481 int ff_udp_get_local_port(URLContext *h)
483 UDPContext *s = h->priv_data;
484 return s->local_port;
488 * Return the udp file handle for select() usage to wait for several RTP
489 * streams at the same time.
490 * @param h media file context
492 static int udp_get_file_handle(URLContext *h)
494 UDPContext *s = h->priv_data;
498 #if HAVE_PTHREAD_CANCEL
499 static void *circular_buffer_task_rx( void *_URLContext)
501 URLContext *h = _URLContext;
502 UDPContext *s = h->priv_data;
505 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
506 pthread_mutex_lock(&s->mutex);
507 if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
508 av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
509 s->circular_buffer_error = AVERROR(EIO);
515 pthread_mutex_unlock(&s->mutex);
516 /* Blocking operations are always cancellation points;
517 see "General Information" / "Thread Cancelation Overview"
519 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
520 len = recv(s->udp_fd, s->tmp+4, sizeof(s->tmp)-4, 0);
521 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
522 pthread_mutex_lock(&s->mutex);
524 if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
525 s->circular_buffer_error = ff_neterrno();
530 AV_WL32(s->tmp, len);
532 if(av_fifo_space(s->fifo) < len + 4) {
534 if (s->overrun_nonfatal) {
535 av_log(h, AV_LOG_WARNING, "Circular buffer overrun. "
536 "Surviving due to overrun_nonfatal option\n");
539 av_log(h, AV_LOG_ERROR, "Circular buffer overrun. "
540 "To avoid, increase fifo_size URL option. "
541 "To survive in such case, use overrun_nonfatal option\n");
542 s->circular_buffer_error = AVERROR(EIO);
546 av_fifo_generic_write(s->fifo, s->tmp, len+4, NULL);
547 pthread_cond_signal(&s->cond);
551 pthread_cond_signal(&s->cond);
552 pthread_mutex_unlock(&s->mutex);
556 static void *circular_buffer_task_tx( void *_URLContext)
558 URLContext *h = _URLContext;
559 UDPContext *s = h->priv_data;
561 int64_t target_timestamp = av_gettime_relative();
562 int64_t start_timestamp = av_gettime_relative();
563 int64_t sent_bits = 0;
564 int64_t burst_interval = s->bitrate ? (s->burst_bits * 1000000 / s->bitrate) : 0;
565 int64_t max_delay = s->bitrate ? ((int64_t)h->max_packet_size * 8 * 1000000 / s->bitrate + 1) : 0;
567 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
568 pthread_mutex_lock(&s->mutex);
570 if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
571 av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
572 s->circular_buffer_error = AVERROR(EIO);
582 len=av_fifo_size(s->fifo);
587 if (pthread_cond_wait(&s->cond, &s->mutex) < 0) {
590 len=av_fifo_size(s->fifo);
593 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
596 av_assert0(len >= 0);
597 av_assert0(len <= sizeof(s->tmp));
599 av_fifo_generic_read(s->fifo, s->tmp, len, NULL);
601 pthread_mutex_unlock(&s->mutex);
602 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
605 timestamp = av_gettime_relative();
606 if (timestamp < target_timestamp) {
607 int64_t delay = target_timestamp - timestamp;
608 if (delay > max_delay) {
610 start_timestamp = timestamp + delay;
615 if (timestamp - burst_interval > target_timestamp) {
616 start_timestamp = timestamp - burst_interval;
620 sent_bits += len * 8;
621 target_timestamp = start_timestamp + sent_bits * 1000000 / s->bitrate;
628 if (!s->is_connected) {
629 ret = sendto (s->udp_fd, p, len, 0,
630 (struct sockaddr *) &s->dest_addr,
633 ret = send(s->udp_fd, p, len, 0);
639 if (ret != AVERROR(EAGAIN) && ret != AVERROR(EINTR)) {
640 pthread_mutex_lock(&s->mutex);
641 s->circular_buffer_error = ret;
642 pthread_mutex_unlock(&s->mutex);
648 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
649 pthread_mutex_lock(&s->mutex);
653 pthread_mutex_unlock(&s->mutex);
660 static int parse_source_list(char *buf, char **sources, int *num_sources,
667 char *next = strchr(source_start, ',');
670 sources[*num_sources] = av_strdup(source_start);
671 if (!sources[*num_sources])
672 return AVERROR(ENOMEM);
673 source_start = next + 1;
675 if (*num_sources >= max_sources || !next)
681 /* put it in UDP context */
682 /* return non zero if error */
683 static int udp_open(URLContext *h, const char *uri, int flags)
685 char hostname[1024], localaddr[1024] = "";
686 int port, udp_fd = -1, tmp, bind_ret = -1, dscp = -1;
687 UDPContext *s = h->priv_data;
691 struct sockaddr_storage my_addr;
693 int i, num_include_sources = 0, num_exclude_sources = 0;
694 char *include_sources[32], *exclude_sources[32];
698 is_output = !(flags & AVIO_FLAG_READ);
699 if (s->buffer_size < 0)
700 s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
703 if (parse_source_list(s->sources, include_sources,
704 &num_include_sources,
705 FF_ARRAY_ELEMS(include_sources)))
710 if (parse_source_list(s->block, exclude_sources, &num_exclude_sources,
711 FF_ARRAY_ELEMS(exclude_sources)))
716 h->max_packet_size = s->pkt_size;
718 p = strchr(uri, '?');
720 if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
722 s->reuse_socket = strtol(buf, &endptr, 10);
723 /* assume if no digits were found it is a request to enable it */
727 if (av_find_info_tag(buf, sizeof(buf), "overrun_nonfatal", p)) {
729 s->overrun_nonfatal = strtol(buf, &endptr, 10);
730 /* assume if no digits were found it is a request to enable it */
732 s->overrun_nonfatal = 1;
733 if (!HAVE_PTHREAD_CANCEL)
734 av_log(h, AV_LOG_WARNING,
735 "'overrun_nonfatal' option was set but it is not supported "
736 "on this build (pthread support is required)\n");
738 if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
739 s->ttl = strtol(buf, NULL, 10);
741 if (av_find_info_tag(buf, sizeof(buf), "udplite_coverage", p)) {
742 s->udplite_coverage = strtol(buf, NULL, 10);
744 if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
745 s->local_port = strtol(buf, NULL, 10);
747 if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
748 s->pkt_size = strtol(buf, NULL, 10);
750 if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
751 s->buffer_size = strtol(buf, NULL, 10);
753 if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
754 s->is_connected = strtol(buf, NULL, 10);
756 if (av_find_info_tag(buf, sizeof(buf), "dscp", p)) {
757 dscp = strtol(buf, NULL, 10);
759 if (av_find_info_tag(buf, sizeof(buf), "fifo_size", p)) {
760 s->circular_buffer_size = strtol(buf, NULL, 10);
761 if (!HAVE_PTHREAD_CANCEL)
762 av_log(h, AV_LOG_WARNING,
763 "'circular_buffer_size' option was set but it is not supported "
764 "on this build (pthread support is required)\n");
766 if (av_find_info_tag(buf, sizeof(buf), "bitrate", p)) {
767 s->bitrate = strtoll(buf, NULL, 10);
768 if (!HAVE_PTHREAD_CANCEL)
769 av_log(h, AV_LOG_WARNING,
770 "'bitrate' option was set but it is not supported "
771 "on this build (pthread support is required)\n");
773 if (av_find_info_tag(buf, sizeof(buf), "burst_bits", p)) {
774 s->burst_bits = strtoll(buf, NULL, 10);
776 if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
777 av_strlcpy(localaddr, buf, sizeof(localaddr));
779 if (av_find_info_tag(buf, sizeof(buf), "sources", p)) {
780 if (parse_source_list(buf, include_sources, &num_include_sources,
781 FF_ARRAY_ELEMS(include_sources)))
784 if (av_find_info_tag(buf, sizeof(buf), "block", p)) {
785 if (parse_source_list(buf, exclude_sources, &num_exclude_sources,
786 FF_ARRAY_ELEMS(exclude_sources)))
789 if (!is_output && av_find_info_tag(buf, sizeof(buf), "timeout", p))
790 s->timeout = strtol(buf, NULL, 10);
791 if (is_output && av_find_info_tag(buf, sizeof(buf), "broadcast", p))
792 s->is_broadcast = strtol(buf, NULL, 10);
794 /* handling needed to support options picking from both AVOption and URL */
795 s->circular_buffer_size *= 188;
796 if (flags & AVIO_FLAG_WRITE) {
797 h->max_packet_size = s->pkt_size;
799 h->max_packet_size = UDP_MAX_PKT_SIZE;
801 h->rw_timeout = s->timeout;
803 /* fill the dest addr */
804 av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
806 /* XXX: fix av_url_split */
807 if (hostname[0] == '\0' || hostname[0] == '?') {
808 /* only accepts null hostname if input */
809 if (!(flags & AVIO_FLAG_READ))
812 if (ff_udp_set_remote_url(h, uri) < 0)
816 if ((s->is_multicast || s->local_port <= 0) && (h->flags & AVIO_FLAG_READ))
817 s->local_port = port;
820 udp_fd = udp_socket_create(h, &my_addr, &len, localaddr);
822 udp_fd = udp_socket_create(h, &my_addr, &len, s->localaddr);
826 s->local_addr_storage=my_addr; //store for future multicast join
828 /* Follow the requested reuse option, unless it's multicast in which
829 * case enable reuse unless explicitly disabled.
831 if (s->reuse_socket > 0 || (s->is_multicast && s->reuse_socket < 0)) {
833 if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
837 if (s->is_broadcast) {
839 if (setsockopt (udp_fd, SOL_SOCKET, SO_BROADCAST, &(s->is_broadcast), sizeof(s->is_broadcast)) != 0)
844 /* Set the checksum coverage for UDP-Lite (RFC 3828) for sending and receiving.
845 * The receiver coverage has to be less than or equal to the sender coverage.
846 * Otherwise, the receiver will drop all packets.
848 if (s->udplite_coverage) {
849 if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
850 av_log(h, AV_LOG_WARNING, "socket option UDPLITE_SEND_CSCOV not available");
852 if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
853 av_log(h, AV_LOG_WARNING, "socket option UDPLITE_RECV_CSCOV not available");
858 if (setsockopt (udp_fd, IPPROTO_IP, IP_TOS, &dscp, sizeof(dscp)) != 0)
862 /* If multicast, try binding the multicast address first, to avoid
863 * receiving UDP packets from other sources aimed at the same UDP
864 * port. This fails on windows. This makes sending to the same address
865 * using sendto() fail, so only do it if we're opened in read-only mode. */
866 if (s->is_multicast && !(h->flags & AVIO_FLAG_WRITE)) {
867 bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
869 /* bind to the local address if not multicast or if the multicast
871 /* the bind is needed to give a port to the socket now */
872 if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0) {
873 log_net_error(h, AV_LOG_ERROR, "bind failed");
877 len = sizeof(my_addr);
878 getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
879 s->local_port = udp_port(&my_addr, len);
881 if (s->is_multicast) {
882 if (h->flags & AVIO_FLAG_WRITE) {
884 if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
887 if (h->flags & AVIO_FLAG_READ) {
889 if (num_include_sources && num_exclude_sources) {
890 av_log(h, AV_LOG_ERROR, "Simultaneously including and excluding multicast sources is not supported\n");
893 if (num_include_sources) {
894 if (udp_set_multicast_sources(h, udp_fd,
895 (struct sockaddr *)&s->dest_addr,
898 num_include_sources, 1) < 0)
901 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage) < 0)
904 if (num_exclude_sources) {
905 if (udp_set_multicast_sources(h, udp_fd,
906 (struct sockaddr *)&s->dest_addr,
909 num_exclude_sources, 0) < 0)
916 /* limit the tx buf size to limit latency */
917 tmp = s->buffer_size;
918 if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
919 log_net_error(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF)");
923 /* set udp recv buffer size to the requested value (default 64K) */
924 tmp = s->buffer_size;
925 if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
926 log_net_error(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF)");
929 if (getsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, &len) < 0) {
930 log_net_error(h, AV_LOG_WARNING, "getsockopt(SO_RCVBUF)");
932 av_log(h, AV_LOG_DEBUG, "end receive buffer size reported is %d\n", tmp);
933 if(tmp < s->buffer_size)
934 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);
937 /* make the socket non-blocking */
938 ff_socket_nonblock(udp_fd, 1);
940 if (s->is_connected) {
941 if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
942 log_net_error(h, AV_LOG_ERROR, "connect");
947 for (i = 0; i < num_include_sources; i++)
948 av_freep(&include_sources[i]);
949 for (i = 0; i < num_exclude_sources; i++)
950 av_freep(&exclude_sources[i]);
954 #if HAVE_PTHREAD_CANCEL
956 Create thread in case of:
957 1. Input and circular_buffer_size is set
958 2. Output and bitrate and circular_buffer_size is set
961 if (is_output && s->bitrate && !s->circular_buffer_size) {
962 /* Warn user in case of 'circular_buffer_size' is not set */
963 av_log(h, AV_LOG_WARNING,"'bitrate' option was set but 'circular_buffer_size' is not, but required\n");
966 if ((!is_output && s->circular_buffer_size) || (is_output && s->bitrate && s->circular_buffer_size)) {
969 /* start the task going */
970 s->fifo = av_fifo_alloc(s->circular_buffer_size);
971 ret = pthread_mutex_init(&s->mutex, NULL);
973 av_log(h, AV_LOG_ERROR, "pthread_mutex_init failed : %s\n", strerror(ret));
976 ret = pthread_cond_init(&s->cond, NULL);
978 av_log(h, AV_LOG_ERROR, "pthread_cond_init failed : %s\n", strerror(ret));
981 ret = pthread_create(&s->circular_buffer_thread, NULL, is_output?circular_buffer_task_tx:circular_buffer_task_rx, h);
983 av_log(h, AV_LOG_ERROR, "pthread_create failed : %s\n", strerror(ret));
986 s->thread_started = 1;
991 #if HAVE_PTHREAD_CANCEL
993 pthread_cond_destroy(&s->cond);
995 pthread_mutex_destroy(&s->mutex);
1000 av_fifo_freep(&s->fifo);
1001 for (i = 0; i < num_include_sources; i++)
1002 av_freep(&include_sources[i]);
1003 for (i = 0; i < num_exclude_sources; i++)
1004 av_freep(&exclude_sources[i]);
1005 return AVERROR(EIO);
1008 static int udplite_open(URLContext *h, const char *uri, int flags)
1010 UDPContext *s = h->priv_data;
1012 // set default checksum coverage
1013 s->udplite_coverage = UDP_HEADER_SIZE;
1015 return udp_open(h, uri, flags);
1018 static int udp_read(URLContext *h, uint8_t *buf, int size)
1020 UDPContext *s = h->priv_data;
1022 #if HAVE_PTHREAD_CANCEL
1023 int avail, nonblock = h->flags & AVIO_FLAG_NONBLOCK;
1026 pthread_mutex_lock(&s->mutex);
1028 avail = av_fifo_size(s->fifo);
1029 if (avail) { // >=size) {
1032 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
1033 avail= AV_RL32(tmp);
1035 av_log(h, AV_LOG_WARNING, "Part of datagram lost due to insufficient buffer size\n");
1039 av_fifo_generic_read(s->fifo, buf, avail, NULL);
1040 av_fifo_drain(s->fifo, AV_RL32(tmp) - avail);
1041 pthread_mutex_unlock(&s->mutex);
1043 } else if(s->circular_buffer_error){
1044 int err = s->circular_buffer_error;
1045 pthread_mutex_unlock(&s->mutex);
1047 } else if(nonblock) {
1048 pthread_mutex_unlock(&s->mutex);
1049 return AVERROR(EAGAIN);
1052 /* FIXME: using the monotonic clock would be better,
1053 but it does not exist on all supported platforms. */
1054 int64_t t = av_gettime() + 100000;
1055 struct timespec tv = { .tv_sec = t / 1000000,
1056 .tv_nsec = (t % 1000000) * 1000 };
1057 if (pthread_cond_timedwait(&s->cond, &s->mutex, &tv) < 0) {
1058 pthread_mutex_unlock(&s->mutex);
1059 return AVERROR(errno == ETIMEDOUT ? EAGAIN : errno);
1067 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1068 ret = ff_network_wait_fd(s->udp_fd, 0);
1072 ret = recv(s->udp_fd, buf, size, 0);
1074 return ret < 0 ? ff_neterrno() : ret;
1077 static int udp_write(URLContext *h, const uint8_t *buf, int size)
1079 UDPContext *s = h->priv_data;
1082 #if HAVE_PTHREAD_CANCEL
1086 pthread_mutex_lock(&s->mutex);
1089 Return error if last tx failed.
1090 Here we can't know on which packet error was, but it needs to know that error exists.
1092 if (s->circular_buffer_error<0) {
1093 int err=s->circular_buffer_error;
1094 pthread_mutex_unlock(&s->mutex);
1098 if(av_fifo_space(s->fifo) < size + 4) {
1099 /* What about a partial packet tx ? */
1100 pthread_mutex_unlock(&s->mutex);
1101 return AVERROR(ENOMEM);
1104 av_fifo_generic_write(s->fifo, tmp, 4, NULL); /* size of packet */
1105 av_fifo_generic_write(s->fifo, (uint8_t *)buf, size, NULL); /* the data */
1106 pthread_cond_signal(&s->cond);
1107 pthread_mutex_unlock(&s->mutex);
1111 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1112 ret = ff_network_wait_fd(s->udp_fd, 1);
1117 if (!s->is_connected) {
1118 ret = sendto (s->udp_fd, buf, size, 0,
1119 (struct sockaddr *) &s->dest_addr,
1122 ret = send(s->udp_fd, buf, size, 0);
1124 return ret < 0 ? ff_neterrno() : ret;
1127 static int udp_close(URLContext *h)
1129 UDPContext *s = h->priv_data;
1131 #if HAVE_PTHREAD_CANCEL
1132 // Request close once writing is finished
1133 if (s->thread_started && !(h->flags & AVIO_FLAG_READ)) {
1134 pthread_mutex_lock(&s->mutex);
1136 pthread_cond_signal(&s->cond);
1137 pthread_mutex_unlock(&s->mutex);
1141 if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
1142 udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage);
1143 #if HAVE_PTHREAD_CANCEL
1144 if (s->thread_started) {
1146 // Cancel only read, as write has been signaled as success to the user
1147 if (h->flags & AVIO_FLAG_READ)
1148 pthread_cancel(s->circular_buffer_thread);
1149 ret = pthread_join(s->circular_buffer_thread, NULL);
1151 av_log(h, AV_LOG_ERROR, "pthread_join(): %s\n", strerror(ret));
1152 pthread_mutex_destroy(&s->mutex);
1153 pthread_cond_destroy(&s->cond);
1156 closesocket(s->udp_fd);
1157 av_fifo_freep(&s->fifo);
1161 const URLProtocol ff_udp_protocol = {
1163 .url_open = udp_open,
1164 .url_read = udp_read,
1165 .url_write = udp_write,
1166 .url_close = udp_close,
1167 .url_get_file_handle = udp_get_file_handle,
1168 .priv_data_size = sizeof(UDPContext),
1169 .priv_data_class = &udp_class,
1170 .flags = URL_PROTOCOL_FLAG_NETWORK,
1173 const URLProtocol ff_udplite_protocol = {
1175 .url_open = udplite_open,
1176 .url_read = udp_read,
1177 .url_write = udp_write,
1178 .url_close = udp_close,
1179 .url_get_file_handle = udp_get_file_handle,
1180 .priv_data_size = sizeof(UDPContext),
1181 .priv_data_class = &udplite_context_class,
1182 .flags = URL_PROTOCOL_FLAG_NETWORK,