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 "libavutil/avassert.h"
32 #include "libavutil/mem.h"
33 #include "libavutil/parseutils.h"
34 #include "libavutil/fifo.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/log.h"
38 #include "libavutil/time.h"
41 #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
64 #undef HAVE_PTHREAD_CANCEL
65 #define HAVE_PTHREAD_CANCEL 1
68 #if HAVE_PTHREAD_CANCEL
69 #include "libavutil/thread.h"
72 #ifndef IPV6_ADD_MEMBERSHIP
73 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
74 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
77 #define UDP_TX_BUF_SIZE 32768
78 #define UDP_RX_BUF_SIZE 393216
79 #define UDP_MAX_PKT_SIZE 65536
80 #define UDP_HEADER_SIZE 8
82 typedef struct UDPQueuedPacketHeader
{
84 struct sockaddr_storage addr
;
86 } UDPQueuedPacketHeader
;
88 typedef struct UDPContext
{
100 struct sockaddr_storage dest_addr
;
104 /* Circular Buffer variables for use in UDP receive code */
105 int circular_buffer_size
;
108 int circular_buffer_error
;
109 int64_t bitrate
; /* number of bits to send per second */
112 #if HAVE_PTHREAD_CANCEL
113 pthread_t circular_buffer_thread
;
114 pthread_mutex_t mutex
;
118 uint8_t tmp
[UDP_MAX_PKT_SIZE
+ sizeof(UDPQueuedPacketHeader
)];
123 struct sockaddr_storage local_addr_storage
;
126 IPSourceFilters filters
;
127 struct sockaddr_storage last_recv_addr
;
128 socklen_t last_recv_addr_len
;
131 #define OFFSET(x) offsetof(UDPContext, x)
132 #define D AV_OPT_FLAG_DECODING_PARAM
133 #define E AV_OPT_FLAG_ENCODING_PARAM
134 static const AVOption options
[] = {
135 { "buffer_size", "System data size (in bytes)", OFFSET(buffer_size
), AV_OPT_TYPE_INT
, { .i64
= -1 }, -1, INT_MAX
, .flags
= D
|E
},
136 { "bitrate", "Bits to send per second", OFFSET(bitrate
), AV_OPT_TYPE_INT64
, { .i64
= 0 }, 0, INT64_MAX
, .flags
= E
},
137 { "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
},
138 { "localport", "Local port", OFFSET(local_port
), AV_OPT_TYPE_INT
, { .i64
= -1 }, -1, INT_MAX
, D
|E
},
139 { "local_port", "Local port", OFFSET(local_port
), AV_OPT_TYPE_INT
, { .i64
= -1 }, -1, INT_MAX
, .flags
= D
|E
},
140 { "localaddr", "Local address", OFFSET(localaddr
), AV_OPT_TYPE_STRING
, { .str
= NULL
}, .flags
= D
|E
},
141 { "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
},
142 { "pkt_size", "Maximum UDP packet size", OFFSET(pkt_size
), AV_OPT_TYPE_INT
, { .i64
= 1472 }, -1, INT_MAX
, .flags
= D
|E
},
143 { "reuse", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket
), AV_OPT_TYPE_BOOL
, { .i64
= -1 }, -1, 1, D
|E
},
144 { "reuse_socket", "explicitly allow reusing UDP sockets", OFFSET(reuse_socket
), AV_OPT_TYPE_BOOL
, { .i64
= -1 }, -1, 1, .flags
= D
|E
},
145 { "broadcast", "explicitly allow or disallow broadcast destination", OFFSET(is_broadcast
), AV_OPT_TYPE_BOOL
, { .i64
= 0 }, 0, 1, E
},
146 { "ttl", "Time to live (multicast only)", OFFSET(ttl
), AV_OPT_TYPE_INT
, { .i64
= 16 }, 0, 255, E
},
147 { "dscp", "DSCP class for outgoing packets", OFFSET(dscp
), AV_OPT_TYPE_INT
, { .i64
= -1 }, -1, 63, E
},
148 { "connect", "set if connect() should be called on socket", OFFSET(is_connected
), AV_OPT_TYPE_BOOL
, { .i64
= 0 }, 0, 1, .flags
= D
|E
},
149 { "fifo_size", "set the UDP circular buffer size (in 188-byte packets)", OFFSET(circular_buffer_size
), AV_OPT_TYPE_INT
, {.i64
= HAVE_PTHREAD_CANCEL
? 7*4096 : 0}, 0, INT_MAX
, D
},
150 { "overrun_nonfatal", "survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal
), AV_OPT_TYPE_BOOL
, {.i64
= 0}, 0, 1, D
},
151 { "timeout", "set raise error timeout, in microseconds (only in read mode)",OFFSET(timeout
), AV_OPT_TYPE_INT
, {.i64
= 0}, 0, INT_MAX
, D
},
152 { "sources", "Source list", OFFSET(sources
), AV_OPT_TYPE_STRING
, { .str
= NULL
}, .flags
= D
|E
},
153 { "block", "Block list", OFFSET(block
), AV_OPT_TYPE_STRING
, { .str
= NULL
}, .flags
= D
|E
},
157 static const AVClass udp_class
= {
159 .item_name
= av_default_item_name
,
161 .version
= LIBAVUTIL_VERSION_INT
,
164 static const AVClass udplite_context_class
= {
165 .class_name
= "udplite",
166 .item_name
= av_default_item_name
,
168 .version
= LIBAVUTIL_VERSION_INT
,
171 static int udp_set_multicast_ttl(int sockfd
, int mcastTTL
,
172 struct sockaddr
*addr
,
177 /* There is some confusion in the world whether IP_MULTICAST_TTL
178 * takes a byte or an int as an argument.
179 * BSD seems to indicate byte so we are going with that and use
180 * int and fall back to byte to be safe */
181 switch (addr
->sa_family
) {
182 #ifdef IP_MULTICAST_TTL
184 protocol
= IPPROTO_IP
;
185 cmd
= IP_MULTICAST_TTL
;
188 #ifdef IPV6_MULTICAST_HOPS
190 protocol
= IPPROTO_IPV6
;
191 cmd
= IPV6_MULTICAST_HOPS
;
198 if (setsockopt(sockfd
, protocol
, cmd
, &mcastTTL
, sizeof(mcastTTL
)) < 0) {
199 /* BSD compatibility */
200 unsigned char ttl
= (unsigned char) mcastTTL
;
202 ff_log_net_error(logctx
, AV_LOG_DEBUG
, "setsockopt(IPV4/IPV6 MULTICAST TTL)");
203 if (setsockopt(sockfd
, protocol
, cmd
, &ttl
, sizeof(ttl
)) < 0) {
204 ff_log_net_error(logctx
, AV_LOG_ERROR
, "setsockopt(IPV4/IPV6 MULTICAST TTL)");
205 return ff_neterrno();
212 static int udp_join_multicast_group(int sockfd
, struct sockaddr
*addr
,
213 struct sockaddr
*local_addr
, void *logctx
)
215 #ifdef IP_ADD_MEMBERSHIP
216 if (addr
->sa_family
== AF_INET
) {
219 mreq
.imr_multiaddr
.s_addr
= ((struct sockaddr_in
*)addr
)->sin_addr
.s_addr
;
221 mreq
.imr_interface
= ((struct sockaddr_in
*)local_addr
)->sin_addr
;
223 mreq
.imr_interface
.s_addr
= INADDR_ANY
;
224 if (setsockopt(sockfd
, IPPROTO_IP
, IP_ADD_MEMBERSHIP
, (const void *)&mreq
, sizeof(mreq
)) < 0) {
225 ff_log_net_error(logctx
, AV_LOG_ERROR
, "setsockopt(IP_ADD_MEMBERSHIP)");
226 return ff_neterrno();
230 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
231 if (addr
->sa_family
== AF_INET6
) {
232 struct ipv6_mreq mreq6
;
234 memcpy(&mreq6
.ipv6mr_multiaddr
, &(((struct sockaddr_in6
*)addr
)->sin6_addr
), sizeof(struct in6_addr
));
235 //TODO: Interface index should be looked up from local_addr
236 mreq6
.ipv6mr_interface
= 0;
237 if (setsockopt(sockfd
, IPPROTO_IPV6
, IPV6_ADD_MEMBERSHIP
, &mreq6
, sizeof(mreq6
)) < 0) {
238 ff_log_net_error(logctx
, AV_LOG_ERROR
, "setsockopt(IPV6_ADD_MEMBERSHIP)");
239 return ff_neterrno();
246 static int udp_leave_multicast_group(int sockfd
, struct sockaddr
*addr
,
247 struct sockaddr
*local_addr
, void *logctx
)
249 #ifdef IP_DROP_MEMBERSHIP
250 if (addr
->sa_family
== AF_INET
) {
253 mreq
.imr_multiaddr
.s_addr
= ((struct sockaddr_in
*)addr
)->sin_addr
.s_addr
;
255 mreq
.imr_interface
= ((struct sockaddr_in
*)local_addr
)->sin_addr
;
257 mreq
.imr_interface
.s_addr
= INADDR_ANY
;
258 if (setsockopt(sockfd
, IPPROTO_IP
, IP_DROP_MEMBERSHIP
, (const void *)&mreq
, sizeof(mreq
)) < 0) {
259 ff_log_net_error(logctx
, AV_LOG_ERROR
, "setsockopt(IP_DROP_MEMBERSHIP)");
264 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
265 if (addr
->sa_family
== AF_INET6
) {
266 struct ipv6_mreq mreq6
;
268 memcpy(&mreq6
.ipv6mr_multiaddr
, &(((struct sockaddr_in6
*)addr
)->sin6_addr
), sizeof(struct in6_addr
));
269 //TODO: Interface index should be looked up from local_addr
270 mreq6
.ipv6mr_interface
= 0;
271 if (setsockopt(sockfd
, IPPROTO_IPV6
, IPV6_DROP_MEMBERSHIP
, &mreq6
, sizeof(mreq6
)) < 0) {
272 ff_log_net_error(logctx
, AV_LOG_ERROR
, "setsockopt(IPV6_DROP_MEMBERSHIP)");
280 static int udp_set_multicast_sources(URLContext
*h
,
281 int sockfd
, struct sockaddr
*addr
,
282 int addr_len
, struct sockaddr_storage
*local_addr
,
283 struct sockaddr_storage
*sources
,
284 int nb_sources
, int include
)
286 if (addr
->sa_family
!= AF_INET
) {
287 #if HAVE_STRUCT_GROUP_SOURCE_REQ && defined(MCAST_BLOCK_SOURCE)
288 /* For IPv4 prefer the old approach, as that alone works reliably on
289 * Windows and it also supports supplying the interface based on its
291 for (int i
= 0; i
< nb_sources
; i
++) {
292 struct group_source_req mreqs
;
293 int level
= addr
->sa_family
== AF_INET
? IPPROTO_IP
: IPPROTO_IPV6
;
295 //TODO: Interface index should be looked up from local_addr
296 mreqs
.gsr_interface
= 0;
297 memcpy(&mreqs
.gsr_group
, addr
, addr_len
);
298 memcpy(&mreqs
.gsr_source
, &sources
[i
], sizeof(*sources
));
300 if (setsockopt(sockfd
, level
,
301 include
? MCAST_JOIN_SOURCE_GROUP
: MCAST_BLOCK_SOURCE
,
302 (const void *)&mreqs
, sizeof(mreqs
)) < 0) {
304 ff_log_net_error(h
, AV_LOG_ERROR
, "setsockopt(MCAST_JOIN_SOURCE_GROUP)");
306 ff_log_net_error(h
, AV_LOG_ERROR
, "setsockopt(MCAST_BLOCK_SOURCE)");
307 return ff_neterrno();
312 av_log(h
, AV_LOG_ERROR
,
313 "Setting multicast sources only supported for IPv4\n");
314 return AVERROR(EINVAL
);
317 #if HAVE_STRUCT_IP_MREQ_SOURCE && defined(IP_BLOCK_SOURCE)
318 for (int i
= 0; i
< nb_sources
; i
++) {
319 struct ip_mreq_source mreqs
;
320 if (sources
[i
].ss_family
!= AF_INET
) {
321 av_log(h
, AV_LOG_ERROR
, "Source/block address %d is of incorrect protocol family\n", i
+ 1);
322 return AVERROR(EINVAL
);
325 mreqs
.imr_multiaddr
.s_addr
= ((struct sockaddr_in
*)addr
)->sin_addr
.s_addr
;
327 mreqs
.imr_interface
= ((struct sockaddr_in
*)local_addr
)->sin_addr
;
329 mreqs
.imr_interface
.s_addr
= INADDR_ANY
;
330 mreqs
.imr_sourceaddr
.s_addr
= ((struct sockaddr_in
*)&sources
[i
])->sin_addr
.s_addr
;
332 if (setsockopt(sockfd
, IPPROTO_IP
,
333 include
? IP_ADD_SOURCE_MEMBERSHIP
: IP_BLOCK_SOURCE
,
334 (const void *)&mreqs
, sizeof(mreqs
)) < 0) {
336 ff_log_net_error(h
, AV_LOG_ERROR
, "setsockopt(IP_ADD_SOURCE_MEMBERSHIP)");
338 ff_log_net_error(h
, AV_LOG_ERROR
, "setsockopt(IP_BLOCK_SOURCE)");
339 return ff_neterrno();
343 return AVERROR(ENOSYS
);
347 static int udp_set_url(URLContext
*h
,
348 struct sockaddr_storage
*addr
,
349 const char *hostname
, int port
)
351 struct addrinfo
*res0
;
354 res0
= ff_ip_resolve_host(h
, hostname
, port
, SOCK_DGRAM
, AF_UNSPEC
, 0);
355 if (!res0
) return AVERROR(EIO
);
356 memcpy(addr
, res0
->ai_addr
, res0
->ai_addrlen
);
357 addr_len
= res0
->ai_addrlen
;
363 static int udp_socket_create(URLContext
*h
, struct sockaddr_storage
*addr
,
364 socklen_t
*addr_len
, const char *localaddr
)
366 UDPContext
*s
= h
->priv_data
;
368 struct addrinfo
*res0
, *res
;
369 int family
= AF_UNSPEC
;
371 if (((struct sockaddr
*) &s
->dest_addr
)->sa_family
)
372 family
= ((struct sockaddr
*) &s
->dest_addr
)->sa_family
;
373 res0
= ff_ip_resolve_host(h
, (localaddr
&& localaddr
[0]) ? localaddr
: NULL
,
375 SOCK_DGRAM
, family
, AI_PASSIVE
);
378 for (res
= res0
; res
; res
=res
->ai_next
) {
379 if (s
->udplite_coverage
)
380 udp_fd
= ff_socket(res
->ai_family
, SOCK_DGRAM
, IPPROTO_UDPLITE
, h
);
382 udp_fd
= ff_socket(res
->ai_family
, SOCK_DGRAM
, 0, h
);
383 if (udp_fd
!= -1) break;
384 ff_log_net_error(h
, AV_LOG_ERROR
, "socket");
390 memcpy(addr
, res
->ai_addr
, res
->ai_addrlen
);
391 *addr_len
= res
->ai_addrlen
;
405 static int udp_port(struct sockaddr_storage
*addr
, int addr_len
)
407 char sbuf
[sizeof(int)*3+1];
410 if ((error
= getnameinfo((struct sockaddr
*)addr
, addr_len
, NULL
, 0, sbuf
, sizeof(sbuf
), NI_NUMERICSERV
)) != 0) {
411 av_log(NULL
, AV_LOG_ERROR
, "getnameinfo: %s\n", gai_strerror(error
));
415 return strtol(sbuf
, NULL
, 10);
420 * If no filename is given to av_open_input_file because you want to
421 * get the local port first, then you must call this function to set
422 * the remote server address.
424 * url syntax: udp://host:port[?option=val...]
425 * option: 'ttl=n' : set the ttl value (for multicast only)
426 * 'localport=n' : set the local port
427 * 'pkt_size=n' : set max packet size
428 * 'reuse=1' : enable reusing the socket
429 * 'overrun_nonfatal=1': survive in case of circular buffer overrun
431 * @param h media file context
432 * @param uri of the remote server
433 * @return zero if no error.
435 int ff_udp_set_remote_url(URLContext
*h
, const char *uri
)
437 UDPContext
*s
= h
->priv_data
;
438 char hostname
[256], buf
[10];
442 av_url_split(NULL
, 0, NULL
, 0, hostname
, sizeof(hostname
), &port
, NULL
, 0, uri
);
444 /* set the destination address */
445 s
->dest_addr_len
= udp_set_url(h
, &s
->dest_addr
, hostname
, port
);
446 if (s
->dest_addr_len
< 0) {
449 s
->is_multicast
= ff_is_multicast_address((struct sockaddr
*) &s
->dest_addr
);
450 p
= strchr(uri
, '?');
452 if (av_find_info_tag(buf
, sizeof(buf
), "connect", p
)) {
453 int was_connected
= s
->is_connected
;
454 s
->is_connected
= strtol(buf
, NULL
, 10);
455 if (s
->is_connected
&& !was_connected
) {
456 if (connect(s
->udp_fd
, (struct sockaddr
*) &s
->dest_addr
,
459 ff_log_net_error(h
, AV_LOG_ERROR
, "connect");
470 * This function is identical to ff_udp_set_remote_url, except that it takes a sockaddr directly.
472 int ff_udp_set_remote_addr(URLContext
*h
, const struct sockaddr
*dest_addr
, socklen_t dest_addr_len
, int do_connect
)
474 UDPContext
*s
= h
->priv_data
;
476 /* set the destination address */
477 if ((size_t)dest_addr_len
> sizeof(s
->dest_addr
))
479 s
->dest_addr_len
= dest_addr_len
;
480 memcpy(&s
->dest_addr
, dest_addr
, dest_addr_len
);
482 s
->is_multicast
= ff_is_multicast_address((struct sockaddr
*) &s
->dest_addr
);
483 if (do_connect
>= 0) {
484 int was_connected
= s
->is_connected
;
485 s
->is_connected
= do_connect
;
486 if (s
->is_connected
&& !was_connected
) {
487 if (connect(s
->udp_fd
, (struct sockaddr
*) &s
->dest_addr
,
490 ff_log_net_error(h
, AV_LOG_ERROR
, "connect");
500 * Return the local port used by the UDP connection
501 * @param h media file context
502 * @return the local port number
504 int ff_udp_get_local_port(URLContext
*h
)
506 UDPContext
*s
= h
->priv_data
;
507 return s
->local_port
;
510 void ff_udp_get_last_recv_addr(URLContext
*h
, struct sockaddr_storage
*addr
, socklen_t
*addr_len
)
512 UDPContext
*s
= h
->priv_data
;
513 *addr
= s
->last_recv_addr
;
514 *addr_len
= s
->last_recv_addr_len
;
518 * Return the udp file handle for select() usage to wait for several RTP
519 * streams at the same time.
520 * @param h media file context
522 static int udp_get_file_handle(URLContext
*h
)
524 UDPContext
*s
= h
->priv_data
;
528 #if HAVE_PTHREAD_CANCEL
529 static void *circular_buffer_task_rx( void *_URLContext
)
531 URLContext
*h
= _URLContext
;
532 UDPContext
*s
= h
->priv_data
;
535 ff_thread_setname("udp-rx");
537 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE
, &old_cancelstate
);
538 pthread_mutex_lock(&s
->mutex
);
539 if (ff_socket_nonblock(s
->udp_fd
, 0) < 0) {
540 av_log(h
, AV_LOG_ERROR
, "Failed to set blocking mode");
541 s
->circular_buffer_error
= AVERROR(EIO
);
545 UDPQueuedPacketHeader pkt_header
;
546 pkt_header
.addr_len
= sizeof(pkt_header
.addr
);
548 pthread_mutex_unlock(&s
->mutex
);
549 /* Blocking operations are always cancellation points;
550 see "General Information" / "Thread Cancellation Overview"
552 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE
, &old_cancelstate
);
553 pkt_header
.pkt_size
= recvfrom(s
->udp_fd
, s
->tmp
+ sizeof(pkt_header
), sizeof(s
->tmp
) - sizeof(pkt_header
), 0, (struct sockaddr
*)&pkt_header
.addr
, &pkt_header
.addr_len
);
554 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE
, &old_cancelstate
);
555 pthread_mutex_lock(&s
->mutex
);
556 if (pkt_header
.pkt_size
< 0) {
557 if (ff_neterrno() != AVERROR(EAGAIN
) && ff_neterrno() != AVERROR(EINTR
)) {
558 s
->circular_buffer_error
= ff_neterrno();
563 if (ff_ip_check_source_lists(&pkt_header
.addr
, &s
->filters
))
565 memcpy(s
->tmp
, &pkt_header
, sizeof(pkt_header
));
567 if (av_fifo_can_write(s
->rx_fifo
) < pkt_header
.pkt_size
+ sizeof(pkt_header
)) {
569 if (s
->overrun_nonfatal
) {
570 av_log(h
, AV_LOG_WARNING
, "Circular buffer overrun. "
571 "Surviving due to overrun_nonfatal option\n");
574 av_log(h
, AV_LOG_ERROR
, "Circular buffer overrun. "
575 "To avoid, increase fifo_size URL option. "
576 "To survive in such case, use overrun_nonfatal option\n");
577 s
->circular_buffer_error
= AVERROR(EIO
);
581 av_fifo_write(s
->rx_fifo
, s
->tmp
, pkt_header
.pkt_size
+ sizeof(pkt_header
));
582 pthread_cond_signal(&s
->cond
);
586 pthread_cond_signal(&s
->cond
);
587 pthread_mutex_unlock(&s
->mutex
);
591 static void *circular_buffer_task_tx( void *_URLContext
)
593 URLContext
*h
= _URLContext
;
594 UDPContext
*s
= h
->priv_data
;
595 int64_t target_timestamp
= av_gettime_relative();
596 int64_t start_timestamp
= av_gettime_relative();
597 int64_t sent_bits
= 0;
598 int64_t burst_interval
= s
->bitrate
? (s
->burst_bits
* 1000000 / s
->bitrate
) : 0;
599 int64_t max_delay
= s
->bitrate
? ((int64_t)h
->max_packet_size
* 8 * 1000000 / s
->bitrate
+ 1) : 0;
601 ff_thread_setname("udp-tx");
603 pthread_mutex_lock(&s
->mutex
);
605 if (ff_socket_nonblock(s
->udp_fd
, 0) < 0) {
606 av_log(h
, AV_LOG_ERROR
, "Failed to set blocking mode");
607 s
->circular_buffer_error
= AVERROR(EIO
);
617 len
= av_fifo_can_read(s
->tx_fifo
);
622 pthread_cond_wait(&s
->cond
, &s
->mutex
);
623 len
= av_fifo_can_read(s
->tx_fifo
);
626 av_fifo_read(s
->tx_fifo
, tmp
, 4);
629 av_assert0(len
>= 0);
630 av_assert0(len
<= sizeof(s
->tmp
));
632 av_fifo_read(s
->tx_fifo
, s
->tmp
, len
);
634 pthread_mutex_unlock(&s
->mutex
);
637 timestamp
= av_gettime_relative();
638 if (timestamp
< target_timestamp
) {
639 int64_t delay
= target_timestamp
- timestamp
;
640 if (delay
> max_delay
) {
642 start_timestamp
= timestamp
+ delay
;
647 if (timestamp
- burst_interval
> target_timestamp
) {
648 start_timestamp
= timestamp
- burst_interval
;
652 sent_bits
+= len
* 8;
653 target_timestamp
= start_timestamp
+ sent_bits
* 1000000 / s
->bitrate
;
660 if (!s
->is_connected
) {
661 ret
= sendto (s
->udp_fd
, p
, len
, 0,
662 (struct sockaddr
*) &s
->dest_addr
,
665 ret
= send(s
->udp_fd
, p
, len
, 0);
671 if (ret
!= AVERROR(EAGAIN
) && ret
!= AVERROR(EINTR
)) {
672 pthread_mutex_lock(&s
->mutex
);
673 s
->circular_buffer_error
= ret
;
674 pthread_mutex_unlock(&s
->mutex
);
680 pthread_mutex_lock(&s
->mutex
);
684 pthread_mutex_unlock(&s
->mutex
);
691 /* put it in UDP context */
692 /* return non zero if error */
693 static int udp_open(URLContext
*h
, const char *uri
, int flags
)
696 int port
, udp_fd
= -1, tmp
, bind_ret
= -1;
697 UDPContext
*s
= h
->priv_data
;
700 struct sockaddr_storage my_addr
;
706 is_output
= !(flags
& AVIO_FLAG_READ
);
707 if (s
->buffer_size
< 0)
708 s
->buffer_size
= is_output
? UDP_TX_BUF_SIZE
: UDP_RX_BUF_SIZE
;
710 p
= strchr(uri
, '?');
712 ret
= ff_parse_opts_from_query_string(s
, p
, 1);
716 if (!HAVE_PTHREAD_CANCEL
) {
717 int64_t optvals
[] = {s
->overrun_nonfatal
, s
->bitrate
, s
->circular_buffer_size
};
718 const char* optnames
[] = { "overrun_nonfatal", "bitrate", "fifo_size"};
719 for (unsigned i
= 0; i
< FF_ARRAY_ELEMS(optvals
); i
++) {
721 av_log(h
, AV_LOG_WARNING
,
722 "'%s' option was set but it is not supported "
723 "on this build (pthread support is required)\n", optnames
[i
]);
727 if ((ret
= ff_ip_parse_sources(h
, s
->sources
, &s
->filters
)) < 0)
731 if ((ret
= ff_ip_parse_blocks(h
, s
->block
, &s
->filters
)) < 0)
735 /* handling needed to support options picking from both AVOption and URL */
736 s
->circular_buffer_size
*= 188;
737 if (flags
& AVIO_FLAG_WRITE
) {
738 h
->max_packet_size
= s
->pkt_size
;
740 h
->max_packet_size
= UDP_MAX_PKT_SIZE
;
742 h
->rw_timeout
= s
->timeout
;
744 /* fill the dest addr */
745 av_url_split(NULL
, 0, NULL
, 0, hostname
, sizeof(hostname
), &port
, NULL
, 0, uri
);
747 /* XXX: fix av_url_split */
748 if (hostname
[0] == '\0' || hostname
[0] == '?') {
749 /* only accepts null hostname if input */
750 if (!(flags
& AVIO_FLAG_READ
)) {
751 ret
= AVERROR(EINVAL
);
755 if ((ret
= ff_udp_set_remote_url(h
, uri
)) < 0)
759 if ((s
->is_multicast
|| s
->local_port
< 0) && (h
->flags
& AVIO_FLAG_READ
))
760 s
->local_port
= port
;
762 udp_fd
= udp_socket_create(h
, &my_addr
, &len
, s
->localaddr
);
768 s
->local_addr_storage
=my_addr
; //store for future multicast join
770 /* Follow the requested reuse option, unless it's multicast in which
771 * case enable reuse unless explicitly disabled.
773 if (s
->reuse_socket
> 0 || (s
->is_multicast
&& s
->reuse_socket
< 0)) {
775 if (setsockopt (udp_fd
, SOL_SOCKET
, SO_REUSEADDR
, &(s
->reuse_socket
), sizeof(s
->reuse_socket
)) != 0) {
781 if (s
->is_broadcast
) {
783 if (setsockopt (udp_fd
, SOL_SOCKET
, SO_BROADCAST
, &(s
->is_broadcast
), sizeof(s
->is_broadcast
)) != 0) {
788 ret
= AVERROR(ENOSYS
);
793 /* Set the checksum coverage for UDP-Lite (RFC 3828) for sending and receiving.
794 * The receiver coverage has to be less than or equal to the sender coverage.
795 * Otherwise, the receiver will drop all packets.
797 if (s
->udplite_coverage
) {
798 if (setsockopt (udp_fd
, IPPROTO_UDPLITE
, UDPLITE_SEND_CSCOV
, &(s
->udplite_coverage
), sizeof(s
->udplite_coverage
)) != 0)
799 av_log(h
, AV_LOG_WARNING
, "socket option UDPLITE_SEND_CSCOV not available");
801 if (setsockopt (udp_fd
, IPPROTO_UDPLITE
, UDPLITE_RECV_CSCOV
, &(s
->udplite_coverage
), sizeof(s
->udplite_coverage
)) != 0)
802 av_log(h
, AV_LOG_WARNING
, "socket option UDPLITE_RECV_CSCOV not available");
806 int dscp
= s
->dscp
<< 2;
807 if (setsockopt (udp_fd
, IPPROTO_IP
, IP_TOS
, &dscp
, sizeof(dscp
)) != 0) {
813 /* If multicast, try binding the multicast address first, to avoid
814 * receiving UDP packets from other sources aimed at the same UDP
815 * port. This fails on windows. This makes sending to the same address
816 * using sendto() fail, so only do it if we're opened in read-only mode. */
817 if (s
->is_multicast
&& (h
->flags
& AVIO_FLAG_READ
)) {
818 bind_ret
= bind(udp_fd
,(struct sockaddr
*)&s
->dest_addr
, len
);
820 /* bind to the local address if not multicast or if the multicast
822 /* the bind is needed to give a port to the socket now */
823 if (bind_ret
< 0 && bind(udp_fd
,(struct sockaddr
*)&my_addr
, len
) < 0) {
824 ff_log_net_error(h
, AV_LOG_ERROR
, "bind failed");
829 len
= sizeof(my_addr
);
830 getsockname(udp_fd
, (struct sockaddr
*)&my_addr
, &len
);
831 s
->local_port
= udp_port(&my_addr
, len
);
833 if (s
->is_multicast
) {
834 if (h
->flags
& AVIO_FLAG_WRITE
) {
836 if ((ret
= udp_set_multicast_ttl(udp_fd
, s
->ttl
, (struct sockaddr
*)&s
->dest_addr
, h
)) < 0)
839 if (h
->flags
& AVIO_FLAG_READ
) {
841 if (s
->filters
.nb_include_addrs
) {
842 if ((ret
= udp_set_multicast_sources(h
, udp_fd
,
843 (struct sockaddr
*)&s
->dest_addr
,
844 s
->dest_addr_len
, &s
->local_addr_storage
,
845 s
->filters
.include_addrs
,
846 s
->filters
.nb_include_addrs
, 1)) < 0)
849 if ((ret
= udp_join_multicast_group(udp_fd
, (struct sockaddr
*)&s
->dest_addr
,
850 (struct sockaddr
*)&s
->local_addr_storage
, h
)) < 0)
853 if (s
->filters
.nb_exclude_addrs
) {
854 if ((ret
= udp_set_multicast_sources(h
, udp_fd
,
855 (struct sockaddr
*)&s
->dest_addr
,
856 s
->dest_addr_len
, &s
->local_addr_storage
,
857 s
->filters
.exclude_addrs
,
858 s
->filters
.nb_exclude_addrs
, 0)) < 0)
865 /* limit the tx buf size to limit latency */
866 tmp
= s
->buffer_size
;
867 if (setsockopt(udp_fd
, SOL_SOCKET
, SO_SNDBUF
, &tmp
, sizeof(tmp
)) < 0) {
868 ff_log_net_error(h
, AV_LOG_ERROR
, "setsockopt(SO_SNDBUF)");
873 /* set udp recv buffer size to the requested value (default UDP_RX_BUF_SIZE) */
874 tmp
= s
->buffer_size
;
875 if (setsockopt(udp_fd
, SOL_SOCKET
, SO_RCVBUF
, &tmp
, sizeof(tmp
)) < 0) {
876 ff_log_net_error(h
, AV_LOG_WARNING
, "setsockopt(SO_RECVBUF)");
879 if (getsockopt(udp_fd
, SOL_SOCKET
, SO_RCVBUF
, &tmp
, &len
) < 0) {
880 ff_log_net_error(h
, AV_LOG_WARNING
, "getsockopt(SO_RCVBUF)");
882 av_log(h
, AV_LOG_DEBUG
, "end receive buffer size reported is %d\n", tmp
);
883 if(tmp
< s
->buffer_size
)
884 av_log(h
, AV_LOG_WARNING
, "attempted to set receive buffer to size %d but it only ended up set as %d\n", s
->buffer_size
, tmp
);
887 /* make the socket non-blocking */
888 ff_socket_nonblock(udp_fd
, 1);
890 if (s
->is_connected
) {
891 if (connect(udp_fd
, (struct sockaddr
*) &s
->dest_addr
, s
->dest_addr_len
)) {
892 ff_log_net_error(h
, AV_LOG_ERROR
, "connect");
900 #if HAVE_PTHREAD_CANCEL
902 Create thread in case of:
903 1. Input and circular_buffer_size is set
904 2. Output and bitrate and circular_buffer_size is set
907 if (is_output
&& s
->bitrate
&& !s
->circular_buffer_size
) {
908 /* Warn user in case of 'circular_buffer_size' is not set */
909 av_log(h
, AV_LOG_WARNING
,"'bitrate' option was set but 'circular_buffer_size' is not, but required\n");
912 if ((!is_output
&& s
->circular_buffer_size
) || (is_output
&& s
->bitrate
&& s
->circular_buffer_size
)) {
913 /* start the task going */
914 AVFifo
*fifo
= av_fifo_alloc2(s
->circular_buffer_size
, 1, 0);
916 ret
= AVERROR(ENOMEM
);
923 ret
= pthread_mutex_init(&s
->mutex
, NULL
);
925 av_log(h
, AV_LOG_ERROR
, "pthread_mutex_init failed : %s\n", strerror(ret
));
929 ret
= pthread_cond_init(&s
->cond
, NULL
);
931 av_log(h
, AV_LOG_ERROR
, "pthread_cond_init failed : %s\n", strerror(ret
));
935 ret
= pthread_create(&s
->circular_buffer_thread
, NULL
, is_output
?circular_buffer_task_tx
:circular_buffer_task_rx
, h
);
937 av_log(h
, AV_LOG_ERROR
, "pthread_create failed : %s\n", strerror(ret
));
941 s
->thread_started
= 1;
946 #if HAVE_PTHREAD_CANCEL
948 pthread_cond_destroy(&s
->cond
);
950 pthread_mutex_destroy(&s
->mutex
);
955 av_fifo_freep2(&s
->rx_fifo
);
956 av_fifo_freep2(&s
->tx_fifo
);
957 ff_ip_reset_filters(&s
->filters
);
961 static int udplite_open(URLContext
*h
, const char *uri
, int flags
)
963 UDPContext
*s
= h
->priv_data
;
965 // set default checksum coverage
966 s
->udplite_coverage
= UDP_HEADER_SIZE
;
968 return udp_open(h
, uri
, flags
);
971 static int udp_read(URLContext
*h
, uint8_t *buf
, int size
)
973 UDPContext
*s
= h
->priv_data
;
975 #if HAVE_PTHREAD_CANCEL
976 int avail
, nonblock
= h
->flags
& AVIO_FLAG_NONBLOCK
;
979 pthread_mutex_lock(&s
->mutex
);
981 avail
= av_fifo_can_read(s
->rx_fifo
);
982 if (avail
) { // >=size) {
983 UDPQueuedPacketHeader header
;
985 av_fifo_read(s
->rx_fifo
, &header
, sizeof(header
));
987 s
->last_recv_addr
= header
.addr
;
988 s
->last_recv_addr_len
= header
.addr_len
;
990 avail
= header
.pkt_size
;
992 av_log(h
, AV_LOG_WARNING
, "Part of datagram lost due to insufficient buffer size\n");
996 av_fifo_read(s
->rx_fifo
, buf
, avail
);
997 av_fifo_drain2(s
->rx_fifo
, header
.pkt_size
- avail
);
998 pthread_mutex_unlock(&s
->mutex
);
1000 } else if(s
->circular_buffer_error
){
1001 int err
= s
->circular_buffer_error
;
1002 pthread_mutex_unlock(&s
->mutex
);
1004 } else if(nonblock
) {
1005 pthread_mutex_unlock(&s
->mutex
);
1006 return AVERROR(EAGAIN
);
1008 /* FIXME: using the monotonic clock would be better,
1009 but it does not exist on all supported platforms. */
1010 int64_t t
= av_gettime() + 100000;
1011 struct timespec tv
= { .tv_sec
= t
/ 1000000,
1012 .tv_nsec
= (t
% 1000000) * 1000 };
1013 int err
= pthread_cond_timedwait(&s
->cond
, &s
->mutex
, &tv
);
1015 pthread_mutex_unlock(&s
->mutex
);
1016 return AVERROR(err
== ETIMEDOUT
? EAGAIN
: err
);
1024 if (!(h
->flags
& AVIO_FLAG_NONBLOCK
)) {
1025 ret
= ff_network_wait_fd(s
->udp_fd
, 0);
1029 s
->last_recv_addr_len
= sizeof(s
->last_recv_addr
);
1030 ret
= recvfrom(s
->udp_fd
, buf
, size
, 0, (struct sockaddr
*)&s
->last_recv_addr
, &s
->last_recv_addr_len
);
1032 return ff_neterrno();
1033 if (ff_ip_check_source_lists(&s
->last_recv_addr
, &s
->filters
))
1034 return AVERROR(EINTR
);
1038 static int udp_write(URLContext
*h
, const uint8_t *buf
, int size
)
1040 UDPContext
*s
= h
->priv_data
;
1043 #if HAVE_PTHREAD_CANCEL
1047 pthread_mutex_lock(&s
->mutex
);
1050 Return error if last tx failed.
1051 Here we can't know on which packet error was, but it needs to know that error exists.
1053 if (s
->circular_buffer_error
<0) {
1054 int err
= s
->circular_buffer_error
;
1055 pthread_mutex_unlock(&s
->mutex
);
1059 if (av_fifo_can_write(s
->tx_fifo
) < size
+ 4) {
1060 /* What about a partial packet tx ? */
1061 pthread_mutex_unlock(&s
->mutex
);
1062 return AVERROR(ENOMEM
);
1065 av_fifo_write(s
->tx_fifo
, tmp
, 4); /* size of packet */
1066 av_fifo_write(s
->tx_fifo
, buf
, size
); /* the data */
1067 pthread_cond_signal(&s
->cond
);
1068 pthread_mutex_unlock(&s
->mutex
);
1072 if (!(h
->flags
& AVIO_FLAG_NONBLOCK
)) {
1073 ret
= ff_network_wait_fd(s
->udp_fd
, 1);
1078 if (!s
->is_connected
) {
1079 ret
= sendto (s
->udp_fd
, buf
, size
, 0,
1080 (struct sockaddr
*) &s
->dest_addr
,
1083 ret
= send(s
->udp_fd
, buf
, size
, 0);
1085 return ret
< 0 ? ff_neterrno() : ret
;
1088 static int udp_close(URLContext
*h
)
1090 UDPContext
*s
= h
->priv_data
;
1092 #if HAVE_PTHREAD_CANCEL
1093 // Request close once writing is finished
1094 if (s
->thread_started
&& !(h
->flags
& AVIO_FLAG_READ
)) {
1095 pthread_mutex_lock(&s
->mutex
);
1097 pthread_cond_signal(&s
->cond
);
1098 pthread_mutex_unlock(&s
->mutex
);
1102 if (s
->is_multicast
&& (h
->flags
& AVIO_FLAG_READ
))
1103 udp_leave_multicast_group(s
->udp_fd
, (struct sockaddr
*)&s
->dest_addr
,
1104 (struct sockaddr
*)&s
->local_addr_storage
, h
);
1105 #if HAVE_PTHREAD_CANCEL
1106 if (s
->thread_started
) {
1108 // Cancel only read, as write has been signaled as success to the user
1109 if (h
->flags
& AVIO_FLAG_READ
) {
1111 /* recvfrom() is not a cancellation point for win32, so we shutdown
1112 * the socket and abort pending IO, subsequent recvfrom() calls
1113 * will fail with WSAESHUTDOWN causing the thread to exit. */
1114 shutdown(s
->udp_fd
, SD_RECEIVE
);
1115 CancelIoEx((HANDLE
)(SOCKET
)s
->udp_fd
, NULL
);
1117 pthread_cancel(s
->circular_buffer_thread
);
1120 ret
= pthread_join(s
->circular_buffer_thread
, NULL
);
1122 av_log(h
, AV_LOG_ERROR
, "pthread_join(): %s\n", strerror(ret
));
1123 pthread_mutex_destroy(&s
->mutex
);
1124 pthread_cond_destroy(&s
->cond
);
1127 closesocket(s
->udp_fd
);
1128 av_fifo_freep2(&s
->rx_fifo
);
1129 av_fifo_freep2(&s
->tx_fifo
);
1130 ff_ip_reset_filters(&s
->filters
);
1134 const URLProtocol ff_udp_protocol
= {
1136 .url_open
= udp_open
,
1137 .url_read
= udp_read
,
1138 .url_write
= udp_write
,
1139 .url_close
= udp_close
,
1140 .url_get_file_handle
= udp_get_file_handle
,
1141 .priv_data_size
= sizeof(UDPContext
),
1142 .priv_data_class
= &udp_class
,
1143 .flags
= URL_PROTOCOL_FLAG_NETWORK
,
1146 const URLProtocol ff_udplite_protocol
= {
1148 .url_open
= udplite_open
,
1149 .url_read
= udp_read
,
1150 .url_write
= udp_write
,
1151 .url_close
= udp_close
,
1152 .url_get_file_handle
= udp_get_file_handle
,
1153 .priv_data_size
= sizeof(UDPContext
),
1154 .priv_data_class
= &udplite_context_class
,
1155 .flags
= URL_PROTOCOL_FLAG_NETWORK
,