Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / doc / ffmpeg.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle ffmpeg Documentation
4 @titlepage
5 @center @titlefont{ffmpeg Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Synopsis
13
14 The generic syntax is:
15
16 @example
17 @c man begin SYNOPSIS
18 ffmpeg [global options] [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
19 @c man end
20 @end example
21
22 @chapter Description
23 @c man begin DESCRIPTION
24
25 ffmpeg is a very fast video and audio converter that can also grab from
26 a live audio/video source. It can also convert between arbitrary sample
27 rates and resize video on the fly with a high quality polyphase filter.
28
29 ffmpeg reads from an arbitrary number of input "files" (which can be regular
30 files, pipes, network streams, grabbing devices, etc.), specified by the
31 @code{-i} option, and writes to an arbitrary number of output "files", which are
32 specified by a plain output filename. Anything found on the command line which
33 cannot be interpreted as an option is considered to be an output filename.
34
35 Each input or output file can in principle contain any number of streams of
36 different types (video/audio/subtitle/attachment/data). Allowed number and/or
37 types of streams can be limited by the container format. Selecting, which
38 streams from which inputs go into output, is done either automatically or with
39 the @code{-map} option (see the Stream selection chapter).
40
41 To refer to input files in options, you must use their indices (0-based). E.g.
42 the first input file is @code{0}, the second is @code{1} etc. Similarly, streams
43 within a file are referred to by their indices. E.g. @code{2:3} refers to the
44 fourth stream in the third input file. See also the Stream specifiers chapter.
45
46 As a general rule, options are applied to the next specified
47 file. Therefore, order is important, and you can have the same
48 option on the command line multiple times. Each occurrence is
49 then applied to the next input or output file.
50 Exceptions from this rule are the global options (e.g. verbosity level),
51 which should be specified first.
52
53 Do not mix input and output files -- first specify all input files, then all
54 output files. Also do not mix options which belong to different files. All
55 options apply ONLY to the next input or output file and are reset between files.
56
57 @itemize
58 @item
59 To set the video bitrate of the output file to 64kbit/s:
60 @example
61 ffmpeg -i input.avi -b:v 64k output.avi
62 @end example
63
64 @item
65 To force the frame rate of the output file to 24 fps:
66 @example
67 ffmpeg -i input.avi -r 24 output.avi
68 @end example
69
70 @item
71 To force the frame rate of the input file (valid for raw formats only)
72 to 1 fps and the frame rate of the output file to 24 fps:
73 @example
74 ffmpeg -r 1 -i input.m2v -r 24 output.avi
75 @end example
76 @end itemize
77
78 The format option may be needed for raw input files.
79
80 @c man end DESCRIPTION
81
82 @chapter Stream selection
83 @c man begin STREAM SELECTION
84
85 By default ffmpeg includes only one stream of each type (video, audio, subtitle)
86 present in the input files and adds them to each output file.  It picks the
87 "best" of each based upon the following criteria; for video it is the stream
88 with the highest resolution, for audio the stream with the most channels, for
89 subtitle it's the first subtitle stream. In the case where several streams of
90 the same type rate equally, the lowest numbered stream is chosen.
91
92 You can disable some of those defaults by using @code{-vn/-an/-sn} options. For
93 full manual control, use the @code{-map} option, which disables the defaults just
94 described.
95
96 @c man end STREAM SELECTION
97
98 @chapter Options
99 @c man begin OPTIONS
100
101 @include avtools-common-opts.texi
102
103 @section Main options
104
105 @table @option
106
107 @item -f @var{fmt} (@emph{input/output})
108 Force input or output file format. The format is normally auto detected for input
109 files and guessed from file extension for output files, so this option is not
110 needed in most cases.
111
112 @item -i @var{filename} (@emph{input})
113 input file name
114
115 @item -y (@emph{global})
116 Overwrite output files without asking.
117
118 @item -n (@emph{global})
119 Do not overwrite output files but exit if file exists.
120
121 @item -c[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
122 @itemx -codec[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
123 Select an encoder (when used before an output file) or a decoder (when used
124 before an input file) for one or more streams. @var{codec} is the name of a
125 decoder/encoder or a special value @code{copy} (output only) to indicate that
126 the stream is not to be re-encoded.
127
128 For example
129 @example
130 ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
131 @end example
132 encodes all video streams with libx264 and copies all audio streams.
133
134 For each stream, the last matching @code{c} option is applied, so
135 @example
136 ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
137 @end example
138 will copy all the streams except the second video, which will be encoded with
139 libx264, and the 138th audio, which will be encoded with libvorbis.
140
141 @item -t @var{duration} (@emph{output})
142 Stop writing the output after its duration reaches @var{duration}.
143 @var{duration} may be a number in seconds, or in @code{hh:mm:ss[.xxx]} form.
144
145 @item -fs @var{limit_size} (@emph{output})
146 Set the file size limit, expressed in bytes.
147
148 @item -ss @var{position} (@emph{input/output})
149 When used as an input option (before @code{-i}), seeks in this input file to
150 @var{position}. When used as an output option (before an output filename),
151 decodes but discards input until the timestamps reach @var{position}. This is
152 slower, but more accurate.
153
154 @var{position} may be either in seconds or in @code{hh:mm:ss[.xxx]} form.
155
156 @item -itsoffset @var{offset} (@emph{input})
157 Set the input time offset in seconds.
158 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
159 The offset is added to the timestamps of the input files.
160 Specifying a positive offset means that the corresponding
161 streams are delayed by @var{offset} seconds.
162
163 @item -timestamp @var{time} (@emph{output})
164 Set the recording timestamp in the container.
165 The syntax for @var{time} is:
166 @example
167 now|([(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...])|(HHMMSS[.m...]))[Z|z])
168 @end example
169 If the value is "now" it takes the current time.
170 Time is local time unless 'Z' or 'z' is appended, in which case it is
171 interpreted as UTC.
172 If the year-month-day part is not specified it takes the current
173 year-month-day.
174
175 @item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
176 Set a metadata key/value pair.
177
178 An optional @var{metadata_specifier} may be given to set metadata
179 on streams or chapters. See @code{-map_metadata} documentation for
180 details.
181
182 This option overrides metadata set with @code{-map_metadata}. It is
183 also possible to delete metadata by using an empty value.
184
185 For example, for setting the title in the output file:
186 @example
187 ffmpeg -i in.avi -metadata title="my title" out.flv
188 @end example
189
190 To set the language of the first audio stream:
191 @example
192 ffmpeg -i INPUT -metadata:s:a:1 language=eng OUTPUT
193 @end example
194
195 @item -target @var{type} (@emph{output})
196 Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
197 @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
198 @code{film-} to use the corresponding standard. All the format options
199 (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
200
201 @example
202 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
203 @end example
204
205 Nevertheless you can specify additional options as long as you know
206 they do not conflict with the standard, as in:
207
208 @example
209 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
210 @end example
211
212 @item -dframes @var{number} (@emph{output})
213 Set the number of data frames to record. This is an alias for @code{-frames:d}.
214
215 @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
216 Stop writing to the stream after @var{framecount} frames.
217
218 @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
219 @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
220 Use fixed quality scale (VBR). The meaning of @var{q} is
221 codec-dependent.
222
223 @item -filter[:@var{stream_specifier}] @var{filter_graph} (@emph{output,per-stream})
224 @var{filter_graph} is a description of the filter graph to apply to
225 the stream. Use @code{-filters} to show all the available filters
226 (including also sources and sinks).
227
228 See also the @option{-filter_complex} option if you want to create filter graphs
229 with multiple inputs and/or outputs.
230 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
231 Specify the preset for matching stream(s).
232
233 @item -stats (@emph{global})
234 Print encoding progress/statistics. On by default.
235
236 @item -debug_ts (@emph{global})
237 Print timestamp information. It is off by default. This option is
238 mostly useful for testing and debugging purposes, and the output
239 format may change from one version to another, so it should not be
240 employed by portable scripts.
241
242 See also the option @code{-fdebug ts}.
243
244 @item -attach @var{filename} (@emph{output})
245 Add an attachment to the output file. This is supported by a few formats
246 like Matroska for e.g. fonts used in rendering subtitles. Attachments
247 are implemented as a specific type of stream, so this option will add
248 a new stream to the file. It is then possible to use per-stream options
249 on this stream in the usual way. Attachment streams created with this
250 option will be created after all the other streams (i.e. those created
251 with @code{-map} or automatic mappings).
252
253 Note that for Matroska you also have to set the mimetype metadata tag:
254 @example
255 ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
256 @end example
257 (assuming that the attachment stream will be third in the output file).
258
259 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
260 Extract the matching attachment stream into a file named @var{filename}. If
261 @var{filename} is empty, then the value of the @code{filename} metadata tag
262 will be used.
263
264 E.g. to extract the first attachment to a file named 'out.ttf':
265 @example
266 ffmpeg -dump_attachment:t:0 out.ttf INPUT
267 @end example
268 To extract all attachments to files determined by the @code{filename} tag:
269 @example
270 ffmpeg -dump_attachment:t "" INPUT
271 @end example
272
273 Technical note -- attachments are implemented as codec extradata, so this
274 option can actually be used to extract extradata from any stream, not just
275 attachments.
276
277 @end table
278
279 @section Video Options
280
281 @table @option
282 @item -vframes @var{number} (@emph{output})
283 Set the number of video frames to record. This is an alias for @code{-frames:v}.
284 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
285 Set frame rate (Hz value, fraction or abbreviation).
286
287 As an input option, ignore any timestamps stored in the file and instead
288 generate timestamps assuming constant frame rate @var{fps}.
289
290 As an output option, duplicate or drop input frames to achieve constant output
291 frame rate @var{fps} (note that this actually causes the @code{fps} filter to be
292 inserted to the end of the corresponding filtergraph).
293
294 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
295 Set frame size.
296
297 As an input option, this is a shortcut for the @option{video_size} private
298 option, recognized by some demuxers for which the frame size is either not
299 stored in the file or is configurable -- e.g. raw video or video grabbers.
300
301 As an output option, this inserts the @code{scale} video filter to the
302 @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
303 directly to insert it at the beginning or some other place.
304
305 The format is @samp{wxh} (default - same as source).
306
307 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
308 Set the video display aspect ratio specified by @var{aspect}.
309
310 @var{aspect} can be a floating point number string, or a string of the
311 form @var{num}:@var{den}, where @var{num} and @var{den} are the
312 numerator and denominator of the aspect ratio. For example "4:3",
313 "16:9", "1.3333", and "1.7777" are valid argument values.
314
315 @item -croptop @var{size}
316 @item -cropbottom @var{size}
317 @item -cropleft @var{size}
318 @item -cropright @var{size}
319 All the crop options have been removed. Use -vf
320 crop=width:height:x:y instead.
321
322 @item -padtop @var{size}
323 @item -padbottom @var{size}
324 @item -padleft @var{size}
325 @item -padright @var{size}
326 @item -padcolor @var{hex_color}
327 All the pad options have been removed. Use -vf
328 pad=width:height:x:y:color instead.
329
330 @item -vn (@emph{output})
331 Disable video recording.
332
333 @item -vcodec @var{codec} (@emph{output})
334 Set the video codec. This is an alias for @code{-codec:v}.
335 @item -same_quant
336 Use same quantizer as source (implies VBR).
337
338 Note that this is NOT SAME QUALITY. Do not use this option unless you know you
339 need it.
340
341 @item -pass @var{n}
342 Select the pass number (1 or 2). It is used to do two-pass
343 video encoding. The statistics of the video are recorded in the first
344 pass into a log file (see also the option -passlogfile),
345 and in the second pass that log file is used to generate the video
346 at the exact requested bitrate.
347 On pass 1, you may just deactivate audio and set output to null,
348 examples for Windows and Unix:
349 @example
350 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
351 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
352 @end example
353
354 @item -passlogfile @var{prefix} (@emph{global})
355 Set two-pass log file name prefix to @var{prefix}, the default file name
356 prefix is ``ffmpeg2pass''. The complete file name will be
357 @file{PREFIX-N.log}, where N is a number specific to the output
358 stream
359
360 @item -vlang @var{code}
361 Set the ISO 639 language code (3 letters) of the current video stream.
362
363 @item -vf @var{filter_graph} (@emph{output})
364 @var{filter_graph} is a description of the filter graph to apply to
365 the input video.
366 Use the option "-filters" to show all the available filters (including
367 also sources and sinks).  This is an alias for @code{-filter:v}.
368
369 @end table
370
371 @section Advanced Video Options
372
373 @table @option
374 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
375 Set pixel format. Use @code{-pix_fmts} to show all the supported
376 pixel formats.
377 If the selected pixel format can not be selected, ffmpeg will print a
378 warning and select the best pixel format supported by the encoder.
379 If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
380 if the requested pixel format can not be selected, and automatic conversions
381 inside filter graphs are disabled.
382 If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
383 as the input (or graph output) and automatic conversions are disabled.
384
385 @item -sws_flags @var{flags} (@emph{input/output})
386 Set SwScaler flags.
387 @item -vdt @var{n}
388 Discard threshold.
389
390 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
391 Rate control override for specific intervals, formatted as "int,int,int"
392 list separated with slashes. Two first values are the beginning and
393 end frame numbers, last one is quantizer to use if positive, or quality
394 factor if negative.
395
396 @item -deinterlace
397 Deinterlace pictures.
398 This option is deprecated since the deinterlacing is very low quality.
399 Use the yadif filter with @code{-filter:v yadif}.
400 @item -ilme
401 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
402 Use this option if your input file is interlaced and you want
403 to keep the interlaced format for minimum losses.
404 The alternative is to deinterlace the input stream with
405 @option{-deinterlace}, but deinterlacing introduces losses.
406 @item -psnr
407 Calculate PSNR of compressed frames.
408 @item -vstats
409 Dump video coding statistics to @file{vstats_HHMMSS.log}.
410 @item -vstats_file @var{file}
411 Dump video coding statistics to @var{file}.
412 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
413 top=1/bottom=0/auto=-1 field first
414 @item -dc @var{precision}
415 Intra_dc_precision.
416 @item -vtag @var{fourcc/tag} (@emph{output})
417 Force video tag/fourcc. This is an alias for @code{-tag:v}.
418 @item -qphist (@emph{global})
419 Show QP histogram
420 @item -vbsf @var{bitstream_filter}
421 Deprecated see -bsf
422 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
423 Force key frames at the specified timestamps, more precisely at the first
424 frames after each specified time.
425 This option can be useful to ensure that a seek point is present at a
426 chapter mark or any other designated place in the output file.
427 The timestamps must be specified in ascending order.
428
429 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
430 When doing stream copy, copy also non-key frames found at the
431 beginning.
432 @end table
433
434 @section Audio Options
435
436 @table @option
437 @item -aframes @var{number} (@emph{output})
438 Set the number of audio frames to record. This is an alias for @code{-frames:a}.
439 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
440 Set the audio sampling frequency. For output streams it is set by
441 default to the frequency of the corresponding input stream. For input
442 streams this option only makes sense for audio grabbing devices and raw
443 demuxers and is mapped to the corresponding demuxer options.
444 @item -aq @var{q} (@emph{output})
445 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
446 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
447 Set the number of audio channels. For output streams it is set by
448 default to the number of input audio channels. For input streams
449 this option only makes sense for audio grabbing devices and raw demuxers
450 and is mapped to the corresponding demuxer options.
451 @item -an (@emph{output})
452 Disable audio recording.
453 @item -acodec @var{codec} (@emph{input/output})
454 Set the audio codec. This is an alias for @code{-codec:a}.
455 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
456 Set the audio sample format. Use @code{-sample_fmts} to get a list
457 of supported sample formats.
458 @item -af @var{filter_graph} (@emph{output})
459 @var{filter_graph} is a description of the filter graph to apply to
460 the input audio.
461 Use the option "-filters" to show all the available filters (including
462 also sources and sinks).  This is an alias for @code{-filter:a}.
463 @end table
464
465 @section Advanced Audio options:
466
467 @table @option
468 @item -atag @var{fourcc/tag} (@emph{output})
469 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
470 @item -absf @var{bitstream_filter}
471 Deprecated, see -bsf
472 @end table
473
474 @section Subtitle options:
475
476 @table @option
477 @item -slang @var{code}
478 Set the ISO 639 language code (3 letters) of the current subtitle stream.
479 @item -scodec @var{codec} (@emph{input/output})
480 Set the subtitle codec. This is an alias for @code{-codec:s}.
481 @item -sn (@emph{output})
482 Disable subtitle recording.
483 @item -sbsf @var{bitstream_filter}
484 Deprecated, see -bsf
485 @end table
486
487 @section Audio/Video grab options
488
489 @table @option
490 @item -isync (@emph{global})
491 Synchronize read on input.
492 @end table
493
494 @section Advanced options
495
496 @table @option
497 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
498
499 Designate one or more input streams as a source for the output file. Each input
500 stream is identified by the input file index @var{input_file_id} and
501 the input stream index @var{input_stream_id} within the input
502 file. Both indices start at 0. If specified,
503 @var{sync_file_id}:@var{stream_specifier} sets which input stream
504 is used as a presentation sync reference.
505
506 The first @code{-map} option on the command line specifies the
507 source for output stream 0, the second @code{-map} option specifies
508 the source for output stream 1, etc.
509
510 A @code{-} character before the stream identifier creates a "negative" mapping.
511 It disables matching streams from already created mappings.
512
513 An alternative @var{[linklabel]} form will map outputs from complex filter
514 graphs (see the @option{-filter_complex} option) to the output file.
515 @var{linklabel} must correspond to a defined output link label in the graph.
516
517 For example, to map ALL streams from the first input file to output
518 @example
519 ffmpeg -i INPUT -map 0 output
520 @end example
521
522 For example, if you have two audio streams in the first input file,
523 these streams are identified by "0:0" and "0:1". You can use
524 @code{-map} to select which streams to place in an output file. For
525 example:
526 @example
527 ffmpeg -i INPUT -map 0:1 out.wav
528 @end example
529 will map the input stream in @file{INPUT} identified by "0:1" to
530 the (single) output stream in @file{out.wav}.
531
532 For example, to select the stream with index 2 from input file
533 @file{a.mov} (specified by the identifier "0:2"), and stream with
534 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
535 and copy them to the output file @file{out.mov}:
536 @example
537 ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
538 @end example
539
540 To select all video and the third audio stream from an input file:
541 @example
542 ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
543 @end example
544
545 To map all the streams except the second audio, use negative mappings
546 @example
547 ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
548 @end example
549
550 Note that using this option disables the default mappings for this output file.
551
552 @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][:@var{output_file_id}.@var{stream_specifier}]
553 Map an audio channel from a given input to an output. If
554 @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
555 be mapped on all the audio streams.
556
557 Using "-1" instead of
558 @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
559 channel.
560
561 For example, assuming @var{INPUT} is a stereo audio file, you can switch the
562 two audio channels with the following command:
563 @example
564 ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
565 @end example
566
567 If you want to mute the first channel and keep the second:
568 @example
569 ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
570 @end example
571
572 The order of the "-map_channel" option specifies the order of the channels in
573 the output stream. The output channel layout is guessed from the number of
574 channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
575 in combination of "-map_channel" makes the channel gain levels to be updated if
576 input and output channel layouts don't match (for instance two "-map_channel"
577 options and "-ac 6").
578
579 You can also extract each channel of an input to specific outputs; the following
580 command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
581 to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
582 @example
583 ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
584 @end example
585
586 The following example splits the channels of a stereo input into two separate
587 streams, which are put into the same output file:
588 @example
589 ffmpeg -i stereo.wav -map 0:0 -map 0:0 -map_channel 0.0.0:0.0 -map_channel 0.0.1:0.1 -y out.ogg
590 @end example
591
592 Note that currently each output stream can only contain channels from a single
593 input stream; you can't for example use "-map_channel" to pick multiple input
594 audio channels contained in different streams (from the same or different files)
595 and merge them into a single output stream. It is therefore not currently
596 possible, for example, to turn two separate mono streams into a single stereo
597 stream. However splitting a stereo stream into two single channel mono streams
598 is possible.
599
600 If you need this feature, a possible workaround is to use the @emph{amerge}
601 filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
602 mono audio streams into one single stereo channel audio stream (and keep the
603 video stream), you can use the following command:
604 @example
605 ffmpeg -i input.mkv -f lavfi -i "
606 amovie=input.mkv:si=1 [a1];
607 amovie=input.mkv:si=2 [a2];
608 [a1][a2] amerge" -c:a pcm_s16le -c:v copy output.mkv
609 @end example
610
611 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
612 Set metadata information of the next output file from @var{infile}. Note that
613 those are file indices (zero-based), not filenames.
614 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
615 A metadata specifier can have the following forms:
616 @table @option
617 @item @var{g}
618 global metadata, i.e. metadata that applies to the whole file
619
620 @item @var{s}[:@var{stream_spec}]
621 per-stream metadata. @var{stream_spec} is a stream specifier as described
622 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
623 matching stream is copied from. In an output metadata specifier, all matching
624 streams are copied to.
625
626 @item @var{c}:@var{chapter_index}
627 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
628
629 @item @var{p}:@var{program_index}
630 per-program metadata. @var{program_index} is the zero-based program index.
631 @end table
632 If metadata specifier is omitted, it defaults to global.
633
634 By default, global metadata is copied from the first input file,
635 per-stream and per-chapter metadata is copied along with streams/chapters. These
636 default mappings are disabled by creating any mapping of the relevant type. A negative
637 file index can be used to create a dummy mapping that just disables automatic copying.
638
639 For example to copy metadata from the first stream of the input file to global metadata
640 of the output file:
641 @example
642 ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
643 @end example
644
645 To do the reverse, i.e. copy global metadata to all audio streams:
646 @example
647 ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
648 @end example
649 Note that simple @code{0} would work as well in this example, since global
650 metadata is assumed by default.
651
652 @item -map_chapters @var{input_file_index} (@emph{output})
653 Copy chapters from input file with index @var{input_file_index} to the next
654 output file. If no chapter mapping is specified, then chapters are copied from
655 the first input file with at least one chapter. Use a negative file index to
656 disable any chapter copying.
657 @item -debug @var{category}
658 Print specific debug info.
659 @var{category} is a number or a string containing one of the following values:
660 @table @samp
661 @item bitstream
662 @item buffers
663 picture buffer allocations
664 @item bugs
665 @item dct_coeff
666 @item er
667 error recognition
668 @item mb_type
669 macroblock (MB) type
670 @item mmco
671 memory management control operations (H.264)
672 @item mv
673 motion vector
674 @item pict
675 picture info
676 @item pts
677 @item qp
678 per-block quantization parameter (QP)
679 @item rc
680 rate control
681 @item skip
682 @item startcode
683 @item thread_ops
684 threading operations
685 @item vis_mb_type
686 visualize block types
687 @item vis_qp
688 visualize quantization parameter (QP), lower QP are tinted greener
689 @end table
690 @item -benchmark (@emph{global})
691 Show benchmarking information at the end of an encode.
692 Shows CPU time used and maximum memory consumption.
693 Maximum memory consumption is not supported on all systems,
694 it will usually display as 0 if not supported.
695 @item -benchmark_all (@emph{global})
696 Show benchmarking information during the encode.
697 Shows CPU time used in various steps (audio/video encode/decode).
698 @item -timelimit @var{duration} (@emph{global})
699 Exit after ffmpeg has been running for @var{duration} seconds.
700 @item -dump (@emph{global})
701 Dump each input packet to stderr.
702 @item -hex (@emph{global})
703 When dumping packets, also dump the payload.
704 @item -re (@emph{input})
705 Read input at native frame rate. Mainly used to simulate a grab device.
706 @item -loop_input
707 Loop over the input stream. Currently it works only for image
708 streams. This option is used for automatic FFserver testing.
709 This option is deprecated, use -loop 1.
710 @item -loop_output @var{number_of_times}
711 Repeatedly loop output for formats that support looping such as animated GIF
712 (0 will loop the output infinitely).
713 This option is deprecated, use -loop.
714 @item -vsync @var{parameter}
715 Video sync method.
716 For compatibility reasons old values can be specified as numbers.
717 Newly added values will have to be specified as strings always.
718
719 @table @option
720 @item 0, passthrough
721 Each frame is passed with its timestamp from the demuxer to the muxer.
722 @item 1, cfr
723 Frames will be duplicated and dropped to achieve exactly the requested
724 constant framerate.
725 @item 2, vfr
726 Frames are passed through with their timestamp or dropped so as to
727 prevent 2 frames from having the same timestamp.
728 @item drop
729 As passthrough but destroys all timestamps, making the muxer generate
730 fresh timestamps based on frame-rate.
731 @item -1, auto
732 Chooses between 1 and 2 depending on muxer capabilities. This is the
733 default method.
734 @end table
735
736 With -map you can select from which stream the timestamps should be
737 taken. You can leave either video or audio unchanged and sync the
738 remaining stream(s) to the unchanged one.
739
740 @item -async @var{samples_per_second}
741 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
742 the parameter is the maximum samples per second by which the audio is changed.
743 -async 1 is a special case where only the start of the audio stream is corrected
744 without any later correction.
745 This option has been deprecated. Use the @code{asyncts} audio filter instead.
746 @item -copyts
747 Copy timestamps from input to output.
748 @item -copytb @var{mode}
749 Specify how to set the encoder timebase when stream copying.  @var{mode} is an
750 integer numeric value, and can assume one of the following values:
751
752 @table @option
753 @item 1
754 Use the demuxer timebase.
755
756 The time base is copied to the output encoder from the corresponding input
757 demuxer. This is sometimes required to avoid non monotonically increasing
758 timestamps when copying video streams with variable frame rate.
759
760 @item 0
761 Use the decoder timebase.
762
763 The time base is copied to the output encoder from the corresponding input
764 decoder.
765
766 @item -1
767 Try to make the choice automatically, in order to generate a sane output.
768 @end table
769
770 Default value is -1.
771
772 @item -shortest
773 Finish encoding when the shortest input stream ends.
774 @item -dts_delta_threshold
775 Timestamp discontinuity delta threshold.
776 @item -muxdelay @var{seconds} (@emph{input})
777 Set the maximum demux-decode delay.
778 @item -muxpreload @var{seconds} (@emph{input})
779 Set the initial demux-decode delay.
780 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
781 Assign a new stream-id value to an output stream. This option should be
782 specified prior to the output filename to which it applies.
783 For the situation where multiple output files exist, a streamid
784 may be reassigned to a different value.
785
786 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
787 an output mpegts file:
788 @example
789 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
790 @end example
791
792 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
793 Set bitstream filters for matching streams. @var{bistream_filters} is
794 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
795 to get the list of bitstream filters.
796 @example
797 ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
798 @end example
799 @example
800 ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
801 @end example
802
803 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{per-stream})
804 Force a tag/fourcc for matching streams.
805
806 @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
807 Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
808 (or '.') for drop.
809 @example
810 ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
811 @end example
812
813 @item -filter_complex @var{filtergraph} (@emph{global})
814 Define a complex filter graph, i.e. one with arbitrary number of inputs and/or
815 outputs. For simple graphs -- those with one input and one output of the same
816 type -- see the @option{-filter} options. @var{filtergraph} is a description of
817 the filter graph, as described in @ref{Filtergraph syntax}.
818
819 Input link labels must refer to input streams using the
820 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
821 uses). If @var{stream_specifier} matches multiple streams, the first one will be
822 used. An unlabeled input will be connected to the first unused input stream of
823 the matching type.
824
825 Output link labels are referred to with @option{-map}. Unlabeled outputs are
826 added to the first output file.
827
828 For example, to overlay an image over video
829 @example
830 ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
831 '[out]' out.mkv
832 @end example
833 Here @code{[0:v]} refers to the first video stream in the first input file,
834 which is linked to the first (main) input of the overlay filter. Similarly the
835 first video stream in the second input is linked to the second (overlay) input
836 of overlay.
837
838 Assuming there is only one video stream in each input file, we can omit input
839 labels, so the above is equivalent to
840 @example
841 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
842 '[out]' out.mkv
843 @end example
844
845 Furthermore we can omit the output label and the single output from the filter
846 graph will be added to the output file automatically, so we can simply write
847 @example
848 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
849 @end example
850 @end table
851
852 @section Preset files
853 A preset file contains a sequence of @var{option}=@var{value} pairs,
854 one for each line, specifying a sequence of options which would be
855 awkward to specify on the command line. Lines starting with the hash
856 ('#') character are ignored and are used to provide comments. Check
857 the @file{presets} directory in the FFmpeg source tree for examples.
858
859 Preset files are specified with the @code{vpre}, @code{apre},
860 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
861 filename of the preset instead of a preset name as input and can be
862 used for any kind of codec. For the @code{vpre}, @code{apre}, and
863 @code{spre} options, the options specified in a preset file are
864 applied to the currently selected codec of the same type as the preset
865 option.
866
867 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
868 preset options identifies the preset file to use according to the
869 following rules:
870
871 First ffmpeg searches for a file named @var{arg}.ffpreset in the
872 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
873 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
874 or in a @file{ffpresets} folder along the executable on win32,
875 in that order. For example, if the argument is @code{libx264-max}, it will
876 search for the file @file{libx264-max.ffpreset}.
877
878 If no such file is found, then ffmpeg will search for a file named
879 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
880 directories, where @var{codec_name} is the name of the codec to which
881 the preset file options will be applied. For example, if you select
882 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
883 then it will search for the file @file{libx264-max.ffpreset}.
884 @c man end OPTIONS
885
886 @chapter Tips
887 @c man begin TIPS
888
889 @itemize
890 @item
891 For streaming at very low bitrate application, use a low frame rate
892 and a small GOP size. This is especially true for RealVideo where
893 the Linux player does not seem to be very fast, so it can miss
894 frames. An example is:
895
896 @example
897 ffmpeg -g 3 -r 3 -t 10 -b:v 50k -s qcif -f rv10 /tmp/b.rm
898 @end example
899
900 @item
901 The parameter 'q' which is displayed while encoding is the current
902 quantizer. The value 1 indicates that a very good quality could
903 be achieved. The value 31 indicates the worst quality. If q=31 appears
904 too often, it means that the encoder cannot compress enough to meet
905 your bitrate. You must either increase the bitrate, decrease the
906 frame rate or decrease the frame size.
907
908 @item
909 If your computer is not fast enough, you can speed up the
910 compression at the expense of the compression ratio. You can use
911 '-me zero' to speed up motion estimation, and '-g 0' to disable
912 motion estimation completely (you have only I-frames, which means it
913 is about as good as JPEG compression).
914
915 @item
916 To have very low audio bitrates, reduce the sampling frequency
917 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
918
919 @item
920 To have a constant quality (but a variable bitrate), use the option
921 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
922 quality).
923
924 @end itemize
925 @c man end TIPS
926
927 @chapter Examples
928 @c man begin EXAMPLES
929
930 @section Preset files
931
932 A preset file contains a sequence of @var{option=value} pairs, one for
933 each line, specifying a sequence of options which can be specified also on
934 the command line. Lines starting with the hash ('#') character are ignored and
935 are used to provide comments. Empty lines are also ignored. Check the
936 @file{presets} directory in the FFmpeg source tree for examples.
937
938 Preset files are specified with the @code{pre} option, this option takes a
939 preset name as input.  FFmpeg searches for a file named @var{preset_name}.avpreset in
940 the directories @file{$AVCONV_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
941 the data directory defined at configuration time (usually @file{$PREFIX/share/ffmpeg})
942 in that order.  For example, if the argument is @code{libx264-max}, it will
943 search for the file @file{libx264-max.avpreset}.
944
945 @section Video and Audio grabbing
946
947 If you specify the input format and device then ffmpeg can grab video
948 and audio directly.
949
950 @example
951 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
952 @end example
953
954 Or with an ALSA audio source (mono input, card id 1) instead of OSS:
955 @example
956 ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
957 @end example
958
959 Note that you must activate the right video source and channel before
960 launching ffmpeg with any TV viewer such as
961 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
962 have to set the audio recording levels correctly with a
963 standard mixer.
964
965 @section X11 grabbing
966
967 Grab the X11 display with ffmpeg via
968
969 @example
970 ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
971 @end example
972
973 0.0 is display.screen number of your X11 server, same as
974 the DISPLAY environment variable.
975
976 @example
977 ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
978 @end example
979
980 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
981 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
982
983 @section Video and Audio file format conversion
984
985 Any supported file format and protocol can serve as input to ffmpeg:
986
987 Examples:
988 @itemize
989 @item
990 You can use YUV files as input:
991
992 @example
993 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
994 @end example
995
996 It will use the files:
997 @example
998 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
999 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
1000 @end example
1001
1002 The Y files use twice the resolution of the U and V files. They are
1003 raw files, without header. They can be generated by all decent video
1004 decoders. You must specify the size of the image with the @option{-s} option
1005 if ffmpeg cannot guess it.
1006
1007 @item
1008 You can input from a raw YUV420P file:
1009
1010 @example
1011 ffmpeg -i /tmp/test.yuv /tmp/out.avi
1012 @end example
1013
1014 test.yuv is a file containing raw YUV planar data. Each frame is composed
1015 of the Y plane followed by the U and V planes at half vertical and
1016 horizontal resolution.
1017
1018 @item
1019 You can output to a raw YUV420P file:
1020
1021 @example
1022 ffmpeg -i mydivx.avi hugefile.yuv
1023 @end example
1024
1025 @item
1026 You can set several input files and output files:
1027
1028 @example
1029 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
1030 @end example
1031
1032 Converts the audio file a.wav and the raw YUV video file a.yuv
1033 to MPEG file a.mpg.
1034
1035 @item
1036 You can also do audio and video conversions at the same time:
1037
1038 @example
1039 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1040 @end example
1041
1042 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1043
1044 @item
1045 You can encode to several formats at the same time and define a
1046 mapping from input stream to output streams:
1047
1048 @example
1049 ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
1050 @end example
1051
1052 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1053 file:index' specifies which input stream is used for each output
1054 stream, in the order of the definition of output streams.
1055
1056 @item
1057 You can transcode decrypted VOBs:
1058
1059 @example
1060 ffmpeg -i snatch_1.vob -f avi -c:v mpeg4 -b:v 800k -g 300 -bf 2 -c:a libmp3lame -b:a 128k snatch.avi
1061 @end example
1062
1063 This is a typical DVD ripping example; the input is a VOB file, the
1064 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1065 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1066 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1067 input video. Furthermore, the audio stream is MP3-encoded so you need
1068 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1069 The mapping is particularly useful for DVD transcoding
1070 to get the desired audio language.
1071
1072 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
1073
1074 @item
1075 You can extract images from a video, or create a video from many images:
1076
1077 For extracting images from a video:
1078 @example
1079 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1080 @end example
1081
1082 This will extract one video frame per second from the video and will
1083 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1084 etc. Images will be rescaled to fit the new WxH values.
1085
1086 If you want to extract just a limited number of frames, you can use the
1087 above command in combination with the -vframes or -t option, or in
1088 combination with -ss to start extracting from a certain point in time.
1089
1090 For creating a video from many images:
1091 @example
1092 ffmpeg -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1093 @end example
1094
1095 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1096 composed of three digits padded with zeroes to express the sequence
1097 number. It is the same syntax supported by the C printf function, but
1098 only formats accepting a normal integer are suitable.
1099
1100 When importing an image sequence, -i also supports expanding shell-like
1101 wildcard patterns (globbing) internally. To lower the chance of interfering
1102 with your actual file names and the shell's glob expansion, you are required
1103 to activate glob meta characters by prefixing them with a single @code{%}
1104 character, like in @code{foo-%*.jpeg}, @code{foo-%?%?%?.jpeg} or
1105 @code{foo-00%[234%]%*.jpeg}.
1106 If your filename actually contains a character sequence of a @code{%} character
1107 followed by a glob character, you must double the @code{%} character to escape
1108 it. Imagine your files begin with @code{%?-foo-}, then you could use a glob
1109 pattern like @code{%%?-foo-%*.jpeg}. For input patterns that could be both a
1110 printf or a glob pattern, ffmpeg will assume it is a glob pattern.
1111
1112 @item
1113 You can put many streams of the same type in the output:
1114
1115 @example
1116 ffmpeg -i test1.avi -i test2.avi -map 0.3 -map 0.2 -map 0.1 -map 0.0 -c copy test12.nut
1117 @end example
1118
1119 The resulting output file @file{test12.avi} will contain first four streams from
1120 the input file in reverse order.
1121
1122 @item
1123 To force CBR video output:
1124 @example
1125 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1126 @end example
1127
1128 @item
1129 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
1130 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
1131 @example
1132 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
1133 @end example
1134
1135 @end itemize
1136 @c man end EXAMPLES
1137
1138 @include syntax.texi
1139 @include eval.texi
1140 @include decoders.texi
1141 @include encoders.texi
1142 @include demuxers.texi
1143 @include muxers.texi
1144 @include indevs.texi
1145 @include outdevs.texi
1146 @include protocols.texi
1147 @include bitstream_filters.texi
1148 @include filters.texi
1149 @include metadata.texi
1150
1151 @ignore
1152
1153 @setfilename ffmpeg
1154 @settitle ffmpeg video converter
1155
1156 @c man begin SEEALSO
1157 ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
1158 @c man end
1159
1160 @c man begin AUTHORS
1161 See git history
1162 @c man end
1163
1164 @end ignore
1165
1166 @bye