doc: Fix some obsolete references to av* tools as ff* tools
[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 @end table
118
119 @anchor{image2}
120 @section image2
121
122 Image file muxer.
123
124 The image file muxer writes video frames to image files.
125
126 The output filenames are specified by a pattern, which can be used to
127 produce sequentially numbered series of files.
128 The pattern may contain the string "%d" or "%0@var{N}d", this string
129 specifies the position of the characters representing a numbering in
130 the filenames. If the form "%0@var{N}d" is used, the string
131 representing the number in each filename is 0-padded to @var{N}
132 digits. The literal character '%' can be specified in the pattern with
133 the string "%%".
134
135 If the pattern contains "%d" or "%0@var{N}d", the first filename of
136 the file list specified will contain the number 1, all the following
137 numbers will be sequential.
138
139 The pattern may contain a suffix which is used to automatically
140 determine the format of the image files to write.
141
142 For example the pattern "img-%03d.bmp" will specify a sequence of
143 filenames of the form @file{img-001.bmp}, @file{img-002.bmp}, ...,
144 @file{img-010.bmp}, etc.
145 The pattern "img%%-%d.jpg" will specify a sequence of filenames of the
146 form @file{img%-1.jpg}, @file{img%-2.jpg}, ..., @file{img%-10.jpg},
147 etc.
148
149 The following example shows how to use @command{avconv} for creating a
150 sequence of files @file{img-001.jpeg}, @file{img-002.jpeg}, ...,
151 taking one image every second from the input video:
152 @example
153 avconv -i in.avi -vsync 1 -r 1 -f image2 'img-%03d.jpeg'
154 @end example
155
156 Note that with @command{avconv}, if the format is not specified with the
157 @code{-f} option and the output filename specifies an image file
158 format, the image2 muxer is automatically selected, so the previous
159 command can be written as:
160 @example
161 avconv -i in.avi -vsync 1 -r 1 'img-%03d.jpeg'
162 @end example
163
164 Note also that the pattern must not necessarily contain "%d" or
165 "%0@var{N}d", for example to create a single image file
166 @file{img.jpeg} from the input video you can employ the command:
167 @example
168 avconv -i in.avi -f image2 -frames:v 1 img.jpeg
169 @end example
170
171 @table @option
172 @item -start_number @var{number}
173 Start the sequence from @var{number}.
174 @end table
175
176 @section MOV/MP4/ISMV
177
178 The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4
179 file has all the metadata about all packets stored in one location
180 (written at the end of the file, it can be moved to the start for
181 better playback using the @command{qt-faststart} tool). A fragmented
182 file consists of a number of fragments, where packets and metadata
183 about these packets are stored together. Writing a fragmented
184 file has the advantage that the file is decodable even if the
185 writing is interrupted (while a normal MOV/MP4 is undecodable if
186 it is not properly finished), and it requires less memory when writing
187 very long files (since writing normal MOV/MP4 files stores info about
188 every single packet in memory until the file is closed). The downside
189 is that it is less compatible with other applications.
190
191 Fragmentation is enabled by setting one of the AVOptions that define
192 how to cut the file into fragments:
193
194 @table @option
195 @item -movflags frag_keyframe
196 Start a new fragment at each video keyframe.
197 @item -frag_duration @var{duration}
198 Create fragments that are @var{duration} microseconds long.
199 @item -frag_size @var{size}
200 Create fragments that contain up to @var{size} bytes of payload data.
201 @item -movflags frag_custom
202 Allow the caller to manually choose when to cut fragments, by
203 calling @code{av_write_frame(ctx, NULL)} to write a fragment with
204 the packets written so far. (This is only useful with other
205 applications integrating libavformat, not from @command{avconv}.)
206 @item -min_frag_duration @var{duration}
207 Don't create fragments that are shorter than @var{duration} microseconds long.
208 @end table
209
210 If more than one condition is specified, fragments are cut when
211 one of the specified conditions is fulfilled. The exception to this is
212 @code{-min_frag_duration}, which has to be fulfilled for any of the other
213 conditions to apply.
214
215 Additionally, the way the output file is written can be adjusted
216 through a few other options:
217
218 @table @option
219 @item -movflags empty_moov
220 Write an initial moov atom directly at the start of the file, without
221 describing any samples in it. Generally, an mdat/moov pair is written
222 at the start of the file, as a normal MOV/MP4 file, containing only
223 a short portion of the file. With this option set, there is no initial
224 mdat atom, and the moov atom only describes the tracks but has
225 a zero duration.
226
227 Files written with this option set do not work in QuickTime.
228 This option is implicitly set when writing ismv (Smooth Streaming) files.
229 @item -movflags separate_moof
230 Write a separate moof (movie fragment) atom for each track. Normally,
231 packets for all tracks are written in a moof atom (which is slightly
232 more efficient), but with this option set, the muxer writes one moof/mdat
233 pair for each track, making it easier to separate tracks.
234
235 This option is implicitly set when writing ismv (Smooth Streaming) files.
236 @end table
237
238 Smooth Streaming content can be pushed in real time to a publishing
239 point on IIS with this muxer. Example:
240 @example
241 avconv -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
242 @end example
243
244 @section mpegts
245
246 MPEG transport stream muxer.
247
248 This muxer implements ISO 13818-1 and part of ETSI EN 300 468.
249
250 The muxer options are:
251
252 @table @option
253 @item -mpegts_original_network_id @var{number}
254 Set the original_network_id (default 0x0001). This is unique identifier
255 of a network in DVB. Its main use is in the unique identification of a
256 service through the path Original_Network_ID, Transport_Stream_ID.
257 @item -mpegts_transport_stream_id @var{number}
258 Set the transport_stream_id (default 0x0001). This identifies a
259 transponder in DVB.
260 @item -mpegts_service_id @var{number}
261 Set the service_id (default 0x0001) also known as program in DVB.
262 @item -mpegts_pmt_start_pid @var{number}
263 Set the first PID for PMT (default 0x1000, max 0x1f00).
264 @item -mpegts_start_pid @var{number}
265 Set the first PID for data packets (default 0x0100, max 0x0f00).
266 @end table
267
268 The recognized metadata settings in mpegts muxer are @code{service_provider}
269 and @code{service_name}. If they are not set the default for
270 @code{service_provider} is "Libav" and the default for
271 @code{service_name} is "Service01".
272
273 @example
274 avconv -i file.mpg -c copy \
275      -mpegts_original_network_id 0x1122 \
276      -mpegts_transport_stream_id 0x3344 \
277      -mpegts_service_id 0x5566 \
278      -mpegts_pmt_start_pid 0x1500 \
279      -mpegts_start_pid 0x150 \
280      -metadata service_provider="Some provider" \
281      -metadata service_name="Some Channel" \
282      -y out.ts
283 @end example
284
285 @section null
286
287 Null muxer.
288
289 This muxer does not generate any output file, it is mainly useful for
290 testing or benchmarking purposes.
291
292 For example to benchmark decoding with @command{avconv} you can use the
293 command:
294 @example
295 avconv -benchmark -i INPUT -f null out.null
296 @end example
297
298 Note that the above command does not read or write the @file{out.null}
299 file, but specifying the output file is required by the @command{avconv}
300 syntax.
301
302 Alternatively you can write the command as:
303 @example
304 avconv -benchmark -i INPUT -f null -
305 @end example
306
307 @section matroska
308
309 Matroska container muxer.
310
311 This muxer implements the matroska and webm container specs.
312
313 The recognized metadata settings in this muxer are:
314
315 @table @option
316
317 @item title=@var{title name}
318 Name provided to a single track
319 @end table
320
321 @table @option
322
323 @item language=@var{language name}
324 Specifies the language of the track in the Matroska languages form
325 @end table
326
327 @table @option
328
329 @item STEREO_MODE=@var{mode}
330 Stereo 3D video layout of two views in a single video track
331 @table @option
332 @item mono
333 video is not stereo
334 @item left_right
335 Both views are arranged side by side, Left-eye view is on the left
336 @item bottom_top
337 Both views are arranged in top-bottom orientation, Left-eye view is at bottom
338 @item top_bottom
339 Both views are arranged in top-bottom orientation, Left-eye view is on top
340 @item checkerboard_rl
341 Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first
342 @item checkerboard_lr
343 Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first
344 @item row_interleaved_rl
345 Each view is constituted by a row based interleaving, Right-eye view is first row
346 @item row_interleaved_lr
347 Each view is constituted by a row based interleaving, Left-eye view is first row
348 @item col_interleaved_rl
349 Both views are arranged in a column based interleaving manner, Right-eye view is first column
350 @item col_interleaved_lr
351 Both views are arranged in a column based interleaving manner, Left-eye view is first column
352 @item anaglyph_cyan_red
353 All frames are in anaglyph format viewable through red-cyan filters
354 @item right_left
355 Both views are arranged side by side, Right-eye view is on the left
356 @item anaglyph_green_magenta
357 All frames are in anaglyph format viewable through green-magenta filters
358 @item block_lr
359 Both eyes laced in one Block, Left-eye view is first
360 @item block_rl
361 Both eyes laced in one Block, Right-eye view is first
362 @end table
363 @end table
364
365 For example a 3D WebM clip can be created using the following command line:
366 @example
367 avconv -i sample_left_right_clip.mpg -an -c:v libvpx -metadata STEREO_MODE=left_right -y stereo_clip.webm
368 @end example
369
370 @section segment
371
372 Basic stream segmenter.
373
374 The segmenter muxer outputs streams to a number of separate files of nearly
375 fixed duration. Output filename pattern can be set in a fashion similar to
376 @ref{image2}.
377
378 Every segment starts with a video keyframe, if a video stream is present.
379 The segment muxer works best with a single constant frame rate video.
380
381 Optionally it can generate a flat list of the created segments, one segment
382 per line.
383
384 @table @option
385 @item segment_format @var{format}
386 Override the inner container format, by default it is guessed by the filename
387 extension.
388 @item segment_time @var{t}
389 Set segment duration to @var{t} seconds.
390 @item segment_list @var{name}
391 Generate also a listfile named @var{name}.
392 @item segment_list_size @var{size}
393 Overwrite the listfile once it reaches @var{size} entries.
394 @item segment_wrap @var{limit}
395 Wrap around segment index once it reaches @var{limit}.
396 @end table
397
398 @example
399 avconv -i in.mkv -c copy -map 0 -f segment -list out.list out%03d.nut
400 @end example
401
402 @section mp3
403
404 The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
405 optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
406 @code{id3v2_version} option controls which one is used. The legacy ID3v1 tag is
407 not written by default, but may be enabled with the @code{write_id3v1} option.
408
409 For seekable output the muxer also writes a Xing frame at the beginning, which
410 contains the number of frames in the file. It is useful for computing duration
411 of VBR files.
412
413 The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
414 are supplied to the muxer in form of a video stream with a single packet. There
415 can be any number of those streams, each will correspond to a single APIC frame.
416 The stream metadata tags @var{title} and @var{comment} map to APIC
417 @var{description} and @var{picture type} respectively. See
418 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
419
420 Note that the APIC frames must be written at the beginning, so the muxer will
421 buffer the audio frames until it gets all the pictures. It is therefore advised
422 to provide the pictures as soon as possible to avoid excessive buffering.
423
424 Examples:
425
426 Write an mp3 with an ID3v2.3 header and an ID3v1 footer:
427 @example
428 avconv -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
429 @end example
430
431 Attach a picture to an mp3:
432 @example
433 avconv -i input.mp3 -i cover.png -c copy -metadata:s:v title="Album cover"
434 -metadata:s:v comment="Cover (Front)" out.mp3
435 @end example
436
437 @section ogg
438
439 Ogg container muxer.
440
441 @table @option
442 @item -page_duration @var{duration}
443 Preferred page duration, in microseconds. The muxer will attempt to create
444 pages that are approximately @var{duration} microseconds long. This allows the
445 user to compromise between seek granularity and container overhead. The default
446 is 1 second. A value of 0 will fill all segments, making pages as large as
447 possible. A value of 1 will effectively use 1 packet-per-page in most
448 situations, giving a small seek granularity at the cost of additional container
449 overhead.
450 @end table
451
452 @c man end MUXERS