From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <ffmpeg-devel-bounces@ffmpeg.org>
Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100])
by master.gitmailbox.com (Postfix) with ESMTP id 71E9A481A4
for <ffmpegdev@gitmailbox.com>; Mon, 11 Mar 2024 16:15:28 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 70F2268D0E0;
Mon, 11 Mar 2024 18:14:55 +0200 (EET)
Received: from mail-ej1-f53.google.com (mail-ej1-f53.google.com
[209.85.218.53])
by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 7BF1568D0BA
for <ffmpeg-devel@ffmpeg.org>; Mon, 11 Mar 2024 18:14:46 +0200 (EET)
Received: by mail-ej1-f53.google.com with SMTP id
a640c23a62f3a-a462b068416so136229166b.0
for <ffmpeg-devel@ffmpeg.org>; Mon, 11 Mar 2024 09:14:46 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=gmail.com; s=20230601; t=1710173685; x=1710778485; darn=ffmpeg.org;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:from:to:cc:subject:date
:message-id:reply-to;
bh=S0VpZ/ATYuNmzZkkpsnol6uUHM7b1WIDqbeY39DtRrI=;
b=lo2/h1Onyd1RqpSviF+3pY448S+jTNUMGSNrAYZzPlwGlizHW1w1g2QjuIipnsQ0TH
Ke62pmHrJ3gQGnXichkWe0bwEaVXuT4xpuNK8MHNFXh+UWR7aktIXpghD+powo3+LHil
o+xGQLDfXA/gSwZHHbU5/rVTD4Yl1CApTy5Q3P2zFRsvvKXvyEP2OC4Y6KetLEvkxTDl
SN72XBCAiw9g8mnqj99yjGxrmLoL8ojOjBeo3JkO3xzbIxCdyLM+UVvbqyDe8BzmbEoi
vhlnDuXF5w5D4YkiuLZqXA08I8JO7/ZfY8Krpnb4a7hlGN0KsuicOV26oBqnvvnlWXDt
4T5w==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1710173685; x=1710778485;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=S0VpZ/ATYuNmzZkkpsnol6uUHM7b1WIDqbeY39DtRrI=;
b=m5caJyFCjA2jUtEJhphPuPUKjezKNSwX5cwUxDjbjzlQTgkgfRRVBOnL5hEAykMrFD
fpGBL5duQljIf9qJSMRQhKqiq6DVPDGx6dXyRIMJb7iRTFIw2kPWxQ6grv4mpoHiPLGw
oVhzTAaFphpfCw+atYMpRXk2o4MCN0vgUtelPt3+S0PVdWGRFF06t7tjVPeosHbNLItW
9n8JwLzPrRFyH+EKn8WpT5mV+ROkOup5utTRowVs6JpS0m2RjjyhUdK0P2B9ozpRa6PU
NGpUr0QSj1GDDPSHDaA+k0gOGGK3+AigBSsD8ZsgE64RSe1J3V42jr+1EQDl2J9YPikU
5NmQ==
X-Gm-Message-State: AOJu0Yy5upm9XR2c0AU+JmayChQQ7eX0rOvCPsrH+tyNnd9Lz18hRUox
qkm4nfb8vu+JP2Dxr7Xn43jfNdEPtz++Mb1OkK/aPS9qVe7qEZUyZnabm+uB
X-Google-Smtp-Source: AGHT+IG7H7rzVAa3fgcfnuhEQpZJ/w3yzbTCXi8sBTE9G6kN7J7Sda7Rd165JcgGvEHM/x9iY4NF+Q==
X-Received: by 2002:a17:907:d382:b0:a46:499:4386 with SMTP id
vh2-20020a170907d38200b00a4604994386mr5560426ejc.4.1710173684487;
Mon, 11 Mar 2024 09:14:44 -0700 (PDT)
Received: from mariano ([188.210.239.79]) by smtp.gmail.com with ESMTPSA id
pw27-20020a17090720bb00b00a44e65447f9sm2975480ejb.7.2024.03.11.09.14.44
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Mon, 11 Mar 2024 09:14:44 -0700 (PDT)
Received: by mariano (Postfix, from userid 1000)
id 26093BFCE2; Mon, 11 Mar 2024 17:14:43 +0100 (CET)
From: Stefano Sabatini <stefasab@gmail.com>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Date: Mon, 11 Mar 2024 17:14:43 +0100
Message-Id: <20240311161443.323282-3-stefasab@gmail.com>
X-Mailer: git-send-email 2.34.1
In-Reply-To: <20240311161443.323282-1-stefasab@gmail.com>
References: <20240311161443.323282-1-stefasab@gmail.com>
MIME-Version: 1.0
Subject: [FFmpeg-devel] [PATCH 3/3] doc/muxers/fifo: review documentation
X-BeenThere: ffmpeg-devel@ffmpeg.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: FFmpeg development discussions and patches <ffmpeg-devel.ffmpeg.org>
List-Unsubscribe: <https://ffmpeg.org/mailman/options/ffmpeg-devel>,
<mailto:ffmpeg-devel-request@ffmpeg.org?subject=unsubscribe>
List-Archive: <https://ffmpeg.org/pipermail/ffmpeg-devel>
List-Post: <mailto:ffmpeg-devel@ffmpeg.org>
List-Help: <mailto:ffmpeg-devel-request@ffmpeg.org?subject=help>
List-Subscribe: <https://ffmpeg.org/mailman/listinfo/ffmpeg-devel>,
<mailto:ffmpeg-devel-request@ffmpeg.org?subject=subscribe>
Reply-To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Cc: Stefano Sabatini <stefasab@gmail.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: ffmpeg-devel-bounces@ffmpeg.org
Sender: "ffmpeg-devel" <ffmpeg-devel-bounces@ffmpeg.org>
Archived-At: <https://master.gitmailbox.com/ffmpegdev/20240311161443.323282-3-stefasab@gmail.com/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>
---
doc/muxers.texi | 138 ++++++++++++++++++++++++++----------------------
1 file changed, 74 insertions(+), 64 deletions(-)
diff --git a/doc/muxers.texi b/doc/muxers.texi
index 2104cc4a95..34de187f5e 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -1421,104 +1421,114 @@ ffmpeg -i INPUT -s:v 720x480 -pix_fmt yuv411p -r 29.97 -ac 2 -ar 48000 -y out.dv
@anchor{fifo}
@section fifo
+FIFO (First-In First-Out) muxer.
-The fifo pseudo-muxer allows the separation of encoding and muxing by using
-first-in-first-out queue and running the actual muxer in a separate thread. This
-is especially useful in combination with the @ref{tee} muxer and can be used to
-send data to several destinations with different reliability/writing speed/latency.
+The @samp{fifo} pseudo-muxer allows the separation of encoding and
+muxing by using a first-in-first-out queue and running the actual muxer
+in a separate thread.
-API users should be aware that callback functions (interrupt_callback,
-io_open and io_close) used within its AVFormatContext must be thread-safe.
+This is especially useful in combination with
+the @ref{tee} muxer and can be used to send data to several
+destinations with different reliability/writing speed/latency.
-The behavior of the fifo muxer if the queue fills up or if the output fails is
-selectable,
+The target muxer is either selected from the output name or specified
+through the @option{fifo_format} option.
+The behavior of the @samp{fifo} muxer if the queue fills up or if the
+output fails (e.g. if a packet cannot be written to the output) is
+selectable:
@itemize @bullet
-
@item
-output can be transparently restarted with configurable delay between retries
-based on real time or time of the processed stream.
+Output can be transparently restarted with configurable delay between
+retries based on real time or time of the processed stream.
@item
-encoding can be blocked during temporary failure, or continue transparently
-dropping packets in case fifo queue fills up.
-
+Encoding can be blocked during temporary failure, or continue transparently
+dropping packets in case the FIFO queue fills up.
@end itemize
+API users should be aware that callback functions
+(@code{interrupt_callback}, @code{io_open} and @code{io_close}) used
+within its @code{AVFormatContext} must be thread-safe.
+
+@subsection Options
@table @option
-@item fifo_format
+@item attempt_recovery @var{bool}
+If failure occurs, attempt to recover the output. This is especially
+useful when used with network output, since it makes it possible to
+restart streaming transparently. By default this option is set to
+@code{false}.
+
+@item drop_pkts_on_overflow @var{bool}
+If set to @code{true}, in case the fifo queue fills up, packets will
+be dropped rather than blocking the encoder. This makes it possible to
+continue streaming without delaying the input, at the cost of omitting
+part of the stream. By default this option is set to @code{false}, so in
+such cases the encoder will be blocked until the muxer processes some
+of the packets and none of them is lost.
+
+@item fifo_format @var{format_name}
Specify the format name. Useful if it cannot be guessed from the
output name suffix.
-@item queue_size
-Specify size of the queue (number of packets). Default value is 60.
+@item format_opts @var{options}
+Specify format options for the underlying muxer. Muxer options can be
+specified as a list of @var{key}=@var{value} pairs separated by ':'.
-@item format_opts
-Specify format options for the underlying muxer. Muxer options can be specified
-as a list of @var{key}=@var{value} pairs separated by ':'.
+@item max_recovery_attempts @var{count}
+Set maximum number of successive unsuccessful recovery attempts after
+which the output fails permanently. By default this option is set to
+@code{0} (unlimited).
-@item drop_pkts_on_overflow @var{bool}
-If set to 1 (true), in case the fifo queue fills up, packets will be dropped
-rather than blocking the encoder. This makes it possible to continue streaming without
-delaying the input, at the cost of omitting part of the stream. By default
-this option is set to 0 (false), so in such cases the encoder will be blocked
-until the muxer processes some of the packets and none of them is lost.
+@item queue_size @var{size}
+Specify size of the queue as a number of packets. Default value is
+@code{60}.
-@item attempt_recovery @var{bool}
-If failure occurs, attempt to recover the output. This is especially useful
-when used with network output, since it makes it possible to restart streaming transparently.
-By default this option is set to 0 (false).
+@item recover_any_error @var{bool}
+If set to @code{true}, recovery will be attempted regardless of type
+of the error causing the failure. By default this option is set to
+@code{false} and in case of certain (usually permanent) errors the
+recovery is not attempted even when the @option{attempt_recovery}
+option is set to @code{true}.
-@item max_recovery_attempts
-Sets maximum number of successive unsuccessful recovery attempts after which
-the output fails permanently. By default this option is set to 0 (unlimited).
+@item recovery_wait_streamtime @var{bool}
+If set to @code{false}, the real time is used when waiting for the
+recovery attempt (i.e. the recovery will be attempted after the time
+specified by the @option{recovery_wait_time} option).
-@item recovery_wait_time @var{duration}
-Waiting time before the next recovery attempt after previous unsuccessful
-recovery attempt. Default value is 5 seconds.
+If set to @code{true}, the time of the processed stream is taken into
+account instead (i.e. the recovery will be attempted after discarding
+the packets corresponding to the @option{recovery_wait_time} option).
-@item recovery_wait_streamtime @var{bool}
-If set to 0 (false), the real time is used when waiting for the recovery
-attempt (i.e. the recovery will be attempted after at least
-recovery_wait_time seconds).
-If set to 1 (true), the time of the processed stream is taken into account
-instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
-seconds of the stream is omitted).
-By default, this option is set to 0 (false).
+By default this option is set to @code{false}.
-@item recover_any_error @var{bool}
-If set to 1 (true), recovery will be attempted regardless of type of the error
-causing the failure. By default this option is set to 0 (false) and in case of
-certain (usually permanent) errors the recovery is not attempted even when
-@var{attempt_recovery} is set to 1.
+@item recovery_wait_time @var{duration}
+Specify waiting time in seconds before the next recovery attempt after
+previous unsuccessful recovery attempt. Default value is @code{5}.
@item restart_with_keyframe @var{bool}
Specify whether to wait for the keyframe after recovering from
-queue overflow or failure. This option is set to 0 (false) by default.
+queue overflow or failure. This option is set to @code{false} by default.
@item timeshift @var{duration}
-Buffer the specified amount of packets and delay writing the output. Note that
-@var{queue_size} must be big enough to store the packets for timeshift. At the
-end of the input the fifo buffer is flushed at realtime speed.
-
+Buffer the specified amount of packets and delay writing the
+output. Note that the value of the @option{queue_size} option must be
+big enough to store the packets for timeshift. At the end of the input
+the fifo buffer is flushed at realtime speed.
@end table
-@subsection Examples
-
-@itemize
+@subsection Example
-@item
-Stream something to rtmp server, continue processing the stream at real-time
-rate even in case of temporary failure (network outage) and attempt to recover
-streaming every second indefinitely.
+Use @command{ffmpeg} to stream to an RTMP server, continue processing
+the stream at real-time rate even in case of temporary failure
+(network outage) and attempt to recover streaming every second
+indefinitely:
@example
-ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
+ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a \
-drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
@end example
-@end itemize
-
@section flv
Adobe Flash Video Format muxer.
--
2.34.1
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".