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