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