Merge remote-tracking branch 'qatar/master'
[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 The generic syntax is:
15
16 @example
17 @c man begin SYNOPSIS
18 ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
19 @c man end
20 @end example
21
22 @chapter Description
23 @c man begin DESCRIPTION
24
25 ffmpeg is a very fast video and audio converter that can also grab from
26 a live audio/video source. It can also convert between arbitrary sample
27 rates and resize video on the fly with a high quality polyphase filter.
28
29 The command line interface is designed to be intuitive, in the sense
30 that ffmpeg tries to figure out all parameters that can possibly be
31 derived automatically. You usually only have to specify the target
32 bitrate you want.
33
34 As a general rule, options are applied to the next specified
35 file. Therefore, order is important, and you can have the same
36 option on the command line multiple times. Each occurrence is
37 then applied to the next input or output file.
38
39 @itemize
40 @item
41 To set the video bitrate of the output file to 64kbit/s:
42 @example
43 ffmpeg -i input.avi -b 64k output.avi
44 @end example
45
46 @item
47 To force the frame rate of the output file to 24 fps:
48 @example
49 ffmpeg -i input.avi -r 24 output.avi
50 @end example
51
52 @item
53 To force the frame rate of the input file (valid for raw formats only)
54 to 1 fps and the frame rate of the output file to 24 fps:
55 @example
56 ffmpeg -r 1 -i input.m2v -r 24 output.avi
57 @end example
58 @end itemize
59
60 The format option may be needed for raw input files.
61
62 By default ffmpeg tries to convert as losslessly as possible: It
63 uses the same audio and video parameters for the outputs as the one
64 specified for the inputs.
65
66 @c man end DESCRIPTION
67
68 @chapter Options
69 @c man begin OPTIONS
70
71 @include avtools-common-opts.texi
72
73 @section Main options
74
75 @table @option
76
77 @item -f @var{fmt}
78 Force format.
79
80 @item -i @var{filename}
81 input file name
82
83 @item -y
84 Overwrite output files.
85
86 @item -t @var{duration}
87 Restrict the transcoded/captured video sequence
88 to the duration specified in seconds.
89 @code{hh:mm:ss[.xxx]} syntax is also supported.
90
91 @item -fs @var{limit_size}
92 Set the file size limit.
93
94 @item -ss @var{position}
95 Seek to given time position in seconds.
96 @code{hh:mm:ss[.xxx]} syntax is also supported.
97
98 @item -itsoffset @var{offset}
99 Set the input time offset in seconds.
100 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
101 This option affects all the input files that follow it.
102 The offset is added to the timestamps of the input files.
103 Specifying a positive offset means that the corresponding
104 streams are delayed by 'offset' seconds.
105
106 @item -timestamp @var{time}
107 Set the recording timestamp in the container.
108 The syntax for @var{time} is:
109 @example
110 now|([(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH[:MM[:SS[.m...]]])|(HH[MM[SS[.m...]]]))[Z|z])
111 @end example
112 If the value is "now" it takes the current time.
113 Time is local time unless 'Z' or 'z' is appended, in which case it is
114 interpreted as UTC.
115 If the year-month-day part is not specified it takes the current
116 year-month-day.
117
118 @item -metadata @var{key}=@var{value}
119 Set a metadata key/value pair.
120
121 For example, for setting the title in the output file:
122 @example
123 ffmpeg -i in.avi -metadata title="my title" out.flv
124 @end example
125
126 @item -v @var{number}
127 Set the logging verbosity level.
128
129 @item -target @var{type}
130 Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
131 "ntsc-svcd", ... ). All the format options (bitrate, codecs,
132 buffer sizes) are then set automatically. You can just type:
133
134 @example
135 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
136 @end example
137
138 Nevertheless you can specify additional options as long as you know
139 they do not conflict with the standard, as in:
140
141 @example
142 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
143 @end example
144
145 @item -dframes @var{number}
146 Set the number of data frames to record.
147
148 @item -scodec @var{codec}
149 Force subtitle codec ('copy' to copy stream).
150
151 @item -newsubtitle
152 Add a new subtitle stream to the current output stream.
153
154 @item -slang @var{code}
155 Set the ISO 639 language code (3 letters) of the current subtitle stream.
156
157 @end table
158
159 @section Video Options
160
161 @table @option
162 @item -vframes @var{number}
163 Set the number of video frames to record.
164 @item -r @var{fps}
165 Set frame rate (Hz value, fraction or abbreviation), (default = 25).
166 @item -s @var{size}
167 Set frame size. The format is @samp{wxh} (ffserver default = 160x128).
168 There is no default for input streams,
169 for output streams it is set by default to the size of the source stream.
170 The following abbreviations are recognized:
171 @table @samp
172 @item sqcif
173 128x96
174 @item qcif
175 176x144
176 @item cif
177 352x288
178 @item 4cif
179 704x576
180 @item 16cif
181 1408x1152
182 @item qqvga
183 160x120
184 @item qvga
185 320x240
186 @item vga
187 640x480
188 @item svga
189 800x600
190 @item xga
191 1024x768
192 @item uxga
193 1600x1200
194 @item qxga
195 2048x1536
196 @item sxga
197 1280x1024
198 @item qsxga
199 2560x2048
200 @item hsxga
201 5120x4096
202 @item wvga
203 852x480
204 @item wxga
205 1366x768
206 @item wsxga
207 1600x1024
208 @item wuxga
209 1920x1200
210 @item woxga
211 2560x1600
212 @item wqsxga
213 3200x2048
214 @item wquxga
215 3840x2400
216 @item whsxga
217 6400x4096
218 @item whuxga
219 7680x4800
220 @item cga
221 320x200
222 @item ega
223 640x350
224 @item hd480
225 852x480
226 @item hd720
227 1280x720
228 @item hd1080
229 1920x1080
230 @end table
231
232 @item -aspect @var{aspect}
233 Set the video display aspect ratio specified by @var{aspect}.
234
235 @var{aspect} can be a floating point number string, or a string of the
236 form @var{num}:@var{den}, where @var{num} and @var{den} are the
237 numerator and denominator of the aspect ratio. For example "4:3",
238 "16:9", "1.3333", and "1.7777" are valid argument values.
239
240 @item -croptop @var{size}
241 @item -cropbottom @var{size}
242 @item -cropleft @var{size}
243 @item -cropright @var{size}
244 All the crop options have been removed. Use -vf
245 crop=width:height:x:y instead.
246
247 @item -padtop @var{size}
248 @item -padbottom @var{size}
249 @item -padleft @var{size}
250 @item -padright @var{size}
251 @item -padcolor @var{hex_color}
252 All the pad options have been removed. Use -vf
253 pad=width:height:x:y:color instead.
254 @item -vn
255 Disable video recording.
256 @item -bt @var{tolerance}
257 Set video bitrate tolerance (in bits, default 4000k).
258 Has a minimum value of: (target_bitrate/target_framerate).
259 In 1-pass mode, bitrate tolerance specifies how far ratecontrol is
260 willing to deviate from the target average bitrate value. This is
261 not related to min/max bitrate. Lowering tolerance too much has
262 an adverse effect on quality.
263 @item -maxrate @var{bitrate}
264 Set max video bitrate (in bit/s).
265 Requires -bufsize to be set.
266 @item -minrate @var{bitrate}
267 Set min video bitrate (in bit/s).
268 Most useful in setting up a CBR encode:
269 @example
270 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
271 @end example
272 It is of little use elsewise.
273 @item -bufsize @var{size}
274 Set video buffer verifier buffer size (in bits).
275 @item -vcodec @var{codec}
276 Force video codec to @var{codec}. Use the @code{copy} special value to
277 tell that the raw codec data must be copied as is.
278 @item -sameq
279 Use same quantizer as source (implies VBR).
280
281 @item -pass @var{n}
282 Select the pass number (1 or 2). It is used to do two-pass
283 video encoding. The statistics of the video are recorded in the first
284 pass into a log file (see also the option -passlogfile),
285 and in the second pass that log file is used to generate the video
286 at the exact requested bitrate.
287 On pass 1, you may just deactivate audio and set output to null,
288 examples for Windows and Unix:
289 @example
290 ffmpeg -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y NUL
291 ffmpeg -i foo.mov -vcodec libxvid -pass 1 -an -f rawvideo -y /dev/null
292 @end example
293
294 @item -passlogfile @var{prefix}
295 Set two-pass log file name prefix to @var{prefix}, the default file name
296 prefix is ``ffmpeg2pass''. The complete file name will be
297 @file{PREFIX-N.log}, where N is a number specific to the output
298 stream.
299
300 @item -newvideo
301 Add a new video stream to the current output stream.
302
303 @item -vlang @var{code}
304 Set the ISO 639 language code (3 letters) of the current video stream.
305
306 @item -vf @var{filter_graph}
307 @var{filter_graph} is a description of the filter graph to apply to
308 the input video.
309 Use the option "-filters" to show all the available filters (including
310 also sources and sinks).
311
312 @end table
313
314 @section Advanced Video Options
315
316 @table @option
317 @item -pix_fmt @var{format}
318 Set pixel format. Use 'list' as parameter to show all the supported
319 pixel formats.
320 @item -sws_flags @var{flags}
321 Set SwScaler flags.
322 @item -g @var{gop_size}
323 Set the group of pictures size.
324 @item -intra
325 Use only intra frames.
326 @item -vdt @var{n}
327 Discard threshold.
328 @item -qscale @var{q}
329 Use fixed video quantizer scale (VBR).
330 @item -qmin @var{q}
331 minimum video quantizer scale (VBR)
332 @item -qmax @var{q}
333 maximum video quantizer scale (VBR)
334 @item -qdiff @var{q}
335 maximum difference between the quantizer scales (VBR)
336 @item -qblur @var{blur}
337 video quantizer scale blur (VBR) (range 0.0 - 1.0)
338 @item -qcomp @var{compression}
339 video quantizer scale compression (VBR) (default 0.5).
340 Constant of ratecontrol equation. Recommended range for default rc_eq: 0.0-1.0
341
342 @item -lmin @var{lambda}
343 minimum video lagrange factor (VBR)
344 @item -lmax @var{lambda}
345 max video lagrange factor (VBR)
346 @item -mblmin @var{lambda}
347 minimum macroblock quantizer scale (VBR)
348 @item -mblmax @var{lambda}
349 maximum macroblock quantizer scale (VBR)
350
351 These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
352 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
353 @example
354 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
355 @end example
356
357 @item -rc_init_cplx @var{complexity}
358 initial complexity for single pass encoding
359 @item -b_qfactor @var{factor}
360 qp factor between P- and B-frames
361 @item -i_qfactor @var{factor}
362 qp factor between P- and I-frames
363 @item -b_qoffset @var{offset}
364 qp offset between P- and B-frames
365 @item -i_qoffset @var{offset}
366 qp offset between P- and I-frames
367 @item -rc_eq @var{equation}
368 Set rate control equation (see section "Expression Evaluation")
369 (default = @code{tex^qComp}).
370
371 When computing the rate control equation expression, besides the
372 standard functions defined in the section "Expression Evaluation", the
373 following functions are available:
374 @table @var
375 @item bits2qp(bits)
376 @item qp2bits(qp)
377 @end table
378
379 and the following constants are available:
380 @table @var
381 @item iTex
382 @item pTex
383 @item tex
384 @item mv
385 @item fCode
386 @item iCount
387 @item mcVar
388 @item var
389 @item isI
390 @item isP
391 @item isB
392 @item avgQP
393 @item qComp
394 @item avgIITex
395 @item avgPITex
396 @item avgPPTex
397 @item avgBPTex
398 @item avgTex
399 @end table
400
401 @item -rc_override @var{override}
402 Rate control override for specific intervals, formated as "int,int,int"
403 list separated with slashes. Two first values are the beginning and
404 end frame numbers, last one is quantizer to use if positive, or quality
405 factor if negative.
406 @item -me_method @var{method}
407 Set motion estimation method to @var{method}.
408 Available methods are (from lowest to best quality):
409 @table @samp
410 @item zero
411 Try just the (0, 0) vector.
412 @item phods
413 @item log
414 @item x1
415 @item hex
416 @item umh
417 @item epzs
418 (default method)
419 @item full
420 exhaustive search (slow and marginally better than epzs)
421 @end table
422
423 @item -dct_algo @var{algo}
424 Set DCT algorithm to @var{algo}. Available values are:
425 @table @samp
426 @item 0
427 FF_DCT_AUTO (default)
428 @item 1
429 FF_DCT_FASTINT
430 @item 2
431 FF_DCT_INT
432 @item 3
433 FF_DCT_MMX
434 @item 4
435 FF_DCT_MLIB
436 @item 5
437 FF_DCT_ALTIVEC
438 @end table
439
440 @item -idct_algo @var{algo}
441 Set IDCT algorithm to @var{algo}. Available values are:
442 @table @samp
443 @item 0
444 FF_IDCT_AUTO (default)
445 @item 1
446 FF_IDCT_INT
447 @item 2
448 FF_IDCT_SIMPLE
449 @item 3
450 FF_IDCT_SIMPLEMMX
451 @item 4
452 FF_IDCT_LIBMPEG2MMX
453 @item 5
454 FF_IDCT_PS2
455 @item 6
456 FF_IDCT_MLIB
457 @item 7
458 FF_IDCT_ARM
459 @item 8
460 FF_IDCT_ALTIVEC
461 @item 9
462 FF_IDCT_SH4
463 @item 10
464 FF_IDCT_SIMPLEARM
465 @end table
466
467 @item -er @var{n}
468 Set error resilience to @var{n}.
469 @table @samp
470 @item 1
471 FF_ER_CAREFUL (default)
472 @item 2
473 FF_ER_COMPLIANT
474 @item 3
475 FF_ER_AGGRESSIVE
476 @item 4
477 FF_ER_EXPLODE
478 @end table
479
480 @item -ec @var{bit_mask}
481 Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
482 the following values:
483 @table @samp
484 @item 1
485 FF_EC_GUESS_MVS (default = enabled)
486 @item 2
487 FF_EC_DEBLOCK (default = enabled)
488 @end table
489
490 @item -bf @var{frames}
491 Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
492 @item -mbd @var{mode}
493 macroblock decision
494 @table @samp
495 @item 0
496 FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in ffmpeg).
497 @item 1
498 FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
499 @item 2
500 FF_MB_DECISION_RD: rate distortion
501 @end table
502
503 @item -4mv
504 Use four motion vector by macroblock (MPEG-4 only).
505 @item -part
506 Use data partitioning (MPEG-4 only).
507 @item -bug @var{param}
508 Work around encoder bugs that are not auto-detected.
509 @item -strict @var{strictness}
510 How strictly to follow the standards.
511 @item -aic
512 Enable Advanced intra coding (h263+).
513 @item -umv
514 Enable Unlimited Motion Vector (h263+)
515
516 @item -deinterlace
517 Deinterlace pictures.
518 @item -ilme
519 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
520 Use this option if your input file is interlaced and you want
521 to keep the interlaced format for minimum losses.
522 The alternative is to deinterlace the input stream with
523 @option{-deinterlace}, but deinterlacing introduces losses.
524 @item -psnr
525 Calculate PSNR of compressed frames.
526 @item -vstats
527 Dump video coding statistics to @file{vstats_HHMMSS.log}.
528 @item -vstats_file @var{file}
529 Dump video coding statistics to @var{file}.
530 @item -top @var{n}
531 top=1/bottom=0/auto=-1 field first
532 @item -dc @var{precision}
533 Intra_dc_precision.
534 @item -vtag @var{fourcc/tag}
535 Force video tag/fourcc.
536 @item -qphist
537 Show QP histogram.
538 @item -vbsf @var{bitstream_filter}
539 Bitstream filters available are "dump_extra", "remove_extra", "noise", "h264_mp4toannexb", "imxdump", "mjpegadump", "mjpeg2jpeg".
540 @example
541 ffmpeg -i h264.mp4 -vcodec copy -vbsf h264_mp4toannexb -an out.h264
542 @end example
543 @item -force_key_frames @var{time}[,@var{time}...]
544 Force key frames at the specified timestamps, more precisely at the first
545 frames after each specified time.
546 This option can be useful to ensure that a seek point is present at a
547 chapter mark or any other designated place in the output file.
548 The timestamps must be specified in ascending order.
549 @end table
550
551 @section Audio Options
552
553 @table @option
554 @item -aframes @var{number}
555 Set the number of audio frames to record.
556 @item -ar @var{freq}
557 Set the audio sampling frequency. For output streams it is set by
558 default to the frequency of the corresponding input stream. For input
559 streams this option only makes sense for audio grabbing devices and raw
560 demuxers and is mapped to the corresponding demuxer options.
561 @item -aq @var{q}
562 Set the audio quality (codec-specific, VBR).
563 @item -ac @var{channels}
564 Set the number of audio channels. For output streams it is set by
565 default to the number of input audio channels. For input streams
566 this option only makes sense for audio grabbing devices and raw demuxers
567 and is mapped to the corresponding demuxer options.
568 @item -an
569 Disable audio recording.
570 @item -acodec @var{codec}
571 Force audio codec to @var{codec}. Use the @code{copy} special value to
572 specify that the raw codec data must be copied as is.
573 @item -newaudio
574 Add a new audio track to the output file. If you want to specify parameters,
575 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
576
577 Mapping will be done automatically, if the number of output streams is equal to
578 the number of input streams, else it will pick the first one that matches. You
579 can override the mapping using @code{-map} as usual.
580
581 Example:
582 @example
583 ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
584 @end example
585 @item -alang @var{code}
586 Set the ISO 639 language code (3 letters) of the current audio stream.
587 @end table
588
589 @section Advanced Audio options:
590
591 @table @option
592 @item -atag @var{fourcc/tag}
593 Force audio tag/fourcc.
594 @item -audio_service_type @var{type}
595 Set the type of service that the audio stream contains.
596 @table @option
597 @item ma
598 Main Audio Service (default)
599 @item ef
600 Effects
601 @item vi
602 Visually Impaired
603 @item hi
604 Hearing Impaired
605 @item di
606 Dialogue
607 @item co
608 Commentary
609 @item em
610 Emergency
611 @item vo
612 Voice Over
613 @item ka
614 Karaoke
615 @end table
616 @item -absf @var{bitstream_filter}
617 Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
618 @end table
619
620 @section Subtitle options:
621
622 @table @option
623 @item -scodec @var{codec}
624 Force subtitle codec ('copy' to copy stream).
625 @item -newsubtitle
626 Add a new subtitle stream to the current output stream.
627 @item -slang @var{code}
628 Set the ISO 639 language code (3 letters) of the current subtitle stream.
629 @item -sn
630 Disable subtitle recording.
631 @item -sbsf @var{bitstream_filter}
632 Bitstream filters available are "mov2textsub", "text2movsub".
633 @example
634 ffmpeg -i file.mov -an -vn -sbsf mov2textsub -scodec copy -f rawvideo sub.txt
635 @end example
636 @end table
637
638 @section Audio/Video grab options
639
640 @table @option
641 @item -vc @var{channel}
642 Set video grab channel (DV1394 only).
643 @item -tvstd @var{standard}
644 Set television standard (NTSC, PAL (SECAM)).
645 @item -isync
646 Synchronize read on input.
647 @end table
648
649 @section Advanced options
650
651 @table @option
652 @item -map @var{input_file_id}.@var{input_stream_id}[:@var{sync_file_id}.@var{sync_stream_id}]
653
654 Designate an input stream as a source for the output file. Each input
655 stream is identified by the input file index @var{input_file_id} and
656 the input stream index @var{input_stream_id} within the input
657 file. Both indexes start at 0. If specified,
658 @var{sync_file_id}.@var{sync_stream_id} sets which input stream
659 is used as a presentation sync reference.
660
661 The @code{-map} options must be specified just after the output file.
662 If any @code{-map} options are used, the number of @code{-map} options
663 on the command line must match the number of streams in the output
664 file. The first @code{-map} option on the command line specifies the
665 source for output stream 0, the second @code{-map} option specifies
666 the source for output stream 1, etc.
667
668 For example, if you have two audio streams in the first input file,
669 these streams are identified by "0.0" and "0.1". You can use
670 @code{-map} to select which stream to place in an output file. For
671 example:
672 @example
673 ffmpeg -i INPUT out.wav -map 0.1
674 @end example
675 will map the input stream in @file{INPUT} identified by "0.1" to
676 the (single) output stream in @file{out.wav}.
677
678 For example, to select the stream with index 2 from input file
679 @file{a.mov} (specified by the identifier "0.2"), and stream with
680 index 6 from input @file{b.mov} (specified by the identifier "1.6"),
681 and copy them to the output file @file{out.mov}:
682 @example
683 ffmpeg -i a.mov -i b.mov -vcodec copy -acodec copy out.mov -map 0.2 -map 1.6
684 @end example
685
686 To add more streams to the output file, you can use the
687 @code{-newaudio}, @code{-newvideo}, @code{-newsubtitle} options.
688
689 @item -map_meta_data @var{outfile}[,@var{metadata}]:@var{infile}[,@var{metadata}]
690 Deprecated, use @var{-map_metadata} instead.
691
692 @item -map_metadata @var{outfile}[,@var{metadata}]:@var{infile}[,@var{metadata}]
693 Set metadata information of @var{outfile} from @var{infile}. Note that those
694 are file indices (zero-based), not filenames.
695 Optional @var{metadata} parameters specify, which metadata to copy - (g)lobal
696 (i.e. metadata that applies to the whole file), per-(s)tream, per-(c)hapter or
697 per-(p)rogram. All metadata specifiers other than global must be followed by the
698 stream/chapter/program number. If metadata specifier is omitted, it defaults to
699 global.
700
701 By default, global metadata is copied from the first input file to all output files,
702 per-stream and per-chapter metadata is copied along with streams/chapters. These
703 default mappings are disabled by creating any mapping of the relevant type. A negative
704 file index can be used to create a dummy mapping that just disables automatic copying.
705
706 For example to copy metadata from the first stream of the input file to global metadata
707 of the output file:
708 @example
709 ffmpeg -i in.ogg -map_metadata 0:0,s0 out.mp3
710 @end example
711 @item -map_chapters @var{outfile}:@var{infile}
712 Copy chapters from @var{infile} to @var{outfile}. If no chapter mapping is specified,
713 then chapters are copied from the first input file with at least one chapter to all
714 output files. Use a negative file index to disable any chapter copying.
715 @item -debug @var{category}
716 Print specific debug info.
717 @var{category} is a number or a string containing one of the following values:
718 @table @samp
719 @item bitstream
720 @item buffers
721 picture buffer allocations
722 @item bugs
723 @item dct_coeff
724 @item er
725 error recognition
726 @item mb_type
727 macroblock (MB) type
728 @item mmco
729 memory management control operations (H.264)
730 @item mv
731 motion vector
732 @item pict
733 picture info
734 @item pts
735 @item qp
736 per-block quantization parameter (QP)
737 @item rc
738 rate control
739 @item skip
740 @item startcode
741 @item thread_ops
742 threading operations
743 @item vis_mb_type
744 visualize block types
745 @item vis_qp
746 visualize quantization parameter (QP), lower QP are tinted greener
747 @end table
748 @item -benchmark
749 Show benchmarking information at the end of an encode.
750 Shows CPU time used and maximum memory consumption.
751 Maximum memory consumption is not supported on all systems,
752 it will usually display as 0 if not supported.
753 @item -dump
754 Dump each input packet.
755 @item -hex
756 When dumping packets, also dump the payload.
757 @item -bitexact
758 Only use bit exact algorithms (for codec testing).
759 @item -ps @var{size}
760 Set RTP payload size in bytes.
761 @item -re
762 Read input at native frame rate. Mainly used to simulate a grab device.
763 @item -loop_input
764 Loop over the input stream. Currently it works only for image
765 streams. This option is used for automatic FFserver testing.
766 This option is deprecated, use -loop 1.
767 @item -loop_output @var{number_of_times}
768 Repeatedly loop output for formats that support looping such as animated GIF
769 (0 will loop the output infinitely).
770 This option is deprecated, use -loop.
771 @item -threads @var{count}
772 Thread count.
773 @item -vsync @var{parameter}
774 Video sync method.
775
776 @table @option
777 @item 0
778 Each frame is passed with its timestamp from the demuxer to the muxer.
779 @item 1
780 Frames will be duplicated and dropped to achieve exactly the requested
781 constant framerate.
782 @item 2
783 Frames are passed through with their timestamp or dropped so as to
784 prevent 2 frames from having the same timestamp.
785 @item -1
786 Chooses between 1 and 2 depending on muxer capabilities. This is the
787 default method.
788 @end table
789
790 With -map you can select from which stream the timestamps should be
791 taken. You can leave either video or audio unchanged and sync the
792 remaining stream(s) to the unchanged one.
793
794 @item -async @var{samples_per_second}
795 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
796 the parameter is the maximum samples per second by which the audio is changed.
797 -async 1 is a special case where only the start of the audio stream is corrected
798 without any later correction.
799 @item -copyts
800 Copy timestamps from input to output.
801 @item -copytb
802 Copy input stream time base from input to output when stream copying.
803 @item -shortest
804 Finish encoding when the shortest input stream ends.
805 @item -dts_delta_threshold
806 Timestamp discontinuity delta threshold.
807 @item -muxdelay @var{seconds}
808 Set the maximum demux-decode delay.
809 @item -muxpreload @var{seconds}
810 Set the initial demux-decode delay.
811 @item -streamid @var{output-stream-index}:@var{new-value}
812 Assign a new stream-id value to an output stream. This option should be
813 specified prior to the output filename to which it applies.
814 For the situation where multiple output files exist, a streamid
815 may be reassigned to a different value.
816
817 For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for
818 an output mpegts file:
819 @example
820 ffmpeg -i infile -streamid 0:33 -streamid 1:36 out.ts
821 @end example
822 @end table
823
824 @section Preset files
825
826 A preset file contains a sequence of @var{option}=@var{value} pairs,
827 one for each line, specifying a sequence of options which would be
828 awkward to specify on the command line. Lines starting with the hash
829 ('#') character are ignored and are used to provide comments. Check
830 the @file{ffpresets} directory in the FFmpeg source tree for examples.
831
832 Preset files are specified with the @code{vpre}, @code{apre},
833 @code{spre}, and @code{fpre} options. The @code{fpre} option takes the
834 filename of the preset instead of a preset name as input and can be
835 used for any kind of codec. For the @code{vpre}, @code{apre}, and
836 @code{spre} options, the options specified in a preset file are
837 applied to the currently selected codec of the same type as the preset
838 option.
839
840 The argument passed to the @code{vpre}, @code{apre}, and @code{spre}
841 preset options identifies the preset file to use according to the
842 following rules:
843
844 First ffmpeg searches for a file named @var{arg}.ffpreset in the
845 directories @file{$FFMPEG_DATADIR} (if set), and @file{$HOME/.ffmpeg}, and in
846 the datadir defined at configuration time (usually @file{PREFIX/share/ffmpeg})
847 or in a @file{ffpresets} folder along the executable on win32,
848 in that order. For example, if the argument is @code{libx264-max}, it will
849 search for the file @file{libx264-max.ffpreset}.
850
851 If no such file is found, then ffmpeg will search for a file named
852 @var{codec_name}-@var{arg}.ffpreset in the above-mentioned
853 directories, where @var{codec_name} is the name of the codec to which
854 the preset file options will be applied. For example, if you select
855 the video codec with @code{-vcodec libx264} and use @code{-vpre max},
856 then it will search for the file @file{libx264-max.ffpreset}.
857 @c man end
858
859 @chapter Tips
860 @c man begin TIPS
861
862 @itemize
863 @item
864 For streaming at very low bitrate application, use a low frame rate
865 and a small GOP size. This is especially true for RealVideo where
866 the Linux player does not seem to be very fast, so it can miss
867 frames. An example is:
868
869 @example
870 ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
871 @end example
872
873 @item
874 The parameter 'q' which is displayed while encoding is the current
875 quantizer. The value 1 indicates that a very good quality could
876 be achieved. The value 31 indicates the worst quality. If q=31 appears
877 too often, it means that the encoder cannot compress enough to meet
878 your bitrate. You must either increase the bitrate, decrease the
879 frame rate or decrease the frame size.
880
881 @item
882 If your computer is not fast enough, you can speed up the
883 compression at the expense of the compression ratio. You can use
884 '-me zero' to speed up motion estimation, and '-intra' to disable
885 motion estimation completely (you have only I-frames, which means it
886 is about as good as JPEG compression).
887
888 @item
889 To have very low audio bitrates, reduce the sampling frequency
890 (down to 22050 Hz for MPEG audio, 22050 or 11025 for AC-3).
891
892 @item
893 To have a constant quality (but a variable bitrate), use the option
894 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
895 quality).
896
897 @item
898 When converting video files, you can use the '-sameq' option which
899 uses the same quality factor in the encoder as in the decoder.
900 It allows almost lossless encoding.
901
902 @end itemize
903 @c man end TIPS
904
905 @chapter Examples
906 @c man begin EXAMPLES
907
908 @section Video and Audio grabbing
909
910 If you specify the input format and device then ffmpeg can grab video
911 and audio directly.
912
913 @example
914 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
915 @end example
916
917 Note that you must activate the right video source and channel before
918 launching ffmpeg with any TV viewer such as
919 @uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
920 have to set the audio recording levels correctly with a
921 standard mixer.
922
923 @section X11 grabbing
924
925 Grab the X11 display with ffmpeg via
926
927 @example
928 ffmpeg -f x11grab -s cif -r 25 -i :0.0 /tmp/out.mpg
929 @end example
930
931 0.0 is display.screen number of your X11 server, same as
932 the DISPLAY environment variable.
933
934 @example
935 ffmpeg -f x11grab -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
936 @end example
937
938 10 is the x-offset and 20 the y-offset for the grabbing.
939
940 @example
941 ffmpeg -f x11grab -follow_mouse centered -s cif -r 25 -i :0.0 /tmp/out.mpg
942 @end example
943
944 The grabbing region follows the mouse pointer, which stays at the center of
945 region.
946
947 @example
948 ffmpeg -f x11grab -follow_mouse 100 -s cif -r 25 -i :0.0 /tmp/out.mpg
949 @end example
950
951 Only follows when mouse pointer reaches within 100 pixels to the edge of
952 region.
953
954 @example
955 ffmpeg -f x11grab -show_region 1 -s cif -r 25 -i :0.0+10,20 /tmp/out.mpg
956 @end example
957
958 The grabbing region will be indicated on screen.
959
960 @example
961 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -s cif -r 25 -i :0.0 /tmp/out.mpg
962 @end example
963
964 The grabbing region indication will follow the mouse pointer.
965
966
967 @section Video and Audio file format conversion
968
969 Any supported file format and protocol can serve as input to ffmpeg:
970
971 Examples:
972 @itemize
973 @item
974 You can use YUV files as input:
975
976 @example
977 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
978 @end example
979
980 It will use the files:
981 @example
982 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
983 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
984 @end example
985
986 The Y files use twice the resolution of the U and V files. They are
987 raw files, without header. They can be generated by all decent video
988 decoders. You must specify the size of the image with the @option{-s} option
989 if ffmpeg cannot guess it.
990
991 @item
992 You can input from a raw YUV420P file:
993
994 @example
995 ffmpeg -i /tmp/test.yuv /tmp/out.avi
996 @end example
997
998 test.yuv is a file containing raw YUV planar data. Each frame is composed
999 of the Y plane followed by the U and V planes at half vertical and
1000 horizontal resolution.
1001
1002 @item
1003 You can output to a raw YUV420P file:
1004
1005 @example
1006 ffmpeg -i mydivx.avi hugefile.yuv
1007 @end example
1008
1009 @item
1010 You can set several input files and output files:
1011
1012 @example
1013 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
1014 @end example
1015
1016 Converts the audio file a.wav and the raw YUV video file a.yuv
1017 to MPEG file a.mpg.
1018
1019 @item
1020 You can also do audio and video conversions at the same time:
1021
1022 @example
1023 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
1024 @end example
1025
1026 Converts a.wav to MPEG audio at 22050 Hz sample rate.
1027
1028 @item
1029 You can encode to several formats at the same time and define a
1030 mapping from input stream to output streams:
1031
1032 @example
1033 ffmpeg -i /tmp/a.wav -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
1034 @end example
1035
1036 Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
1037 file:index' specifies which input stream is used for each output
1038 stream, in the order of the definition of output streams.
1039
1040 @item
1041 You can transcode decrypted VOBs:
1042
1043 @example
1044 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
1045 @end example
1046
1047 This is a typical DVD ripping example; the input is a VOB file, the
1048 output an AVI file with MPEG-4 video and MP3 audio. Note that in this
1049 command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
1050 GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
1051 input video. Furthermore, the audio stream is MP3-encoded so you need
1052 to enable LAME support by passing @code{--enable-libmp3lame} to configure.
1053 The mapping is particularly useful for DVD transcoding
1054 to get the desired audio language.
1055
1056 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
1057
1058 @item
1059 You can extract images from a video, or create a video from many images:
1060
1061 For extracting images from a video:
1062 @example
1063 ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
1064 @end example
1065
1066 This will extract one video frame per second from the video and will
1067 output them in files named @file{foo-001.jpeg}, @file{foo-002.jpeg},
1068 etc. Images will be rescaled to fit the new WxH values.
1069
1070 If you want to extract just a limited number of frames, you can use the
1071 above command in combination with the -vframes or -t option, or in
1072 combination with -ss to start extracting from a certain point in time.
1073
1074 For creating a video from many images:
1075 @example
1076 ffmpeg -f image2 -i foo-%03d.jpeg -r 12 -s WxH foo.avi
1077 @end example
1078
1079 The syntax @code{foo-%03d.jpeg} specifies to use a decimal number
1080 composed of three digits padded with zeroes to express the sequence
1081 number. It is the same syntax supported by the C printf function, but
1082 only formats accepting a normal integer are suitable.
1083
1084 @item
1085 You can put many streams of the same type in the output:
1086
1087 @example
1088 ffmpeg -i test1.avi -i test2.avi -vcodec copy -acodec copy -vcodec copy -acodec copy test12.avi -newvideo -newaudio
1089 @end example
1090
1091 In addition to the first video and audio streams, the resulting
1092 output file @file{test12.avi} will contain the second video
1093 and the second audio stream found in the input streams list.
1094
1095 The @code{-newvideo}, @code{-newaudio} and @code{-newsubtitle}
1096 options have to be specified immediately after the name of the output
1097 file to which you want to add them.
1098
1099 @end itemize
1100 @c man end EXAMPLES
1101
1102 @include eval.texi
1103 @include decoders.texi
1104 @include encoders.texi
1105 @include demuxers.texi
1106 @include muxers.texi
1107 @include indevs.texi
1108 @include outdevs.texi
1109 @include protocols.texi
1110 @include bitstream_filters.texi
1111 @include filters.texi
1112 @include metadata.texi
1113
1114 @ignore
1115
1116 @setfilename ffmpeg
1117 @settitle ffmpeg video converter
1118
1119 @c man begin SEEALSO
1120 ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
1121 @c man end
1122
1123 @c man begin AUTHORS
1124 The FFmpeg developers
1125 @c man end
1126
1127 @end ignore
1128
1129 @bye