73e4c549586d821b7443dbfe6fd4998efa227dfa
[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 It accepts the following options:
27
28 @table @option
29 @item write_id3v2
30 Enable ID3v2 tags writing when set to 1. Default is 0 (disabled).
31
32 @item id3v2_version
33 Select ID3v2 version to write. Currently only version 3 and 4 (aka.
34 ID3v2.3 and ID3v2.4) are supported. The default is version 4.
35
36 @end table
37
38 @anchor{crc}
39 @section crc
40
41 CRC (Cyclic Redundancy Check) testing format.
42
43 This muxer computes and prints the Adler-32 CRC of all the input audio
44 and video frames. By default audio frames are converted to signed
45 16-bit raw audio and video frames to raw video before computing the
46 CRC.
47
48 The output of the muxer consists of a single line of the form:
49 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
50 8 digits containing the CRC for all the decoded input frames.
51
52 For example to compute the CRC of the input, and store it in the file
53 @file{out.crc}:
54 @example
55 ffmpeg -i INPUT -f crc out.crc
56 @end example
57
58 You can print the CRC to stdout with the command:
59 @example
60 ffmpeg -i INPUT -f crc -
61 @end example
62
63 You can select the output format of each frame with @command{ffmpeg} by
64 specifying the audio and video codec and format. For example to
65 compute the CRC of the input audio converted to PCM unsigned 8-bit
66 and the input video converted to MPEG-2 video, use the command:
67 @example
68 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
69 @end example
70
71 See also the @ref{framecrc} muxer.
72
73 @anchor{framecrc}
74 @section framecrc
75
76 Per-packet CRC (Cyclic Redundancy Check) testing format.
77
78 This muxer computes and prints the Adler-32 CRC for each audio
79 and video packet. By default audio frames are converted to signed
80 16-bit raw audio and video frames to raw video before computing the
81 CRC.
82
83 The output of the muxer consists of a line for each audio and video
84 packet of the form:
85 @example
86 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, 0x@var{CRC}
87 @end example
88
89 @var{CRC} is a hexadecimal number 0-padded to 8 digits containing the
90 CRC of the packet.
91
92 For example to compute the CRC of the audio and video frames in
93 @file{INPUT}, converted to raw audio and video packets, and store it
94 in the file @file{out.crc}:
95 @example
96 ffmpeg -i INPUT -f framecrc out.crc
97 @end example
98
99 To print the information to stdout, use the command:
100 @example
101 ffmpeg -i INPUT -f framecrc -
102 @end example
103
104 With @command{ffmpeg}, you can select the output format to which the
105 audio and video frames are encoded before computing the CRC for each
106 packet by specifying the audio and video codec. For example, to
107 compute the CRC of each decoded input audio frame converted to PCM
108 unsigned 8-bit and of each decoded input video frame converted to
109 MPEG-2 video, use the command:
110 @example
111 ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
112 @end example
113
114 See also the @ref{crc} muxer.
115
116 @anchor{framemd5}
117 @section framemd5
118
119 Per-packet MD5 testing format.
120
121 This muxer computes and prints the MD5 hash for each audio
122 and video packet. By default audio frames are converted to signed
123 16-bit raw audio and video frames to raw video before computing the
124 hash.
125
126 The output of the muxer consists of a line for each audio and video
127 packet of the form:
128 @example
129 @var{stream_index}, @var{packet_dts}, @var{packet_pts}, @var{packet_duration}, @var{packet_size}, @var{MD5}
130 @end example
131
132 @var{MD5} is a hexadecimal number representing the computed MD5 hash
133 for the packet.
134
135 For example to compute the MD5 of the audio and video frames in
136 @file{INPUT}, converted to raw audio and video packets, and store it
137 in the file @file{out.md5}:
138 @example
139 ffmpeg -i INPUT -f framemd5 out.md5
140 @end example
141
142 To print the information to stdout, use the command:
143 @example
144 ffmpeg -i INPUT -f framemd5 -
145 @end example
146
147 See also the @ref{md5} muxer.
148
149 @anchor{hls}
150 @section hls
151
152 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
153 the HTTP Live Streaming specification.
154
155 It creates a playlist file and numbered segment files. The output
156 filename specifies the playlist filename; the segment filenames
157 receive the same basename as the playlist, a sequential number and
158 a .ts extension.
159
160 @example
161 ffmpeg -i in.nut out.m3u8
162 @end example
163
164 @table @option
165 @item -hls_time @var{seconds}
166 Set the segment length in seconds.
167 @item -hls_list_size @var{size}
168 Set the maximum number of playlist entries.
169 @item -hls_wrap @var{wrap}
170 Set the number after which index wraps.
171 @item -start_number @var{number}
172 Start the sequence from @var{number}.
173 @end table
174
175 @anchor{ico}
176 @section ico
177
178 ICO file muxer.
179
180 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
181
182 @itemize
183 @item
184 Size cannot exceed 256 pixels in any dimension
185
186 @item
187 Only BMP and PNG images can be stored
188
189 @item
190 If a BMP image is used, it must be one of the following pixel formats:
191 @example
192 BMP Bit Depth      FFmpeg Pixel Format
193 1bit               pal8
194 4bit               pal8
195 8bit               pal8
196 16bit              rgb555le
197 24bit              bgr24
198 32bit              bgra
199 @end example
200
201 @item
202 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
203
204 @item
205 If a PNG image is used, it must use the rgba pixel format
206 @end itemize
207
208 @anchor{image2}
209 @section image2
210
211 Image file muxer.
212
213 The image file muxer writes video frames to image files.
214
215 The output filenames are specified by a pattern, which can be used to
216 produce sequentially numbered series of files.
217 The pattern may contain the string "%d" or "%0@var{N}d", this string
218 specifies the position of the characters representing a numbering in
219 the filenames. If the form "%0@var{N}d" is used, the string
220 representing the number in each filename is 0-padded to @var{N}
221 digits. The literal character '%' can be specified in the pattern with
222 the string "%%".
223
224 If the pattern contains "%d" or "%0@var{N}d", the first filename of
225 the file list specified will contain the number 1, all the following
226 numbers will be sequential.
227
228 The pattern may contain a suffix which is used to automatically
229 determine the format of the image files to write.
230
231 For example the pattern "img-%03d.bmp" will specify a sequence of
232 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
233 @file{img-010.bmp}, etc.
234 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
235 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
236 etc.
237
238 The following example shows how to use @command{ffmpeg} for creating a
239 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
240 taking one image every second from the input video:
241 @example
242 ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
243 @end example
244
245 Note that with @command{ffmpeg}, if the format is not specified with the
246 @code{-f} option and the output filename specifies an image file
247 format, the image2 muxer is automatically selected, so the previous
248 command can be written as:
249 @example
250 ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
251 @end example
252
253 Note also that the pattern must not necessarily contain "%d" or
254 "%0@var{N}d", for example to create a single image file
255 @file{img.jpeg} from the input video you can employ the command:
256 @example
257 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
258 @end example
259
260 @table @option
261 @item start_number @var{number}
262 Start the sequence from @var{number}. Default value is 1. Must be a
263 positive number.
264
265 @item -update @var{number}
266 If @var{number} is nonzero, the filename will always be interpreted as just a
267 filename, not a pattern, and this file will be continuously overwritten with new
268 images.
269
270 @end table
271
272 The image muxer supports the .Y.U.V image file format. This format is
273 special in that that each image frame consists of three files, for
274 each of the YUV420P components. To read or write this image file format,
275 specify the name of the '.Y' file. The muxer will automatically open the
276 '.U' and '.V' files as required.
277
278 @section matroska
279
280 Matroska container muxer.
281
282 This muxer implements the matroska and webm container specs.
283
284 The recognized metadata settings in this muxer are:
285
286 @table @option
287
288 @item title=@var{title name}
289 Name provided to a single track
290 @end table
291
292 @table @option
293
294 @item language=@var{language name}
295 Specifies the language of the track in the Matroska languages form
296 @end table
297
298 @table @option
299
300 @item stereo_mode=@var{mode}
301 Stereo 3D video layout of two views in a single video track
302 @table @option
303 @item mono
304 video is not stereo
305 @item left_right
306 Both views are arranged side by side, Left-eye view is on the left
307 @item bottom_top
308 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
309 @item top_bottom
310 Both views are arranged in top-bottom orientation, Left-eye view is on top
311 @item checkerboard_rl
312 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
313 @item checkerboard_lr
314 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
315 @item row_interleaved_rl
316 Each view is constituted by a row based interleaving, Right-eye view is first row
317 @item row_interleaved_lr
318 Each view is constituted by a row based interleaving, Left-eye view is first row
319 @item col_interleaved_rl
320 Both views are arranged in a column based interleaving manner, Right-eye view is first column
321 @item col_interleaved_lr
322 Both views are arranged in a column based interleaving manner, Left-eye view is first column
323 @item anaglyph_cyan_red
324 All frames are in anaglyph format viewable through red-cyan filters
325 @item right_left
326 Both views are arranged side by side, Right-eye view is on the left
327 @item anaglyph_green_magenta
328 All frames are in anaglyph format viewable through green-magenta filters
329 @item block_lr
330 Both eyes laced in one Block, Left-eye view is first
331 @item block_rl
332 Both eyes laced in one Block, Right-eye view is first
333 @end table
334 @end table
335
336 For example a 3D WebM clip can be created using the following command line:
337 @example
338 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
339 @end example
340
341 This muxer supports the following options:
342
343 @table @option
344
345 @item reserve_index_space
346 By default, this muxer writes the index for seeking (called cues in Matroska
347 terms) at the end of the file, because it cannot know in advance how much space
348 to leave for the index at the beginning of the file. However for some use cases
349 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
350 index at the beginning of the file.
351
352 If this option is set to a non-zero value, the muxer will reserve a given amount
353 of space in the file header and then try to write the cues there when the muxing
354 finishes. If the available space does not suffice, muxing will fail. A safe size
355 for most use cases should be about 50kB per hour of video.
356
357 Note that cues are only written if the output is seekable and this option will
358 have no effect if it is not.
359
360 @end table
361
362 @anchor{md5}
363 @section md5
364
365 MD5 testing format.
366
367 This muxer computes and prints the MD5 hash of all the input audio
368 and video frames. By default audio frames are converted to signed
369 16-bit raw audio and video frames to raw video before computing the
370 hash.
371
372 The output of the muxer consists of a single line of the form:
373 MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
374 the computed MD5 hash.
375
376 For example to compute the MD5 hash of the input converted to raw
377 audio and video, and store it in the file @file{out.md5}:
378 @example
379 ffmpeg -i INPUT -f md5 out.md5
380 @end example
381
382 You can print the MD5 to stdout with the command:
383 @example
384 ffmpeg -i INPUT -f md5 -
385 @end example
386
387 See also the @ref{framemd5} muxer.
388
389 @section MOV/MP4/ISMV
390
391 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
392 file has all the metadata about all packets stored in one location
393 (written at the end of the file, it can be moved to the start for
394 better playback by adding @var{faststart} to the @var{movflags}, or
395 using the @command{qt-faststart} tool). A fragmented
396 file consists of a number of fragments, where packets and metadata
397 about these packets are stored together. Writing a fragmented
398 file has the advantage that the file is decodable even if the
399 writing is interrupted (while a normal MOV/MP4 is undecodable if
400 it is not properly finished), and it requires less memory when writing
401 very long files (since writing normal MOV/MP4 files stores info about
402 every single packet in memory until the file is closed). The downside
403 is that it is less compatible with other applications.
404
405 Fragmentation is enabled by setting one of the AVOptions that define
406 how to cut the file into fragments:
407
408 @table @option
409 @item -moov_size @var{bytes}
410 Reserves space for the moov atom at the beginning of the file instead of placing the
411 moov atom at the end. If the space reserved is insufficient, muxing will fail.
412 @item -movflags frag_keyframe
413 Start a new fragment at each video keyframe.
414 @item -frag_duration @var{duration}
415 Create fragments that are @var{duration} microseconds long.
416 @item -frag_size @var{size}
417 Create fragments that contain up to @var{size} bytes of payload data.
418 @item -movflags frag_custom
419 Allow the caller to manually choose when to cut fragments, by
420 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
421 the packets written so far. (This is only useful with other
422 applications integrating libavformat, not from @command{ffmpeg}.)
423 @item -min_frag_duration @var{duration}
424 Don't create fragments that are shorter than @var{duration} microseconds long.
425 @end table
426
427 If more than one condition is specified, fragments are cut when
428 one of the specified conditions is fulfilled. The exception to this is
429 @code{-min_frag_duration}, which has to be fulfilled for any of the other
430 conditions to apply.
431
432 Additionally, the way the output file is written can be adjusted
433 through a few other options:
434
435 @table @option
436 @item -movflags empty_moov
437 Write an initial moov atom directly at the start of the file, without
438 describing any samples in it. Generally, an mdat/moov pair is written
439 at the start of the file, as a normal MOV/MP4 file, containing only
440 a short portion of the file. With this option set, there is no initial
441 mdat atom, and the moov atom only describes the tracks but has
442 a zero duration.
443
444 Files written with this option set do not work in QuickTime.
445 This option is implicitly set when writing ismv (Smooth Streaming) files.
446 @item -movflags separate_moof
447 Write a separate moof (movie fragment) atom for each track. Normally,
448 packets for all tracks are written in a moof atom (which is slightly
449 more efficient), but with this option set, the muxer writes one moof/mdat
450 pair for each track, making it easier to separate tracks.
451
452 This option is implicitly set when writing ismv (Smooth Streaming) files.
453 @item -movflags faststart
454 Run a second pass moving the index (moov atom) to the beginning of the file.
455 This operation can take a while, and will not work in various situations such
456 as fragmented output, thus it is not enabled by default.
457 @item -movflags rtphint
458 Add RTP hinting tracks to the output file.
459 @end table
460
461 Smooth Streaming content can be pushed in real time to a publishing
462 point on IIS with this muxer. Example:
463 @example
464 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
465 @end example
466
467 @section mp3
468
469 The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
470 optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
471 @code{id3v2_version} option controls which one is used. The legacy ID3v1 tag is
472 not written by default, but may be enabled with the @code{write_id3v1} option.
473
474 For seekable output the muxer also writes a Xing frame at the beginning, which
475 contains the number of frames in the file. It is useful for computing duration
476 of VBR files.
477
478 The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
479 are supplied to the muxer in form of a video stream with a single packet. There
480 can be any number of those streams, each will correspond to a single APIC frame.
481 The stream metadata tags @var{title} and @var{comment} map to APIC
482 @var{description} and @var{picture type} respectively. See
483 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
484
485 Note that the APIC frames must be written at the beginning, so the muxer will
486 buffer the audio frames until it gets all the pictures. It is therefore advised
487 to provide the pictures as soon as possible to avoid excessive buffering.
488
489 Examples:
490
491 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
492 @example
493 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
494 @end example
495
496 To attach a picture to an mp3 file select both the audio and the picture stream
497 with @code{map}:
498 @example
499 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
500 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
501 @end example
502
503 @section mpegts
504
505 MPEG transport stream muxer.
506
507 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
508
509 The muxer options are:
510
511 @table @option
512 @item -mpegts_original_network_id @var{number}
513 Set the original_network_id (default 0x0001). This is unique identifier
514 of a network in DVB. Its main use is in the unique identification of a
515 service through the path Original_Network_ID, Transport_Stream_ID.
516 @item -mpegts_transport_stream_id @var{number}
517 Set the transport_stream_id (default 0x0001). This identifies a
518 transponder in DVB.
519 @item -mpegts_service_id @var{number}
520 Set the service_id (default 0x0001) also known as program in DVB.
521 @item -mpegts_pmt_start_pid @var{number}
522 Set the first PID for PMT (default 0x1000, max 0x1f00).
523 @item -mpegts_start_pid @var{number}
524 Set the first PID for data packets (default 0x0100, max 0x0f00).
525 @item -mpegts_m2ts_mode @var{number}
526 Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
527 @item -muxrate @var{number}
528 Set muxrate.
529 @item -pes_payload_size @var{number}
530 Set minimum PES packet payload in bytes.
531 @item -mpegts_flags @var{flags}
532 Set flags (see below).
533 @item -mpegts_copyts @var{number}
534 Preserve original timestamps, if value is set to 1. Default value is -1, which
535 results in shifting timestamps so that they start from 0.
536 @item -tables_version @var{number}
537 Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
538 This option allows updating stream structure so that standard consumer may
539 detect the change. To do so, reopen output AVFormatContext (in case of API
540 usage) or restart ffmpeg instance, cyclically changing tables_version value:
541 @example
542 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
543 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
544 ...
545 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
546 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
547 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
548 ...
549 @end example
550 @end table
551
552 Option mpegts_flags may take a set of such flags:
553
554 @table @option
555 @item resend_headers
556 Reemit PAT/PMT before writing the next packet.
557 @item latm
558 Use LATM packetization for AAC.
559 @end table
560
561 The recognized metadata settings in mpegts muxer are @code{service_provider}
562 and @code{service_name}. If they are not set the default for
563 @code{service_provider} is "FFmpeg" and the default for
564 @code{service_name} is "Service01".
565
566 @example
567 ffmpeg -i file.mpg -c copy \
568      -mpegts_original_network_id 0x1122 \
569      -mpegts_transport_stream_id 0x3344 \
570      -mpegts_service_id 0x5566 \
571      -mpegts_pmt_start_pid 0x1500 \
572      -mpegts_start_pid 0x150 \
573      -metadata service_provider="Some provider" \
574      -metadata service_name="Some Channel" \
575      -y out.ts
576 @end example
577
578 @section null
579
580 Null muxer.
581
582 This muxer does not generate any output file, it is mainly useful for
583 testing or benchmarking purposes.
584
585 For example to benchmark decoding with @command{ffmpeg} you can use the
586 command:
587 @example
588 ffmpeg -benchmark -i INPUT -f null out.null
589 @end example
590
591 Note that the above command does not read or write the @file{out.null}
592 file, but specifying the output file is required by the @command{ffmpeg}
593 syntax.
594
595 Alternatively you can write the command as:
596 @example
597 ffmpeg -benchmark -i INPUT -f null -
598 @end example
599
600 @section ogg
601
602 Ogg container muxer.
603
604 @table @option
605 @item -page_duration @var{duration}
606 Preferred page duration, in microseconds. The muxer will attempt to create
607 pages that are approximately @var{duration} microseconds long. This allows the
608 user to compromise between seek granularity and container overhead. The default
609 is 1 second. A value of 0 will fill all segments, making pages as large as
610 possible. A value of 1 will effectively use 1 packet-per-page in most
611 situations, giving a small seek granularity at the cost of additional container
612 overhead.
613 @end table
614
615 @section segment, stream_segment, ssegment
616
617 Basic stream segmenter.
618
619 The segmenter muxer outputs streams to a number of separate files of nearly
620 fixed duration. Output filename pattern can be set in a fashion similar to
621 @ref{image2}.
622
623 @code{stream_segment} is a variant of the muxer used to write to
624 streaming output formats, i.e. which do not require global headers,
625 and is recommended for outputting e.g. to MPEG transport stream segments.
626 @code{ssegment} is a shorter alias for @code{stream_segment}.
627
628 Every segment starts with a keyframe of the selected reference stream,
629 which is set through the @option{reference_stream} option.
630
631 Note that if you want accurate splitting for a video file, you need to
632 make the input key frames correspond to the exact splitting times
633 expected by the segmenter, or the segment muxer will start the new
634 segment with the key frame found next after the specified start
635 time.
636
637 The segment muxer works best with a single constant frame rate video.
638
639 Optionally it can generate a list of the created segments, by setting
640 the option @var{segment_list}. The list type is specified by the
641 @var{segment_list_type} option.
642
643 The segment muxer supports the following options:
644
645 @table @option
646 @item reference_stream @var{specifier}
647 Set the reference stream, as specified by the string @var{specifier}.
648 If @var{specifier} is set to @code{auto}, the reference is choosen
649 automatically. Otherwise it must be a stream specifier (see the ``Stream
650 specifiers'' chapter in the ffmpeg manual) which specifies the
651 reference stream. The default value is @code{auto}.
652
653 @item segment_format @var{format}
654 Override the inner container format, by default it is guessed by the filename
655 extension.
656
657 @item segment_list @var{name}
658 Generate also a listfile named @var{name}. If not specified no
659 listfile is generated.
660
661 @item segment_list_flags @var{flags}
662 Set flags affecting the segment list generation.
663
664 It currently supports the following flags:
665 @table @samp
666 @item cache
667 Allow caching (only affects M3U8 list files).
668
669 @item live
670 Allow live-friendly file generation.
671 @end table
672
673 Default value is @code{samp}.
674
675 @item segment_list_size @var{size}
676 Update the list file so that it contains at most the last @var{size}
677 segments. If 0 the list file will contain all the segments. Default
678 value is 0.
679
680 @item segment_list_type @var{type}
681 Specify the format for the segment list file.
682
683 The following values are recognized:
684 @table @samp
685 @item flat
686 Generate a flat list for the created segments, one segment per line.
687
688 @item csv, ext
689 Generate a list for the created segments, one segment per line,
690 each line matching the format (comma-separated values):
691 @example
692 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
693 @end example
694
695 @var{segment_filename} is the name of the output file generated by the
696 muxer according to the provided pattern. CSV escaping (according to
697 RFC4180) is applied if required.
698
699 @var{segment_start_time} and @var{segment_end_time} specify
700 the segment start and end time expressed in seconds.
701
702 A list file with the suffix @code{".csv"} or @code{".ext"} will
703 auto-select this format.
704
705 @samp{ext} is deprecated in favor or @samp{csv}.
706
707 @item ffconcat
708 Generate an ffconcat file for the created segments. The resulting file
709 can be read using the FFmpeg @ref{concat} demuxer.
710
711 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
712 auto-select this format.
713
714 @item m3u8
715 Generate an extended M3U8 file, version 3, compliant with
716 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
717
718 A list file with the suffix @code{".m3u8"} will auto-select this format.
719 @end table
720
721 If not specified the type is guessed from the list file name suffix.
722
723 @item segment_time @var{time}
724 Set segment duration to @var{time}, the value must be a duration
725 specification. Default value is "2". See also the
726 @option{segment_times} option.
727
728 Note that splitting may not be accurate, unless you force the
729 reference stream key-frames at the given time. See the introductory
730 notice and the examples below.
731
732 @item segment_time_delta @var{delta}
733 Specify the accuracy time when selecting the start time for a
734 segment, expressed as a duration specification. Default value is "0".
735
736 When delta is specified a key-frame will start a new segment if its
737 PTS satisfies the relation:
738 @example
739 PTS >= start_time - time_delta
740 @end example
741
742 This option is useful when splitting video content, which is always
743 split at GOP boundaries, in case a key frame is found just before the
744 specified split time.
745
746 In particular may be used in combination with the @file{ffmpeg} option
747 @var{force_key_frames}. The key frame times specified by
748 @var{force_key_frames} may not be set accurately because of rounding
749 issues, with the consequence that a key frame time may result set just
750 before the specified time. For constant frame rate videos a value of
751 1/2*@var{frame_rate} should address the worst case mismatch between
752 the specified time and the time set by @var{force_key_frames}.
753
754 @item segment_times @var{times}
755 Specify a list of split points. @var{times} contains a list of comma
756 separated duration specifications, in increasing order. See also
757 the @option{segment_time} option.
758
759 @item segment_frames @var{frames}
760 Specify a list of split video frame numbers. @var{frames} contains a
761 list of comma separated integer numbers, in increasing order.
762
763 This option specifies to start a new segment whenever a reference
764 stream key frame is found and the sequential number (starting from 0)
765 of the frame is greater or equal to the next value in the list.
766
767 @item segment_wrap @var{limit}
768 Wrap around segment index once it reaches @var{limit}.
769
770 @item segment_start_number @var{number}
771 Set the sequence number of the first segment. Defaults to @code{0}.
772
773 @item reset_timestamps @var{1|0}
774 Reset timestamps at the begin of each segment, so that each segment
775 will start with near-zero timestamps. It is meant to ease the playback
776 of the generated segments. May not work with some combinations of
777 muxers/codecs. It is set to @code{0} by default.
778
779 @item initial_offset @var{offset}
780 Specify timestamp offset to apply to the output packet timestamps. The
781 argument must be a time duration specification, and defaults to 0.
782 @end table
783
784 @subsection Examples
785
786 @itemize
787 @item
788 To remux the content of file @file{in.mkv} to a list of segments
789 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
790 generated segments to @file{out.list}:
791 @example
792 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
793 @end example
794
795 @item
796 As the example above, but segment the input file according to the split
797 points specified by the @var{segment_times} option:
798 @example
799 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
800 @end example
801
802 @item
803 As the example above, but use the @command{ffmpeg} @option{force_key_frames}
804 option to force key frames in the input at the specified location, together
805 with the segment option @option{segment_time_delta} to account for
806 possible roundings operated when setting key frame times.
807 @example
808 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
809 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
810 @end example
811 In order to force key frames on the input file, transcoding is
812 required.
813
814 @item
815 Segment the input file by splitting the input file according to the
816 frame numbers sequence specified with the @option{segment_frames} option:
817 @example
818 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
819 @end example
820
821 @item
822 To convert the @file{in.mkv} to TS segments using the @code{libx264}
823 and @code{libfaac} encoders:
824 @example
825 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
826 @end example
827
828 @item
829 Segment the input file, and create an M3U8 live playlist (can be used
830 as live HLS source):
831 @example
832 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
833 -segment_list_flags +live -segment_time 10 out%03d.mkv
834 @end example
835 @end itemize
836
837 @section tee
838
839 The tee muxer can be used to write the same data to several files or any
840 other kind of muxer. It can be used, for example, to both stream a video to
841 the network and save it to disk at the same time.
842
843 It is different from specifying several outputs to the @command{ffmpeg}
844 command-line tool because the audio and video data will be encoded only once
845 with the tee muxer; encoding can be a very expensive process. It is not
846 useful when using the libavformat API directly because it is then possible
847 to feed the same packets to several muxers directly.
848
849 The slave outputs are specified in the file name given to the muxer,
850 separated by '|'. If any of the slave name contains the '|' separator,
851 leading or trailing spaces or any special character, it must be
852 escaped (see the ``Quoting and escaping'' section in the ffmpeg-utils
853 manual).
854
855 Muxer options can be specified for each slave by prepending them as a list of
856 @var{key}=@var{value} pairs separated by ':', between square brackets. If
857 the options values contain a special character or the ':' separator, they
858 must be escaped; note that this is a second level escaping.
859
860 The following special options are also recognized:
861 @table @option
862 @item f
863 Specify the format name. Useful if it cannot be guessed from the
864 output name suffix.
865
866 @item bsfs[/@var{spec}]
867 Specify a list of bitstream filters to apply to the specified
868 output. It is possible to specify to which streams a given bitstream
869 filter applies, by appending a stream specifier to the option
870 separated by @code{/}. If the stream specifier is not specified, the
871 bistream filters will be applied to all streams in the output.
872
873 Several bitstream filters can be specified, separated by ",".
874
875 @item select
876 Select the streams that should be mapped to the slave output,
877 specified by a stream specifier. If not specified, this defaults to
878 all the input streams.
879 @end table
880
881 Example: encode something and both archive it in a WebM file and stream it
882 as MPEG-TS over UDP (the streams need to be explicitly mapped):
883
884 @example
885 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
886   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
887 @end example
888
889 Example: use @command{ffmpeg} to encode the input, and send the output
890 to three different destinations. The @code{dump_extra} bitstream
891 filter is used to add extradata information to all the output video
892 keyframes packets, as requested by the MPEG-TS format. The select
893 option is applied to @file{out.aac} in order to make it contain only
894 audio packets.
895 @example
896 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
897        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
898 @end example
899
900 Note: some codecs may need different options depending on the output format;
901 the auto-detection of this can not work with the tee muxer. The main example
902 is the @option{global_header} flag.
903
904 @c man end MUXERS