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