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