doc/ffmpeg: add documentation for the disposition option
[ffmpeg.git] / doc / ffmpeg.texi
1 \input texinfo @c -*- texinfo -*-
2 @documentencoding UTF-8
3
4 @settitle ffmpeg Documentation
5 @titlepage
6 @center @titlefont{ffmpeg Documentation}
7 @end titlepage
8
9 @top
10
11 @contents
12
13 @chapter Synopsis
14
15 ffmpeg [@var{global_options}] @{[@var{input_file_options}] -i @file{input_file}@} ... @{[@var{output_file_options}] @file{output_file}@} ...
16
17 @chapter Description
18 @c man begin DESCRIPTION
19
20 @command{ffmpeg} is a very fast video and audio converter that can also grab from
21 a live audio/video source. It can also convert between arbitrary sample
22 rates and resize video on the fly with a high quality polyphase filter.
23
24 @command{ffmpeg} reads from an arbitrary number of input "files" (which can be regular
25 files, pipes, network streams, grabbing devices, etc.), specified by the
26 @code{-i} option, and writes to an arbitrary number of output "files", which are
27 specified by a plain output filename. Anything found on the command line which
28 cannot be interpreted as an option is considered to be an output filename.
29
30 Each input or output file can, in principle, contain any number of streams of
31 different types (video/audio/subtitle/attachment/data). The allowed number and/or
32 types of streams may be limited by the container format. Selecting which
33 streams from which inputs will go into which output is either done automatically
34 or with the @code{-map} option (see the Stream selection chapter).
35
36 To refer to input files in options, you must use their indices (0-based). E.g.
37 the first input file is @code{0}, the second is @code{1}, etc. Similarly, streams
38 within a file are referred to by their indices. E.g. @code{2:3} refers to the
39 fourth stream in the third input file. Also see the Stream specifiers chapter.
40
41 As a general rule, options are applied to the next specified
42 file. Therefore, order is important, and you can have the same
43 option on the command line multiple times. Each occurrence is
44 then applied to the next input or output file.
45 Exceptions from this rule are the global options (e.g. verbosity level),
46 which should be specified first.
47
48 Do not mix input and output files -- first specify all input files, then all
49 output files. Also do not mix options which belong to different files. All
50 options apply ONLY to the next input or output file and are reset between files.
51
52 @itemize
53 @item
54 To set the video bitrate of the output file to 64 kbit/s:
55 @example
56 ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
57 @end example
58
59 @item
60 To force the frame rate of the output file to 24 fps:
61 @example
62 ffmpeg -i input.avi -r 24 output.avi
63 @end example
64
65 @item
66 To force the frame rate of the input file (valid for raw formats only)
67 to 1 fps and the frame rate of the output file to 24 fps:
68 @example
69 ffmpeg -r 1 -i input.m2v -r 24 output.avi
70 @end example
71 @end itemize
72
73 The format option may be needed for raw input files.
74
75 @c man end DESCRIPTION
76
77 @chapter Detailed description
78 @c man begin DETAILED DESCRIPTION
79
80 The transcoding process in @command{ffmpeg} for each output can be described by
81 the following diagram:
82
83 @verbatim
84  _______              ______________
85 |       |            |              |
86 | input |  demuxer   | encoded data |   decoder
87 | file  | ---------> | packets      | -----+
88 |_______|            |______________|      |
89                                            v
90                                        _________
91                                       |         |
92                                       | decoded |
93                                       | frames  |
94                                       |_________|
95  ________             ______________       |
96 |        |           |              |      |
97 | output | <-------- | encoded data | <----+
98 | file   |   muxer   | packets      |   encoder
99 |________|           |______________|
100
101
102 @end verbatim
103
104 @command{ffmpeg} calls the libavformat library (containing demuxers) to read
105 input files and get packets containing encoded data from them. When there are
106 multiple input files, @command{ffmpeg} tries to keep them synchronized by
107 tracking lowest timestamp on any active input stream.
108
109 Encoded packets are then passed to the decoder (unless streamcopy is selected
110 for the stream, see further for a description). The decoder produces
111 uncompressed frames (raw video/PCM audio/...) which can be processed further by
112 filtering (see next section). After filtering, the frames are passed to the
113 encoder, which encodes them and outputs encoded packets. Finally those are
114 passed to the muxer, which writes the encoded packets to the output file.
115
116 @section Filtering
117 Before encoding, @command{ffmpeg} can process raw audio and video frames using
118 filters from the libavfilter library. Several chained filters form a filter
119 graph. @command{ffmpeg} distinguishes between two types of filtergraphs:
120 simple and complex.
121
122 @subsection Simple filtergraphs
123 Simple filtergraphs are those that have exactly one input and output, both of
124 the same type. In the above diagram they can be represented by simply inserting
125 an additional step between decoding and encoding:
126
127 @verbatim
128  _________                        ______________
129 |         |                      |              |
130 | decoded |                      | encoded data |
131 | frames  |\                   _ | packets      |
132 |_________| \                  /||______________|
133              \   __________   /
134   simple     _\||          | /  encoder
135   filtergraph   | filtered |/
136                 | frames   |
137                 |__________|
138
139 @end verbatim
140
141 Simple filtergraphs are configured with the per-stream @option{-filter} option
142 (with @option{-vf} and @option{-af} aliases for video and audio respectively).
143 A simple filtergraph for video can look for example like this:
144
145 @verbatim
146  _______        _____________        _______        ________
147 |       |      |             |      |       |      |        |
148 | input | ---> | deinterlace | ---> | scale | ---> | output |
149 |_______|      |_____________|      |_______|      |________|
150
151 @end verbatim
152
153 Note that some filters change frame properties but not frame contents. E.g. the
154 @code{fps} filter in the example above changes number of frames, but does not
155 touch the frame contents. Another example is the @code{setpts} filter, which
156 only sets timestamps and otherwise passes the frames unchanged.
157
158 @subsection Complex filtergraphs
159 Complex filtergraphs are those which cannot be described as simply a linear
160 processing chain applied to one stream. This is the case, for example, when the graph has
161 more than one input and/or output, or when output stream type is different from
162 input. They can be represented with the following diagram:
163
164 @verbatim
165  _________
166 |         |
167 | input 0 |\                    __________
168 |_________| \                  |          |
169              \   _________    /| output 0 |
170               \ |         |  / |__________|
171  _________     \| complex | /
172 |         |     |         |/
173 | input 1 |---->| filter  |\
174 |_________|     |         | \   __________
175                /| graph   |  \ |          |
176               / |         |   \| output 1 |
177  _________   /  |_________|    |__________|
178 |         | /
179 | input 2 |/
180 |_________|
181
182 @end verbatim
183
184 Complex filtergraphs are configured with the @option{-filter_complex} option.
185 Note that this option is global, since a complex filtergraph, by its nature,
186 cannot be unambiguously associated with a single stream or file.
187
188 The @option{-lavfi} option is equivalent to @option{-filter_complex}.
189
190 A trivial example of a complex filtergraph is the @code{overlay} filter, which
191 has two video inputs and one video output, containing one video overlaid on top
192 of the other. Its audio counterpart is the @code{amix} filter.
193
194 @section Stream copy
195 Stream copy is a mode selected by supplying the @code{copy} parameter to the
196 @option{-codec} option. It makes @command{ffmpeg} omit the decoding and encoding
197 step for the specified stream, so it does only demuxing and muxing. It is useful
198 for changing the container format or modifying container-level metadata. The
199 diagram above will, in this case, simplify to this:
200
201 @verbatim
202  _______              ______________            ________
203 |       |            |              |          |        |
204 | input |  demuxer   | encoded data |  muxer   | output |
205 | file  | ---------> | packets      | -------> | file   |
206 |_______|            |______________|          |________|
207
208 @end verbatim
209
210 Since there is no decoding or encoding, it is very fast and there is no quality
211 loss. However, it might not work in some cases because of many factors. Applying
212 filters is obviously also impossible, since filters work on uncompressed data.
213
214 @c man end DETAILED DESCRIPTION
215
216 @chapter Stream selection
217 @c man begin STREAM SELECTION
218
219 By default, @command{ffmpeg} includes only one stream of each type (video, audio, subtitle)
220 present in the input files and adds them to each output file.  It picks the
221 "best" of each based upon the following criteria: for video, it is the stream
222 with the highest resolution, for audio, it is the stream with the most channels, for
223 subtitles, it is the first subtitle stream. In the case where several streams of
224 the same type rate equally, the stream with the lowest index is chosen.
225
226 You can disable some of those defaults by using the @code{-vn/-an/-sn/-dn} options. For
227 full manual control, use the @code{-map} option, which disables the defaults just
228 described.
229
230 @c man end STREAM SELECTION
231
232 @chapter Options
233 @c man begin OPTIONS
234
235 @include fftools-common-opts.texi
236
237 @section Main options
238
239 @table @option
240
241 @item -f @var{fmt} (@emph{input/output})
242 Force input or output file format. The format is normally auto detected for input
243 files and guessed from the file extension for output files, so this option is not
244 needed in most cases.
245
246 @item -i @var{filename} (@emph{input})
247 input file name
248
249 @item -y (@emph{global})
250 Overwrite output files without asking.
251
252 @item -n (@emph{global})
253 Do not overwrite output files, and exit immediately if a specified
254 output file already exists.
255
256 @item -stream_loop @var{number} (@emph{input})
257 Set number of times input stream shall be looped. Loop 0 means no loop,
258 loop -1 means infinite loop.
259
260 @item -c[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
261 @itemx -codec[:@var{stream_specifier}] @var{codec} (@emph{input/output,per-stream})
262 Select an encoder (when used before an output file) or a decoder (when used
263 before an input file) for one or more streams. @var{codec} is the name of a
264 decoder/encoder or a special value @code{copy} (output only) to indicate that
265 the stream is not to be re-encoded.
266
267 For example
268 @example
269 ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
270 @end example
271 encodes all video streams with libx264 and copies all audio streams.
272
273 For each stream, the last matching @code{c} option is applied, so
274 @example
275 ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
276 @end example
277 will copy all the streams except the second video, which will be encoded with
278 libx264, and the 138th audio, which will be encoded with libvorbis.
279
280 @item -t @var{duration} (@emph{input/output})
281 When used as an input option (before @code{-i}), limit the @var{duration} of
282 data read from the input file.
283
284 When used as an output option (before an output filename), stop writing the
285 output after its duration reaches @var{duration}.
286
287 @var{duration} must be a time duration specification,
288 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
289
290 -to and -t are mutually exclusive and -t has priority.
291
292 @item -to @var{position} (@emph{output})
293 Stop writing the output at @var{position}.
294 @var{position} must be a time duration specification,
295 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
296
297 -to and -t are mutually exclusive and -t has priority.
298
299 @item -fs @var{limit_size} (@emph{output})
300 Set the file size limit, expressed in bytes. No further chunk of bytes is written
301 after the limit is exceeded. The size of the output file is slightly more than the
302 requested file size.
303
304 @item -ss @var{position} (@emph{input/output})
305 When used as an input option (before @code{-i}), seeks in this input file to
306 @var{position}. Note that in most formats it is not possible to seek exactly,
307 so @command{ffmpeg} will seek to the closest seek point before @var{position}.
308 When transcoding and @option{-accurate_seek} is enabled (the default), this
309 extra segment between the seek point and @var{position} will be decoded and
310 discarded. When doing stream copy or when @option{-noaccurate_seek} is used, it
311 will be preserved.
312
313 When used as an output option (before an output filename), decodes but discards
314 input until the timestamps reach @var{position}.
315
316 @var{position} must be a time duration specification,
317 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
318
319 @item -sseof @var{position} (@emph{input/output})
320
321 Like the @code{-ss} option but relative to the "end of file". That is negative
322 values are earlier in the file, 0 is at EOF.
323
324 @item -itsoffset @var{offset} (@emph{input})
325 Set the input time offset.
326
327 @var{offset} must be a time duration specification,
328 see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
329
330 The offset is added to the timestamps of the input files. Specifying
331 a positive offset means that the corresponding streams are delayed by
332 the time duration specified in @var{offset}.
333
334 @item -timestamp @var{date} (@emph{output})
335 Set the recording timestamp in the container.
336
337 @var{date} must be a date specification,
338 see @ref{date syntax,,the Date section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
339
340 @item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
341 Set a metadata key/value pair.
342
343 An optional @var{metadata_specifier} may be given to set metadata
344 on streams, chapters or programs. See @code{-map_metadata}
345 documentation for details.
346
347 This option overrides metadata set with @code{-map_metadata}. It is
348 also possible to delete metadata by using an empty value.
349
350 For example, for setting the title in the output file:
351 @example
352 ffmpeg -i in.avi -metadata title="my title" out.flv
353 @end example
354
355 To set the language of the first audio stream:
356 @example
357 ffmpeg -i INPUT -metadata:s:a:0 language=eng OUTPUT
358 @end example
359
360 @item -disposition[:stream_specifier] @var{value} (@emph{output,per-stream})
361 Sets the disposition for a stream.
362
363 This option overrides the disposition copied from the input stream. It is also
364 possible to delete the disposition by setting it to 0.
365
366 The following dispositions are recognized:
367 @table @option
368 @item default
369 @item dub
370 @item original
371 @item comment
372 @item lyrics
373 @item karaoke
374 @item forced
375 @item hearing_impaired
376 @item visual_impaired
377 @item clean_effects
378 @item captions
379 @item descriptions
380 @item metadata
381 @end table
382
383 For example, to make the second audio stream the default stream:
384 @example
385 ffmpeg -i in.mkv -disposition:a:1 default out.mkv
386 @end example
387
388 To make the second subtitle stream the default stream and remove the default
389 disposition from the first subtitle stream:
390 @example
391 ffmpeg -i INPUT -disposition:s:0 0 -disposition:s:1 default OUTPUT
392 @end example
393
394 @item -program [title=@var{title}:][program_num=@var{program_num}:]st=@var{stream}[:st=@var{stream}...] (@emph{output})
395
396 Creates a program with the specified @var{title}, @var{program_num} and adds the specified
397 @var{stream}(s) to it.
398
399 @item -target @var{type} (@emph{output})
400 Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
401 @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
402 @code{film-} to use the corresponding standard. All the format options
403 (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
404
405 @example
406 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
407 @end example
408
409 Nevertheless you can specify additional options as long as you know
410 they do not conflict with the standard, as in:
411
412 @example
413 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
414 @end example
415
416 @item -dframes @var{number} (@emph{output})
417 Set the number of data frames to output. This is an alias for @code{-frames:d}.
418
419 @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
420 Stop writing to the stream after @var{framecount} frames.
421
422 @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
423 @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
424 Use fixed quality scale (VBR). The meaning of @var{q}/@var{qscale} is
425 codec-dependent.
426 If @var{qscale} is used without a @var{stream_specifier} then it applies only
427 to the video stream, this is to maintain compatibility with previous behavior
428 and as specifying the same codec specific value to 2 different codecs that is
429 audio and video generally is not what is intended when no stream_specifier is
430 used.
431
432 @anchor{filter_option}
433 @item -filter[:@var{stream_specifier}] @var{filtergraph} (@emph{output,per-stream})
434 Create the filtergraph specified by @var{filtergraph} and use it to
435 filter the stream.
436
437 @var{filtergraph} is a description of the filtergraph to apply to
438 the stream, and must have a single input and a single output of the
439 same type of the stream. In the filtergraph, the input is associated
440 to the label @code{in}, and the output to the label @code{out}. See
441 the ffmpeg-filters manual for more information about the filtergraph
442 syntax.
443
444 See the @ref{filter_complex_option,,-filter_complex option} if you
445 want to create filtergraphs with multiple inputs and/or outputs.
446
447 @item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
448 This option is similar to @option{-filter}, the only difference is that its
449 argument is the name of the file from which a filtergraph description is to be
450 read.
451
452 @item -filter_threads @var{nb_threads} (@emph{global})
453 Defines how many threads are used to process a filter pipeline. Each pipeline
454 will produce a thread pool with this many threads available for parallel processing.
455 The default is the number of available CPUs.
456
457 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
458 Specify the preset for matching stream(s).
459
460 @item -stats (@emph{global})
461 Print encoding progress/statistics. It is on by default, to explicitly
462 disable it you need to specify @code{-nostats}.
463
464 @item -progress @var{url} (@emph{global})
465 Send program-friendly progress information to @var{url}.
466
467 Progress information is written approximately every second and at the end of
468 the encoding process. It is made of "@var{key}=@var{value}" lines. @var{key}
469 consists of only alphanumeric characters. The last key of a sequence of
470 progress information is always "progress".
471
472 @item -stdin
473 Enable interaction on standard input. On by default unless standard input is
474 used as an input. To explicitly disable interaction you need to specify
475 @code{-nostdin}.
476
477 Disabling interaction on standard input is useful, for example, if
478 ffmpeg is in the background process group. Roughly the same result can
479 be achieved with @code{ffmpeg ... < /dev/null} but it requires a
480 shell.
481
482 @item -debug_ts (@emph{global})
483 Print timestamp information. It is off by default. This option is
484 mostly useful for testing and debugging purposes, and the output
485 format may change from one version to another, so it should not be
486 employed by portable scripts.
487
488 See also the option @code{-fdebug ts}.
489
490 @item -attach @var{filename} (@emph{output})
491 Add an attachment to the output file. This is supported by a few formats
492 like Matroska for e.g. fonts used in rendering subtitles. Attachments
493 are implemented as a specific type of stream, so this option will add
494 a new stream to the file. It is then possible to use per-stream options
495 on this stream in the usual way. Attachment streams created with this
496 option will be created after all the other streams (i.e. those created
497 with @code{-map} or automatic mappings).
498
499 Note that for Matroska you also have to set the mimetype metadata tag:
500 @example
501 ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
502 @end example
503 (assuming that the attachment stream will be third in the output file).
504
505 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
506 Extract the matching attachment stream into a file named @var{filename}. If
507 @var{filename} is empty, then the value of the @code{filename} metadata tag
508 will be used.
509
510 E.g. to extract the first attachment to a file named 'out.ttf':
511 @example
512 ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
513 @end example
514 To extract all attachments to files determined by the @code{filename} tag:
515 @example
516 ffmpeg -dump_attachment:t "" -i INPUT
517 @end example
518
519 Technical note -- attachments are implemented as codec extradata, so this
520 option can actually be used to extract extradata from any stream, not just
521 attachments.
522
523 @item -noautorotate
524 Disable automatically rotating video based on file metadata.
525
526 @end table
527
528 @section Video Options
529
530 @table @option
531 @item -vframes @var{number} (@emph{output})
532 Set the number of video frames to output. This is an alias for @code{-frames:v}.
533 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
534 Set frame rate (Hz value, fraction or abbreviation).
535
536 As an input option, ignore any timestamps stored in the file and instead
537 generate timestamps assuming constant frame rate @var{fps}.
538 This is not the same as the @option{-framerate} option used for some input formats
539 like image2 or v4l2 (it used to be the same in older versions of FFmpeg).
540 If in doubt use @option{-framerate} instead of the input option @option{-r}.
541
542 As an output option, duplicate or drop input frames to achieve constant output
543 frame rate @var{fps}.
544
545 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
546 Set frame size.
547
548 As an input option, this is a shortcut for the @option{video_size} private
549 option, recognized by some demuxers for which the frame size is either not
550 stored in the file or is configurable -- e.g. raw video or video grabbers.
551
552 As an output option, this inserts the @code{scale} video filter to the
553 @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
554 directly to insert it at the beginning or some other place.
555
556 The format is @samp{wxh} (default - same as source).
557
558 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
559 Set the video display aspect ratio specified by @var{aspect}.
560
561 @var{aspect} can be a floating point number string, or a string of the
562 form @var{num}:@var{den}, where @var{num} and @var{den} are the
563 numerator and denominator of the aspect ratio. For example "4:3",
564 "16:9", "1.3333", and "1.7777" are valid argument values.
565
566 If used together with @option{-vcodec copy}, it will affect the aspect ratio
567 stored at container level, but not the aspect ratio stored in encoded
568 frames, if it exists.
569
570 @item -vn (@emph{output})
571 Disable video recording.
572
573 @item -vcodec @var{codec} (@emph{output})
574 Set the video codec. This is an alias for @code{-codec:v}.
575
576 @item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
577 Select the pass number (1 or 2). It is used to do two-pass
578 video encoding. The statistics of the video are recorded in the first
579 pass into a log file (see also the option -passlogfile),
580 and in the second pass that log file is used to generate the video
581 at the exact requested bitrate.
582 On pass 1, you may just deactivate audio and set output to null,
583 examples for Windows and Unix:
584 @example
585 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
586 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
587 @end example
588
589 @item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
590 Set two-pass log file name prefix to @var{prefix}, the default file name
591 prefix is ``ffmpeg2pass''. The complete file name will be
592 @file{PREFIX-N.log}, where N is a number specific to the output
593 stream
594
595 @item -vf @var{filtergraph} (@emph{output})
596 Create the filtergraph specified by @var{filtergraph} and use it to
597 filter the stream.
598
599 This is an alias for @code{-filter:v}, see the @ref{filter_option,,-filter option}.
600 @end table
601
602 @section Advanced Video options
603
604 @table @option
605 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
606 Set pixel format. Use @code{-pix_fmts} to show all the supported
607 pixel formats.
608 If the selected pixel format can not be selected, ffmpeg will print a
609 warning and select the best pixel format supported by the encoder.
610 If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
611 if the requested pixel format can not be selected, and automatic conversions
612 inside filtergraphs are disabled.
613 If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
614 as the input (or graph output) and automatic conversions are disabled.
615
616 @item -sws_flags @var{flags} (@emph{input/output})
617 Set SwScaler flags.
618 @item -vdt @var{n}
619 Discard threshold.
620
621 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
622 Rate control override for specific intervals, formatted as "int,int,int"
623 list separated with slashes. Two first values are the beginning and
624 end frame numbers, last one is quantizer to use if positive, or quality
625 factor if negative.
626
627 @item -ilme
628 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
629 Use this option if your input file is interlaced and you want
630 to keep the interlaced format for minimum losses.
631 The alternative is to deinterlace the input stream with
632 @option{-deinterlace}, but deinterlacing introduces losses.
633 @item -psnr
634 Calculate PSNR of compressed frames.
635 @item -vstats
636 Dump video coding statistics to @file{vstats_HHMMSS.log}.
637 @item -vstats_file @var{file}
638 Dump video coding statistics to @var{file}.
639 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
640 top=1/bottom=0/auto=-1 field first
641 @item -dc @var{precision}
642 Intra_dc_precision.
643 @item -vtag @var{fourcc/tag} (@emph{output})
644 Force video tag/fourcc. This is an alias for @code{-tag:v}.
645 @item -qphist (@emph{global})
646 Show QP histogram
647 @item -vbsf @var{bitstream_filter}
648 Deprecated see -bsf
649
650 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
651 @item -force_key_frames[:@var{stream_specifier}] expr:@var{expr} (@emph{output,per-stream})
652 Force key frames at the specified timestamps, more precisely at the first
653 frames after each specified time.
654
655 If the argument is prefixed with @code{expr:}, the string @var{expr}
656 is interpreted like an expression and is evaluated for each frame. A
657 key frame is forced in case the evaluation is non-zero.
658
659 If one of the times is "@code{chapters}[@var{delta}]", it is expanded into
660 the time of the beginning of all chapters in the file, shifted by
661 @var{delta}, expressed as a time in seconds.
662 This option can be useful to ensure that a seek point is present at a
663 chapter mark or any other designated place in the output file.
664
665 For example, to insert a key frame at 5 minutes, plus key frames 0.1 second
666 before the beginning of every chapter:
667 @example
668 -force_key_frames 0:05:00,chapters-0.1
669 @end example
670
671 The expression in @var{expr} can contain the following constants:
672 @table @option
673 @item n
674 the number of current processed frame, starting from 0
675 @item n_forced
676 the number of forced frames
677 @item prev_forced_n
678 the number of the previous forced frame, it is @code{NAN} when no
679 keyframe was forced yet
680 @item prev_forced_t
681 the time of the previous forced frame, it is @code{NAN} when no
682 keyframe was forced yet
683 @item t
684 the time of the current processed frame
685 @end table
686
687 For example to force a key frame every 5 seconds, you can specify:
688 @example
689 -force_key_frames expr:gte(t,n_forced*5)
690 @end example
691
692 To force a key frame 5 seconds after the time of the last forced one,
693 starting from second 13:
694 @example
695 -force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
696 @end example
697
698 Note that forcing too many keyframes is very harmful for the lookahead
699 algorithms of certain encoders: using fixed-GOP options or similar
700 would be more efficient.
701
702 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
703 When doing stream copy, copy also non-key frames found at the
704 beginning.
705
706 @item -hwaccel[:@var{stream_specifier}] @var{hwaccel} (@emph{input,per-stream})
707 Use hardware acceleration to decode the matching stream(s). The allowed values
708 of @var{hwaccel} are:
709 @table @option
710 @item none
711 Do not use any hardware acceleration (the default).
712
713 @item auto
714 Automatically select the hardware acceleration method.
715
716 @item vda
717 Use Apple VDA hardware acceleration.
718
719 @item vdpau
720 Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration.
721
722 @item dxva2
723 Use DXVA2 (DirectX Video Acceleration) hardware acceleration.
724
725 @item qsv
726 Use the Intel QuickSync Video acceleration for video transcoding.
727
728 Unlike most other values, this option does not enable accelerated decoding (that
729 is used automatically whenever a qsv decoder is selected), but accelerated
730 transcoding, without copying the frames into the system memory.
731
732 For it to work, both the decoder and the encoder must support QSV acceleration
733 and no filters must be used.
734 @end table
735
736 This option has no effect if the selected hwaccel is not available or not
737 supported by the chosen decoder.
738
739 Note that most acceleration methods are intended for playback and will not be
740 faster than software decoding on modern CPUs. Additionally, @command{ffmpeg}
741 will usually need to copy the decoded frames from the GPU memory into the system
742 memory, resulting in further performance loss. This option is thus mainly
743 useful for testing.
744
745 @item -hwaccel_device[:@var{stream_specifier}] @var{hwaccel_device} (@emph{input,per-stream})
746 Select a device to use for hardware acceleration.
747
748 This option only makes sense when the @option{-hwaccel} option is also
749 specified. Its exact meaning depends on the specific hardware acceleration
750 method chosen.
751
752 @table @option
753 @item vdpau
754 For VDPAU, this option specifies the X11 display/screen to use. If this option
755 is not specified, the value of the @var{DISPLAY} environment variable is used
756
757 @item dxva2
758 For DXVA2, this option should contain the number of the display adapter to use.
759 If this option is not specified, the default adapter is used.
760
761 @item qsv
762 For QSV, this option corresponds to the values of MFX_IMPL_* . Allowed values
763 are:
764 @table @option
765 @item auto
766 @item sw
767 @item hw
768 @item auto_any
769 @item hw_any
770 @item hw2
771 @item hw3
772 @item hw4
773 @end table
774 @end table
775
776 @item -hwaccels
777 List all hardware acceleration methods supported in this build of ffmpeg.
778
779 @end table
780
781 @section Audio Options
782
783 @table @option
784 @item -aframes @var{number} (@emph{output})
785 Set the number of audio frames to output. This is an alias for @code{-frames:a}.
786 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
787 Set the audio sampling frequency. For output streams it is set by
788 default to the frequency of the corresponding input stream. For input
789 streams this option only makes sense for audio grabbing devices and raw
790 demuxers and is mapped to the corresponding demuxer options.
791 @item -aq @var{q} (@emph{output})
792 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
793 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
794 Set the number of audio channels. For output streams it is set by
795 default to the number of input audio channels. For input streams
796 this option only makes sense for audio grabbing devices and raw demuxers
797 and is mapped to the corresponding demuxer options.
798 @item -an (@emph{output})
799 Disable audio recording.
800 @item -acodec @var{codec} (@emph{input/output})
801 Set the audio codec. This is an alias for @code{-codec:a}.
802 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
803 Set the audio sample format. Use @code{-sample_fmts} to get a list
804 of supported sample formats.
805
806 @item -af @var{filtergraph} (@emph{output})
807 Create the filtergraph specified by @var{filtergraph} and use it to
808 filter the stream.
809
810 This is an alias for @code{-filter:a}, see the @ref{filter_option,,-filter option}.
811 @end table
812
813 @section Advanced Audio options
814
815 @table @option
816 @item -atag @var{fourcc/tag} (@emph{output})
817 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
818 @item -absf @var{bitstream_filter}
819 Deprecated, see -bsf
820 @item -guess_layout_max @var{channels} (@emph{input,per-stream})
821 If some input channel layout is not known, try to guess only if it
822 corresponds to at most the specified number of channels. For example, 2
823 tells to @command{ffmpeg} to recognize 1 channel as mono and 2 channels as
824 stereo but not 6 channels as 5.1. The default is to always try to guess. Use
825 0 to disable all guessing.
826 @end table
827
828 @section Subtitle options
829
830 @table @option
831 @item -scodec @var{codec} (@emph{input/output})
832 Set the subtitle codec. This is an alias for @code{-codec:s}.
833 @item -sn (@emph{output})
834 Disable subtitle recording.
835 @item -sbsf @var{bitstream_filter}
836 Deprecated, see -bsf
837 @end table
838
839 @section Advanced Subtitle options
840
841 @table @option
842
843 @item -fix_sub_duration
844 Fix subtitles durations. For each subtitle, wait for the next packet in the
845 same stream and adjust the duration of the first to avoid overlap. This is
846 necessary with some subtitles codecs, especially DVB subtitles, because the
847 duration in the original packet is only a rough estimate and the end is
848 actually marked by an empty subtitle frame. Failing to use this option when
849 necessary can result in exaggerated durations or muxing failures due to
850 non-monotonic timestamps.
851
852 Note that this option will delay the output of all data until the next
853 subtitle packet is decoded: it may increase memory consumption and latency a
854 lot.
855
856 @item -canvas_size @var{size}
857 Set the size of the canvas used to render subtitles.
858
859 @end table
860
861 @section Advanced options
862
863 @table @option
864 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
865
866 Designate one or more input streams as a source for the output file. Each input
867 stream is identified by the input file index @var{input_file_id} and
868 the input stream index @var{input_stream_id} within the input
869 file. Both indices start at 0. If specified,
870 @var{sync_file_id}:@var{stream_specifier} sets which input stream
871 is used as a presentation sync reference.
872
873 The first @code{-map} option on the command line specifies the
874 source for output stream 0, the second @code{-map} option specifies
875 the source for output stream 1, etc.
876
877 A @code{-} character before the stream identifier creates a "negative" mapping.
878 It disables matching streams from already created mappings.
879
880 An alternative @var{[linklabel]} form will map outputs from complex filter
881 graphs (see the @option{-filter_complex} option) to the output file.
882 @var{linklabel} must correspond to a defined output link label in the graph.
883
884 For example, to map ALL streams from the first input file to output
885 @example
886 ffmpeg -i INPUT -map 0 output
887 @end example
888
889 For example, if you have two audio streams in the first input file,
890 these streams are identified by "0:0" and "0:1". You can use
891 @code{-map} to select which streams to place in an output file. For
892 example:
893 @example
894 ffmpeg -i INPUT -map 0:1 out.wav
895 @end example
896 will map the input stream in @file{INPUT} identified by "0:1" to
897 the (single) output stream in @file{out.wav}.
898
899 For example, to select the stream with index 2 from input file
900 @file{a.mov} (specified by the identifier "0:2"), and stream with
901 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
902 and copy them to the output file @file{out.mov}:
903 @example
904 ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
905 @end example
906
907 To select all video and the third audio stream from an input file:
908 @example
909 ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
910 @end example
911
912 To map all the streams except the second audio, use negative mappings
913 @example
914 ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
915 @end example
916
917 To pick the English audio stream:
918 @example
919 ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
920 @end example
921
922 Note that using this option disables the default mappings for this output file.
923
924 @item -ignore_unknown
925 Ignore input streams with unknown type instead of failing if copying
926 such streams is attempted.
927
928 @item -copy_unknown
929 Allow input streams with unknown type to be copied instead of failing if copying
930 such streams is attempted.
931
932 @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][:@var{output_file_id}.@var{stream_specifier}]
933 Map an audio channel from a given input to an output. If
934 @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
935 be mapped on all the audio streams.
936
937 Using "-1" instead of
938 @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
939 channel.
940
941 For example, assuming @var{INPUT} is a stereo audio file, you can switch the
942 two audio channels with the following command:
943 @example
944 ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
945 @end example
946
947 If you want to mute the first channel and keep the second:
948 @example
949 ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
950 @end example
951
952 The order of the "-map_channel" option specifies the order of the channels in
953 the output stream. The output channel layout is guessed from the number of
954 channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
955 in combination of "-map_channel" makes the channel gain levels to be updated if
956 input and output channel layouts don't match (for instance two "-map_channel"
957 options and "-ac 6").
958
959 You can also extract each channel of an input to specific outputs; the following
960 command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
961 to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
962 @example
963 ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
964 @end example
965
966 The following example splits the channels of a stereo input into two separate
967 streams, which are put into the same output file:
968 @example
969 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
970 @end example
971
972 Note that currently each output stream can only contain channels from a single
973 input stream; you can't for example use "-map_channel" to pick multiple input
974 audio channels contained in different streams (from the same or different files)
975 and merge them into a single output stream. It is therefore not currently
976 possible, for example, to turn two separate mono streams into a single stereo
977 stream. However splitting a stereo stream into two single channel mono streams
978 is possible.
979
980 If you need this feature, a possible workaround is to use the @emph{amerge}
981 filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
982 mono audio streams into one single stereo channel audio stream (and keep the
983 video stream), you can use the following command:
984 @example
985 ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
986 @end example
987
988 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
989 Set metadata information of the next output file from @var{infile}. Note that
990 those are file indices (zero-based), not filenames.
991 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
992 A metadata specifier can have the following forms:
993 @table @option
994 @item @var{g}
995 global metadata, i.e. metadata that applies to the whole file
996
997 @item @var{s}[:@var{stream_spec}]
998 per-stream metadata. @var{stream_spec} is a stream specifier as described
999 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
1000 matching stream is copied from. In an output metadata specifier, all matching
1001 streams are copied to.
1002
1003 @item @var{c}:@var{chapter_index}
1004 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
1005
1006 @item @var{p}:@var{program_index}
1007 per-program metadata. @var{program_index} is the zero-based program index.
1008 @end table
1009 If metadata specifier is omitted, it defaults to global.
1010
1011 By default, global metadata is copied from the first input file,
1012 per-stream and per-chapter metadata is copied along with streams/chapters. These
1013 default mappings are disabled by creating any mapping of the relevant type. A negative
1014 file index can be used to create a dummy mapping that just disables automatic copying.
1015
1016 For example to copy metadata from the first stream of the input file to global metadata
1017 of the output file:
1018 @example
1019 ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
1020 @end example
1021
1022 To do the reverse, i.e. copy global metadata to all audio streams:
1023 @example
1024 ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
1025 @end example
1026 Note that simple @code{0} would work as well in this example, since global
1027 metadata is assumed by default.
1028
1029 @item -map_chapters @var{input_file_index} (@emph{output})
1030 Copy chapters from input file with index @var{input_file_index} to the next
1031 output file. If no chapter mapping is specified, then chapters are copied from
1032 the first input file with at least one chapter. Use a negative file index to
1033 disable any chapter copying.
1034
1035 @item -benchmark (@emph{global})
1036 Show benchmarking information at the end of an encode.
1037 Shows CPU time used and maximum memory consumption.
1038 Maximum memory consumption is not supported on all systems,
1039 it will usually display as 0 if not supported.
1040 @item -benchmark_all (@emph{global})
1041 Show benchmarking information during the encode.
1042 Shows CPU time used in various steps (audio/video encode/decode).
1043 @item -timelimit @var{duration} (@emph{global})
1044 Exit after ffmpeg has been running for @var{duration} seconds.
1045 @item -dump (@emph{global})
1046 Dump each input packet to stderr.
1047 @item -hex (@emph{global})
1048 When dumping packets, also dump the payload.
1049 @item -re (@emph{input})
1050 Read input at native frame rate. Mainly used to simulate a grab device,
1051 or live input stream (e.g. when reading from a file). Should not be used
1052 with actual grab devices or live input streams (where it can cause packet
1053 loss).
1054 By default @command{ffmpeg} attempts to read the input(s) as fast as possible.
1055 This option will slow down the reading of the input(s) to the native frame rate
1056 of the input(s). It is useful for real-time output (e.g. live streaming).
1057 @item -loop_input
1058 Loop over the input stream. Currently it works only for image
1059 streams. This option is used for automatic FFserver testing.
1060 This option is deprecated, use -loop 1.
1061 @item -loop_output @var{number_of_times}
1062 Repeatedly loop output for formats that support looping such as animated GIF
1063 (0 will loop the output infinitely).
1064 This option is deprecated, use -loop.
1065 @item -vsync @var{parameter}
1066 Video sync method.
1067 For compatibility reasons old values can be specified as numbers.
1068 Newly added values will have to be specified as strings always.
1069
1070 @table @option
1071 @item 0, passthrough
1072 Each frame is passed with its timestamp from the demuxer to the muxer.
1073 @item 1, cfr
1074 Frames will be duplicated and dropped to achieve exactly the requested
1075 constant frame rate.
1076 @item 2, vfr
1077 Frames are passed through with their timestamp or dropped so as to
1078 prevent 2 frames from having the same timestamp.
1079 @item drop
1080 As passthrough but destroys all timestamps, making the muxer generate
1081 fresh timestamps based on frame-rate.
1082 @item -1, auto
1083 Chooses between 1 and 2 depending on muxer capabilities. This is the
1084 default method.
1085 @end table
1086
1087 Note that the timestamps may be further modified by the muxer, after this.
1088 For example, in the case that the format option @option{avoid_negative_ts}
1089 is enabled.
1090
1091 With -map you can select from which stream the timestamps should be
1092 taken. You can leave either video or audio unchanged and sync the
1093 remaining stream(s) to the unchanged one.
1094
1095 @item -frame_drop_threshold @var{parameter}
1096 Frame drop threshold, which specifies how much behind video frames can
1097 be before they are dropped. In frame rate units, so 1.0 is one frame.
1098 The default is -1.1. One possible usecase is to avoid framedrops in case
1099 of noisy timestamps or to increase frame drop precision in case of exact
1100 timestamps.
1101
1102 @item -async @var{samples_per_second}
1103 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
1104 the parameter is the maximum samples per second by which the audio is changed.
1105 -async 1 is a special case where only the start of the audio stream is corrected
1106 without any later correction.
1107
1108 Note that the timestamps may be further modified by the muxer, after this.
1109 For example, in the case that the format option @option{avoid_negative_ts}
1110 is enabled.
1111
1112 This option has been deprecated. Use the @code{aresample} audio filter instead.
1113
1114 @item -copyts
1115 Do not process input timestamps, but keep their values without trying
1116 to sanitize them. In particular, do not remove the initial start time
1117 offset value.
1118
1119 Note that, depending on the @option{vsync} option or on specific muxer
1120 processing (e.g. in case the format option @option{avoid_negative_ts}
1121 is enabled) the output timestamps may mismatch with the input
1122 timestamps even when this option is selected.
1123
1124 @item -start_at_zero
1125 When used with @option{copyts}, shift input timestamps so they start at zero.
1126
1127 This means that using e.g. @code{-ss 50} will make output timestamps start at
1128 50 seconds, regardless of what timestamp the input file started at.
1129
1130 @item -copytb @var{mode}
1131 Specify how to set the encoder timebase when stream copying.  @var{mode} is an
1132 integer numeric value, and can assume one of the following values:
1133
1134 @table @option
1135 @item 1
1136 Use the demuxer timebase.
1137
1138 The time base is copied to the output encoder from the corresponding input
1139 demuxer. This is sometimes required to avoid non monotonically increasing
1140 timestamps when copying video streams with variable frame rate.
1141
1142 @item 0
1143 Use the decoder timebase.
1144
1145 The time base is copied to the output encoder from the corresponding input
1146 decoder.
1147
1148 @item -1
1149 Try to make the choice automatically, in order to generate a sane output.
1150 @end table
1151
1152 Default value is -1.
1153
1154 @item -shortest (@emph{output})
1155 Finish encoding when the shortest input stream ends.
1156 @item -dts_delta_threshold
1157 Timestamp discontinuity delta threshold.
1158 @item -muxdelay @var{seconds} (@emph{input})
1159 Set the maximum demux-decode delay.
1160 @item -muxpreload @var{seconds} (@emph{input})
1161 Set the initial demux-decode delay.
1162 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
1163 Assign a new stream-id value to an output stream. This option should be
1164 specified prior to the output filename to which it applies.
1165 For the situation where multiple output files exist, a streamid
1166 may be reassigned to a different value.
1167
1168 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
1169 an output mpegts file:
1170 @example
1171 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
1172 @end example
1173
1174 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
1175 Set bitstream filters for matching streams. @var{bitstream_filters} is
1176 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
1177 to get the list of bitstream filters.
1178 @example
1179 ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
1180 @end example
1181 @example
1182 ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
1183 @end example
1184
1185 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{input/output,per-stream})
1186 Force a tag/fourcc for matching streams.
1187
1188 @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
1189 Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
1190 (or '.') for drop.
1191 @example
1192 ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
1193 @end example
1194
1195 @anchor{filter_complex_option}
1196 @item -filter_complex @var{filtergraph} (@emph{global})
1197 Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1198 outputs. For simple graphs -- those with one input and one output of the same
1199 type -- see the @option{-filter} options. @var{filtergraph} is a description of
1200 the filtergraph, as described in the ``Filtergraph syntax'' section of the
1201 ffmpeg-filters manual.
1202
1203 Input link labels must refer to input streams using the
1204 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
1205 uses). If @var{stream_specifier} matches multiple streams, the first one will be
1206 used. An unlabeled input will be connected to the first unused input stream of
1207 the matching type.
1208
1209 Output link labels are referred to with @option{-map}. Unlabeled outputs are
1210 added to the first output file.
1211
1212 Note that with this option it is possible to use only lavfi sources without
1213 normal input files.
1214
1215 For example, to overlay an image over video
1216 @example
1217 ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
1218 '[out]' out.mkv
1219 @end example
1220 Here @code{[0:v]} refers to the first video stream in the first input file,
1221 which is linked to the first (main) input of the overlay filter. Similarly the
1222 first video stream in the second input is linked to the second (overlay) input
1223 of overlay.
1224
1225 Assuming there is only one video stream in each input file, we can omit input
1226 labels, so the above is equivalent to
1227 @example
1228 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
1229 '[out]' out.mkv
1230 @end example
1231
1232 Furthermore we can omit the output label and the single output from the filter
1233 graph will be added to the output file automatically, so we can simply write
1234 @example
1235 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
1236 @end example
1237
1238 To generate 5 seconds of pure red video using lavfi @code{color} source:
1239 @example
1240 ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
1241 @end example
1242
1243 @item -filter_complex_threads @var{nb_threads} (@emph{global})
1244 Defines how many threads are used to process a filter_complex graph.
1245 Similar to filter_threads but used for @code{-filter_complex} graphs only.
1246 The default is the number of available CPUs.
1247
1248 @item -lavfi @var{filtergraph} (@emph{global})
1249 Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1250 outputs. Equivalent to @option{-filter_complex}.
1251
1252 @item -filter_complex_script @var{filename} (@emph{global})
1253 This option is similar to @option{-filter_complex}, the only difference is that
1254 its argument is the name of the file from which a complex filtergraph
1255 description is to be read.
1256
1257 @item -accurate_seek (@emph{input})
1258 This option enables or disables accurate seeking in input files with the
1259 @option{-ss} option. It is enabled by default, so seeking is accurate when
1260 transcoding. Use @option{-noaccurate_seek} to disable it, which may be useful
1261 e.g. when copying some streams and transcoding the others.
1262
1263 @item -seek_timestamp (@emph{input})
1264 This option enables or disables seeking by timestamp in input files with the
1265 @option{-ss} option. It is disabled by default. If enabled, the argument
1266 to the @option{-ss} option is considered an actual timestamp, and is not
1267 offset by the start time of the file. This matters only for files which do
1268 not start from timestamp 0, such as transport streams.
1269
1270 @item -thread_queue_size @var{size} (@emph{input})
1271 This option sets the maximum number of queued packets when reading from the
1272 file or device. With low latency / high rate live streams, packets may be
1273 discarded if they are not read in a timely manner; raising this value can
1274 avoid it.
1275
1276 @item -override_ffserver (@emph{global})
1277 Overrides the input specifications from @command{ffserver}. Using this
1278 option you can map any input stream to @command{ffserver} and control
1279 many aspects of the encoding from @command{ffmpeg}. Without this
1280 option @command{ffmpeg} will transmit to @command{ffserver} what is
1281 requested by @command{ffserver}.
1282
1283 The option is intended for cases where features are needed that cannot be
1284 specified to @command{ffserver} but can be to @command{ffmpeg}.
1285
1286 @item -sdp_file @var{file} (@emph{global})
1287 Print sdp information for an output stream to @var{file}.
1288 This allows dumping sdp information when at least one output isn't an
1289 rtp stream. (Requires at least one of the output formats to be rtp).
1290
1291 @item -discard (@emph{input})
1292 Allows discarding specific streams or frames of streams at the demuxer.
1293 Not all demuxers support this.
1294
1295 @table @option
1296 @item none
1297 Discard no frame.
1298
1299 @item default
1300 Default, which discards no frames.
1301
1302 @item noref
1303 Discard all non-reference frames.
1304
1305 @item bidir
1306 Discard all bidirectional frames.
1307
1308 @item nokey
1309 Discard all frames excepts keyframes.
1310
1311 @item all
1312 Discard all frames.
1313 @end table
1314
1315 @item -abort_on @var{flags} (@emph{global})
1316 Stop and abort on various conditions. The following flags are available:
1317
1318 @table @option
1319 @item empty_output
1320 No packets were passed to the muxer, the output is empty.
1321 @end table
1322
1323 @item -xerror (@emph{global})
1324 Stop and exit on error
1325
1326 @item -max_muxing_queue_size @var{packets} (@emph{output,per-stream})
1327 When transcoding audio and/or video streams, ffmpeg will not begin writing into
1328 the output until it has one packet for each such stream. While waiting for that
1329 to happen, packets for other streams are buffered. This option sets the size of
1330 this buffer, in packets, for the matching output stream.
1331
1332 The default value of this option should be high enough for most uses, so only
1333 touch this option if you are sure that you need it.
1334
1335 @end table
1336
1337 As a special exception, you can use a bitmap subtitle stream as input: it
1338 will be converted into a video with the same size as the largest video in
1339 the file, or 720x576 if no video is present. Note that this is an
1340 experimental and temporary solution. It will be removed once libavfilter has
1341 proper support for subtitles.
1342
1343 For example, to hardcode subtitles on top of a DVB-T recording stored in
1344 MPEG-TS format, delaying the subtitles by 1 second:
1345 @example
1346 ffmpeg -i input.ts -filter_complex \
1347   '[#0x2ef] setpts=PTS+1/TB [sub] ; [#0x2d0] [sub] overlay' \
1348   -sn -map '#0x2dc' output.mkv
1349 @end example
1350 (0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video,
1351 audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too)
1352
1353 @section Preset files
1354 A preset file contains a sequence of @var{option}=@var{value} pairs,
1355 one for each line, specifying a sequence of options which would be
1356 awkward to specify on the command line. Lines starting with the hash
1357 ('#') character are ignored and are used to provide comments. Check
1358 the @file{presets} directory in the FFmpeg source tree for examples.
1359
1360 There are two types of preset files: ffpreset and avpreset files.
1361
1362 @subsection ffpreset files
1363 ffpreset files are specified with the @code{vpre}, @code{apre},
1364 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
1365 filename of the preset instead of a preset name as input and can be
1366 used for any kind of codec. For the @code{vpre}, @code{apre}, and
1367 @code{spre} options, the options specified in a preset file are
1368 applied to the currently selected codec of the same type as the preset
1369 option.
1370
1371 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
1372 preset options identifies the preset file to use according to the
1373 following rules:
1374
1375 First ffmpeg searches for a file named @var{arg}.ffpreset in the
1376 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
1377 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
1378 or in a @file{ffpresets} folder along the executable on win32,
1379 in that order. For example, if the argument is @code{libvpx-1080p}, it will
1380 search for the file @file{libvpx-1080p.ffpreset}.
1381
1382 If no such file is found, then ffmpeg will search for a file named
1383 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
1384 directories, where @var{codec_name} is the name of the codec to which
1385 the preset file options will be applied. For example, if you select
1386 the video codec with @code{-vcodec libvpx} and use @code{-vpre 1080p},
1387 then it will search for the file @file{libvpx-1080p.ffpreset}.
1388
1389 @subsection avpreset files
1390 avpreset files are specified with the @code{pre} option. They work similar to
1391 ffpreset files, but they only allow encoder- specific options. Therefore, an
1392 @var{option}=@var{value} pair specifying an encoder cannot be used.
1393
1394 When the @code{pre} option is specified, ffmpeg will look for files with the
1395 suffix .avpreset in the directories @file{$AVCONV_DATADIR} (if set), and
1396 @file{$HOME/.avconv}, and in the datadir defined at configuration time (usually
1397 @file{PREFIX/share/ffmpeg}), in that order.
1398
1399 First ffmpeg searches for a file named @var{codec_name}-@var{arg}.avpreset in
1400 the above-mentioned directories, where @var{codec_name} is the name of the codec
1401 to which the preset file options will be applied. For example, if you select the
1402 video codec with @code{-vcodec libvpx} and use @code{-pre 1080p}, then it will
1403 search for the file @file{libvpx-1080p.avpreset}.
1404
1405 If no such file is found, then ffmpeg will search for a file named
1406 @var{arg}.avpreset in the same directories.
1407
1408 @c man end OPTIONS
1409
1410 @chapter Examples
1411 @c man begin EXAMPLES
1412
1413 @section Video and Audio grabbing
1414
1415 If you specify the input format and device then ffmpeg can grab video
1416 and audio directly.
1417
1418 @example
1419 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
1420 @end example
1421
1422 Or with an ALSA audio source (mono input, card id 1) instead of OSS:
1423 @example
1424 ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
1425 @end example
1426
1427 Note that you must activate the right video source and channel before
1428 launching ffmpeg with any TV viewer such as
1429 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
1430 have to set the audio recording levels correctly with a
1431 standard mixer.
1432
1433 @section X11 grabbing
1434
1435 Grab the X11 display with ffmpeg via
1436
1437 @example
1438 ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
1439 @end example
1440
1441 0.0 is display.screen number of your X11 server, same as
1442 the DISPLAY environment variable.
1443
1444 @example
1445 ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
1446 @end example
1447
1448 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
1449 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
1450
1451 @section Video and Audio file format conversion
1452
1453 Any supported file format and protocol can serve as input to ffmpeg:
1454
1455 Examples:
1456 @itemize
1457 @item
1458 You can use YUV files as input:
1459
1460 @example
1461 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
1462 @end example
1463
1464 It will use the files:
1465 @example
1466 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
1467 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
1468 @end example
1469
1470 The Y files use twice the resolution of the U and V files. They are
1471 raw files, without header. They can be generated by all decent video
1472 decoders. You must specify the size of the image with the @option{-s} option
1473 if ffmpeg cannot guess it.
1474
1475 @item
1476 You can input from a raw YUV420P file:
1477
1478 @example
1479 ffmpeg -i /tmp/test.yuv /tmp/out.avi
1480 @end example
1481
1482 test.yuv is a file containing raw YUV planar data. Each frame is composed
1483 of the Y plane followed by the U and V planes at half vertical and
1484 horizontal resolution.
1485
1486 @item
1487 You can output to a raw YUV420P file:
1488
1489 @example
1490 ffmpeg -i mydivx.avi hugefile.yuv
1491 @end example
1492
1493 @item
1494 You can set several input files and output files:
1495
1496 @example
1497 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
1498 @end example
1499
1500 Converts the audio file a.wav and the raw YUV video file a.yuv
1501 to MPEG file a.mpg.
1502
1503 @item
1504 You can also do audio and video conversions at the same time:
1505
1506 @example
1507 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1508 @end example
1509
1510 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1511
1512 @item
1513 You can encode to several formats at the same time and define a
1514 mapping from input stream to output streams:
1515
1516 @example
1517 ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
1518 @end example
1519
1520 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1521 file:index' specifies which input stream is used for each output
1522 stream, in the order of the definition of output streams.
1523
1524 @item
1525 You can transcode decrypted VOBs:
1526
1527 @example
1528 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
1529 @end example
1530
1531 This is a typical DVD ripping example; the input is a VOB file, the
1532 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1533 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1534 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1535 input video. Furthermore, the audio stream is MP3-encoded so you need
1536 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1537 The mapping is particularly useful for DVD transcoding
1538 to get the desired audio language.
1539
1540 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
1541
1542 @item
1543 You can extract images from a video, or create a video from many images:
1544
1545 For extracting images from a video:
1546 @example
1547 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1548 @end example
1549
1550 This will extract one video frame per second from the video and will
1551 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1552 etc. Images will be rescaled to fit the new WxH values.
1553
1554 If you want to extract just a limited number of frames, you can use the
1555 above command in combination with the -vframes or -t option, or in
1556 combination with -ss to start extracting from a certain point in time.
1557
1558 For creating a video from many images:
1559 @example
1560 ffmpeg -f image2 -framerate 12 -i foo-%03d.jpeg -s WxH foo.avi
1561 @end example
1562
1563 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1564 composed of three digits padded with zeroes to express the sequence
1565 number. It is the same syntax supported by the C printf function, but
1566 only formats accepting a normal integer are suitable.
1567
1568 When importing an image sequence, -i also supports expanding
1569 shell-like wildcard patterns (globbing) internally, by selecting the
1570 image2-specific @code{-pattern_type glob} option.
1571
1572 For example, for creating a video from filenames matching the glob pattern
1573 @code{foo-*.jpeg}:
1574 @example
1575 ffmpeg -f image2 -pattern_type glob -framerate 12 -i 'foo-*.jpeg' -s WxH foo.avi
1576 @end example
1577
1578 @item
1579 You can put many streams of the same type in the output:
1580
1581 @example
1582 ffmpeg -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
1583 @end example
1584
1585 The resulting output file @file{test12.nut} will contain the first four streams
1586 from the input files in reverse order.
1587
1588 @item
1589 To force CBR video output:
1590 @example
1591 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1592 @end example
1593
1594 @item
1595 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
1596 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
1597 @example
1598 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
1599 @end example
1600
1601 @end itemize
1602 @c man end EXAMPLES
1603
1604 @include config.texi
1605 @ifset config-all
1606 @ifset config-avutil
1607 @include utils.texi
1608 @end ifset
1609 @ifset config-avcodec
1610 @include codecs.texi
1611 @include bitstream_filters.texi
1612 @end ifset
1613 @ifset config-avformat
1614 @include formats.texi
1615 @include protocols.texi
1616 @end ifset
1617 @ifset config-avdevice
1618 @include devices.texi
1619 @end ifset
1620 @ifset config-swresample
1621 @include resampler.texi
1622 @end ifset
1623 @ifset config-swscale
1624 @include scaler.texi
1625 @end ifset
1626 @ifset config-avfilter
1627 @include filters.texi
1628 @end ifset
1629 @end ifset
1630
1631 @chapter See Also
1632
1633 @ifhtml
1634 @ifset config-all
1635 @url{ffmpeg.html,ffmpeg}
1636 @end ifset
1637 @ifset config-not-all
1638 @url{ffmpeg-all.html,ffmpeg-all},
1639 @end ifset
1640 @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
1641 @url{ffmpeg-utils.html,ffmpeg-utils},
1642 @url{ffmpeg-scaler.html,ffmpeg-scaler},
1643 @url{ffmpeg-resampler.html,ffmpeg-resampler},
1644 @url{ffmpeg-codecs.html,ffmpeg-codecs},
1645 @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
1646 @url{ffmpeg-formats.html,ffmpeg-formats},
1647 @url{ffmpeg-devices.html,ffmpeg-devices},
1648 @url{ffmpeg-protocols.html,ffmpeg-protocols},
1649 @url{ffmpeg-filters.html,ffmpeg-filters}
1650 @end ifhtml
1651
1652 @ifnothtml
1653 @ifset config-all
1654 ffmpeg(1),
1655 @end ifset
1656 @ifset config-not-all
1657 ffmpeg-all(1),
1658 @end ifset
1659 ffplay(1), ffprobe(1), ffserver(1),
1660 ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
1661 ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
1662 ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
1663 @end ifnothtml
1664
1665 @include authors.texi
1666
1667 @ignore
1668
1669 @setfilename ffmpeg
1670 @settitle ffmpeg video converter
1671
1672 @end ignore
1673
1674 @bye