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