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