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