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