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