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