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