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