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