summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2013-05-03 13:16:34 +0200
committerMichael Niedermayer <michaelni@gmx.at>2013-05-03 13:16:34 +0200
commit6537827189153cd1c6944403a48d7ff76f7b8228 (patch)
treee713d2f95acea7b929949d6836f037fc71e5a359 /doc
parent2e0cc34292d25526f9b91752aa980fd740a0edf7 (diff)
parente3b225a4fe0ff1e64a220b757c6f0a5cf9258521 (diff)
Merge commit 'e3b225a4fe0ff1e64a220b757c6f0a5cf9258521'
* commit 'e3b225a4fe0ff1e64a220b757c6f0a5cf9258521': matroskaenc: add an option to put the index at the start of the file Conflicts: doc/muxers.texi libavformat/matroskaenc.c libavformat/version.h Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/muxers.texi21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/muxers.texi b/doc/muxers.texi
index f1274948f8..dc627dc968 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -489,6 +489,27 @@ 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
+This muxer supports the following options:
+
+@table @option
+
+@item reserve_index_space
+By default, this muxer writes the index for seeking (called cues in Matroska
+terms) at the end of the file, because it cannot know in advance how much space
+to leave for the index at the beginning of the file. However for some use cases
+-- e.g. streaming where seeking is possible but slow -- it is useful to put the
+index at the beginning of the file.
+
+If this option is set to a non-zero value, the muxer will reserve a given amount
+of space in the file header and then try to write the cues there when the muxing
+finishes. If the available space does not suffice, muxing will fail. A safe size
+for most use cases should be about 50kB per hour of video.
+
+Note that cues are only written if the output is seekable and this option will
+have no effect if it is not.
+
+@end table
+
@section segment, stream_segment, ssegment
Basic stream segmenter.