1 \input texinfo @c -*- texinfo -*-
3 @settitle FFmpeg Documentation
6 @center @titlefont{FFmpeg Documentation}
13 FFmpeg is a very fast video and audio converter. It can also grab from
14 a live audio/video source.
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
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.
27 @section Video and Audio grabbing
29 FFmpeg can grab video and audio from devices given that you specify the input
33 ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
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://bytesex.org/xawtv/}) by Gerd Knorr. You also
39 have to set the audio recording levels correctly with a
44 FFmpeg can grab the X11 display.
47 ffmpeg -f x11grab -s cif -i :0.0 /tmp/out.mpg
50 0.0 is display.screen number of your X11 server, same as
51 the DISPLAY environment variable.
54 ffmpeg -f x11grab -s cif -i :0.0+10,20 /tmp/out.mpg
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.
60 @section Video and Audio file format conversion
62 * FFmpeg can use any supported file format and protocol as input:
66 * You can use YUV files as input:
69 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
72 It will use the files:
74 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
75 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
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.
83 * You can input from a raw YUV420P file:
86 ffmpeg -i /tmp/test.yuv /tmp/out.avi
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.
93 * You can output to a raw YUV420P file:
96 ffmpeg -i mydivx.avi hugefile.yuv
99 * You can set several input files and output files:
102 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
105 Converts the audio file a.wav and the raw YUV video file a.yuv
108 * You can also do audio and video conversions at the same time:
111 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
114 Converts a.wav to MPEG audio at 22050Hz sample rate.
116 * You can encode to several formats at the same time and define a
117 mapping from input stream to output streams:
120 ffmpeg -i /tmp/a.wav -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
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.
127 * You can transcode decrypted VOBs:
130 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
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.
142 NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
149 The generic syntax is:
152 @c man begin SYNOPSIS
153 ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
156 @c man begin DESCRIPTION
157 As a general rule, options are applied to the next specified
158 file. Therefore, order is important, and you can have the same
159 option on the command line multiple times. Each occurrence is
160 then applied to the next input or output file.
162 * To set the video bitrate of the output file to 64kbit/s:
164 ffmpeg -i input.avi -b 64k output.avi
167 * To force the frame rate of the input and output file to 24 fps:
169 ffmpeg -r 24 -i input.avi output.avi
172 * To force the frame rate of the output file to 24 fps:
174 ffmpeg -i input.avi -r 24 output.avi
177 * To force the frame rate of input file to 1 fps and the output file to 24 fps:
179 ffmpeg -r 1 -i input.avi -r 24 output.avi
182 The format option may be needed for raw input files.
184 By default, FFmpeg tries to convert as losslessly as possible: It
185 uses the same audio and video parameters for the outputs as the one
186 specified for the inputs.
190 @section Main options
203 Show available formats, codecs, protocols, ...
208 @item -i @var{filename}
212 Overwrite output files.
214 @item -t @var{duration}
215 Restrict the transcoded/captured video sequence
216 to the duration specified in seconds.
217 @code{hh:mm:ss[.xxx]} syntax is also supported.
219 @item -fs @var{limit_size}
220 Set the file size limit.
222 @item -ss @var{position}
223 Seek to given time position in seconds.
224 @code{hh:mm:ss[.xxx]} syntax is also supported.
226 @item -itsoffset @var{offset}
227 Set the input time offset in seconds.
228 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
229 This option affects all the input files that follow it.
230 The offset is added to the timestamps of the input files.
231 Specifying a positive offset means that the corresponding
232 streams are delayed by 'offset' seconds.
234 @item -title @var{string}
237 @item -timestamp @var{time}
240 @item -author @var{string}
243 @item -copyright @var{string}
246 @item -comment @var{string}
249 @item -album @var{string}
252 @item -track @var{number}
255 @item -year @var{number}
258 @item -v @var{number}
259 Set the logging verbosity level.
261 @item -target @var{type}
262 Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
263 "ntsc-svcd", ... ). All the format options (bitrate, codecs,
264 buffer sizes) are then set automatically. You can just type:
267 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
270 Nevertheless you can specify additional options as long as you know
271 they do not conflict with the standard, as in:
274 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
277 @item -dframes @var{number}
278 Set the number of data frames to record.
280 @item -scodec @var{codec}
281 Force subtitle codec ('copy' to copy stream).
284 Add a new subtitle stream to the current output stream.
286 @item -slang @var{code}
287 Set the ISO 639 language code (3 letters) of the current subtitle stream.
291 @section Video Options
294 @item -b @var{bitrate}
295 Set the video bitrate in bit/s (default = 200 kb/s).
296 @item -vframes @var{number}
297 Set the number of video frames to record.
299 Set frame rate (Hz value, fraction or abbreviation), (default = 25).
301 Set frame size. The format is @samp{wxh} (ffserver default = 160x128, ffmpeg default = same as source).
302 The following abbreviations are recognized:
362 @item -aspect @var{aspect}
363 Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
364 @item -croptop @var{size}
365 Set top crop band size (in pixels).
366 @item -cropbottom @var{size}
367 Set bottom crop band size (in pixels).
368 @item -cropleft @var{size}
369 Set left crop band size (in pixels).
370 @item -cropright @var{size}
371 Set right crop band size (in pixels).
372 @item -padtop @var{size}
373 Set top pad band size (in pixels).
374 @item -padbottom @var{size}
375 Set bottom pad band size (in pixels).
376 @item -padleft @var{size}
377 Set left pad band size (in pixels).
378 @item -padright @var{size}
379 Set right pad band size (in pixels).
380 @item -padcolor @var{hex_color}
381 Set color of padded bands. The value for padcolor is expressed
382 as a six digit hexadecimal number where the first two digits
383 represent red, the middle two digits green and last two digits
384 blue (default = 000000 (black)).
386 Disable video recording.
387 @item -bt @var{tolerance}
388 Set video bitrate tolerance (in bits, default 4000k).
389 Has a minimum value of: (target_bitrate/target_framerate).
390 In 1-pass mode, bitrate tolerance specifies how far ratecontrol is
391 willing to deviate from the target average bitrate value. This is
392 not related to min/max bitrate. Lowering tolerance too much has
393 an adverse effect on quality.
394 @item -maxrate @var{bitrate}
395 Set max video bitrate (in bit/s).
396 Requires -bufsize to be set.
397 @item -minrate @var{bitrate}
398 Set min video bitrate (in bit/s).
399 Most useful in setting up a CBR encode:
401 ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
403 It is of little use elsewise.
404 @item -bufsize @var{size}
405 Set video buffer verifier buffer size (in bits).
406 @item -vcodec @var{codec}
407 Force video codec to @var{codec}. Use the @code{copy} special value to
408 tell that the raw codec data must be copied as is.
410 Use same video quality as source (implies VBR).
413 Select the pass number (1 or 2). It is useful to do two pass
414 encoding. The statistics of the video are recorded in the first
415 pass and the video is generated at the exact requested bitrate
418 @item -passlogfile @var{file}
419 Set two pass logfile name to @var{file}.
422 Add a new video stream to the current output stream.
426 @section Advanced Video Options
429 @item -pix_fmt @var{format}
430 Set pixel format. Use 'list' as parameter to show all the supported
432 @item -sws_flags @var{flags}
433 Set SwScaler flags (only available when compiled with swscale support).
434 @item -g @var{gop_size}
435 Set the group of pictures size.
437 Use only intra frames.
440 @item -qscale @var{q}
441 Use fixed video quantizer scale (VBR).
443 minimum video quantizer scale (VBR)
445 maximum video quantizer scale (VBR)
447 maximum difference between the quantizer scales (VBR)
448 @item -qblur @var{blur}
449 video quantizer scale blur (VBR) (range 0.0 - 1.0)
450 @item -qcomp @var{compression}
451 video quantizer scale compression (VBR) (default 0.5).
452 Constant of ratecontrol equation. Recommended range for default rc_eq: 0.0-1.0
454 @item -lmin @var{lambda}
455 minimum video lagrange factor (VBR)
456 @item -lmax @var{lambda}
457 max video lagrange factor (VBR)
458 @item -mblmin @var{lambda}
459 minimum macroblock quantizer scale (VBR)
460 @item -mblmax @var{lambda}
461 maximum macroblock quantizer scale (VBR)
463 These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
464 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
466 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
469 @item -rc_init_cplx @var{complexity}
470 initial complexity for single pass encoding
471 @item -b_qfactor @var{factor}
472 qp factor between P- and B-frames
473 @item -i_qfactor @var{factor}
474 qp factor between P- and I-frames
475 @item -b_qoffset @var{offset}
476 qp offset between P- and B-frames
477 @item -i_qoffset @var{offset}
478 qp offset between P- and I-frames
479 @item -rc_eq @var{equation}
480 Set rate control equation (@pxref{FFmpeg formula
481 evaluator}) (default = @code{tex^qComp}).
482 @item -rc_override @var{override}
483 rate control override for specific intervals
484 @item -me_method @var{method}
485 Set motion estimation method to @var{method}.
486 Available methods are (from lowest to best quality):
489 Try just the (0, 0) vector.
498 exhaustive search (slow and marginally better than epzs)
501 @item -dct_algo @var{algo}
502 Set DCT algorithm to @var{algo}. Available values are:
505 FF_DCT_AUTO (default)
518 @item -idct_algo @var{algo}
519 Set IDCT algorithm to @var{algo}. Available values are:
522 FF_IDCT_AUTO (default)
546 Set error resilience to @var{n}.
549 FF_ER_CAREFUL (default)
555 FF_ER_VERY_AGGRESSIVE
558 @item -ec @var{bit_mask}
559 Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
560 the following values:
563 FF_EC_GUESS_MVS (default = enabled)
565 FF_EC_DEBLOCK (default = enabled)
568 @item -bf @var{frames}
569 Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
570 @item -mbd @var{mode}
574 FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
576 FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
578 FF_MB_DECISION_RD: rate distortion
582 Use four motion vector by macroblock (MPEG-4 only).
584 Use data partitioning (MPEG-4 only).
585 @item -bug @var{param}
586 Work around encoder bugs that are not auto-detected.
587 @item -strict @var{strictness}
588 How strictly to follow the standards.
590 Enable Advanced intra coding (h263+).
592 Enable Unlimited Motion Vector (h263+)
595 Deinterlace pictures.
597 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
598 Use this option if your input file is interlaced and you want
599 to keep the interlaced format for minimum losses.
600 The alternative is to deinterlace the input stream with
601 @option{-deinterlace}, but deinterlacing introduces losses.
603 Calculate PSNR of compressed frames.
605 Dump video coding statistics to @file{vstats_HHMMSS.log}.
606 @item -vstats_file @var{file}
607 Dump video coding statistics to @var{file}.
608 @item -vhook @var{module}
609 Insert video processing @var{module}. @var{module} contains the module
610 name and its parameters separated by spaces.
612 top=1/bottom=0/auto=-1 field first
613 @item -dc @var{precision}
615 @item -vtag @var{fourcc/tag}
616 Force video tag/fourcc.
619 @item -vbsf @var{bitstream_filter}
620 Bitstream filters available are "dump_extra", "remove_extra", "noise", "h264_mp4toannexb", "imxdump", "mjpegadump".
622 ffmpeg -i h264.mp4 -vcodec copy -vbsf h264_mp4toannexb -an out.h264
626 @section Audio Options
629 @item -aframes @var{number}
630 Set the number of audio frames to record.
632 Set the audio sampling frequency (default = 44100 Hz).
633 @item -ab @var{bitrate}
634 Set the audio bitrate in bit/s (default = 64k).
635 @item -ac @var{channels}
636 Set the number of audio channels (default = 1).
638 Disable audio recording.
639 @item -acodec @var{codec}
640 Force audio codec to @var{codec}. Use the @code{copy} special value to
641 specify that the raw codec data must be copied as is.
643 Add a new audio track to the output file. If you want to specify parameters,
644 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
646 Mapping will be done automatically, if the number of output streams is equal to
647 the number of input streams, else it will pick the first one that matches. You
648 can override the mapping using @code{-map} as usual.
652 ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
654 @item -alang @var{code}
655 Set the ISO 639 language code (3 letters) of the current audio stream.
658 @section Advanced Audio options:
661 @item -atag @var{fourcc/tag}
662 Force audio tag/fourcc.
663 @item -absf @var{bitstream_filter}
664 Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
667 @section Subtitle options:
670 @item -scodec @var{codec}
671 Force subtitle codec ('copy' to copy stream).
673 Add a new subtitle stream to the current output stream.
674 @item -slang @var{code}
675 Set the ISO 639 language code (3 letters) of the current subtitle stream.
676 @item -sbsf @var{bitstream_filter}
677 Bitstream filters available are "mov2textsub", "text2movsub".
679 ffmpeg -i file.mov -an -vn -sbsf mov2textsub -scodec copy -f rawvideo sub.txt
683 @section Audio/Video grab options
686 @item -vc @var{channel}
687 Set video grab channel (DV1394 only).
688 @item -tvstd @var{standard}
689 Set television standard (NTSC, PAL (SECAM)).
691 Synchronize read on input.
694 @section Advanced options
697 @item -map input stream id[:input stream id]
698 Set stream mapping from input streams to output streams.
699 Just enumerate the input streams in the order you want them in the output.
700 [input stream id] sets the (input) stream to sync against.
701 @item -map_meta_data @var{outfile}:@var{infile}
702 Set meta data information of @var{outfile} from @var{infile}.
704 Print specific debug info.
706 Add timings for benchmarking.
708 Dump each input packet.
710 When dumping packets, also dump the payload.
712 Only use bit exact algorithms (for codec testing).
714 Set packet size in bits.
716 Read input at native frame rate. Mainly used to simulate a grab device.
718 Loop over the input stream. Currently it works only for image
719 streams. This option is used for automatic FFserver testing.
720 @item -loop_output @var{number_of_times}
721 Repeatedly loop output for formats that support looping such as animated GIF
722 (0 will loop the output infinitely).
723 @item -threads @var{count}
725 @item -vsync @var{parameter}
726 Video sync method. Video will be stretched/squeezed to match the timestamps,
727 it is done by duplicating and dropping frames. With -map you can select from
728 which stream the timestamps should be taken. You can leave either video or
729 audio unchanged and sync the remaining stream(s) to the unchanged one.
730 @item -async @var{samples_per_second}
731 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
732 the parameter is the maximum samples per second by which the audio is changed.
733 -async 1 is a special case where only the start of the audio stream is corrected
734 without any later correction.
736 Copy timestamps from input to output.
738 Finish encoding when the shortest input stream ends.
739 @item -dts_delta_threshold
740 Timestamp discontinuity delta threshold.
741 @item -muxdelay @var{seconds}
742 Set the maximum demux-decode delay.
743 @item -muxpreload @var{seconds}
744 Set the initial demux-decode delay.
747 @node FFmpeg formula evaluator
748 @section FFmpeg formula evaluator
750 When evaluating a rate control string, FFmpeg uses an internal formula
753 The following binary operators are available: @code{+}, @code{-},
754 @code{*}, @code{/}, @code{^}.
756 The following unary operators are available: @code{+}, @code{-},
759 The following functions are available:
781 The following constants are available:
810 @settitle FFmpeg video converter
813 ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
824 The file name can be @file{-} to read from standard input or to write
827 FFmpeg also handles many protocols specified with an URL syntax.
829 Use 'ffmpeg -formats' to see a list of the supported protocols.
831 The protocol @code{http:} is currently used only to communicate with
832 FFserver (see the FFserver documentation). When FFmpeg will be a
833 video player it will also be used for streaming :-)
838 @item For streaming at very low bitrate application, use a low frame rate
839 and a small GOP size. This is especially true for RealVideo where
840 the Linux player does not seem to be very fast, so it can miss
841 frames. An example is:
844 ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
847 @item 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.
854 @item If your computer is not fast enough, you can speed up the
855 compression at the expense of the compression ratio. You can use
856 '-me zero' to speed up motion estimation, and '-intra' to disable
857 motion estimation completely (you have only I-frames, which means it
858 is about as good as JPEG compression).
860 @item To have very low audio bitrates, reduce the sampling frequency
861 (down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
863 @item To have a constant quality (but a variable bitrate), use the option
864 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
867 @item When converting video files, you can use the '-sameq' option which
868 uses the same quality factor in the encoder as in the decoder.
869 It allows almost lossless encoding.