[FFmpeg-cvslog] doc/muxers: review rawvideo muxers section

Wed Jan 10 20:58:02 EET 2024

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Sat Jan  6 19:07:36 2024 +0100| [c7e26d192a39e262e5e2f6c307a64ba1b080e7ae] | committer: Stefano Sabatini

doc/muxers: review rawvideo muxers section

Move section to the top of the file, use table in place of subsection
to list the comprising muxers, and show media type information and
extensions in the item entry names.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=c7e26d192a39e262e5e2f6c307a64ba1b080e7ae
---

 doc/muxers.texi | 340 ++++++++++++++++++++++++++------------------------------
 1 file changed, 158 insertions(+), 182 deletions(-)

diff --git a/doc/muxers.texi b/doc/muxers.texi
index ee6edd6f43..e0fddc0ecd 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -19,6 +19,164 @@ enabled demuxers and muxers.
 
 A description of some of the currently available muxers follows.
 
+ at anchor{raw muxers}
+ at section Raw muxers
+
+This section covers raw muxers. They accept a single stream matching
+the designated codec. They do not store timestamps or metadata. The
+recognized extension is the same as the muxer name unless indicated
+otherwise.
+
+It comprises the following muxers. The media type and the eventual
+extensions used to automatically selects the muxer from the output
+extensions are also shown.
+
+ at table @samp
+ at item ac3 @emph{audio}
+Dolby Digital, also known as AC-3.
+
+ at item adx @emph{audio}
+CRI Middleware ADX audio.
+
+This muxer will write out the total sample count near the start of the
+first packet when the output is seekable and the count can be stored
+in 32 bits.
+
+ at item aptx @emph{audio}
+aptX (Audio Processing Technology for Bluetooth)
+
+ at item aptx_hd @emph{audio} (aptxdh)
+aptX HD (Audio Processing Technology for Bluetooth) audio
+
+ at item avs2 @emph{video} (avs, avs2)
+AVS2-P2/IEEE1857.4 video.
+
+ at item cavsvideo @emph{video} (cavs)
+Chinese AVS (Audio Video Standard)
+
+ at item codec2raw @emph{audio}
+Codec 2 audio.
+
+No extension is registered so format name has to be supplied e.g. with
+the ffmpeg CLI tool @code{-f codec2raw}.
+
+ at item data @emph{any}
+Generic data muxer.
+
+This muxer accepts a single stream with any codec of any type. The
+input stream has to be selected using the @code{-map} option with the
+ at command{ffmpeg} CLI tool.
+
+No extension is registered so format name has to be supplied e.g. with
+the @command{ffmpeg} CLI tool @code{-f data}.
+
+ at item dirac @emph{video} (drc, vc2)
+BBC Dirac video.
+
+The Dirac Pro codec is a subset and is standardized as SMPTE VC-2.
+
+ at item dnxhd @emph{video} (dnxhd, dnxhr)
+Avid DNxHD video.
+
+It is standardized as SMPTE VC-3. Accepts DNxHR streams.
+
+ at item dts @emph{audio}
+DTS Coherent Acoustics (DCA) audio
+
+ at item  eac3 @emph{audio}
+Dolby Digital Plus, also known as Enhanced AC-3
+
+ at item evc @emph{video} (evc)
+MPEG-5 Essential Video Coding (EVC) / EVC / MPEG-5 Part 1 EVC video
+
+ at item g722 @emph{audio}
+ITU-T G.722 audio
+
+ at item g723_1 @emph{audio} (tco, rco)
+ITU-T G.723.1 audio
+
+ at item g726 @emph{audio}
+ITU-T G.726 big-endian ("left-justified") audio.
+
+No extension is registered so format name has to be supplied e.g. with
+the @command{ffmpeg} CLI tool @code{-f g726}.
+
+ at item g726le @emph{audio}
+ITU-T G.726 little-endian ("right-justified") audio.
+
+No extension is registered so format name has to be supplied e.g. with
+the @command{ffmpeg} CLI tool @code{-f g726le}.
+
+ at item gsm @emph{audio}
+Global System for Mobile Communications audio
+
+ at item h261 @emph{video}
+ITU-T H.261 video
+
+ at item h263 @emph{video}
+ITU-T H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2 video
+
+ at item h264 @emph{video} (h264, 264)
+ITU-T H.264 / MPEG-4 Part 10 AVC video. Bitstream shall be converted
+to Annex B syntax if it's in length-prefixed mode.
+
+ at item hevc @emph{video} (hevc, h265, 265)
+ITU-T H.265 / MPEG-H Part 2 HEVC video. Bitstream shall be converted
+to Annex B syntax if it's in length-prefixed mode.
+
+ at item m4v @emph{video}
+MPEG-4 Part 2 video
+
+ at item mjpeg @emph{video} (mjpg, mjpeg)
+Motion JPEG video
+
+ at item mlp @emph{audio}
+Meridian Lossless Packing, also known as Packed PCM
+
+ at item mp2 @emph{audio} (mp2, m2a, mpa)
+MPEG-1 Audio Layer II audio
+
+ at item mpeg1video @emph{video} (mpg, mpeg, m1v)
+MPEG-1 Part 2 video.
+
+ at item mpeg2video @emph{video} (m2v)
+ITU-T H.262 / MPEG-2 Part 2 video
+
+ at item obu @emph{video}
+AV1 low overhead Open Bitstream Units muxer.
+
+Temporal delimiter OBUs will be inserted in all temporal units of the
+stream.
+
+ at item rawvideo @emph{video} (yuv, rgb)
+Raw uncompressed video.
+
+ at item sbc @emph{audio} (sbc, msbc)
+Bluetooth SIG low-complexity subband codec audio
+
+ at item truehd @emph{audio} (thd)
+Dolby TrueHD audio
+
+ at item vc1 @emph{video}
+SMPTE 421M / VC-1 video
+ at end table
+
+ at subsection Examples
+
+ at itemize
+ at item
+Store raw video frames with the @samp{rawvideo} muxer using @command{ffmpeg}:
+ at example
+ffmpeg -f lavfi -i testsrc -t 10 -s hd1080p testsrc.yuv
+ at end example
+
+Since the rawvideo muxer do not store the information related to size
+and format, this information must be provided when demuxing the file:
+ at example
+ffplay -video_size 1920x1080 -pixel_format rgb24 -f rawvideo testsrc.rgb
+ at end example
+ at end itemize
+
 @section MOV/MPEG-4/ISOMBFF muxers
 
 This section covers formats belonging to the QuickTime / MOV family,
@@ -2220,188 +2378,6 @@ ogg files can be safely chained.
 
 @end table
 
- at anchor{raw muxers}
- at section raw muxers
-
-Raw muxers accept a single stream matching the designated codec. They do not store timestamps or metadata.
-The recognized extension is the same as the muxer name unless indicated otherwise.
-
- at subsection ac3
-
-Dolby Digital, also known as AC-3, audio.
-
- at subsection adx
-
-CRI Middleware ADX audio.
-
-This muxer will write out the total sample count near the start of the first packet
-when the output is seekable and the count can be stored in 32 bits.
-
- at subsection aptx
-
-aptX (Audio Processing Technology for Bluetooth) audio.
-
- at subsection aptx_hd
-
-aptX HD (Audio Processing Technology for Bluetooth) audio.
-
-Extensions: aptxhd
-
- at subsection avs2
-
-AVS2-P2/IEEE1857.4 video.
-
-Extensions: avs, avs2
-
- at subsection cavsvideo
-
-Chinese AVS (Audio Video Standard) video.
-
-Extensions: cavs
-
- at subsection codec2raw
-
-Codec 2 audio.
-
-No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f codec2raw}.
-
- at subsection data
-
-Data muxer accepts a single stream with any codec of any type.
-The input stream has to be selected using the @code{-map} option with the ffmpeg CLI tool.
-
-No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f data}.
-
- at subsection dirac
-
-BBC Dirac video. The Dirac Pro codec is a subset and is standardized as SMPTE VC-2.
-
-Extensions: drc, vc2
-
- at subsection dnxhd
-
-Avid DNxHD video. It is standardized as SMPTE VC-3. Accepts DNxHR streams.
-
-Extensions: dnxhd, dnxhr
-
- at subsection dts
-
-DTS Coherent Acoustics (DCA) audio.
-
- at subsection eac3
-
-Dolby Digital Plus, also known as Enhanced AC-3, audio.
-
- at subsection evc
-
-MPEG-5 Essential Video Coding (EVC) / EVC / MPEG-5 Part 1 EVC video.
-
-Extensions: evc
-
- at subsection g722
-
-ITU-T G.722 audio.
-
- at subsection g723_1
-
-ITU-T G.723.1 audio.
-
-Extensions: tco, rco
-
- at subsection g726
-
-ITU-T G.726 big-endian ("left-justified") audio.
-
-No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726}.
-
- at subsection g726le
-
-ITU-T G.726 little-endian ("right-justified") audio.
-
-No extension is registered so format name has to be supplied e.g. with the ffmpeg CLI tool @code{-f g726le}.
-
- at subsection gsm
-
-Global System for Mobile Communications audio.
-
- at subsection h261
-
-ITU-T H.261 video.
-
- at subsection h263
-
-ITU-T H.263 / H.263-1996, H.263+ / H.263-1998 / H.263 version 2 video.
-
- at subsection h264
-
-ITU-T H.264 / MPEG-4 Part 10 AVC video. Bitstream shall be converted to Annex B syntax if it's in length-prefixed mode.
-
-Extensions: h264, 264
-
- at subsection hevc
-
-ITU-T H.265 / MPEG-H Part 2 HEVC video. Bitstream shall be converted to Annex B syntax if it's in length-prefixed mode.
-
-Extensions: hevc, h265, 265
-
- at subsection m4v
-
-MPEG-4 Part 2 video.
-
- at subsection mjpeg
-
-Motion JPEG video.
-
-Extensions: mjpg, mjpeg
-
- at subsection mlp
-
-Meridian Lossless Packing, also known as Packed PCM, audio.
-
- at subsection mp2
-
-MPEG-1 Audio Layer II audio.
-
-Extensions: mp2, m2a, mpa
-
- at subsection mpeg1video
-
-MPEG-1 Part 2 video.
-
-Extensions: mpg, mpeg, m1v
-
- at subsection mpeg2video
-
-ITU-T H.262 / MPEG-2 Part 2 video.
-
-Extensions: m2v
-
- at subsection obu
-
-AV1 low overhead Open Bitstream Units muxer. Temporal delimiter OBUs will be inserted in all temporal units of the stream.
-
- at subsection rawvideo
-
-Raw uncompressed video.
-
-Extensions: yuv, rgb
-
- at subsection sbc
-
-Bluetooth SIG low-complexity subband codec audio.
-
-Extensions: sbc, msbc
-
- at subsection truehd
-
-Dolby TrueHD audio.
-
-Extensions: thd
-
- at subsection vc1
-
-SMPTE 421M / VC-1 video.
-
 @anchor{segment}
 @section segment, stream_segment, ssegment
 

