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