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