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