From patchwork Tue Jan 11 10:34:08 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gijs Peskens X-Patchwork-Id: 33232 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a6b:cd86:0:0:0:0:0 with SMTP id d128csp3568662iog; Tue, 11 Jan 2022 02:34:28 -0800 (PST) X-Google-Smtp-Source: ABdhPJzQaLsgI5uFZsJD2ITWjStq+KMX+j+XLQIC/xrgaUWnpry7U96giQuwRb7oIp8ZBaweoPg9 X-Received: by 2002:a17:906:7f88:: with SMTP id f8mr2985742ejr.471.1641897268464; Tue, 11 Jan 2022 02:34:28 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1641897268; cv=none; d=google.com; s=arc-20160816; b=VXOB6CMjWbm+29ah/4vPl7nY5qk1Odurk+7v6Ok5TMW8rJ6aT7zfoBAqWpXoyIEBDS 6/fm+LCmv8ypKqPV64LUtKw1wPkZVU8OEDDG0k/wtGjLUU6AgxZShM5beqIVV/P8H0JN ZqCm6KWIm8SpcxwNI9/pVffNj5cfmwBIppTWqCNimp7rgwFol9E8JVbRR9N/YTOIhzC2 fcmlI4bT6Ev0ghYm6wdehYaAcvzaL+pNpyckth+JnOh1soIcMoGDCx8/ALm1PNB+oeTu tUjdCQmJLC4UzrtjtIyZIsPtwxcVio2V7YH9m5ba0G6w6R5zk5oEeIu9cnevvim5ltLG eWtA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:reply-to:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:subject:mime-version:references:in-reply-to:message-id :date:to:from:dkim-signature:delivered-to; bh=G+fLta//J+CI0l8qYmw2A6ci/8UXRt2A3KWVo9NPvIY=; b=TcCt2ug23rGUVdlUAoztHl6xI5HrBh06o3C58lQlYr9gPJEBY3SEBhZAPhA4xnxCjx l2HfKYzd7ChSiQkSqeygwpdObSjb1KetOuKPaLBrkVDE0zBMRbGcY08I5zYZJ7Fqs6ar vl+iQpUMiFLaDMC8134GDLn84/EBRp+IYvFHRrUt8Hd0IHGMK8KFN39eKZN++Zpfe6E1 9jA6LU+5LdIKrTPFu+8q54G6eA+VE1RkomV23isxQlKkIT/edNHGNpi6nEYnR3FzFDoo hHqSHJDitZ8NhxtPkbkHp2UPwkiGhTfTNC3caW26c47EYsuYAb/pP6sjhiPlmZ4zkuDU X3TQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@heteigenwijsje.nl header.s=dkim header.b=l1huIRqP; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=peskens.net Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id l1si1693553ejo.929.2022.01.11.02.34.27; Tue, 11 Jan 2022 02:34:28 -0800 (PST) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@heteigenwijsje.nl header.s=dkim header.b=l1huIRqP; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=peskens.net Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id AF7EA68AF81; Tue, 11 Jan 2022 12:34:23 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from smtp.heteigenwijsje.nl (unknown [185.216.161.180]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 43BD6680394 for ; Tue, 11 Jan 2022 12:34:16 +0200 (EET) Received: from mail.heteigenwijsje.nl (localhost [127.0.0.1]) by smtp.heteigenwijsje.nl (Postfix) with ESMTP id 3B36E8CDEF for ; Tue, 11 Jan 2022 11:29:06 +0100 (CET) Authentication-Results: mail.heteigenwijsje.nl (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=heteigenwijsje.nl DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d= heteigenwijsje.nl; h=content-transfer-encoding:mime-version :references:in-reply-to:x-mailer:message-id:date:date:subject :subject:to:from:from; s=dkim; t=1641896939; x=1644488940; bh=DE wRrzDBQOoKPURM9sZsxUbvXMVkCBK9zpaiT3lOHDY=; b=l1huIRqPQT5cjfSB5a FTdEJrXdGsGvhy1bD5vuAUCEuLpm8JgAKJZAVLp8ycNu93vGHHaqn8yzMLo8RLdL 9i21Yu77MAwIMlpWi2BPpcjgzjRQ3SWj6qujw7PIFSJ/nbJYuxXSdhBcDQm7oEEm IW7XzxxHd9ftOnFFH+fW9wsH8= X-Virus-Scanned: amavisd-new at mail.heteigenwijsje.nl Received: from smtp.heteigenwijsje.nl ([127.0.0.1]) by mail.heteigenwijsje.nl (mail.heteigenwijsje.nl [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id HL4Ag5iD7LJl for ; Tue, 11 Jan 2022 11:28:59 +0100 (CET) Received: from smtp.heteigenwijsje.nl (localhost [127.0.0.1]) by smtp.heteigenwijsje.nl (Postfix) with ESMTP id 571CC8D23D for ; Tue, 11 Jan 2022 11:28:59 +0100 (CET) Received: from unknown ([2001:985:7aa4:1:40c0:375f:e41:372b]) by smtp.heteigenwijsje.nl with ESMTPSA id kIKSFOtb3WHveAAAc3PRCQ (envelope-from ) for ; Tue, 11 Jan 2022 11:28:59 +0100 From: Gijs Peskens To: ffmpeg-devel@ffmpeg.org Date: Tue, 11 Jan 2022 11:34:08 +0100 Message-Id: <20220111103408.201161-1-gijs@peskens.net> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220111092338.194468-1-gijs@peskens.net> References: <20220111092338.194468-1-gijs@peskens.net> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH] libRIST: allow setting fifo size and fail on overflow. X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: wVeDwjtbCpS+ Introduce fifo_size and overrun_nonfatal params to configure fifo buffer behavior. Use newly introduced RIST_DATA_FLAGS_OVERFLOW flag to check for overrun and error out in that case. --- doc/protocols.texi | 9 +++++++++ libavformat/librist.c | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/doc/protocols.texi b/doc/protocols.texi index d207df0b52..f1acf0cc77 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -745,6 +745,15 @@ Set internal RIST buffer size in milliseconds for retransmission of data. Default value is 0 which means the librist default (1 sec). Maximum value is 30 seconds. +@item fifo_size +Size of the librist receiver output fifo in number of packets. This must be a +power of 2. +Defaults to 8192 (vs the libRIST default of 1024). + +@item overrun_nonfatal=@var{1|0} +Survive in case of libRIST fifo buffer overrun. Default +value is 0. + @item pkt_size Set maximum packet size for sending data. 1316 by default. diff --git a/libavformat/librist.c b/libavformat/librist.c index 378b635ea7..53f83d3668 100644 --- a/libavformat/librist.c +++ b/libavformat/librist.c @@ -43,6 +43,9 @@ ((patch) + ((minor)* 0x100) + ((major) *0x10000)) #define FF_LIBRIST_VERSION FF_LIBRIST_MAKE_VERSION(LIBRIST_API_VERSION_MAJOR, LIBRIST_API_VERSION_MINOR, LIBRIST_API_VERSION_PATCH) #define FF_LIBRIST_VERSION_41 FF_LIBRIST_MAKE_VERSION(4, 1, 0) +#define FF_LIBRIST_VERSION_42 FF_LIBRIST_MAKE_VERSION(4, 2, 0) + +#define FF_LIBRIST_FIFO_SIZE_DEFAULT 8192 typedef struct RISTContext { const AVClass *class; @@ -52,6 +55,8 @@ typedef struct RISTContext { int packet_size; int log_level; int encryption; + int fifo_size; + int overrun_nonfatal; char *secret; struct rist_logging_settings logging_settings; @@ -70,6 +75,8 @@ static const AVOption librist_options[] = { { "main", NULL, 0, AV_OPT_TYPE_CONST, {.i64=RIST_PROFILE_MAIN}, 0, 0, .flags = D|E, "profile" }, { "advanced", NULL, 0, AV_OPT_TYPE_CONST, {.i64=RIST_PROFILE_ADVANCED}, 0, 0, .flags = D|E, "profile" }, { "buffer_size", "set buffer_size in ms", OFFSET(buffer_size), AV_OPT_TYPE_INT, {.i64=0}, 0, 30000, .flags = D|E }, + { "fifo_size", "Set libRIST fifo buffer. Size must be power of 2", OFFSET(fifo_size), AV_OPT_TYPE_INT, {.i64=FF_LIBRIST_FIFO_SIZE_DEFAULT}, 2 << 9, 2 << 15, .flags = D|E }, + { "overrun_nonfatal", "survive in case of libRIST receiving circular buffer overrun", OFFSET(overrun_nonfatal), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D }, { "pkt_size", "set packet size", OFFSET(packet_size), AV_OPT_TYPE_INT, {.i64=1316}, 1, MAX_PAYLOAD_SIZE, .flags = D|E }, { "log_level", "set loglevel", OFFSET(log_level), AV_OPT_TYPE_INT, {.i64=RIST_LOG_INFO}, -1, INT_MAX, .flags = D|E }, { "secret", "set encryption secret",OFFSET(secret), AV_OPT_TYPE_STRING,{.str=NULL}, 0, 0, .flags = D|E }, @@ -161,6 +168,20 @@ static int librist_open(URLContext *h, const char *uri, int flags) if (ret < 0) goto err; + //Prior to 4.2.0 there was a bug in libRIST which made this call always fail. +#if FF_LIBRIST_VERSION >= FF_LIBRIST_VERSION_42 + if (flags & AVIO_FLAG_READ) { + ret = rist_receiver_set_output_fifo_size(s->ctx, s->fifo_size); + if (ret != 0) { + goto err; + } + } +#else + if (s->fifo_size != FF_LIBRIST_FIFO_SIZE_DEFAULT) { + av_log(h, AV_LOG_ERROR, "libRIST prior to 0.2.7 has a bug which fails setting the fifo buffer size\n"); + } +#endif + if (((s->encryption == 128 || s->encryption == 256) && !s->secret) || ((peer_config->key_size == 128 || peer_config->key_size == 256) && !peer_config->secret[0])) { av_log(h, AV_LOG_ERROR, "secret is mandatory if encryption is enabled\n"); @@ -223,8 +244,24 @@ static int librist_read(URLContext *h, uint8_t *buf, int size) return AVERROR_EXTERNAL; } +#if FF_LIBRIST_VERSION >= FF_LIBRIST_VERSION_42 + if (data_block->flags & RIST_DATA_FLAGS_OVERFLOW == RIST_DATA_FLAGS_OVERFLOW) { + if (!s->overrun_nonfatal) { + av_log(h, AV_LOG_ERROR, "Fifo buffer overrun. " + "To avoid, increase fifo_size URL option. " + "To survive in such case, use overrun_nonfatal option\n"); + size = AVERROR(EIO); + goto out_free; + } else { + av_log(h, AV_LOG_WARNING, "Fifo buffer overrun. " + "Surviving due to overrun_nonfatal option\n"); + } + } +#endif + size = data_block->payload_len; memcpy(buf, data_block->payload, size); +out_free: #if FF_LIBRIST_VERSION < FF_LIBRIST_VERSION_41 rist_receiver_data_block_free((struct rist_data_block**)&data_block); #else