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