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