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