avformat/hlsenc: added segment file deletion
[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 1. Must
385 be a non-negative number.
386
387 @item update
388 If set to 1, the filename will always be interpreted as just a
389 filename, not a pattern, and the corresponding file will be continuously
390 overwritten with new images. Default value is 0.
391
392 @item strftime
393 If set to 1, expand the filename with date and time information from
394 @code{strftime()}. Default value is 0.
395 @end table
396
397 The image muxer supports the .Y.U.V image file format. This format is
398 special in that that each image frame consists of three files, for
399 each of the YUV420P components. To read or write this image file format,
400 specify the name of the '.Y' file. The muxer will automatically open the
401 '.U' and '.V' files as required.
402
403 @section matroska
404
405 Matroska container muxer.
406
407 This muxer implements the matroska and webm container specs.
408
409 @subsection Metadata
410
411 The recognized metadata settings in this muxer are:
412
413 @table @option
414 @item title
415 Set title name provided to a single track.
416
417 @item language
418 Specify the language of the track in the Matroska languages form.
419
420 The language can be either the 3 letters bibliographic ISO-639-2 (ISO
421 639-2/B) form (like "fre" for French), or a language code mixed with a
422 country code for specialities in languages (like "fre-ca" for Canadian
423 French).
424
425 @item stereo_mode
426 Set stereo 3D video layout of two views in a single video track.
427
428 The following values are recognized:
429 @table @samp
430 @item mono
431 video is not stereo
432 @item left_right
433 Both views are arranged side by side, Left-eye view is on the left
434 @item bottom_top
435 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
436 @item top_bottom
437 Both views are arranged in top-bottom orientation, Left-eye view is on top
438 @item checkerboard_rl
439 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
440 @item checkerboard_lr
441 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
442 @item row_interleaved_rl
443 Each view is constituted by a row based interleaving, Right-eye view is first row
444 @item row_interleaved_lr
445 Each view is constituted by a row based interleaving, Left-eye view is first row
446 @item col_interleaved_rl
447 Both views are arranged in a column based interleaving manner, Right-eye view is first column
448 @item col_interleaved_lr
449 Both views are arranged in a column based interleaving manner, Left-eye view is first column
450 @item anaglyph_cyan_red
451 All frames are in anaglyph format viewable through red-cyan filters
452 @item right_left
453 Both views are arranged side by side, Right-eye view is on the left
454 @item anaglyph_green_magenta
455 All frames are in anaglyph format viewable through green-magenta filters
456 @item block_lr
457 Both eyes laced in one Block, Left-eye view is first
458 @item block_rl
459 Both eyes laced in one Block, Right-eye view is first
460 @end table
461 @end table
462
463 For example a 3D WebM clip can be created using the following command line:
464 @example
465 ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
466 @end example
467
468 @subsection Options
469
470 This muxer supports the following options:
471
472 @table @option
473 @item reserve_index_space
474 By default, this muxer writes the index for seeking (called cues in Matroska
475 terms) at the end of the file, because it cannot know in advance how much space
476 to leave for the index at the beginning of the file. However for some use cases
477 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
478 index at the beginning of the file.
479
480 If this option is set to a non-zero value, the muxer will reserve a given amount
481 of space in the file header and then try to write the cues there when the muxing
482 finishes. If the available space does not suffice, muxing will fail. A safe size
483 for most use cases should be about 50kB per hour of video.
484
485 Note that cues are only written if the output is seekable and this option will
486 have no effect if it is not.
487 @end table
488
489 @anchor{md5}
490 @section md5
491
492 MD5 testing format.
493
494 This muxer computes and prints the MD5 hash of all the input audio
495 and video frames. By default audio frames are converted to signed
496 16-bit raw audio and video frames to raw video before computing the
497 hash.
498
499 The output of the muxer consists of a single line of the form:
500 MD5=@var{MD5}, where @var{MD5} is a hexadecimal number representing
501 the computed MD5 hash.
502
503 For example to compute the MD5 hash of the input converted to raw
504 audio and video, and store it in the file @file{out.md5}:
505 @example
506 ffmpeg -i INPUT -f md5 out.md5
507 @end example
508
509 You can print the MD5 to stdout with the command:
510 @example
511 ffmpeg -i INPUT -f md5 -
512 @end example
513
514 See also the @ref{framemd5} muxer.
515
516 @section mov, mp4, ismv
517
518 MOV/MP4/ISMV (Smooth Streaming) muxer.
519
520 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
521 file has all the metadata about all packets stored in one location
522 (written at the end of the file, it can be moved to the start for
523 better playback by adding @var{faststart} to the @var{movflags}, or
524 using the @command{qt-faststart} tool). A fragmented
525 file consists of a number of fragments, where packets and metadata
526 about these packets are stored together. Writing a fragmented
527 file has the advantage that the file is decodable even if the
528 writing is interrupted (while a normal MOV/MP4 is undecodable if
529 it is not properly finished), and it requires less memory when writing
530 very long files (since writing normal MOV/MP4 files stores info about
531 every single packet in memory until the file is closed). The downside
532 is that it is less compatible with other applications.
533
534 @subsection Options
535
536 Fragmentation is enabled by setting one of the AVOptions that define
537 how to cut the file into fragments:
538
539 @table @option
540 @item -moov_size @var{bytes}
541 Reserves space for the moov atom at the beginning of the file instead of placing the
542 moov atom at the end. If the space reserved is insufficient, muxing will fail.
543 @item -movflags frag_keyframe
544 Start a new fragment at each video keyframe.
545 @item -frag_duration @var{duration}
546 Create fragments that are @var{duration} microseconds long.
547 @item -frag_size @var{size}
548 Create fragments that contain up to @var{size} bytes of payload data.
549 @item -movflags frag_custom
550 Allow the caller to manually choose when to cut fragments, by
551 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
552 the packets written so far. (This is only useful with other
553 applications integrating libavformat, not from @command{ffmpeg}.)
554 @item -min_frag_duration @var{duration}
555 Don't create fragments that are shorter than @var{duration} microseconds long.
556 @end table
557
558 If more than one condition is specified, fragments are cut when
559 one of the specified conditions is fulfilled. The exception to this is
560 @code{-min_frag_duration}, which has to be fulfilled for any of the other
561 conditions to apply.
562
563 Additionally, the way the output file is written can be adjusted
564 through a few other options:
565
566 @table @option
567 @item -movflags empty_moov
568 Write an initial moov atom directly at the start of the file, without
569 describing any samples in it. Generally, an mdat/moov pair is written
570 at the start of the file, as a normal MOV/MP4 file, containing only
571 a short portion of the file. With this option set, there is no initial
572 mdat atom, and the moov atom only describes the tracks but has
573 a zero duration.
574
575 This option is implicitly set when writing ismv (Smooth Streaming) files.
576 @item -movflags separate_moof
577 Write a separate moof (movie fragment) atom for each track. Normally,
578 packets for all tracks are written in a moof atom (which is slightly
579 more efficient), but with this option set, the muxer writes one moof/mdat
580 pair for each track, making it easier to separate tracks.
581
582 This option is implicitly set when writing ismv (Smooth Streaming) files.
583 @item -movflags faststart
584 Run a second pass moving the index (moov atom) to the beginning of the file.
585 This operation can take a while, and will not work in various situations such
586 as fragmented output, thus it is not enabled by default.
587 @item -movflags rtphint
588 Add RTP hinting tracks to the output file.
589 @item -movflags disable_chpl
590 Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
591 and a QuickTime chapter track are written to the file. With this option
592 set, only the QuickTime chapter track will be written. Nero chapters can
593 cause failures when the file is reprocessed with certain tagging programs, like
594 mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well.
595 @item -movflags omit_tfhd_offset
596 Do not write any absolute base_data_offset in tfhd atoms. This avoids
597 tying fragments to absolute byte positions in the file/streams.
598 @item -movflags default_base_moof
599 Similarly to the omit_tfhd_offset, this flag avoids writing the
600 absolute base_data_offset field in tfhd atoms, but does so by using
601 the new default-base-is-moof flag instead. This flag is new from
602 14496-12:2012. This may make the fragments easier to parse in certain
603 circumstances (avoiding basing track fragment location calculations
604 on the implicit end of the previous track fragment).
605 @end table
606
607 @subsection Example
608
609 Smooth Streaming content can be pushed in real time to a publishing
610 point on IIS with this muxer. Example:
611 @example
612 ffmpeg -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
613 @end example
614
615 @section mp3
616
617 The MP3 muxer writes a raw MP3 stream with the following optional features:
618 @itemize @bullet
619 @item
620 An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
621 2.4 are supported, the @code{id3v2_version} private option controls which one is
622 used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
623 completely.
624
625 The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
626 The pictures are supplied to the muxer in form of a video stream with a single
627 packet. There can be any number of those streams, each will correspond to a
628 single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
629 to APIC @var{description} and @var{picture type} respectively. See
630 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
631
632 Note that the APIC frames must be written at the beginning, so the muxer will
633 buffer the audio frames until it gets all the pictures. It is therefore advised
634 to provide the pictures as soon as possible to avoid excessive buffering.
635
636 @item
637 A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
638 default, but will be written only if the output is seekable. The
639 @code{write_xing} private option can be used to disable it.  The frame contains
640 various information that may be useful to the decoder, like the audio duration
641 or encoder delay.
642
643 @item
644 A legacy ID3v1 tag at the end of the file (disabled by default). It may be
645 enabled with the @code{write_id3v1} private option, but as its capabilities are
646 very limited, its usage is not recommended.
647 @end itemize
648
649 Examples:
650
651 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
652 @example
653 ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
654 @end example
655
656 To attach a picture to an mp3 file select both the audio and the picture stream
657 with @code{map}:
658 @example
659 ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
660 -metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
661 @end example
662
663 Write a "clean" MP3 without any extra features:
664 @example
665 ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
666 @end example
667
668 @section mpegts
669
670 MPEG transport stream muxer.
671
672 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
673
674 The recognized metadata settings in mpegts muxer are @code{service_provider}
675 and @code{service_name}. If they are not set the default for
676 @code{service_provider} is "FFmpeg" and the default for
677 @code{service_name} is "Service01".
678
679 @subsection Options
680
681 The muxer options are:
682
683 @table @option
684 @item -mpegts_original_network_id @var{number}
685 Set the original_network_id (default 0x0001). This is unique identifier
686 of a network in DVB. Its main use is in the unique identification of a
687 service through the path Original_Network_ID, Transport_Stream_ID.
688 @item -mpegts_transport_stream_id @var{number}
689 Set the transport_stream_id (default 0x0001). This identifies a
690 transponder in DVB.
691 @item -mpegts_service_id @var{number}
692 Set the service_id (default 0x0001) also known as program in DVB.
693 @item -mpegts_pmt_start_pid @var{number}
694 Set the first PID for PMT (default 0x1000, max 0x1f00).
695 @item -mpegts_start_pid @var{number}
696 Set the first PID for data packets (default 0x0100, max 0x0f00).
697 @item -mpegts_m2ts_mode @var{number}
698 Enable m2ts mode if set to 1. Default value is -1 which disables m2ts mode.
699 @item -muxrate @var{number}
700 Set a constant muxrate (default VBR).
701 @item -pcr_period @var{numer}
702 Override the default PCR retransmission time (default 20ms), ignored
703 if variable muxrate is selected.
704 @item -pes_payload_size @var{number}
705 Set minimum PES packet payload in bytes.
706 @item -mpegts_flags @var{flags}
707 Set flags (see below).
708 @item -mpegts_copyts @var{number}
709 Preserve original timestamps, if value is set to 1. Default value is -1, which
710 results in shifting timestamps so that they start from 0.
711 @item -tables_version @var{number}
712 Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively).
713 This option allows updating stream structure so that standard consumer may
714 detect the change. To do so, reopen output AVFormatContext (in case of API
715 usage) or restart ffmpeg instance, cyclically changing tables_version value:
716 @example
717 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
718 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
719 ...
720 ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
721 ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
722 ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
723 ...
724 @end example
725 @end table
726
727 Option mpegts_flags may take a set of such flags:
728
729 @table @option
730 @item resend_headers
731 Reemit PAT/PMT before writing the next packet.
732 @item latm
733 Use LATM packetization for AAC.
734 @end table
735
736 @subsection Example
737
738 @example
739 ffmpeg -i file.mpg -c copy \
740      -mpegts_original_network_id 0x1122 \
741      -mpegts_transport_stream_id 0x3344 \
742      -mpegts_service_id 0x5566 \
743      -mpegts_pmt_start_pid 0x1500 \
744      -mpegts_start_pid 0x150 \
745      -metadata service_provider="Some provider" \
746      -metadata service_name="Some Channel" \
747      -y out.ts
748 @end example
749
750 @section null
751
752 Null muxer.
753
754 This muxer does not generate any output file, it is mainly useful for
755 testing or benchmarking purposes.
756
757 For example to benchmark decoding with @command{ffmpeg} you can use the
758 command:
759 @example
760 ffmpeg -benchmark -i INPUT -f null out.null
761 @end example
762
763 Note that the above command does not read or write the @file{out.null}
764 file, but specifying the output file is required by the @command{ffmpeg}
765 syntax.
766
767 Alternatively you can write the command as:
768 @example
769 ffmpeg -benchmark -i INPUT -f null -
770 @end example
771
772 @section nut
773
774 @table @option
775 @item -syncpoints @var{flags}
776 Change the syncpoint usage in nut:
777 @table @option
778 @item @var{default} use the normal low-overhead seeking aids.
779 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
780     Use of this option is not recommended, as the resulting files are very damage
781     sensitive and seeking is not possible. Also in general the overhead from
782     syncpoints is negligible. Note, -@code{write_index} 0 can be used to disable
783     all growing data tables, allowing to mux endless streams with limited memory
784     and wihout these disadvantages.
785 @item @var{timestamped} extend the syncpoint with a wallclock field.
786 @end table
787 The @var{none} and @var{timestamped} flags are experimental.
788 @item -write_index @var{bool}
789 Write index at the end, the default is to write an index.
790 @end table
791
792 @example
793 ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
794 @end example
795
796 @section ogg
797
798 Ogg container muxer.
799
800 @table @option
801 @item -page_duration @var{duration}
802 Preferred page duration, in microseconds. The muxer will attempt to create
803 pages that are approximately @var{duration} microseconds long. This allows the
804 user to compromise between seek granularity and container overhead. The default
805 is 1 second. A value of 0 will fill all segments, making pages as large as
806 possible. A value of 1 will effectively use 1 packet-per-page in most
807 situations, giving a small seek granularity at the cost of additional container
808 overhead.
809 @end table
810
811 @anchor{segment}
812 @section segment, stream_segment, ssegment
813
814 Basic stream segmenter.
815
816 This muxer outputs streams to a number of separate files of nearly
817 fixed duration. Output filename pattern can be set in a fashion similar to
818 @ref{image2}.
819
820 @code{stream_segment} is a variant of the muxer used to write to
821 streaming output formats, i.e. which do not require global headers,
822 and is recommended for outputting e.g. to MPEG transport stream segments.
823 @code{ssegment} is a shorter alias for @code{stream_segment}.
824
825 Every segment starts with a keyframe of the selected reference stream,
826 which is set through the @option{reference_stream} option.
827
828 Note that if you want accurate splitting for a video file, you need to
829 make the input key frames correspond to the exact splitting times
830 expected by the segmenter, or the segment muxer will start the new
831 segment with the key frame found next after the specified start
832 time.
833
834 The segment muxer works best with a single constant frame rate video.
835
836 Optionally it can generate a list of the created segments, by setting
837 the option @var{segment_list}. The list type is specified by the
838 @var{segment_list_type} option. The entry filenames in the segment
839 list are set by default to the basename of the corresponding segment
840 files.
841
842 See also the @ref{hls} muxer, which provides a more specific
843 implementation for HLS segmentation.
844
845 @subsection Options
846
847 The segment muxer supports the following options:
848
849 @table @option
850 @item reference_stream @var{specifier}
851 Set the reference stream, as specified by the string @var{specifier}.
852 If @var{specifier} is set to @code{auto}, the reference is chosen
853 automatically. Otherwise it must be a stream specifier (see the ``Stream
854 specifiers'' chapter in the ffmpeg manual) which specifies the
855 reference stream. The default value is @code{auto}.
856
857 @item segment_format @var{format}
858 Override the inner container format, by default it is guessed by the filename
859 extension.
860
861 @item segment_format_options @var{options_list}
862 Set output format options using a :-separated list of key=value
863 parameters. Values containing the @code{:} special character must be
864 escaped.
865
866 @item segment_list @var{name}
867 Generate also a listfile named @var{name}. If not specified no
868 listfile is generated.
869
870 @item segment_list_flags @var{flags}
871 Set flags affecting the segment list generation.
872
873 It currently supports the following flags:
874 @table @samp
875 @item cache
876 Allow caching (only affects M3U8 list files).
877
878 @item live
879 Allow live-friendly file generation.
880 @end table
881
882 @item segment_list_type @var{type}
883 Select the listing format.
884 @table @option
885 @item @var{flat} use a simple flat list of entries.
886 @item @var{hls} use a m3u8-like structure.
887 @end table
888
889 @item segment_list_size @var{size}
890 Update the list file so that it contains at most @var{size}
891 segments. If 0 the list file will contain all the segments. Default
892 value is 0.
893
894 @item segment_list_entry_prefix @var{prefix}
895 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
896 By default no prefix is applied.
897
898 The following values are recognized:
899 @table @samp
900 @item flat
901 Generate a flat list for the created segments, one segment per line.
902
903 @item csv, ext
904 Generate a list for the created segments, one segment per line,
905 each line matching the format (comma-separated values):
906 @example
907 @var{segment_filename},@var{segment_start_time},@var{segment_end_time}
908 @end example
909
910 @var{segment_filename} is the name of the output file generated by the
911 muxer according to the provided pattern. CSV escaping (according to
912 RFC4180) is applied if required.
913
914 @var{segment_start_time} and @var{segment_end_time} specify
915 the segment start and end time expressed in seconds.
916
917 A list file with the suffix @code{".csv"} or @code{".ext"} will
918 auto-select this format.
919
920 @samp{ext} is deprecated in favor or @samp{csv}.
921
922 @item ffconcat
923 Generate an ffconcat file for the created segments. The resulting file
924 can be read using the FFmpeg @ref{concat} demuxer.
925
926 A list file with the suffix @code{".ffcat"} or @code{".ffconcat"} will
927 auto-select this format.
928
929 @item m3u8
930 Generate an extended M3U8 file, version 3, compliant with
931 @url{http://tools.ietf.org/id/draft-pantos-http-live-streaming}.
932
933 A list file with the suffix @code{".m3u8"} will auto-select this format.
934 @end table
935
936 If not specified the type is guessed from the list file name suffix.
937
938 @item segment_time @var{time}
939 Set segment duration to @var{time}, the value must be a duration
940 specification. Default value is "2". See also the
941 @option{segment_times} option.
942
943 Note that splitting may not be accurate, unless you force the
944 reference stream key-frames at the given time. See the introductory
945 notice and the examples below.
946
947 @item segment_atclocktime @var{1|0}
948 If set to "1" split at regular clock time intervals starting from 00:00
949 o'clock. The @var{time} value specified in @option{segment_time} is
950 used for setting the length of the splitting interval.
951
952 For example with @option{segment_time} set to "900" this makes it possible
953 to create files at 12:00 o'clock, 12:15, 12:30, etc.
954
955 Default value is "0".
956
957 @item segment_time_delta @var{delta}
958 Specify the accuracy time when selecting the start time for a
959 segment, expressed as a duration specification. Default value is "0".
960
961 When delta is specified a key-frame will start a new segment if its
962 PTS satisfies the relation:
963 @example
964 PTS >= start_time - time_delta
965 @end example
966
967 This option is useful when splitting video content, which is always
968 split at GOP boundaries, in case a key frame is found just before the
969 specified split time.
970
971 In particular may be used in combination with the @file{ffmpeg} option
972 @var{force_key_frames}. The key frame times specified by
973 @var{force_key_frames} may not be set accurately because of rounding
974 issues, with the consequence that a key frame time may result set just
975 before the specified time. For constant frame rate videos a value of
976 1/(2*@var{frame_rate}) should address the worst case mismatch between
977 the specified time and the time set by @var{force_key_frames}.
978
979 @item segment_times @var{times}
980 Specify a list of split points. @var{times} contains a list of comma
981 separated duration specifications, in increasing order. See also
982 the @option{segment_time} option.
983
984 @item segment_frames @var{frames}
985 Specify a list of split video frame numbers. @var{frames} contains a
986 list of comma separated integer numbers, in increasing order.
987
988 This option specifies to start a new segment whenever a reference
989 stream key frame is found and the sequential number (starting from 0)
990 of the frame is greater or equal to the next value in the list.
991
992 @item segment_wrap @var{limit}
993 Wrap around segment index once it reaches @var{limit}.
994
995 @item segment_start_number @var{number}
996 Set the sequence number of the first segment. Defaults to @code{0}.
997
998 @item reset_timestamps @var{1|0}
999 Reset timestamps at the begin of each segment, so that each segment
1000 will start with near-zero timestamps. It is meant to ease the playback
1001 of the generated segments. May not work with some combinations of
1002 muxers/codecs. It is set to @code{0} by default.
1003
1004 @item initial_offset @var{offset}
1005 Specify timestamp offset to apply to the output packet timestamps. The
1006 argument must be a time duration specification, and defaults to 0.
1007 @end table
1008
1009 @subsection Examples
1010
1011 @itemize
1012 @item
1013 Remux the content of file @file{in.mkv} to a list of segments
1014 @file{out-000.nut}, @file{out-001.nut}, etc., and write the list of
1015 generated segments to @file{out.list}:
1016 @example
1017 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.list out%03d.nut
1018 @end example
1019
1020 @item
1021 Segment input and set output format options for the output segments:
1022 @example
1023 ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
1024 @end example
1025
1026 @item
1027 Segment the input file according to the split points specified by the
1028 @var{segment_times} option:
1029 @example
1030 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
1031 @end example
1032
1033 @item
1034 Use the @command{ffmpeg} @option{force_key_frames}
1035 option to force key frames in the input at the specified location, together
1036 with the segment option @option{segment_time_delta} to account for
1037 possible roundings operated when setting key frame times.
1038 @example
1039 ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
1040 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
1041 @end example
1042 In order to force key frames on the input file, transcoding is
1043 required.
1044
1045 @item
1046 Segment the input file by splitting the input file according to the
1047 frame numbers sequence specified with the @option{segment_frames} option:
1048 @example
1049 ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
1050 @end example
1051
1052 @item
1053 Convert the @file{in.mkv} to TS segments using the @code{libx264}
1054 and @code{libfaac} encoders:
1055 @example
1056 ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a libfaac -f ssegment -segment_list out.list out%03d.ts
1057 @end example
1058
1059 @item
1060 Segment the input file, and create an M3U8 live playlist (can be used
1061 as live HLS source):
1062 @example
1063 ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
1064 -segment_list_flags +live -segment_time 10 out%03d.mkv
1065 @end example
1066 @end itemize
1067
1068 @section smoothstreaming
1069
1070 Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server.
1071
1072 @table @option
1073 @item window_size
1074 Specify the number of fragments kept in the manifest. Default 0 (keep all).
1075
1076 @item extra_window_size
1077 Specify the number of fragments kept outside of the manifest before removing from disk. Default 5.
1078
1079 @item lookahead_count
1080 Specify the number of lookahead fragments. Default 2.
1081
1082 @item min_frag_duration
1083 Specify the minimum fragment duration (in microseconds). Default 5000000.
1084
1085 @item remove_at_exit
1086 Specify whether to remove all fragments when finished. Default 0 (do not remove).
1087
1088 @end table
1089
1090 @section tee
1091
1092 The tee muxer can be used to write the same data to several files or any
1093 other kind of muxer. It can be used, for example, to both stream a video to
1094 the network and save it to disk at the same time.
1095
1096 It is different from specifying several outputs to the @command{ffmpeg}
1097 command-line tool because the audio and video data will be encoded only once
1098 with the tee muxer; encoding can be a very expensive process. It is not
1099 useful when using the libavformat API directly because it is then possible
1100 to feed the same packets to several muxers directly.
1101
1102 The slave outputs are specified in the file name given to the muxer,
1103 separated by '|'. If any of the slave name contains the '|' separator,
1104 leading or trailing spaces or any special character, it must be
1105 escaped (see @ref{quoting_and_escaping,,the "Quoting and escaping"
1106 section in the ffmpeg-utils(1) manual,ffmpeg-utils}).
1107
1108 Muxer options can be specified for each slave by prepending them as a list of
1109 @var{key}=@var{value} pairs separated by ':', between square brackets. If
1110 the options values contain a special character or the ':' separator, they
1111 must be escaped; note that this is a second level escaping.
1112
1113 The following special options are also recognized:
1114 @table @option
1115 @item f
1116 Specify the format name. Useful if it cannot be guessed from the
1117 output name suffix.
1118
1119 @item bsfs[/@var{spec}]
1120 Specify a list of bitstream filters to apply to the specified
1121 output.
1122
1123 It is possible to specify to which streams a given bitstream filter
1124 applies, by appending a stream specifier to the option separated by
1125 @code{/}. @var{spec} must be a stream specifier (see @ref{Format
1126 stream specifiers}).  If the stream specifier is not specified, the
1127 bitstream filters will be applied to all streams in the output.
1128
1129 Several bitstream filters can be specified, separated by ",".
1130
1131 @item select
1132 Select the streams that should be mapped to the slave output,
1133 specified by a stream specifier. If not specified, this defaults to
1134 all the input streams.
1135 @end table
1136
1137 @subsection Examples
1138
1139 @itemize
1140 @item
1141 Encode something and both archive it in a WebM file and stream it
1142 as MPEG-TS over UDP (the streams need to be explicitly mapped):
1143 @example
1144 ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
1145   "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
1146 @end example
1147
1148 @item
1149 Use @command{ffmpeg} to encode the input, and send the output
1150 to three different destinations. The @code{dump_extra} bitstream
1151 filter is used to add extradata information to all the output video
1152 keyframes packets, as requested by the MPEG-TS format. The select
1153 option is applied to @file{out.aac} in order to make it contain only
1154 audio packets.
1155 @example
1156 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1157        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
1158 @end example
1159
1160 @item
1161 As below, but select only stream @code{a:1} for the audio output. Note
1162 that a second level escaping must be performed, as ":" is a special
1163 character used to separate options.
1164 @example
1165 ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac -strict experimental
1166        -f tee "[bsfs/v=dump_extra]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
1167 @end example
1168 @end itemize
1169
1170 Note: some codecs may need different options depending on the output format;
1171 the auto-detection of this can not work with the tee muxer. The main example
1172 is the @option{global_header} flag.
1173
1174 @section webm_dash_manifest
1175
1176 WebM DASH Manifest muxer.
1177
1178 This muxer implements the WebM DASH Manifest specification to generate the DASH manifest XML.
1179
1180 @subsection Options
1181
1182 This muxer supports the following options:
1183
1184 @table @option
1185 @item adaptation_sets
1186 This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the
1187 unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding
1188 audio and video streams. Any number of adaptation sets can be added using this option.
1189 @end table
1190
1191 @subsection Example
1192 @example
1193 ffmpeg -f webm_dash_manifest -i video1.webm \
1194        -f webm_dash_manifest -i video2.webm \
1195        -f webm_dash_manifest -i audio1.webm \
1196        -f webm_dash_manifest -i audio2.webm \
1197        -map 0 -map 1 -map 2 -map 3 \
1198        -c copy \
1199        -f webm_dash_manifest \
1200        -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
1201        manifest.xml
1202 @end example
1203
1204 @c man end MUXERS