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