doc/ffmpeg: Document opencl for -init_hw_device
[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 captions
379 @item descriptions
380 @item metadata
381 @end table
382
383 For example, to make the second audio stream the default stream:
384 @example
385 ffmpeg -i in.mkv -disposition:a:1 default out.mkv
386 @end example
387
388 To make the second subtitle stream the default stream and remove the default
389 disposition from the first subtitle stream:
390 @example
391 ffmpeg -i INPUT -disposition:s:0 0 -disposition:s:1 default OUTPUT
392 @end example
393
394 @item -program [title=@var{title}:][program_num=@var{program_num}:]st=@var{stream}[:st=@var{stream}...] (@emph{output})
395
396 Creates a program with the specified @var{title}, @var{program_num} and adds the specified
397 @var{stream}(s) to it.
398
399 @item -target @var{type} (@emph{output})
400 Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
401 @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
402 @code{film-} to use the corresponding standard. All the format options
403 (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
404
405 @example
406 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
407 @end example
408
409 Nevertheless you can specify additional options as long as you know
410 they do not conflict with the standard, as in:
411
412 @example
413 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
414 @end example
415
416 @item -dframes @var{number} (@emph{output})
417 Set the number of data frames to output. This is an obsolete alias for
418 @code{-frames:d}, which you should use instead.
419
420 @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
421 Stop writing to the stream after @var{framecount} frames.
422
423 @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
424 @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
425 Use fixed quality scale (VBR). The meaning of @var{q}/@var{qscale} is
426 codec-dependent.
427 If @var{qscale} is used without a @var{stream_specifier} then it applies only
428 to the video stream, this is to maintain compatibility with previous behavior
429 and as specifying the same codec specific value to 2 different codecs that is
430 audio and video generally is not what is intended when no stream_specifier is
431 used.
432
433 @anchor{filter_option}
434 @item -filter[:@var{stream_specifier}] @var{filtergraph} (@emph{output,per-stream})
435 Create the filtergraph specified by @var{filtergraph} and use it to
436 filter the stream.
437
438 @var{filtergraph} is a description of the filtergraph to apply to
439 the stream, and must have a single input and a single output of the
440 same type of the stream. In the filtergraph, the input is associated
441 to the label @code{in}, and the output to the label @code{out}. See
442 the ffmpeg-filters manual for more information about the filtergraph
443 syntax.
444
445 See the @ref{filter_complex_option,,-filter_complex option} if you
446 want to create filtergraphs with multiple inputs and/or outputs.
447
448 @item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
449 This option is similar to @option{-filter}, the only difference is that its
450 argument is the name of the file from which a filtergraph description is to be
451 read.
452
453 @item -filter_threads @var{nb_threads} (@emph{global})
454 Defines how many threads are used to process a filter pipeline. Each pipeline
455 will produce a thread pool with this many threads available for parallel processing.
456 The default is the number of available CPUs.
457
458 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
459 Specify the preset for matching stream(s).
460
461 @item -stats (@emph{global})
462 Print encoding progress/statistics. It is on by default, to explicitly
463 disable it you need to specify @code{-nostats}.
464
465 @item -progress @var{url} (@emph{global})
466 Send program-friendly progress information to @var{url}.
467
468 Progress information is written approximately every second and at the end of
469 the encoding process. It is made of "@var{key}=@var{value}" lines. @var{key}
470 consists of only alphanumeric characters. The last key of a sequence of
471 progress information is always "progress".
472
473 @anchor{stdin option}
474 @item -stdin
475 Enable interaction on standard input. On by default unless standard input is
476 used as an input. To explicitly disable interaction you need to specify
477 @code{-nostdin}.
478
479 Disabling interaction on standard input is useful, for example, if
480 ffmpeg is in the background process group. Roughly the same result can
481 be achieved with @code{ffmpeg ... < /dev/null} but it requires a
482 shell.
483
484 @item -debug_ts (@emph{global})
485 Print timestamp information. It is off by default. This option is
486 mostly useful for testing and debugging purposes, and the output
487 format may change from one version to another, so it should not be
488 employed by portable scripts.
489
490 See also the option @code{-fdebug ts}.
491
492 @item -attach @var{filename} (@emph{output})
493 Add an attachment to the output file. This is supported by a few formats
494 like Matroska for e.g. fonts used in rendering subtitles. Attachments
495 are implemented as a specific type of stream, so this option will add
496 a new stream to the file. It is then possible to use per-stream options
497 on this stream in the usual way. Attachment streams created with this
498 option will be created after all the other streams (i.e. those created
499 with @code{-map} or automatic mappings).
500
501 Note that for Matroska you also have to set the mimetype metadata tag:
502 @example
503 ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
504 @end example
505 (assuming that the attachment stream will be third in the output file).
506
507 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
508 Extract the matching attachment stream into a file named @var{filename}. If
509 @var{filename} is empty, then the value of the @code{filename} metadata tag
510 will be used.
511
512 E.g. to extract the first attachment to a file named 'out.ttf':
513 @example
514 ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
515 @end example
516 To extract all attachments to files determined by the @code{filename} tag:
517 @example
518 ffmpeg -dump_attachment:t "" -i INPUT
519 @end example
520
521 Technical note -- attachments are implemented as codec extradata, so this
522 option can actually be used to extract extradata from any stream, not just
523 attachments.
524
525 @item -noautorotate
526 Disable automatically rotating video based on file metadata.
527
528 @end table
529
530 @section Video Options
531
532 @table @option
533 @item -vframes @var{number} (@emph{output})
534 Set the number of video frames to output. This is an obsolete alias for
535 @code{-frames:v}, which you should use instead.
536 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
537 Set frame rate (Hz value, fraction or abbreviation).
538
539 As an input option, ignore any timestamps stored in the file and instead
540 generate timestamps assuming constant frame rate @var{fps}.
541 This is not the same as the @option{-framerate} option used for some input formats
542 like image2 or v4l2 (it used to be the same in older versions of FFmpeg).
543 If in doubt use @option{-framerate} instead of the input option @option{-r}.
544
545 As an output option, duplicate or drop input frames to achieve constant output
546 frame rate @var{fps}.
547
548 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
549 Set frame size.
550
551 As an input option, this is a shortcut for the @option{video_size} private
552 option, recognized by some demuxers for which the frame size is either not
553 stored in the file or is configurable -- e.g. raw video or video grabbers.
554
555 As an output option, this inserts the @code{scale} video filter to the
556 @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
557 directly to insert it at the beginning or some other place.
558
559 The format is @samp{wxh} (default - same as source).
560
561 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
562 Set the video display aspect ratio specified by @var{aspect}.
563
564 @var{aspect} can be a floating point number string, or a string of the
565 form @var{num}:@var{den}, where @var{num} and @var{den} are the
566 numerator and denominator of the aspect ratio. For example "4:3",
567 "16:9", "1.3333", and "1.7777" are valid argument values.
568
569 If used together with @option{-vcodec copy}, it will affect the aspect ratio
570 stored at container level, but not the aspect ratio stored in encoded
571 frames, if it exists.
572
573 @item -vn (@emph{output})
574 Disable video recording.
575
576 @item -vcodec @var{codec} (@emph{output})
577 Set the video codec. This is an alias for @code{-codec:v}.
578
579 @item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
580 Select the pass number (1 or 2). It is used to do two-pass
581 video encoding. The statistics of the video are recorded in the first
582 pass into a log file (see also the option -passlogfile),
583 and in the second pass that log file is used to generate the video
584 at the exact requested bitrate.
585 On pass 1, you may just deactivate audio and set output to null,
586 examples for Windows and Unix:
587 @example
588 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
589 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
590 @end example
591
592 @item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
593 Set two-pass log file name prefix to @var{prefix}, the default file name
594 prefix is ``ffmpeg2pass''. The complete file name will be
595 @file{PREFIX-N.log}, where N is a number specific to the output
596 stream
597
598 @item -vf @var{filtergraph} (@emph{output})
599 Create the filtergraph specified by @var{filtergraph} and use it to
600 filter the stream.
601
602 This is an alias for @code{-filter:v}, see the @ref{filter_option,,-filter option}.
603 @end table
604
605 @section Advanced Video options
606
607 @table @option
608 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
609 Set pixel format. Use @code{-pix_fmts} to show all the supported
610 pixel formats.
611 If the selected pixel format can not be selected, ffmpeg will print a
612 warning and select the best pixel format supported by the encoder.
613 If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
614 if the requested pixel format can not be selected, and automatic conversions
615 inside filtergraphs are disabled.
616 If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
617 as the input (or graph output) and automatic conversions are disabled.
618
619 @item -sws_flags @var{flags} (@emph{input/output})
620 Set SwScaler flags.
621 @item -vdt @var{n}
622 Discard threshold.
623
624 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
625 Rate control override for specific intervals, formatted as "int,int,int"
626 list separated with slashes. Two first values are the beginning and
627 end frame numbers, last one is quantizer to use if positive, or quality
628 factor if negative.
629
630 @item -ilme
631 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
632 Use this option if your input file is interlaced and you want
633 to keep the interlaced format for minimum losses.
634 The alternative is to deinterlace the input stream with
635 @option{-deinterlace}, but deinterlacing introduces losses.
636 @item -psnr
637 Calculate PSNR of compressed frames.
638 @item -vstats
639 Dump video coding statistics to @file{vstats_HHMMSS.log}.
640 @item -vstats_file @var{file}
641 Dump video coding statistics to @var{file}.
642 @item -vstats_version @var{file}
643 Specifies which version of the vstats format to use. Default is 2.
644
645 version = 1 :
646
647 @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}
648
649 version > 1:
650
651 @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}
652 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
653 top=1/bottom=0/auto=-1 field first
654 @item -dc @var{precision}
655 Intra_dc_precision.
656 @item -vtag @var{fourcc/tag} (@emph{output})
657 Force video tag/fourcc. This is an alias for @code{-tag:v}.
658 @item -qphist (@emph{global})
659 Show QP histogram
660 @item -vbsf @var{bitstream_filter}
661 Deprecated see -bsf
662
663 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
664 @item -force_key_frames[:@var{stream_specifier}] expr:@var{expr} (@emph{output,per-stream})
665 Force key frames at the specified timestamps, more precisely at the first
666 frames after each specified time.
667
668 If the argument is prefixed with @code{expr:}, the string @var{expr}
669 is interpreted like an expression and is evaluated for each frame. A
670 key frame is forced in case the evaluation is non-zero.
671
672 If one of the times is "@code{chapters}[@var{delta}]", it is expanded into
673 the time of the beginning of all chapters in the file, shifted by
674 @var{delta}, expressed as a time in seconds.
675 This option can be useful to ensure that a seek point is present at a
676 chapter mark or any other designated place in the output file.
677
678 For example, to insert a key frame at 5 minutes, plus key frames 0.1 second
679 before the beginning of every chapter:
680 @example
681 -force_key_frames 0:05:00,chapters-0.1
682 @end example
683
684 The expression in @var{expr} can contain the following constants:
685 @table @option
686 @item n
687 the number of current processed frame, starting from 0
688 @item n_forced
689 the number of forced frames
690 @item prev_forced_n
691 the number of the previous forced frame, it is @code{NAN} when no
692 keyframe was forced yet
693 @item prev_forced_t
694 the time of the previous forced frame, it is @code{NAN} when no
695 keyframe was forced yet
696 @item t
697 the time of the current processed frame
698 @end table
699
700 For example to force a key frame every 5 seconds, you can specify:
701 @example
702 -force_key_frames expr:gte(t,n_forced*5)
703 @end example
704
705 To force a key frame 5 seconds after the time of the last forced one,
706 starting from second 13:
707 @example
708 -force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
709 @end example
710
711 Note that forcing too many keyframes is very harmful for the lookahead
712 algorithms of certain encoders: using fixed-GOP options or similar
713 would be more efficient.
714
715 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
716 When doing stream copy, copy also non-key frames found at the
717 beginning.
718
719 @item -init_hw_device @var{type}[=@var{name}][:@var{device}[,@var{key=value}...]]
720 Initialise a new hardware device of type @var{type} called @var{name}, using the
721 given device parameters.
722 If no name is specified it will receive a default name of the form "@var{type}%d".
723
724 The meaning of @var{device} and the following arguments depends on the
725 device type:
726 @table @option
727
728 @item cuda
729 @var{device} is the number of the CUDA device.
730
731 @item dxva2
732 @var{device} is the number of the Direct3D 9 display adapter.
733
734 @item vaapi
735 @var{device} is either an X11 display name or a DRM render node.
736 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY})
737 and then the first DRM render node (@emph{/dev/dri/renderD128}).
738
739 @item vdpau
740 @var{device} is an X11 display name.
741 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY}).
742
743 @item qsv
744 @var{device} selects a value in @samp{MFX_IMPL_*}. Allowed values are:
745 @table @option
746 @item auto
747 @item sw
748 @item hw
749 @item auto_any
750 @item hw_any
751 @item hw2
752 @item hw3
753 @item hw4
754 @end table
755 If not specified, @samp{auto_any} is used.
756 (Note that it may be easier to achieve the desired result for QSV by creating the
757 platform-appropriate subdevice (@samp{dxva2} or @samp{vaapi}) and then deriving a
758 QSV device from that.)
759
760 @item opencl
761 @var{device} selects the platform and device as @emph{platform_index.device_index}.
762
763 The set of devices can also be filtered using the key-value pairs to find only
764 devices matching particular platform or device strings.
765
766 The strings usable as filters are:
767 @table @option
768 @item platform_profile
769 @item platform_version
770 @item platform_name
771 @item platform_vendor
772 @item platform_extensions
773 @item device_name
774 @item device_vendor
775 @item driver_version
776 @item device_version
777 @item device_profile
778 @item device_extensions
779 @item device_type
780 @end table
781
782 The indices and filters must together uniquely select a device.
783
784 Examples:
785 @table @emph
786 @item -init_hw_device opencl:0.1
787 Choose the second device on the first platform.
788
789 @item -init_hw_device opencl:,device_name=Foo9000
790 Choose the device with a name containing the string @emph{Foo9000}.
791
792 @item -init_hw_device opencl:1,device_type=gpu,device_extensions=cl_khr_fp16
793 Choose the GPU device on the second platform supporting the @emph{cl_khr_fp16}
794 extension.
795 @end table
796
797 @end table
798
799 @item -init_hw_device @var{type}[=@var{name}]@@@var{source}
800 Initialise a new hardware device of type @var{type} called @var{name},
801 deriving it from the existing device with the name @var{source}.
802
803 @item -init_hw_device list
804 List all hardware device types supported in this build of ffmpeg.
805
806 @item -filter_hw_device @var{name}
807 Pass the hardware device called @var{name} to all filters in any filter graph.
808 This can be used to set the device to upload to with the @code{hwupload} filter,
809 or the device to map to with the @code{hwmap} filter.  Other filters may also
810 make use of this parameter when they require a hardware device.  Note that this
811 is typically only required when the input is not already in hardware frames -
812 when it is, filters will derive the device they require from the context of the
813 frames they receive as input.
814
815 This is a global setting, so all filters will receive the same device.
816
817 @item -hwaccel[:@var{stream_specifier}] @var{hwaccel} (@emph{input,per-stream})
818 Use hardware acceleration to decode the matching stream(s). The allowed values
819 of @var{hwaccel} are:
820 @table @option
821 @item none
822 Do not use any hardware acceleration (the default).
823
824 @item auto
825 Automatically select the hardware acceleration method.
826
827 @item vdpau
828 Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration.
829
830 @item dxva2
831 Use DXVA2 (DirectX Video Acceleration) hardware acceleration.
832
833 @item vaapi
834 Use VAAPI (Video Acceleration API) hardware acceleration.
835
836 @item qsv
837 Use the Intel QuickSync Video acceleration for video transcoding.
838
839 Unlike most other values, this option does not enable accelerated decoding (that
840 is used automatically whenever a qsv decoder is selected), but accelerated
841 transcoding, without copying the frames into the system memory.
842
843 For it to work, both the decoder and the encoder must support QSV acceleration
844 and no filters must be used.
845 @end table
846
847 This option has no effect if the selected hwaccel is not available or not
848 supported by the chosen decoder.
849
850 Note that most acceleration methods are intended for playback and will not be
851 faster than software decoding on modern CPUs. Additionally, @command{ffmpeg}
852 will usually need to copy the decoded frames from the GPU memory into the system
853 memory, resulting in further performance loss. This option is thus mainly
854 useful for testing.
855
856 @item -hwaccel_device[:@var{stream_specifier}] @var{hwaccel_device} (@emph{input,per-stream})
857 Select a device to use for hardware acceleration.
858
859 This option only makes sense when the @option{-hwaccel} option is also specified.
860 It can either refer to an existing device created with @option{-init_hw_device}
861 by name, or it can create a new device as if
862 @samp{-init_hw_device} @var{type}:@var{hwaccel_device}
863 were called immediately before.
864
865 @item -hwaccels
866 List all hardware acceleration methods supported in this build of ffmpeg.
867
868 @end table
869
870 @section Audio Options
871
872 @table @option
873 @item -aframes @var{number} (@emph{output})
874 Set the number of audio frames to output. This is an obsolete alias for
875 @code{-frames:a}, which you should use instead.
876 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
877 Set the audio sampling frequency. For output streams it is set by
878 default to the frequency of the corresponding input stream. For input
879 streams this option only makes sense for audio grabbing devices and raw
880 demuxers and is mapped to the corresponding demuxer options.
881 @item -aq @var{q} (@emph{output})
882 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
883 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
884 Set the number of audio channels. For output streams it is set by
885 default to the number of input audio channels. For input streams
886 this option only makes sense for audio grabbing devices and raw demuxers
887 and is mapped to the corresponding demuxer options.
888 @item -an (@emph{output})
889 Disable audio recording.
890 @item -acodec @var{codec} (@emph{input/output})
891 Set the audio codec. This is an alias for @code{-codec:a}.
892 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
893 Set the audio sample format. Use @code{-sample_fmts} to get a list
894 of supported sample formats.
895
896 @item -af @var{filtergraph} (@emph{output})
897 Create the filtergraph specified by @var{filtergraph} and use it to
898 filter the stream.
899
900 This is an alias for @code{-filter:a}, see the @ref{filter_option,,-filter option}.
901 @end table
902
903 @section Advanced Audio options
904
905 @table @option
906 @item -atag @var{fourcc/tag} (@emph{output})
907 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
908 @item -absf @var{bitstream_filter}
909 Deprecated, see -bsf
910 @item -guess_layout_max @var{channels} (@emph{input,per-stream})
911 If some input channel layout is not known, try to guess only if it
912 corresponds to at most the specified number of channels. For example, 2
913 tells to @command{ffmpeg} to recognize 1 channel as mono and 2 channels as
914 stereo but not 6 channels as 5.1. The default is to always try to guess. Use
915 0 to disable all guessing.
916 @end table
917
918 @section Subtitle options
919
920 @table @option
921 @item -scodec @var{codec} (@emph{input/output})
922 Set the subtitle codec. This is an alias for @code{-codec:s}.
923 @item -sn (@emph{output})
924 Disable subtitle recording.
925 @item -sbsf @var{bitstream_filter}
926 Deprecated, see -bsf
927 @end table
928
929 @section Advanced Subtitle options
930
931 @table @option
932
933 @item -fix_sub_duration
934 Fix subtitles durations. For each subtitle, wait for the next packet in the
935 same stream and adjust the duration of the first to avoid overlap. This is
936 necessary with some subtitles codecs, especially DVB subtitles, because the
937 duration in the original packet is only a rough estimate and the end is
938 actually marked by an empty subtitle frame. Failing to use this option when
939 necessary can result in exaggerated durations or muxing failures due to
940 non-monotonic timestamps.
941
942 Note that this option will delay the output of all data until the next
943 subtitle packet is decoded: it may increase memory consumption and latency a
944 lot.
945
946 @item -canvas_size @var{size}
947 Set the size of the canvas used to render subtitles.
948
949 @end table
950
951 @section Advanced options
952
953 @table @option
954 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][?][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
955
956 Designate one or more input streams as a source for the output file. Each input
957 stream is identified by the input file index @var{input_file_id} and
958 the input stream index @var{input_stream_id} within the input
959 file. Both indices start at 0. If specified,
960 @var{sync_file_id}:@var{stream_specifier} sets which input stream
961 is used as a presentation sync reference.
962
963 The first @code{-map} option on the command line specifies the
964 source for output stream 0, the second @code{-map} option specifies
965 the source for output stream 1, etc.
966
967 A @code{-} character before the stream identifier creates a "negative" mapping.
968 It disables matching streams from already created mappings.
969
970 A trailing @code{?} after the stream index will allow the map to be
971 optional: if the map matches no streams the map will be ignored instead
972 of failing. Note the map will still fail if an invalid input file index
973 is used; such as if the map refers to a non-existent input.
974
975 An alternative @var{[linklabel]} form will map outputs from complex filter
976 graphs (see the @option{-filter_complex} option) to the output file.
977 @var{linklabel} must correspond to a defined output link label in the graph.
978
979 For example, to map ALL streams from the first input file to output
980 @example
981 ffmpeg -i INPUT -map 0 output
982 @end example
983
984 For example, if you have two audio streams in the first input file,
985 these streams are identified by "0:0" and "0:1". You can use
986 @code{-map} to select which streams to place in an output file. For
987 example:
988 @example
989 ffmpeg -i INPUT -map 0:1 out.wav
990 @end example
991 will map the input stream in @file{INPUT} identified by "0:1" to
992 the (single) output stream in @file{out.wav}.
993
994 For example, to select the stream with index 2 from input file
995 @file{a.mov} (specified by the identifier "0:2"), and stream with
996 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
997 and copy them to the output file @file{out.mov}:
998 @example
999 ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
1000 @end example
1001
1002 To select all video and the third audio stream from an input file:
1003 @example
1004 ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
1005 @end example
1006
1007 To map all the streams except the second audio, use negative mappings
1008 @example
1009 ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
1010 @end example
1011
1012 To map the video and audio streams from the first input, and using the
1013 trailing @code{?}, ignore the audio mapping if no audio streams exist in
1014 the first input:
1015 @example
1016 ffmpeg -i INPUT -map 0:v -map 0:a? OUTPUT
1017 @end example
1018
1019 To pick the English audio stream:
1020 @example
1021 ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
1022 @end example
1023
1024 Note that using this option disables the default mappings for this output file.
1025
1026 @item -ignore_unknown
1027 Ignore input streams with unknown type instead of failing if copying
1028 such streams is attempted.
1029
1030 @item -copy_unknown
1031 Allow input streams with unknown type to be copied instead of failing if copying
1032 such streams is attempted.
1033
1034 @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][?][:@var{output_file_id}.@var{stream_specifier}]
1035 Map an audio channel from a given input to an output. If
1036 @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
1037 be mapped on all the audio streams.
1038
1039 Using "-1" instead of
1040 @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
1041 channel.
1042
1043 A trailing @code{?} will allow the map_channel to be
1044 optional: if the map_channel matches no channel the map_channel will be ignored instead
1045 of failing.
1046
1047 For example, assuming @var{INPUT} is a stereo audio file, you can switch the
1048 two audio channels with the following command:
1049 @example
1050 ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
1051 @end example
1052
1053 If you want to mute the first channel and keep the second:
1054 @example
1055 ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
1056 @end example
1057
1058 The order of the "-map_channel" option specifies the order of the channels in
1059 the output stream. The output channel layout is guessed from the number of
1060 channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
1061 in combination of "-map_channel" makes the channel gain levels to be updated if
1062 input and output channel layouts don't match (for instance two "-map_channel"
1063 options and "-ac 6").
1064
1065 You can also extract each channel of an input to specific outputs; the following
1066 command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
1067 to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
1068 @example
1069 ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
1070 @end example
1071
1072 The following example splits the channels of a stereo input into two separate
1073 streams, which are put into the same output file:
1074 @example
1075 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
1076 @end example
1077
1078 Note that currently each output stream can only contain channels from a single
1079 input stream; you can't for example use "-map_channel" to pick multiple input
1080 audio channels contained in different streams (from the same or different files)
1081 and merge them into a single output stream. It is therefore not currently
1082 possible, for example, to turn two separate mono streams into a single stereo
1083 stream. However splitting a stereo stream into two single channel mono streams
1084 is possible.
1085
1086 If you need this feature, a possible workaround is to use the @emph{amerge}
1087 filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
1088 mono audio streams into one single stereo channel audio stream (and keep the
1089 video stream), you can use the following command:
1090 @example
1091 ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
1092 @end example
1093
1094 To map the first two audio channels from the first input, and using the
1095 trailing @code{?}, ignore the audio channel mapping if the first input is
1096 mono instead of stereo:
1097 @example
1098 ffmpeg -i INPUT -map_channel 0.0.0 -map_channel 0.0.1? OUTPUT
1099 @end example
1100
1101 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
1102 Set metadata information of the next output file from @var{infile}. Note that
1103 those are file indices (zero-based), not filenames.
1104 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
1105 A metadata specifier can have the following forms:
1106 @table @option
1107 @item @var{g}
1108 global metadata, i.e. metadata that applies to the whole file
1109
1110 @item @var{s}[:@var{stream_spec}]
1111 per-stream metadata. @var{stream_spec} is a stream specifier as described
1112 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
1113 matching stream is copied from. In an output metadata specifier, all matching
1114 streams are copied to.
1115
1116 @item @var{c}:@var{chapter_index}
1117 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
1118
1119 @item @var{p}:@var{program_index}
1120 per-program metadata. @var{program_index} is the zero-based program index.
1121 @end table
1122 If metadata specifier is omitted, it defaults to global.
1123
1124 By default, global metadata is copied from the first input file,
1125 per-stream and per-chapter metadata is copied along with streams/chapters. These
1126 default mappings are disabled by creating any mapping of the relevant type. A negative
1127 file index can be used to create a dummy mapping that just disables automatic copying.
1128
1129 For example to copy metadata from the first stream of the input file to global metadata
1130 of the output file:
1131 @example
1132 ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
1133 @end example
1134
1135 To do the reverse, i.e. copy global metadata to all audio streams:
1136 @example
1137 ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
1138 @end example
1139 Note that simple @code{0} would work as well in this example, since global
1140 metadata is assumed by default.
1141
1142 @item -map_chapters @var{input_file_index} (@emph{output})
1143 Copy chapters from input file with index @var{input_file_index} to the next
1144 output file. If no chapter mapping is specified, then chapters are copied from
1145 the first input file with at least one chapter. Use a negative file index to
1146 disable any chapter copying.
1147
1148 @item -benchmark (@emph{global})
1149 Show benchmarking information at the end of an encode.
1150 Shows CPU time used and maximum memory consumption.
1151 Maximum memory consumption is not supported on all systems,
1152 it will usually display as 0 if not supported.
1153 @item -benchmark_all (@emph{global})
1154 Show benchmarking information during the encode.
1155 Shows CPU time used in various steps (audio/video encode/decode).
1156 @item -timelimit @var{duration} (@emph{global})
1157 Exit after ffmpeg has been running for @var{duration} seconds.
1158 @item -dump (@emph{global})
1159 Dump each input packet to stderr.
1160 @item -hex (@emph{global})
1161 When dumping packets, also dump the payload.
1162 @item -re (@emph{input})
1163 Read input at native frame rate. Mainly used to simulate a grab device,
1164 or live input stream (e.g. when reading from a file). Should not be used
1165 with actual grab devices or live input streams (where it can cause packet
1166 loss).
1167 By default @command{ffmpeg} attempts to read the input(s) as fast as possible.
1168 This option will slow down the reading of the input(s) to the native frame rate
1169 of the input(s). It is useful for real-time output (e.g. live streaming).
1170 @item -loop_input
1171 Loop over the input stream. Currently it works only for image
1172 streams. This option is used for automatic FFserver testing.
1173 This option is deprecated, use -loop 1.
1174 @item -loop_output @var{number_of_times}
1175 Repeatedly loop output for formats that support looping such as animated GIF
1176 (0 will loop the output infinitely).
1177 This option is deprecated, use -loop.
1178 @item -vsync @var{parameter}
1179 Video sync method.
1180 For compatibility reasons old values can be specified as numbers.
1181 Newly added values will have to be specified as strings always.
1182
1183 @table @option
1184 @item 0, passthrough
1185 Each frame is passed with its timestamp from the demuxer to the muxer.
1186 @item 1, cfr
1187 Frames will be duplicated and dropped to achieve exactly the requested
1188 constant frame rate.
1189 @item 2, vfr
1190 Frames are passed through with their timestamp or dropped so as to
1191 prevent 2 frames from having the same timestamp.
1192 @item drop
1193 As passthrough but destroys all timestamps, making the muxer generate
1194 fresh timestamps based on frame-rate.
1195 @item -1, auto
1196 Chooses between 1 and 2 depending on muxer capabilities. This is the
1197 default method.
1198 @end table
1199
1200 Note that the timestamps may be further modified by the muxer, after this.
1201 For example, in the case that the format option @option{avoid_negative_ts}
1202 is enabled.
1203
1204 With -map you can select from which stream the timestamps should be
1205 taken. You can leave either video or audio unchanged and sync the
1206 remaining stream(s) to the unchanged one.
1207
1208 @item -frame_drop_threshold @var{parameter}
1209 Frame drop threshold, which specifies how much behind video frames can
1210 be before they are dropped. In frame rate units, so 1.0 is one frame.
1211 The default is -1.1. One possible usecase is to avoid framedrops in case
1212 of noisy timestamps or to increase frame drop precision in case of exact
1213 timestamps.
1214
1215 @item -async @var{samples_per_second}
1216 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
1217 the parameter is the maximum samples per second by which the audio is changed.
1218 -async 1 is a special case where only the start of the audio stream is corrected
1219 without any later correction.
1220
1221 Note that the timestamps may be further modified by the muxer, after this.
1222 For example, in the case that the format option @option{avoid_negative_ts}
1223 is enabled.
1224
1225 This option has been deprecated. Use the @code{aresample} audio filter instead.
1226
1227 @item -copyts
1228 Do not process input timestamps, but keep their values without trying
1229 to sanitize them. In particular, do not remove the initial start time
1230 offset value.
1231
1232 Note that, depending on the @option{vsync} option or on specific muxer
1233 processing (e.g. in case the format option @option{avoid_negative_ts}
1234 is enabled) the output timestamps may mismatch with the input
1235 timestamps even when this option is selected.
1236
1237 @item -start_at_zero
1238 When used with @option{copyts}, shift input timestamps so they start at zero.
1239
1240 This means that using e.g. @code{-ss 50} will make output timestamps start at
1241 50 seconds, regardless of what timestamp the input file started at.
1242
1243 @item -copytb @var{mode}
1244 Specify how to set the encoder timebase when stream copying.  @var{mode} is an
1245 integer numeric value, and can assume one of the following values:
1246
1247 @table @option
1248 @item 1
1249 Use the demuxer timebase.
1250
1251 The time base is copied to the output encoder from the corresponding input
1252 demuxer. This is sometimes required to avoid non monotonically increasing
1253 timestamps when copying video streams with variable frame rate.
1254
1255 @item 0
1256 Use the decoder timebase.
1257
1258 The time base is copied to the output encoder from the corresponding input
1259 decoder.
1260
1261 @item -1
1262 Try to make the choice automatically, in order to generate a sane output.
1263 @end table
1264
1265 Default value is -1.
1266
1267 @item -enc_time_base[:@var{stream_specifier}] @var{timebase} (@emph{output,per-stream})
1268 Set the encoder timebase. @var{timebase} is a floating point number,
1269 and can assume one of the following values:
1270
1271 @table @option
1272 @item 0
1273 Assign a default value according to the media type.
1274
1275 For video - use 1/framerate, for audio - use 1/samplerate.
1276
1277 @item -1
1278 Use the input stream timebase when possible.
1279
1280 If an input stream is not available, the default timebase will be used.
1281
1282 @item >0
1283 Use the provided number as the timebase.
1284
1285 This field can be provided as a ratio of two integers (e.g. 1:24, 1:48000)
1286 or as a floating point number (e.g. 0.04166, 2.0833e-5)
1287 @end table
1288
1289 Default value is 0.
1290
1291 @item -bitexact (@emph{input/output})
1292 Enable bitexact mode for (de)muxer and (de/en)coder
1293 @item -shortest (@emph{output})
1294 Finish encoding when the shortest input stream ends.
1295 @item -dts_delta_threshold
1296 Timestamp discontinuity delta threshold.
1297 @item -muxdelay @var{seconds} (@emph{input})
1298 Set the maximum demux-decode delay.
1299 @item -muxpreload @var{seconds} (@emph{input})
1300 Set the initial demux-decode delay.
1301 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
1302 Assign a new stream-id value to an output stream. This option should be
1303 specified prior to the output filename to which it applies.
1304 For the situation where multiple output files exist, a streamid
1305 may be reassigned to a different value.
1306
1307 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
1308 an output mpegts file:
1309 @example
1310 ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
1311 @end example
1312
1313 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
1314 Set bitstream filters for matching streams. @var{bitstream_filters} is
1315 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
1316 to get the list of bitstream filters.
1317 @example
1318 ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
1319 @end example
1320 @example
1321 ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
1322 @end example
1323
1324 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{input/output,per-stream})
1325 Force a tag/fourcc for matching streams.
1326
1327 @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
1328 Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
1329 (or '.') for drop.
1330 @example
1331 ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
1332 @end example
1333
1334 @anchor{filter_complex_option}
1335 @item -filter_complex @var{filtergraph} (@emph{global})
1336 Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1337 outputs. For simple graphs -- those with one input and one output of the same
1338 type -- see the @option{-filter} options. @var{filtergraph} is a description of
1339 the filtergraph, as described in the ``Filtergraph syntax'' section of the
1340 ffmpeg-filters manual.
1341
1342 Input link labels must refer to input streams using the
1343 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
1344 uses). If @var{stream_specifier} matches multiple streams, the first one will be
1345 used. An unlabeled input will be connected to the first unused input stream of
1346 the matching type.
1347
1348 Output link labels are referred to with @option{-map}. Unlabeled outputs are
1349 added to the first output file.
1350
1351 Note that with this option it is possible to use only lavfi sources without
1352 normal input files.
1353
1354 For example, to overlay an image over video
1355 @example
1356 ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
1357 '[out]' out.mkv
1358 @end example
1359 Here @code{[0:v]} refers to the first video stream in the first input file,
1360 which is linked to the first (main) input of the overlay filter. Similarly the
1361 first video stream in the second input is linked to the second (overlay) input
1362 of overlay.
1363
1364 Assuming there is only one video stream in each input file, we can omit input
1365 labels, so the above is equivalent to
1366 @example
1367 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
1368 '[out]' out.mkv
1369 @end example
1370
1371 Furthermore we can omit the output label and the single output from the filter
1372 graph will be added to the output file automatically, so we can simply write
1373 @example
1374 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
1375 @end example
1376
1377 To generate 5 seconds of pure red video using lavfi @code{color} source:
1378 @example
1379 ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
1380 @end example
1381
1382 @item -filter_complex_threads @var{nb_threads} (@emph{global})
1383 Defines how many threads are used to process a filter_complex graph.
1384 Similar to filter_threads but used for @code{-filter_complex} graphs only.
1385 The default is the number of available CPUs.
1386
1387 @item -lavfi @var{filtergraph} (@emph{global})
1388 Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1389 outputs. Equivalent to @option{-filter_complex}.
1390
1391 @item -filter_complex_script @var{filename} (@emph{global})
1392 This option is similar to @option{-filter_complex}, the only difference is that
1393 its argument is the name of the file from which a complex filtergraph
1394 description is to be read.
1395
1396 @item -accurate_seek (@emph{input})
1397 This option enables or disables accurate seeking in input files with the
1398 @option{-ss} option. It is enabled by default, so seeking is accurate when
1399 transcoding. Use @option{-noaccurate_seek} to disable it, which may be useful
1400 e.g. when copying some streams and transcoding the others.
1401
1402 @item -seek_timestamp (@emph{input})
1403 This option enables or disables seeking by timestamp in input files with the
1404 @option{-ss} option. It is disabled by default. If enabled, the argument
1405 to the @option{-ss} option is considered an actual timestamp, and is not
1406 offset by the start time of the file. This matters only for files which do
1407 not start from timestamp 0, such as transport streams.
1408
1409 @item -thread_queue_size @var{size} (@emph{input})
1410 This option sets the maximum number of queued packets when reading from the
1411 file or device. With low latency / high rate live streams, packets may be
1412 discarded if they are not read in a timely manner; raising this value can
1413 avoid it.
1414
1415 @item -override_ffserver (@emph{global})
1416 Overrides the input specifications from @command{ffserver}. Using this
1417 option you can map any input stream to @command{ffserver} and control
1418 many aspects of the encoding from @command{ffmpeg}. Without this
1419 option @command{ffmpeg} will transmit to @command{ffserver} what is
1420 requested by @command{ffserver}.
1421
1422 The option is intended for cases where features are needed that cannot be
1423 specified to @command{ffserver} but can be to @command{ffmpeg}.
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}, @url{ffserver.html,ffserver},
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), ffserver(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