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