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