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