Browse code

doc/muxers: add "Options", "Examples", "Syntax", etc. subsections

More consistent with codec docs. Also some minor reorganization of sentences
to fit the new document hierarchy.

Signed-off-by: Timothy Gu <timothygu99@gmail.com>

Timothy Gu authored on 2014/01/09 11:30:20
Showing 1 changed files
... ...
@@ -23,6 +23,8 @@ A description of some of the currently available muxers follows.
23 23
 
24 24
 Audio Interchange File Format muxer.
25 25
 
26
+@subsection Options
27
+
26 28
 It accepts the following options:
27 29
 
28 30
 @table @option
... ...
@@ -49,6 +51,10 @@ The output of the muxer consists of a single line of the form:
49 49
 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
50 50
 8 digits containing the CRC for all the decoded input frames.
51 51
 
52
+See also the @ref{framecrc} muxer.
53
+
54
+@subsection Examples
55
+
52 56
 For example to compute the CRC of the input, and store it in the file
53 57
 @file{out.crc}:
54 58
 @example
... ...
@@ -68,8 +74,6 @@ and the input video converted to MPEG-2 video, use the command:
68 68
 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
69 69
 @end example
70 70
 
71
-See also the @ref{framecrc} muxer.
72
-
73 71
 @anchor{framecrc}
74 72
 @section framecrc
75 73
 
... ...
@@ -89,6 +93,8 @@ packet of the form:
89 89
 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
90 90
 CRC of the packet.
91 91
 
92
+@subsection Examples
93
+
92 94
 For example to compute the CRC of the audio and video frames in
93 95
 @file{INPUT}, converted to raw audio and video packets, and store it
94 96
 in the file @file{out.crc}:
... ...
@@ -132,6 +138,8 @@ packet of the form:
132 132
 @var{MD5} is a hexadecimal number representing the computed MD5 hash
133 133
 for the packet.
134 134
 
135
+@subsection Examples
136
+
135 137
 For example to compute the MD5 of the audio and video frames in
136 138
 @file{INPUT}, converted to raw audio and video packets, and store it
137 139
 in the file @file{out.md5}:
... ...
@@ -200,6 +208,8 @@ See also the @ref{segment} muxer, which provides a more generic and
200 200
 flexible implementation of a segmenter, and can be used to perform HLS
201 201
 segmentation.
202 202
 
203
+@subsection Options
204
+
203 205
 This muxer supports the following options:
204 206
 
205 207
 @table @option
... ...
@@ -292,6 +302,8 @@ The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
292 292
 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
293 293
 etc.
294 294
 
295
+@subsection Examples
296
+
295 297
 The following example shows how to use @command{ffmpeg} for creating a
296 298
 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
297 299
 taking one image every second from the input video:
... ...
@@ -354,6 +366,8 @@ Matroska container muxer.
354 354
 
355 355
 This muxer implements the matroska and webm container specs.
356 356
 
357
+@subsection Metadata
358
+
357 359
 The recognized metadata settings in this muxer are:
358 360
 
359 361
 @table @option
... ...
@@ -411,6 +425,8 @@ For example a 3D WebM clip can be created using the following command line:
411 411
 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
412 412
 @end example
413 413
 
414
+@subsection Options
415
+
414 416
 This muxer supports the following options:
415 417
 
416 418
 @table @option
... ...
@@ -475,6 +491,8 @@ very long files (since writing normal MOV/MP4 files stores info about
475 475
 every single packet in memory until the file is closed). The downside
476 476
 is that it is less compatible with other applications.
477 477
 
478
+@subsection Options
479
+
478 480
 Fragmentation is enabled by setting one of the AVOptions that define
479 481
 how to cut the file into fragments:
480 482
 
... ...
@@ -531,6 +549,8 @@ as fragmented output, thus it is not enabled by default.
531 531
 Add RTP hinting tracks to the output file.
532 532
 @end table
533 533
 
534
+@subsection Example
535
+
534 536
 Smooth Streaming content can be pushed in real time to a publishing
535 537
 point on IIS with this muxer. Example:
536 538
 @example
... ...
@@ -587,6 +607,13 @@ MPEG transport stream muxer.
587 587
 
588 588
 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
589 589
 
590
+The recognized metadata settings in mpegts muxer are @code{service_provider}
591
+and @code{service_name}. If they are not set the default for
592
+@code{service_provider} is "FFmpeg" and the default for
593
+@code{service_name} is "Service01".
594
+
595
+@subsection Options
596
+
590 597
 The muxer options are:
591 598
 
592 599
 @table @option
... ...
@@ -639,10 +666,7 @@ Reemit PAT/PMT before writing the next packet.
639 639
 Use LATM packetization for AAC.
640 640
 @end table
641 641
 
642
-The recognized metadata settings in mpegts muxer are @code{service_provider}
643
-and @code{service_name}. If they are not set the default for
644
-@code{service_provider} is "FFmpeg" and the default for
645
-@code{service_name} is "Service01".
642
+@subsection Example
646 643
 
647 644
 @example
648 645
 ffmpeg -i file.mpg -c copy \
... ...
@@ -727,6 +751,8 @@ files.
727 727
 See also the @ref{hls} muxer, which provides a more specific
728 728
 implementation for HLS segmentation.
729 729
 
730
+@subsection Options
731
+
730 732
 The segment muxer supports the following options:
731 733
 
732 734
 @table @option
... ...
@@ -970,7 +996,8 @@ specified by a stream specifier. If not specified, this defaults to
970 970
 all the input streams.
971 971
 @end table
972 972
 
973
-Some examples follow.
973
+@subsection Examples
974
+
974 975
 @itemize
975 976
 @item
976 977
 Encode something and both archive it in a WebM file and stream it