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