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