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