[FFmpeg-devel] [PATCH 3/4] doc/muxers: add "Options", "Examples", "Syntax", etc. subsections

[Timothy Gu]

More consistent with codec docs.

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 doc/muxers.texi | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

diff --git a/doc/muxers.texi b/doc/muxers.texi
index 8a2bed0..e795e91 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -23,6 +23,8 @@ A description of some of the currently available muxers follows.
 
 Audio Interchange File Format muxer.
 
+ at subsection Options
+
 It accepts the following options:
 
 @table @option
@@ -45,10 +47,14 @@ and video frames. By default audio frames are converted to signed
 16-bit raw audio and video frames to raw video before computing the
 CRC.
 
+ at subsection Output Syntax
+
 The output of the muxer consists of a single line of the form:
 CRC=0x at var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
 8 digits containing the CRC for all the decoded input frames.
 
+ at subsection Examples
+
 For example to compute the CRC of the input, and store it in the file
 @file{out.crc}:
 @example
@@ -80,6 +86,8 @@ and video packet. By default audio frames are converted to signed
 16-bit raw audio and video frames to raw video before computing the
 CRC.
 
+ at subsection Output Syntax
+
 The output of the muxer consists of a line for each audio and video
 packet of the form:
 @example
@@ -89,6 +97,8 @@ packet of the form:
 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
 CRC of the packet.
 
+ at subsection Examples
+
 For example to compute the CRC of the audio and video frames in
 @file{INPUT}, converted to raw audio and video packets, and store it
 in the file @file{out.crc}:
@@ -123,6 +133,8 @@ and video packet. By default audio frames are converted to signed
 16-bit raw audio and video frames to raw video before computing the
 hash.
 
+ at subsection Output Syntax
+
 The output of the muxer consists of a line for each audio and video
 packet of the form:
 @example
@@ -132,6 +144,8 @@ packet of the form:
 @var{MD5} is a hexadecimal number representing the computed MD5 hash
 for the packet.
 
+ at subsection Examples
+
 For example to compute the MD5 of the audio and video frames in
 @file{INPUT}, converted to raw audio and video packets, and store it
 in the file @file{out.md5}:
@@ -151,6 +165,8 @@ See also the @ref{md5} muxer.
 
 Animated GIF muxer.
 
+ at subsection Options
+
 It accepts the following options:
 
 @table @option
@@ -165,6 +181,8 @@ special value to tell the muxer to re-use the previous delay. In case of a
 loop, you might want to customize this value to mark a pause for instance.
 @end table
 
+ at subsection Examples
+
 For example, to encode a gif looping 10 times, with a 5 seconds delay between
 the loops:
 @example
@@ -191,6 +209,8 @@ filename specifies the playlist filename; the segment filenames
 receive the same basename as the playlist, a sequential number and
 a .ts extension.
 
+ at subsection Examples
+
 For example, to convert an input file with @command{ffmpeg}:
 @example
 ffmpeg -i in.nut out.m3u8
@@ -200,6 +220,8 @@ See also the @ref{segment} muxer, which provides a more generic and
 flexible implementation of a segmenter, and can be used to perform HLS
 segmentation.
 
+ at subsection Options
+
 This muxer supports the following options:
 
 @table @option
@@ -269,6 +291,8 @@ Image file muxer.
 
 The image file muxer writes video frames to image files.
 
+ at subsection Output File Name Syntax
+
 The output filenames are specified by a pattern, which can be used to
 produce sequentially numbered series of files.
 The pattern may contain the string "%d" or "%0 at var{N}d", this string
@@ -292,6 +316,8 @@ The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
 etc.
 
+ at subsection Examples
+
 The following example shows how to use @command{ffmpeg} for creating a
 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
 taking one image every second from the input video:
@@ -314,6 +340,8 @@ Note also that the pattern must not necessarily contain "%d" or
 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
 @end example
 
+ at subsection Options
+
 @table @option
 @item start_number @var{number}
 Start the sequence from @var{number}. Default value is 1. Must be a
@@ -338,6 +366,8 @@ Matroska container muxer.
 
 This muxer implements the matroska and webm container specs.
 
+ at subsection Metadata
+
 The recognized metadata settings in this muxer are:
 
 @table @option
@@ -395,6 +425,8 @@ For example a 3D WebM clip can be created using the following command line:
 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
 @end example
 
+ at subsection Options
+
 This muxer supports the following options:
 
 @table @option
@@ -426,10 +458,14 @@ and video frames. By default audio frames are converted to signed
 16-bit raw audio and video frames to raw video before computing the
 hash.
 
+ at subsection Output Syntax
+
 The output of the muxer consists of a single line of the form:
 MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
 the computed MD5 hash.
 
+ at subsection Examples
+
 For example to compute the MD5 hash of the input converted to raw
 audio and video, and store it in the file @file{out.md5}:
 @example
@@ -461,6 +497,8 @@ very long files (since writing normal MOV/MP4 files stores info about
 every single packet in memory until the file is closed). The downside
 is that it is less compatible with other applications.
 
+ at subsection Fragmentation Options
+
 Fragmentation is enabled by setting one of the AVOptions that define
 how to cut the file into fragments:
 
@@ -488,6 +526,8 @@ one of the specified conditions is fulfilled. The exception to this is
 @code{-min_frag_duration}, which has to be fulfilled for any of the other
 conditions to apply.
 
+ at subsection Miscellaneous Options
+
 Additionally, the way the output file is written can be adjusted
 through a few other options:
 
@@ -517,6 +557,8 @@ as fragmented output, thus it is not enabled by default.
 Add RTP hinting tracks to the output file.
 @end table
 
+ at subsection Examples
+
 Smooth Streaming content can be pushed in real time to a publishing
 point on IIS with this muxer. Example:
 @example
@@ -545,7 +587,7 @@ Note that the APIC frames must be written at the beginning, so the muxer will
 buffer the audio frames until it gets all the pictures. It is therefore advised
 to provide the pictures as soon as possible to avoid excessive buffering.
 
-Examples:
+ at subsection Examples
 
 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
 @example
@@ -565,6 +607,8 @@ MPEG transport stream muxer.
 
 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
 
+ at subsection Options
+
 The muxer options are:
 
 @table @option
@@ -617,11 +661,15 @@ Reemit PAT/PMT before writing the next packet.
 Use LATM packetization for AAC.
 @end table
 
+ at subsection Metadata
+
 The recognized metadata settings in mpegts muxer are @code{service_provider}
 and @code{service_name}. If they are not set the default for
 @code{service_provider} is "FFmpeg" and the default for
 @code{service_name} is "Service01".
 
+ at subsection Examples
+
 @example
 ffmpeg -i file.mpg -c copy \
      -mpegts_original_network_id 0x1122 \
@@ -641,6 +689,8 @@ Null muxer.
 This muxer does not generate any output file, it is mainly useful for
 testing or benchmarking purposes.
 
+ at subsection Examples
+
 For example to benchmark decoding with @command{ffmpeg} you can use the
 command:
 @example
@@ -660,6 +710,8 @@ ffmpeg -benchmark -i INPUT -f null -
 
 Ogg container muxer.
 
+ at subsection Options
+
 @table @option
 @item -page_duration @var{duration}
 Preferred page duration, in microseconds. The muxer will attempt to create
@@ -705,6 +757,8 @@ files.
 See also the @ref{hls} muxer, which provides a more specific
 implementation for HLS segmentation.
 
+ at subsection Options
+
 The segment muxer supports the following options:
 
 @table @option
@@ -913,6 +967,8 @@ with the tee muxer; encoding can be a very expensive process. It is not
 useful when using the libavformat API directly because it is then possible
 to feed the same packets to several muxers directly.
 
+ at subsection Output File Name Syntax
+
 The slave outputs are specified in the file name given to the muxer,
 separated by '|'. If any of the slave name contains the '|' separator,
 leading or trailing spaces or any special character, it must be
@@ -948,6 +1004,8 @@ specified by a stream specifier. If not specified, this defaults to
 all the input streams.
 @end table
 
+ at subsection Examples
+
 Some examples follow.
 @itemize
 @item
-- 
1.8.3.2