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