doc/APIchanges: fill in missing hashes and dates
[ffmpeg.git] / doc / muxers.texi
1 @chapter Muxers
2 @c man begin MUXERS
3
4 Muxers are configured elements in Libav which allow writing
5 multimedia streams to a particular type of file.
6
7 When you configure your Libav 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 av* tools will display the list of
17 enabled muxers.
18
19 A description of some of the currently available muxers follows.
20
21 @anchor{crc}
22 @section crc
23
24 CRC (Cyclic Redundancy Check) testing format.
25
26 This muxer computes and prints the Adler-32 CRC of all the input audio
27 and video frames. By default audio frames are converted to signed
28 16-bit raw audio and video frames to raw video before computing the
29 CRC.
30
31 The output of the muxer consists of a single line of the form:
32 CRC=0x@var{CRC}, where @var{CRC} is a hexadecimal number 0-padded to
33 8 digits containing the CRC for all the decoded input frames.
34
35 For example to compute the CRC of the input, and store it in the file
36 @file{out.crc}:
37 @example
38 avconv -i INPUT -f crc out.crc
39 @end example
40
41 You can print the CRC to stdout with the command:
42 @example
43 avconv -i INPUT -f crc -
44 @end example
45
46 You can select the output format of each frame with @command{avconv} by
47 specifying the audio and video codec and format. For example to
48 compute the CRC of the input audio converted to PCM unsigned 8-bit
49 and the input video converted to MPEG-2 video, use the command:
50 @example
51 avconv -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
52 @end example
53
54 See also the @ref{framecrc} muxer.
55
56 @anchor{framecrc}
57 @section framecrc
58
59 Per-frame CRC (Cyclic Redundancy Check) testing format.
60
61 This muxer computes and prints the Adler-32 CRC for each decoded audio
62 and video frame. By default audio frames are converted to signed
63 16-bit raw audio and video frames to raw video before computing the
64 CRC.
65
66 The output of the muxer consists of a line for each audio and video
67 frame of the form: @var{stream_index}, @var{frame_dts},
68 @var{frame_size}, 0x@var{CRC}, where @var{CRC} is a hexadecimal
69 number 0-padded to 8 digits containing the CRC of the decoded frame.
70
71 For example to compute the CRC of each decoded frame in the input, and
72 store it in the file @file{out.crc}:
73 @example
74 avconv -i INPUT -f framecrc out.crc
75 @end example
76
77 You can print the CRC of each decoded frame to stdout with the command:
78 @example
79 avconv -i INPUT -f framecrc -
80 @end example
81
82 You can select the output format of each frame with @command{avconv} by
83 specifying the audio and video codec and format. For example, to
84 compute the CRC of each decoded input audio frame converted to PCM
85 unsigned 8-bit and of each decoded input video frame converted to
86 MPEG-2 video, use the command:
87 @example
88 avconv -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
89 @end example
90
91 See also the @ref{crc} muxer.
92
93 @anchor{hls}
94 @section hls
95
96 Apple HTTP Live Streaming muxer that segments MPEG-TS according to
97 the HTTP Live Streaming specification.
98
99 It creates a playlist file and numbered segment files. The output
100 filename specifies the playlist filename; the segment filenames
101 receive the same basename as the playlist, a sequential number and
102 a .ts extension.
103
104 @example
105 avconv -i in.nut out.m3u8
106 @end example
107
108 @table @option
109 @item -hls_time @var{seconds}
110 Set the segment length in seconds.
111 @item -hls_list_size @var{size}
112 Set the maximum number of playlist entries.
113 @item -hls_wrap @var{wrap}
114 Set the number after which index wraps.
115 @item -start_number @var{number}
116 Start the sequence from @var{number}.
117 @item -hls_base_url @var{baseurl}
118 Append @var{baseurl} to every entry in the playlist.
119 Useful to generate playlists with absolute paths.
120 @end table
121
122 @anchor{image2}
123 @section image2
124
125 Image file muxer.
126
127 The image file muxer writes video frames to image files.
128
129 The output filenames are specified by a pattern, which can be used to
130 produce sequentially numbered series of files.
131 The pattern may contain the string "%d" or "%0@var{N}d", this string
132 specifies the position of the characters representing a numbering in
133 the filenames. If the form "%0@var{N}d" is used, the string
134 representing the number in each filename is 0-padded to @var{N}
135 digits. The literal character '%' can be specified in the pattern with
136 the string "%%".
137
138 If the pattern contains "%d" or "%0@var{N}d", the first filename of
139 the file list specified will contain the number 1, all the following
140 numbers will be sequential.
141
142 The pattern may contain a suffix which is used to automatically
143 determine the format of the image files to write.
144
145 For example the pattern "img-%03d.bmp" will specify a sequence of
146 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
147 @file{img-010.bmp}, etc.
148 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
149 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
150 etc.
151
152 The following example shows how to use @command{avconv} for creating a
153 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
154 taking one image every second from the input video:
155 @example
156 avconv -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
157 @end example
158
159 Note that with @command{avconv}, if the format is not specified with the
160 @code{-f} option and the output filename specifies an image file
161 format, the image2 muxer is automatically selected, so the previous
162 command can be written as:
163 @example
164 avconv -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
165 @end example
166
167 Note also that the pattern must not necessarily contain "%d" or
168 "%0@var{N}d", for example to create a single image file
169 @file{img.jpeg} from the input video you can employ the command:
170 @example
171 avconv -i in.avi -f image2 -frames:v 1 img.jpeg
172 @end example
173
174 @table @option
175 @item -start_number @var{number}
176 Start the sequence from @var{number}.
177
178 @item -update @var{number}
179 If @var{number} is nonzero, the filename will always be interpreted as just a
180 filename, not a pattern, and this file will be continuously overwritten with new
181 images.
182
183 @end table
184
185 @section matroska
186
187 Matroska container muxer.
188
189 This muxer implements the matroska and webm container specs.
190
191 The recognized metadata settings in this muxer are:
192
193 @table @option
194
195 @item title=@var{title name}
196 Name provided to a single track
197 @end table
198
199 @table @option
200
201 @item language=@var{language name}
202 Specifies the language of the track in the Matroska languages form
203 @end table
204
205 @table @option
206
207 @item STEREO_MODE=@var{mode}
208 Stereo 3D video layout of two views in a single video track
209 @table @option
210 @item mono
211 video is not stereo
212 @item left_right
213 Both views are arranged side by side, Left-eye view is on the left
214 @item bottom_top
215 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
216 @item top_bottom
217 Both views are arranged in top-bottom orientation, Left-eye view is on top
218 @item checkerboard_rl
219 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
220 @item checkerboard_lr
221 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
222 @item row_interleaved_rl
223 Each view is constituted by a row based interleaving, Right-eye view is first row
224 @item row_interleaved_lr
225 Each view is constituted by a row based interleaving, Left-eye view is first row
226 @item col_interleaved_rl
227 Both views are arranged in a column based interleaving manner, Right-eye view is first column
228 @item col_interleaved_lr
229 Both views are arranged in a column based interleaving manner, Left-eye view is first column
230 @item anaglyph_cyan_red
231 All frames are in anaglyph format viewable through red-cyan filters
232 @item right_left
233 Both views are arranged side by side, Right-eye view is on the left
234 @item anaglyph_green_magenta
235 All frames are in anaglyph format viewable through green-magenta filters
236 @item block_lr
237 Both eyes laced in one Block, Left-eye view is first
238 @item block_rl
239 Both eyes laced in one Block, Right-eye view is first
240 @end table
241 @end table
242
243 For example a 3D WebM clip can be created using the following command line:
244 @example
245 avconv -i sample_left_right_clip.mpg -an -c:v libvpx -metadata STEREO_MODE=left_right -y stereo_clip.webm
246 @end example
247
248 This muxer supports the following options:
249
250 @table @option
251
252 @item reserve_index_space
253 By default, this muxer writes the index for seeking (called cues in Matroska
254 terms) at the end of the file, because it cannot know in advance how much space
255 to leave for the index at the beginning of the file. However for some use cases
256 -- e.g.  streaming where seeking is possible but slow -- it is useful to put the
257 index at the beginning of the file.
258
259 If this option is set to a non-zero value, the muxer will reserve a given amount
260 of space in the file header and then try to write the cues there when the muxing
261 finishes. If the available space does not suffice, muxing will fail. A safe size
262 for most use cases should be about 50kB per hour of video.
263
264 Note that cues are only written if the output is seekable and this option will
265 have no effect if it is not.
266
267 @end table
268
269 @section mov, mp4, ismv
270
271 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
272 file has all the metadata about all packets stored in one location
273 (written at the end of the file, it can be moved to the start for
274 better playback using the @command{qt-faststart} tool). A fragmented
275 file consists of a number of fragments, where packets and metadata
276 about these packets are stored together. Writing a fragmented
277 file has the advantage that the file is decodable even if the
278 writing is interrupted (while a normal MOV/MP4 is undecodable if
279 it is not properly finished), and it requires less memory when writing
280 very long files (since writing normal MOV/MP4 files stores info about
281 every single packet in memory until the file is closed). The downside
282 is that it is less compatible with other applications.
283
284 Fragmentation is enabled by setting one of the AVOptions that define
285 how to cut the file into fragments:
286
287 @table @option
288 @item -movflags frag_keyframe
289 Start a new fragment at each video keyframe.
290 @item -frag_duration @var{duration}
291 Create fragments that are @var{duration} microseconds long.
292 @item -frag_size @var{size}
293 Create fragments that contain up to @var{size} bytes of payload data.
294 @item -movflags frag_custom
295 Allow the caller to manually choose when to cut fragments, by
296 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
297 the packets written so far. (This is only useful with other
298 applications integrating libavformat, not from @command{avconv}.)
299 @item -min_frag_duration @var{duration}
300 Don't create fragments that are shorter than @var{duration} microseconds long.
301 @end table
302
303 If more than one condition is specified, fragments are cut when
304 one of the specified conditions is fulfilled. The exception to this is
305 @code{-min_frag_duration}, which has to be fulfilled for any of the other
306 conditions to apply.
307
308 Additionally, the way the output file is written can be adjusted
309 through a few other options:
310
311 @table @option
312 @item -movflags empty_moov
313 Write an initial moov atom directly at the start of the file, without
314 describing any samples in it. Generally, an mdat/moov pair is written
315 at the start of the file, as a normal MOV/MP4 file, containing only
316 a short portion of the file. With this option set, there is no initial
317 mdat atom, and the moov atom only describes the tracks but has
318 a zero duration.
319
320 Files written with this option set do not work in QuickTime.
321 This option is implicitly set when writing ismv (Smooth Streaming) files.
322 @item -movflags separate_moof
323 Write a separate moof (movie fragment) atom for each track. Normally,
324 packets for all tracks are written in a moof atom (which is slightly
325 more efficient), but with this option set, the muxer writes one moof/mdat
326 pair for each track, making it easier to separate tracks.
327
328 This option is implicitly set when writing ismv (Smooth Streaming) files.
329 @item -movflags faststart
330 Run a second pass moving the index (moov atom) to the beginning of the file.
331 This operation can take a while, and will not work in various situations such
332 as fragmented output, thus it is not enabled by default.
333 @item -movflags disable_chpl
334 Disable Nero chapter markers (chpl atom).  Normally, both Nero chapters
335 and a QuickTime chapter track are written to the file. With this option
336 set, only the QuickTime chapter track will be written. Nero chapters can
337 cause failures when the file is reprocessed with certain tagging programs.
338 @end table
339
340 Smooth Streaming content can be pushed in real time to a publishing
341 point on IIS with this muxer. Example:
342 @example
343 avconv -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
344 @end example
345
346 @section mp3
347
348 The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
349 optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
350 @code{id3v2_version} option controls which one is used. Setting
351 @code{id3v2_version} to 0 will disable the ID3v2 header completely. The legacy
352 ID3v1 tag is not written by default, but may be enabled with the
353 @code{write_id3v1} option.
354
355 The muxer may also write a Xing frame at the beginning, which contains the
356 number of frames in the file. It is useful for computing duration of VBR files.
357 The Xing frame is written if the output stream is seekable and if the
358 @code{write_xing} option is set to 1 (the default).
359
360 The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
361 are supplied to the muxer in form of a video stream with a single packet. There
362 can be any number of those streams, each will correspond to a single APIC frame.
363 The stream metadata tags @var{title} and @var{comment} map to APIC
364 @var{description} and @var{picture type} respectively. See
365 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
366
367 Note that the APIC frames must be written at the beginning, so the muxer will
368 buffer the audio frames until it gets all the pictures. It is therefore advised
369 to provide the pictures as soon as possible to avoid excessive buffering.
370
371 Examples:
372
373 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
374 @example
375 avconv -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
376 @end example
377
378 Attach a picture to an mp3:
379 @example
380 avconv -i input.mp3 -i cover.png -c copy -metadata:s:v title="Album cover"
381 -metadata:s:v comment="Cover (Front)" out.mp3
382 @end example
383
384 Write a "clean" MP3 without any extra features:
385 @example
386 avconv -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
387 @end example
388
389 @section mpegts
390
391 MPEG transport stream muxer.
392
393 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
394
395 The muxer options are:
396
397 @table @option
398 @item -mpegts_original_network_id @var{number}
399 Set the original_network_id (default 0x0001). This is unique identifier
400 of a network in DVB. Its main use is in the unique identification of a
401 service through the path Original_Network_ID, Transport_Stream_ID.
402 @item -mpegts_transport_stream_id @var{number}
403 Set the transport_stream_id (default 0x0001). This identifies a
404 transponder in DVB.
405 @item -mpegts_service_id @var{number}
406 Set the service_id (default 0x0001) also known as program in DVB.
407 @item -mpegts_pmt_start_pid @var{number}
408 Set the first PID for PMT (default 0x1000, max 0x1f00).
409 @item -mpegts_start_pid @var{number}
410 Set the first PID for data packets (default 0x0100, max 0x0f00).
411 @item -muxrate @var{number}
412 Set a constant muxrate (default VBR).
413 @item -pcr_period @var{numer}
414 Override the default PCR retransmission time (default 20ms), ignored
415 if variable muxrate is selected.
416 @end table
417
418 The recognized metadata settings in mpegts muxer are @code{service_provider}
419 and @code{service_name}. If they are not set the default for
420 @code{service_provider} is "Libav" and the default for
421 @code{service_name} is "Service01".
422
423 @example
424 avconv -i file.mpg -c copy \
425      -mpegts_original_network_id 0x1122 \
426      -mpegts_transport_stream_id 0x3344 \
427      -mpegts_service_id 0x5566 \
428      -mpegts_pmt_start_pid 0x1500 \
429      -mpegts_start_pid 0x150 \
430      -metadata service_provider="Some provider" \
431      -metadata service_name="Some Channel" \
432      -y out.ts
433 @end example
434
435 @section null
436
437 Null muxer.
438
439 This muxer does not generate any output file, it is mainly useful for
440 testing or benchmarking purposes.
441
442 For example to benchmark decoding with @command{avconv} you can use the
443 command:
444 @example
445 avconv -benchmark -i INPUT -f null out.null
446 @end example
447
448 Note that the above command does not read or write the @file{out.null}
449 file, but specifying the output file is required by the @command{avconv}
450 syntax.
451
452 Alternatively you can write the command as:
453 @example
454 avconv -benchmark -i INPUT -f null -
455 @end example
456
457 @section nut
458
459 @table @option
460 @item -syncpoints @var{flags}
461 Change the syncpoint usage in nut:
462 @table @option
463 @item @var{default} use the normal low-overhead seeking aids.
464 @item @var{none} do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
465 @item @var{timestamped} extend the syncpoint with a wallclock field.
466 @end table
467 The @var{none} and @var{timestamped} flags are experimental.
468 @end table
469
470 @example
471 avconv -i INPUT -f_strict experimental -syncpoints none - | processor
472 @end example
473
474 @section ogg
475
476 Ogg container muxer.
477
478 @table @option
479 @item -page_duration @var{duration}
480 Preferred page duration, in microseconds. The muxer will attempt to create
481 pages that are approximately @var{duration} microseconds long. This allows the
482 user to compromise between seek granularity and container overhead. The default
483 is 1 second. A value of 0 will fill all segments, making pages as large as
484 possible. A value of 1 will effectively use 1 packet-per-page in most
485 situations, giving a small seek granularity at the cost of additional container
486 overhead.
487 @end table
488
489 @section segment
490
491 Basic stream segmenter.
492
493 The segmenter muxer outputs streams to a number of separate files of nearly
494 fixed duration. Output filename pattern can be set in a fashion similar to
495 @ref{image2}.
496
497 Every segment starts with a video keyframe, if a video stream is present.
498 The segment muxer works best with a single constant frame rate video.
499
500 Optionally it can generate a flat list of the created segments, one segment
501 per line.
502
503 @table @option
504 @item segment_format @var{format}
505 Override the inner container format, by default it is guessed by the filename
506 extension.
507 @item segment_time @var{t}
508 Set segment duration to @var{t} seconds.
509 @item segment_list @var{name}
510 Generate also a listfile named @var{name}.
511 @item segment_list_type @var{type}
512 Select the listing format.
513 @table @option
514 @item @var{flat} use a simple flat list of entries.
515 @item @var{hls} use a m3u8-like structure.
516 @end table
517 @item segment_list_size @var{size}
518 Overwrite the listfile once it reaches @var{size} entries.
519 @item segment_list_entry_prefix @var{prefix}
520 Prepend @var{prefix} to each entry. Useful to generate absolute paths.
521 @item segment_wrap @var{limit}
522 Wrap around segment index once it reaches @var{limit}.
523 @end table
524
525 @example
526 avconv -i in.mkv -c copy -map 0 -f segment -list out.list out%03d.nut
527 @end example
528
529 @c man end MUXERS