libavformat/udp.c

   1 /*
   2  * UDP prototype streaming system
   3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; 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 _BSD_SOURCE     /* Needed for using struct ip_mreq with recent glibc */
  28
  29 #include "avformat.h"
  30 #include "avio_internal.h"
  31 #include "libavutil/parseutils.h"
  32 #include <unistd.h>
  33 #include "internal.h"
  34 #include "network.h"
  35 #include "os_support.h"
  36 #include "url.h"
  37 #include <sys/time.h>
  38
  39 #ifndef IPV6_ADD_MEMBERSHIP
  40 #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
  41 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
  42 #endif
  43
  44 typedef struct {
  45     int udp_fd;
  46     int ttl;
  47     int buffer_size;
  48     int is_multicast;
  49     int local_port;
  50     int reuse_socket;
  51     struct sockaddr_storage dest_addr;
  52     int dest_addr_len;
  53     int is_connected;
  54 } UDPContext;
  55
  56 #define UDP_TX_BUF_SIZE 32768
  57 #define UDP_MAX_PKT_SIZE 65536
  58
  59 static int udp_set_multicast_ttl(int sockfd, int mcastTTL,
  60                                  struct sockaddr *addr)
  61 {
  62 #ifdef IP_MULTICAST_TTL
  63     if (addr->sa_family == AF_INET) {
  64         if (setsockopt(sockfd, IPPROTO_IP, IP_MULTICAST_TTL, &mcastTTL, sizeof(mcastTTL)) < 0) {
  65             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_MULTICAST_TTL): %s\n", strerror(errno));
  66             return -1;
  67         }
  68     }
  69 #endif
  70 #if defined(IPPROTO_IPV6) && defined(IPV6_MULTICAST_HOPS)
  71     if (addr->sa_family == AF_INET6) {
  72         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &mcastTTL, sizeof(mcastTTL)) < 0) {
  73             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_MULTICAST_HOPS): %s\n", strerror(errno));
  74             return -1;
  75         }
  76     }
  77 #endif
  78     return 0;
  79 }
  80
  81 static int udp_join_multicast_group(int sockfd, struct sockaddr *addr)
  82 {
  83 #ifdef IP_ADD_MEMBERSHIP
  84     if (addr->sa_family == AF_INET) {
  85         struct ip_mreq mreq;
  86
  87         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
  88         mreq.imr_interface.s_addr= INADDR_ANY;
  89         if (setsockopt(sockfd, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
  90             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_ADD_MEMBERSHIP): %s\n", strerror(errno));
  91             return -1;
  92         }
  93     }
  94 #endif
  95 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
  96     if (addr->sa_family == AF_INET6) {
  97         struct ipv6_mreq mreq6;
  98
  99         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
 100         mreq6.ipv6mr_interface= 0;
 101         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
 102             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_ADD_MEMBERSHIP): %s\n", strerror(errno));
 103             return -1;
 104         }
 105     }
 106 #endif
 107     return 0;
 108 }
 109
 110 static int udp_leave_multicast_group(int sockfd, struct sockaddr *addr)
 111 {
 112 #ifdef IP_DROP_MEMBERSHIP
 113     if (addr->sa_family == AF_INET) {
 114         struct ip_mreq mreq;
 115
 116         mreq.imr_multiaddr.s_addr = ((struct sockaddr_in *)addr)->sin_addr.s_addr;
 117         mreq.imr_interface.s_addr= INADDR_ANY;
 118         if (setsockopt(sockfd, IPPROTO_IP, IP_DROP_MEMBERSHIP, (const void *)&mreq, sizeof(mreq)) < 0) {
 119             av_log(NULL, AV_LOG_ERROR, "setsockopt(IP_DROP_MEMBERSHIP): %s\n", strerror(errno));
 120             return -1;
 121         }
 122     }
 123 #endif
 124 #if HAVE_STRUCT_IPV6_MREQ && defined(IPPROTO_IPV6)
 125     if (addr->sa_family == AF_INET6) {
 126         struct ipv6_mreq mreq6;
 127
 128         memcpy(&mreq6.ipv6mr_multiaddr, &(((struct sockaddr_in6 *)addr)->sin6_addr), sizeof(struct in6_addr));
 129         mreq6.ipv6mr_interface= 0;
 130         if (setsockopt(sockfd, IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, &mreq6, sizeof(mreq6)) < 0) {
 131             av_log(NULL, AV_LOG_ERROR, "setsockopt(IPV6_DROP_MEMBERSHIP): %s\n", strerror(errno));
 132             return -1;
 133         }
 134     }
 135 #endif
 136     return 0;
 137 }
 138
 139 static struct addrinfo* udp_resolve_host(const char *hostname, int port,
 140                                          int type, int family, int flags)
 141 {
 142     struct addrinfo hints, *res = 0;
 143     int error;
 144     char sport[16];
 145     const char *node = 0, *service = "0";
 146
 147     if (port > 0) {
 148         snprintf(sport, sizeof(sport), "%d", port);
 149         service = sport;
 150     }
 151     if ((hostname) && (hostname[0] != '\0') && (hostname[0] != '?')) {
 152         node = hostname;
 153     }
 154     memset(&hints, 0, sizeof(hints));
 155     hints.ai_socktype = type;
 156     hints.ai_family   = family;
 157     hints.ai_flags = flags;
 158     if ((error = getaddrinfo(node, service, &hints, &res))) {
 159         res = NULL;
 160         av_log(NULL, AV_LOG_ERROR, "udp_resolve_host: %s\n", gai_strerror(error));
 161     }
 162
 163     return res;
 164 }
 165
 166 static int udp_set_url(struct sockaddr_storage *addr,
 167                        const char *hostname, int port)
 168 {
 169     struct addrinfo *res0;
 170     int addr_len;
 171
 172     res0 = udp_resolve_host(hostname, port, SOCK_DGRAM, AF_UNSPEC, 0);
 173     if (res0 == 0) return AVERROR(EIO);
 174     memcpy(addr, res0->ai_addr, res0->ai_addrlen);
 175     addr_len = res0->ai_addrlen;
 176     freeaddrinfo(res0);
 177
 178     return addr_len;
 179 }
 180
 181 static int udp_socket_create(UDPContext *s,
 182                              struct sockaddr_storage *addr, int *addr_len)
 183 {
 184     int udp_fd = -1;
 185     struct addrinfo *res0 = NULL, *res = NULL;
 186     int family = AF_UNSPEC;
 187
 188     if (((struct sockaddr *) &s->dest_addr)->sa_family)
 189         family = ((struct sockaddr *) &s->dest_addr)->sa_family;
 190     res0 = udp_resolve_host(0, s->local_port, SOCK_DGRAM, family, AI_PASSIVE);
 191     if (res0 == 0)
 192         goto fail;
 193     for (res = res0; res; res=res->ai_next) {
 194         udp_fd = socket(res->ai_family, SOCK_DGRAM, 0);
 195         if (udp_fd > 0) break;
 196         av_log(NULL, AV_LOG_ERROR, "socket: %s\n", strerror(errno));
 197     }
 198
 199     if (udp_fd < 0)
 200         goto fail;
 201
 202     memcpy(addr, res->ai_addr, res->ai_addrlen);
 203     *addr_len = res->ai_addrlen;
 204
 205     freeaddrinfo(res0);
 206
 207     return udp_fd;
 208
 209  fail:
 210     if (udp_fd >= 0)
 211         closesocket(udp_fd);
 212     if(res0)
 213         freeaddrinfo(res0);
 214     return -1;
 215 }
 216
 217 static int udp_port(struct sockaddr_storage *addr, int addr_len)
 218 {
 219     char sbuf[sizeof(int)*3+1];
 220
 221     if (getnameinfo((struct sockaddr *)addr, addr_len, NULL, 0,  sbuf, sizeof(sbuf), NI_NUMERICSERV) != 0) {
 222         av_log(NULL, AV_LOG_ERROR, "getnameinfo: %s\n", strerror(errno));
 223         return -1;
 224     }
 225
 226     return strtol(sbuf, NULL, 10);
 227 }
 228
 229
 230 /**
 231  * If no filename is given to av_open_input_file because you want to
 232  * get the local port first, then you must call this function to set
 233  * the remote server address.
 234  *
 235  * url syntax: udp://host:port[?option=val...]
 236  * option: 'ttl=n'       : set the ttl value (for multicast only)
 237  *         'localport=n' : set the local port
 238  *         'pkt_size=n'  : set max packet size
 239  *         'reuse=1'     : enable reusing the socket
 240  *
 241  * @param h media file context
 242  * @param uri of the remote server
 243  * @return zero if no error.
 244  */
 245 int ff_udp_set_remote_url(URLContext *h, const char *uri)
 246 {
 247     UDPContext *s = h->priv_data;
 248     char hostname[256], buf[10];
 249     int port;
 250     const char *p;
 251
 252     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
 253
 254     /* set the destination address */
 255     s->dest_addr_len = udp_set_url(&s->dest_addr, hostname, port);
 256     if (s->dest_addr_len < 0) {
 257         return AVERROR(EIO);
 258     }
 259     s->is_multicast = ff_is_multicast_address((struct sockaddr*) &s->dest_addr);
 260     p = strchr(uri, '?');
 261     if (p) {
 262         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
 263             int was_connected = s->is_connected;
 264             s->is_connected = strtol(buf, NULL, 10);
 265             if (s->is_connected && !was_connected) {
 266                 if (connect(s->udp_fd, (struct sockaddr *) &s->dest_addr,
 267                             s->dest_addr_len)) {
 268                     s->is_connected = 0;
 269                     av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
 270                     return AVERROR(EIO);
 271                 }
 272             }
 273         }
 274     }
 275
 276     return 0;
 277 }
 278
 279 /**
 280  * Return the local port used by the UDP connection
 281  * @param h media file context
 282  * @return the local port number
 283  */
 284 int ff_udp_get_local_port(URLContext *h)
 285 {
 286     UDPContext *s = h->priv_data;
 287     return s->local_port;
 288 }
 289
 290 /**
 291  * Return the udp file handle for select() usage to wait for several RTP
 292  * streams at the same time.
 293  * @param h media file context
 294  */
 295 static int udp_get_file_handle(URLContext *h)
 296 {
 297     UDPContext *s = h->priv_data;
 298     return s->udp_fd;
 299 }
 300
 301 /* put it in UDP context */
 302 /* return non zero if error */
 303 static int udp_open(URLContext *h, const char *uri, int flags)
 304 {
 305     char hostname[1024];
 306     int port, udp_fd = -1, tmp, bind_ret = -1;
 307     UDPContext *s = NULL;
 308     int is_output;
 309     const char *p;
 310     char buf[256];
 311     struct sockaddr_storage my_addr;
 312     int len;
 313     int reuse_specified = 0;
 314
 315     h->is_streamed = 1;
 316     h->max_packet_size = 1472;
 317
 318     is_output = !(flags & AVIO_FLAG_READ);
 319
 320     s = av_mallocz(sizeof(UDPContext));
 321     if (!s)
 322         return AVERROR(ENOMEM);
 323
 324     h->priv_data = s;
 325     s->ttl = 16;
 326     s->buffer_size = is_output ? UDP_TX_BUF_SIZE : UDP_MAX_PKT_SIZE;
 327
 328     p = strchr(uri, '?');
 329     if (p) {
 330         if (av_find_info_tag(buf, sizeof(buf), "reuse", p)) {
 331             char *endptr = NULL;
 332             s->reuse_socket = strtol(buf, &endptr, 10);
 333             /* assume if no digits were found it is a request to enable it */
 334             if (buf == endptr)
 335                 s->reuse_socket = 1;
 336             reuse_specified = 1;
 337         }
 338         if (av_find_info_tag(buf, sizeof(buf), "ttl", p)) {
 339             s->ttl = strtol(buf, NULL, 10);
 340         }
 341         if (av_find_info_tag(buf, sizeof(buf), "localport", p)) {
 342             s->local_port = strtol(buf, NULL, 10);
 343         }
 344         if (av_find_info_tag(buf, sizeof(buf), "pkt_size", p)) {
 345             h->max_packet_size = strtol(buf, NULL, 10);
 346         }
 347         if (av_find_info_tag(buf, sizeof(buf), "buffer_size", p)) {
 348             s->buffer_size = strtol(buf, NULL, 10);
 349         }
 350         if (av_find_info_tag(buf, sizeof(buf), "connect", p)) {
 351             s->is_connected = strtol(buf, NULL, 10);
 352         }
 353     }
 354
 355     /* fill the dest addr */
 356     av_url_split(NULL, 0, NULL, 0, hostname, sizeof(hostname), &port, NULL, 0, uri);
 357
 358     /* XXX: fix av_url_split */
 359     if (hostname[0] == '\0' || hostname[0] == '?') {
 360         /* only accepts null hostname if input */
 361         if (!(flags & AVIO_FLAG_READ))
 362             goto fail;
 363     } else {
 364         if (ff_udp_set_remote_url(h, uri) < 0)
 365             goto fail;
 366     }
 367
 368     if ((s->is_multicast || !s->local_port) && (h->flags & AVIO_FLAG_READ))
 369         s->local_port = port;
 370     udp_fd = udp_socket_create(s, &my_addr, &len);
 371     if (udp_fd < 0)
 372         goto fail;
 373
 374     /* Follow the requested reuse option, unless it's multicast in which
 375      * case enable reuse unless explicitely disabled.
 376      */
 377     if (s->reuse_socket || (s->is_multicast && !reuse_specified)) {
 378         s->reuse_socket = 1;
 379         if (setsockopt (udp_fd, SOL_SOCKET, SO_REUSEADDR, &(s->reuse_socket), sizeof(s->reuse_socket)) != 0)
 380             goto fail;
 381     }
 382
 383     /* the bind is needed to give a port to the socket now */
 384     /* if multicast, try the multicast address bind first */
 385     if (s->is_multicast && (h->flags & AVIO_FLAG_READ)) {
 386         bind_ret = bind(udp_fd,(struct sockaddr *)&s->dest_addr, len);
 387     }
 388     /* bind to the local address if not multicast or if the multicast
 389      * bind failed */
 390     if (bind_ret < 0 && bind(udp_fd,(struct sockaddr *)&my_addr, len) < 0)
 391         goto fail;
 392
 393     len = sizeof(my_addr);
 394     getsockname(udp_fd, (struct sockaddr *)&my_addr, &len);
 395     s->local_port = udp_port(&my_addr, len);
 396
 397     if (s->is_multicast) {
 398         if (!(h->flags & AVIO_FLAG_READ)) {
 399             /* output */
 400             if (udp_set_multicast_ttl(udp_fd, s->ttl, (struct sockaddr *)&s->dest_addr) < 0)
 401                 goto fail;
 402         } else {
 403             /* input */
 404             if (udp_join_multicast_group(udp_fd, (struct sockaddr *)&s->dest_addr) < 0)
 405                 goto fail;
 406         }
 407     }
 408
 409     if (is_output) {
 410         /* limit the tx buf size to limit latency */
 411         tmp = s->buffer_size;
 412         if (setsockopt(udp_fd, SOL_SOCKET, SO_SNDBUF, &tmp, sizeof(tmp)) < 0) {
 413             av_log(h, AV_LOG_ERROR, "setsockopt(SO_SNDBUF): %s\n", strerror(errno));
 414             goto fail;
 415         }
 416     } else {
 417         /* set udp recv buffer size to the largest possible udp packet size to
 418          * avoid losing data on OSes that set this too low by default. */
 419         tmp = s->buffer_size;
 420         if (setsockopt(udp_fd, SOL_SOCKET, SO_RCVBUF, &tmp, sizeof(tmp)) < 0) {
 421             av_log(h, AV_LOG_WARNING, "setsockopt(SO_RECVBUF): %s\n", strerror(errno));
 422         }
 423         /* make the socket non-blocking */
 424         ff_socket_nonblock(udp_fd, 1);
 425     }
 426     if (s->is_connected) {
 427         if (connect(udp_fd, (struct sockaddr *) &s->dest_addr, s->dest_addr_len)) {
 428             av_log(h, AV_LOG_ERROR, "connect: %s\n", strerror(errno));
 429             goto fail;
 430         }
 431     }
 432
 433     s->udp_fd = udp_fd;
 434     return 0;
 435  fail:
 436     if (udp_fd >= 0)
 437         closesocket(udp_fd);
 438     av_free(s);
 439     return AVERROR(EIO);
 440 }
 441
 442 static int udp_read(URLContext *h, uint8_t *buf, int size)
 443 {
 444     UDPContext *s = h->priv_data;
 445     int ret;
 446
 447     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
 448         ret = ff_network_wait_fd(s->udp_fd, 0);
 449         if (ret < 0)
 450             return ret;
 451     }
 452     ret = recv(s->udp_fd, buf, size, 0);
 453     return ret < 0 ? ff_neterrno() : ret;
 454 }
 455
 456 static int udp_write(URLContext *h, const uint8_t *buf, int size)
 457 {
 458     UDPContext *s = h->priv_data;
 459     int ret;
 460
 461     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
 462         ret = ff_network_wait_fd(s->udp_fd, 1);
 463         if (ret < 0)
 464             return ret;
 465     }
 466
 467     if (!s->is_connected) {
 468         ret = sendto (s->udp_fd, buf, size, 0,
 469                       (struct sockaddr *) &s->dest_addr,
 470                       s->dest_addr_len);
 471     } else
 472         ret = send(s->udp_fd, buf, size, 0);
 473
 474     return ret < 0 ? ff_neterrno() : ret;
 475 }
 476
 477 static int udp_close(URLContext *h)
 478 {
 479     UDPContext *s = h->priv_data;
 480
 481     if (s->is_multicast && (h->flags & AVIO_FLAG_READ))
 482         udp_leave_multicast_group(s->udp_fd, (struct sockaddr *)&s->dest_addr);
 483     closesocket(s->udp_fd);
 484     av_free(s);
 485     return 0;
 486 }
 487
 488 URLProtocol ff_udp_protocol = {
 489     .name                = "udp",
 490     .url_open            = udp_open,
 491     .url_read            = udp_read,
 492     .url_write           = udp_write,
 493     .url_close           = udp_close,
 494     .url_get_file_handle = udp_get_file_handle,
 495 };