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