2 * This file is part of FFmpeg.
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * Haivision Open SRT (Secure Reliable Transport) protocol
26 #include "libavutil/avassert.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/parseutils.h"
29 #include "libavutil/time.h"
34 #include "os_support.h"
39 SRT_MODE_LISTENER = 1,
40 SRT_MODE_RENDEZVOUS = 2
43 typedef struct SRTContext {
48 int64_t listen_timeout;
64 int64_t connect_timeout;
68 #define D AV_OPT_FLAG_DECODING_PARAM
69 #define E AV_OPT_FLAG_ENCODING_PARAM
70 #define OFFSET(x) offsetof(SRTContext, x)
71 static const AVOption libsrt_options[] = {
72 { "rw_timeout", "Timeout of socket I/O operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, INT64_MAX, .flags = D|E },
73 { "listen_timeout", "Connection awaiting timeout", OFFSET(listen_timeout), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, INT64_MAX, .flags = D|E },
74 { "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 },
75 { "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 },
76 { "maxbw", "Maximum bandwidth (bytes per second) that the connection can use", OFFSET(maxbw), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, INT64_MAX, .flags = D|E },
77 { "pbkeylen", "Crypto key len in bytes {16,24,32} Default: 16 (128-bit)", OFFSET(pbkeylen), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 32, .flags = D|E },
78 { "passphrase", "Crypto PBKDF2 Passphrase size[0,10..64] 0:disable crypto", OFFSET(passphrase), AV_OPT_TYPE_STRING, { .str = NULL }, .flags = D|E },
79 { "mss", "The Maximum Segment Size", OFFSET(mss), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1500, .flags = D|E },
80 { "ffs", "Flight flag size (window size) (in bytes)", OFFSET(ffs), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, .flags = D|E },
81 { "ipttl", "IP Time To Live", OFFSET(ipttl), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 255, .flags = D|E },
82 { "iptos", "IP Type of Service", OFFSET(iptos), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 255, .flags = D|E },
83 { "inputbw", "Estimated input stream rate", OFFSET(inputbw), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, INT64_MAX, .flags = D|E },
84 { "oheadbw", "MaxBW ceiling based on % over input stream rate", OFFSET(oheadbw), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 100, .flags = D|E },
85 { "tsbpddelay", "TsbPd receiver delay to absorb burst of missed packet retransmission", OFFSET(tsbpddelay), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, INT64_MAX, .flags = D|E },
86 { "tlpktdrop", "Enable receiver pkt drop", OFFSET(tlpktdrop), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, .flags = D|E },
87 { "nakreport", "Enable receiver to send periodic NAK reports", OFFSET(nakreport), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, .flags = D|E },
88 { "connect_timeout", "Connect timeout. Caller default: 3000, rendezvous (x 10)", OFFSET(connect_timeout), AV_OPT_TYPE_INT64, { .i64 = -1 }, -1, INT64_MAX, .flags = D|E },
89 { "mode", "Connection mode (caller, listener, rendezvous)", OFFSET(mode), AV_OPT_TYPE_INT, { .i64 = SRT_MODE_CALLER }, SRT_MODE_CALLER, SRT_MODE_RENDEZVOUS, .flags = D|E, "mode" },
90 { "caller", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = SRT_MODE_CALLER }, INT_MIN, INT_MAX, .flags = D|E, "mode" },
91 { "listener", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = SRT_MODE_LISTENER }, INT_MIN, INT_MAX, .flags = D|E, "mode" },
92 { "rendezvous", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = SRT_MODE_RENDEZVOUS }, INT_MIN, INT_MAX, .flags = D|E, "mode" },
96 static int libsrt_neterrno(URLContext *h)
98 int err = srt_getlasterror(NULL);
99 av_log(h, AV_LOG_ERROR, "%s\n", srt_getlasterror_str());
100 if (err == SRT_EASYNCRCV)
101 return AVERROR(EAGAIN);
102 return AVERROR_UNKNOWN;
105 static int libsrt_socket_nonblock(int socket, int enable)
107 int ret = srt_setsockopt(socket, 0, SRTO_SNDSYN, &enable, sizeof(enable));
110 return srt_setsockopt(socket, 0, SRTO_RCVSYN, &enable, sizeof(enable));
113 static int libsrt_network_wait_fd(URLContext *h, int eid, int fd, int write)
116 int modes = write ? SRT_EPOLL_OUT : SRT_EPOLL_IN;
119 if (srt_epoll_add_usock(eid, fd, &modes) < 0)
120 return libsrt_neterrno(h);
122 ret = srt_epoll_wait(eid, 0, 0, ready, &len, POLLING_TIME, 0, 0, 0, 0);
124 ret = srt_epoll_wait(eid, ready, &len, 0, 0, POLLING_TIME, 0, 0, 0, 0);
127 if (srt_getlasterror(NULL) == SRT_ETIMEOUT)
128 ret = AVERROR(EAGAIN);
130 ret = libsrt_neterrno(h);
134 if (srt_epoll_remove_usock(eid, fd) < 0)
135 return libsrt_neterrno(h);
139 /* TODO de-duplicate code from ff_network_wait_fd_timeout() */
141 static int libsrt_network_wait_fd_timeout(URLContext *h, int eid, int fd, int write, int64_t timeout, AVIOInterruptCB *int_cb)
144 int64_t wait_start = 0;
147 if (ff_check_interrupt(int_cb))
149 ret = libsrt_network_wait_fd(h, eid, fd, write);
150 if (ret != AVERROR(EAGAIN))
154 wait_start = av_gettime_relative();
155 else if (av_gettime_relative() - wait_start > timeout)
156 return AVERROR(ETIMEDOUT);
161 static int libsrt_listen(int eid, int fd, const struct sockaddr *addr, socklen_t addrlen, URLContext *h, int timeout)
165 if (srt_setsockopt(fd, SOL_SOCKET, SRTO_REUSEADDR, &reuse, sizeof(reuse))) {
166 av_log(h, AV_LOG_WARNING, "setsockopt(SRTO_REUSEADDR) failed\n");
168 ret = srt_bind(fd, addr, addrlen);
170 return libsrt_neterrno(h);
172 ret = srt_listen(fd, 1);
174 return libsrt_neterrno(h);
176 while ((ret = libsrt_network_wait_fd_timeout(h, eid, fd, 1, timeout, &h->interrupt_callback))) {
178 case AVERROR(ETIMEDOUT):
185 ret = srt_accept(fd, NULL, NULL);
187 return libsrt_neterrno(h);
188 if (libsrt_socket_nonblock(ret, 1) < 0)
189 av_log(h, AV_LOG_DEBUG, "libsrt_socket_nonblock failed\n");
194 static int libsrt_listen_connect(int eid, int fd, const struct sockaddr *addr, socklen_t addrlen, int timeout, URLContext *h, int will_try_next)
198 if (libsrt_socket_nonblock(fd, 1) < 0)
199 av_log(h, AV_LOG_DEBUG, "ff_socket_nonblock failed\n");
201 while ((ret = srt_connect(fd, addr, addrlen))) {
202 ret = libsrt_neterrno(h);
205 if (ff_check_interrupt(&h->interrupt_callback))
208 case AVERROR(EINPROGRESS):
209 case AVERROR(EAGAIN):
210 ret = libsrt_network_wait_fd_timeout(h, eid, fd, 1, timeout, &h->interrupt_callback);
213 ret = srt_getlasterror(NULL);
214 srt_clearlasterror();
218 av_strerror(ret, buf, sizeof(buf));
220 av_log(h, AV_LOG_WARNING,
221 "Connection to %s failed (%s), trying next address\n",
224 av_log(h, AV_LOG_ERROR, "Connection to %s failed: %s\n",
234 static int libsrt_setsockopt(URLContext *h, int fd, SRT_SOCKOPT optname, const char * optnamestr, const void * optval, int optlen)
236 if (srt_setsockopt(fd, 0, optname, optval, optlen) < 0) {
237 av_log(h, AV_LOG_ERROR, "failed to set option %s on socket: %s\n", optnamestr, srt_getlasterror_str());
243 /* - The "POST" options can be altered any time on a connected socket.
244 They MAY have also some meaning when set prior to connecting; such
245 option is SRTO_RCVSYN, which makes connect/accept call asynchronous.
246 Because of that this option is treated special way in this app. */
247 static int libsrt_set_options_post(URLContext *h, int fd)
249 SRTContext *s = h->priv_data;
251 if ((s->inputbw >= 0 && libsrt_setsockopt(h, fd, SRTO_INPUTBW, "SRTO_INPUTBW", &s->inputbw, sizeof(s->inputbw)) < 0) ||
252 (s->oheadbw >= 0 && libsrt_setsockopt(h, fd, SRTO_OHEADBW, "SRTO_OHEADBW", &s->oheadbw, sizeof(s->oheadbw)) < 0)) {
258 /* - The "PRE" options must be set prior to connecting and can't be altered
259 on a connected socket, however if set on a listening socket, they are
260 derived by accept-ed socket. */
261 static int libsrt_set_options_pre(URLContext *h, int fd)
263 SRTContext *s = h->priv_data;
265 int tsbpddelay = s->tsbpddelay / 1000;
266 int connect_timeout = s->connect_timeout;
268 if ((s->mode == SRT_MODE_RENDEZVOUS && libsrt_setsockopt(h, fd, SRTO_RENDEZVOUS, "SRTO_RENDEZVOUS", &yes, sizeof(yes)) < 0) ||
269 (s->maxbw >= 0 && libsrt_setsockopt(h, fd, SRTO_MAXBW, "SRTO_MAXBW", &s->maxbw, sizeof(s->maxbw)) < 0) ||
270 (s->pbkeylen >= 0 && libsrt_setsockopt(h, fd, SRTO_PBKEYLEN, "SRTO_PBKEYLEN", &s->pbkeylen, sizeof(s->pbkeylen)) < 0) ||
271 (s->passphrase && libsrt_setsockopt(h, fd, SRTO_PASSPHRASE, "SRTO_PASSPHRASE", &s->passphrase, sizeof(s->passphrase)) < 0) ||
272 (s->mss >= 0 && libsrt_setsockopt(h, fd, SRTO_MSS, "SRTO_MMS", &s->mss, sizeof(s->mss)) < 0) ||
273 (s->ffs >= 0 && libsrt_setsockopt(h, fd, SRTO_FC, "SRTO_FC", &s->ffs, sizeof(s->ffs)) < 0) ||
274 (s->ipttl >= 0 && libsrt_setsockopt(h, fd, SRTO_IPTTL, "SRTO_UPTTL", &s->ipttl, sizeof(s->ipttl)) < 0) ||
275 (s->iptos >= 0 && libsrt_setsockopt(h, fd, SRTO_IPTOS, "SRTO_IPTOS", &s->iptos, sizeof(s->iptos)) < 0) ||
276 (tsbpddelay >= 0 && libsrt_setsockopt(h, fd, SRTO_TSBPDDELAY, "SRTO_TSBPDELAY", &tsbpddelay, sizeof(tsbpddelay)) < 0) ||
277 (s->tlpktdrop >= 0 && libsrt_setsockopt(h, fd, SRTO_TLPKTDROP, "SRTO_TLPKDROP", &s->tlpktdrop, sizeof(s->tlpktdrop)) < 0) ||
278 (s->nakreport >= 0 && libsrt_setsockopt(h, fd, SRTO_NAKREPORT, "SRTO_NAKREPORT", &s->nakreport, sizeof(s->nakreport)) < 0) ||
279 (connect_timeout >= 0 && libsrt_setsockopt(h, fd, SRTO_CONNTIMEO, "SRTO_CONNTIMEO", &connect_timeout, sizeof(connect_timeout)) <0 )) {
286 static int libsrt_setup(URLContext *h, const char *uri, int flags)
288 struct addrinfo hints = { 0 }, *ai, *cur_ai;
290 SRTContext *s = h->priv_data;
294 char hostname[1024],proto[1024],path[1024];
296 int open_timeout = 5000000;
299 eid = srt_epoll_create();
301 return libsrt_neterrno(h);
304 av_url_split(proto, sizeof(proto), NULL, 0, hostname, sizeof(hostname),
305 &port, path, sizeof(path), uri);
306 if (strcmp(proto, "srt"))
307 return AVERROR(EINVAL);
308 if (port <= 0 || port >= 65536) {
309 av_log(h, AV_LOG_ERROR, "Port missing in uri\n");
310 return AVERROR(EINVAL);
312 p = strchr(uri, '?');
314 if (av_find_info_tag(buf, sizeof(buf), "timeout", p)) {
315 s->rw_timeout = strtol(buf, NULL, 10);
317 if (av_find_info_tag(buf, sizeof(buf), "listen_timeout", p)) {
318 s->listen_timeout = strtol(buf, NULL, 10);
321 if (s->rw_timeout >= 0) {
322 open_timeout = h->rw_timeout = s->rw_timeout;
324 hints.ai_family = AF_UNSPEC;
325 hints.ai_socktype = SOCK_DGRAM;
326 snprintf(portstr, sizeof(portstr), "%d", port);
327 if (s->mode == SRT_MODE_LISTENER)
328 hints.ai_flags |= AI_PASSIVE;
329 ret = getaddrinfo(hostname[0] ? hostname : NULL, portstr, &hints, &ai);
331 av_log(h, AV_LOG_ERROR,
332 "Failed to resolve hostname %s: %s\n",
333 hostname, gai_strerror(ret));
341 fd = srt_socket(cur_ai->ai_family, cur_ai->ai_socktype, 0);
343 ret = libsrt_neterrno(h);
347 if ((ret = libsrt_set_options_pre(h, fd)) < 0) {
351 /* Set the socket's send or receive buffer sizes, if specified.
352 If unspecified or setting fails, system default is used. */
353 if (s->recv_buffer_size > 0) {
354 srt_setsockopt(fd, SOL_SOCKET, SRTO_UDP_RCVBUF, &s->recv_buffer_size, sizeof (s->recv_buffer_size));
356 if (s->send_buffer_size > 0) {
357 srt_setsockopt(fd, SOL_SOCKET, SRTO_UDP_SNDBUF, &s->send_buffer_size, sizeof (s->send_buffer_size));
359 if (s->mode == SRT_MODE_LISTENER) {
361 if ((ret = libsrt_listen(s->eid, fd, cur_ai->ai_addr, cur_ai->ai_addrlen, h, open_timeout / 1000)) < 0)
365 if (s->mode == SRT_MODE_RENDEZVOUS) {
366 ret = srt_bind(fd, cur_ai->ai_addr, cur_ai->ai_addrlen);
371 if ((ret = libsrt_listen_connect(s->eid, fd, cur_ai->ai_addr, cur_ai->ai_addrlen,
372 open_timeout / 1000, h, !!cur_ai->ai_next)) < 0) {
373 if (ret == AVERROR_EXIT)
379 if ((ret = libsrt_set_options_post(h, fd)) < 0) {
390 if (cur_ai->ai_next) {
391 /* Retry with the next sockaddr */
392 cur_ai = cur_ai->ai_next;
405 static int libsrt_open(URLContext *h, const char *uri, int flags)
407 SRTContext *s = h->priv_data;
411 if (srt_startup() < 0) {
412 return AVERROR_UNKNOWN;
415 /* SRT options (srt/srt.h) */
416 p = strchr(uri, '?');
418 if (av_find_info_tag(buf, sizeof(buf), "maxbw", p)) {
419 s->maxbw = strtoll(buf, NULL, 0);
421 if (av_find_info_tag(buf, sizeof(buf), "pbkeylen", p)) {
422 s->pbkeylen = strtol(buf, NULL, 10);
424 if (av_find_info_tag(buf, sizeof(buf), "passphrase", p)) {
425 s->passphrase = av_strndup(buf, strlen(buf));
427 if (av_find_info_tag(buf, sizeof(buf), "mss", p)) {
428 s->mss = strtol(buf, NULL, 10);
430 if (av_find_info_tag(buf, sizeof(buf), "ffs", p)) {
431 s->ffs = strtol(buf, NULL, 10);
433 if (av_find_info_tag(buf, sizeof(buf), "ipttl", p)) {
434 s->ipttl = strtol(buf, NULL, 10);
436 if (av_find_info_tag(buf, sizeof(buf), "iptos", p)) {
437 s->iptos = strtol(buf, NULL, 10);
439 if (av_find_info_tag(buf, sizeof(buf), "inputbw", p)) {
440 s->inputbw = strtoll(buf, NULL, 10);
442 if (av_find_info_tag(buf, sizeof(buf), "oheadbw", p)) {
443 s->oheadbw = strtoll(buf, NULL, 10);
445 if (av_find_info_tag(buf, sizeof(buf), "tsbpddelay", p)) {
446 s->tsbpddelay = strtol(buf, NULL, 10);
448 if (av_find_info_tag(buf, sizeof(buf), "tlpktdrop", p)) {
449 s->tlpktdrop = strtol(buf, NULL, 10);
451 if (av_find_info_tag(buf, sizeof(buf), "nakreport", p)) {
452 s->nakreport = strtol(buf, NULL, 10);
454 if (av_find_info_tag(buf, sizeof(buf), "connect_timeout", p)) {
455 s->connect_timeout = strtol(buf, NULL, 10);
457 if (av_find_info_tag(buf, sizeof(buf), "mode", p)) {
458 if (!strcmp(buf, "caller")) {
459 s->mode = SRT_MODE_CALLER;
460 } else if (!strcmp(buf, "listener")) {
461 s->mode = SRT_MODE_LISTENER;
462 } else if (!strcmp(buf, "rendezvous")) {
463 s->mode = SRT_MODE_RENDEZVOUS;
469 return libsrt_setup(h, uri, flags);
472 static int libsrt_read(URLContext *h, uint8_t *buf, int size)
474 SRTContext *s = h->priv_data;
477 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
478 ret = libsrt_network_wait_fd_timeout(h, s->eid, s->fd, 0, h->rw_timeout, &h->interrupt_callback);
483 ret = srt_recvmsg(s->fd, buf, size);
485 ret = libsrt_neterrno(h);
491 static int libsrt_write(URLContext *h, const uint8_t *buf, int size)
493 SRTContext *s = h->priv_data;
496 if (!(h->flags & AVIO_FLAG_NONBLOCK)) {
497 ret = libsrt_network_wait_fd_timeout(h, s->eid, s->fd, 1, h->rw_timeout, &h->interrupt_callback);
502 ret = srt_sendmsg(s->fd, buf, size, -1, 0);
504 ret = libsrt_neterrno(h);
510 static int libsrt_close(URLContext *h)
512 SRTContext *s = h->priv_data;
516 srt_epoll_release(s->eid);
523 static int libsrt_get_file_handle(URLContext *h)
525 SRTContext *s = h->priv_data;
529 static const AVClass libsrt_class = {
530 .class_name = "libsrt",
531 .item_name = av_default_item_name,
532 .option = libsrt_options,
533 .version = LIBAVUTIL_VERSION_INT,
536 const URLProtocol ff_libsrt_protocol = {
538 .url_open = libsrt_open,
539 .url_read = libsrt_read,
540 .url_write = libsrt_write,
541 .url_close = libsrt_close,
542 .url_get_file_handle = libsrt_get_file_handle,
543 .priv_data_size = sizeof(SRTContext),
544 .flags = URL_PROTOCOL_FLAG_NETWORK,
545 .priv_data_class = &libsrt_class,