libavformat/tcp.c
171bbb03
 /*
  * TCP protocol
406792e7
  * Copyright (c) 2002 Fabrice Bellard
171bbb03
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
171bbb03
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
171bbb03
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
171bbb03
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
5509bffa
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
171bbb03
  */
 #include "avformat.h"
21198155
 #include "libavutil/avassert.h"
3d42d493
 #include "libavutil/parseutils.h"
2e009c60
 #include "libavutil/opt.h"
9cf788ec
 #include "libavutil/time.h"
1d4579e3
 
e4a9e3cc
 #include "internal.h"
42572ef5
 #include "network.h"
087b3272
 #include "os_support.h"
5cec8971
 #include "url.h"
a8475bbd
 #if HAVE_POLL_H
 #include <poll.h>
6ad1c9c9
 #endif
171bbb03
 
 typedef struct TCPContext {
2e009c60
     const AVClass *class;
171bbb03
     int fd;
2e009c60
     int listen;
68b7b534
     int open_timeout;
2e009c60
     int rw_timeout;
     int listen_timeout;
84110f4f
     int recv_buffer_size;
     int send_buffer_size;
171bbb03
 } TCPContext;
 
2e009c60
 #define OFFSET(x) offsetof(TCPContext, x)
 #define D AV_OPT_FLAG_DECODING_PARAM
 #define E AV_OPT_FLAG_ENCODING_PARAM
 static const AVOption options[] = {
75235a25
     { "listen",          "Listen for incoming connections",  OFFSET(listen),         AV_OPT_TYPE_INT, { .i64 = 0 },     0,       2,       .flags = D|E },
1f4bce89
     { "timeout",     "set timeout (in microseconds) of socket I/O operations", OFFSET(rw_timeout),     AV_OPT_TYPE_INT, { .i64 = -1 },         -1, INT_MAX, .flags = D|E },
c5c4e583
     { "listen_timeout",  "Connection awaiting timeout (in milliseconds)",      OFFSET(listen_timeout), AV_OPT_TYPE_INT, { .i64 = -1 },         -1, INT_MAX, .flags = D|E },
84110f4f
     { "send_buffer_size", "Socket send buffer size (in bytes)",                OFFSET(send_buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 },         -1, INT_MAX, .flags = D|E },
     { "recv_buffer_size", "Socket receive buffer size (in bytes)",             OFFSET(recv_buffer_size), AV_OPT_TYPE_INT, { .i64 = -1 },         -1, INT_MAX, .flags = D|E },
1d4579e3
     { NULL }
2e009c60
 };
 
1d4579e3
 static const AVClass tcp_class = {
2e009c60
     .class_name = "tcp",
     .item_name  = av_default_item_name,
     .option     = options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
171bbb03
 /* return non zero if error */
 static int tcp_open(URLContext *h, const char *uri, int flags)
 {
a92be9b8
     struct addrinfo hints = { 0 }, *ai, *cur_ai;
171bbb03
     int port, fd = -1;
7e580505
     TCPContext *s = h->priv_data;
3d42d493
     const char *p;
     char buf[256];
a8475bbd
     int ret;
f23a9759
     char hostname[1024],proto[1024],path[1024];
fdcdd539
     char portstr[10];
68b7b534
     s->open_timeout = 5000000;
6ba5cbc6
 
f3bfe388
     av_url_split(proto, sizeof(proto), NULL, 0, hostname, sizeof(hostname),
a3303add
         &port, path, sizeof(path), uri);
f9a9a148
     if (strcmp(proto, "tcp"))
8b9af28d
         return AVERROR(EINVAL);
f9a9a148
     if (port <= 0 || port >= 65536) {
         av_log(h, AV_LOG_ERROR, "Port missing in uri\n");
         return AVERROR(EINVAL);
     }
3d42d493
     p = strchr(uri, '?');
     if (p) {
702d9a23
         if (av_find_info_tag(buf, sizeof(buf), "listen", p)) {
             char *endptr = NULL;
             s->listen = strtol(buf, &endptr, 10);
             /* assume if no digits were found it is a request to enable it */
             if (buf == endptr)
                 s->listen = 1;
         }
ebb6b27a
         if (av_find_info_tag(buf, sizeof(buf), "timeout", p)) {
2e009c60
             s->rw_timeout = strtol(buf, NULL, 10);
ebb6b27a
         }
5427df01
         if (av_find_info_tag(buf, sizeof(buf), "listen_timeout", p)) {
2e009c60
             s->listen_timeout = strtol(buf, NULL, 10);
5427df01
         }
3d42d493
     }
68b7b534
     if (s->rw_timeout >= 0) {
         s->open_timeout =
         h->rw_timeout   = s->rw_timeout;
     }
88248b76
     hints.ai_family = AF_UNSPEC;
fdcdd539
     hints.ai_socktype = SOCK_STREAM;
     snprintf(portstr, sizeof(portstr), "%d", port);
2e009c60
     if (s->listen)
58f3e09e
         hints.ai_flags |= AI_PASSIVE;
ef882e46
     if (!hostname[0])
         ret = getaddrinfo(NULL, portstr, &hints, &ai);
     else
         ret = getaddrinfo(hostname, portstr, &hints, &ai);
63638a3c
     if (ret) {
c60112f2
         av_log(h, AV_LOG_ERROR,
63638a3c
                "Failed to resolve hostname %s: %s\n",
                hostname, gai_strerror(ret));
8b9af28d
         return AVERROR(EIO);
63638a3c
     }
171bbb03
 
fdcdd539
     cur_ai = ai;
 
  restart:
c6bc823e
 #if HAVE_STRUCT_SOCKADDR_IN6
c0f6eff6
     // workaround for IOS9 getaddrinfo in IPv6 only network use hardcode IPv4 address can not resolve port number.
     if (cur_ai->ai_family == AF_INET6){
         struct sockaddr_in6 * sockaddr_v6 = (struct sockaddr_in6 *)cur_ai->ai_addr;
         if (!sockaddr_v6->sin6_port){
             sockaddr_v6->sin6_port = htons(port);
         }
     }
c6bc823e
 #endif
c0f6eff6
 
bb937825
     fd = ff_socket(cur_ai->ai_family,
                    cur_ai->ai_socktype,
                    cur_ai->ai_protocol);
28306e6d
     if (fd < 0) {
         ret = ff_neterrno();
fdcdd539
         goto fail;
28306e6d
     }
115329f1
 
f3778108
     /* Set the socket's send or receive buffer sizes, if specified.
        If unspecified or setting fails, system default is used. */
     if (s->recv_buffer_size > 0) {
         setsockopt (fd, SOL_SOCKET, SO_RCVBUF, &s->recv_buffer_size, sizeof (s->recv_buffer_size));
     }
     if (s->send_buffer_size > 0) {
         setsockopt (fd, SOL_SOCKET, SO_SNDBUF, &s->send_buffer_size, sizeof (s->send_buffer_size));
     }
 
75235a25
     if (s->listen == 2) {
         // multi-client
         if ((ret = ff_listen(fd, cur_ai->ai_addr, cur_ai->ai_addrlen)) < 0)
             goto fail1;
     } else if (s->listen == 1) {
         // single client
6a8d58d6
         if ((ret = ff_listen_bind(fd, cur_ai->ai_addr, cur_ai->ai_addrlen,
                                   s->listen_timeout, h)) < 0)
2dbb8cc6
             goto fail1;
6a8d58d6
         // Socket descriptor already closed here. Safe to overwrite to client one.
         fd = ret;
3d42d493
     } else {
f849a77e
         if ((ret = ff_listen_connect(fd, cur_ai->ai_addr, cur_ai->ai_addrlen,
22fbc7f8
                                      s->open_timeout / 1000, h, !!cur_ai->ai_next)) < 0) {
3d42d493
 
f849a77e
             if (ret == AVERROR_EXIT)
1aa58c64
                 goto fail1;
f849a77e
             else
                 goto fail;
63638a3c
         }
09787fb8
     }
f849a77e
 
47f944a2
     h->is_streamed = 1;
171bbb03
     s->fd = fd;
84110f4f
 
fdcdd539
     freeaddrinfo(ai);
171bbb03
     return 0;
 
  fail:
fdcdd539
     if (cur_ai->ai_next) {
         /* Retry with the next sockaddr */
         cur_ai = cur_ai->ai_next;
         if (fd >= 0)
             closesocket(fd);
28306e6d
         ret = 0;
fdcdd539
         goto restart;
     }
09787fb8
  fail1:
171bbb03
     if (fd >= 0)
e9d511dc
         closesocket(fd);
fdcdd539
     freeaddrinfo(ai);
09787fb8
     return ret;
171bbb03
 }
 
21198155
 static int tcp_accept(URLContext *s, URLContext **c)
 {
     TCPContext *sc = s->priv_data;
     TCPContext *cc;
     int ret;
     av_assert0(sc->listen);
     if ((ret = ffurl_alloc(c, s->filename, s->flags, &s->interrupt_callback)) < 0)
         return ret;
     cc = (*c)->priv_data;
     ret = ff_accept(sc->fd, sc->listen_timeout, s);
     if (ret < 0)
54b6bef6
         return ret;
21198155
     cc->fd = ret;
     return 0;
 }
 
0c1a9eda
 static int tcp_read(URLContext *h, uint8_t *buf, int size)
171bbb03
 {
     TCPContext *s = h->priv_data;
ad3cffb6
     int ret;
171bbb03
 
f87b1b37
     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
949acefc
         ret = ff_network_wait_fd_timeout(s->fd, 0, h->rw_timeout, &h->interrupt_callback);
         if (ret)
51b317d2
             return ret;
171bbb03
     }
ad3cffb6
     ret = recv(s->fd, buf, size, 0);
     return ret < 0 ? ff_neterrno() : ret;
171bbb03
 }
 
27241cbf
 static int tcp_write(URLContext *h, const uint8_t *buf, int size)
171bbb03
 {
     TCPContext *s = h->priv_data;
ad3cffb6
     int ret;
171bbb03
 
f87b1b37
     if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
949acefc
         ret = ff_network_wait_fd_timeout(s->fd, 1, h->rw_timeout, &h->interrupt_callback);
         if (ret)
51b317d2
             return ret;
171bbb03
     }
6ee1cb57
     ret = send(s->fd, buf, size, MSG_NOSIGNAL);
ad3cffb6
     return ret < 0 ? ff_neterrno() : ret;
171bbb03
 }
 
4a9ca935
 static int tcp_shutdown(URLContext *h, int flags)
 {
     TCPContext *s = h->priv_data;
     int how;
 
     if (flags & AVIO_FLAG_WRITE && flags & AVIO_FLAG_READ) {
         how = SHUT_RDWR;
     } else if (flags & AVIO_FLAG_WRITE) {
         how = SHUT_WR;
     } else {
         how = SHUT_RD;
     }
 
     return shutdown(s->fd, how);
 }
 
171bbb03
 static int tcp_close(URLContext *h)
 {
     TCPContext *s = h->priv_data;
9ddd71fc
     closesocket(s->fd);
171bbb03
     return 0;
 }
 
f0a80394
 static int tcp_get_file_handle(URLContext *h)
 {
     TCPContext *s = h->priv_data;
     return s->fd;
 }
 
8c8e5d52
 static int tcp_get_window_size(URLContext *h)
 {
     TCPContext *s = h->priv_data;
     int avail;
     int avail_len = sizeof(avail);
 
 #if HAVE_WINSOCK2_H
     /* SO_RCVBUF with winsock only reports the actual TCP window size when
     auto-tuning has been disabled via setting SO_RCVBUF */
     if (s->recv_buffer_size < 0) {
         return AVERROR(ENOSYS);
     }
 #endif
 
     if (getsockopt(s->fd, SOL_SOCKET, SO_RCVBUF, &avail, &avail_len)) {
         return ff_neterrno();
     }
     return avail;
 }
 
2758cded
 const URLProtocol ff_tcp_protocol = {
f35ff97f
     .name                = "tcp",
     .url_open            = tcp_open,
21198155
     .url_accept          = tcp_accept,
f35ff97f
     .url_read            = tcp_read,
     .url_write           = tcp_write,
     .url_close           = tcp_close,
f0a80394
     .url_get_file_handle = tcp_get_file_handle,
8c8e5d52
     .url_get_short_seek  = tcp_get_window_size,
4a9ca935
     .url_shutdown        = tcp_shutdown,
7e580505
     .priv_data_size      = sizeof(TCPContext),
32b83aee
     .flags               = URL_PROTOCOL_FLAG_NETWORK,
1d4579e3
     .priv_data_class     = &tcp_class,
171bbb03
 };