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