lavf: Add support for WebM Live Muxing
[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 one or more segment files. The output filename
198 specifies the playlist filename.
199
200 By default, the muxer creates a file for each segment produced. These files
201 have the same name as the playlist, followed by a sequential number and a
202 .ts extension.
203
204 For example, to convert an input file with @command{ffmpeg}:
205 @example
206 ffmpeg -i in.nut out.m3u8
207 @end example
208 This example will produce the playlist, @file{out.m3u8}, and segment files:
209 @file{out0.ts}, @file{out1.ts}, @file{out2.ts}, etc.
210
211 See also the @ref{segment} muxer, which provides a more generic and
212 flexible implementation of a segmenter, and can be used to perform HLS
213 segmentation.
214
215 @subsection Options
216
217 This muxer supports the following options:
218
219 @table @option
220 @item hls_time @var{seconds}
221 Set the segment length in seconds. Default value is 2.
222
223 @item hls_list_size @var{size}
224 Set the maximum number of playlist entries. If set to 0 the list file
225 will contain all the segments. Default value is 5.
226
227 @item hls_ts_options @var{options_list}
228 Set output format options using a :-separated list of key=value
229 parameters. Values containing @code{:} special characters must be
230 escaped.
231
232 @item hls_wrap @var{wrap}
233 Set the number after which the segment filename number (the number
234 specified in each segment file) wraps. If set to 0 the number will be
235 never wrapped. Default value is 0.
236
237 This option is useful to avoid to fill the disk with many segment
238 files, and limits the maximum number of segment files written to disk
239 to @var{wrap}.
240
241 @item start_number @var{number}
242 Start the playlist sequence number from @var{number}. Default value is
243 0.
244
245 @item hls_allow_cache @var{allowcache}
246 Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments.
247
248 @item hls_base_url @var{baseurl}
249 Append @var{baseurl} to every entry in the playlist.
250 Useful to generate playlists with absolute paths.
251
252 Note that the playlist sequence number must be unique for each segment
253 and it is not to be confused with the segment filename sequence number
254 which can be cyclic, for example if the @option{wrap} option is
255 specified.
256
257 @item hls_segment_filename @var{filename}
258 Set the segment filename. Unless hls_flags single_file is set @var{filename}
259 is used as a string format with the segment number:
260 @example
261 ffmpeg in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
262 @end example
263 This example will produce the playlist, @file{out.m3u8}, and segment files:
264 @file{file000.ts}, @file{file001.ts}, @file{file002.ts}, etc.
265
266 @item hls_flags single_file
267 If this flag is set, the muxer will store all segments in a single MPEG-TS
268 file, and will use byte ranges in the playlist. HLS playlists generated with
269 this way will have the version number 4.
270 For example:
271 @example
272 ffmpeg -i in.nut -hls_flags single_file out.m3u8
273 @end example
274 Will produce the playlist, @file{out.m3u8}, and a single segment file,
275 @file{out.ts}.
276
277 @item hls_flags delete_segments
278 Segment files removed from the playlist are deleted after a period of time
279 equal to the duration of the segment plus the duration of the playlist.
280 @end table
281
282 @anchor{ico}
283 @section ico
284
285 ICO file muxer.
286
287 Microsoft's icon file format (ICO) has some strict limitations that should be noted:
288
289 @itemize
290 @item
291 Size cannot exceed 256 pixels in any dimension
292
293 @item
294 Only BMP and PNG images can be stored
295
296 @item
297 If a BMP image is used, it must be one of the following pixel formats:
298 @example
299 BMP Bit Depth      FFmpeg Pixel Format
300 1bit               pal8
301 4bit               pal8
302 8bit               pal8
303 16bit              rgb555le
304 24bit              bgr24
305 32bit              bgra
306 @end example
307
308 @item
309 If a BMP image is used, it must use the BITMAPINFOHEADER DIB header
310
311 @item
312 If a PNG image is used, it must use the rgba pixel format
313 @end itemize
314
315 @anchor{image2}
316 @section image2
317
318 Image file muxer.
319
320 The image file muxer writes video frames to image files.
321
322 The output filenames are specified by a pattern, which can be used to
323 produce sequentially numbered series of files.
324 The pattern may contain the string "%d" or "%0@var{N}d", this string
325 specifies the position of the characters representing a numbering in
326 the filenames. If the form "%0@var{N}d" is used, the string
327 representing the number in each filename is 0-padded to @var{N}
328 digits. The literal character '%' can be specified in the pattern with
329 the string "%%".
330
331 If the pattern contains "%d" or "%0@var{N}d", the first filename of
332 the file list specified will contain the number 1, all the following
333 numbers will be sequential.
334
335 The pattern may contain a suffix which is used to automatically
336 determine the format of the image files to write.
337
338 For example the pattern "img-%03d.bmp" will specify a sequence of
339 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
340 @file{img-010.bmp}, etc.
341 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
342 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
343 etc.
344
345 @subsection Examples
346
347 The following example shows how to use @command{ffmpeg} for creating a
348 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
349 taking one image every second from the input video:
350 @example
351 ffmpeg -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
352 @end example
353
354 Note that with @command{ffmpeg}, if the format is not specified with the
355 @code{-f} option and the output filename specifies an image file
356 format, the image2 muxer is automatically selected, so the previous
357 command can be written as:
358 @example
359 ffmpeg -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
360 @end example
361
362 Note also that the pattern must not necessarily contain "%d" or
363 "%0@var{N}d", for example to create a single image file
364 @file{img.jpeg} from the input video you can employ the command:
365 @example
366 ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
367 @end example
368
369 The @option{strftime} option allows you to expand the filename with
370 date and time information. Check the documentation of
371 the @code{strftime()} function for the syntax.
372
373 For example to generate image files from the @code{strftime()}
374 "%Y-%m-%d_%H-%M-%S" pattern, the following @command{ffmpeg} command
375 can be used:
376 @example
377 ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
378 @end example
379
380 @subsection Options
381
382 @table @option
383 @item start_number
384 Start the sequence from the specified number. Default value is 0.
385
386 @item update
387 If set to 1, the filename will always be interpreted as just a
388 filename, not a pattern, and the corresponding file will be continuously
389 overwritten with new images. Default value is 0.
390
391 @item strftime
392 If set to 1, expand the filename with date and time information from
393 @code{strftime()}. Default value is 0.
394 @end table
395
396 The image muxer supports the .Y.U.V image file format. This format is
397 special in that that each image frame consists of three files, for
398 each of the YUV420P components. To read or write this image file format,
399 specify the name of the '.Y' file. The muxer will automatically open the
400 '.U' and '.V' files as required.
401
402 @section matroska
403
404 Matroska container muxer.
405
406 This muxer implements the matroska and webm container specs.
407
408 @subsection Metadata
409
410 The recognized metadata settings in this muxer are:
411
412 @table @option
413 @item title
414 Set title name provided to a single track.
415
416 @item language
417 Specify the language of the track in the Matroska languages form.
418
419 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
420 639-2/B) form (like "fre" for French), or a language code mixed with a
421 country code for specialities in languages (like "fre-ca" for Canadian
422 French).
423
424 @item stereo_mode
425 Set stereo 3D video layout of two views in a single video track.
426
427 The following values are recognized:
428 @table @samp
429 @item mono
430 video is not stereo
431 @item left_right
432 Both views are arranged side by side, Left-eye view is on the left
433 @item bottom_top
434 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
435 @item top_bottom
436 Both views are arranged in top-bottom orientation, Left-eye view is on top
437 @item checkerboard_rl
438 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
439 @item checkerboard_lr
440 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
441 @item row_interleaved_rl
442 Each view is constituted by a row based interleaving, Right-eye view is first row
443 @item row_interleaved_lr
444 Each view is constituted by a row based interleaving, Left-eye view is first row
445 @item col_interleaved_rl
446 Both views are arranged in a column based interleaving manner, Right-eye view is first column
447 @item col_interleaved_lr
448 Both views are arranged in a column based interleaving manner, Left-eye view is first column
449 @item anaglyph_cyan_red
450 All frames are in anaglyph format viewable through red-cyan filters
451 @item right_left
452 Both views are arranged side by side, Right-eye view is on the left
453 @item anaglyph_green_magenta
454 All frames are in anaglyph format viewable through green-magenta filters
455 @item block_lr
456 Both eyes laced in one Block, Left-eye view is first
457 @item block_rl
458 Both eyes laced in one Block, Right-eye view is first
459 @end table
460 @end table
461
462 For example a 3D WebM clip can be created using the following command line:
463 @example
464 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
465 @end example
466
467 @subsection Options
468
469 This muxer supports the following options:
470
471 @table @option
472 @item reserve_index_space
473 By default, this muxer writes the index for seeking (called cues in Matroska
474 terms) at the end of the file, because it cannot know in advance how much space
475 to leave for the index at the beginning of the file. However for some use cases
476 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
477 index at the beginning of the file.
478
479 If this option is set to a non-zero value, the muxer will reserve a given amount
480 of space in the file header and then try to write the cues there when the muxing
481 finishes. If the available space does not suffice, muxing will fail. A safe size
482 for most use cases should be about 50kB per hour of video.
483
484 Note that cues are only written if the output is seekable and this option will
485 have no effect if it is not.
486 @end table
487
488 @anchor{md5}
489 @section md5
490
491 MD5 testing format.
492
493 This muxer computes and prints the MD5 hash of all the input audio
494 and video frames. By default audio frames are converted to signed
495 16-bit raw audio and video frames to raw video before computing the
496 hash.
497
498 The output of the muxer consists of a single line of the form:
499 MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
500 the computed MD5 hash.
501
502 For example to compute the MD5 hash of the input converted to raw
503 audio and video, and store it in the file @file{out.md5}:
504 @example
505 ffmpeg -i INPUT -f md5 out.md5
506 @end example
507
508 You can print the MD5 to stdout with the command:
509 @example
510 ffmpeg -i INPUT -f md5 -
511 @end example
512
513 See also the @ref{framemd5} muxer.
514
515 @section mov, mp4, ismv
516
517 MOV/MP4/ISMV (Smooth Streaming) muxer.
518
519 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
520 file has all the metadata about all packets stored in one location
521 (written at the end of the file, it can be moved to the start for
522 better playback by adding @var{faststart} to the @var{movflags}, or
523 using the @command{qt-faststart} tool). A fragmented
524 file consists of a number of fragments, where packets and metadata
525 about these packets are stored together. Writing a fragmented
526 file has the advantage that the file is decodable even if the
527 writing is interrupted (while a normal MOV/MP4 is undecodable if
528 it is not properly finished), and it requires less memory when writing
529 very long files (since writing normal MOV/MP4 files stores info about
530 every single packet in memory until the file is closed). The downside
531 is that it is less compatible with other applications.
532
533 @subsection Options
534
535 Fragmentation is enabled by setting one of the AVOptions that define
536 how to cut the file into fragments:
537
538 @table @option
539 @item -moov_size @var{bytes}
540 Reserves space for the moov atom at the beginning of the file instead of placing the
541 moov atom at the end. If the space reserved is insufficient, muxing will fail.
542 @item -movflags frag_keyframe
543 Start a new fragment at each video keyframe.
544 @item -frag_duration @var{duration}
545 Create fragments that are @var{duration} microseconds long.
546 @item -frag_size @var{size}
547 Create fragments that contain up to @var{size} bytes of payload data.
548 @item -movflags frag_custom
549 Allow the caller to manually choose when to cut fragments, by
550 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
551 the packets written so far. (This is only useful with other
552 applications integrating libavformat, not from @command{ffmpeg}.)
553 @item -min_frag_duration @var{duration}
554 Don't create fragments that are shorter than @var{duration} microseconds long.
555 @end table
556
557 If more than one condition is specified, fragments are cut when
558 one of the specified conditions is fulfilled. The exception to this is
559 @code{-min_frag_duration}, which has to be fulfilled for any of the other
560 conditions to apply.
561
562 Additionally, the way the output file is written can be adjusted
563 through a few other options:
564
565 @table @option
566 @item -movflags empty_moov
567 Write an initial moov atom directly at the start of the file, without
568 describing any samples in it. Generally, an mdat/moov pair is written
569 at the start of the file, as a normal MOV/MP4 file, containing only
570 a short portion of the file. With this option set, there is no initial
571 mdat atom, and the moov atom only describes the tracks but has
572 a zero duration.
573
574 This option is implicitly set when writing ismv (Smooth Streaming) files.
575 @item -movflags separate_moof
576 Write a separate moof (movie fragment) atom for each track. Normally,
577 packets for all tracks are written in a moof atom (which is slightly
578 more efficient), but with this option set, the muxer writes one moof/mdat
579 pair for each track, making it easier to separate tracks.
580
581 This option is implicitly set when writing ismv (Smooth Streaming) files.
582 @item -movflags faststart
583 Run a second pass moving the index (moov atom) to the beginning of the file.
584 This operation can take a while, and will not work in various situations such
585 as fragmented output, thus it is not enabled by default.
586 @item -movflags rtphint
587 Add RTP hinting tracks to the output file.
588 @item -movflags disable_chpl
589 Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
590 and a QuickTime chapter track are written to the file. With this option
591 set, only the QuickTime chapter track will be written. Nero chapters can
592 cause failures when the file is reprocessed with certain tagging programs, like
593 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
594 @item -movflags omit_tfhd_offset
595 Do not write any absolute base_data_offset in tfhd atoms. This avoids
596 tying fragments to absolute byte positions in the file/streams.
597 @item -movflags default_base_moof
598 Similarly to the omit_tfhd_offset, this flag avoids writing the
599 absolute base_data_offset field in tfhd atoms, but does so by using
600 the new default-base-is-moof flag instead. This flag is new from
601 14496-12:2012. This may make the fragments easier to parse in certain
602 circumstances (avoiding basing track fragment location calculations
603 on the implicit end of the previous track fragment).
604 @end table
605
606 @subsection Example
607
608 Smooth Streaming content can be pushed in real time to a publishing
609 point on IIS with this muxer. Example:
610 @example
611 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
612 @end example
613
614 @section mp3
615
616 The MP3 muxer writes a raw MP3 stream with the following optional features:
617 @itemize @bullet
618 @item
619 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
620 2.4 are supported, the @code{id3v2_version} private option controls which one is
621 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
622 completely.
623
624 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
625 The pictures are supplied to the muxer in form of a video stream with a single
626 packet. There can be any number of those streams, each will correspond to a
627 single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
628 to APIC @var{description} and @var{picture type} respectively. See
629 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
630
631 Note that the APIC frames must be written at the beginning, so the muxer will
632 buffer the audio frames until it gets all the pictures. It is therefore advised
633 to provide the pictures as soon as possible to avoid excessive buffering.
634
635 @item
636 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
637 default, but will be written only if the output is seekable. The
638 @code{write_xing} private option can be used to disable it.  The frame contains
639 various information that may be useful to the decoder, like the audio duration
640 or encoder delay.
641
642 @item
643 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
644 enabled with the @code{write_id3v1} private option, but as its capabilities are
645 very limited, its usage is not recommended.
646 @end itemize
647
648 Examples:
649
650 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
651 @example
652 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
653 @end example
654
655 To attach a picture to an mp3 file select both the audio and the picture stream
656 with @code{map}:
657 @example
658 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
659 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
660 @end example
661
662 Write a "clean" MP3 without any extra features:
663 @example
664 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
665 @end example
666
667 @section mpegts
668
669 MPEG transport stream muxer.
670
671 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
672
673 The recognized metadata settings in mpegts muxer are @code{service_provider}
674 and @code{service_name}. If they are not set the default for
675 @code{service_provider} is "FFmpeg" and the default for
676 @code{service_name} is "Service01".
677
678 @subsection Options
679
680 The muxer options are:
681
682 @table @option
683 @item -mpegts_original_network_id @var{number}
684 Set the original_network_id (default 0x0001). This is unique identifier
685 of a network in DVB. Its main use is in the unique identification of a
686 service through the path Original_Network_ID, Transport_Stream_ID.
687 @item -mpegts_transport_stream_id @var{number}
688 Set the transport_stream_id (default 0x0001). This identifies a
689 transponder in DVB.
690 @item -mpegts_service_id @var{number}
691 Set the service_id (default 0x0001) also known as program in DVB.
692 @item -mpegts_service_type @var{number}
693 Set the program service_type (default @var{digital_tv}), see below
694 a list of pre defined values.
695 @item -mpegts_pmt_start_pid @var{number}
696 Set the first PID for PMT (default 0x1000, max 0x1f00).
697 @item -mpegts_start_pid @var{number}
698 Set the first PID for data packets (default 0x0100, max 0x0f00).
699 @item -mpegts_m2ts_mode @var{number}
700 Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
701 @item -muxrate @var{number}
702 Set a constant muxrate (default VBR).
703 @item -pcr_period @var{numer}
704 Override the default PCR retransmission time (default 20ms), ignored
705 if variable muxrate is selected.
706 @item -pes_payload_size @var{number}
707 Set minimum PES packet payload in bytes.
708 @item -mpegts_flags @var{flags}
709 Set flags (see below).
710 @item -mpegts_copyts @var{number}
711 Preserve original timestamps, if value is set to 1. Default value is -1, which
712 results in shifting timestamps so that they start from 0.
713 @item -tables_version @var{number}
714 Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
715 This option allows updating stream structure so that standard consumer may
716 detect the change. To do so, reopen output AVFormatContext (in case of API
717 usage) or restart ffmpeg instance, cyclically changing tables_version value:
718 @example
719 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
720 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
721 ...
722 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
723 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
724 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
725 ...
726 @end example
727 @end table
728
729 Option mpegts_service_type accepts the following values:
730
731 @table @option
732 @item hex_value
733 Any hexdecimal value between 0x01 to 0xff as defined in ETSI 300 468.
734 @item digital_tv
735 Digital TV service.
736 @item digital_radio
737 Digital Radio service.
738 @item teletext
739 Teletext service.
740 @item advanced_codec_digital_radio
741 Advanced Codec Digital Radio service.
742 @item mpeg2_digital_hdtv
743 MPEG2 Digital HDTV service.
744 @item advanced_codec_digital_sdtv
745 Advanced Codec Digital SDTV service.
746 @item advanced_codec_digital_hdtv
747 Advanced Codec Digital HDTV service.
748 @end table
749
750 Option mpegts_flags may take a set of such flags:
751
752 @table @option
753 @item resend_headers
754 Reemit PAT/PMT before writing the next packet.
755 @item latm
756 Use LATM packetization for AAC.
757 @end table
758
759 @subsection Example
760
761 @example
762 ffmpeg -i file.mpg -c copy \
763      -mpegts_original_network_id 0x1122 \
764      -mpegts_transport_stream_id 0x3344 \
765      -mpegts_service_id 0x5566 \
766      -mpegts_pmt_start_pid 0x1500 \
767      -mpegts_start_pid 0x150 \
768      -metadata service_provider="Some provider" \
769      -metadata service_name="Some Channel" \
770      -y out.ts
771 @end example
772
773 @section null
774
775 Null muxer.
776
777 This muxer does not generate any output file, it is mainly useful for
778 testing or benchmarking purposes.
779
780 For example to benchmark decoding with @command{ffmpeg} you can use the
781 command:
782 @example
783 ffmpeg -benchmark -i INPUT -f null out.null
784 @end example
785
786 Note that the above command does not read or write the @file{out.null}
787 file, but specifying the output file is required by the @command{ffmpeg}
788 syntax.
789
790 Alternatively you can write the command as:
791 @example
792 ffmpeg -benchmark -i INPUT -f null -
793 @end example
794
795 @section nut
796
797 @table @option
798 @item -syncpoints @var{flags}
799 Change the syncpoint usage in nut:
800 @table @option
801 @item @var{default} use the normal low-overhead seeking aids.
802 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
803     Use of this option is not recommended, as the resulting files are very damage
804     sensitive and seeking is not possible. Also in general the overhead from
805     syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
806     all growing data tables, allowing to mux endless streams with limited memory
807     and without these disadvantages.
808 @item @var{timestamped} extend the syncpoint with a wallclock field.
809 @end table
810 The @var{none} and @var{timestamped} flags are experimental.
811 @item -write_index @var{bool}
812 Write index at the end, the default is to write an index.
813 @end table
814
815 @example
816 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
817 @end example
818
819 @section ogg
820
821 Ogg container muxer.
822
823 @table @option
824 @item -page_duration @var{duration}
825 Preferred page duration, in microseconds. The muxer will attempt to create
826 pages that are approximately @var{duration} microseconds long. This allows the
827 user to compromise between seek granularity and container overhead. The default
828 is 1 second. A value of 0 will fill all segments, making pages as large as
829 possible. A value of 1 will effectively use 1 packet-per-page in most
830 situations, giving a small seek granularity at the cost of additional container
831 overhead.
832 @item -serial_offset @var{value}
833 Serial value from which to set the streams serial number.
834 Setting it to different and sufficiently large values ensures that the produced
835 ogg files can be safely chained.
836
837 @end table
838
839 @anchor{segment}
840 @section segment, stream_segment, ssegment
841
842 Basic stream segmenter.
843
844 This muxer outputs streams to a number of separate files of nearly
845 fixed duration. Output filename pattern can be set in a fashion
846 similar to @ref{image2}, or by using a @code{strftime} template if
847 the @option{strftime} option is enabled.
848
849 @code{stream_segment} is a variant of the muxer used to write to
850 streaming output formats, i.e. which do not require global headers,
851 and is recommended for outputting e.g. to MPEG transport stream segments.
852 @code{ssegment} is a shorter alias for @code{stream_segment}.
853
854 Every segment starts with a keyframe of the selected reference stream,
855 which is set through the @option{reference_stream} option.
856
857 Note that if you want accurate splitting for a video file, you need to
858 make the input key frames correspond to the exact splitting times
859 expected by the segmenter, or the segment muxer will start the new
860 segment with the key frame found next after the specified start
861 time.
862
863 The segment muxer works best with a single constant frame rate video.
864
865 Optionally it can generate a list of the created segments, by setting
866 the option @var{segment_list}. The list type is specified by the
867 @var{segment_list_type} option. The entry filenames in the segment
868 list are set by default to the basename of the corresponding segment
869 files.
870
871 See also the @ref{hls} muxer, which provides a more specific
872 implementation for HLS segmentation.
873
874 @subsection Options
875
876 The segment muxer supports the following options:
877
878 @table @option
879 @item reference_stream @var{specifier}
880 Set the reference stream, as specified by the string @var{specifier}.
881 If @var{specifier} is set to @code{auto}, the reference is chosen
882 automatically. Otherwise it must be a stream specifier (see the ``Stream
883 specifiers'' chapter in the ffmpeg manual) which specifies the
884 reference stream. The default value is @code{auto}.
885
886 @item segment_format @var{format}
887 Override the inner container format, by default it is guessed by the filename
888 extension.
889
890 @item segment_format_options @var{options_list}
891 Set output format options using a :-separated list of key=value
892 parameters. Values containing the @code{:} special character must be
893 escaped.
894
895 @item segment_list @var{name}
896 Generate also a listfile named @var{name}. If not specified no
897 listfile is generated.
898
899 @item segment_list_flags @var{flags}
900 Set flags affecting the segment list generation.
901
902 It currently supports the following flags:
903 @table @samp
904 @item cache
905 Allow caching (only affects M3U8 list files).
906
907 @item live
908 Allow live-friendly file generation.
909 @end table
910
911 @item segment_list_type @var{type}
912 Select the listing format.
913 @table @option
914 @item @var{flat} use a simple flat list of entries.
915 @item @var{hls} use a m3u8-like structure.
916 @end table
917
918 @item segment_list_size @var{size}
919 Update the list file so that it contains at most @var{size}
920 segments. If 0 the list file will contain all the segments. Default
921 value is 0.
922
923 @item segment_list_entry_prefix @var{prefix}
924 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
925 By default no prefix is applied.
926
927 The following values are recognized:
928 @table @samp
929 @item flat
930 Generate a flat list for the created segments, one segment per line.
931
932 @item csv, ext
933 Generate a list for the created segments, one segment per line,
934 each line matching the format (comma-separated values):
935 @example
936 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
937 @end example
938
939 @var{segment_filename} is the name of the output file generated by the
940 muxer according to the provided pattern. CSV escaping (according to
941 RFC4180) is applied if required.
942
943 @var{segment_start_time} and @var{segment_end_time} specify
944 the segment start and end time expressed in seconds.
945
946 A list file with the suffix @code{".csv"} or @code{".ext"} will
947 auto-select this format.
948
949 @samp{ext} is deprecated in favor or @samp{csv}.
950
951 @item ffconcat
952 Generate an ffconcat file for the created segments. The resulting file
953 can be read using the FFmpeg @ref{concat} demuxer.
954
955 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
956 auto-select this format.
957
958 @item m3u8
959 Generate an extended M3U8 file, version 3, compliant with
960 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
961
962 A list file with the suffix @code{".m3u8"} will auto-select this format.
963 @end table
964
965 If not specified the type is guessed from the list file name suffix.
966
967 @item segment_time @var{time}
968 Set segment duration to @var{time}, the value must be a duration
969 specification. Default value is "2". See also the
970 @option{segment_times} option.
971
972 Note that splitting may not be accurate, unless you force the
973 reference stream key-frames at the given time. See the introductory
974 notice and the examples below.
975
976 @item segment_atclocktime @var{1|0}
977 If set to "1" split at regular clock time intervals starting from 00:00
978 o'clock. The @var{time} value specified in @option{segment_time} is
979 used for setting the length of the splitting interval.
980
981 For example with @option{segment_time} set to "900" this makes it possible
982 to create files at 12:00 o'clock, 12:15, 12:30, etc.
983
984 Default value is "0".
985
986 @item segment_time_delta @var{delta}
987 Specify the accuracy time when selecting the start time for a
988 segment, expressed as a duration specification. Default value is "0".
989
990 When delta is specified a key-frame will start a new segment if its
991 PTS satisfies the relation:
992 @example
993 PTS >= start_time - time_delta
994 @end example
995
996 This option is useful when splitting video content, which is always
997 split at GOP boundaries, in case a key frame is found just before the
998 specified split time.
999
1000 In particular may be used in combination with the @file{ffmpeg} option
1001 @var{force_key_frames}. The key frame times specified by
1002 @var{force_key_frames} may not be set accurately because of rounding
1003 issues, with the consequence that a key frame time may result set just
1004 before the specified time. For constant frame rate videos a value of
1005 1/(2*@var{frame_rate}) should address the worst case mismatch between
1006 the specified time and the time set by @var{force_key_frames}.
1007
1008 @item segment_times @var{times}
1009 Specify a list of split points. @var{times} contains a list of comma
1010 separated duration specifications, in increasing order. See also
1011 the @option{segment_time} option.
1012
1013 @item segment_frames @var{frames}
1014 Specify a list of split video frame numbers. @var{frames} contains a
1015 list of comma separated integer numbers, in increasing order.
1016
1017 This option specifies to start a new segment whenever a reference
1018 stream key frame is found and the sequential number (starting from 0)
1019 of the frame is greater or equal to the next value in the list.
1020
1021 @item segment_wrap @var{limit}
1022 Wrap around segment index once it reaches @var{limit}.
1023
1024 @item segment_start_number @var{number}
1025 Set the sequence number of the first segment. Defaults to @code{0}.
1026
1027 @item strftime @var{1|0}
1028 Use the @code{strftime} function to define the name of the new
1029 segments to write. If this is selected, the output segment name must
1030 contain a @code{strftime} function template. Default value is
1031 @code{0}.
1032
1033 @item reset_timestamps @var{1|0}
1034 Reset timestamps at the begin of each segment, so that each segment
1035 will start with near-zero timestamps. It is meant to ease the playback
1036 of the generated segments. May not work with some combinations of
1037 muxers/codecs. It is set to @code{0} by default.
1038
1039 @item initial_offset @var{offset}
1040 Specify timestamp offset to apply to the output packet timestamps. The
1041 argument must be a time duration specification, and defaults to 0.
1042 @end table
1043
1044 @subsection Examples
1045
1046 @itemize
1047 @item
1048 Remux the content of file @file{in.mkv} to a list of segments
1049 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
1050 generated segments to @file{out.list}:
1051 @example
1052 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
1053 @end example
1054
1055 @item
1056 Segment input and set output format options for the output segments:
1057 @example
1058 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
1059 @end example
1060
1061 @item
1062 Segment the input file according to the split points specified by the
1063 @var{segment_times} option:
1064 @example
1065 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
1066 @end example
1067
1068 @item
1069 Use the @command{ffmpeg} @option{force_key_frames}
1070 option to force key frames in the input at the specified location, together
1071 with the segment option @option{segment_time_delta} to account for
1072 possible roundings operated when setting key frame times.
1073 @example
1074 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1075 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1076 @end example
1077 In order to force key frames on the input file, transcoding is
1078 required.
1079
1080 @item
1081 Segment the input file by splitting the input file according to the
1082 frame numbers sequence specified with the @option{segment_frames} option:
1083 @example
1084 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
1085 @end example
1086
1087 @item
1088 Convert the @file{in.mkv} to TS segments using the @code{libx264}
1089 and @code{libfaac} encoders:
1090 @example
1091 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
1092 @end example
1093
1094 @item
1095 Segment the input file, and create an M3U8 live playlist (can be used
1096 as live HLS source):
1097 @example
1098 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
1099 -segment_list_flags +live -segment_time 10 out%03d.mkv
1100 @end example
1101 @end itemize
1102
1103 @section smoothstreaming
1104
1105 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1106
1107 @table @option
1108 @item window_size
1109 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1110
1111 @item extra_window_size
1112 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1113
1114 @item lookahead_count
1115 Specify the number of lookahead fragments. Default 2.
1116
1117 @item min_frag_duration
1118 Specify the minimum fragment duration (in microseconds). Default 5000000.
1119
1120 @item remove_at_exit
1121 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1122
1123 @end table
1124
1125 @section tee
1126
1127 The tee muxer can be used to write the same data to several files or any
1128 other kind of muxer. It can be used, for example, to both stream a video to
1129 the network and save it to disk at the same time.
1130
1131 It is different from specifying several outputs to the @command{ffmpeg}
1132 command-line tool because the audio and video data will be encoded only once
1133 with the tee muxer; encoding can be a very expensive process. It is not
1134 useful when using the libavformat API directly because it is then possible
1135 to feed the same packets to several muxers directly.
1136
1137 The slave outputs are specified in the file name given to the muxer,
1138 separated by '|'. If any of the slave name contains the '|' separator,
1139 leading or trailing spaces or any special character, it must be
1140 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
1141 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
1142
1143 Muxer options can be specified for each slave by prepending them as a list of
1144 @var{key}=@var{value} pairs separated by ':', between square brackets. If
1145 the options values contain a special character or the ':' separator, they
1146 must be escaped; note that this is a second level escaping.
1147
1148 The following special options are also recognized:
1149 @table @option
1150 @item f
1151 Specify the format name. Useful if it cannot be guessed from the
1152 output name suffix.
1153
1154 @item bsfs[/@var{spec}]
1155 Specify a list of bitstream filters to apply to the specified
1156 output.
1157
1158 It is possible to specify to which streams a given bitstream filter
1159 applies, by appending a stream specifier to the option separated by
1160 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
1161 stream specifiers}).  If the stream specifier is not specified, the
1162 bitstream filters will be applied to all streams in the output.
1163
1164 Several bitstream filters can be specified, separated by ",".
1165
1166 @item select
1167 Select the streams that should be mapped to the slave output,
1168 specified by a stream specifier. If not specified, this defaults to
1169 all the input streams.
1170 @end table
1171
1172 @subsection Examples
1173
1174 @itemize
1175 @item
1176 Encode something and both archive it in a WebM file and stream it
1177 as MPEG-TS over UDP (the streams need to be explicitly mapped):
1178 @example
1179 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1180   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1181 @end example
1182
1183 @item
1184 Use @command{ffmpeg} to encode the input, and send the output
1185 to three different destinations. The @code{dump_extra} bitstream
1186 filter is used to add extradata information to all the output video
1187 keyframes packets, as requested by the MPEG-TS format. The select
1188 option is applied to @file{out.aac} in order to make it contain only
1189 audio packets.
1190 @example
1191 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1192        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
1193 @end example
1194
1195 @item
1196 As below, but select only stream @code{a:1} for the audio output. Note
1197 that a second level escaping must be performed, as ":" is a special
1198 character used to separate options.
1199 @example
1200 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1201        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
1202 @end example
1203 @end itemize
1204
1205 Note: some codecs may need different options depending on the output format;
1206 the auto-detection of this can not work with the tee muxer. The main example
1207 is the @option{global_header} flag.
1208
1209 @section webm_dash_manifest
1210
1211 WebM DASH Manifest muxer.
1212
1213 This muxer implements the WebM DASH Manifest specification to generate the DASH
1214 manifest XML. It also supports manifest generation for DASH live streams.
1215
1216 For more information see:
1217
1218 @itemize @bullet
1219 @item
1220 WebM DASH Specification: @url{https://sites.google.com/a/webmproject.org/wiki/adaptive-streaming/webm-dash-specification}
1221 @item
1222 ISO DASH Specification: @url{http://standards.iso.org/ittf/PubliclyAvailableStandards/c065274_ISO_IEC_23009-1_2014.zip}
1223 @end itemize
1224
1225 @subsection Options
1226
1227 This muxer supports the following options:
1228
1229 @table @option
1230 @item adaptation_sets
1231 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
1232 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
1233 audio and video streams. Any number of adaptation sets can be added using this option.
1234
1235 @item live
1236 Set this to 1 to create a live stream DASH Manifest. Default: 0.
1237
1238 @item chunk_start_index
1239 Start index of the first chunk. This will go in the @samp{startNumber} attribute
1240 of the @samp{SegmentTemplate} element in the manifest. Default: 0.
1241
1242 @item chunk_duration_ms
1243 Duration of each chunk in milliseconds. This will go in the @samp{duration}
1244 attribute of the @samp{SegmentTemplate} element in the manifest. Default: 1000.
1245
1246 @item utc_timing_url
1247 URL of the page that will return the UTC timestamp in ISO format. This will go
1248 in the @samp{value} attribute of the @samp{UTCTiming} element in the manifest.
1249 Default: None.
1250
1251 @item time_shift_buffer_depth
1252 Smallest time (in seconds) shifting buffer for which any Representation is
1253 guaranteed to be available. This will go in the @samp{timeShiftBufferDepth}
1254 attribute of the @samp{MPD} element. Default: 60.
1255
1256 @end table
1257
1258 @subsection Example
1259 @example
1260 ffmpeg -f webm_dash_manifest -i video1.webm \
1261        -f webm_dash_manifest -i video2.webm \
1262        -f webm_dash_manifest -i audio1.webm \
1263        -f webm_dash_manifest -i audio2.webm \
1264        -map 0 -map 1 -map 2 -map 3 \
1265        -c copy \
1266        -f webm_dash_manifest \
1267        -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
1268        manifest.xml
1269 @end example
1270
1271 @section webm_chunk
1272
1273 WebM Live Chunk Muxer.
1274
1275 This muxer writes out WebM headers and chunks as separate files which can be
1276 consumed by clients that support WebM Live streams via DASH.
1277
1278 @subsection Options
1279
1280 This muxer supports the following options:
1281
1282 @table @option
1283 @item chunk_start_index
1284 Index of the first chunk (defaults to 0).
1285
1286 @item header
1287 Filename of the header where the initialization data will be written.
1288
1289 @item audio_chunk_duration
1290 Duration of each audio chunk in milliseconds (defaults to 5000).
1291 @end table
1292
1293 @subsection Example
1294 @example
1295 ffmpeg -f v4l2 -i /dev/video0 \
1296        -f alsa -i hw:0 \
1297        -map 0:0 \
1298        -c:v libvpx-vp9 \
1299        -s 640x360 -keyint_min 30 -g 30 \
1300        -f webm_chunk \
1301        -header webm_live_video_360.hdr \
1302        -chunk_start_index 1 \
1303        webm_live_video_360_%d.chk \
1304        -map 1:0 \
1305        -c:a libvorbis \
1306        -b:a 128k \
1307        -f webm_chunk \
1308        -header webm_live_audio_128.hdr \
1309        -chunk_start_index 1 \
1310        -audio_chunk_duration 1000 \
1311        webm_live_audio_128_%d.chk
1312 @end example
1313
1314 @c man end MUXERS