Merge remote-tracking branch 'qatar/master'

[ffmpeg] / doc / muxers.texi

diff --git a/doc/muxers.texi b/doc/muxers.texi
index b5a27d18445df28669a96a6f43895d487a81bfe0..83c21dba678d6a24c297a8cca108c3a35dd5b91e 100644 (file)
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -479,6 +479,24 @@ extension.
 @item segment_list @var{name}
 Generate also a listfile named @var{name}. If not specified no
 listfile is generated.
+@item segment_list_flags @var{flags}
+Set flags affecting the segment list generation.
+
+It currently supports the following flags:
+@table @var
+@item cache
+Allow caching (only affects M3U8 list files).
+
+@item live
+Allow live-friendly file generation.
+
+This currently only affects M3U8 lists. In particular, write a fake
+EXT-X-TARGETDURATION duration field at the top of the file, based on
+the specified @var{segment_time}.
+@end table
+
+Default value is @code{cache}.
+
 @item segment_list_size @var{size}
 Overwrite the listfile once it reaches @var{size} entries. If 0
 the listfile is never overwritten. Default value is 0.
@@ -490,21 +508,25 @@ The following values are recognized:
 @item flat
 Generate a flat list for the created segments, one segment per line.
 
-@item ext
+@item csv, ext
 Generate a list for the created segments, one segment per line,
-each line matching the format:
+each line matching the format (comma-separated values):
 @example
 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
 @end example
 
 @var{segment_filename} is the name of the output file generated by the
-muxer according to the provided pattern, and should not contain the
-"," character for simplifying parsing operations.
+muxer according to the provided pattern. CSV escaping (according to
+RFC4180) is applied if required.
 
 @var{segment_start_time} and @var{segment_end_time} specify
 the segment start and end time expressed in seconds.
 
-A list file with the suffix @code{".ext"} will auto-select this format.
+A list file with the suffix @code{".csv"} or @code{".ext"} will
+auto-select this format.
+
+@code{ext} is deprecated in favor or @code{csv}.
+
 @item m3u8
 Generate an extended M3U8 file, version 4, compliant with
 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming-08.txt}.
@@ -559,7 +581,7 @@ ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nu
 As the example above, but segment the input file according to the split
 points specified by the @var{segment_times} option:
 @example
-ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.ext -segment_times 1,2,3,5,8,13,21 out%03d.nut
+ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 out%03d.nut
 @end example
 
 @item
@@ -569,7 +591,7 @@ with the segment option @var{segment_time_delta} to account for
 possible roundings operated when setting key frame times.
 @example
 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -vcodec mpeg4 -acodec pcm_s16le -map 0 \
--f segment -segment_list out.ext -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
+-f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
 @end example
 In order to force key frames on the input file, transcoding is
 required.
@@ -580,6 +602,14 @@ and @code{libfaac} encoders:
 @example
 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
 @end example
+
+@item
+Segment the input file, and create an M3U8 live playlist (can be used
+as live HLS source):
+@example
+ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
+-segment_list_flags +live -segment_time 10 out%03d.mkv
+@end example
 @end itemize
 
 @section mp3