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