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