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 audio_device -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, ...
212 Overwrite output files.
215 Set the recording time in seconds.
216 @code{hh:mm:ss[.xxx]} syntax is also supported.
219 Set the file size limit.
222 Seek to given time position in seconds.
223 @code{hh:mm:ss[.xxx]} syntax is also supported.
225 @item -itsoffset offset
226 Set the input time offset in seconds.
227 @code{[-]hh:mm:ss[.xxx]} syntax is also supported.
228 This option affects all the input files that follow it.
229 The offset is added to the timestamps of the input files.
230 Specifying a positive offset means that the corresponding
231 streams are delayed by 'offset' seconds.
236 @item -timestamp time
242 @item -copyright string
245 @item -comment string
258 Control amount of logging.
261 Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
262 "ntsc-svcd", ... ). All the format options (bitrate, codecs,
263 buffer sizes) are then set automatically. You can just type:
266 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
269 Nevertheless you can specify additional options as long as you know
270 they do not conflict with the standard, as in:
273 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
276 @item -dframes number
277 Set the number of data frames to record.
280 Force subtitle codec ('copy' to copy stream).
283 Add a new subtitle stream to the current output stream.
286 Set the ISO 639 language code (3 letters) of the current subtitle stream.
290 @section Video Options
294 Set the video bitrate in bit/s (default = 200 kb/s).
295 @item -vframes number
296 Set the number of video frames to record.
298 Set frame rate (Hz value, fraction or abbreviation), (default = 25).
300 Set frame size. The format is @samp{wxh} (ffserver default = 160x128, ffmpeg default = same as source).
301 The following abbreviations are recognized:
362 Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
364 Set top crop band size (in pixels).
365 @item -cropbottom size
366 Set bottom crop band size (in pixels).
368 Set left crop band size (in pixels).
369 @item -cropright size
370 Set right crop band size (in pixels).
372 Set top pad band size (in pixels).
373 @item -padbottom size
374 Set bottom pad band size (in pixels).
376 Set left pad band size (in pixels).
378 Set right pad band size (in pixels).
379 @item -padcolor (hex color)
380 Set color of padded bands. The value for padcolor is expressed
381 as a six digit hexadecimal number where the first two digits
382 represent red, the middle two digits green and last two digits
383 blue (default = 000000 (black)).
385 Disable video recording.
387 Set video bitrate tolerance (in bit/s).
388 @item -maxrate bitrate
389 Set max video bitrate tolerance (in bit/s).
390 @item -minrate bitrate
391 Set min video bitrate tolerance (in bit/s).
393 Set rate control buffer size (in bits).
395 Force video codec to @var{codec}. Use the @code{copy} special value to
396 tell that the raw codec data must be copied as is.
398 Use same video quality as source (implies VBR).
401 Select the pass number (1 or 2). It is useful to do two pass
402 encoding. The statistics of the video are recorded in the first
403 pass and the video is generated at the exact requested bitrate
406 @item -passlogfile file
407 Set two pass logfile name to @var{file}.
410 Add a new video stream to the current output stream.
414 @section Advanced Video Options
417 @item -pix_fmt format
418 Set pixel format. Use 'list' as parameter to show all the supported
420 @item -sws_flags flags
421 Set SwScaler flags (only available when compiled with SwScaler support).
423 Set the group of pictures size.
425 Use only intra frames.
429 Use fixed video quantizer scale (VBR).
431 minimum video quantizer scale (VBR)
433 maximum video quantizer scale (VBR)
435 maximum difference between the quantizer scales (VBR)
437 video quantizer scale blur (VBR)
438 @item -qcomp compression
439 video quantizer scale compression (VBR)
442 minimum video lagrange factor (VBR)
444 max video lagrange factor (VBR)
446 minimum macroblock quantizer scale (VBR)
448 maximum macroblock quantizer scale (VBR)
450 These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
451 but you may use the QP2LAMBDA constant to easily convert from 'q' units:
453 ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
456 @item -rc_init_cplx complexity
457 initial complexity for single pass encoding
458 @item -b_qfactor factor
459 qp factor between P- and B-frames
460 @item -i_qfactor factor
461 qp factor between P- and I-frames
462 @item -b_qoffset offset
463 qp offset between P- and B-frames
464 @item -i_qoffset offset
465 qp offset between P- and I-frames
466 @item -rc_eq equation
467 Set rate control equation (@pxref{FFmpeg formula
468 evaluator}) (default = @code{tex^qComp}).
469 @item -rc_override override
470 rate control override for specific intervals
472 Set motion estimation method to @var{method}.
473 Available methods are (from lowest to best quality):
476 Try just the (0, 0) vector.
483 exhaustive search (slow and marginally better than epzs)
487 Set DCT algorithm to @var{algo}. Available values are:
490 FF_DCT_AUTO (default)
503 @item -idct_algo algo
504 Set IDCT algorithm to @var{algo}. Available values are:
507 FF_IDCT_AUTO (default)
531 Set error resilience to @var{n}.
534 FF_ER_CAREFUL (default)
540 FF_ER_VERY_AGGRESSIVE
544 Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
545 the following values:
548 FF_EC_GUESS_MVS (default = enabled)
550 FF_EC_DEBLOCK (default = enabled)
554 Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
559 FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
561 FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
563 FF_MB_DECISION_RD: rate distortion
567 Use four motion vector by macroblock (MPEG-4 only).
569 Use data partitioning (MPEG-4 only).
571 Work around encoder bugs that are not auto-detected.
572 @item -strict strictness
573 How strictly to follow the standards.
575 Enable Advanced intra coding (h263+).
577 Enable Unlimited Motion Vector (h263+)
580 Deinterlace pictures.
582 Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
583 Use this option if your input file is interlaced and you want
584 to keep the interlaced format for minimum losses.
585 The alternative is to deinterlace the input stream with
586 @option{-deinterlace}, but deinterlacing introduces losses.
588 Calculate PSNR of compressed frames.
590 Dump video coding statistics to @file{vstats_HHMMSS.log}.
591 @item -vstats_file file
592 Dump video coding statistics to @var{file}.
594 Insert video processing @var{module}. @var{module} contains the module
595 name and its parameters separated by spaces.
597 top=1/bottom=0/auto=-1 field first
600 @item -vtag fourcc/tag
601 Force video tag/fourcc.
604 @item -vbsf bitstream filter
605 Bitstream filters available are "dump_extra", "remove_extra", "noise".
608 @section Audio Options
611 @item -aframes number
612 Set the number of audio frames to record.
614 Set the audio sampling frequency (default = 44100 Hz).
616 Set the audio bitrate in bit/s (default = 64k).
618 Set the number of audio channels (default = 1).
620 Disable audio recording.
622 Force audio codec to @var{codec}. Use the @code{copy} special value to
623 specify that the raw codec data must be copied as is.
625 Add a new audio track to the output file. If you want to specify parameters,
626 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
628 Mapping will be done automatically, if the number of output streams is equal to
629 the number of input streams, else it will pick the first one that matches. You
630 can override the mapping using @code{-map} as usual.
634 ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
637 Set the ISO 639 language code (3 letters) of the current audio stream.
640 @section Advanced Audio options:
643 @item -atag fourcc/tag
644 Force audio tag/fourcc.
645 @item -absf bitstream filter
646 Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
649 @section Subtitle options:
653 Force subtitle codec ('copy' to copy stream).
655 Add a new subtitle stream to the current output stream.
657 Set the ISO 639 language code (3 letters) of the current subtitle stream.
660 @section Audio/Video grab options
664 Set video grab channel (DV1394 only).
665 @item -tvstd standard
666 Set television standard (NTSC, PAL (SECAM)).
668 Synchronize read on input.
671 @section Advanced options
674 @item -map input stream id[:input stream id]
675 Set stream mapping from input streams to output streams.
676 Just enumerate the input streams in the order you want them in the output.
677 [input stream id] sets the (input) stream to sync against.
678 @item -map_meta_data outfile:infile
679 Set meta data information of outfile from infile.
681 Print specific debug info.
683 Add timings for benchmarking.
685 Dump each input packet.
687 When dumping packets, also dump the payload.
689 Only use bit exact algorithms (for codec testing).
691 Set packet size in bits.
693 Read input at native frame rate. Mainly used to simulate a grab device.
695 Loop over the input stream. Currently it works only for image
696 streams. This option is used for automatic FFserver testing.
697 @item -loop_output number_of_times
698 Repeatedly loop output for formats that support looping such as animated GIF
699 (0 will loop the output infinitely).
702 @item -vsync parameter
703 Video sync method. Video will be stretched/squeezed to match the timestamps,
704 it is done by duplicating and dropping frames. With -map you can select from
705 which stream the timestamps should be taken. You can leave either video or
706 audio unchanged and sync the remaining stream(s) to the unchanged one.
707 @item -async samples_per_second
708 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
709 the parameter is the maximum samples per second by which the audio is changed.
710 -async 1 is a special case where only the start of the audio stream is corrected
711 without any later correction.
713 Copy timestamps from input to output.
715 Finish encoding when the shortest input stream ends.
716 @item -dts_delta_threshold
717 Timestamp discontinuity delta threshold.
718 @item -muxdelay seconds
719 Set the maximum demux-decode delay.
720 @item -muxpreload seconds
721 Set the initial demux-decode delay.
724 @node FFmpeg formula evaluator
725 @section FFmpeg formula evaluator
727 When evaluating a rate control string, FFmpeg uses an internal formula
730 The following binary operators are available: @code{+}, @code{-},
731 @code{*}, @code{/}, @code{^}.
733 The following unary operators are available: @code{+}, @code{-},
736 The following functions are available:
758 The following constants are available:
787 @settitle FFmpeg video converter
790 ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
801 The filename can be @file{-} to read from standard input or to write
804 FFmpeg also handles many protocols specified with an URL syntax.
806 Use 'ffmpeg -formats' to see a list of the supported protocols.
808 The protocol @code{http:} is currently used only to communicate with
809 FFserver (see the FFserver documentation). When FFmpeg will be a
810 video player it will also be used for streaming :-)
815 @item For streaming at very low bitrate application, use a low frame rate
816 and a small GOP size. This is especially true for RealVideo where
817 the Linux player does not seem to be very fast, so it can miss
818 frames. An example is:
821 ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
824 @item The parameter 'q' which is displayed while encoding is the current
825 quantizer. The value 1 indicates that a very good quality could
826 be achieved. The value 31 indicates the worst quality. If q=31 appears
827 too often, it means that the encoder cannot compress enough to meet
828 your bitrate. You must either increase the bitrate, decrease the
829 frame rate or decrease the frame size.
831 @item If your computer is not fast enough, you can speed up the
832 compression at the expense of the compression ratio. You can use
833 '-me zero' to speed up motion estimation, and '-intra' to disable
834 motion estimation completely (you have only I-frames, which means it
835 is about as good as JPEG compression).
837 @item To have very low audio bitrates, reduce the sampling frequency
838 (down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
840 @item To have a constant quality (but a variable bitrate), use the option
841 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
844 @item When converting video files, you can use the '-sameq' option which
845 uses the same quality factor in the encoder as in the decoder.
846 It allows almost lossless encoding.
851 @chapter external libraries
853 FFmpeg can be hooked up with a number of external libraries to add support
854 for more formats. None of them are used by default, their use has to be
855 explicitly requested by passing the appropriate flags to @file{./configure}.
859 AMR comes in two different flavors, WB and NB. FFmpeg can make use of the
860 AMR WB (floating-point mode) and the AMR NB (floating-point mode) reference
861 decoders and encoders.
863 Go to @url{http://www.penguin.cz/~utx/amr} and follow the instructions for
864 installing the libraries. Then pass @code{--enable-libamr-nb} and/or
865 @code{--enable-libamr-wb} to configure to enable the libraries.
868 @chapter Supported File Formats and Codecs
870 You can use the @code{-formats} option to have an exhaustive list.
872 @section File Formats
874 FFmpeg supports the following file formats through the @code{libavformat}
877 @multitable @columnfractions .4 .1 .1 .4
878 @item Supported File Format @tab Encoding @tab Decoding @tab Comments
879 @item MPEG audio @tab X @tab X
880 @item MPEG-1 systems @tab X @tab X
881 @tab muxed audio and video
882 @item MPEG-2 PS @tab X @tab X
883 @tab also known as @code{VOB} file
884 @item MPEG-2 TS @tab @tab X
885 @tab also known as DVB Transport Stream
886 @item ASF@tab X @tab X
887 @item AVI@tab X @tab X
888 @item WAV@tab X @tab X
889 @item Macromedia Flash@tab X @tab X
890 @tab Only embedded audio is decoded.
891 @item FLV @tab X @tab X
892 @tab Macromedia Flash video files
893 @item Real Audio and Video @tab X @tab X
894 @item Raw AC3 @tab X @tab X
895 @item Raw MJPEG @tab X @tab X
896 @item Raw MPEG video @tab X @tab X
897 @item Raw PCM8/16 bits, mulaw/Alaw@tab X @tab X
898 @item Raw CRI ADX audio @tab X @tab X
899 @item Raw Shorten audio @tab @tab X
900 @item SUN AU format @tab X @tab X
901 @item NUT @tab X @tab X @tab NUT Open Container Format
902 @item QuickTime @tab X @tab X
903 @item MPEG-4 @tab X @tab X
904 @tab MPEG-4 is a variant of QuickTime.
905 @item Raw MPEG4 video @tab X @tab X
906 @item DV @tab X @tab X
907 @item 4xm @tab @tab X
908 @tab 4X Technologies format, used in some games.
909 @item Playstation STR @tab @tab X
910 @item Id RoQ @tab X @tab X
911 @tab Used in Quake III, Jedi Knight 2, other computer games.
912 @item Interplay MVE @tab @tab X
913 @tab Format used in various Interplay computer games.
914 @item WC3 Movie @tab @tab X
915 @tab Multimedia format used in Origin's Wing Commander III computer game.
916 @item Sega FILM/CPK @tab @tab X
917 @tab Used in many Sega Saturn console games.
918 @item Westwood Studios VQA/AUD @tab @tab X
919 @tab Multimedia formats used in Westwood Studios games.
920 @item Id Cinematic (.cin) @tab @tab X
921 @tab Used in Quake II.
922 @item FLIC format @tab @tab X
924 @item Sierra VMD @tab @tab X
925 @tab Used in Sierra CD-ROM games.
926 @item Sierra Online @tab @tab X
927 @tab .sol files used in Sierra Online games.
928 @item Matroska @tab @tab X
929 @item Electronic Arts Multimedia @tab @tab X
930 @tab Used in various EA games; files have extensions like WVE and UV2.
931 @item Nullsoft Video (NSV) format @tab @tab X
932 @item ADTS AAC audio @tab X @tab X
933 @item Creative VOC @tab X @tab X @tab Created for the Sound Blaster Pro.
934 @item American Laser Games MM @tab @tab X
935 @tab Multimedia format used in games like Mad Dog McCree
936 @item AVS @tab @tab X
937 @tab Multimedia format used by the Creature Shock game.
938 @item Smacker @tab @tab X
939 @tab Multimedia format used by many games.
940 @item GXF @tab X @tab X
941 @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley playout servers.
942 @item CIN @tab @tab X
943 @tab Multimedia format used by Delphine Software games.
944 @item MXF @tab @tab X
945 @tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
946 @item SEQ @tab @tab X
947 @tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
948 @item DXA @tab @tab X
949 @tab This format is used in non-Windows version of Feeble Files game and
950 different game cutscenes repacked for use with ScummVM.
951 @item THP @tab @tab X
952 @tab Used on the Nintendo GameCube.
953 @item C93 @tab @tab X
954 @tab Used in the game Cyberia from Interplay.
955 @item Bethsoft VID @tab @tab X
956 @tab Used in some games from Bethesda Softworks.
957 @item CRYO APC @tab @tab X
958 @tab Audio format used in some games by CRYO Interactive Entertainment.
961 @code{X} means that encoding (resp. decoding) is supported.
963 @section Image Formats
965 FFmpeg can read and write images for each frame of a video sequence. The
966 following image formats are supported:
968 @multitable @columnfractions .4 .1 .1 .4
969 @item Supported Image Format @tab Encoding @tab Decoding @tab Comments
970 @item PGM, PPM @tab X @tab X
971 @item PAM @tab X @tab X @tab PAM is a PNM extension with alpha support.
972 @item PGMYUV @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
973 @item JPEG @tab X @tab X @tab Progressive JPEG is not supported.
974 @item .Y.U.V @tab X @tab X @tab one raw file per component
975 @item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
976 @item PNG @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
977 @item Targa @tab @tab X @tab Targa (.TGA) image format.
978 @item TIFF @tab X @tab X @tab YUV, JPEG and some extension is not supported yet.
979 @item SGI @tab X @tab X @tab SGI RGB image format
980 @item PTX @tab @tab X @tab V.Flash PTX format
983 @code{X} means that encoding (resp. decoding) is supported.
985 @section Video Codecs
987 @multitable @columnfractions .4 .1 .1 .4
988 @item Supported Codec @tab Encoding @tab Decoding @tab Comments
989 @item MPEG-1 video @tab X @tab X
990 @item MPEG-2 video @tab X @tab X
991 @item MPEG-4 @tab X @tab X
992 @item MSMPEG4 V1 @tab X @tab X
993 @item MSMPEG4 V2 @tab X @tab X
994 @item MSMPEG4 V3 @tab X @tab X
995 @item WMV7 @tab X @tab X
996 @item WMV8 @tab X @tab X @tab not completely working
997 @item WMV9 @tab @tab X @tab not completely working
998 @item VC1 @tab @tab X
999 @item H.261 @tab X @tab X
1000 @item H.263(+) @tab X @tab X @tab also known as RealVideo 1.0
1001 @item H.264 @tab @tab X
1002 @item RealVideo 1.0 @tab X @tab X
1003 @item RealVideo 2.0 @tab X @tab X
1004 @item MJPEG @tab X @tab X
1005 @item lossless MJPEG @tab X @tab X
1006 @item JPEG-LS @tab X @tab X @tab fourcc: MJLS, lossless and near-lossless is supported
1007 @item Apple MJPEG-B @tab @tab X
1008 @item Sunplus MJPEG @tab @tab X @tab fourcc: SP5X
1009 @item DV @tab X @tab X
1010 @item HuffYUV @tab X @tab X
1011 @item FFmpeg Video 1 @tab X @tab X @tab experimental lossless codec (fourcc: FFV1)
1012 @item FFmpeg Snow @tab X @tab X @tab experimental wavelet codec (fourcc: SNOW)
1013 @item Asus v1 @tab X @tab X @tab fourcc: ASV1
1014 @item Asus v2 @tab X @tab X @tab fourcc: ASV2
1015 @item Creative YUV @tab @tab X @tab fourcc: CYUV
1016 @item Sorenson Video 1 @tab X @tab X @tab fourcc: SVQ1
1017 @item Sorenson Video 3 @tab @tab X @tab fourcc: SVQ3
1018 @item On2 VP3 @tab @tab X @tab still experimental
1019 @item On2 VP5 @tab @tab X @tab fourcc: VP50
1020 @item On2 VP6 @tab @tab X @tab fourcc: VP60,VP61,VP62
1021 @item Theora @tab X @tab X @tab still experimental
1022 @item Intel Indeo 3 @tab @tab X
1023 @item FLV @tab X @tab X @tab Sorenson H.263 used in Flash
1024 @item Flash Screen Video @tab X @tab X @tab fourcc: FSV1
1025 @item ATI VCR1 @tab @tab X @tab fourcc: VCR1
1026 @item ATI VCR2 @tab @tab X @tab fourcc: VCR2
1027 @item Cirrus Logic AccuPak @tab @tab X @tab fourcc: CLJR
1028 @item 4X Video @tab @tab X @tab Used in certain computer games.
1029 @item Sony Playstation MDEC @tab @tab X
1030 @item Id RoQ @tab X @tab X @tab Used in Quake III, Jedi Knight 2, other computer games.
1031 @item Xan/WC3 @tab @tab X @tab Used in Wing Commander III .MVE files.
1032 @item Interplay Video @tab @tab X @tab Used in Interplay .MVE files.
1033 @item Apple Animation @tab X @tab X @tab fourcc: 'rle '
1034 @item Apple Graphics @tab @tab X @tab fourcc: 'smc '
1035 @item Apple Video @tab @tab X @tab fourcc: rpza
1036 @item Apple QuickDraw @tab @tab X @tab fourcc: qdrw
1037 @item Cinepak @tab @tab X
1038 @item Microsoft RLE @tab @tab X
1039 @item Microsoft Video-1 @tab @tab X
1040 @item Westwood VQA @tab @tab X
1041 @item Id Cinematic Video @tab @tab X @tab Used in Quake II.
1042 @item Planar RGB @tab @tab X @tab fourcc: 8BPS
1043 @item FLIC video @tab @tab X
1044 @item Duck TrueMotion v1 @tab @tab X @tab fourcc: DUCK
1045 @item Duck TrueMotion v2 @tab @tab X @tab fourcc: TM20
1046 @item VMD Video @tab @tab X @tab Used in Sierra VMD files.
1047 @item MSZH @tab @tab X @tab Part of LCL
1048 @item ZLIB @tab X @tab X @tab Part of LCL, encoder experimental
1049 @item TechSmith Camtasia @tab @tab X @tab fourcc: TSCC
1050 @item IBM Ultimotion @tab @tab X @tab fourcc: ULTI
1051 @item Miro VideoXL @tab @tab X @tab fourcc: VIXL
1052 @item QPEG @tab @tab X @tab fourccs: QPEG, Q1.0, Q1.1
1053 @item LOCO @tab @tab X @tab
1054 @item Winnov WNV1 @tab @tab X @tab
1055 @item Autodesk Animator Studio Codec @tab @tab X @tab fourcc: AASC
1056 @item Fraps FPS1 @tab @tab X @tab
1057 @item CamStudio @tab @tab X @tab fourcc: CSCD
1058 @item American Laser Games Video @tab @tab X @tab Used in games like Mad Dog McCree
1059 @item ZMBV @tab X @tab X @tab Encoder works only on PAL8
1060 @item AVS Video @tab @tab X @tab Video encoding used by the Creature Shock game.
1061 @item Smacker Video @tab @tab X @tab Video encoding used in Smacker.
1062 @item RTjpeg @tab @tab X @tab Video encoding used in NuppelVideo files.
1063 @item KMVC @tab @tab X @tab Codec used in Worms games.
1064 @item VMware Video @tab @tab X @tab Codec used in videos captured by VMware.
1065 @item Cin Video @tab @tab X @tab Codec used in Delphine Software games.
1066 @item Tiertex Seq Video @tab @tab X @tab Codec used in DOS CDROM FlashBack game.
1067 @item DXA Video @tab @tab X @tab Codec originally used in Feeble Files game.
1068 @item AVID DNxHD @tab @tab X @tab aka SMPTE VC3
1069 @item C93 Video @tab @tab X @tab Codec used in Cyberia game.
1070 @item THP @tab @tab X @tab Used on the Nintendo GameCube.
1071 @item Bethsoft VID @tab @tab X @tab Used in some games from Bethesda Softworks.
1072 @item Renderware TXD @tab @tab X @tab Texture dictionaries used by the Renderware Engine.
1075 @code{X} means that encoding (resp. decoding) is supported.
1077 @section Audio Codecs
1079 @multitable @columnfractions .4 .1 .1 .1 .7
1080 @item Supported Codec @tab Encoding @tab Decoding @tab Comments
1081 @item MPEG audio layer 2 @tab IX @tab IX
1082 @item MPEG audio layer 1/3 @tab IX @tab IX
1083 @tab MP3 encoding is supported through the external library LAME.
1084 @item AC3 @tab IX @tab IX
1085 @tab liba52 is used internally for decoding.
1086 @item Vorbis @tab X @tab X
1087 @item WMA V1/V2 @tab X @tab X
1088 @item AAC @tab X @tab X
1089 @tab Supported through the external library libfaac/libfaad.
1090 @item Microsoft ADPCM @tab X @tab X
1091 @item MS IMA ADPCM @tab X @tab X
1092 @item QT IMA ADPCM @tab @tab X
1093 @item 4X IMA ADPCM @tab @tab X
1094 @item G.726 ADPCM @tab X @tab X
1095 @item Duck DK3 IMA ADPCM @tab @tab X
1096 @tab Used in some Sega Saturn console games.
1097 @item Duck DK4 IMA ADPCM @tab @tab X
1098 @tab Used in some Sega Saturn console games.
1099 @item Westwood Studios IMA ADPCM @tab @tab X
1100 @tab Used in Westwood Studios games like Command and Conquer.
1101 @item SMJPEG IMA ADPCM @tab @tab X
1102 @tab Used in certain Loki game ports.
1103 @item CD-ROM XA ADPCM @tab @tab X
1104 @item CRI ADX ADPCM @tab X @tab X
1105 @tab Used in Sega Dreamcast games.
1106 @item Electronic Arts ADPCM @tab @tab X
1107 @tab Used in various EA titles.
1108 @item Creative ADPCM @tab @tab X
1109 @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
1110 @item THP ADPCM @tab @tab X
1111 @tab Used on the Nintendo GameCube.
1112 @item RA144 @tab @tab X
1113 @tab Real 14400 bit/s codec
1114 @item RA288 @tab @tab X
1115 @tab Real 28800 bit/s codec
1116 @item RADnet @tab X @tab IX
1117 @tab Real low bitrate AC3 codec, liba52 is used for decoding.
1118 @item AMR-NB @tab X @tab X
1119 @tab Supported through an external library.
1120 @item AMR-WB @tab X @tab X
1121 @tab Supported through an external library.
1122 @item DV audio @tab @tab X
1123 @item Id RoQ DPCM @tab X @tab X
1124 @tab Used in Quake III, Jedi Knight 2, other computer games.
1125 @item Interplay MVE DPCM @tab @tab X
1126 @tab Used in various Interplay computer games.
1127 @item Xan DPCM @tab @tab X
1128 @tab Used in Origin's Wing Commander IV AVI files.
1129 @item Sierra Online DPCM @tab @tab X
1130 @tab Used in Sierra Online game audio files.
1131 @item Apple MACE 3 @tab @tab X
1132 @item Apple MACE 6 @tab @tab X
1133 @item FLAC lossless audio @tab X @tab X
1134 @item Shorten lossless audio @tab @tab X
1135 @item Apple lossless audio @tab @tab X
1136 @tab QuickTime fourcc 'alac'
1137 @item FFmpeg Sonic @tab X @tab X
1138 @tab experimental lossy/lossless codec
1139 @item Qdesign QDM2 @tab @tab X
1140 @tab there are still some distortions
1141 @item Real COOK @tab @tab X
1142 @tab All versions except 5.1 are supported
1143 @item DSP Group TrueSpeech @tab @tab X
1144 @item True Audio (TTA) @tab @tab X
1145 @item Smacker Audio @tab @tab X
1146 @item WavPack Audio @tab @tab X
1147 @item Cin Audio @tab @tab X
1148 @tab Codec used in Delphine Software games.
1149 @item Intel Music Coder @tab @tab X
1150 @item Musepack @tab @tab X
1151 @tab Only SV7 is supported
1152 @item DT$ Coherent Audio @tab @tab X
1153 @item ATRAC 3 @tab @tab X
1156 @code{X} means that encoding (resp. decoding) is supported.
1158 @code{I} means that an integer-only version is available, too (ensures high
1159 performance on systems without hardware floating point support).
1161 @chapter Platform Specific information
1165 BSD make will not build FFmpeg, you need to install and use GNU Make
1170 To get help and instructions for using FFmpeg under Windows, check out
1171 the FFmpeg Windows Help Forum at
1172 @url{http://arrozcru.no-ip.org/ffmpeg/}.
1174 @subsection Native Windows compilation
1177 @item Install the current versions of MSYS and MinGW from
1178 @url{http://www.mingw.org/}. You can find detailed installation
1179 instructions in the download section and the FAQ.
1181 NOTE: Use at least bash 3.1. Older versions are known to be failing on the
1184 @item If you want to test the FFplay, also download
1185 the MinGW development library of SDL 1.2.x
1186 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
1187 @url{http://www.libsdl.org}. Unpack it in a temporary directory, and
1188 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1189 directory. Edit the @file{sdl-config} script so that it gives the
1190 correct SDL directory when invoked.
1192 @item If you want to use vhooks, you must have a POSIX compliant libdl in your
1193 MinGW system. Get dlfcn-win32 from @url{http://code.google.com/p/dlfcn-win32}.
1195 @item Extract the current version of FFmpeg.
1197 @item Start the MSYS shell (file @file{msys.bat}).
1199 @item Change to the FFmpeg directory and follow
1200 the instructions of how to compile FFmpeg (file
1201 @file{INSTALL}). Usually, launching @file{./configure} and @file{make}
1202 suffices. If you have problems using SDL, verify that
1203 @file{sdl-config} can be launched from the MSYS command line.
1205 @item You can install FFmpeg in @file{Program Files/FFmpeg} by typing
1206 @file{make install}. Do not forget to copy @file{SDL.dll} to the place
1207 you launch @file{ffplay} from.
1214 @item The target @file{make wininstaller} can be used to create a
1215 Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
1216 must be copied to the FFmpeg directory in order to build the
1219 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
1220 you can build @file{avcodec.dll} and @file{avformat.dll}. With
1221 @code{make install} you install the FFmpeg DLLs and the associated
1222 headers in @file{Program Files/FFmpeg}.
1224 @item Visual C++ compatibility: If you used @code{./configure --enable-shared}
1225 when configuring FFmpeg, FFmpeg tries to use the Microsoft Visual
1226 C++ @code{lib} tool to build @code{avcodec.lib} and
1227 @code{avformat.lib}. With these libraries you can link your Visual C++
1228 code directly with the FFmpeg DLLs (see below).
1232 @subsection Visual C++ compatibility
1234 FFmpeg will not compile under Visual C++ -- and it has too many
1235 dependencies on the GCC compiler to make a port viable. However,
1236 if you want to use the FFmpeg libraries in your own applications,
1237 you can still compile those applications using Visual C++. An
1238 important restriction to this is that you have to use the
1239 dynamically linked versions of the FFmpeg libraries (i.e. the
1240 DLLs), and you have to make sure that Visual-C++-compatible
1241 import libraries are created during the FFmpeg build process.
1243 This description of how to use the FFmpeg libraries with Visual C++ is
1244 based on Visual C++ 2005 Express Edition Beta 2. If you have a different
1245 version, you might have to modify the procedures slightly.
1247 Here are the step-by-step instructions for building the FFmpeg libraries
1248 so they can be used with Visual C++:
1252 @item Install Visual C++ (if you have not done so already).
1254 @item Install MinGW and MSYS as described above.
1256 @item Add a call to @file{vcvars32.bat} (which sets up the environment
1257 variables for the Visual C++ tools) as the first line of
1258 @file{msys.bat}. The standard location for @file{vcvars32.bat} is
1259 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
1260 and the standard location for @file{msys.bat} is
1261 @file{C:\msys\1.0\msys.bat}. If this corresponds to your setup, add the
1262 following line as the first line of @file{msys.bat}:
1264 @code{call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"}
1266 @item Start the MSYS shell (file @file{msys.bat}) and type @code{link.exe}.
1267 If you get a help message with the command line options of @code{link.exe},
1268 this means your environment variables are set up correctly, the
1269 Microsoft linker is on the path and will be used by FFmpeg to
1270 create Visual-C++-compatible import libraries.
1272 @item Extract the current version of FFmpeg and change to the FFmpeg directory.
1274 @item Type the command
1275 @code{./configure --enable-shared --disable-static --enable-memalign-hack}
1276 to configure and, if that did not produce any errors,
1277 type @code{make} to build FFmpeg.
1279 @item The subdirectories @file{libavformat}, @file{libavcodec}, and
1280 @file{libavutil} should now contain the files @file{avformat.dll},
1281 @file{avformat.lib}, @file{avcodec.dll}, @file{avcodec.lib},
1282 @file{avutil.dll}, and @file{avutil.lib}, respectively. Copy the three
1283 DLLs to your System32 directory (typically @file{C:\Windows\System32}).
1287 And here is how to use these libraries with Visual C++:
1291 @item Create a new console application ("File / New / Project") and then
1292 select "Win32 Console Application". On the appropriate page of the
1293 Application Wizard, uncheck the "Precompiled headers" option.
1295 @item Write the source code for your application, or, for testing, just
1296 copy the code from an existing sample application into the source file
1297 that Visual C++ has already created for you. (Note that your source
1298 filehas to have a @code{.cpp} extension; otherwise, Visual C++ will not
1299 compile the FFmpeg headers correctly because in C mode, it does not
1300 recognize the @code{inline} keyword.) For example, you can copy
1301 @file{output_example.c} from the FFmpeg distribution (but you will
1302 have to make minor modifications so the code will compile under
1305 @item Open the "Project / Properties" dialog box. In the "Configuration"
1306 combo box, select "All Configurations" so that the changes you make will
1307 affect both debug and release builds. In the tree view on the left hand
1308 side, select "C/C++ / General", then edit the "Additional Include
1309 Directories" setting to contain the complete paths to the
1310 @file{libavformat}, @file{libavcodec}, and @file{libavutil}
1311 subdirectories of your FFmpeg directory. Note that the directories have
1312 to be separated using semicolons. Now select "Linker / General" from the
1313 tree view and edit the "Additional Library Directories" setting to
1314 contain the same three directories.
1316 @item Still in the "Project / Properties" dialog box, select "Linker / Input"
1317 from the tree view, then add the files @file{avformat.lib},
1318 @file{avcodec.lib}, and @file{avutil.lib} to the end of the "Additional
1319 Dependencies". Note that the names of the libraries have to be separated
1322 @item Now, select "C/C++ / Code Generation" from the tree view. Select
1323 "Debug" in the "Configuration" combo box. Make sure that "Runtime
1324 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
1325 the "Configuration" combo box and make sure that "Runtime Library" is
1326 set to "Multi-threaded DLL".
1328 @item Click "OK" to close the "Project / Properties" dialog box and build
1329 the application. Hopefully, it should compile and run cleanly. If you
1330 used @file{output_example.c} as your sample application, you will get a
1331 few compiler errors, but they are easy to fix. The first type of error
1332 occurs because Visual C++ does not allow an @code{int} to be converted to
1333 an @code{enum} without a cast. To solve the problem, insert the required
1334 casts (this error occurs once for a @code{CodecID} and once for a
1335 @code{CodecType}). The second type of error occurs because C++ requires
1336 the return value of @code{malloc} to be cast to the exact type of the
1337 pointer it is being assigned to. Visual C++ will complain that, for
1338 example, @code{(void *)} is being assigned to @code{(uint8_t *)} without
1339 an explicit cast. So insert an explicit cast in these places to silence
1340 the compiler. The third type of error occurs because the @code{snprintf}
1341 library function is called @code{_snprintf} under Visual C++. So just
1342 add an underscore to fix the problem. With these changes,
1343 @file{output_example.c} should compile under Visual C++, and the
1344 resulting executable should produce valid video files.
1348 @subsection Cross compilation for Windows with Linux
1350 You must use the MinGW cross compilation tools available at
1351 @url{http://www.mingw.org/}.
1353 Then configure FFmpeg with the following options:
1355 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
1357 (you can change the cross-prefix according to the prefix chosen for the
1360 Then you can easily test FFmpeg with Wine
1361 (@url{http://www.winehq.com/}).
1363 @subsection Compilation under Cygwin
1365 Cygwin works very much like Unix.
1367 Just install your Cygwin with all the "Base" packages, plus the
1368 following "Devel" ones:
1370 binutils, gcc-core, make, subversion
1373 Do not install binutils-20060709-1 (they are buggy on shared builds);
1374 use binutils-20050610-1 instead.
1379 ./configure --enable-static --disable-shared
1382 to make a static build or
1385 ./configure --enable-shared --disable-static
1388 to build shared libraries.
1390 If you want to build FFmpeg with additional libraries, download Cygwin
1391 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository
1392 and/or SDL, xvid, faac, faad2 packages from Cygwin Ports,
1393 (@url{http://cygwinports.dotsrc.org/}).
1395 @subsection Crosscompilation for Windows under Cygwin
1397 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
1399 Just install your Cygwin as explained before, plus these additional
1402 gcc-mingw-core, mingw-runtime, mingw-zlib
1405 and add some special flags to your configure invocation.
1407 For a static build run
1409 ./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1412 and for a build with shared libraries
1414 ./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1419 The configure script should guess the configuration itself.
1420 Networking support is currently not finished.
1421 errno issues fixed by Andrew Bachmann.
1425 François Revol - revol at free dot fr - April 2002
1427 The configure script should guess the configuration itself,
1428 however I still did not test building on the net_server version of BeOS.
1430 FFserver is broken (needs poll() implementation).
1432 There are still issues with errno codes, which are negative in BeOS, and
1433 that FFmpeg negates when returning. This ends up turning errors into
1434 valid results, then crashes.
1437 @chapter Developers Guide
1441 @item libavcodec is the library containing the codecs (both encoding and
1442 decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
1444 @item libavformat is the library containing the file format handling (mux and
1445 demux code for several formats). Look at @file{ffplay.c} to use it in a
1446 player. See @file{output_example.c} to use it to generate audio or video
1451 @section Integrating libavcodec or libavformat in your program
1453 You can integrate all the source code of the libraries to link them
1454 statically to avoid any version problem. All you need is to provide a
1455 'config.mak' and a 'config.h' in the parent directory. See the defines
1456 generated by ./configure to understand what is needed.
1458 You can use libavcodec or libavformat in your commercial program, but
1459 @emph{any patch you make must be published}. The best way to proceed is
1460 to send your patches to the FFmpeg mailing list.
1463 @section Coding Rules
1465 FFmpeg is programmed in the ISO C90 language with a few additional
1466 features from ISO C99, namely:
1469 the @samp{inline} keyword;
1473 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
1475 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
1478 These features are supported by all compilers we care about, so we will not
1479 accept patches to remove their use unless they absolutely do not impair
1480 clarity and performance.
1482 All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
1483 compiles with several other compilers, such as the Compaq ccc compiler
1484 or Sun Studio 9, and we would like to keep it that way unless it would
1485 be exceedingly involved. To ensure compatibility, please do not use any
1486 additional C99 features or GCC extensions. Especially watch out for:
1489 mixing statements and declarations;
1491 @samp{long long} (use @samp{int64_t} instead);
1493 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
1495 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
1499 The presentation is the one specified by 'indent -i4 -kr -nut'.
1500 The TAB character is forbidden outside of Makefiles as is any
1501 form of trailing whitespace. Commits containing either will be
1502 rejected by the Subversion repository.
1504 Main priority in FFmpeg is simplicity and small code size (=less
1507 Comments: Use the JavaDoc/Doxygen
1508 format (see examples below) so that code documentation
1509 can be generated automatically. All nontrivial functions should have a comment
1510 above them explaining what the function does, even if it is just one sentence.
1511 All structures and their member variables should be documented, too.
1524 typedef struct Foobar@{
1525 int var1; /**< var1 description */
1526 int var2; ///< var2 description
1527 /** var3 description */
1535 * @@param my_parameter description of my_parameter
1536 * @@return return value description
1538 int myfunc(int my_parameter)
1542 fprintf and printf are forbidden in libavformat and libavcodec,
1543 please use av_log() instead.
1545 Casts should be used only when necessary. Unneeded parentheses
1546 should also be avoided if they don't make the code easier to understand.
1548 @section Development Policy
1552 You must not commit code which breaks FFmpeg! (Meaning unfinished but
1553 enabled code which breaks compilation or compiles but does not work or
1554 breaks the regression tests)
1555 You can commit unfinished stuff (for testing etc), but it must be disabled
1556 (#ifdef etc) by default so it does not interfere with other developers'
1559 You do not have to over-test things. If it works for you, and you think it
1560 should work for others, then commit. If your code has problems
1561 (portability, triggers compiler bugs, unusual environment etc) they will be
1562 reported and eventually fixed.
1564 Do not commit unrelated changes together, split them into self-contained
1565 pieces. Also do not forget that if part B depends on part A, but A does not
1566 depend on B, then A can and should be committed first and separate from B.
1567 Keeping changes well split into self-contained parts makes reviewing and
1568 understanding them on the commit log mailing list easier. This also helps
1569 in case of debugging later on.
1570 Also if you have doubts about splitting or not splitting, do not hesitate to
1571 ask/discuss it on the developer mailing list.
1573 Do not change behavior of the program (renaming options etc) without
1574 first discussing it on the ffmpeg-devel mailing list. Do not remove
1575 functionality from the code. Just improve!
1577 Note: Redundant code can be removed.
1579 Do not commit changes to the build system (Makefiles, configure script)
1580 which change behavior, defaults etc, without asking first. The same
1581 applies to compiler warning fixes, trivial looking fixes and to code
1582 maintained by other developers. We usually have a reason for doing things
1583 the way we do. Send your changes as patches to the ffmpeg-devel mailing
1584 list, and if the code maintainers say OK, you may commit. This does not
1585 apply to files you wrote and/or maintain.
1587 We refuse source indentation and other cosmetic changes if they are mixed
1588 with functional changes, such commits will be rejected and removed. Every
1589 developer has his own indentation style, you should not change it. Of course
1590 if you (re)write something, you can use your own style, even though we would
1591 prefer if the indentation throughout FFmpeg was consistent (Many projects
1592 force a given indentation style - we do not.). If you really need to make
1593 indentation changes (try to avoid this), separate them strictly from real
1596 NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
1597 then either do NOT change the indentation of the inner part within (do not
1598 move it to the right)! or do so in a separate commit
1600 Always fill out the commit log message. Describe in a few lines what you
1601 changed and why. You can refer to mailing list postings if you fix a
1602 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
1604 If you apply a patch by someone else, include the name and email address in
1605 the log message. Since the ffmpeg-cvslog mailing list is publicly
1606 archived you should add some SPAM protection to the email address. Send an
1607 answer to ffmpeg-devel (or wherever you got the patch from) saying that
1608 you applied the patch.
1610 When applying patches that have been discussed (at length) on the mailing
1611 list, reference the thread in the log message.
1613 Do NOT commit to code actively maintained by others without permission.
1614 Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
1615 timeframe (12h for build failures and security fixes, 3 days small changes,
1616 1 week for big patches) then commit your patch if you think it is OK.
1617 Also note, the maintainer can simply ask for more time to review!
1619 Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
1620 are sent there and reviewed by all the other developers. Bugs and possible
1621 improvements or general questions regarding commits are discussed there. We
1622 expect you to react if problems with your code are uncovered.
1624 Update the documentation if you change behavior or add features. If you are
1625 unsure how best to do this, send a patch to ffmpeg-devel, the documentation
1626 maintainer(s) will review and commit your stuff.
1628 Try to keep important discussions and requests (also) on the public
1629 developer mailing list, so that all developers can benefit from them.
1631 Never write to unallocated memory, never write over the end of arrays,
1632 always check values read from some untrusted source before using them
1633 as array index or other risky things.
1635 Remember to check if you need to bump versions for the specific libav
1636 parts (libavutil, libavcodec, libavformat) you are changing. You need
1637 to change the version integer and the version string.
1638 Incrementing the first component means no backward compatibility to
1639 previous versions (e.g. removal of a function from the public API).
1640 Incrementing the second component means backward compatible change
1641 (e.g. addition of a function to the public API).
1642 Incrementing the third component means a noteworthy binary compatible
1643 change (e.g. encoder bug fix that matters for the decoder).
1645 If you add a new codec, remember to update the changelog, add it to
1646 the supported codecs table in the documentation and bump the second
1647 component of the @file{libavcodec} version number appropriately. If
1648 it has a fourcc, add it to @file{libavformat/avienc.c}, even if it
1651 Do not change code to hide warnings without ensuring that the underlying
1652 logic is correct and thus the warning was inappropriate.
1654 If you add a new file, give it a proper license header. Do not copy and
1655 paste it from a random place, use an existing file as template.
1658 We think our rules are not too hard. If you have comments, contact us.
1660 Note, these rules are mostly borrowed from the MPlayer project.
1662 @section Submitting patches
1664 First, (@pxref{Coding Rules}) above if you did not yet.
1666 When you submit your patch, try to send a unified diff (diff '-up'
1667 option). I cannot read other diffs :-)
1669 Also please do not submit patches which contain several unrelated changes.
1670 Split them into individual self-contained patches; this makes reviewing
1673 Run the regression tests before submitting a patch so that you can
1674 verify that there are no big problems.
1676 Patches should be posted as base64 encoded attachments (or any other
1677 encoding which ensures that the patch will not be trashed during
1678 transmission) to the ffmpeg-devel mailing list, see
1679 @url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
1681 It also helps quite a bit if you tell us what the patch does (for example
1682 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
1683 and has no lrint()')
1685 Also please if you send several patches, send each patch as separate mail,
1686 do not attach several unrelated patches to the same mail.
1688 @section patch submission checklist
1692 Do the regression tests pass with the patch applied?
1694 Is the patch a unified diff?
1696 Is the patch against latest FFmpeg SVN?
1698 Are you subscribed to ffmpeg-dev?
1699 (the list is subscribers only due to spam)
1701 Have you checked that the changes are minimal, so that the same cannot be
1702 achieved with a smaller patch and/or simpler final code?
1704 If the change is to speed critical code, did you benchmark it?
1706 If you did any benchmarks, did you provide them in the mail?
1708 Have you checked that the patch does not introduce buffer overflows or
1709 other security issues?
1711 Is the patch created from the root of the source tree, so it can be
1712 applied with @code{patch -p0}?
1714 Does the patch not mix functional and cosmetic changes?
1716 Did you add tabs or trailing whitespace to the code? Both are forbidden.
1718 Is the patch attached to the email you send?
1720 Is the mime type of the patch correct? It should be text/x-diff or
1721 text/x-patch or at least text/plain and not application/octet-stream.
1723 If the patch fixes a bug, did you provide a verbose analysis of the bug?
1725 If the patch fixes a bug, did you provide enough information, including
1726 a sample, so the bug can be reproduced and the fix can be verified?
1727 Note please do not attach samples >100k to mails but rather provide a
1728 URL, you can upload to ftp://upload.mplayerhq.hu
1730 Did you provide a verbose summary about what the patch does change?
1732 Did you provide a verbose explanation why it changes things like it does?
1734 Did you provide a verbose summary of the user visible advantages and
1735 disadvantages if the patch is applied?
1737 Did you provide an example so we can verify the new feature added by the
1740 If you added a new file, did you insert a license header? It should be
1741 taken from FFmpeg, not randomly copied and pasted from somewhere else.
1743 You should maintain alphabetical order in alphabetically ordered lists as
1744 long as doing so does not break API/ABI compatibility.
1746 Did you provide a suggestion for a clear commit log message?
1749 @section Patch review process
1751 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
1752 clear note that the patch is not for SVN.
1753 Reviews and comments will be posted as replies to the patch on the
1754 mailing list. The patch submitter then has to take care of every comment,
1755 that can be by resubmitting a changed patch or by discussion. Resubmitted
1756 patches will themselves be reviewed like any other patch. If at some point
1757 a patch passes review with no comments then it is approved, that can for
1758 simple and small patches happen immediately while large patches will generally
1759 have to be changed and reviewed many times before they are approved.
1760 After a patch is approved it will be committed to the repository.
1762 We will review all submitted patches, but sometimes we are quite busy so
1763 especially for large patches this can take several weeks.
1765 When resubmitting patches, please do not make any significant changes
1766 not related to the comments received during review. Such patches will
1767 be rejected. Instead, submit significant changes or new features as
1770 @section Regression tests
1772 Before submitting a patch (or committing to the repository), you should at least
1773 test that you did not break anything.
1775 The regression tests build a synthetic video stream and a synthetic
1776 audio stream. These are then encoded and decoded with all codecs or
1777 formats. The CRC (or MD5) of each generated file is recorded in a
1778 result file. A 'diff' is launched to compare the reference results and
1781 The regression tests then go on to test the FFserver code with a
1782 limited set of streams. It is important that this step runs correctly
1785 Run 'make test' to test all the codecs and formats.
1787 Run 'make fulltest' to test all the codecs, formats and FFserver.
1789 [Of course, some patches may change the results of the regression tests. In
1790 this case, the reference results of the regression tests shall be modified