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