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