avfilter/avf_showspectrum: properly handle EOF case
[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 -itsscale @var{scale} (@emph{input,per-stream})
527 Rescale input timestamps. @var{scale} should be a floating point number.
528
529 @item -timestamp @var{date} (@emph{output})
530 Set the recording timestamp in the container.
531
532 @var{date} must be a date specification,
533 see @ref{date syntax,,the Date section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
534
535 @item -metadata[:metadata_specifier] @var{key}=@var{value} (@emph{output,per-metadata})
536 Set a metadata key/value pair.
537
538 An optional @var{metadata_specifier} may be given to set metadata
539 on streams, chapters or programs. See @code{-map_metadata}
540 documentation for details.
541
542 This option overrides metadata set with @code{-map_metadata}. It is
543 also possible to delete metadata by using an empty value.
544
545 For example, for setting the title in the output file:
546 @example
547 ffmpeg -i in.avi -metadata title="my title" out.flv
548 @end example
549
550 To set the language of the first audio stream:
551 @example
552 ffmpeg -i INPUT -metadata:s:a:0 language=eng OUTPUT
553 @end example
554
555 @item -disposition[:stream_specifier] @var{value} (@emph{output,per-stream})
556 Sets the disposition for a stream.
557
558 This option overrides the disposition copied from the input stream. It is also
559 possible to delete the disposition by setting it to 0.
560
561 The following dispositions are recognized:
562 @table @option
563 @item default
564 @item dub
565 @item original
566 @item comment
567 @item lyrics
568 @item karaoke
569 @item forced
570 @item hearing_impaired
571 @item visual_impaired
572 @item clean_effects
573 @item attached_pic
574 @item captions
575 @item descriptions
576 @item dependent
577 @item metadata
578 @end table
579
580 For example, to make the second audio stream the default stream:
581 @example
582 ffmpeg -i in.mkv -c copy -disposition:a:1 default out.mkv
583 @end example
584
585 To make the second subtitle stream the default stream and remove the default
586 disposition from the first subtitle stream:
587 @example
588 ffmpeg -i in.mkv -c copy -disposition:s:0 0 -disposition:s:1 default out.mkv
589 @end example
590
591 To add an embedded cover/thumbnail:
592 @example
593 ffmpeg -i in.mp4 -i IMAGE -map 0 -map 1 -c copy -c:v:1 png -disposition:v:1 attached_pic out.mp4
594 @end example
595
596 Not all muxers support embedded thumbnails, and those who do, only support a few formats, like JPEG or PNG.
597
598 @item -program [title=@var{title}:][program_num=@var{program_num}:]st=@var{stream}[:st=@var{stream}...] (@emph{output})
599
600 Creates a program with the specified @var{title}, @var{program_num} and adds the specified
601 @var{stream}(s) to it.
602
603 @item -target @var{type} (@emph{output})
604 Specify target file type (@code{vcd}, @code{svcd}, @code{dvd}, @code{dv},
605 @code{dv50}). @var{type} may be prefixed with @code{pal-}, @code{ntsc-} or
606 @code{film-} to use the corresponding standard. All the format options
607 (bitrate, codecs, buffer sizes) are then set automatically. You can just type:
608
609 @example
610 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
611 @end example
612
613 Nevertheless you can specify additional options as long as you know
614 they do not conflict with the standard, as in:
615
616 @example
617 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
618 @end example
619
620 @item -dn (@emph{input/output})
621 As an input option, blocks all data streams of a file from being filtered or
622 being automatically selected or mapped for any output. See @code{-discard}
623 option to disable streams individually.
624
625 As an output option, disables data recording i.e. automatic selection or
626 mapping of any data stream. For full manual control see the @code{-map}
627 option.
628
629 @item -dframes @var{number} (@emph{output})
630 Set the number of data frames to output. This is an obsolete alias for
631 @code{-frames:d}, which you should use instead.
632
633 @item -frames[:@var{stream_specifier}] @var{framecount} (@emph{output,per-stream})
634 Stop writing to the stream after @var{framecount} frames.
635
636 @item -q[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
637 @itemx -qscale[:@var{stream_specifier}] @var{q} (@emph{output,per-stream})
638 Use fixed quality scale (VBR). The meaning of @var{q}/@var{qscale} is
639 codec-dependent.
640 If @var{qscale} is used without a @var{stream_specifier} then it applies only
641 to the video stream, this is to maintain compatibility with previous behavior
642 and as specifying the same codec specific value to 2 different codecs that is
643 audio and video generally is not what is intended when no stream_specifier is
644 used.
645
646 @anchor{filter_option}
647 @item -filter[:@var{stream_specifier}] @var{filtergraph} (@emph{output,per-stream})
648 Create the filtergraph specified by @var{filtergraph} and use it to
649 filter the stream.
650
651 @var{filtergraph} is a description of the filtergraph to apply to
652 the stream, and must have a single input and a single output of the
653 same type of the stream. In the filtergraph, the input is associated
654 to the label @code{in}, and the output to the label @code{out}. See
655 the ffmpeg-filters manual for more information about the filtergraph
656 syntax.
657
658 See the @ref{filter_complex_option,,-filter_complex option} if you
659 want to create filtergraphs with multiple inputs and/or outputs.
660
661 @item -filter_script[:@var{stream_specifier}] @var{filename} (@emph{output,per-stream})
662 This option is similar to @option{-filter}, the only difference is that its
663 argument is the name of the file from which a filtergraph description is to be
664 read.
665
666 @item -filter_threads @var{nb_threads} (@emph{global})
667 Defines how many threads are used to process a filter pipeline. Each pipeline
668 will produce a thread pool with this many threads available for parallel processing.
669 The default is the number of available CPUs.
670
671 @item -pre[:@var{stream_specifier}] @var{preset_name} (@emph{output,per-stream})
672 Specify the preset for matching stream(s).
673
674 @item -stats (@emph{global})
675 Print encoding progress/statistics. It is on by default, to explicitly
676 disable it you need to specify @code{-nostats}.
677
678 @item -progress @var{url} (@emph{global})
679 Send program-friendly progress information to @var{url}.
680
681 Progress information is written approximately every second and at the end of
682 the encoding process. It is made of "@var{key}=@var{value}" lines. @var{key}
683 consists of only alphanumeric characters. The last key of a sequence of
684 progress information is always "progress".
685
686 @anchor{stdin option}
687 @item -stdin
688 Enable interaction on standard input. On by default unless standard input is
689 used as an input. To explicitly disable interaction you need to specify
690 @code{-nostdin}.
691
692 Disabling interaction on standard input is useful, for example, if
693 ffmpeg is in the background process group. Roughly the same result can
694 be achieved with @code{ffmpeg ... < /dev/null} but it requires a
695 shell.
696
697 @item -debug_ts (@emph{global})
698 Print timestamp information. It is off by default. This option is
699 mostly useful for testing and debugging purposes, and the output
700 format may change from one version to another, so it should not be
701 employed by portable scripts.
702
703 See also the option @code{-fdebug ts}.
704
705 @item -attach @var{filename} (@emph{output})
706 Add an attachment to the output file. This is supported by a few formats
707 like Matroska for e.g. fonts used in rendering subtitles. Attachments
708 are implemented as a specific type of stream, so this option will add
709 a new stream to the file. It is then possible to use per-stream options
710 on this stream in the usual way. Attachment streams created with this
711 option will be created after all the other streams (i.e. those created
712 with @code{-map} or automatic mappings).
713
714 Note that for Matroska you also have to set the mimetype metadata tag:
715 @example
716 ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
717 @end example
718 (assuming that the attachment stream will be third in the output file).
719
720 @item -dump_attachment[:@var{stream_specifier}] @var{filename} (@emph{input,per-stream})
721 Extract the matching attachment stream into a file named @var{filename}. If
722 @var{filename} is empty, then the value of the @code{filename} metadata tag
723 will be used.
724
725 E.g. to extract the first attachment to a file named 'out.ttf':
726 @example
727 ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
728 @end example
729 To extract all attachments to files determined by the @code{filename} tag:
730 @example
731 ffmpeg -dump_attachment:t "" -i INPUT
732 @end example
733
734 Technical note -- attachments are implemented as codec extradata, so this
735 option can actually be used to extract extradata from any stream, not just
736 attachments.
737
738 @item -noautorotate
739 Disable automatically rotating video based on file metadata.
740
741 @end table
742
743 @section Video Options
744
745 @table @option
746 @item -vframes @var{number} (@emph{output})
747 Set the number of video frames to output. This is an obsolete alias for
748 @code{-frames:v}, which you should use instead.
749 @item -r[:@var{stream_specifier}] @var{fps} (@emph{input/output,per-stream})
750 Set frame rate (Hz value, fraction or abbreviation).
751
752 As an input option, ignore any timestamps stored in the file and instead
753 generate timestamps assuming constant frame rate @var{fps}.
754 This is not the same as the @option{-framerate} option used for some input formats
755 like image2 or v4l2 (it used to be the same in older versions of FFmpeg).
756 If in doubt use @option{-framerate} instead of the input option @option{-r}.
757
758 As an output option, duplicate or drop input frames to achieve constant output
759 frame rate @var{fps}.
760
761 @item -s[:@var{stream_specifier}] @var{size} (@emph{input/output,per-stream})
762 Set frame size.
763
764 As an input option, this is a shortcut for the @option{video_size} private
765 option, recognized by some demuxers for which the frame size is either not
766 stored in the file or is configurable -- e.g. raw video or video grabbers.
767
768 As an output option, this inserts the @code{scale} video filter to the
769 @emph{end} of the corresponding filtergraph. Please use the @code{scale} filter
770 directly to insert it at the beginning or some other place.
771
772 The format is @samp{wxh} (default - same as source).
773
774 @item -aspect[:@var{stream_specifier}] @var{aspect} (@emph{output,per-stream})
775 Set the video display aspect ratio specified by @var{aspect}.
776
777 @var{aspect} can be a floating point number string, or a string of the
778 form @var{num}:@var{den}, where @var{num} and @var{den} are the
779 numerator and denominator of the aspect ratio. For example "4:3",
780 "16:9", "1.3333", and "1.7777" are valid argument values.
781
782 If used together with @option{-vcodec copy}, it will affect the aspect ratio
783 stored at container level, but not the aspect ratio stored in encoded
784 frames, if it exists.
785
786 @item -vn (@emph{input/output})
787 As an input option, blocks all video streams of a file from being filtered or
788 being automatically selected or mapped for any output. See @code{-discard}
789 option to disable streams individually.
790
791 As an output option, disables video recording i.e. automatic selection or
792 mapping of any video stream. For full manual control see the @code{-map}
793 option.
794
795 @item -vcodec @var{codec} (@emph{output})
796 Set the video codec. This is an alias for @code{-codec:v}.
797
798 @item -pass[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
799 Select the pass number (1 or 2). It is used to do two-pass
800 video encoding. The statistics of the video are recorded in the first
801 pass into a log file (see also the option -passlogfile),
802 and in the second pass that log file is used to generate the video
803 at the exact requested bitrate.
804 On pass 1, you may just deactivate audio and set output to null,
805 examples for Windows and Unix:
806 @example
807 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
808 ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
809 @end example
810
811 @item -passlogfile[:@var{stream_specifier}] @var{prefix} (@emph{output,per-stream})
812 Set two-pass log file name prefix to @var{prefix}, the default file name
813 prefix is ``ffmpeg2pass''. The complete file name will be
814 @file{PREFIX-N.log}, where N is a number specific to the output
815 stream
816
817 @item -vf @var{filtergraph} (@emph{output})
818 Create the filtergraph specified by @var{filtergraph} and use it to
819 filter the stream.
820
821 This is an alias for @code{-filter:v}, see the @ref{filter_option,,-filter option}.
822 @end table
823
824 @section Advanced Video options
825
826 @table @option
827 @item -pix_fmt[:@var{stream_specifier}] @var{format} (@emph{input/output,per-stream})
828 Set pixel format. Use @code{-pix_fmts} to show all the supported
829 pixel formats.
830 If the selected pixel format can not be selected, ffmpeg will print a
831 warning and select the best pixel format supported by the encoder.
832 If @var{pix_fmt} is prefixed by a @code{+}, ffmpeg will exit with an error
833 if the requested pixel format can not be selected, and automatic conversions
834 inside filtergraphs are disabled.
835 If @var{pix_fmt} is a single @code{+}, ffmpeg selects the same pixel format
836 as the input (or graph output) and automatic conversions are disabled.
837
838 @item -sws_flags @var{flags} (@emph{input/output})
839 Set SwScaler flags.
840
841 @item -rc_override[:@var{stream_specifier}] @var{override} (@emph{output,per-stream})
842 Rate control override for specific intervals, formatted as "int,int,int"
843 list separated with slashes. Two first values are the beginning and
844 end frame numbers, last one is quantizer to use if positive, or quality
845 factor if negative.
846
847 @item -ilme
848 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
849 Use this option if your input file is interlaced and you want
850 to keep the interlaced format for minimum losses.
851 The alternative is to deinterlace the input stream with
852 @option{-deinterlace}, but deinterlacing introduces losses.
853 @item -psnr
854 Calculate PSNR of compressed frames.
855 @item -vstats
856 Dump video coding statistics to @file{vstats_HHMMSS.log}.
857 @item -vstats_file @var{file}
858 Dump video coding statistics to @var{file}.
859 @item -vstats_version @var{file}
860 Specifies which version of the vstats format to use. Default is 2.
861
862 version = 1 :
863
864 @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}
865
866 version > 1:
867
868 @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}
869 @item -top[:@var{stream_specifier}] @var{n} (@emph{output,per-stream})
870 top=1/bottom=0/auto=-1 field first
871 @item -dc @var{precision}
872 Intra_dc_precision.
873 @item -vtag @var{fourcc/tag} (@emph{output})
874 Force video tag/fourcc. This is an alias for @code{-tag:v}.
875 @item -qphist (@emph{global})
876 Show QP histogram
877 @item -vbsf @var{bitstream_filter}
878 Deprecated see -bsf
879
880 @item -force_key_frames[:@var{stream_specifier}] @var{time}[,@var{time}...] (@emph{output,per-stream})
881 @item -force_key_frames[:@var{stream_specifier}] expr:@var{expr} (@emph{output,per-stream})
882 @item -force_key_frames[:@var{stream_specifier}] source (@emph{output,per-stream})
883
884 @var{force_key_frames} can take arguments of the following form:
885
886 @table @option
887
888 @item @var{time}[,@var{time}...]
889 If the argument consists of timestamps, ffmpeg will round the specified times to the nearest
890 output timestamp as per the encoder time base and force a keyframe at the first frame having
891 timestamp equal or greater than the computed timestamp. Note that if the encoder time base is too
892 coarse, then the keyframes may be forced on frames with timestamps lower than the specified time.
893 The default encoder time base is the inverse of the output framerate but may be set otherwise
894 via @code{-enc_time_base}.
895
896 If one of the times is "@code{chapters}[@var{delta}]", it is expanded into
897 the time of the beginning of all chapters in the file, shifted by
898 @var{delta}, expressed as a time in seconds.
899 This option can be useful to ensure that a seek point is present at a
900 chapter mark or any other designated place in the output file.
901
902 For example, to insert a key frame at 5 minutes, plus key frames 0.1 second
903 before the beginning of every chapter:
904 @example
905 -force_key_frames 0:05:00,chapters-0.1
906 @end example
907
908 @item expr:@var{expr}
909 If the argument is prefixed with @code{expr:}, the string @var{expr}
910 is interpreted like an expression and is evaluated for each frame. A
911 key frame is forced in case the evaluation is non-zero.
912
913 The expression in @var{expr} can contain the following constants:
914 @table @option
915 @item n
916 the number of current processed frame, starting from 0
917 @item n_forced
918 the number of forced frames
919 @item prev_forced_n
920 the number of the previous forced frame, it is @code{NAN} when no
921 keyframe was forced yet
922 @item prev_forced_t
923 the time of the previous forced frame, it is @code{NAN} when no
924 keyframe was forced yet
925 @item t
926 the time of the current processed frame
927 @end table
928
929 For example to force a key frame every 5 seconds, you can specify:
930 @example
931 -force_key_frames expr:gte(t,n_forced*5)
932 @end example
933
934 To force a key frame 5 seconds after the time of the last forced one,
935 starting from second 13:
936 @example
937 -force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
938 @end example
939
940 @item source
941 If the argument is @code{source}, ffmpeg will force a key frame if
942 the current frame being encoded is marked as a key frame in its source.
943
944 @end table
945
946 Note that forcing too many keyframes is very harmful for the lookahead
947 algorithms of certain encoders: using fixed-GOP options or similar
948 would be more efficient.
949
950 @item -copyinkf[:@var{stream_specifier}] (@emph{output,per-stream})
951 When doing stream copy, copy also non-key frames found at the
952 beginning.
953
954 @item -init_hw_device @var{type}[=@var{name}][:@var{device}[,@var{key=value}...]]
955 Initialise a new hardware device of type @var{type} called @var{name}, using the
956 given device parameters.
957 If no name is specified it will receive a default name of the form "@var{type}%d".
958
959 The meaning of @var{device} and the following arguments depends on the
960 device type:
961 @table @option
962
963 @item cuda
964 @var{device} is the number of the CUDA device.
965
966 @item dxva2
967 @var{device} is the number of the Direct3D 9 display adapter.
968
969 @item vaapi
970 @var{device} is either an X11 display name or a DRM render node.
971 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY})
972 and then the first DRM render node (@emph{/dev/dri/renderD128}).
973
974 @item vdpau
975 @var{device} is an X11 display name.
976 If not specified, it will attempt to open the default X11 display (@emph{$DISPLAY}).
977
978 @item qsv
979 @var{device} selects a value in @samp{MFX_IMPL_*}. Allowed values are:
980 @table @option
981 @item auto
982 @item sw
983 @item hw
984 @item auto_any
985 @item hw_any
986 @item hw2
987 @item hw3
988 @item hw4
989 @end table
990 If not specified, @samp{auto_any} is used.
991 (Note that it may be easier to achieve the desired result for QSV by creating the
992 platform-appropriate subdevice (@samp{dxva2} or @samp{vaapi}) and then deriving a
993 QSV device from that.)
994
995 @item opencl
996 @var{device} selects the platform and device as @emph{platform_index.device_index}.
997
998 The set of devices can also be filtered using the key-value pairs to find only
999 devices matching particular platform or device strings.
1000
1001 The strings usable as filters are:
1002 @table @option
1003 @item platform_profile
1004 @item platform_version
1005 @item platform_name
1006 @item platform_vendor
1007 @item platform_extensions
1008 @item device_name
1009 @item device_vendor
1010 @item driver_version
1011 @item device_version
1012 @item device_profile
1013 @item device_extensions
1014 @item device_type
1015 @end table
1016
1017 The indices and filters must together uniquely select a device.
1018
1019 Examples:
1020 @table @emph
1021 @item -init_hw_device opencl:0.1
1022 Choose the second device on the first platform.
1023
1024 @item -init_hw_device opencl:,device_name=Foo9000
1025 Choose the device with a name containing the string @emph{Foo9000}.
1026
1027 @item -init_hw_device opencl:1,device_type=gpu,device_extensions=cl_khr_fp16
1028 Choose the GPU device on the second platform supporting the @emph{cl_khr_fp16}
1029 extension.
1030 @end table
1031
1032 @item vulkan
1033 If @var{device} is an integer, it selects the device by its index in a
1034 system-dependent list of devices.  If @var{device} is any other string, it
1035 selects the first device with a name containing that string as a substring.
1036
1037 The following options are recognized:
1038 @table @option
1039 @item debug
1040 If set to 1, enables the validation layer, if installed.
1041 @item linear_images
1042 If set to 1, images allocated by the hwcontext will be linear and locally mappable.
1043 @item instance_extensions
1044 A plus separated list of additional instance extensions to enable.
1045 @item device_extensions
1046 A plus separated list of additional device extensions to enable.
1047 @end table
1048
1049 Examples:
1050 @table @emph
1051 @item -init_hw_device vulkan:1
1052 Choose the second device on the system.
1053
1054 @item -init_hw_device vulkan:RADV
1055 Choose the first device with a name containing the string @emph{RADV}.
1056
1057 @item -init_hw_device vulkan:0,instance_extensions=VK_KHR_wayland_surface+VK_KHR_xcb_surface
1058 Choose the first device and enable the Wayland and XCB instance extensions.
1059 @end table
1060
1061 @end table
1062
1063 @item -init_hw_device @var{type}[=@var{name}]@@@var{source}
1064 Initialise a new hardware device of type @var{type} called @var{name},
1065 deriving it from the existing device with the name @var{source}.
1066
1067 @item -init_hw_device list
1068 List all hardware device types supported in this build of ffmpeg.
1069
1070 @item -filter_hw_device @var{name}
1071 Pass the hardware device called @var{name} to all filters in any filter graph.
1072 This can be used to set the device to upload to with the @code{hwupload} filter,
1073 or the device to map to with the @code{hwmap} filter.  Other filters may also
1074 make use of this parameter when they require a hardware device.  Note that this
1075 is typically only required when the input is not already in hardware frames -
1076 when it is, filters will derive the device they require from the context of the
1077 frames they receive as input.
1078
1079 This is a global setting, so all filters will receive the same device.
1080
1081 @item -hwaccel[:@var{stream_specifier}] @var{hwaccel} (@emph{input,per-stream})
1082 Use hardware acceleration to decode the matching stream(s). The allowed values
1083 of @var{hwaccel} are:
1084 @table @option
1085 @item none
1086 Do not use any hardware acceleration (the default).
1087
1088 @item auto
1089 Automatically select the hardware acceleration method.
1090
1091 @item vdpau
1092 Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration.
1093
1094 @item dxva2
1095 Use DXVA2 (DirectX Video Acceleration) hardware acceleration.
1096
1097 @item vaapi
1098 Use VAAPI (Video Acceleration API) hardware acceleration.
1099
1100 @item qsv
1101 Use the Intel QuickSync Video acceleration for video transcoding.
1102
1103 Unlike most other values, this option does not enable accelerated decoding (that
1104 is used automatically whenever a qsv decoder is selected), but accelerated
1105 transcoding, without copying the frames into the system memory.
1106
1107 For it to work, both the decoder and the encoder must support QSV acceleration
1108 and no filters must be used.
1109 @end table
1110
1111 This option has no effect if the selected hwaccel is not available or not
1112 supported by the chosen decoder.
1113
1114 Note that most acceleration methods are intended for playback and will not be
1115 faster than software decoding on modern CPUs. Additionally, @command{ffmpeg}
1116 will usually need to copy the decoded frames from the GPU memory into the system
1117 memory, resulting in further performance loss. This option is thus mainly
1118 useful for testing.
1119
1120 @item -hwaccel_device[:@var{stream_specifier}] @var{hwaccel_device} (@emph{input,per-stream})
1121 Select a device to use for hardware acceleration.
1122
1123 This option only makes sense when the @option{-hwaccel} option is also specified.
1124 It can either refer to an existing device created with @option{-init_hw_device}
1125 by name, or it can create a new device as if
1126 @samp{-init_hw_device} @var{type}:@var{hwaccel_device}
1127 were called immediately before.
1128
1129 @item -hwaccels
1130 List all hardware acceleration methods supported in this build of ffmpeg.
1131
1132 @end table
1133
1134 @section Audio Options
1135
1136 @table @option
1137 @item -aframes @var{number} (@emph{output})
1138 Set the number of audio frames to output. This is an obsolete alias for
1139 @code{-frames:a}, which you should use instead.
1140 @item -ar[:@var{stream_specifier}] @var{freq} (@emph{input/output,per-stream})
1141 Set the audio sampling frequency. For output streams it is set by
1142 default to the frequency of the corresponding input stream. For input
1143 streams this option only makes sense for audio grabbing devices and raw
1144 demuxers and is mapped to the corresponding demuxer options.
1145 @item -aq @var{q} (@emph{output})
1146 Set the audio quality (codec-specific, VBR). This is an alias for -q:a.
1147 @item -ac[:@var{stream_specifier}] @var{channels} (@emph{input/output,per-stream})
1148 Set the number of audio channels. For output streams it is set by
1149 default to the number of input audio channels. For input streams
1150 this option only makes sense for audio grabbing devices and raw demuxers
1151 and is mapped to the corresponding demuxer options.
1152 @item -an (@emph{input/output})
1153 As an input option, blocks all audio streams of a file from being filtered or
1154 being automatically selected or mapped for any output. See @code{-discard}
1155 option to disable streams individually.
1156
1157 As an output option, disables audio recording i.e. automatic selection or
1158 mapping of any audio stream. For full manual control see the @code{-map}
1159 option.
1160 @item -acodec @var{codec} (@emph{input/output})
1161 Set the audio codec. This is an alias for @code{-codec:a}.
1162 @item -sample_fmt[:@var{stream_specifier}] @var{sample_fmt} (@emph{output,per-stream})
1163 Set the audio sample format. Use @code{-sample_fmts} to get a list
1164 of supported sample formats.
1165
1166 @item -af @var{filtergraph} (@emph{output})
1167 Create the filtergraph specified by @var{filtergraph} and use it to
1168 filter the stream.
1169
1170 This is an alias for @code{-filter:a}, see the @ref{filter_option,,-filter option}.
1171 @end table
1172
1173 @section Advanced Audio options
1174
1175 @table @option
1176 @item -atag @var{fourcc/tag} (@emph{output})
1177 Force audio tag/fourcc. This is an alias for @code{-tag:a}.
1178 @item -absf @var{bitstream_filter}
1179 Deprecated, see -bsf
1180 @item -guess_layout_max @var{channels} (@emph{input,per-stream})
1181 If some input channel layout is not known, try to guess only if it
1182 corresponds to at most the specified number of channels. For example, 2
1183 tells to @command{ffmpeg} to recognize 1 channel as mono and 2 channels as
1184 stereo but not 6 channels as 5.1. The default is to always try to guess. Use
1185 0 to disable all guessing.
1186 @end table
1187
1188 @section Subtitle options
1189
1190 @table @option
1191 @item -scodec @var{codec} (@emph{input/output})
1192 Set the subtitle codec. This is an alias for @code{-codec:s}.
1193 @item -sn (@emph{input/output})
1194 As an input option, blocks all subtitle streams of a file from being filtered or
1195 being automatically selected or mapped for any output. See @code{-discard}
1196 option to disable streams individually.
1197
1198 As an output option, disables subtitle recording i.e. automatic selection or
1199 mapping of any subtitle stream. For full manual control see the @code{-map}
1200 option.
1201 @item -sbsf @var{bitstream_filter}
1202 Deprecated, see -bsf
1203 @end table
1204
1205 @section Advanced Subtitle options
1206
1207 @table @option
1208
1209 @item -fix_sub_duration
1210 Fix subtitles durations. For each subtitle, wait for the next packet in the
1211 same stream and adjust the duration of the first to avoid overlap. This is
1212 necessary with some subtitles codecs, especially DVB subtitles, because the
1213 duration in the original packet is only a rough estimate and the end is
1214 actually marked by an empty subtitle frame. Failing to use this option when
1215 necessary can result in exaggerated durations or muxing failures due to
1216 non-monotonic timestamps.
1217
1218 Note that this option will delay the output of all data until the next
1219 subtitle packet is decoded: it may increase memory consumption and latency a
1220 lot.
1221
1222 @item -canvas_size @var{size}
1223 Set the size of the canvas used to render subtitles.
1224
1225 @end table
1226
1227 @section Advanced options
1228
1229 @table @option
1230 @item -map [-]@var{input_file_id}[:@var{stream_specifier}][?][,@var{sync_file_id}[:@var{stream_specifier}]] | @var{[linklabel]} (@emph{output})
1231
1232 Designate one or more input streams as a source for the output file. Each input
1233 stream is identified by the input file index @var{input_file_id} and
1234 the input stream index @var{input_stream_id} within the input
1235 file. Both indices start at 0. If specified,
1236 @var{sync_file_id}:@var{stream_specifier} sets which input stream
1237 is used as a presentation sync reference.
1238
1239 The first @code{-map} option on the command line specifies the
1240 source for output stream 0, the second @code{-map} option specifies
1241 the source for output stream 1, etc.
1242
1243 A @code{-} character before the stream identifier creates a "negative" mapping.
1244 It disables matching streams from already created mappings.
1245
1246 A trailing @code{?} after the stream index will allow the map to be
1247 optional: if the map matches no streams the map will be ignored instead
1248 of failing. Note the map will still fail if an invalid input file index
1249 is used; such as if the map refers to a non-existent input.
1250
1251 An alternative @var{[linklabel]} form will map outputs from complex filter
1252 graphs (see the @option{-filter_complex} option) to the output file.
1253 @var{linklabel} must correspond to a defined output link label in the graph.
1254
1255 For example, to map ALL streams from the first input file to output
1256 @example
1257 ffmpeg -i INPUT -map 0 output
1258 @end example
1259
1260 For example, if you have two audio streams in the first input file,
1261 these streams are identified by "0:0" and "0:1". You can use
1262 @code{-map} to select which streams to place in an output file. For
1263 example:
1264 @example
1265 ffmpeg -i INPUT -map 0:1 out.wav
1266 @end example
1267 will map the input stream in @file{INPUT} identified by "0:1" to
1268 the (single) output stream in @file{out.wav}.
1269
1270 For example, to select the stream with index 2 from input file
1271 @file{a.mov} (specified by the identifier "0:2"), and stream with
1272 index 6 from input @file{b.mov} (specified by the identifier "1:6"),
1273 and copy them to the output file @file{out.mov}:
1274 @example
1275 ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
1276 @end example
1277
1278 To select all video and the third audio stream from an input file:
1279 @example
1280 ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
1281 @end example
1282
1283 To map all the streams except the second audio, use negative mappings
1284 @example
1285 ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
1286 @end example
1287
1288 To map the video and audio streams from the first input, and using the
1289 trailing @code{?}, ignore the audio mapping if no audio streams exist in
1290 the first input:
1291 @example
1292 ffmpeg -i INPUT -map 0:v -map 0:a? OUTPUT
1293 @end example
1294
1295 To pick the English audio stream:
1296 @example
1297 ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
1298 @end example
1299
1300 Note that using this option disables the default mappings for this output file.
1301
1302 @item -ignore_unknown
1303 Ignore input streams with unknown type instead of failing if copying
1304 such streams is attempted.
1305
1306 @item -copy_unknown
1307 Allow input streams with unknown type to be copied instead of failing if copying
1308 such streams is attempted.
1309
1310 @item -map_channel [@var{input_file_id}.@var{stream_specifier}.@var{channel_id}|-1][?][:@var{output_file_id}.@var{stream_specifier}]
1311 Map an audio channel from a given input to an output. If
1312 @var{output_file_id}.@var{stream_specifier} is not set, the audio channel will
1313 be mapped on all the audio streams.
1314
1315 Using "-1" instead of
1316 @var{input_file_id}.@var{stream_specifier}.@var{channel_id} will map a muted
1317 channel.
1318
1319 A trailing @code{?} will allow the map_channel to be
1320 optional: if the map_channel matches no channel the map_channel will be ignored instead
1321 of failing.
1322
1323 For example, assuming @var{INPUT} is a stereo audio file, you can switch the
1324 two audio channels with the following command:
1325 @example
1326 ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
1327 @end example
1328
1329 If you want to mute the first channel and keep the second:
1330 @example
1331 ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
1332 @end example
1333
1334 The order of the "-map_channel" option specifies the order of the channels in
1335 the output stream. The output channel layout is guessed from the number of
1336 channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac"
1337 in combination of "-map_channel" makes the channel gain levels to be updated if
1338 input and output channel layouts don't match (for instance two "-map_channel"
1339 options and "-ac 6").
1340
1341 You can also extract each channel of an input to specific outputs; the following
1342 command extracts two channels of the @var{INPUT} audio stream (file 0, stream 0)
1343 to the respective @var{OUTPUT_CH0} and @var{OUTPUT_CH1} outputs:
1344 @example
1345 ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
1346 @end example
1347
1348 The following example splits the channels of a stereo input into two separate
1349 streams, which are put into the same output file:
1350 @example
1351 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
1352 @end example
1353
1354 Note that currently each output stream can only contain channels from a single
1355 input stream; you can't for example use "-map_channel" to pick multiple input
1356 audio channels contained in different streams (from the same or different files)
1357 and merge them into a single output stream. It is therefore not currently
1358 possible, for example, to turn two separate mono streams into a single stereo
1359 stream. However splitting a stereo stream into two single channel mono streams
1360 is possible.
1361
1362 If you need this feature, a possible workaround is to use the @emph{amerge}
1363 filter. For example, if you need to merge a media (here @file{input.mkv}) with 2
1364 mono audio streams into one single stereo channel audio stream (and keep the
1365 video stream), you can use the following command:
1366 @example
1367 ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
1368 @end example
1369
1370 To map the first two audio channels from the first input, and using the
1371 trailing @code{?}, ignore the audio channel mapping if the first input is
1372 mono instead of stereo:
1373 @example
1374 ffmpeg -i INPUT -map_channel 0.0.0 -map_channel 0.0.1? OUTPUT
1375 @end example
1376
1377 @item -map_metadata[:@var{metadata_spec_out}] @var{infile}[:@var{metadata_spec_in}] (@emph{output,per-metadata})
1378 Set metadata information of the next output file from @var{infile}. Note that
1379 those are file indices (zero-based), not filenames.
1380 Optional @var{metadata_spec_in/out} parameters specify, which metadata to copy.
1381 A metadata specifier can have the following forms:
1382 @table @option
1383 @item @var{g}
1384 global metadata, i.e. metadata that applies to the whole file
1385
1386 @item @var{s}[:@var{stream_spec}]
1387 per-stream metadata. @var{stream_spec} is a stream specifier as described
1388 in the @ref{Stream specifiers} chapter. In an input metadata specifier, the first
1389 matching stream is copied from. In an output metadata specifier, all matching
1390 streams are copied to.
1391
1392 @item @var{c}:@var{chapter_index}
1393 per-chapter metadata. @var{chapter_index} is the zero-based chapter index.
1394
1395 @item @var{p}:@var{program_index}
1396 per-program metadata. @var{program_index} is the zero-based program index.
1397 @end table
1398 If metadata specifier is omitted, it defaults to global.
1399
1400 By default, global metadata is copied from the first input file,
1401 per-stream and per-chapter metadata is copied along with streams/chapters. These
1402 default mappings are disabled by creating any mapping of the relevant type. A negative
1403 file index can be used to create a dummy mapping that just disables automatic copying.
1404
1405 For example to copy metadata from the first stream of the input file to global metadata
1406 of the output file:
1407 @example
1408 ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
1409 @end example
1410
1411 To do the reverse, i.e. copy global metadata to all audio streams:
1412 @example
1413 ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
1414 @end example
1415 Note that simple @code{0} would work as well in this example, since global
1416 metadata is assumed by default.
1417
1418 @item -map_chapters @var{input_file_index} (@emph{output})
1419 Copy chapters from input file with index @var{input_file_index} to the next
1420 output file. If no chapter mapping is specified, then chapters are copied from
1421 the first input file with at least one chapter. Use a negative file index to
1422 disable any chapter copying.
1423
1424 @item -benchmark (@emph{global})
1425 Show benchmarking information at the end of an encode.
1426 Shows real, system and user time used and maximum memory consumption.
1427 Maximum memory consumption is not supported on all systems,
1428 it will usually display as 0 if not supported.
1429 @item -benchmark_all (@emph{global})
1430 Show benchmarking information during the encode.
1431 Shows real, system and user time used in various steps (audio/video encode/decode).
1432 @item -timelimit @var{duration} (@emph{global})
1433 Exit after ffmpeg has been running for @var{duration} seconds in CPU user time.
1434 @item -dump (@emph{global})
1435 Dump each input packet to stderr.
1436 @item -hex (@emph{global})
1437 When dumping packets, also dump the payload.
1438 @item -re (@emph{input})
1439 Read input at native frame rate. Mainly used to simulate a grab device,
1440 or live input stream (e.g. when reading from a file). Should not be used
1441 with actual grab devices or live input streams (where it can cause packet
1442 loss).
1443 By default @command{ffmpeg} attempts to read the input(s) as fast as possible.
1444 This option will slow down the reading of the input(s) to the native frame rate
1445 of the input(s). It is useful for real-time output (e.g. live streaming).
1446 @item -vsync @var{parameter}
1447 Video sync method.
1448 For compatibility reasons old values can be specified as numbers.
1449 Newly added values will have to be specified as strings always.
1450
1451 @table @option
1452 @item 0, passthrough
1453 Each frame is passed with its timestamp from the demuxer to the muxer.
1454 @item 1, cfr
1455 Frames will be duplicated and dropped to achieve exactly the requested
1456 constant frame rate.
1457 @item 2, vfr
1458 Frames are passed through with their timestamp or dropped so as to
1459 prevent 2 frames from having the same timestamp.
1460 @item drop
1461 As passthrough but destroys all timestamps, making the muxer generate
1462 fresh timestamps based on frame-rate.
1463 @item -1, auto
1464 Chooses between 1 and 2 depending on muxer capabilities. This is the
1465 default method.
1466 @end table
1467
1468 Note that the timestamps may be further modified by the muxer, after this.
1469 For example, in the case that the format option @option{avoid_negative_ts}
1470 is enabled.
1471
1472 With -map you can select from which stream the timestamps should be
1473 taken. You can leave either video or audio unchanged and sync the
1474 remaining stream(s) to the unchanged one.
1475
1476 @item -frame_drop_threshold @var{parameter}
1477 Frame drop threshold, which specifies how much behind video frames can
1478 be before they are dropped. In frame rate units, so 1.0 is one frame.
1479 The default is -1.1. One possible usecase is to avoid framedrops in case
1480 of noisy timestamps or to increase frame drop precision in case of exact
1481 timestamps.
1482
1483 @item -async @var{samples_per_second}
1484 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
1485 the parameter is the maximum samples per second by which the audio is changed.
1486 -async 1 is a special case where only the start of the audio stream is corrected
1487 without any later correction.
1488
1489 Note that the timestamps may be further modified by the muxer, after this.
1490 For example, in the case that the format option @option{avoid_negative_ts}
1491 is enabled.
1492
1493 This option has been deprecated. Use the @code{aresample} audio filter instead.
1494
1495 @item -copyts
1496 Do not process input timestamps, but keep their values without trying
1497 to sanitize them. In particular, do not remove the initial start time
1498 offset value.
1499
1500 Note that, depending on the @option{vsync} option or on specific muxer
1501 processing (e.g. in case the format option @option{avoid_negative_ts}
1502 is enabled) the output timestamps may mismatch with the input
1503 timestamps even when this option is selected.
1504
1505 @item -start_at_zero
1506 When used with @option{copyts}, shift input timestamps so they start at zero.
1507
1508 This means that using e.g. @code{-ss 50} will make output timestamps start at
1509 50 seconds, regardless of what timestamp the input file started at.
1510
1511 @item -copytb @var{mode}
1512 Specify how to set the encoder timebase when stream copying.  @var{mode} is an
1513 integer numeric value, and can assume one of the following values:
1514
1515 @table @option
1516 @item 1
1517 Use the demuxer timebase.
1518
1519 The time base is copied to the output encoder from the corresponding input
1520 demuxer. This is sometimes required to avoid non monotonically increasing
1521 timestamps when copying video streams with variable frame rate.
1522
1523 @item 0
1524 Use the decoder timebase.
1525
1526 The time base is copied to the output encoder from the corresponding input
1527 decoder.
1528
1529 @item -1
1530 Try to make the choice automatically, in order to generate a sane output.
1531 @end table
1532
1533 Default value is -1.
1534
1535 @item -enc_time_base[:@var{stream_specifier}] @var{timebase} (@emph{output,per-stream})
1536 Set the encoder timebase. @var{timebase} is a floating point number,
1537 and can assume one of the following values:
1538
1539 @table @option
1540 @item 0
1541 Assign a default value according to the media type.
1542
1543 For video - use 1/framerate, for audio - use 1/samplerate.
1544
1545 @item -1
1546 Use the input stream timebase when possible.
1547
1548 If an input stream is not available, the default timebase will be used.
1549
1550 @item >0
1551 Use the provided number as the timebase.
1552
1553 This field can be provided as a ratio of two integers (e.g. 1:24, 1:48000)
1554 or as a floating point number (e.g. 0.04166, 2.0833e-5)
1555 @end table
1556
1557 Default value is 0.
1558
1559 @item -bitexact (@emph{input/output})
1560 Enable bitexact mode for (de)muxer and (de/en)coder
1561 @item -shortest (@emph{output})
1562 Finish encoding when the shortest input stream ends.
1563 @item -dts_delta_threshold
1564 Timestamp discontinuity delta threshold.
1565 @item -dts_error_threshold @var{seconds}
1566 Timestamp error delta threshold. This threshold use to discard crazy/damaged
1567 timestamps and the default is 30 hours which is arbitrarily picked and quite
1568 conservative.
1569 @item -muxdelay @var{seconds} (@emph{output})
1570 Set the maximum demux-decode delay.
1571 @item -muxpreload @var{seconds} (@emph{output})
1572 Set the initial demux-decode delay.
1573 @item -streamid @var{output-stream-index}:@var{new-value} (@emph{output})
1574 Assign a new stream-id value to an output stream. This option should be
1575 specified prior to the output filename to which it applies.
1576 For the situation where multiple output files exist, a streamid
1577 may be reassigned to a different value.
1578
1579 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
1580 an output mpegts file:
1581 @example
1582 ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
1583 @end example
1584
1585 @item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
1586 Set bitstream filters for matching streams. @var{bitstream_filters} is
1587 a comma-separated list of bitstream filters. Use the @code{-bsfs} option
1588 to get the list of bitstream filters.
1589 @example
1590 ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
1591 @end example
1592 @example
1593 ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
1594 @end example
1595
1596 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{input/output,per-stream})
1597 Force a tag/fourcc for matching streams.
1598
1599 @item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
1600 Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
1601 (or '.') for drop.
1602 @example
1603 ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
1604 @end example
1605
1606 @anchor{filter_complex_option}
1607 @item -filter_complex @var{filtergraph} (@emph{global})
1608 Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1609 outputs. For simple graphs -- those with one input and one output of the same
1610 type -- see the @option{-filter} options. @var{filtergraph} is a description of
1611 the filtergraph, as described in the ``Filtergraph syntax'' section of the
1612 ffmpeg-filters manual.
1613
1614 Input link labels must refer to input streams using the
1615 @code{[file_index:stream_specifier]} syntax (i.e. the same as @option{-map}
1616 uses). If @var{stream_specifier} matches multiple streams, the first one will be
1617 used. An unlabeled input will be connected to the first unused input stream of
1618 the matching type.
1619
1620 Output link labels are referred to with @option{-map}. Unlabeled outputs are
1621 added to the first output file.
1622
1623 Note that with this option it is possible to use only lavfi sources without
1624 normal input files.
1625
1626 For example, to overlay an image over video
1627 @example
1628 ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
1629 '[out]' out.mkv
1630 @end example
1631 Here @code{[0:v]} refers to the first video stream in the first input file,
1632 which is linked to the first (main) input of the overlay filter. Similarly the
1633 first video stream in the second input is linked to the second (overlay) input
1634 of overlay.
1635
1636 Assuming there is only one video stream in each input file, we can omit input
1637 labels, so the above is equivalent to
1638 @example
1639 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
1640 '[out]' out.mkv
1641 @end example
1642
1643 Furthermore we can omit the output label and the single output from the filter
1644 graph will be added to the output file automatically, so we can simply write
1645 @example
1646 ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
1647 @end example
1648
1649 To generate 5 seconds of pure red video using lavfi @code{color} source:
1650 @example
1651 ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
1652 @end example
1653
1654 @item -filter_complex_threads @var{nb_threads} (@emph{global})
1655 Defines how many threads are used to process a filter_complex graph.
1656 Similar to filter_threads but used for @code{-filter_complex} graphs only.
1657 The default is the number of available CPUs.
1658
1659 @item -lavfi @var{filtergraph} (@emph{global})
1660 Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or
1661 outputs. Equivalent to @option{-filter_complex}.
1662
1663 @item -filter_complex_script @var{filename} (@emph{global})
1664 This option is similar to @option{-filter_complex}, the only difference is that
1665 its argument is the name of the file from which a complex filtergraph
1666 description is to be read.
1667
1668 @item -accurate_seek (@emph{input})
1669 This option enables or disables accurate seeking in input files with the
1670 @option{-ss} option. It is enabled by default, so seeking is accurate when
1671 transcoding. Use @option{-noaccurate_seek} to disable it, which may be useful
1672 e.g. when copying some streams and transcoding the others.
1673
1674 @item -seek_timestamp (@emph{input})
1675 This option enables or disables seeking by timestamp in input files with the
1676 @option{-ss} option. It is disabled by default. If enabled, the argument
1677 to the @option{-ss} option is considered an actual timestamp, and is not
1678 offset by the start time of the file. This matters only for files which do
1679 not start from timestamp 0, such as transport streams.
1680
1681 @item -thread_queue_size @var{size} (@emph{input})
1682 This option sets the maximum number of queued packets when reading from the
1683 file or device. With low latency / high rate live streams, packets may be
1684 discarded if they are not read in a timely manner; raising this value can
1685 avoid it.
1686
1687 @item -sdp_file @var{file} (@emph{global})
1688 Print sdp information for an output stream to @var{file}.
1689 This allows dumping sdp information when at least one output isn't an
1690 rtp stream. (Requires at least one of the output formats to be rtp).
1691
1692 @item -discard (@emph{input})
1693 Allows discarding specific streams or frames from streams.
1694 Any input stream can be fully discarded, using value @code{all} whereas
1695 selective discarding of frames from a stream occurs at the demuxer
1696 and is not supported by all demuxers.
1697
1698 @table @option
1699 @item none
1700 Discard no frame.
1701
1702 @item default
1703 Default, which discards no frames.
1704
1705 @item noref
1706 Discard all non-reference frames.
1707
1708 @item bidir
1709 Discard all bidirectional frames.
1710
1711 @item nokey
1712 Discard all frames excepts keyframes.
1713
1714 @item all
1715 Discard all frames.
1716 @end table
1717
1718 @item -abort_on @var{flags} (@emph{global})
1719 Stop and abort on various conditions. The following flags are available:
1720
1721 @table @option
1722 @item empty_output
1723 No packets were passed to the muxer, the output is empty.
1724 @item empty_output_stream
1725 No packets were passed to the muxer in some of the output streams.
1726 @end table
1727
1728 @item -xerror (@emph{global})
1729 Stop and exit on error
1730
1731 @item -max_muxing_queue_size @var{packets} (@emph{output,per-stream})
1732 When transcoding audio and/or video streams, ffmpeg will not begin writing into
1733 the output until it has one packet for each such stream. While waiting for that
1734 to happen, packets for other streams are buffered. This option sets the size of
1735 this buffer, in packets, for the matching output stream.
1736
1737 The default value of this option should be high enough for most uses, so only
1738 touch this option if you are sure that you need it.
1739
1740 @end table
1741
1742 As a special exception, you can use a bitmap subtitle stream as input: it
1743 will be converted into a video with the same size as the largest video in
1744 the file, or 720x576 if no video is present. Note that this is an
1745 experimental and temporary solution. It will be removed once libavfilter has
1746 proper support for subtitles.
1747
1748 For example, to hardcode subtitles on top of a DVB-T recording stored in
1749 MPEG-TS format, delaying the subtitles by 1 second:
1750 @example
1751 ffmpeg -i input.ts -filter_complex \
1752   '[#0x2ef] setpts=PTS+1/TB [sub] ; [#0x2d0] [sub] overlay' \
1753   -sn -map '#0x2dc' output.mkv
1754 @end example
1755 (0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video,
1756 audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too)
1757
1758 @section Preset files
1759 A preset file contains a sequence of @var{option}=@var{value} pairs,
1760 one for each line, specifying a sequence of options which would be
1761 awkward to specify on the command line. Lines starting with the hash
1762 ('#') character are ignored and are used to provide comments. Check
1763 the @file{presets} directory in the FFmpeg source tree for examples.
1764
1765 There are two types of preset files: ffpreset and avpreset files.
1766
1767 @subsection ffpreset files
1768 ffpreset files are specified with the @code{vpre}, @code{apre},
1769 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
1770 filename of the preset instead of a preset name as input and can be
1771 used for any kind of codec. For the @code{vpre}, @code{apre}, and
1772 @code{spre} options, the options specified in a preset file are
1773 applied to the currently selected codec of the same type as the preset
1774 option.
1775
1776 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
1777 preset options identifies the preset file to use according to the
1778 following rules:
1779
1780 First ffmpeg searches for a file named @var{arg}.ffpreset in the
1781 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
1782 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
1783 or in a @file{ffpresets} folder along the executable on win32,
1784 in that order. For example, if the argument is @code{libvpx-1080p}, it will
1785 search for the file @file{libvpx-1080p.ffpreset}.
1786
1787 If no such file is found, then ffmpeg will search for a file named
1788 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
1789 directories, where @var{codec_name} is the name of the codec to which
1790 the preset file options will be applied. For example, if you select
1791 the video codec with @code{-vcodec libvpx} and use @code{-vpre 1080p},
1792 then it will search for the file @file{libvpx-1080p.ffpreset}.
1793
1794 @subsection avpreset files
1795 avpreset files are specified with the @code{pre} option. They work similar to
1796 ffpreset files, but they only allow encoder- specific options. Therefore, an
1797 @var{option}=@var{value} pair specifying an encoder cannot be used.
1798
1799 When the @code{pre} option is specified, ffmpeg will look for files with the
1800 suffix .avpreset in the directories @file{$AVCONV_DATADIR} (if set), and
1801 @file{$HOME/.avconv}, and in the datadir defined at configuration time (usually
1802 @file{PREFIX/share/ffmpeg}), in that order.
1803
1804 First ffmpeg searches for a file named @var{codec_name}-@var{arg}.avpreset in
1805 the above-mentioned directories, where @var{codec_name} is the name of the codec
1806 to which the preset file options will be applied. For example, if you select the
1807 video codec with @code{-vcodec libvpx} and use @code{-pre 1080p}, then it will
1808 search for the file @file{libvpx-1080p.avpreset}.
1809
1810 If no such file is found, then ffmpeg will search for a file named
1811 @var{arg}.avpreset in the same directories.
1812
1813 @c man end OPTIONS
1814
1815 @chapter Examples
1816 @c man begin EXAMPLES
1817
1818 @section Video and Audio grabbing
1819
1820 If you specify the input format and device then ffmpeg can grab video
1821 and audio directly.
1822
1823 @example
1824 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
1825 @end example
1826
1827 Or with an ALSA audio source (mono input, card id 1) instead of OSS:
1828 @example
1829 ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
1830 @end example
1831
1832 Note that you must activate the right video source and channel before
1833 launching ffmpeg with any TV viewer such as
1834 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
1835 have to set the audio recording levels correctly with a
1836 standard mixer.
1837
1838 @section X11 grabbing
1839
1840 Grab the X11 display with ffmpeg via
1841
1842 @example
1843 ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
1844 @end example
1845
1846 0.0 is display.screen number of your X11 server, same as
1847 the DISPLAY environment variable.
1848
1849 @example
1850 ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
1851 @end example
1852
1853 0.0 is display.screen number of your X11 server, same as the DISPLAY environment
1854 variable. 10 is the x-offset and 20 the y-offset for the grabbing.
1855
1856 @section Video and Audio file format conversion
1857
1858 Any supported file format and protocol can serve as input to ffmpeg:
1859
1860 Examples:
1861 @itemize
1862 @item
1863 You can use YUV files as input:
1864
1865 @example
1866 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
1867 @end example
1868
1869 It will use the files:
1870 @example
1871 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
1872 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
1873 @end example
1874
1875 The Y files use twice the resolution of the U and V files. They are
1876 raw files, without header. They can be generated by all decent video
1877 decoders. You must specify the size of the image with the @option{-s} option
1878 if ffmpeg cannot guess it.
1879
1880 @item
1881 You can input from a raw YUV420P file:
1882
1883 @example
1884 ffmpeg -i /tmp/test.yuv /tmp/out.avi
1885 @end example
1886
1887 test.yuv is a file containing raw YUV planar data. Each frame is composed
1888 of the Y plane followed by the U and V planes at half vertical and
1889 horizontal resolution.
1890
1891 @item
1892 You can output to a raw YUV420P file:
1893
1894 @example
1895 ffmpeg -i mydivx.avi hugefile.yuv
1896 @end example
1897
1898 @item
1899 You can set several input files and output files:
1900
1901 @example
1902 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
1903 @end example
1904
1905 Converts the audio file a.wav and the raw YUV video file a.yuv
1906 to MPEG file a.mpg.
1907
1908 @item
1909 You can also do audio and video conversions at the same time:
1910
1911 @example
1912 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1913 @end example
1914
1915 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1916
1917 @item
1918 You can encode to several formats at the same time and define a
1919 mapping from input stream to output streams:
1920
1921 @example
1922 ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
1923 @end example
1924
1925 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1926 file:index' specifies which input stream is used for each output
1927 stream, in the order of the definition of output streams.
1928
1929 @item
1930 You can transcode decrypted VOBs:
1931
1932 @example
1933 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
1934 @end example
1935
1936 This is a typical DVD ripping example; the input is a VOB file, the
1937 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1938 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1939 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1940 input video. Furthermore, the audio stream is MP3-encoded so you need
1941 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1942 The mapping is particularly useful for DVD transcoding
1943 to get the desired audio language.
1944
1945 NOTE: To see the supported input formats, use @code{ffmpeg -demuxers}.
1946
1947 @item
1948 You can extract images from a video, or create a video from many images:
1949
1950 For extracting images from a video:
1951 @example
1952 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1953 @end example
1954
1955 This will extract one video frame per second from the video and will
1956 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1957 etc. Images will be rescaled to fit the new WxH values.
1958
1959 If you want to extract just a limited number of frames, you can use the
1960 above command in combination with the @code{-frames:v} or @code{-t} option,
1961 or in combination with -ss to start extracting from a certain point in time.
1962
1963 For creating a video from many images:
1964 @example
1965 ffmpeg -f image2 -framerate 12 -i foo-%03d.jpeg -s WxH foo.avi
1966 @end example
1967
1968 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1969 composed of three digits padded with zeroes to express the sequence
1970 number. It is the same syntax supported by the C printf function, but
1971 only formats accepting a normal integer are suitable.
1972
1973 When importing an image sequence, -i also supports expanding
1974 shell-like wildcard patterns (globbing) internally, by selecting the
1975 image2-specific @code{-pattern_type glob} option.
1976
1977 For example, for creating a video from filenames matching the glob pattern
1978 @code{foo-*.jpeg}:
1979 @example
1980 ffmpeg -f image2 -pattern_type glob -framerate 12 -i 'foo-*.jpeg' -s WxH foo.avi
1981 @end example
1982
1983 @item
1984 You can put many streams of the same type in the output:
1985
1986 @example
1987 ffmpeg -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
1988 @end example
1989
1990 The resulting output file @file{test12.nut} will contain the first four streams
1991 from the input files in reverse order.
1992
1993 @item
1994 To force CBR video output:
1995 @example
1996 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
1997 @end example
1998
1999 @item
2000 The four options lmin, lmax, mblmin and mblmax use 'lambda' units,
2001 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
2002 @example
2003 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
2004 @end example
2005
2006 @end itemize
2007 @c man end EXAMPLES
2008
2009 @include config.texi
2010 @ifset config-all
2011 @ifset config-avutil
2012 @include utils.texi
2013 @end ifset
2014 @ifset config-avcodec
2015 @include codecs.texi
2016 @include bitstream_filters.texi
2017 @end ifset
2018 @ifset config-avformat
2019 @include formats.texi
2020 @include protocols.texi
2021 @end ifset
2022 @ifset config-avdevice
2023 @include devices.texi
2024 @end ifset
2025 @ifset config-swresample
2026 @include resampler.texi
2027 @end ifset
2028 @ifset config-swscale
2029 @include scaler.texi
2030 @end ifset
2031 @ifset config-avfilter
2032 @include filters.texi
2033 @end ifset
2034 @end ifset
2035
2036 @chapter See Also
2037
2038 @ifhtml
2039 @ifset config-all
2040 @url{ffmpeg.html,ffmpeg}
2041 @end ifset
2042 @ifset config-not-all
2043 @url{ffmpeg-all.html,ffmpeg-all},
2044 @end ifset
2045 @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
2046 @url{ffmpeg-utils.html,ffmpeg-utils},
2047 @url{ffmpeg-scaler.html,ffmpeg-scaler},
2048 @url{ffmpeg-resampler.html,ffmpeg-resampler},
2049 @url{ffmpeg-codecs.html,ffmpeg-codecs},
2050 @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
2051 @url{ffmpeg-formats.html,ffmpeg-formats},
2052 @url{ffmpeg-devices.html,ffmpeg-devices},
2053 @url{ffmpeg-protocols.html,ffmpeg-protocols},
2054 @url{ffmpeg-filters.html,ffmpeg-filters}
2055 @end ifhtml
2056
2057 @ifnothtml
2058 @ifset config-all
2059 ffmpeg(1),
2060 @end ifset
2061 @ifset config-not-all
2062 ffmpeg-all(1),
2063 @end ifset
2064 ffplay(1), ffprobe(1),
2065 ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
2066 ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
2067 ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
2068 @end ifnothtml
2069
2070 @include authors.texi
2071
2072 @ignore
2073
2074 @setfilename ffmpeg
2075 @settitle ffmpeg video converter
2076
2077 @end ignore
2078
2079 @bye