8d0f7f15195a364fcec9ee9278c8e6893cbd11b9
[ffmpeg.git] / libavformat / udp.c
1 /*
2  * UDP prototype streaming system
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * UDP protocol
25  */
26
27 #define _DEFAULT_SOURCE
28 #define _BSD_SOURCE     /* Needed for using struct ip_mreq with recent glibc */
29
30 #include "avformat.h"
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"
40 #include "internal.h"
41 #include "network.h"
42 #include "os_support.h"
43 #include "url.h"
44 #include "ip.h"
45
46 #ifdef __APPLE__
47 #include "TargetConditionals.h"
48 #endif
49
50 #if HAVE_UDPLITE_H
51 #include "udplite.h"
52 #else
53 /* On many Linux systems, udplite.h is missing but the kernel supports UDP-Lite.
54  * So, we provide a fallback here.
55  */
56 #define UDPLITE_SEND_CSCOV                               10
57 #define UDPLITE_RECV_CSCOV                               11
58 #endif
59
60 #ifndef IPPROTO_UDPLITE
61 #define IPPROTO_UDPLITE                                  136
62 #endif
63
64 #if HAVE_PTHREAD_CANCEL
65 #include <pthread.h>
66 #endif
67
68 #ifndef IPV6_ADD_MEMBERSHIP
69 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
70 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
71 #endif
72
73 #define UDP_TX_BUF_SIZE 32768
74 #define UDP_MAX_PKT_SIZE 65536
75 #define UDP_HEADER_SIZE 8
76
77 typedef struct UDPContext {
78     const AVClass *class;
79     int udp_fd;
80     int ttl;
81     int udplite_coverage;
82     int buffer_size;
83     int pkt_size;
84     int is_multicast;
85     int is_broadcast;
86     int local_port;
87     int reuse_socket;
88     int overrun_nonfatal;
89     struct sockaddr_storage dest_addr;
90     int dest_addr_len;
91     int is_connected;
92
93     /* Circular Buffer variables for use in UDP receive code */
94     int circular_buffer_size;
95     AVFifoBuffer *fifo;
96     int circular_buffer_error;
97     int64_t bitrate; /* number of bits to send per second */
98     int64_t burst_bits;
99     int close_req;
100 #if HAVE_PTHREAD_CANCEL
101     pthread_t circular_buffer_thread;
102     pthread_mutex_t mutex;
103     pthread_cond_t cond;
104     int thread_started;
105 #endif
106     uint8_t tmp[UDP_MAX_PKT_SIZE+4];
107     int remaining_in_dg;
108     char *localaddr;
109     int timeout;
110     struct sockaddr_storage local_addr_storage;
111     char *sources;
112     char *block;
113     IPSourceFilters filters;
114 } UDPContext;
115
116 #define OFFSET(x) offsetof(UDPContext, x)
117 #define D AV_OPT_FLAG_DECODING_PARAM
118 #define E AV_OPT_FLAG_ENCODING_PARAM
119 static const AVOption options[] = {
120     { "buffer_size",    "System data size (in bytes)",                     OFFSET(buffer_size),    AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
121     { "bitrate",        "Bits to send per second",                         OFFSET(bitrate),        AV_OPT_TYPE_INT64,  { .i64 = 0  },     0, INT64_MAX, .flags = E },
122     { "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 },
123     { "localport",      "Local port",                                      OFFSET(local_port),     AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, D|E },
124     { "local_port",     "Local port",                                      OFFSET(local_port),     AV_OPT_TYPE_INT,    { .i64 = -1 },    -1, INT_MAX, .flags = D|E },
125     { "localaddr",      "Local address",                                   OFFSET(localaddr),      AV_OPT_TYPE_STRING, { .str = NULL },               .flags = D|E },
126     { "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 },
127     { "pkt_size",       "Maximum UDP packet size",                         OFFSET(pkt_size),       AV_OPT_TYPE_INT,    { .i64 = 1472 },  -1, INT_MAX, .flags = D|E },
128     { "reuse",          "explicitly allow reusing UDP sockets",            OFFSET(reuse_socket),   AV_OPT_TYPE_BOOL,   { .i64 = -1 },    -1, 1,       D|E },
129     { "reuse_socket",   "explicitly allow reusing UDP sockets",            OFFSET(reuse_socket),   AV_OPT_TYPE_BOOL,   { .i64 = -1 },    -1, 1,       .flags = D|E },
130     { "broadcast", "explicitly allow or disallow broadcast destination",   OFFSET(is_broadcast),   AV_OPT_TYPE_BOOL,   { .i64 = 0  },     0, 1,       E },
131     { "ttl",            "Time to live (multicast only)",                   OFFSET(ttl),            AV_OPT_TYPE_INT,    { .i64 = 16 },     0, INT_MAX, E },
132     { "connect",        "set if connect() should be called on socket",     OFFSET(is_connected),   AV_OPT_TYPE_BOOL,   { .i64 =  0 },     0, 1,       .flags = D|E },
133     { "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 },
134     { "overrun_nonfatal", "survive in case of UDP receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1,    D },
135     { "timeout",        "set raise error timeout (only in read mode)",     OFFSET(timeout),        AV_OPT_TYPE_INT,    { .i64 = 0 },      0, INT_MAX, D },
136     { "sources",        "Source list",                                     OFFSET(sources),        AV_OPT_TYPE_STRING, { .str = NULL },               .flags = D|E },
137     { "block",          "Block list",                                      OFFSET(block),          AV_OPT_TYPE_STRING, { .str = NULL },               .flags = D|E },
138     { NULL }
139 };
140
141 static const AVClass udp_class = {
142     .class_name = "udp",
143     .item_name  = av_default_item_name,
144     .option     = options,
145     .version    = LIBAVUTIL_VERSION_INT,
146 };
147
148 static const AVClass udplite_context_class = {
149     .class_name     = "udplite",
150     .item_name      = av_default_item_name,
151     .option         = options,
152     .version        = LIBAVUTIL_VERSION_INT,
153 };
154
155 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
156                                  struct sockaddr *addr)
157 {
158 #ifdef IP_MULTICAST_TTL
159     if (addr->sa_family == AF_INET) {
160         if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
161             ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL)");
162             return -1;
163         }
164     }
165 #endif
166 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
167     if (addr->sa_family == AF_INET6) {
168         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
169             ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS)");
170             return -1;
171         }
172     }
173 #endif
174     return 0;
175 }
176
177 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
178 {
179 #ifdef IP_ADD_MEMBERSHIP
180     if (addr->sa_family == AF_INET) {
181         struct ip_mreq mreq;
182
183         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
184         if (local_addr)
185             mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
186         else
187             mreq.imr_interface.s_addr= INADDR_ANY;
188         if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
189             ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP)");
190             return -1;
191         }
192     }
193 #endif
194 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
195     if (addr->sa_family == AF_INET6) {
196         struct ipv6_mreq mreq6;
197
198         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
199         mreq6.ipv6mr_interface= 0;
200         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
201             ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP)");
202             return -1;
203         }
204     }
205 #endif
206     return 0;
207 }
208
209 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr,struct sockaddr *local_addr)
210 {
211 #ifdef IP_DROP_MEMBERSHIP
212     if (addr->sa_family == AF_INET) {
213         struct ip_mreq mreq;
214
215         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
216         if (local_addr)
217             mreq.imr_interface= ((struct sockaddr_in *)local_addr)->sin_addr;
218         else
219             mreq.imr_interface.s_addr= INADDR_ANY;
220         if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
221             ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP)");
222             return -1;
223         }
224     }
225 #endif
226 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
227     if (addr->sa_family == AF_INET6) {
228         struct ipv6_mreq mreq6;
229
230         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
231         mreq6.ipv6mr_interface= 0;
232         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
233             ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP)");
234             return -1;
235         }
236     }
237 #endif
238     return 0;
239 }
240
241 static int udp_set_multicast_sources(URLContext *h,
242                                      int sockfd, struct sockaddr *addr,
243                                      int addr_len, struct sockaddr_storage *sources,
244                                      int nb_sources, int include)
245 {
246 #if HAVE_STRUCT_GROUP_SOURCE_REQ && defined(MCAST_BLOCK_SOURCE) && !defined(_WIN32) && (!defined(TARGET_OS_TV) || !TARGET_OS_TV)
247     /* These ones are available in the microsoft SDK, but don't seem to work
248      * as on linux, so just prefer the v4-only approach there for now. */
249     int i;
250     for (i = 0; i < nb_sources; i++) {
251         struct group_source_req mreqs;
252         int level = addr->sa_family == AF_INET ? IPPROTO_IP : IPPROTO_IPV6;
253
254         mreqs.gsr_interface = 0;
255         memcpy(&mreqs.gsr_group, addr, addr_len);
256         memcpy(&mreqs.gsr_source, &sources[i], sizeof(*sources));
257
258         if (setsockopt(sockfd, level,
259                        include ? MCAST_JOIN_SOURCE_GROUP : MCAST_BLOCK_SOURCE,
260                        (const void *)&mreqs, sizeof(mreqs)) < 0) {
261             if (include)
262                 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_JOIN_SOURCE_GROUP)");
263             else
264                 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(MCAST_BLOCK_SOURCE)");
265             return ff_neterrno();
266         }
267     }
268 #elif HAVE_STRUCT_IP_MREQ_SOURCE && defined(IP_BLOCK_SOURCE)
269     int i;
270     if (addr->sa_family != AF_INET) {
271         av_log(NULL, AV_LOG_ERROR,
272                "Setting multicast sources only supported for IPv4\n");
273         return AVERROR(EINVAL);
274     }
275     for (i = 0; i < nb_sources; i++) {
276         struct ip_mreq_source mreqs;
277         if (sources[i].ss_family != AF_INET) {
278             av_log(NULL, AV_LOG_ERROR, "Source/block address %d is of incorrect protocol family\n", i + 1);
279             return AVERROR(EINVAL);
280         }
281
282         mreqs.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
283         mreqs.imr_interface.s_addr = INADDR_ANY;
284         mreqs.imr_sourceaddr.s_addr = ((struct sockaddr_in *)&sources[i])->sin_addr.s_addr;
285
286         if (setsockopt(sockfd, IPPROTO_IP,
287                        include ? IP_ADD_SOURCE_MEMBERSHIP : IP_BLOCK_SOURCE,
288                        (const void *)&mreqs, sizeof(mreqs)) < 0) {
289             if (include)
290                 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_SOURCE_MEMBERSHIP)");
291             else
292                 ff_log_net_error(NULL, AV_LOG_ERROR, "setsockopt(IP_BLOCK_SOURCE)");
293             return ff_neterrno();
294         }
295     }
296 #else
297     return AVERROR(ENOSYS);
298 #endif
299     return 0;
300 }
301 static int udp_set_url(URLContext *h,
302                        struct sockaddr_storage *addr,
303                        const char *hostname, int port)
304 {
305     struct addrinfo *res0;
306     int addr_len;
307
308     res0 = ff_ip_resolve_host(h, hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
309     if (!res0) return AVERROR(EIO);
310     memcpy(addr, res0->ai_addr, res0->ai_addrlen);
311     addr_len = res0->ai_addrlen;
312     freeaddrinfo(res0);
313
314     return addr_len;
315 }
316
317 static int udp_socket_create(URLContext *h, struct sockaddr_storage *addr,
318                              socklen_t *addr_len, const char *localaddr)
319 {
320     UDPContext *s = h->priv_data;
321     int udp_fd = -1;
322     struct addrinfo *res0, *res;
323     int family = AF_UNSPEC;
324
325     if (((struct sockaddr *) &s->dest_addr)->sa_family)
326         family = ((struct sockaddr *) &s->dest_addr)->sa_family;
327     res0 = ff_ip_resolve_host(h, (localaddr && localaddr[0]) ? localaddr : NULL,
328                             s->local_port,
329                             SOCK_DGRAM, family, AI_PASSIVE);
330     if (!res0)
331         goto fail;
332     for (res = res0; res; res=res->ai_next) {
333         if (s->udplite_coverage)
334             udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, IPPROTO_UDPLITE);
335         else
336             udp_fd = ff_socket(res->ai_family, SOCK_DGRAM, 0);
337         if (udp_fd != -1) break;
338         ff_log_net_error(NULL, AV_LOG_ERROR, "socket");
339     }
340
341     if (udp_fd < 0)
342         goto fail;
343
344     memcpy(addr, res->ai_addr, res->ai_addrlen);
345     *addr_len = res->ai_addrlen;
346
347     freeaddrinfo(res0);
348
349     return udp_fd;
350
351  fail:
352     if (udp_fd >= 0)
353         closesocket(udp_fd);
354     if(res0)
355         freeaddrinfo(res0);
356     return -1;
357 }
358
359 static int udp_port(struct sockaddr_storage *addr, int addr_len)
360 {
361     char sbuf[sizeof(int)*3+1];
362     int error;
363
364     if ((error = getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0,  sbuf, sizeof(sbuf), NI_NUMERICSERV)) != 0) {
365         av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", gai_strerror(error));
366         return -1;
367     }
368
369     return strtol(sbuf, NULL, 10);
370 }
371
372
373 /**
374  * If no filename is given to av_open_input_file because you want to
375  * get the local port first, then you must call this function to set
376  * the remote server address.
377  *
378  * url syntax: udp://host:port[?option=val...]
379  * option: 'ttl=n'       : set the ttl value (for multicast only)
380  *         'localport=n' : set the local port
381  *         'pkt_size=n'  : set max packet size
382  *         'reuse=1'     : enable reusing the socket
383  *         'overrun_nonfatal=1': survive in case of circular buffer overrun
384  *
385  * @param h media file context
386  * @param uri of the remote server
387  * @return zero if no error.
388  */
389 int ff_udp_set_remote_url(URLContext *h, const char *uri)
390 {
391     UDPContext *s = h->priv_data;
392     char hostname[256], buf[10];
393     int port;
394     const char *p;
395
396     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
397
398     /* set the destination address */
399     s->dest_addr_len = udp_set_url(h, &s->dest_addr, hostname, port);
400     if (s->dest_addr_len < 0) {
401         return AVERROR(EIO);
402     }
403     s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
404     p = strchr(uri, '?');
405     if (p) {
406         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
407             int was_connected = s->is_connected;
408             s->is_connected = strtol(buf, NULL, 10);
409             if (s->is_connected && !was_connected) {
410                 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
411                             s->dest_addr_len)) {
412                     s->is_connected = 0;
413                     ff_log_net_error(h, AV_LOG_ERROR, "connect");
414                     return AVERROR(EIO);
415                 }
416             }
417         }
418     }
419
420     return 0;
421 }
422
423 /**
424  * Return the local port used by the UDP connection
425  * @param h media file context
426  * @return the local port number
427  */
428 int ff_udp_get_local_port(URLContext *h)
429 {
430     UDPContext *s = h->priv_data;
431     return s->local_port;
432 }
433
434 /**
435  * Return the udp file handle for select() usage to wait for several RTP
436  * streams at the same time.
437  * @param h media file context
438  */
439 static int udp_get_file_handle(URLContext *h)
440 {
441     UDPContext *s = h->priv_data;
442     return s->udp_fd;
443 }
444
445 #if HAVE_PTHREAD_CANCEL
446 static void *circular_buffer_task_rx( void *_URLContext)
447 {
448     URLContext *h = _URLContext;
449     UDPContext *s = h->priv_data;
450     int old_cancelstate;
451
452     pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
453     pthread_mutex_lock(&s->mutex);
454     if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
455         av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
456         s->circular_buffer_error = AVERROR(EIO);
457         goto end;
458     }
459     while(1) {
460         int len;
461         struct sockaddr_storage addr;
462         socklen_t addr_len = sizeof(addr);
463
464         pthread_mutex_unlock(&s->mutex);
465         /* Blocking operations are always cancellation points;
466            see "General Information" / "Thread Cancelation Overview"
467            in Single Unix. */
468         pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
469         len = recvfrom(s->udp_fd, s->tmp+4, sizeof(s->tmp)-4, 0, (struct sockaddr *)&addr, &addr_len);
470         pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
471         pthread_mutex_lock(&s->mutex);
472         if (len < 0) {
473             if (ff_neterrno() != AVERROR(EAGAIN) && ff_neterrno() != AVERROR(EINTR)) {
474                 s->circular_buffer_error = ff_neterrno();
475                 goto end;
476             }
477             continue;
478         }
479         if (ff_ip_check_source_lists(&addr, &s->filters))
480             continue;
481         AV_WL32(s->tmp, len);
482
483         if(av_fifo_space(s->fifo) < len + 4) {
484             /* No Space left */
485             if (s->overrun_nonfatal) {
486                 av_log(h, AV_LOG_WARNING, "Circular buffer overrun. "
487                         "Surviving due to overrun_nonfatal option\n");
488                 continue;
489             } else {
490                 av_log(h, AV_LOG_ERROR, "Circular buffer overrun. "
491                         "To avoid, increase fifo_size URL option. "
492                         "To survive in such case, use overrun_nonfatal option\n");
493                 s->circular_buffer_error = AVERROR(EIO);
494                 goto end;
495             }
496         }
497         av_fifo_generic_write(s->fifo, s->tmp, len+4, NULL);
498         pthread_cond_signal(&s->cond);
499     }
500
501 end:
502     pthread_cond_signal(&s->cond);
503     pthread_mutex_unlock(&s->mutex);
504     return NULL;
505 }
506
507 static void *circular_buffer_task_tx( void *_URLContext)
508 {
509     URLContext *h = _URLContext;
510     UDPContext *s = h->priv_data;
511     int old_cancelstate;
512     int64_t target_timestamp = av_gettime_relative();
513     int64_t start_timestamp = av_gettime_relative();
514     int64_t sent_bits = 0;
515     int64_t burst_interval = s->bitrate ? (s->burst_bits * 1000000 / s->bitrate) : 0;
516     int64_t max_delay = s->bitrate ?  ((int64_t)h->max_packet_size * 8 * 1000000 / s->bitrate + 1) : 0;
517
518     pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
519     pthread_mutex_lock(&s->mutex);
520
521     if (ff_socket_nonblock(s->udp_fd, 0) < 0) {
522         av_log(h, AV_LOG_ERROR, "Failed to set blocking mode");
523         s->circular_buffer_error = AVERROR(EIO);
524         goto end;
525     }
526
527     for(;;) {
528         int len;
529         const uint8_t *p;
530         uint8_t tmp[4];
531         int64_t timestamp;
532
533         len=av_fifo_size(s->fifo);
534
535         while (len<4) {
536             if (s->close_req)
537                 goto end;
538             if (pthread_cond_wait(&s->cond, &s->mutex) < 0) {
539                 goto end;
540             }
541             len=av_fifo_size(s->fifo);
542         }
543
544         av_fifo_generic_read(s->fifo, tmp, 4, NULL);
545         len=AV_RL32(tmp);
546
547         av_assert0(len >= 0);
548         av_assert0(len <= sizeof(s->tmp));
549
550         av_fifo_generic_read(s->fifo, s->tmp, len, NULL);
551
552         pthread_mutex_unlock(&s->mutex);
553         pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old_cancelstate);
554
555         if (s->bitrate) {
556             timestamp = av_gettime_relative();
557             if (timestamp < target_timestamp) {
558                 int64_t delay = target_timestamp - timestamp;
559                 if (delay > max_delay) {
560                     delay = max_delay;
561                     start_timestamp = timestamp + delay;
562                     sent_bits = 0;
563                 }
564                 av_usleep(delay);
565             } else {
566                 if (timestamp - burst_interval > target_timestamp) {
567                     start_timestamp = timestamp - burst_interval;
568                     sent_bits = 0;
569                 }
570             }
571             sent_bits += len * 8;
572             target_timestamp = start_timestamp + sent_bits * 1000000 / s->bitrate;
573         }
574
575         p = s->tmp;
576         while (len) {
577             int ret;
578             av_assert0(len > 0);
579             if (!s->is_connected) {
580                 ret = sendto (s->udp_fd, p, len, 0,
581                             (struct sockaddr *) &s->dest_addr,
582                             s->dest_addr_len);
583             } else
584                 ret = send(s->udp_fd, p, len, 0);
585             if (ret >= 0) {
586                 len -= ret;
587                 p   += ret;
588             } else {
589                 ret = ff_neterrno();
590                 if (ret != AVERROR(EAGAIN) && ret != AVERROR(EINTR)) {
591                     pthread_mutex_lock(&s->mutex);
592                     s->circular_buffer_error = ret;
593                     pthread_mutex_unlock(&s->mutex);
594                     return NULL;
595                 }
596             }
597         }
598
599         pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancelstate);
600         pthread_mutex_lock(&s->mutex);
601     }
602
603 end:
604     pthread_mutex_unlock(&s->mutex);
605     return NULL;
606 }
607
608
609 #endif
610
611 /* put it in UDP context */
612 /* return non zero if error */
613 static int udp_open(URLContext *h, const char *uri, int flags)
614 {
615     char hostname[1024], localaddr[1024] = "";
616     int port, udp_fd = -1, tmp, bind_ret = -1, dscp = -1;
617     UDPContext *s = h->priv_data;
618     int is_output;
619     const char *p;
620     char buf[256];
621     struct sockaddr_storage my_addr;
622     socklen_t len;
623
624     h->is_streamed = 1;
625
626     is_output = !(flags & AVIO_FLAG_READ);
627     if (s->buffer_size < 0)
628         s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
629
630     if (s->sources) {
631         if (ff_ip_parse_sources(h, s->sources, &s->filters) < 0)
632             goto fail;
633     }
634
635     if (s->block) {
636         if (ff_ip_parse_blocks(h, s->block, &s->filters) < 0)
637             goto fail;
638     }
639
640     if (s->pkt_size > 0)
641         h->max_packet_size = s->pkt_size;
642
643     p = strchr(uri, '?');
644     if (p) {
645         if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
646             char *endptr = NULL;
647             s->reuse_socket = strtol(buf, &endptr, 10);
648             /* assume if no digits were found it is a request to enable it */
649             if (buf == endptr)
650                 s->reuse_socket = 1;
651         }
652         if (av_find_info_tag(buf, sizeof(buf), "overrun_nonfatal", p)) {
653             char *endptr = NULL;
654             s->overrun_nonfatal = strtol(buf, &endptr, 10);
655             /* assume if no digits were found it is a request to enable it */
656             if (buf == endptr)
657                 s->overrun_nonfatal = 1;
658             if (!HAVE_PTHREAD_CANCEL)
659                 av_log(h, AV_LOG_WARNING,
660                        "'overrun_nonfatal' option was set but it is not supported "
661                        "on this build (pthread support is required)\n");
662         }
663         if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
664             s->ttl = strtol(buf, NULL, 10);
665         }
666         if (av_find_info_tag(buf, sizeof(buf), "udplite_coverage", p)) {
667             s->udplite_coverage = strtol(buf, NULL, 10);
668         }
669         if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
670             s->local_port = strtol(buf, NULL, 10);
671         }
672         if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
673             s->pkt_size = strtol(buf, NULL, 10);
674         }
675         if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
676             s->buffer_size = strtol(buf, NULL, 10);
677         }
678         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
679             s->is_connected = strtol(buf, NULL, 10);
680         }
681         if (av_find_info_tag(buf, sizeof(buf), "dscp", p)) {
682             dscp = strtol(buf, NULL, 10);
683         }
684         if (av_find_info_tag(buf, sizeof(buf), "fifo_size", p)) {
685             s->circular_buffer_size = strtol(buf, NULL, 10);
686             if (!HAVE_PTHREAD_CANCEL)
687                 av_log(h, AV_LOG_WARNING,
688                        "'circular_buffer_size' option was set but it is not supported "
689                        "on this build (pthread support is required)\n");
690         }
691         if (av_find_info_tag(buf, sizeof(buf), "bitrate", p)) {
692             s->bitrate = strtoll(buf, NULL, 10);
693             if (!HAVE_PTHREAD_CANCEL)
694                 av_log(h, AV_LOG_WARNING,
695                        "'bitrate' option was set but it is not supported "
696                        "on this build (pthread support is required)\n");
697         }
698         if (av_find_info_tag(buf, sizeof(buf), "burst_bits", p)) {
699             s->burst_bits = strtoll(buf, NULL, 10);
700         }
701         if (av_find_info_tag(buf, sizeof(buf), "localaddr", p)) {
702             av_strlcpy(localaddr, buf, sizeof(localaddr));
703         }
704         if (av_find_info_tag(buf, sizeof(buf), "sources", p)) {
705             if (ff_ip_parse_sources(h, buf, &s->filters) < 0)
706                 goto fail;
707         }
708         if (av_find_info_tag(buf, sizeof(buf), "block", p)) {
709             if (ff_ip_parse_blocks(h, buf, &s->filters) < 0)
710                 goto fail;
711         }
712         if (!is_output && av_find_info_tag(buf, sizeof(buf), "timeout", p))
713             s->timeout = strtol(buf, NULL, 10);
714         if (is_output && av_find_info_tag(buf, sizeof(buf), "broadcast", p))
715             s->is_broadcast = strtol(buf, NULL, 10);
716     }
717     /* handling needed to support options picking from both AVOption and URL */
718     s->circular_buffer_size *= 188;
719     if (flags & AVIO_FLAG_WRITE) {
720         h->max_packet_size = s->pkt_size;
721     } else {
722         h->max_packet_size = UDP_MAX_PKT_SIZE;
723     }
724     h->rw_timeout = s->timeout;
725
726     /* fill the dest addr */
727     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
728
729     /* XXX: fix av_url_split */
730     if (hostname[0] == '\0' || hostname[0] == '?') {
731         /* only accepts null hostname if input */
732         if (!(flags & AVIO_FLAG_READ))
733             goto fail;
734     } else {
735         if (ff_udp_set_remote_url(h, uri) < 0)
736             goto fail;
737     }
738
739     if ((s->is_multicast || s->local_port <= 0) && (h->flags & AVIO_FLAG_READ))
740         s->local_port = port;
741
742     if (localaddr[0])
743         udp_fd = udp_socket_create(h, &my_addr, &len, localaddr);
744     else
745         udp_fd = udp_socket_create(h, &my_addr, &len, s->localaddr);
746     if (udp_fd < 0)
747         goto fail;
748
749     s->local_addr_storage=my_addr; //store for future multicast join
750
751     /* Follow the requested reuse option, unless it's multicast in which
752      * case enable reuse unless explicitly disabled.
753      */
754     if (s->reuse_socket > 0 || (s->is_multicast && s->reuse_socket < 0)) {
755         s->reuse_socket = 1;
756         if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
757             goto fail;
758     }
759
760     if (s->is_broadcast) {
761 #ifdef SO_BROADCAST
762         if (setsockopt (udp_fd, SOL_SOCKET, SO_BROADCAST, &(s->is_broadcast), sizeof(s->is_broadcast)) != 0)
763 #endif
764            goto fail;
765     }
766
767     /* Set the checksum coverage for UDP-Lite (RFC 3828) for sending and receiving.
768      * The receiver coverage has to be less than or equal to the sender coverage.
769      * Otherwise, the receiver will drop all packets.
770      */
771     if (s->udplite_coverage) {
772         if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
773             av_log(h, AV_LOG_WARNING, "socket option UDPLITE_SEND_CSCOV not available");
774
775         if (setsockopt (udp_fd, IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, &(s->udplite_coverage), sizeof(s->udplite_coverage)) != 0)
776             av_log(h, AV_LOG_WARNING, "socket option UDPLITE_RECV_CSCOV not available");
777     }
778
779     if (dscp >= 0) {
780         dscp <<= 2;
781         if (setsockopt (udp_fd, IPPROTO_IP, IP_TOS, &dscp, sizeof(dscp)) != 0)
782             goto fail;
783     }
784
785     /* If multicast, try binding the multicast address first, to avoid
786      * receiving UDP packets from other sources aimed at the same UDP
787      * port. This fails on windows. This makes sending to the same address
788      * using sendto() fail, so only do it if we're opened in read-only mode. */
789     if (s->is_multicast && !(h->flags & AVIO_FLAG_WRITE)) {
790         bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
791     }
792     /* bind to the local address if not multicast or if the multicast
793      * bind failed */
794     /* the bind is needed to give a port to the socket now */
795     if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0) {
796         ff_log_net_error(h, AV_LOG_ERROR, "bind failed");
797         goto fail;
798     }
799
800     len = sizeof(my_addr);
801     getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
802     s->local_port = udp_port(&my_addr, len);
803
804     if (s->is_multicast) {
805         if (h->flags & AVIO_FLAG_WRITE) {
806             /* output */
807             if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
808                 goto fail;
809         }
810         if (h->flags & AVIO_FLAG_READ) {
811             /* input */
812             if (s->filters.nb_include_addrs) {
813                 if (udp_set_multicast_sources(h, udp_fd,
814                                               (struct sockaddr *)&s->dest_addr,
815                                               s->dest_addr_len,
816                                               s->filters.include_addrs,
817                                               s->filters.nb_include_addrs, 1) < 0)
818                     goto fail;
819             } else {
820                 if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage) < 0)
821                     goto fail;
822             }
823             if (s->filters.nb_exclude_addrs) {
824                 if (udp_set_multicast_sources(h, udp_fd,
825                                               (struct sockaddr *)&s->dest_addr,
826                                               s->dest_addr_len,
827                                               s->filters.exclude_addrs,
828                                               s->filters.nb_exclude_addrs, 0) < 0)
829                     goto fail;
830             }
831         }
832     }
833
834     if (is_output) {
835         /* limit the tx buf size to limit latency */
836         tmp = s->buffer_size;
837         if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
838             ff_log_net_error(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF)");
839             goto fail;
840         }
841     } else {
842         /* set udp recv buffer size to the requested value (default 64K) */
843         tmp = s->buffer_size;
844         if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
845             ff_log_net_error(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF)");
846         }
847         len = sizeof(tmp);
848         if (getsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, &len) < 0) {
849             ff_log_net_error(h, AV_LOG_WARNING, "getsockopt(SO_RCVBUF)");
850         } else {
851             av_log(h, AV_LOG_DEBUG, "end receive buffer size reported is %d\n", tmp);
852             if(tmp < s->buffer_size)
853                 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);
854         }
855
856         /* make the socket non-blocking */
857         ff_socket_nonblock(udp_fd, 1);
858     }
859     if (s->is_connected) {
860         if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
861             ff_log_net_error(h, AV_LOG_ERROR, "connect");
862             goto fail;
863         }
864     }
865
866     s->udp_fd = udp_fd;
867
868 #if HAVE_PTHREAD_CANCEL
869     /*
870       Create thread in case of:
871       1. Input and circular_buffer_size is set
872       2. Output and bitrate and circular_buffer_size is set
873     */
874
875     if (is_output && s->bitrate && !s->circular_buffer_size) {
876         /* Warn user in case of 'circular_buffer_size' is not set */
877         av_log(h, AV_LOG_WARNING,"'bitrate' option was set but 'circular_buffer_size' is not, but required\n");
878     }
879
880     if ((!is_output && s->circular_buffer_size) || (is_output && s->bitrate && s->circular_buffer_size)) {
881         int ret;
882
883         /* start the task going */
884         s->fifo = av_fifo_alloc(s->circular_buffer_size);
885         ret = pthread_mutex_init(&s->mutex, NULL);
886         if (ret != 0) {
887             av_log(h, AV_LOG_ERROR, "pthread_mutex_init failed : %s\n", strerror(ret));
888             goto fail;
889         }
890         ret = pthread_cond_init(&s->cond, NULL);
891         if (ret != 0) {
892             av_log(h, AV_LOG_ERROR, "pthread_cond_init failed : %s\n", strerror(ret));
893             goto cond_fail;
894         }
895         ret = pthread_create(&s->circular_buffer_thread, NULL, is_output?circular_buffer_task_tx:circular_buffer_task_rx, h);
896         if (ret != 0) {
897             av_log(h, AV_LOG_ERROR, "pthread_create failed : %s\n", strerror(ret));
898             goto thread_fail;
899         }
900         s->thread_started = 1;
901     }
902 #endif
903
904     return 0;
905 #if HAVE_PTHREAD_CANCEL
906  thread_fail:
907     pthread_cond_destroy(&s->cond);
908  cond_fail:
909     pthread_mutex_destroy(&s->mutex);
910 #endif
911  fail:
912     if (udp_fd >= 0)
913         closesocket(udp_fd);
914     av_fifo_freep(&s->fifo);
915     ff_ip_reset_filters(&s->filters);
916     return AVERROR(EIO);
917 }
918
919 static int udplite_open(URLContext *h, const char *uri, int flags)
920 {
921     UDPContext *s = h->priv_data;
922
923     // set default checksum coverage
924     s->udplite_coverage = UDP_HEADER_SIZE;
925
926     return udp_open(h, uri, flags);
927 }
928
929 static int udp_read(URLContext *h, uint8_t *buf, int size)
930 {
931     UDPContext *s = h->priv_data;
932     int ret;
933     struct sockaddr_storage addr;
934     socklen_t addr_len = sizeof(addr);
935 #if HAVE_PTHREAD_CANCEL
936     int avail, nonblock = h->flags & AVIO_FLAG_NONBLOCK;
937
938     if (s->fifo) {
939         pthread_mutex_lock(&s->mutex);
940         do {
941             avail = av_fifo_size(s->fifo);
942             if (avail) { // >=size) {
943                 uint8_t tmp[4];
944
945                 av_fifo_generic_read(s->fifo, tmp, 4, NULL);
946                 avail= AV_RL32(tmp);
947                 if(avail > size){
948                     av_log(h, AV_LOG_WARNING, "Part of datagram lost due to insufficient buffer size\n");
949                     avail= size;
950                 }
951
952                 av_fifo_generic_read(s->fifo, buf, avail, NULL);
953                 av_fifo_drain(s->fifo, AV_RL32(tmp) - avail);
954                 pthread_mutex_unlock(&s->mutex);
955                 return avail;
956             } else if(s->circular_buffer_error){
957                 int err = s->circular_buffer_error;
958                 pthread_mutex_unlock(&s->mutex);
959                 return err;
960             } else if(nonblock) {
961                 pthread_mutex_unlock(&s->mutex);
962                 return AVERROR(EAGAIN);
963             }
964             else {
965                 /* FIXME: using the monotonic clock would be better,
966                    but it does not exist on all supported platforms. */
967                 int64_t t = av_gettime() + 100000;
968                 struct timespec tv = { .tv_sec  =  t / 1000000,
969                                        .tv_nsec = (t % 1000000) * 1000 };
970                 if (pthread_cond_timedwait(&s->cond, &s->mutex, &tv) < 0) {
971                     pthread_mutex_unlock(&s->mutex);
972                     return AVERROR(errno == ETIMEDOUT ? EAGAIN : errno);
973                 }
974                 nonblock = 1;
975             }
976         } while( 1);
977     }
978 #endif
979
980     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
981         ret = ff_network_wait_fd(s->udp_fd, 0);
982         if (ret < 0)
983             return ret;
984     }
985     ret = recvfrom(s->udp_fd, buf, size, 0, (struct sockaddr *)&addr, &addr_len);
986     if (ret < 0)
987         return ff_neterrno();
988     if (ff_ip_check_source_lists(&addr, &s->filters))
989         return AVERROR(EINTR);
990     return ret;
991 }
992
993 static int udp_write(URLContext *h, const uint8_t *buf, int size)
994 {
995     UDPContext *s = h->priv_data;
996     int ret;
997
998 #if HAVE_PTHREAD_CANCEL
999     if (s->fifo) {
1000         uint8_t tmp[4];
1001
1002         pthread_mutex_lock(&s->mutex);
1003
1004         /*
1005           Return error if last tx failed.
1006           Here we can't know on which packet error was, but it needs to know that error exists.
1007         */
1008         if (s->circular_buffer_error<0) {
1009             int err=s->circular_buffer_error;
1010             pthread_mutex_unlock(&s->mutex);
1011             return err;
1012         }
1013
1014         if(av_fifo_space(s->fifo) < size + 4) {
1015             /* What about a partial packet tx ? */
1016             pthread_mutex_unlock(&s->mutex);
1017             return AVERROR(ENOMEM);
1018         }
1019         AV_WL32(tmp, size);
1020         av_fifo_generic_write(s->fifo, tmp, 4, NULL); /* size of packet */
1021         av_fifo_generic_write(s->fifo, (uint8_t *)buf, size, NULL); /* the data */
1022         pthread_cond_signal(&s->cond);
1023         pthread_mutex_unlock(&s->mutex);
1024         return size;
1025     }
1026 #endif
1027     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
1028         ret = ff_network_wait_fd(s->udp_fd, 1);
1029         if (ret < 0)
1030             return ret;
1031     }
1032
1033     if (!s->is_connected) {
1034         ret = sendto (s->udp_fd, buf, size, 0,
1035                       (struct sockaddr *) &s->dest_addr,
1036                       s->dest_addr_len);
1037     } else
1038         ret = send(s->udp_fd, buf, size, 0);
1039
1040     return ret < 0 ? ff_neterrno() : ret;
1041 }
1042
1043 static int udp_close(URLContext *h)
1044 {
1045     UDPContext *s = h->priv_data;
1046
1047 #if HAVE_PTHREAD_CANCEL
1048     // Request close once writing is finished
1049     if (s->thread_started && !(h->flags & AVIO_FLAG_READ)) {
1050         pthread_mutex_lock(&s->mutex);
1051         s->close_req = 1;
1052         pthread_cond_signal(&s->cond);
1053         pthread_mutex_unlock(&s->mutex);
1054     }
1055 #endif
1056
1057     if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
1058         udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr,(struct sockaddr *)&s->local_addr_storage);
1059 #if HAVE_PTHREAD_CANCEL
1060     if (s->thread_started) {
1061         int ret;
1062         // Cancel only read, as write has been signaled as success to the user
1063         if (h->flags & AVIO_FLAG_READ)
1064             pthread_cancel(s->circular_buffer_thread);
1065         ret = pthread_join(s->circular_buffer_thread, NULL);
1066         if (ret != 0)
1067             av_log(h, AV_LOG_ERROR, "pthread_join(): %s\n", strerror(ret));
1068         pthread_mutex_destroy(&s->mutex);
1069         pthread_cond_destroy(&s->cond);
1070     }
1071 #endif
1072     closesocket(s->udp_fd);
1073     av_fifo_freep(&s->fifo);
1074     ff_ip_reset_filters(&s->filters);
1075     return 0;
1076 }
1077
1078 const URLProtocol ff_udp_protocol = {
1079     .name                = "udp",
1080     .url_open            = udp_open,
1081     .url_read            = udp_read,
1082     .url_write           = udp_write,
1083     .url_close           = udp_close,
1084     .url_get_file_handle = udp_get_file_handle,
1085     .priv_data_size      = sizeof(UDPContext),
1086     .priv_data_class     = &udp_class,
1087     .flags               = URL_PROTOCOL_FLAG_NETWORK,
1088 };
1089
1090 const URLProtocol ff_udplite_protocol = {
1091     .name                = "udplite",
1092     .url_open            = udplite_open,
1093     .url_read            = udp_read,
1094     .url_write           = udp_write,
1095     .url_close           = udp_close,
1096     .url_get_file_handle = udp_get_file_handle,
1097     .priv_data_size      = sizeof(UDPContext),
1098     .priv_data_class     = &udplite_context_class,
1099     .flags               = URL_PROTOCOL_FLAG_NETWORK,
1100 };