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