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