Browse code

doc/muxers: add AVI muxer documentation

Reviewed-by: Michael Niedermayer <michael@niedermayer.cc>
Signed-off-by: Tobias Rapp <t.rapp@noa-archive.com>

Tobias Rapp authored on 2017/01/05 19:17:39
Showing 1 changed files
... ...
@@ -57,6 +57,39 @@ fragmentation or muxer overhead depending on your source. Default value is
57 57
 
58 58
 @end table
59 59
 
60
+@anchor{avi}
61
+@section avi
62
+
63
+Audio Video Interleaved muxer.
64
+
65
+@subsection Options
66
+
67
+It accepts the following options:
68
+
69
+@table @option
70
+@item reserve_index_space
71
+Reserve the specified amount of bytes for the OpenDML master index of each
72
+stream within the file header. By default additional master indexes are
73
+embedded within the data packets if there is no space left in the first master
74
+index and are linked together as a chain of indexes. This index structure can
75
+cause problems for some use cases, e.g. third-party software strictly relying
76
+on the OpenDML index specification or when file seeking is slow. Reserving
77
+enough index space in the file header avoids these problems.
78
+
79
+The required index space depends on the output file size and should be about 16
80
+bytes per gigabyte. When this option is omitted or set to zero the necessary
81
+index space is guessed.
82
+
83
+@item write_channel_mask
84
+Write the channel layout mask into the audio stream header.
85
+
86
+This option is enabled by default. Disabling the channel mask can be useful in
87
+specific scenarios, e.g. when merging multiple audio streams into one for
88
+compatibility with software that only supports a single audio stream in AVI
89
+(see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
90
+
91
+@end table
92
+
60 93
 @anchor{chromaprint}
61 94
 @section chromaprint
62 95