avformat/dashenc: Added option for Segment file format
[ffmpeg.git] / doc / muxers.texi
1 @chapter Muxers
2 @c man begin MUXERS
3
4 Muxers are configured elements in FFmpeg which allow writing
5 multimedia streams to a particular type of file.
6
7 When you configure your FFmpeg build, all the supported muxers
8 are enabled by default. You can list all available muxers using the
9 configure option @code{--list-muxers}.
10
11 You can disable all the muxers with the configure option
12 @code{--disable-muxers} and selectively enable / disable single muxers
13 with the options @code{--enable-muxer=@var{MUXER}} /
14 @code{--disable-muxer=@var{MUXER}}.
15
16 The option @code{-muxers} of the ff* tools will display the list of
17 enabled muxers. Use @code{-formats} to view a combined list of
18 enabled demuxers and muxers.
19
20 A description of some of the currently available muxers follows.
21
22 @anchor{aiff}
23 @section aiff
24
25 Audio Interchange File Format muxer.
26
27 @subsection Options
28
29 It accepts the following options:
30
31 @table @option
32 @item write_id3v2
33 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
34
35 @item id3v2_version
36 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
37 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
38
39 @end table
40
41 @anchor{asf}
42 @section asf
43
44 Advanced Systems Format muxer.
45
46 Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this
47 muxer too.
48
49 @subsection Options
50
51 It accepts the following options:
52
53 @table @option
54 @item packet_size
55 Set the muxer packet size. By tuning this setting you may reduce data
56 fragmentation or muxer overhead depending on your source. Default value is
57 3200, minimum is 100, maximum is 64k.
58
59 @end table
60
61 @anchor{avi}
62 @section avi
63
64 Audio Video Interleaved muxer.
65
66 @subsection Options
67
68 It accepts the following options:
69
70 @table @option
71 @item reserve_index_space
72 Reserve the specified amount of bytes for the OpenDML master index of each
73 stream within the file header. By default additional master indexes are
74 embedded within the data packets if there is no space left in the first master
75 index and are linked together as a chain of indexes. This index structure can
76 cause problems for some use cases, e.g. third-party software strictly relying
77 on the OpenDML index specification or when file seeking is slow. Reserving
78 enough index space in the file header avoids these problems.
79
80 The required index space depends on the output file size and should be about 16
81 bytes per gigabyte. When this option is omitted or set to zero the necessary
82 index space is guessed.
83
84 @item write_channel_mask
85 Write the channel layout mask into the audio stream header.
86
87 This option is enabled by default. Disabling the channel mask can be useful in
88 specific scenarios, e.g. when merging multiple audio streams into one for
89 compatibility with software that only supports a single audio stream in AVI
90 (see @ref{amerge,,the "amerge" section in the ffmpeg-filters manual,ffmpeg-filters}).
91
92 @end table
93
94 @anchor{chromaprint}
95 @section chromaprint
96
97 Chromaprint fingerprinter
98
99 This muxer feeds audio data to the Chromaprint library, which generates
100 a fingerprint for the provided audio data. It takes a single signed
101 native-endian 16-bit raw audio stream.
102
103 @subsection Options
104
105 @table @option
106 @item silence_threshold
107 Threshold for detecting silence, ranges from 0 to 32767. -1 for default
108 (required for use with the AcoustID service).
109
110 @item algorithm
111 Algorithm index to fingerprint with.
112
113 @item fp_format
114 Format to output the fingerprint as. Accepts the following options:
115 @table @samp
116 @item raw
117 Binary raw fingerprint
118
119 @item compressed
120 Binary compressed fingerprint
121
122 @item base64
123 Base64 compressed fingerprint
124
125 @end table
126
127 @end table
128
129 @anchor{crc}
130 @section crc
131
132 CRC (Cyclic Redundancy Check) testing format.
133
134 This muxer computes and prints the Adler-32 CRC of all the input audio
135 and video frames. By default audio frames are converted to signed
136 16-bit raw audio and video frames to raw video before computing the
137 CRC.
138
139 The output of the muxer consists of a single line of the form:
140 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
141 8 digits containing the CRC for all the decoded input frames.
142
143 See also the @ref{framecrc} muxer.
144
145 @subsection Examples
146
147 For example to compute the CRC of the input, and store it in the file
148 @file{out.crc}:
149 @example
150 ffmpeg -i INPUT -f crc out.crc
151 @end example
152
153 You can print the CRC to stdout with the command:
154 @example
155 ffmpeg -i INPUT -f crc -
156 @end example
157
158 You can select the output format of each frame with @command{ffmpeg} by
159 specifying the audio and video codec and format. For example to
160 compute the CRC of the input audio converted to PCM unsigned 8-bit
161 and the input video converted to MPEG-2 video, use the command:
162 @example
163 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
164 @end example
165
166 @section flv
167
168 Adobe Flash Video Format muxer.
169
170 This muxer accepts the following options:
171
172 @table @option
173
174 @item flvflags @var{flags}
175 Possible values:
176
177 @table @samp
178
179 @item aac_seq_header_detect
180 Place AAC sequence header based on audio stream data.
181
182 @item no_sequence_end
183 Disable sequence end tag.
184
185 @item no_metadata
186 Disable metadata tag.
187
188 @item no_duration_filesize
189 Disable duration and filesize in metadata when they are equal to zero
190 at the end of stream. (Be used to non-seekable living stream).
191
192 @item add_keyframe_index
193 Used to facilitate seeking; particularly for HTTP pseudo streaming.
194 @end table
195 @end table
196
197 @anchor{dash}
198 @section dash
199
200 Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments
201 and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014.
202
203 For more information see:
204
205 @itemize @bullet
206 @item
207 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
208 @item
209 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
210 @end itemize
211
212 It creates a MPD manifest file and segment files for each stream.
213
214 The segment filename might contain pre-defined identifiers used with SegmentTemplate
215 as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$",
216 "$Number$", "$Bandwidth$" and "$Time$".
217
218 @example
219 ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264
220 -b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline
221 -profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0
222 -b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1
223 -window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a"
224 -f dash /path/to/out.mpd
225 @end example
226
227 @table @option
228 @item -min_seg_duration @var{microseconds}
229 This is a deprecated option to set the segment length in microseconds, use @var{seg_duration} instead.
230 @item -seg_duration @var{duration}
231 Set the segment length in seconds (fractional value can be set). The value is
232 treated as average segment duration when @var{use_template} is enabled and
233 @var{use_timeline} is disabled and as minimum segment duration for all the other
234 use cases.
235 @item -window_size @var{size}
236 Set the maximum number of segments kept in the manifest.
237 @item -extra_window_size @var{size}
238 Set the maximum number of segments kept outside of the manifest before removing from disk.
239 @item -remove_at_exit @var{remove}
240 Enable (1) or disable (0) removal of all segments when finished.
241 @item -use_template @var{template}
242 Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList.
243 @item -use_timeline @var{timeline}
244 Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate.
245 @item -single_file @var{single_file}
246 Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges.
247 @item -single_file_name @var{file_name}
248 DASH-templated name to be used for baseURL. Implies @var{single_file} set to "1".
249 @item -init_seg_name @var{init_name}
250 DASH-templated name to used for the initialization segment. Default is "init-stream$RepresentationID$.m4s"
251 @item -media_seg_name @var{segment_name}
252 DASH-templated name to used for the media segments. Default is "chunk-stream$RepresentationID$-$Number%05d$.m4s"
253 @item -utc_timing_url @var{utc_url}
254 URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso"
255 @item method @var{method}
256 Use the given HTTP method to create output files. Generally set to PUT or POST.
257 @item -http_user_agent @var{user_agent}
258 Override User-Agent field in HTTP header. Applicable only for HTTP output.
259 @item -http_persistent @var{http_persistent}
260 Use persistent HTTP connections. Applicable only for HTTP output.
261 @item -hls_playlist @var{hls_playlist}
262 Generate HLS playlist files as well. The master playlist is generated with the filename master.m3u8.
263 One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc.
264 @item -streaming @var{streaming}
265 Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming
266 mode, each frame will be a moof fragment which forms a chunk.
267 @item -adaptation_sets @var{adaptation_sets}
268 Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs
269 of the adaptation sets and a,b,c,d and e are the indices of the mapped streams.
270
271 To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs.
272
273 When no assignment is defined, this defaults to an AdaptationSet for each stream.
274 @item -timeout @var{timeout}
275 Set timeout for socket I/O operations. Applicable only for HTTP output.
276 @item -index_correction @var{index_correction}
277 Enable (1) or Disable (0) segment index correction logic. Applicable only when
278 @var{use_template} is enabled and @var{use_timeline} is disabled.
279
280 When enabled, the logic monitors the flow of segment indexes. If a streams's
281 segment index value is not at the expected real time position, then the logic
282 corrects that index value.
283
284 Typically this logic is needed in live streaming use cases. The network bandwidth
285 fluctuations are common during long run streaming. Each fluctuation can cause
286 the segment indexes fall behind the expected real time position.
287 @item -format_options @var{options_list}
288 Set container format (mp4/webm) options using a @code{:} separated list of
289 key=value parameters. Values containing @code{:} special characters must be
290 escaped.
291
292 @item dash_segment_type @var{dash_segment_type}
293 Possible values:
294 @item mp4
295 If this flag is set, the dash segment files will be in in ISOBMFF format. This is the default format.
296
297 @item webm
298 If this flag is set, the dash segment files will be in in WebM format.
299
300 @end table
301
302 @anchor{framecrc}
303 @section framecrc
304
305 Per-packet CRC (Cyclic Redundancy Check) testing format.
306
307 This muxer computes and prints the Adler-32 CRC for each audio
308 and video packet. By default audio frames are converted to signed
309 16-bit raw audio and video frames to raw video before computing the
310 CRC.
311
312 The output of the muxer consists of a line for each audio and video
313 packet of the form:
314 @example
315 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
316 @end example
317
318 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
319 CRC of the packet.
320
321 @subsection Examples
322
323 For example to compute the CRC of the audio and video frames in
324 @file{INPUT}, converted to raw audio and video packets, and store it
325 in the file @file{out.crc}:
326 @example
327 ffmpeg -i INPUT -f framecrc out.crc
328 @end example
329
330 To print the information to stdout, use the command:
331 @example
332 ffmpeg -i INPUT -f framecrc -
333 @end example
334
335 With @command{ffmpeg}, you can select the output format to which the
336 audio and video frames are encoded before computing the CRC for each
337 packet by specifying the audio and video codec. For example, to
338 compute the CRC of each decoded input audio frame converted to PCM
339 unsigned 8-bit and of each decoded input video frame converted to
340 MPEG-2 video, use the command:
341 @example
342 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
343 @end example
344
345 See also the @ref{crc} muxer.
346
347 @anchor{framehash}
348 @section framehash
349
350 Per-packet hash testing format.
351
352 This muxer computes and prints a cryptographic hash for each audio
353 and video packet. This can be used for packet-by-packet equality
354 checks without having to individually do a binary comparison on each.
355
356 By default audio frames are converted to signed 16-bit raw audio and
357 video frames to raw video before computing the hash, but the output
358 of explicit conversions to other codecs can also be used. It uses the
359 SHA-256 cryptographic hash function by default, but supports several
360 other algorithms.
361
362 The output of the muxer consists of a line for each audio and video
363 packet of the form:
364 @example
365 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{hash}
366 @end example
367
368 @var{hash} is a hexadecimal number representing the computed hash
369 for the packet.
370
371 @table @option
372 @item hash @var{algorithm}
373 Use the cryptographic hash function specified by the string @var{algorithm}.
374 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
375 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
376 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
377 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
378
379 @end table
380
381 @subsection Examples
382
383 To compute the SHA-256 hash of the audio and video frames in @file{INPUT},
384 converted to raw audio and video packets, and store it in the file
385 @file{out.sha256}:
386 @example
387 ffmpeg -i INPUT -f framehash out.sha256
388 @end example
389
390 To print the information to stdout, using the MD5 hash function, use
391 the command:
392 @example
393 ffmpeg -i INPUT -f framehash -hash md5 -
394 @end example
395
396 See also the @ref{hash} muxer.
397
398 @anchor{framemd5}
399 @section framemd5
400
401 Per-packet MD5 testing format.
402
403 This is a variant of the @ref{framehash} muxer. Unlike that muxer,
404 it defaults to using the MD5 hash function.
405
406 @subsection Examples
407
408 To compute the MD5 hash of the audio and video frames in @file{INPUT},
409 converted to raw audio and video packets, and store it in the file
410 @file{out.md5}:
411 @example
412 ffmpeg -i INPUT -f framemd5 out.md5
413 @end example
414
415 To print the information to stdout, use the command:
416 @example
417 ffmpeg -i INPUT -f framemd5 -
418 @end example
419
420 See also the @ref{framehash} and @ref{md5} muxers.
421
422 @anchor{gif}
423 @section gif
424
425 Animated GIF muxer.
426
427 It accepts the following options:
428
429 @table @option
430 @item loop
431 Set the number of times to loop the output. Use @code{-1} for no loop, @code{0}
432 for looping indefinitely (default).
433
434 @item final_delay
435 Force the delay (expressed in centiseconds) after the last frame. Each frame
436 ends with a delay until the next frame. The default is @code{-1}, which is a
437 special value to tell the muxer to re-use the previous delay. In case of a
438 loop, you might want to customize this value to mark a pause for instance.
439 @end table
440
441 For example, to encode a gif looping 10 times, with a 5 seconds delay between
442 the loops:
443 @example
444 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
445 @end example
446
447 Note 1: if you wish to extract the frames into separate GIF files, you need to
448 force the @ref{image2} muxer:
449 @example
450 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
451 @end example
452
453 Note 2: the GIF format has a very large time base: the delay between two frames
454 can therefore not be smaller than one centi second.
455
456 @anchor{hash}
457 @section hash
458
459 Hash testing format.
460
461 This muxer computes and prints a cryptographic hash of all the input
462 audio and video frames. This can be used for equality checks without
463 having to do a complete binary comparison.
464
465 By default audio frames are converted to signed 16-bit raw audio and
466 video frames to raw video before computing the hash, but the output
467 of explicit conversions to other codecs can also be used. Timestamps
468 are ignored. It uses the SHA-256 cryptographic hash function by default,
469 but supports several other algorithms.
470
471 The output of the muxer consists of a single line of the form:
472 @var{algo}=@var{hash}, where @var{algo} is a short string representing
473 the hash function used, and @var{hash} is a hexadecimal number
474 representing the computed hash.
475
476 @table @option
477 @item hash @var{algorithm}
478 Use the cryptographic hash function specified by the string @var{algorithm}.
479 Supported values include @code{MD5}, @code{murmur3}, @code{RIPEMD128},
480 @code{RIPEMD160}, @code{RIPEMD256}, @code{RIPEMD320}, @code{SHA160},
481 @code{SHA224}, @code{SHA256} (default), @code{SHA512/224}, @code{SHA512/256},
482 @code{SHA384}, @code{SHA512}, @code{CRC32} and @code{adler32}.
483
484 @end table
485
486 @subsection Examples
487
488 To compute the SHA-256 hash of the input converted to raw audio and
489 video, and store it in the file @file{out.sha256}:
490 @example
491 ffmpeg -i INPUT -f hash out.sha256
492 @end example
493
494 To print an MD5 hash to stdout use the command:
495 @example
496 ffmpeg -i INPUT -f hash -hash md5 -
497 @end example
498
499 See also the @ref{framehash} muxer.
500
501 @anchor{hls}
502 @section hls
503
504 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
505 the HTTP Live Streaming (HLS) specification.
506
507 It creates a playlist file, and one or more segment files. The output filename
508 specifies the playlist filename.
509
510 By default, the muxer creates a file for each segment produced. These files
511 have the same name as the playlist, followed by a sequential number and a
512 .ts extension.
513
514 Make sure to require a closed GOP when encoding and to set the GOP
515 size to fit your segment time constraint.
516
517 For example, to convert an input file with @command{ffmpeg}:
518 @example
519 ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
520 @end example
521 This example will produce the playlist, @file{out.m3u8}, and segment files:
522 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
523
524 See also the @ref{segment} muxer, which provides a more generic and
525 flexible implementation of a segmenter, and can be used to perform HLS
526 segmentation.
527
528 @subsection Options
529
530 This muxer supports the following options:
531
532 @table @option
533 @item hls_init_time @var{seconds}
534 Set the initial target segment length in seconds. Default value is @var{0}.
535 Segment will be cut on the next key frame after this time has passed on the first m3u8 list.
536 After the initial playlist is filled @command{ffmpeg} will cut segments
537 at duration equal to @code{hls_time}
538
539 @item hls_time @var{seconds}
540 Set the target segment length in seconds. Default value is 2.
541 Segment will be cut on the next key frame after this time has passed.
542
543 @item hls_list_size @var{size}
544 Set the maximum number of playlist entries. If set to 0 the list file
545 will contain all the segments. Default value is 5.
546
547 @item hls_delete_threshold @var{size}
548 Set the number of unreferenced segments to keep on disk before @code{hls_flags delete_segments}
549 deletes them. Increase this to allow continue clients to download segments which
550 were recently referenced in the playlist. Default value is 1, meaning segments older than
551 @code{hls_list_size+1} will be deleted.
552
553 @item hls_ts_options @var{options_list}
554 Set output format options using a :-separated list of key=value
555 parameters. Values containing @code{:} special characters must be
556 escaped.
557
558 @item hls_wrap @var{wrap}
559 This is a deprecated option, you can use @code{hls_list_size}
560 and @code{hls_flags delete_segments} instead it
561
562 This option is useful to avoid to fill the disk with many segment
563 files, and limits the maximum number of segment files written to disk
564 to @var{wrap}.
565
566
567 @item hls_start_number_source
568 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) according to the specified source.
569 Unless @code{hls_flags single_file} is set, it also specifies source of starting sequence numbers of
570 segment and subtitle filenames. In any case, if @code{hls_flags append_list}
571 is set and read playlist sequence number is greater than the specified start sequence number,
572 then that value will be used as start value.
573
574 It accepts the following values:
575
576 @table @option
577
578 @item generic (default)
579 Set the starting sequence numbers according to @var{start_number} option value.
580
581 @item epoch
582 The start number will be the seconds since epoch (1970-01-01 00:00:00)
583
584 @item datetime
585 The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759.
586
587 @end table
588
589 @item start_number @var{number}
590 Start the playlist sequence number (@code{#EXT-X-MEDIA-SEQUENCE}) from the specified @var{number}
591 when @var{hls_start_number_source} value is @var{generic}. (This is the default case.)
592 Unless @code{hls_flags single_file} is set, it also specifies starting sequence numbers of segment and subtitle filenames.
593 Default value is 0.
594
595 @item hls_allow_cache @var{allowcache}
596 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
597
598 @item hls_base_url @var{baseurl}
599 Append @var{baseurl} to every entry in the playlist.
600 Useful to generate playlists with absolute paths.
601
602 Note that the playlist sequence number must be unique for each segment
603 and it is not to be confused with the segment filename sequence number
604 which can be cyclic, for example if the @option{wrap} option is
605 specified.
606
607 @item hls_segment_filename @var{filename}
608 Set the segment filename. Unless @code{hls_flags single_file} is set,
609 @var{filename} is used as a string format with the segment number:
610 @example
611 ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
612 @end example
613 This example will produce the playlist, @file{out.m3u8}, and segment files:
614 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
615
616 @var{filename} may contain full path or relative path specification,
617 but only the file name part without any path info will be contained in the m3u8 segment list.
618 Should a relative path be specified, the path of the created segment
619 files will be relative to the current working directory.
620 When use_localtime_mkdir is set, the whole expanded value of @var{filename} will be written into the m3u8 segment list.
621
622 When @code{var_stream_map} is set with two or more variant streams, the
623 @var{filename} pattern must contain the string "%v", this string specifies
624 the position of variant stream index in the generated segment file names.
625 @example
626 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
627   -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
628   -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
629 @end example
630 This example will produce the playlists segment file sets:
631 @file{file_0_000.ts}, @file{file_0_001.ts}, @file{file_0_002.ts}, etc. and
632 @file{file_1_000.ts}, @file{file_1_001.ts}, @file{file_1_002.ts}, etc.
633
634 The string "%v" may be present in the filename or in the last directory name
635 containing the file. If the string is present in the directory name, then
636 sub-directories are created after expanding the directory name pattern. This
637 enables creation of segments corresponding to different variant streams in
638 subdirectories.
639 @example
640 ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
641   -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
642   -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
643 @end example
644 This example will produce the playlists segment file sets:
645 @file{vs0/file_000.ts}, @file{vs0/file_001.ts}, @file{vs0/file_002.ts}, etc. and
646 @file{vs1/file_000.ts}, @file{vs1/file_001.ts}, @file{vs1/file_002.ts}, etc.
647
648 @item use_localtime
649 Use strftime() on @var{filename} to expand the segment filename with localtime.
650 The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index
651 hls_flag and %%d will be the specifier.
652 @example
653 ffmpeg -i in.nut -use_localtime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
654 @end example
655 This example will produce the playlist, @file{out.m3u8}, and segment files:
656 @file{file-20160215-1455569023.ts}, @file{file-20160215-1455569024.ts}, etc.
657 Note: On some systems/environments, the @code{%s} specifier is not available. See
658   @code{strftime()} documentation.
659 @example
660 ffmpeg -i in.nut -use_localtime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
661 @end example
662 This example will produce the playlist, @file{out.m3u8}, and segment files:
663 @file{file-20160215-0001.ts}, @file{file-20160215-0002.ts}, etc.
664
665 @item use_localtime_mkdir
666 Used together with -use_localtime, it will create all subdirectories which
667 is expanded in @var{filename}.
668 @example
669 ffmpeg -i in.nut -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
670 @end example
671 This example will create a directory 201560215 (if it does not exist), and then
672 produce the playlist, @file{out.m3u8}, and segment files:
673 @file{20160215/file-20160215-1455569023.ts}, @file{20160215/file-20160215-1455569024.ts}, etc.
674
675 @example
676 ffmpeg -i in.nut -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
677 @end example
678 This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then
679 produce the playlist, @file{out.m3u8}, and segment files:
680 @file{2016/02/15/file-20160215-1455569023.ts}, @file{2016/02/15/file-20160215-1455569024.ts}, etc.
681
682
683 @item hls_key_info_file @var{key_info_file}
684 Use the information in @var{key_info_file} for segment encryption. The first
685 line of @var{key_info_file} specifies the key URI written to the playlist. The
686 key URL is used to access the encryption key during playback. The second line
687 specifies the path to the key file used to obtain the key during the encryption
688 process. The key file is read as a single packed array of 16 octets in binary
689 format. The optional third line specifies the initialization vector (IV) as a
690 hexadecimal string to be used instead of the segment sequence number (default)
691 for encryption. Changes to @var{key_info_file} will result in segment
692 encryption with the new key/IV and an entry in the playlist for the new key
693 URI/IV if @code{hls_flags periodic_rekey} is enabled.
694
695 Key info file format:
696 @example
697 @var{key URI}
698 @var{key file path}
699 @var{IV} (optional)
700 @end example
701
702 Example key URIs:
703 @example
704 http://server/file.key
705 /path/to/file.key
706 file.key
707 @end example
708
709 Example key file paths:
710 @example
711 file.key
712 /path/to/file.key
713 @end example
714
715 Example IV:
716 @example
717 0123456789ABCDEF0123456789ABCDEF
718 @end example
719
720 Key info file example:
721 @example
722 http://server/file.key
723 /path/to/file.key
724 0123456789ABCDEF0123456789ABCDEF
725 @end example
726
727 Example shell script:
728 @example
729 #!/bin/sh
730 BASE_URL=$@{1:-'.'@}
731 openssl rand 16 > file.key
732 echo $BASE_URL/file.key > file.keyinfo
733 echo file.key >> file.keyinfo
734 echo $(openssl rand -hex 16) >> file.keyinfo
735 ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
736   -hls_key_info_file file.keyinfo out.m3u8
737 @end example
738
739 @item -hls_enc @var{enc}
740 Enable (1) or disable (0) the AES128 encryption.
741 When enabled every segment generated is encrypted and the encryption key
742 is saved as @var{playlist name}.key.
743
744 @item -hls_enc_key @var{key}
745 Hex-coded 16byte key to encrypt the segments, by default it
746 is randomly generated.
747
748 @item -hls_enc_key_url @var{keyurl}
749 If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
750 in the playlist.
751
752 @item -hls_enc_iv @var{iv}
753 Hex-coded 16byte initialization vector for every segment instead
754 of the autogenerated ones.
755
756 @item hls_segment_type @var{flags}
757 Possible values:
758
759 @table @samp
760 @item mpegts
761 If this flag is set, the hls segment files will format to mpegts.
762 the mpegts files is used in all hls versions.
763
764 @item fmp4
765 If this flag is set, the hls segment files will format to fragment mp4 looks like dash.
766 the fmp4 files is used in hls after version 7.
767
768 @end table
769
770 @item hls_fmp4_init_filename @var{filename}
771 set filename to the fragment files header file, default filename is @file{init.mp4}.
772
773 When @code{var_stream_map} is set with two or more variant streams, the
774 @var{filename} pattern must contain the string "%v", this string specifies
775 the position of variant stream index in the generated init file names.
776 The string "%v" may be present in the filename or in the last directory name
777 containing the file. If the string is present in the directory name, then
778 sub-directories are created after expanding the directory name pattern. This
779 enables creation of init files corresponding to different variant streams in
780 subdirectories.
781
782 @item hls_flags @var{flags}
783 Possible values:
784
785 @table @samp
786 @item single_file
787 If this flag is set, the muxer will store all segments in a single MPEG-TS
788 file, and will use byte ranges in the playlist. HLS playlists generated with
789 this way will have the version number 4.
790 For example:
791 @example
792 ffmpeg -i in.nut -hls_flags single_file out.m3u8
793 @end example
794 Will produce the playlist, @file{out.m3u8}, and a single segment file,
795 @file{out.ts}.
796
797 @item delete_segments
798 Segment files removed from the playlist are deleted after a period of time
799 equal to the duration of the segment plus the duration of the playlist.
800
801 @item append_list
802 Append new segments into the end of old segment list,
803 and remove the @code{#EXT-X-ENDLIST} from the old segment list.
804
805 @item round_durations
806 Round the duration info in the playlist file segment info to integer
807 values, instead of using floating point.
808
809 @item discont_start
810 Add the @code{#EXT-X-DISCONTINUITY} tag to the playlist, before the
811 first segment's information.
812
813 @item omit_endlist
814 Do not append the @code{EXT-X-ENDLIST} tag at the end of the playlist.
815
816 @item periodic_rekey
817 The file specified by @code{hls_key_info_file} will be checked periodically and
818 detect updates to the encryption info. Be sure to replace this file atomically,
819 including the file containing the AES encryption key.
820
821 @item independent_segments
822 Add the @code{#EXT-X-INDEPENDENT-SEGMENTS} to playlists that has video segments
823 and when all the segments of that playlist are guaranteed to start with a Key frame.
824
825 @item split_by_time
826 Allow segments to start on frames other than keyframes. This improves
827 behavior on some players when the time between keyframes is inconsistent,
828 but may make things worse on others, and can cause some oddities during
829 seeking. This flag should be used with the @code{hls_time} option.
830
831 @item program_date_time
832 Generate @code{EXT-X-PROGRAM-DATE-TIME} tags.
833
834 @item second_level_segment_index
835 Makes it possible to use segment indexes as %%d in hls_segment_filename expression
836 besides date/time values when use_localtime is on.
837 To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width.
838
839 @item second_level_segment_size
840 Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename
841 expression besides date/time values when use_localtime is on.
842 To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width.
843
844 @item second_level_segment_duration
845 Makes it possible to use segment duration (calculated  in microseconds) as %%t in hls_segment_filename
846 expression besides date/time values when use_localtime is on.
847 To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width.
848
849 @example
850 ffmpeg -i sample.mpeg \
851    -f hls -hls_time 3 -hls_list_size 5 \
852    -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
853    -use_localtime 1 -use_localtime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
854 @end example
855 This will produce segments like this:
856 @file{segment_20170102194334_0003_00122200_0000003000000.ts}, @file{segment_20170102194334_0004_00120072_0000003000000.ts} etc.
857
858 @item temp_file
859 Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver
860 serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments
861 before they have been added to the m3u8 playlist.
862
863 @end table
864
865 @item hls_playlist_type event
866 Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
867 @option{hls_list_size} to 0; the playlist can only be appended to.
868
869 @item hls_playlist_type vod
870 Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
871 @option{hls_list_size} to 0; the playlist must not change.
872
873 @item method
874 Use the given HTTP method to create the hls files.
875 @example
876 ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
877 @end example
878 This example will upload all the mpegts segment files to the HTTP
879 server using the HTTP PUT method, and update the m3u8 files every
880 @code{refresh} times using the same method.
881 Note that the HTTP server must support the given method for uploading
882 files.
883
884 @item http_user_agent
885 Override User-Agent field in HTTP header. Applicable only for HTTP output.
886
887 @item var_stream_map
888 Map string which specifies how to group the audio, video and subtitle streams
889 into different variant streams. The variant stream groups are separated
890 by space.
891 Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are
892 the keys to specify audio, video and subtitle streams respectively.
893 Allowed values are 0 to 9 (limited just based on practical usage).
894
895 When there are two or more variant streams, the output filename pattern must
896 contain the string "%v", this string specifies the position of variant stream
897 index in the output media playlist filenames. The string "%v" may be present in
898 the filename or in the last directory name containing the file. If the string is
899 present in the directory name, then sub-directories are created after expanding
900 the directory name pattern. This enables creation of variant streams in
901 subdirectories.
902
903 @example
904 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
905   -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
906   http://example.com/live/out_%v.m3u8
907 @end example
908 This example creates two hls variant streams. The first variant stream will
909 contain video stream of bitrate 1000k and audio stream of bitrate 64k and the
910 second variant stream will contain video stream of bitrate 256k and audio
911 stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and
912 out_1.m3u8 will be created.
913 @example
914 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
915   -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
916   http://example.com/live/out_%v.m3u8
917 @end example
918 This example creates three hls variant streams. The first variant stream will
919 be a video only stream with video bitrate 1000k, the second variant stream will
920 be an audio only stream with bitrate 64k and the third variant stream will be a
921 video only stream with bitrate 256k. Here, three media playlist with file names
922 out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created.
923 @example
924 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
925   -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
926   http://example.com/live/vs_%v/out.m3u8
927 @end example
928 This example creates the variant streams in subdirectories. Here, the first
929 media playlist is created at @file{http://example.com/live/vs_0/out.m3u8} and
930 the second one at @file{http://example.com/live/vs_1/out.m3u8}.
931 @example
932 ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k  \
933   -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
934   -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
935   -master_pl_name master.m3u8 \
936   http://example.com/live/out_%v.m3u8
937 @end example
938 This example creates two audio only and two video only variant streams. In
939 addition to the #EXT-X-STREAM-INF tag for each variant stream in the master
940 playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams
941 and they are mapped to the two video only variant streams with audio group names
942 'aud_low' and 'aud_high'.
943
944 By default, a single hls variant containing all the encoded streams is created.
945
946 @item cc_stream_map
947 Map string which specifies different closed captions groups and their
948 attributes. The closed captions stream groups are separated by space.
949 Expected string format is like this
950 "ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....".
951 'ccgroup' and 'instreamid' are mandatory attributes. 'language' is an optional
952 attribute.
953 The closed captions groups configured using this option are mapped to different
954 variant streams by providing the same 'ccgroup' name in the
955 @code{var_stream_map} string. If @code{var_stream_map} is not set, then the
956 first available ccgroup in @code{cc_stream_map} is mapped to the output variant
957 stream. The examples for these two use cases are given below.
958
959 @example
960 ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
961   -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
962   -master_pl_name master.m3u8 \
963   http://example.com/live/out.m3u8
964 @end example
965 This example adds @code{#EXT-X-MEDIA} tag with @code{TYPE=CLOSED-CAPTIONS} in
966 the master playlist with group name 'cc', langauge 'en' (english) and
967 INSTREAM-ID 'CC1'. Also, it adds @code{CLOSED-CAPTIONS} attribute with group
968 name 'cc' for the output variant stream.
969 @example
970 ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
971   -a53cc:0 1 -a53cc:1 1\
972   -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
973   -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
974   -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
975   -master_pl_name master.m3u8 \
976   http://example.com/live/out_%v.m3u8
977 @end example
978 This example adds two @code{#EXT-X-MEDIA} tags with @code{TYPE=CLOSED-CAPTIONS} in
979 the master playlist for the INSTREAM-IDs 'CC1' and 'CC2'. Also, it adds
980 @code{CLOSED-CAPTIONS} attribute with group name 'cc' for the two output variant
981 streams.
982
983 @item master_pl_name
984 Create HLS master playlist with the given name.
985
986 @example
987 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
988 @end example
989 This example creates HLS master playlist with name master.m3u8 and it is
990 published at http://example.com/live/
991
992 @item master_pl_publish_rate
993 Publish master play list repeatedly every after specified number of segment intervals.
994
995 @example
996 ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
997 -hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
998 @end example
999
1000 This example creates HLS master playlist with name master.m3u8 and keep
1001 publishing it repeatedly every after 30 segments i.e. every after 60s.
1002
1003 @item http_persistent
1004 Use persistent HTTP connections. Applicable only for HTTP output.
1005
1006 @item timeout
1007 Set timeout for socket I/O operations. Applicable only for HTTP output.
1008
1009 @end table
1010
1011 @anchor{ico}
1012 @section ico
1013
1014 ICO file muxer.
1015
1016 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
1017
1018 @itemize
1019 @item
1020 Size cannot exceed 256 pixels in any dimension
1021
1022 @item
1023 Only BMP and PNG images can be stored
1024
1025 @item
1026 If a BMP image is used, it must be one of the following pixel formats:
1027 @example
1028 BMP Bit Depth      FFmpeg Pixel Format
1029 1bit               pal8
1030 4bit               pal8
1031 8bit               pal8
1032 16bit              rgb555le
1033 24bit              bgr24
1034 32bit              bgra
1035 @end example
1036
1037 @item
1038 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
1039
1040 @item
1041 If a PNG image is used, it must use the rgba pixel format
1042 @end itemize
1043
1044 @anchor{image2}
1045 @section image2
1046
1047 Image file muxer.
1048
1049 The image file muxer writes video frames to image files.
1050
1051 The output filenames are specified by a pattern, which can be used to
1052 produce sequentially numbered series of files.
1053 The pattern may contain the string "%d" or "%0@var{N}d", this string
1054 specifies the position of the characters representing a numbering in
1055 the filenames. If the form "%0@var{N}d" is used, the string
1056 representing the number in each filename is 0-padded to @var{N}
1057 digits. The literal character '%' can be specified in the pattern with
1058 the string "%%".
1059
1060 If the pattern contains "%d" or "%0@var{N}d", the first filename of
1061 the file list specified will contain the number 1, all the following
1062 numbers will be sequential.
1063
1064 The pattern may contain a suffix which is used to automatically
1065 determine the format of the image files to write.
1066
1067 For example the pattern "img-%03d.bmp" will specify a sequence of
1068 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
1069 @file{img-010.bmp}, etc.
1070 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
1071 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
1072 etc.
1073
1074 @subsection Examples
1075
1076 The following example shows how to use @command{ffmpeg} for creating a
1077 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
1078 taking one image every second from the input video:
1079 @example
1080 ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
1081 @end example
1082
1083 Note that with @command{ffmpeg}, if the format is not specified with the
1084 @code{-f} option and the output filename specifies an image file
1085 format, the image2 muxer is automatically selected, so the previous
1086 command can be written as:
1087 @example
1088 ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
1089 @end example
1090
1091 Note also that the pattern must not necessarily contain "%d" or
1092 "%0@var{N}d", for example to create a single image file
1093 @file{img.jpeg} from the start of the input video you can employ the command:
1094 @example
1095 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
1096 @end example
1097
1098 The @option{strftime} option allows you to expand the filename with
1099 date and time information. Check the documentation of
1100 the @code{strftime()} function for the syntax.
1101
1102 For example to generate image files from the @code{strftime()}
1103 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
1104 can be used:
1105 @example
1106 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
1107 @end example
1108
1109 You can set the file name with current frame's PTS:
1110 @example
1111 ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
1112 @end example
1113
1114 @subsection Options
1115
1116 @table @option
1117 @item frame_pts
1118 If set to 1, expand the filename with pts from pkt->pts.
1119 Default value is 0.
1120
1121 @item start_number
1122 Start the sequence from the specified number. Default value is 1.
1123
1124 @item update
1125 If set to 1, the filename will always be interpreted as just a
1126 filename, not a pattern, and the corresponding file will be continuously
1127 overwritten with new images. Default value is 0.
1128
1129 @item strftime
1130 If set to 1, expand the filename with date and time information from
1131 @code{strftime()}. Default value is 0.
1132 @end table
1133
1134 The image muxer supports the .Y.U.V image file format. This format is
1135 special in that that each image frame consists of three files, for
1136 each of the YUV420P components. To read or write this image file format,
1137 specify the name of the '.Y' file. The muxer will automatically open the
1138 '.U' and '.V' files as required.
1139
1140 @section matroska
1141
1142 Matroska container muxer.
1143
1144 This muxer implements the matroska and webm container specs.
1145
1146 @subsection Metadata
1147
1148 The recognized metadata settings in this muxer are:
1149
1150 @table @option
1151 @item title
1152 Set title name provided to a single track.
1153
1154 @item language
1155 Specify the language of the track in the Matroska languages form.
1156
1157 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
1158 639-2/B) form (like "fre" for French), or a language code mixed with a
1159 country code for specialities in languages (like "fre-ca" for Canadian
1160 French).
1161
1162 @item stereo_mode
1163 Set stereo 3D video layout of two views in a single video track.
1164
1165 The following values are recognized:
1166 @table @samp
1167 @item mono
1168 video is not stereo
1169 @item left_right
1170 Both views are arranged side by side, Left-eye view is on the left
1171 @item bottom_top
1172 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
1173 @item top_bottom
1174 Both views are arranged in top-bottom orientation, Left-eye view is on top
1175 @item checkerboard_rl
1176 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
1177 @item checkerboard_lr
1178 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
1179 @item row_interleaved_rl
1180 Each view is constituted by a row based interleaving, Right-eye view is first row
1181 @item row_interleaved_lr
1182 Each view is constituted by a row based interleaving, Left-eye view is first row
1183 @item col_interleaved_rl
1184 Both views are arranged in a column based interleaving manner, Right-eye view is first column
1185 @item col_interleaved_lr
1186 Both views are arranged in a column based interleaving manner, Left-eye view is first column
1187 @item anaglyph_cyan_red
1188 All frames are in anaglyph format viewable through red-cyan filters
1189 @item right_left
1190 Both views are arranged side by side, Right-eye view is on the left
1191 @item anaglyph_green_magenta
1192 All frames are in anaglyph format viewable through green-magenta filters
1193 @item block_lr
1194 Both eyes laced in one Block, Left-eye view is first
1195 @item block_rl
1196 Both eyes laced in one Block, Right-eye view is first
1197 @end table
1198 @end table
1199
1200 For example a 3D WebM clip can be created using the following command line:
1201 @example
1202 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
1203 @end example
1204
1205 @subsection Options
1206
1207 This muxer supports the following options:
1208
1209 @table @option
1210 @item reserve_index_space
1211 By default, this muxer writes the index for seeking (called cues in Matroska
1212 terms) at the end of the file, because it cannot know in advance how much space
1213 to leave for the index at the beginning of the file. However for some use cases
1214 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
1215 index at the beginning of the file.
1216
1217 If this option is set to a non-zero value, the muxer will reserve a given amount
1218 of space in the file header and then try to write the cues there when the muxing
1219 finishes. If the available space does not suffice, muxing will fail. A safe size
1220 for most use cases should be about 50kB per hour of video.
1221
1222 Note that cues are only written if the output is seekable and this option will
1223 have no effect if it is not.
1224 @end table
1225
1226 @anchor{md5}
1227 @section md5
1228
1229 MD5 testing format.
1230
1231 This is a variant of the @ref{hash} muxer. Unlike that muxer, it
1232 defaults to using the MD5 hash function.
1233
1234 @subsection Examples
1235
1236 To compute the MD5 hash of the input converted to raw
1237 audio and video, and store it in the file @file{out.md5}:
1238 @example
1239 ffmpeg -i INPUT -f md5 out.md5
1240 @end example
1241
1242 You can print the MD5 to stdout with the command:
1243 @example
1244 ffmpeg -i INPUT -f md5 -
1245 @end example
1246
1247 See also the @ref{hash} and @ref{framemd5} muxers.
1248
1249 @section mov, mp4, ismv
1250
1251 MOV/MP4/ISMV (Smooth Streaming) muxer.
1252
1253 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
1254 file has all the metadata about all packets stored in one location
1255 (written at the end of the file, it can be moved to the start for
1256 better playback by adding @var{faststart} to the @var{movflags}, or
1257 using the @command{qt-faststart} tool). A fragmented
1258 file consists of a number of fragments, where packets and metadata
1259 about these packets are stored together. Writing a fragmented
1260 file has the advantage that the file is decodable even if the
1261 writing is interrupted (while a normal MOV/MP4 is undecodable if
1262 it is not properly finished), and it requires less memory when writing
1263 very long files (since writing normal MOV/MP4 files stores info about
1264 every single packet in memory until the file is closed). The downside
1265 is that it is less compatible with other applications.
1266
1267 @subsection Options
1268
1269 Fragmentation is enabled by setting one of the AVOptions that define
1270 how to cut the file into fragments:
1271
1272 @table @option
1273 @item -moov_size @var{bytes}
1274 Reserves space for the moov atom at the beginning of the file instead of placing the
1275 moov atom at the end. If the space reserved is insufficient, muxing will fail.
1276 @item -movflags frag_keyframe
1277 Start a new fragment at each video keyframe.
1278 @item -frag_duration @var{duration}
1279 Create fragments that are @var{duration} microseconds long.
1280 @item -frag_size @var{size}
1281 Create fragments that contain up to @var{size} bytes of payload data.
1282 @item -movflags frag_custom
1283 Allow the caller to manually choose when to cut fragments, by
1284 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
1285 the packets written so far. (This is only useful with other
1286 applications integrating libavformat, not from @command{ffmpeg}.)
1287 @item -min_frag_duration @var{duration}
1288 Don't create fragments that are shorter than @var{duration} microseconds long.
1289 @end table
1290
1291 If more than one condition is specified, fragments are cut when
1292 one of the specified conditions is fulfilled. The exception to this is
1293 @code{-min_frag_duration}, which has to be fulfilled for any of the other
1294 conditions to apply.
1295
1296 Additionally, the way the output file is written can be adjusted
1297 through a few other options:
1298
1299 @table @option
1300 @item -movflags empty_moov
1301 Write an initial moov atom directly at the start of the file, without
1302 describing any samples in it. Generally, an mdat/moov pair is written
1303 at the start of the file, as a normal MOV/MP4 file, containing only
1304 a short portion of the file. With this option set, there is no initial
1305 mdat atom, and the moov atom only describes the tracks but has
1306 a zero duration.
1307
1308 This option is implicitly set when writing ismv (Smooth Streaming) files.
1309 @item -movflags separate_moof
1310 Write a separate moof (movie fragment) atom for each track. Normally,
1311 packets for all tracks are written in a moof atom (which is slightly
1312 more efficient), but with this option set, the muxer writes one moof/mdat
1313 pair for each track, making it easier to separate tracks.
1314
1315 This option is implicitly set when writing ismv (Smooth Streaming) files.
1316 @item -movflags faststart
1317 Run a second pass moving the index (moov atom) to the beginning of the file.
1318 This operation can take a while, and will not work in various situations such
1319 as fragmented output, thus it is not enabled by default.
1320 @item -movflags rtphint
1321 Add RTP hinting tracks to the output file.
1322 @item -movflags disable_chpl
1323 Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
1324 and a QuickTime chapter track are written to the file. With this option
1325 set, only the QuickTime chapter track will be written. Nero chapters can
1326 cause failures when the file is reprocessed with certain tagging programs, like
1327 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
1328 @item -movflags omit_tfhd_offset
1329 Do not write any absolute base_data_offset in tfhd atoms. This avoids
1330 tying fragments to absolute byte positions in the file/streams.
1331 @item -movflags default_base_moof
1332 Similarly to the omit_tfhd_offset, this flag avoids writing the
1333 absolute base_data_offset field in tfhd atoms, but does so by using
1334 the new default-base-is-moof flag instead. This flag is new from
1335 14496-12:2012. This may make the fragments easier to parse in certain
1336 circumstances (avoiding basing track fragment location calculations
1337 on the implicit end of the previous track fragment).
1338 @item -write_tmcd
1339 Specify @code{on} to force writing a timecode track, @code{off} to disable it
1340 and @code{auto} to write a timecode track only for mov and mp4 output (default).
1341 @item -movflags negative_cts_offsets
1342 Enables utilization of version 1 of the CTTS box, in which the CTS offsets can
1343 be negative. This enables the initial sample to have DTS/CTS of zero, and
1344 reduces the need for edit lists for some cases such as video tracks with
1345 B-frames. Additionally, eases conformance with the DASH-IF interoperability
1346 guidelines.
1347 @end table
1348
1349 @subsection Example
1350
1351 Smooth Streaming content can be pushed in real time to a publishing
1352 point on IIS with this muxer. Example:
1353 @example
1354 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
1355 @end example
1356
1357 @subsection Audible AAX
1358
1359 Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
1360 @example
1361 ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
1362 @end example
1363
1364 @section mp3
1365
1366 The MP3 muxer writes a raw MP3 stream with the following optional features:
1367 @itemize @bullet
1368 @item
1369 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
1370 2.4 are supported, the @code{id3v2_version} private option controls which one is
1371 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
1372 completely.
1373
1374 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
1375 The pictures are supplied to the muxer in form of a video stream with a single
1376 packet. There can be any number of those streams, each will correspond to a
1377 single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
1378 to APIC @var{description} and @var{picture type} respectively. See
1379 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
1380
1381 Note that the APIC frames must be written at the beginning, so the muxer will
1382 buffer the audio frames until it gets all the pictures. It is therefore advised
1383 to provide the pictures as soon as possible to avoid excessive buffering.
1384
1385 @item
1386 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
1387 default, but will be written only if the output is seekable. The
1388 @code{write_xing} private option can be used to disable it.  The frame contains
1389 various information that may be useful to the decoder, like the audio duration
1390 or encoder delay.
1391
1392 @item
1393 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
1394 enabled with the @code{write_id3v1} private option, but as its capabilities are
1395 very limited, its usage is not recommended.
1396 @end itemize
1397
1398 Examples:
1399
1400 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
1401 @example
1402 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
1403 @end example
1404
1405 To attach a picture to an mp3 file select both the audio and the picture stream
1406 with @code{map}:
1407 @example
1408 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
1409 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
1410 @end example
1411
1412 Write a "clean" MP3 without any extra features:
1413 @example
1414 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
1415 @end example
1416
1417 @section mpegts
1418
1419 MPEG transport stream muxer.
1420
1421 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
1422
1423 The recognized metadata settings in mpegts muxer are @code{service_provider}
1424 and @code{service_name}. If they are not set the default for
1425 @code{service_provider} is @samp{FFmpeg} and the default for
1426 @code{service_name} is @samp{Service01}.
1427
1428 @subsection Options
1429
1430 The muxer options are:
1431
1432 @table @option
1433 @item mpegts_transport_stream_id @var{integer}
1434 Set the @samp{transport_stream_id}. This identifies a transponder in DVB.
1435 Default is @code{0x0001}.
1436
1437 @item mpegts_original_network_id @var{integer}
1438 Set the @samp{original_network_id}. This is unique identifier of a
1439 network in DVB. Its main use is in the unique identification of a service
1440 through the path @samp{Original_Network_ID, Transport_Stream_ID}. Default
1441 is @code{0x0001}.
1442
1443 @item mpegts_service_id @var{integer}
1444 Set the @samp{service_id}, also known as program in DVB. Default is
1445 @code{0x0001}.
1446
1447 @item mpegts_service_type @var{integer}
1448 Set the program @samp{service_type}. Default is @code{digital_tv}.
1449 Accepts the following options:
1450 @table @samp
1451 @item hex_value
1452 Any hexdecimal value between @code{0x01} to @code{0xff} as defined in
1453 ETSI 300 468.
1454 @item digital_tv
1455 Digital TV service.
1456 @item digital_radio
1457 Digital Radio service.
1458 @item teletext
1459 Teletext service.
1460 @item advanced_codec_digital_radio
1461 Advanced Codec Digital Radio service.
1462 @item mpeg2_digital_hdtv
1463 MPEG2 Digital HDTV service.
1464 @item advanced_codec_digital_sdtv
1465 Advanced Codec Digital SDTV service.
1466 @item advanced_codec_digital_hdtv
1467 Advanced Codec Digital HDTV service.
1468 @end table
1469
1470 @item mpegts_pmt_start_pid @var{integer}
1471 Set the first PID for PMT. Default is @code{0x1000}. Max is @code{0x1f00}.
1472
1473 @item mpegts_start_pid @var{integer}
1474 Set the first PID for data packets. Default is @code{0x0100}. Max is
1475 @code{0x0f00}.
1476
1477 @item mpegts_m2ts_mode @var{boolean}
1478 Enable m2ts mode if set to @code{1}. Default value is @code{-1} which
1479 disables m2ts mode.
1480
1481 @item muxrate @var{integer}
1482 Set a constant muxrate. Default is VBR.
1483
1484 @item pes_payload_size @var{integer}
1485 Set minimum PES packet payload in bytes. Default is @code{2930}.
1486
1487 @item mpegts_flags @var{flags}
1488 Set mpegts flags. Accepts the following options:
1489 @table @samp
1490 @item resend_headers
1491 Reemit PAT/PMT before writing the next packet.
1492 @item latm
1493 Use LATM packetization for AAC.
1494 @item pat_pmt_at_frames
1495 Reemit PAT and PMT at each video frame.
1496 @item system_b
1497 Conform to System B (DVB) instead of System A (ATSC).
1498 @item initial_discontinuity
1499 Mark the initial packet of each stream as discontinuity.
1500 @end table
1501
1502 @item resend_headers @var{integer}
1503 Reemit PAT/PMT before writing the next packet. This option is deprecated:
1504 use @option{mpegts_flags} instead.
1505
1506 @item mpegts_copyts @var{boolean}
1507 Preserve original timestamps, if value is set to @code{1}. Default value
1508 is @code{-1}, which results in shifting timestamps so that they start from 0.
1509
1510 @item omit_video_pes_length @var{boolean}
1511 Omit the PES packet length for video packets. Default is @code{1} (true).
1512
1513 @item pcr_period @var{integer}
1514 Override the default PCR retransmission time in milliseconds. Ignored if
1515 variable muxrate is selected. Default is @code{20}.
1516
1517 @item pat_period @var{double}
1518 Maximum time in seconds between PAT/PMT tables.
1519
1520 @item sdt_period @var{double}
1521 Maximum time in seconds between SDT tables.
1522
1523 @item tables_version @var{integer}
1524 Set PAT, PMT and SDT version (default @code{0}, valid values are from 0 to 31, inclusively).
1525 This option allows updating stream structure so that standard consumer may
1526 detect the change. To do so, reopen output @code{AVFormatContext} (in case of API
1527 usage) or restart @command{ffmpeg} instance, cyclically changing
1528 @option{tables_version} value:
1529
1530 @example
1531 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1532 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1533 ...
1534 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
1535 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
1536 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
1537 ...
1538 @end example
1539 @end table
1540
1541 @subsection Example
1542
1543 @example
1544 ffmpeg -i file.mpg -c copy \
1545      -mpegts_original_network_id 0x1122 \
1546      -mpegts_transport_stream_id 0x3344 \
1547      -mpegts_service_id 0x5566 \
1548      -mpegts_pmt_start_pid 0x1500 \
1549      -mpegts_start_pid 0x150 \
1550      -metadata service_provider="Some provider" \
1551      -metadata service_name="Some Channel" \
1552      out.ts
1553 @end example
1554
1555 @section mxf, mxf_d10
1556
1557 MXF muxer.
1558
1559 @subsection Options
1560
1561 The muxer options are:
1562
1563 @table @option
1564 @item store_user_comments @var{bool}
1565 Set if user comments should be stored if available or never.
1566 IRT D-10 does not allow user comments. The default is thus to write them for
1567 mxf but not for mxf_d10
1568 @end table
1569
1570 @section null
1571
1572 Null muxer.
1573
1574 This muxer does not generate any output file, it is mainly useful for
1575 testing or benchmarking purposes.
1576
1577 For example to benchmark decoding with @command{ffmpeg} you can use the
1578 command:
1579 @example
1580 ffmpeg -benchmark -i INPUT -f null out.null
1581 @end example
1582
1583 Note that the above command does not read or write the @file{out.null}
1584 file, but specifying the output file is required by the @command{ffmpeg}
1585 syntax.
1586
1587 Alternatively you can write the command as:
1588 @example
1589 ffmpeg -benchmark -i INPUT -f null -
1590 @end example
1591
1592 @section nut
1593
1594 @table @option
1595 @item -syncpoints @var{flags}
1596 Change the syncpoint usage in nut:
1597 @table @option
1598 @item @var{default} use the normal low-overhead seeking aids.
1599 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
1600     Use of this option is not recommended, as the resulting files are very damage
1601     sensitive and seeking is not possible. Also in general the overhead from
1602     syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
1603     all growing data tables, allowing to mux endless streams with limited memory
1604     and without these disadvantages.
1605 @item @var{timestamped} extend the syncpoint with a wallclock field.
1606 @end table
1607 The @var{none} and @var{timestamped} flags are experimental.
1608 @item -write_index @var{bool}
1609 Write index at the end, the default is to write an index.
1610 @end table
1611
1612 @example
1613 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
1614 @end example
1615
1616 @section ogg
1617
1618 Ogg container muxer.
1619
1620 @table @option
1621 @item -page_duration @var{duration}
1622 Preferred page duration, in microseconds. The muxer will attempt to create
1623 pages that are approximately @var{duration} microseconds long. This allows the
1624 user to compromise between seek granularity and container overhead. The default
1625 is 1 second. A value of 0 will fill all segments, making pages as large as
1626 possible. A value of 1 will effectively use 1 packet-per-page in most
1627 situations, giving a small seek granularity at the cost of additional container
1628 overhead.
1629 @item -serial_offset @var{value}
1630 Serial value from which to set the streams serial number.
1631 Setting it to different and sufficiently large values ensures that the produced
1632 ogg files can be safely chained.
1633
1634 @end table
1635
1636 @anchor{segment}
1637 @section segment, stream_segment, ssegment
1638
1639 Basic stream segmenter.
1640
1641 This muxer outputs streams to a number of separate files of nearly
1642 fixed duration. Output filename pattern can be set in a fashion
1643 similar to @ref{image2}, or by using a @code{strftime} template if
1644 the @option{strftime} option is enabled.
1645
1646 @code{stream_segment} is a variant of the muxer used to write to
1647 streaming output formats, i.e. which do not require global headers,
1648 and is recommended for outputting e.g. to MPEG transport stream segments.
1649 @code{ssegment} is a shorter alias for @code{stream_segment}.
1650
1651 Every segment starts with a keyframe of the selected reference stream,
1652 which is set through the @option{reference_stream} option.
1653
1654 Note that if you want accurate splitting for a video file, you need to
1655 make the input key frames correspond to the exact splitting times
1656 expected by the segmenter, or the segment muxer will start the new
1657 segment with the key frame found next after the specified start
1658 time.
1659
1660 The segment muxer works best with a single constant frame rate video.
1661
1662 Optionally it can generate a list of the created segments, by setting
1663 the option @var{segment_list}. The list type is specified by the
1664 @var{segment_list_type} option. The entry filenames in the segment
1665 list are set by default to the basename of the corresponding segment
1666 files.
1667
1668 See also the @ref{hls} muxer, which provides a more specific
1669 implementation for HLS segmentation.
1670
1671 @subsection Options
1672
1673 The segment muxer supports the following options:
1674
1675 @table @option
1676 @item increment_tc @var{1|0}
1677 if set to @code{1}, increment timecode between each segment
1678 If this is selected, the input need to have
1679 a timecode in the first video stream. Default value is
1680 @code{0}.
1681
1682 @item reference_stream @var{specifier}
1683 Set the reference stream, as specified by the string @var{specifier}.
1684 If @var{specifier} is set to @code{auto}, the reference is chosen
1685 automatically. Otherwise it must be a stream specifier (see the ``Stream
1686 specifiers'' chapter in the ffmpeg manual) which specifies the
1687 reference stream. The default value is @code{auto}.
1688
1689 @item segment_format @var{format}
1690 Override the inner container format, by default it is guessed by the filename
1691 extension.
1692
1693 @item segment_format_options @var{options_list}
1694 Set output format options using a :-separated list of key=value
1695 parameters. Values containing the @code{:} special character must be
1696 escaped.
1697
1698 @item segment_list @var{name}
1699 Generate also a listfile named @var{name}. If not specified no
1700 listfile is generated.
1701
1702 @item segment_list_flags @var{flags}
1703 Set flags affecting the segment list generation.
1704
1705 It currently supports the following flags:
1706 @table @samp
1707 @item cache
1708 Allow caching (only affects M3U8 list files).
1709
1710 @item live
1711 Allow live-friendly file generation.
1712 @end table
1713
1714 @item segment_list_size @var{size}
1715 Update the list file so that it contains at most @var{size}
1716 segments. If 0 the list file will contain all the segments. Default
1717 value is 0.
1718
1719 @item segment_list_entry_prefix @var{prefix}
1720 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
1721 By default no prefix is applied.
1722
1723 @item segment_list_type @var{type}
1724 Select the listing format.
1725
1726 The following values are recognized:
1727 @table @samp
1728 @item flat
1729 Generate a flat list for the created segments, one segment per line.
1730
1731 @item csv, ext
1732 Generate a list for the created segments, one segment per line,
1733 each line matching the format (comma-separated values):
1734 @example
1735 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
1736 @end example
1737
1738 @var{segment_filename} is the name of the output file generated by the
1739 muxer according to the provided pattern. CSV escaping (according to
1740 RFC4180) is applied if required.
1741
1742 @var{segment_start_time} and @var{segment_end_time} specify
1743 the segment start and end time expressed in seconds.
1744
1745 A list file with the suffix @code{".csv"} or @code{".ext"} will
1746 auto-select this format.
1747
1748 @samp{ext} is deprecated in favor or @samp{csv}.
1749
1750 @item ffconcat
1751 Generate an ffconcat file for the created segments. The resulting file
1752 can be read using the FFmpeg @ref{concat} demuxer.
1753
1754 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
1755 auto-select this format.
1756
1757 @item m3u8
1758 Generate an extended M3U8 file, version 3, compliant with
1759 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
1760
1761 A list file with the suffix @code{".m3u8"} will auto-select this format.
1762 @end table
1763
1764 If not specified the type is guessed from the list file name suffix.
1765
1766 @item segment_time @var{time}
1767 Set segment duration to @var{time}, the value must be a duration
1768 specification. Default value is "2". See also the
1769 @option{segment_times} option.
1770
1771 Note that splitting may not be accurate, unless you force the
1772 reference stream key-frames at the given time. See the introductory
1773 notice and the examples below.
1774
1775 @item segment_atclocktime @var{1|0}
1776 If set to "1" split at regular clock time intervals starting from 00:00
1777 o'clock. The @var{time} value specified in @option{segment_time} is
1778 used for setting the length of the splitting interval.
1779
1780 For example with @option{segment_time} set to "900" this makes it possible
1781 to create files at 12:00 o'clock, 12:15, 12:30, etc.
1782
1783 Default value is "0".
1784
1785 @item segment_clocktime_offset @var{duration}
1786 Delay the segment splitting times with the specified duration when using
1787 @option{segment_atclocktime}.
1788
1789 For example with @option{segment_time} set to "900" and
1790 @option{segment_clocktime_offset} set to "300" this makes it possible to
1791 create files at 12:05, 12:20, 12:35, etc.
1792
1793 Default value is "0".
1794
1795 @item segment_clocktime_wrap_duration @var{duration}
1796 Force the segmenter to only start a new segment if a packet reaches the muxer
1797 within the specified duration after the segmenting clock time. This way you
1798 can make the segmenter more resilient to backward local time jumps, such as
1799 leap seconds or transition to standard time from daylight savings time.
1800
1801 Default is the maximum possible duration which means starting a new segment
1802 regardless of the elapsed time since the last clock time.
1803
1804 @item segment_time_delta @var{delta}
1805 Specify the accuracy time when selecting the start time for a
1806 segment, expressed as a duration specification. Default value is "0".
1807
1808 When delta is specified a key-frame will start a new segment if its
1809 PTS satisfies the relation:
1810 @example
1811 PTS >= start_time - time_delta
1812 @end example
1813
1814 This option is useful when splitting video content, which is always
1815 split at GOP boundaries, in case a key frame is found just before the
1816 specified split time.
1817
1818 In particular may be used in combination with the @file{ffmpeg} option
1819 @var{force_key_frames}. The key frame times specified by
1820 @var{force_key_frames} may not be set accurately because of rounding
1821 issues, with the consequence that a key frame time may result set just
1822 before the specified time. For constant frame rate videos a value of
1823 1/(2*@var{frame_rate}) should address the worst case mismatch between
1824 the specified time and the time set by @var{force_key_frames}.
1825
1826 @item segment_times @var{times}
1827 Specify a list of split points. @var{times} contains a list of comma
1828 separated duration specifications, in increasing order. See also
1829 the @option{segment_time} option.
1830
1831 @item segment_frames @var{frames}
1832 Specify a list of split video frame numbers. @var{frames} contains a
1833 list of comma separated integer numbers, in increasing order.
1834
1835 This option specifies to start a new segment whenever a reference
1836 stream key frame is found and the sequential number (starting from 0)
1837 of the frame is greater or equal to the next value in the list.
1838
1839 @item segment_wrap @var{limit}
1840 Wrap around segment index once it reaches @var{limit}.
1841
1842 @item segment_start_number @var{number}
1843 Set the sequence number of the first segment. Defaults to @code{0}.
1844
1845 @item strftime @var{1|0}
1846 Use the @code{strftime} function to define the name of the new
1847 segments to write. If this is selected, the output segment name must
1848 contain a @code{strftime} function template. Default value is
1849 @code{0}.
1850
1851 @item break_non_keyframes @var{1|0}
1852 If enabled, allow segments to start on frames other than keyframes. This
1853 improves behavior on some players when the time between keyframes is
1854 inconsistent, but may make things worse on others, and can cause some oddities
1855 during seeking. Defaults to @code{0}.
1856
1857 @item reset_timestamps @var{1|0}
1858 Reset timestamps at the beginning of each segment, so that each segment
1859 will start with near-zero timestamps. It is meant to ease the playback
1860 of the generated segments. May not work with some combinations of
1861 muxers/codecs. It is set to @code{0} by default.
1862
1863 @item initial_offset @var{offset}
1864 Specify timestamp offset to apply to the output packet timestamps. The
1865 argument must be a time duration specification, and defaults to 0.
1866
1867 @item write_empty_segments @var{1|0}
1868 If enabled, write an empty segment if there are no packets during the period a
1869 segment would usually span. Otherwise, the segment will be filled with the next
1870 packet written. Defaults to @code{0}.
1871 @end table
1872
1873 Make sure to require a closed GOP when encoding and to set the GOP
1874 size to fit your segment time constraint.
1875
1876 @subsection Examples
1877
1878 @itemize
1879 @item
1880 Remux the content of file @file{in.mkv} to a list of segments
1881 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
1882 generated segments to @file{out.list}:
1883 @example
1884 ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
1885 @end example
1886
1887 @item
1888 Segment input and set output format options for the output segments:
1889 @example
1890 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
1891 @end example
1892
1893 @item
1894 Segment the input file according to the split points specified by the
1895 @var{segment_times} option:
1896 @example
1897 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
1898 @end example
1899
1900 @item
1901 Use the @command{ffmpeg} @option{force_key_frames}
1902 option to force key frames in the input at the specified location, together
1903 with the segment option @option{segment_time_delta} to account for
1904 possible roundings operated when setting key frame times.
1905 @example
1906 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1907 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1908 @end example
1909 In order to force key frames on the input file, transcoding is
1910 required.
1911
1912 @item
1913 Segment the input file by splitting the input file according to the
1914 frame numbers sequence specified with the @option{segment_frames} option:
1915 @example
1916 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
1917 @end example
1918
1919 @item
1920 Convert the @file{in.mkv} to TS segments using the @code{libx264}
1921 and @code{aac} encoders:
1922 @example
1923 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
1924 @end example
1925
1926 @item
1927 Segment the input file, and create an M3U8 live playlist (can be used
1928 as live HLS source):
1929 @example
1930 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
1931 -segment_list_flags +live -segment_time 10 out%03d.mkv
1932 @end example
1933 @end itemize
1934
1935 @section smoothstreaming
1936
1937 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1938
1939 @table @option
1940 @item window_size
1941 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1942
1943 @item extra_window_size
1944 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1945
1946 @item lookahead_count
1947 Specify the number of lookahead fragments. Default 2.
1948
1949 @item min_frag_duration
1950 Specify the minimum fragment duration (in microseconds). Default 5000000.
1951
1952 @item remove_at_exit
1953 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1954
1955 @end table
1956
1957 @anchor{fifo}
1958 @section fifo
1959
1960 The fifo pseudo-muxer allows the separation of encoding and muxing by using
1961 first-in-first-out queue and running the actual muxer in a separate thread. This
1962 is especially useful in combination with the @ref{tee} muxer and can be used to
1963 send data to several destinations with different reliability/writing speed/latency.
1964
1965 API users should be aware that callback functions (interrupt_callback,
1966 io_open and io_close) used within its AVFormatContext must be thread-safe.
1967
1968 The behavior of the fifo muxer if the queue fills up or if the output fails is
1969 selectable,
1970
1971 @itemize @bullet
1972
1973 @item
1974 output can be transparently restarted with configurable delay between retries
1975 based on real time or time of the processed stream.
1976
1977 @item
1978 encoding can be blocked during temporary failure, or continue transparently
1979 dropping packets in case fifo queue fills up.
1980
1981 @end itemize
1982
1983 @table @option
1984
1985 @item fifo_format
1986 Specify the format name. Useful if it cannot be guessed from the
1987 output name suffix.
1988
1989 @item queue_size
1990 Specify size of the queue (number of packets). Default value is 60.
1991
1992 @item format_opts
1993 Specify format options for the underlying muxer. Muxer options can be specified
1994 as a list of @var{key}=@var{value} pairs separated by ':'.
1995
1996 @item drop_pkts_on_overflow @var{bool}
1997 If set to 1 (true), in case the fifo queue fills up, packets will be dropped
1998 rather than blocking the encoder. This makes it possible to continue streaming without
1999 delaying the input, at the cost of omitting part of the stream. By default
2000 this option is set to 0 (false), so in such cases the encoder will be blocked
2001 until the muxer processes some of the packets and none of them is lost.
2002
2003 @item attempt_recovery @var{bool}
2004 If failure occurs, attempt to recover the output. This is especially useful
2005 when used with network output, since it makes it possible to restart streaming transparently.
2006 By default this option is set to 0 (false).
2007
2008 @item max_recovery_attempts
2009 Sets maximum number of successive unsuccessful recovery attempts after which
2010 the output fails permanently. By default this option is set to 0 (unlimited).
2011
2012 @item recovery_wait_time @var{duration}
2013 Waiting time before the next recovery attempt after previous unsuccessful
2014 recovery attempt. Default value is 5 seconds.
2015
2016 @item recovery_wait_streamtime @var{bool}
2017 If set to 0 (false), the real time is used when waiting for the recovery
2018 attempt (i.e. the recovery will be attempted after at least
2019 recovery_wait_time seconds).
2020 If set to 1 (true), the time of the processed stream is taken into account
2021 instead (i.e. the recovery will be attempted after at least @var{recovery_wait_time}
2022 seconds of the stream is omitted).
2023 By default, this option is set to 0 (false).
2024
2025 @item recover_any_error @var{bool}
2026 If set to 1 (true), recovery will be attempted regardless of type of the error
2027 causing the failure. By default this option is set to 0 (false) and in case of
2028 certain (usually permanent) errors the recovery is not attempted even when
2029 @var{attempt_recovery} is set to 1.
2030
2031 @item restart_with_keyframe @var{bool}
2032 Specify whether to wait for the keyframe after recovering from
2033 queue overflow or failure. This option is set to 0 (false) by default.
2034
2035 @end table
2036
2037 @subsection Examples
2038
2039 @itemize
2040
2041 @item
2042 Stream something to rtmp server, continue processing the stream at real-time
2043 rate even in case of temporary failure (network outage) and attempt to recover
2044 streaming every second indefinitely.
2045 @example
2046 ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
2047   -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
2048 @end example
2049
2050 @end itemize
2051
2052 @anchor{tee}
2053 @section tee
2054
2055 The tee muxer can be used to write the same data to several outputs, such as files or streams.
2056 It can be used, for example, to stream a video over a network and save it to disk at the same time.
2057
2058 It is different from specifying several outputs to the @command{ffmpeg}
2059 command-line tool. With the tee muxer, the audio and video data will be encoded only once.
2060 With conventional multiple outputs, multiple encoding operations in parallel are initiated,
2061 which can be a very expensive process. The tee muxer is not useful when using the libavformat API
2062 directly because it is then possible to feed the same packets to several muxers directly.
2063
2064 Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select
2065 output streams. So all streams intended for output must be specified using @code{-map}. See
2066 the examples below.
2067
2068 Some encoders may need different options depending on the output format;
2069 the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified.
2070 The main example is the @option{global_header} flag.
2071
2072 The slave outputs are specified in the file name given to the muxer,
2073 separated by '|'. If any of the slave name contains the '|' separator,
2074 leading or trailing spaces or any special character, those must be
2075 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
2076 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
2077
2078 @subsection Options
2079
2080 @table @option
2081
2082 @item use_fifo @var{bool}
2083 If set to 1, slave outputs will be processed in separate threads using the @ref{fifo}
2084 muxer. This allows to compensate for different speed/latency/reliability of
2085 outputs and setup transparent recovery. By default this feature is turned off.
2086
2087 @item fifo_options
2088 Options to pass to fifo pseudo-muxer instances. See @ref{fifo}.
2089
2090 @end table
2091
2092 Muxer options can be specified for each slave by prepending them as a list of
2093 @var{key}=@var{value} pairs separated by ':', between square brackets. If
2094 the options values contain a special character or the ':' separator, they
2095 must be escaped; note that this is a second level escaping.
2096
2097 The following special options are also recognized:
2098 @table @option
2099 @item f
2100 Specify the format name. Required if it cannot be guessed from the
2101 output URL.
2102
2103 @item bsfs[/@var{spec}]
2104 Specify a list of bitstream filters to apply to the specified
2105 output.
2106
2107 It is possible to specify to which streams a given bitstream filter
2108 applies, by appending a stream specifier to the option separated by
2109 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
2110 stream specifiers}).
2111
2112 If the stream specifier is not specified, the bitstream filters will be
2113 applied to all streams in the output. This will cause that output operation
2114 to fail if the output contains streams to which the bitstream filter cannot
2115 be applied e.g. @code{h264_mp4toannexb} being applied to an output containing an audio stream.
2116
2117 Options for a bitstream filter must be specified in the form of @code{opt=value}.
2118
2119 Several bitstream filters can be specified, separated by ",".
2120
2121 @item use_fifo @var{bool}
2122 This allows to override tee muxer use_fifo option for individual slave muxer.
2123
2124 @item fifo_options
2125 This allows to override tee muxer fifo_options for individual slave muxer.
2126 See @ref{fifo}.
2127
2128 @item select
2129 Select the streams that should be mapped to the slave output,
2130 specified by a stream specifier. If not specified, this defaults to
2131 all the mapped streams. This will cause that output operation to fail
2132 if the output format does not accept all mapped streams.
2133
2134 You may use multiple stream specifiers separated by commas (@code{,}) e.g.: @code{a:0,v}
2135
2136 @item onfail
2137 Specify behaviour on output failure. This can be set to either @code{abort} (which is
2138 default) or @code{ignore}. @code{abort} will cause whole process to fail in case of failure
2139 on this slave output. @code{ignore} will ignore failure on this output, so other outputs
2140 will continue without being affected.
2141 @end table
2142
2143 @subsection Examples
2144
2145 @itemize
2146 @item
2147 Encode something and both archive it in a WebM file and stream it
2148 as MPEG-TS over UDP:
2149 @example
2150 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2151   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2152 @end example
2153
2154 @item
2155 As above, but continue streaming even if output to local file fails
2156 (for example local drive fills up):
2157 @example
2158 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
2159   "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
2160 @end example
2161
2162 @item
2163 Use @command{ffmpeg} to encode the input, and send the output
2164 to three different destinations. The @code{dump_extra} bitstream
2165 filter is used to add extradata information to all the output video
2166 keyframes packets, as requested by the MPEG-TS format. The select
2167 option is applied to @file{out.aac} in order to make it contain only
2168 audio packets.
2169 @example
2170 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2171        -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
2172 @end example
2173
2174 @item
2175 As above, but select only stream @code{a:1} for the audio output. Note
2176 that a second level escaping must be performed, as ":" is a special
2177 character used to separate options.
2178 @example
2179 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
2180        -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
2181 @end example
2182 @end itemize
2183
2184 @section webm_dash_manifest
2185
2186 WebM DASH Manifest muxer.
2187
2188 This muxer implements the WebM DASH Manifest specification to generate the DASH
2189 manifest XML. It also supports manifest generation for DASH live streams.
2190
2191 For more information see:
2192
2193 @itemize @bullet
2194 @item
2195 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
2196 @item
2197 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
2198 @end itemize
2199
2200 @subsection Options
2201
2202 This muxer supports the following options:
2203
2204 @table @option
2205 @item adaptation_sets
2206 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
2207 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
2208 audio and video streams. Any number of adaptation sets can be added using this option.
2209
2210 @item live
2211 Set this to 1 to create a live stream DASH Manifest. Default: 0.
2212
2213 @item chunk_start_index
2214 Start index of the first chunk. This will go in the @samp{startNumber} attribute
2215 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
2216
2217 @item chunk_duration_ms
2218 Duration of each chunk in milliseconds. This will go in the @samp{duration}
2219 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
2220
2221 @item utc_timing_url
2222 URL of the page that will return the UTC timestamp in ISO format. This will go
2223 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
2224 Default: None.
2225
2226 @item time_shift_buffer_depth
2227 Smallest time (in seconds) shifting buffer for which any Representation is
2228 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
2229 attribute of the @samp{MPD} element. Default: 60.
2230
2231 @item minimum_update_period
2232 Minimum update period (in seconds) of the manifest. This will go in the
2233 @samp{minimumUpdatePeriod} attribute of the @samp{MPD} element. Default: 0.
2234
2235 @end table
2236
2237 @subsection Example
2238 @example
2239 ffmpeg -f webm_dash_manifest -i video1.webm \
2240        -f webm_dash_manifest -i video2.webm \
2241        -f webm_dash_manifest -i audio1.webm \
2242        -f webm_dash_manifest -i audio2.webm \
2243        -map 0 -map 1 -map 2 -map 3 \
2244        -c copy \
2245        -f webm_dash_manifest \
2246        -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
2247        manifest.xml
2248 @end example
2249
2250 @section webm_chunk
2251
2252 WebM Live Chunk Muxer.
2253
2254 This muxer writes out WebM headers and chunks as separate files which can be
2255 consumed by clients that support WebM Live streams via DASH.
2256
2257 @subsection Options
2258
2259 This muxer supports the following options:
2260
2261 @table @option
2262 @item chunk_start_index
2263 Index of the first chunk (defaults to 0).
2264
2265 @item header
2266 Filename of the header where the initialization data will be written.
2267
2268 @item audio_chunk_duration
2269 Duration of each audio chunk in milliseconds (defaults to 5000).
2270 @end table
2271
2272 @subsection Example
2273 @example
2274 ffmpeg -f v4l2 -i /dev/video0 \
2275        -f alsa -i hw:0 \
2276        -map 0:0 \
2277        -c:v libvpx-vp9 \
2278        -s 640x360 -keyint_min 30 -g 30 \
2279        -f webm_chunk \
2280        -header webm_live_video_360.hdr \
2281        -chunk_start_index 1 \
2282        webm_live_video_360_%d.chk \
2283        -map 1:0 \
2284        -c:a libvorbis \
2285        -b:a 128k \
2286        -f webm_chunk \
2287        -header webm_live_audio_128.hdr \
2288        -chunk_start_index 1 \
2289        -audio_chunk_duration 1000 \
2290        webm_live_audio_128_%d.chk
2291 @end example
2292
2293 @c man end MUXERS