KMVC (used in Worms games) decoder. Works fine with samples from MPHQ
[libav.git] / doc / ffmpeg-doc.texi
CommitLineData
9181577c
FB
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
13FFmpeg is a very fast video and audio converter. It can also grab from
14a live audio/video source.
115329f1 15
9181577c 16The command line interface is designed to be intuitive, in the sense
4c5f7207
DB
17that FFmpeg tries to figure out all parameters that can possibly be
18derived automatically. You usually only have to specify the target
19bitrate you want.
9181577c
FB
20
21FFmpeg can also convert from any sample rate to any other, and resize
22video on the fly with a high quality polyphase filter.
23
24@chapter Quick Start
25
e99c4e10 26@c man begin EXAMPLES
9181577c
FB
27@section Video and Audio grabbing
28
e99c4e10
FB
29FFmpeg can use a video4linux compatible video source and any Open Sound
30System audio source:
31
9181577c 32@example
115329f1 33ffmpeg /tmp/out.mpg
9181577c
FB
34@end example
35
e99c4e10 36Note that you must activate the right video source and channel before
4c5f7207
DB
37launching FFmpeg with any TV viewer such as xawtv
38(@url{http://bytesex.org/xawtv/}) by Gerd Knorr. You also
39have to set the audio recording levels correctly with a
e99c4e10 40standard mixer.
9181577c 41
6bf40f39 42@section Video and Audio file format conversion
9181577c 43
4c5f7207 44* FFmpeg can use any supported file format and protocol as input:
9181577c
FB
45
46Examples:
47
4c5f7207 48* You can use YUV files as input:
9181577c
FB
49
50@example
115329f1 51ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
9181577c
FB
52@end example
53
115329f1 54It will use the files:
9181577c 55@example
e99c4e10
FB
56/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
57/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
9181577c
FB
58@end example
59
e99c4e10
FB
60The Y files use twice the resolution of the U and V files. They are
61raw files, without header. They can be generated by all decent video
62decoders. You must specify the size of the image with the @option{-s} option
4c5f7207 63if FFmpeg cannot guess it.
9181577c 64
4c5f7207 65* You can input from a raw YUV420P file:
9181577c
FB
66
67@example
e99c4e10 68ffmpeg -i /tmp/test.yuv /tmp/out.avi
9181577c
FB
69@end example
70
4c5f7207
DB
71test.yuv is a file containing raw YUV planar data. Each frame is composed
72of the Y plane followed by the U and V planes at half vertical and
e99c4e10 73horizontal resolution.
9181577c 74
4c5f7207 75* You can output to a raw YUV420P file:
9181577c
FB
76
77@example
f926cbe7 78ffmpeg -i mydivx.avi hugefile.yuv
9181577c
FB
79@end example
80
81* You can set several input files and output files:
82
83@example
e99c4e10 84ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
9181577c
FB
85@end example
86
4c5f7207
DB
87Converts the audio file a.wav and the raw YUV video file a.yuv
88to MPEG file a.mpg.
9181577c 89
6bf40f39 90* You can also do audio and video conversions at the same time:
9181577c
FB
91
92@example
e99c4e10 93ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
9181577c
FB
94@end example
95
4c5f7207 96Converts a.wav to MPEG audio at 22050Hz sample rate.
9181577c
FB
97
98* You can encode to several formats at the same time and define a
e99c4e10 99mapping from input stream to output streams:
9181577c
FB
100
101@example
e99c4e10 102ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
9181577c
FB
103@end example
104
4c5f7207
DB
105Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
106file:index' specifies which input stream is used for each output
e99c4e10 107stream, in the order of the definition of output streams.
9181577c
FB
108
109* You can transcode decrypted VOBs
110
111@example
e99c4e10 112ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800 -g 300 -bf 2 -acodec mp3 -ab 128 snatch.avi
9181577c
FB
113@end example
114
4c5f7207
DB
115This is a typical DVD ripping example; the input is a VOB file, the
116output an AVI file with MPEG-4 video and MP3 audio. Note that in this
117command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
118GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
119input video. Furthermore, the audio stream is MP3-encoded so you need
120to enable LAME support by passing @code{--enable-mp3lame} to configure.
121The mapping is particularly useful for DVD transcoding
e99c4e10 122to get the desired audio language.
9181577c 123
4c5f7207 124NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
e99c4e10 125@c man end
9181577c
FB
126
127@chapter Invocation
128
129@section Syntax
130
e99c4e10 131The generic syntax is:
9181577c 132
115329f1 133@example
e99c4e10 134@c man begin SYNOPSIS
28f88dc8 135ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
e99c4e10 136@c man end
9181577c 137@end example
e99c4e10
FB
138@c man begin DESCRIPTION
139If no input file is given, audio/video grabbing is done.
9181577c 140
e99c4e10
FB
141As a general rule, options are applied to the next specified
142file. For example, if you give the @option{-b 64} option, it sets the video
4c5f7207 143bitrate of the next file. The format option may be needed for raw input
e99c4e10 144files.
9181577c 145
4c5f7207
DB
146By default, FFmpeg tries to convert as losslessly as possible: It
147uses the same audio and video parameters for the outputs as the one
e99c4e10
FB
148specified for the inputs.
149@c man end
9181577c 150
e99c4e10 151@c man begin OPTIONS
9181577c
FB
152@section Main options
153
e99c4e10 154@table @option
9181577c 155@item -L
4c5f7207 156Show license.
18bff752 157
9181577c 158@item -h
4c5f7207 159Show help.
18bff752 160
e99c4e10 161@item -formats
4c5f7207 162Show available formats, codecs, protocols, ...
18bff752 163
115329f1 164@item -f fmt
4c5f7207 165Force format.
18bff752 166
115329f1 167@item -i filename
4c5f7207 168input filename
9181577c 169
115329f1 170@item -y
4c5f7207 171Overwrite output files.
9181577c 172
115329f1 173@item -t duration
4c5f7207
DB
174Set the recording time in seconds.
175@code{hh:mm:ss[.xxx]} syntax is also supported.
9181577c 176
e83a84ac 177@item -ss position
4c5f7207
DB
178Seek to given time position in seconds.
179@code{hh:mm:ss[.xxx]} syntax is also supported.
e83a84ac 180
115329f1 181@item -title string
4c5f7207 182Set the title.
9181577c 183
115329f1 184@item -author string
4c5f7207 185Set the author.
9181577c 186
115329f1 187@item -copyright string
4c5f7207 188Set the copyright.
9181577c 189
115329f1 190@item -comment string
4c5f7207 191Set the comment.
9181577c 192
99db6420 193@item -target type
4c5f7207
DB
194Specify target file type ("vcd", "svcd", "dvd", "dv", "pal-vcd",
195"ntsc-svcd", ... ). All the format options (bitrate, codecs,
196buffer sizes) are then set automatically. You can just type:
99db6420
FB
197
198@example
199ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
200@end example
201
4c5f7207
DB
202Nevertheless you can specify additional options as long as you know
203they do not conflict with the standard, as in:
791d8d1d
MB
204
205@example
206ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
207@end example
208
99db6420 209@item -hq
4c5f7207 210Activate high quality settings.
18bff752 211
401fbdde 212@item -itsoffset offset
4c5f7207
DB
213Set the input time offset in seconds.
214@code{[-]hh:mm:ss[.xxx]} syntax is also supported.
215This option affects all the input files that follow it.
216The offset is added to the timestamps of the input files.
217Specifying a positive offset means that the corresponding
218streams are delayed by 'offset' seconds.
401fbdde 219
9181577c
FB
220@end table
221
222@section Video Options
223
e99c4e10 224@table @option
9181577c 225@item -b bitrate
4c5f7207 226Set the video bitrate in kbit/s (default = 200 kb/s).
115329f1 227@item -r fps
4c5f7207 228Set frame rate (default = 25).
115329f1 229@item -s size
4c5f7207
DB
230Set frame size. The format is @samp{wxh} (default = 160x128).
231The following abbreviations are recognized:
5ee03c86 232@table @samp
18bff752
FB
233@item sqcif
234128x96
235@item qcif
236176x144
237@item cif
238352x288
239@item 4cif
240704x576
241@end table
242
243@item -aspect aspect
4c5f7207 244Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
18bff752 245@item -croptop size
4c5f7207 246Set top crop band size (in pixels).
18bff752 247@item -cropbottom size
4c5f7207 248Set bottom crop band size (in pixels).
18bff752 249@item -cropleft size
4c5f7207 250Set left crop band size (in pixels).
18bff752 251@item -cropright size
4c5f7207 252Set right crop band size (in pixels).
1ff93ffc 253@item -padtop size
4c5f7207 254Set top pad band size (in pixels).
1ff93ffc 255@item -padbottom size
4c5f7207 256Set bottom pad band size (in pixels).
1ff93ffc 257@item -padleft size
4c5f7207 258Set left pad band size (in pixels).
1ff93ffc 259@item -padright size
4c5f7207 260Set right pad band size (in pixels).
5b79a73e 261@item -padcolor (hex color)
4c5f7207
DB
262Set color of padded bands. The value for padcolor is expressed
263as a six digit hexadecimal number where the first two digits
264represent red, the middle two digits green and last two digits
265blue (default = 000000 (black)).
9181577c 266@item -vn
4c5f7207 267Disable video recording.
115329f1 268@item -bt tolerance
4c5f7207 269Set video bitrate tolerance (in kbit/s).
18bff752 270@item -maxrate bitrate
4c5f7207 271Set max video bitrate tolerance (in kbit/s).
18bff752 272@item -minrate bitrate
4c5f7207 273Set min video bitrate tolerance (in kbit/s).
18bff752 274@item -bufsize size
4c5f7207 275Set rate control buffer size (in kbit).
115329f1 276@item -vcodec codec
4c5f7207 277Force video codec to @var{codec}. Use the @code{copy} special value to
5ee03c86 278tell that the raw codec data must be copied as is.
18bff752 279@item -sameq
4c5f7207 280Use same video quality as source (implies VBR).
9181577c 281
115329f1 282@item -pass n
4c5f7207
DB
283Select the pass number (1 or 2). It is useful to do two pass
284encoding. The statistics of the video are recorded in the first
285pass and the video is generated at the exact requested bitrate
286in the second pass.
9181577c 287
115329f1 288@item -passlogfile file
4c5f7207 289Set two pass logfile name to @var{file}.
9181577c
FB
290
291@end table
292
18bff752 293@section Advanced Video Options
9181577c 294
e99c4e10 295@table @option
115329f1 296@item -g gop_size
4c5f7207 297Set the group of pictures size.
115329f1 298@item -intra
4c5f7207 299Use only intra frames.
115329f1 300@item -qscale q
4c5f7207 301Use fixed video quantiser scale (VBR).
115329f1 302@item -qmin q
4c5f7207 303minimum video quantiser scale (VBR)
115329f1 304@item -qmax q
4c5f7207 305maximum video quantiser scale (VBR)
115329f1 306@item -qdiff q
4c5f7207 307maximum difference between the quantiser scales (VBR)
115329f1 308@item -qblur blur
9181577c 309video quantiser scale blur (VBR)
115329f1 310@item -qcomp compression
9181577c 311video quantiser scale compression (VBR)
18bff752
FB
312
313@item -rc_init_cplx complexity
4c5f7207 314initial complexity for single pass encoding
18bff752 315@item -b_qfactor factor
4c5f7207 316qp factor between P- and B-frames
18bff752 317@item -i_qfactor factor
4c5f7207 318qp factor between P- and I-frames
18bff752 319@item -b_qoffset offset
4c5f7207 320qp offset between P- and B-frames
18bff752 321@item -i_qoffset offset
4c5f7207 322qp offset between P- and I-frames
18bff752 323@item -rc_eq equation
4c5f7207
DB
324Set rate control equation (@pxref{FFmpeg formula
325evaluator}) (default = @code{tex^qComp}).
5ee03c86
FB
326@item -rc_override override
327rate control override for specific intervals
18bff752 328@item -me method
4c5f7207
DB
329Set motion estimation method to @var{method}.
330Available methods are (from lowest to best quality):
18bff752
FB
331@table @samp
332@item zero
5ee03c86 333Try just the (0, 0) vector.
18bff752
FB
334@item phods
335@item log
336@item x1
337@item epzs
338(default method)
339@item full
340exhaustive search (slow and marginally better than epzs)
341@end table
342
343@item -dct_algo algo
4c5f7207 344Set DCT algorithm to @var{algo}. Available values are:
18bff752
FB
345@table @samp
346@item 0
347FF_DCT_AUTO (default)
348@item 1
349FF_DCT_FASTINT
350@item 2
351FF_DCT_INT
352@item 3
353FF_DCT_MMX
354@item 4
355FF_DCT_MLIB
356@item 5
357FF_DCT_ALTIVEC
358@end table
359
360@item -idct_algo algo
4c5f7207 361Set IDCT algorithm to @var{algo}. Available values are:
18bff752
FB
362@table @samp
363@item 0
364FF_IDCT_AUTO (default)
365@item 1
115329f1 366FF_IDCT_INT
18bff752 367@item 2
115329f1 368FF_IDCT_SIMPLE
18bff752 369@item 3
115329f1 370FF_IDCT_SIMPLEMMX
18bff752 371@item 4
115329f1 372FF_IDCT_LIBMPEG2MMX
18bff752 373@item 5
115329f1 374FF_IDCT_PS2
18bff752 375@item 6
115329f1 376FF_IDCT_MLIB
18bff752 377@item 7
115329f1 378FF_IDCT_ARM
18bff752 379@item 8
115329f1 380FF_IDCT_ALTIVEC
18bff752 381@item 9
115329f1 382FF_IDCT_SH4
18bff752 383@item 10
115329f1 384FF_IDCT_SIMPLEARM
18bff752
FB
385@end table
386
387@item -er n
4c5f7207 388Set error resilience to @var{n}.
18bff752 389@table @samp
115329f1 390@item 1
1471c6c2 391FF_ER_CAREFUL (default)
18bff752 392@item 2
5ee03c86 393FF_ER_COMPLIANT
18bff752
FB
394@item 3
395FF_ER_AGGRESSIVE
396@item 4
397FF_ER_VERY_AGGRESSIVE
398@end table
399
5ee03c86 400@item -ec bit_mask
4c5f7207 401Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
5ee03c86 402the following values:
18bff752
FB
403@table @samp
404@item 1
4c5f7207 405FF_EC_GUESS_MVS (default = enabled)
18bff752 406@item 2
4c5f7207 407FF_EC_DEBLOCK (default = enabled)
18bff752
FB
408@end table
409
410@item -bf frames
4c5f7207 411Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
18bff752
FB
412@item -mbd mode
413macroblock decision
414@table @samp
415@item 0
4c5f7207 416FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
18bff752 417@item 1
4c5f7207 418FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
18bff752 419@item 2
019c8838 420FF_MB_DECISION_RD: rate distortion
18bff752
FB
421@end table
422
423@item -4mv
4c5f7207 424Use four motion vector by macroblock (MPEG-4 only).
18bff752 425@item -part
4c5f7207 426Use data partitioning (MPEG-4 only).
18bff752 427@item -bug param
4c5f7207 428Work around encoder bugs that are not auto-detected.
18bff752 429@item -strict strictness
4c5f7207 430How strictly to follow the standards.
5ee03c86 431@item -aic
4c5f7207 432Enable Advanced intra coding (h263+).
5ee03c86 433@item -umv
4c5f7207 434Enable Unlimited Motion Vector (h263+)
18bff752
FB
435
436@item -deinterlace
4c5f7207 437Deinterlace pictures.
99db6420 438@item -interlace
4c5f7207
DB
439Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
440Use this option if your input file is interlaced and you want
441to keep the interlaced format for minimum losses.
442The alternative is to deinterlace the input stream with
443@option{-deinterlace}, but deinterlacing introduces losses.
18bff752 444@item -psnr
4c5f7207 445Calculate PSNR of compressed frames.
18bff752 446@item -vstats
4c5f7207 447Dump video coding statistics to @file{vstats_HHMMSS.log}.
18bff752 448@item -vhook module
4c5f7207 449Insert video processing @var{module}. @var{module} contains the module
18bff752 450name and its parameters separated by spaces.
18bff752
FB
451@end table
452
453@section Audio Options
454
455@table @option
115329f1 456@item -ar freq
4c5f7207 457Set the audio sampling frequency (default = 44100 Hz).
115329f1 458@item -ab bitrate
4c5f7207 459Set the audio bitrate in kbit/s (default = 64).
18bff752 460@item -ac channels
4c5f7207 461Set the number of audio channels (default = 1).
5ee03c86 462@item -an
4c5f7207 463Disable audio recording.
5ee03c86 464@item -acodec codec
4c5f7207
DB
465Force audio codec to @var{codec}. Use the @code{copy} special value to
466specify that the raw codec data must be copied as is.
18bff752
FB
467@end table
468
469@section Audio/Video grab options
470
471@table @option
472@item -vd device
4c5f7207 473sEt video grab device (e.g. @file{/dev/video0}).
18bff752 474@item -vc channel
4c5f7207 475Set video grab channel (DV1394 only).
18bff752 476@item -tvstd standard
4c5f7207 477Set television standard (NTSC, PAL (SECAM)).
18bff752 478@item -dv1394
4c5f7207 479Set DV1394 grab.
18bff752 480@item -ad device
4c5f7207 481Set audio device (e.g. @file{/dev/dsp}).
18bff752
FB
482@end table
483
484@section Advanced options
485
486@table @option
115329f1 487@item -map file:stream
4c5f7207 488Set input stream mapping.
18bff752 489@item -debug
4c5f7207 490Print specific debug info.
115329f1 491@item -benchmark
4c5f7207 492Add timings for benchmarking.
115329f1 493@item -hex
4c5f7207 494Dump each input packet.
18bff752 495@item -bitexact
4c5f7207 496Only use bit exact algorithms (for codec testing).
18bff752 497@item -ps size
4c5f7207 498Set packet size in bits.
5ee03c86 499@item -re
4c5f7207 500Read input at native frame rate. Mainly used to simulate a grab device.
5ee03c86 501@item -loop
4c5f7207
DB
502Loop over the input stream. Currently it works only for image
503streams. This option is used for automatic FFserver testing.
8108551a 504@item -loop_output number_of_times
019c8838 505Repeatedly loop output for formats that support looping such as animated GIF
4c5f7207 506(0 will loop the output infinitely).
9181577c 507@end table
18bff752
FB
508
509@node FFmpeg formula evaluator
510@section FFmpeg formula evaluator
511
512When evaluating a rate control string, FFmpeg uses an internal formula
115329f1 513evaluator.
18bff752
FB
514
515The following binary operators are available: @code{+}, @code{-},
516@code{*}, @code{/}, @code{^}.
517
518The following unary operators are available: @code{+}, @code{-},
519@code{(...)}.
520
521The following functions are available:
522@table @var
523@item sinh(x)
524@item cosh(x)
525@item tanh(x)
526@item sin(x)
527@item cos(x)
528@item tan(x)
529@item exp(x)
530@item log(x)
531@item squish(x)
532@item gauss(x)
533@item abs(x)
534@item max(x, y)
535@item min(x, y)
536@item gt(x, y)
537@item lt(x, y)
538@item eq(x, y)
539@item bits2qp(bits)
540@item qp2bits(qp)
541@end table
542
543The following constants are available:
544@table @var
545@item PI
546@item E
547@item iTex
548@item pTex
549@item tex
550@item mv
551@item fCode
552@item iCount
553@item mcVar
554@item var
555@item isI
556@item isP
557@item isB
558@item avgQP
559@item qComp
560@item avgIITex
561@item avgPITex
562@item avgPPTex
563@item avgBPTex
564@item avgTex
565@end table
566
e99c4e10
FB
567@c man end
568
569@ignore
570
571@setfilename ffmpeg
572@settitle FFmpeg video converter
573
574@c man begin SEEALSO
019c8838 575ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
e99c4e10
FB
576@c man end
577
578@c man begin AUTHOR
579Fabrice Bellard
580@c man end
581
582@end ignore
9181577c
FB
583
584@section Protocols
585
4c5f7207
DB
586The filename can be @file{-} to read from standard input or to write
587to standard output.
9181577c 588
4c5f7207 589FFmpeg also handles many protocols specified with an URL syntax.
9181577c 590
4c5f7207 591Use 'ffmpeg -formats' to see a list of the supported protocols.
9181577c 592
e99c4e10 593The protocol @code{http:} is currently used only to communicate with
4c5f7207 594FFserver (see the FFserver documentation). When FFmpeg will be a
e99c4e10 595video player it will also be used for streaming :-)
9181577c
FB
596
597@chapter Tips
598
599@itemize
4c5f7207
DB
600@item For streaming at very low bitrate application, use a low frame rate
601and a small GOP size. This is especially true for RealVideo where
e99c4e10
FB
602the Linux player does not seem to be very fast, so it can miss
603frames. An example is:
9181577c
FB
604
605@example
e99c4e10 606ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
9181577c
FB
607@end example
608
609@item The parameter 'q' which is displayed while encoding is the current
4c5f7207
DB
610quantizer. The value 1 indicates that a very good quality could
611be achieved. The value 31 indicates the worst quality. If q=31 appears
e99c4e10 612too often, it means that the encoder cannot compress enough to meet
4c5f7207 613your bitrate. You must either increase the bitrate, decrease the
e99c4e10 614frame rate or decrease the frame size.
9181577c
FB
615
616@item If your computer is not fast enough, you can speed up the
e99c4e10
FB
617compression at the expense of the compression ratio. You can use
618'-me zero' to speed up motion estimation, and '-intra' to disable
4c5f7207 619motion estimation completely (you have only I-frames, which means it
e99c4e10 620is about as good as JPEG compression).
9181577c 621
4c5f7207 622@item To have very low audio bitrates, reduce the sampling frequency
019c8838 623(down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
9181577c
FB
624
625@item To have a constant quality (but a variable bitrate), use the option
e99c4e10
FB
626'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
627quality).
9181577c
FB
628
629@item When converting video files, you can use the '-sameq' option which
4c5f7207
DB
630uses the same quality factor in the encoder as in the decoder.
631It allows almost lossless encoding.
9181577c
FB
632
633@end itemize
634
635@chapter Supported File Formats and Codecs
636
637You can use the @code{-formats} option to have an exhaustive list.
638
639@section File Formats
640
6bf40f39 641FFmpeg supports the following file formats through the @code{libavformat}
0699d2fe 642library:
9181577c 643
3fc9e78f 644@multitable @columnfractions .4 .1 .1 .4
9181577c
FB
645@item Supported File Format @tab Encoding @tab Decoding @tab Comments
646@item MPEG audio @tab X @tab X
4c5f7207 647@item MPEG-1 systems @tab X @tab X
9181577c 648@tab muxed audio and video
4c5f7207 649@item MPEG-2 PS @tab X @tab X
9181577c 650@tab also known as @code{VOB} file
4c5f7207 651@item MPEG-2 TS @tab @tab X
9181577c 652@tab also known as DVB Transport Stream
115329f1
DB
653@item ASF@tab X @tab X
654@item AVI@tab X @tab X
655@item WAV@tab X @tab X
9181577c 656@item Macromedia Flash@tab X @tab X
4c5f7207 657@tab Only embedded audio is decoded.
2eb5d024
FB
658@item FLV @tab X @tab X
659@tab Macromedia Flash video files
115329f1
DB
660@item Real Audio and Video @tab X @tab X
661@item Raw AC3 @tab X @tab X
662@item Raw MJPEG @tab X @tab X
663@item Raw MPEG video @tab X @tab X
664@item Raw PCM8/16 bits, mulaw/Alaw@tab X @tab X
665@item Raw CRI ADX audio @tab X @tab X
666@item Raw Shorten audio @tab @tab X
667@item SUN AU format @tab X @tab X
7fe4c823 668@item NUT @tab X @tab X @tab NUT Open Container Format
115329f1 669@item QuickTime @tab X @tab X
4c5f7207
DB
670@item MPEG-4 @tab X @tab X
671@tab MPEG-4 is a variant of QuickTime.
115329f1 672@item Raw MPEG4 video @tab X @tab X
4fa1c4fa 673@item DV @tab X @tab X
701b603d 674@item 4xm @tab @tab X
4c5f7207 675@tab 4X Technologies format, used in some games.
4d3b1f8d
MM
676@item Playstation STR @tab @tab X
677@item Id RoQ @tab @tab X
4c5f7207 678@tab Used in Quake III, Jedi Knight 2, other computer games.
4d3b1f8d 679@item Interplay MVE @tab @tab X
4c5f7207 680@tab Format used in various Interplay computer games.
b17e9c99 681@item WC3 Movie @tab @tab X
4c5f7207 682@tab Multimedia format used in Origin's Wing Commander III computer game.
2fdf638b 683@item Sega FILM/CPK @tab @tab X
4c5f7207 684@tab Used in many Sega Saturn console games.
2fdf638b 685@item Westwood Studios VQA/AUD @tab @tab X
4c5f7207 686@tab Multimedia formats used in Westwood Studios games.
4120a53a 687@item Id Cinematic (.cin) @tab @tab X
4c5f7207 688@tab Used in Quake II.
42cad81a
MM
689@item FLIC format @tab @tab X
690@tab .fli/.flc files
da00f30e 691@item Sierra VMD @tab @tab X
4c5f7207 692@tab Used in Sierra CD-ROM games.
d08d7142 693@item Sierra Online @tab @tab X
4c5f7207 694@tab .sol files used in Sierra Online games.
38088adf 695@item Matroska @tab @tab X
ad81a9fe 696@item Electronic Arts Multimedia @tab @tab X
4c5f7207 697@tab Used in various EA games; files have extensions like WVE and UV2.
353147ed 698@item Nullsoft Video (NSV) format @tab @tab X
4accd1fd 699@item ADTS AAC audio @tab X @tab X
ea395e8c 700@item Creative VOC @tab X @tab X @tab Created for the Sound Blaster Pro.
4e114829
MM
701@item American Laser Games MM @tab @tab X
702@tab Multimedia format used in games like Mad Dog McCree
26376701
MM
703@item AVS @tab @tab X
704@tab Multimedia format used by the Creature Shock game.
348efc18
KS
705@item Smacker @tab @tab X
706@tab Multimedia format used by many games.
353147ed 707@end multitable
9181577c 708
4c5f7207 709@code{X} means that encoding (resp. decoding) is supported.
9181577c 710
0699d2fe
FB
711@section Image Formats
712
713FFmpeg can read and write images for each frame of a video sequence. The
714following image formats are supported:
715
3fc9e78f 716@multitable @columnfractions .4 .1 .1 .4
0699d2fe 717@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
115329f1 718@item PGM, PPM @tab X @tab X
4c5f7207 719@item PAM @tab X @tab X @tab PAM is a PNM extension with alpha support.
2eb5d024 720@item PGMYUV @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
4c5f7207
DB
721@item JPEG @tab X @tab X @tab Progressive JPEG is not supported.
722@item .Y.U.V @tab X @tab X @tab one raw file per component
723@item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
724@item PNG @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
6a91ec51 725@item SGI @tab X @tab X @tab SGI RGB image format
0699d2fe
FB
726@end multitable
727
4c5f7207 728@code{X} means that encoding (resp. decoding) is supported.
0699d2fe 729
9181577c
FB
730@section Video Codecs
731
3fc9e78f 732@multitable @columnfractions .4 .1 .1 .4
9181577c 733@item Supported Codec @tab Encoding @tab Decoding @tab Comments
4c5f7207
DB
734@item MPEG-1 video @tab X @tab X
735@item MPEG-2 video @tab X @tab X
736@item MPEG-4 @tab X @tab X @tab also known as DivX4/5
9181577c
FB
737@item MSMPEG4 V1 @tab X @tab X
738@item MSMPEG4 V2 @tab X @tab X
4c5f7207 739@item MSMPEG4 V3 @tab X @tab X @tab also known as DivX3
9181577c 740@item WMV7 @tab X @tab X
4c5f7207 741@item WMV8 @tab X @tab X @tab not completely working
b06b45c4 742@item H.261 @tab X @tab X
4c5f7207 743@item H.263(+) @tab X @tab X @tab also known as RealVideo 1.0
b06b45c4 744@item H.264 @tab @tab X
e839a994
DB
745@item RealVideo 1.0 @tab X @tab X
746@item RealVideo 2.0 @tab X @tab X
115329f1 747@item MJPEG @tab X @tab X
4c5f7207 748@item lossless MJPEG @tab X @tab X
26d6d032 749@item JPEG-LS @tab X @tab X @tab fourcc: MJLS, lossless and near-lossless is supported
d6896c49
AB
750@item Apple MJPEG-B @tab @tab X
751@item Sunplus MJPEG @tab @tab X @tab fourcc: SP5X
115329f1 752@item DV @tab X @tab X
4c5f7207
DB
753@item HuffYUV @tab X @tab X
754@item FFmpeg Video 1 @tab X @tab X @tab experimental lossless codec (fourcc: FFV1)
755@item FFmpeg Snow @tab X @tab X @tab experimental wavelet codec (fourcc: SNOW)
701b603d 756@item Asus v1 @tab X @tab X @tab fourcc: ASV1
4d3b1f8d 757@item Asus v2 @tab X @tab X @tab fourcc: ASV2
701b603d 758@item Creative YUV @tab @tab X @tab fourcc: CYUV
d2bfadc0 759@item Sorenson Video 1 @tab X @tab X @tab fourcc: SVQ1
701b603d
MM
760@item Sorenson Video 3 @tab @tab X @tab fourcc: SVQ3
761@item On2 VP3 @tab @tab X @tab still experimental
d6896c49 762@item Theora @tab @tab X @tab still experimental
cdb2c1ca 763@item Intel Indeo 3 @tab @tab X
9303d49c 764@item FLV @tab X @tab X @tab Sorenson H.263 used in Flash
4d3b1f8d 765@item ATI VCR1 @tab @tab X @tab fourcc: VCR1
7fe4c823 766@item ATI VCR2 @tab @tab X @tab fourcc: VCR2
4d3b1f8d 767@item Cirrus Logic AccuPak @tab @tab X @tab fourcc: CLJR
4c5f7207 768@item 4X Video @tab @tab X @tab Used in certain computer games.
115329f1 769@item Sony Playstation MDEC @tab @tab X
4c5f7207
DB
770@item Id RoQ @tab @tab X @tab Used in Quake III, Jedi Knight 2, other computer games.
771@item Xan/WC3 @tab @tab X @tab Used in Wing Commander III .MVE files.
772@item Interplay Video @tab @tab X @tab Used in Interplay .MVE files.
070ed1bc 773@item Apple Animation @tab @tab X @tab fourcc: 'rle '
42cad81a 774@item Apple Graphics @tab @tab X @tab fourcc: 'smc '
2fdf638b 775@item Apple Video @tab @tab X @tab fourcc: rpza
d08d7142 776@item Apple QuickDraw @tab @tab X @tab fourcc: qdrw
2fdf638b
MM
777@item Cinepak @tab @tab X
778@item Microsoft RLE @tab @tab X
779@item Microsoft Video-1 @tab @tab X
4120a53a 780@item Westwood VQA @tab @tab X
4c5f7207 781@item Id Cinematic Video @tab @tab X @tab Used in Quake II.
1dc1ed99 782@item Planar RGB @tab @tab X @tab fourcc: 8BPS
42cad81a 783@item FLIC video @tab @tab X
9a4117d5 784@item Duck TrueMotion v1 @tab @tab X @tab fourcc: DUCK
dce76c20 785@item Duck TrueMotion v2 @tab @tab X @tab fourcc: TM20
4c5f7207 786@item VMD Video @tab @tab X @tab Used in Sierra VMD files.
a273bbfb
RT
787@item MSZH @tab @tab X @tab Part of LCL
788@item ZLIB @tab X @tab X @tab Part of LCL, encoder experimental
9d53d58e 789@item TechSmith Camtasia @tab @tab X @tab fourcc: TSCC
d0a0bbd2 790@item IBM Ultimotion @tab @tab X @tab fourcc: ULTI
ab711b3c 791@item Miro VideoXL @tab @tab X @tab fourcc: VIXL
acfd8f0f 792@item QPEG @tab @tab X @tab fourccs: QPEG, Q1.0, Q1.1
115329f1
DB
793@item LOCO @tab @tab X @tab
794@item Winnov WNV1 @tab @tab X @tab
589f8220 795@item Autodesk Animator Studio Codec @tab @tab X @tab fourcc: AASC
115329f1 796@item Fraps FPS1 @tab @tab X @tab
2b6c1d80 797@item CamStudio @tab @tab X @tab fourcc: CSCD
4e114829 798@item American Laser Games Video @tab @tab X @tab Used in games like Mad Dog McCree
9c8d8e84 799@item ZMBV @tab @tab X @tab
26376701 800@item AVS Video @tab @tab X @tab Video encoding used by the Creature Shock game.
348efc18 801@item Smacker Video @tab @tab X @tab Video encoding used in Smacker.
dfca23e3 802@item RTjpeg @tab @tab X @tab Video encoding used in NuppelVideo files.
fd7b1991 803@item KMVC @tab @tab X @tab Codec used in Worms games.
9181577c
FB
804@end multitable
805
4c5f7207 806@code{X} means that encoding (resp. decoding) is supported.
9181577c 807
70b0bb87 808See @url{http://mplayerhq.hu/~michael/codec-features.html} to
4c5f7207
DB
809get a precise comparison of the FFmpeg MPEG-4 codec compared to
810other implementations.
60837265 811
9181577c
FB
812@section Audio Codecs
813
814@multitable @columnfractions .4 .1 .1 .1 .7
815@item Supported Codec @tab Encoding @tab Decoding @tab Comments
115329f1 816@item MPEG audio layer 2 @tab IX @tab IX
9181577c 817@item MPEG audio layer 1/3 @tab IX @tab IX
4c5f7207 818@tab MP3 encoding is supported through the external library LAME.
37776c3b 819@item AC3 @tab IX @tab IX
4c5f7207 820@tab liba52 is used internally for decoding.
34d7008d 821@item Vorbis @tab X @tab X
4c5f7207 822@tab Supported through the external library libvorbis.
4745b5bf 823@item WMA V1/V2 @tab @tab X
f6fa7a6c 824@item AAC @tab X @tab X
4c5f7207 825@tab Supported through the external library libfaac/libfaad.
d4c3c5a6 826@item Microsoft ADPCM @tab X @tab X
4d3b1f8d
MM
827@item MS IMA ADPCM @tab X @tab X
828@item QT IMA ADPCM @tab @tab X
829@item 4X IMA ADPCM @tab @tab X
d4e437df 830@item G.726 ADPCM @tab X @tab X
b17e9c99 831@item Duck DK3 IMA ADPCM @tab @tab X
4c5f7207 832@tab Used in some Sega Saturn console games.
b17e9c99 833@item Duck DK4 IMA ADPCM @tab @tab X
4c5f7207 834@tab Used in some Sega Saturn console games.
2fdf638b 835@item Westwood Studios IMA ADPCM @tab @tab X
4c5f7207 836@tab Used in Westwood Studios games like Command and Conquer.
7d8379f2 837@item SMJPEG IMA ADPCM @tab @tab X
4c5f7207 838@tab Used in certain Loki game ports.
42cad81a
MM
839@item CD-ROM XA ADPCM @tab @tab X
840@item CRI ADX ADPCM @tab X @tab X
4c5f7207 841@tab Used in Sega Dreamcast games.
7d8379f2 842@item Electronic Arts ADPCM @tab @tab X
4c5f7207 843@tab Used in various EA titles.
b3bfb299 844@item Creative ADPCM @tab @tab X
2433f24f 845@tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
2eb5d024
FB
846@item RA144 @tab @tab X
847@tab Real 14400 bit/s codec
848@item RA288 @tab @tab X
849@tab Real 28800 bit/s codec
37776c3b 850@item RADnet @tab X @tab IX
4c5f7207 851@tab Real low bitrate AC3 codec, liba52 is used for decoding.
2eb5d024 852@item AMR-NB @tab X @tab X
4c5f7207 853@tab Supported through an external library.
d663a1fd 854@item AMR-WB @tab X @tab X
4c5f7207 855@tab Supported through an external library.
2eb5d024 856@item DV audio @tab @tab X
4d3b1f8d 857@item Id RoQ DPCM @tab @tab X
4c5f7207 858@tab Used in Quake III, Jedi Knight 2, other computer games.
4d3b1f8d 859@item Interplay MVE DPCM @tab @tab X
4c5f7207 860@tab Used in various Interplay computer games.
b17e9c99 861@item Xan DPCM @tab @tab X
4c5f7207 862@tab Used in Origin's Wing Commander IV AVI files.
d08d7142 863@item Sierra Online DPCM @tab @tab X
4c5f7207 864@tab Used in Sierra Online game audio files.
d6896c49
AB
865@item Apple MACE 3 @tab @tab X
866@item Apple MACE 6 @tab @tab X
13dfd2b9
MM
867@item FLAC lossless audio @tab @tab X
868@item Shorten lossless audio @tab @tab X
f770ee03
MM
869@item Apple lossless audio @tab @tab X
870@tab QuickTime fourcc 'alac'
33a4d8b1 871@item FFmpeg Sonic @tab X @tab X
4c5f7207 872@tab experimental lossy/lossless codec
d9b1c197
RT
873@item Qdesign QDM2 @tab @tab X
874@tab there are still some distortions
440e7988
RT
875@item Real COOK @tab @tab X
876@tab All versions except 5.1 are supported
e839a994 877@item DSP Group TrueSpeech @tab @tab X
3dc411c0 878@item True Audio (TTA) @tab @tab X
348efc18 879@item Smacker Audio @tab @tab X
9181577c
FB
880@end multitable
881
4c5f7207 882@code{X} means that encoding (resp. decoding) is supported.
9181577c 883
4c5f7207
DB
884@code{I} means that an integer-only version is available, too (ensures high
885performance on systems without hardware floating point support).
9181577c 886
47d944d2
FB
887@chapter Platform Specific information
888
889@section Linux
890
4c5f7207
DB
891FFmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
892preferred compiler now for FFmpeg. All future optimizations will depend on
47d944d2
FB
893features only found in GCC 3.2.
894
895@section BSD
896
21d1cb12
DB
897BSD make will not build FFmpeg, you need to install and use GNU Make
898(@file{gmake}).
899
47d944d2
FB
900@section Windows
901
b030b284
FB
902@subsection Native Windows compilation
903
904@itemize
905@item Install the current versions of MSYS and MinGW from
906@url{http://www.mingw.org/}. You can find detailed installation
907instructions in the download section and the FAQ.
908
4c5f7207 909@item If you want to test the FFplay, also download
50f52fcd
FB
910the MinGW development library of SDL 1.2.x
911(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
4c5f7207 912@url{http://www.libsdl.org}. Unpack it in a temporary directory, and
50f52fcd 913unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
988a9f9e
FB
914directory. Edit the @file{sdl-config} script so that it gives the
915correct SDL directory when invoked.
50f52fcd 916
e926e391 917@item Extract the current version of FFmpeg.
115329f1 918
b030b284
FB
919@item Start the MSYS shell (file @file{msys.bat}).
920
4c5f7207
DB
921@item Change to the FFmpeg directory and follow
922 the instructions of how to compile FFmpeg (file
50f52fcd
FB
923@file{INSTALL}). Usually, launching @file{./configure} and @file{make}
924suffices. If you have problems using SDL, verify that
925@file{sdl-config} can be launched from the MSYS command line.
926
4c5f7207
DB
927@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing
928@file{make install}. Don't forget to copy @file{SDL.dll} to the place
929you launch @file{ffplay} from.
50f52fcd 930
b030b284
FB
931@end itemize
932
115329f1 933Notes:
988a9f9e 934@itemize
50f52fcd 935
988a9f9e
FB
936@item The target @file{make wininstaller} can be used to create a
937Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
4c5f7207 938must be copied to the FFmpeg directory in order to build the
988a9f9e
FB
939installer.
940
4c5f7207 941@item By using @code{./configure --enable-shared} when configuring FFmpeg,
988a9f9e
FB
942you can build @file{avcodec.dll} and @file{avformat.dll}. With
943@code{make install} you install the FFmpeg DLLs and the associated
115329f1 944headers in @file{Program Files/FFmpeg}.
988a9f9e 945
4c5f7207
DB
946@item Visual C++ compatibility: If you used @code{./configure --enable-shared}
947when configuring FFmpeg, FFmpeg tries to use the Microsoft Visual
988a9f9e 948C++ @code{lib} tool to build @code{avcodec.lib} and
4c5f7207 949@code{avformat.lib}. With these libraries you can link your Visual C++
be0efc0c 950code directly with the FFmpeg DLLs (see below).
988a9f9e
FB
951
952@end itemize
b030b284 953
be0efc0c
MB
954@subsection Visual C++ compatibility
955
956FFmpeg will not compile under Visual C++ -- and it has too many
957dependencies on the GCC compiler to make a port viable. However,
958if you want to use the FFmpeg libraries in your own applications,
959you can still compile those applications using Visual C++. An
960important restriction to this is that you have to use the
961dynamically linked versions of the FFmpeg libraries (i.e. the
962DLLs), and you have to make sure that Visual-C++-compatible
963import libraries are created during the FFmpeg build process.
964
965This description of how to use the FFmpeg libraries with Visual C++ is
966based on Visual C++ 2005 Express Edition Beta 2. If you have a different
967version, you might have to modify the procedures slightly.
968
969Here are the step-by-step instructions for building the FFmpeg libraries
970so they can be used with Visual C++:
971
972@enumerate
973
974@item Install Visual C++ (if you haven't done so already).
975
976@item Install MinGW and MSYS as described above.
977
978@item Add a call to @file{vcvars32.bat} (which sets up the environment
979variables for the Visual C++ tools) as the first line of
980@file{msys.bat}. The standard location for @file{vcvars32.bat} is
981@file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
982and the standard location for @file{msys.bat} is
983@file{C:\msys\1.0\msys.bat}. If this corresponds to your setup, add the
984following line as the first line of @file{msys.bat}:
985
986@code{call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"}
987
988@item Start the MSYS shell (file @file{msys.bat}) and type @code{link.exe}.
989If you get a help message with the command line options of @code{link.exe},
990this means your environment variables are set up correctly, the
991Microsoft linker is on the path and will be used by FFmpeg to
992create Visual-C++-compatible import libraries.
993
e926e391 994@item Extract the current version of FFmpeg and change to the FFmpeg directory.
be0efc0c
MB
995
996@item Type the command
51d8321d
DB
997@code{./configure --enable-shared --disable-static --enable-memalign-hack}
998to configure and, if that didn't produce any errors,
999type @code{make} to build FFmpeg.
be0efc0c
MB
1000
1001@item The subdirectories @file{libavformat}, @file{libavcodec}, and
1002@file{libavutil} should now contain the files @file{avformat.dll},
1003@file{avformat.lib}, @file{avcodec.dll}, @file{avcodec.lib},
1004@file{avutil.dll}, and @file{avutil.lib}, respectively. Copy the three
1005DLLs to your System32 directory (typically @file{C:\Windows\System32}).
1006
1007@end enumerate
1008
1009And here is how to use these libraries with Visual C++:
1010
1011@enumerate
1012
1013@item Create a new console application ("File / New / Project") and then
1014select "Win32 Console Application". On the appropriate page of the
1015Application Wizard, uncheck the "Precompiled headers" option.
1016
1017@item Write the source code for your application, or, for testing, just
1018copy the code from an existing sample application into the source file
1019that Visual C++ has already created for you. (Note that your source
1020filehas to have a @code{.cpp} extension; otherwise, Visual C++ won't
1021compile the FFmpeg headers correctly because in C mode, it doesn't
1022recognize the @code{inline} keyword.) For example, you can copy
1023@file{output_example.c} from the FFmpeg distribution (but you will
1024have to make minor modifications so the code will compile under
1025C++, see below).
1026
1027@item Open the "Project / Properties" dialog box. In the "Configuration"
1028combo box, select "All Configurations" so that the changes you make will
1029affect both debug and release builds. In the tree view on the left hand
1030side, select "C/C++ / General", then edit the "Additional Include
1031Directories" setting to contain the complete paths to the
1032@file{libavformat}, @file{libavcodec}, and @file{libavutil}
1033subdirectories of your FFmpeg directory. Note that the directories have
1034to be separated using semicolons. Now select "Linker / General" from the
1035tree view and edit the "Additional Library Directories" setting to
1036contain the same three directories.
1037
1038@item Still in the "Project / Properties" dialog box, select "Linker / Input"
1039from the tree view, then add the files @file{avformat.lib},
1040@file{avcodec.lib}, and @file{avutil.lib} to the end of the "Additional
1041Dependencies". Note that the names of the libraries have to be separated
1042using spaces.
1043
765c3440 1044@item Now, select "C/C++ / Code Generation" from the tree view. Select
be0efc0c
MB
1045"Debug" in the "Configuration" combo box. Make sure that "Runtime
1046Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
1047the "Configuration" combo box and make sure that "Runtime Library" is
1048set to "Multi-threaded DLL".
1049
1050@item Click "OK" to close the "Project / Properties" dialog box and build
1051the application. Hopefully, it should compile and run cleanly. If you
1052used @file{output_example.c} as your sample application, you will get a
1053few compiler errors, but they are easy to fix. The first type of error
1054occurs because Visual C++ doesn't allow an @code{int} to be converted to
1055an @code{enum} without a cast. To solve the problem, insert the required
1056casts (this error occurs once for a @code{CodecID} and once for a
1057@code{CodecType}). The second type of error occurs because C++ requires
1058the return value of @code{malloc} to be cast to the exact type of the
1059pointer it is being assigned to. Visual C++ will complain that, for
1060example, @code{(void *)} is being assigned to @code{(uint8_t *)} without
1061an explicit cast. So insert an explicit cast in these places to silence
1062the compiler. The third type of error occurs because the @code{snprintf}
1063library function is called @code{_snprintf} under Visual C++. So just
1064add an underscore to fix the problem. With these changes,
1065@file{output_example.c} should compile under Visual C++, and the
1066resulting executable should produce valid video files.
1067
1068@end enumerate
1069
b030b284
FB
1070@subsection Cross compilation for Windows with Linux
1071
1072You must use the MinGW cross compilation tools available at
1073@url{http://www.mingw.org/}.
1074
4c5f7207 1075Then configure FFmpeg with the following options:
b030b284
FB
1076@example
1077./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
1078@end example
019c8838 1079(you can change the cross-prefix according to the prefix chosen for the
b030b284
FB
1080MinGW tools).
1081
4c5f7207 1082Then you can easily test FFmpeg with Wine
b030b284
FB
1083(@url{http://www.winehq.com/}).
1084
019c8838 1085@section Mac OS X
47d944d2
FB
1086
1087@section BeOS
1088
1089The configure script should guess the configuration itself.
1090Networking support is currently not finished.
1091errno issues fixed by Andrew Bachmann.
1092
1093Old stuff:
1094
7dd611c9 1095François Revol - revol at free dot fr - April 2002
47d944d2 1096
115329f1 1097The configure script should guess the configuration itself,
4c5f7207 1098however I still didn't test building on the net_server version of BeOS.
47d944d2 1099
4c5f7207 1100FFserver is broken (needs poll() implementation).
47d944d2 1101
4c5f7207 1102There are still issues with errno codes, which are negative in BeOS, and
115329f1 1103that FFmpeg negates when returning. This ends up turning errors into
47d944d2
FB
1104valid results, then crashes.
1105(To be fixed)
1106
34d7008d 1107@chapter Developers Guide
9181577c
FB
1108
1109@section API
1110@itemize
1111@item libavcodec is the library containing the codecs (both encoding and
4c5f7207 1112decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
9181577c 1113
4c5f7207
DB
1114@item libavformat is the library containing the file format handling (mux and
1115demux code for several formats). Look at @file{ffplay.c} to use it in a
a93b9dba
FB
1116player. See @file{output_example.c} to use it to generate audio or video
1117streams.
1118
9181577c
FB
1119@end itemize
1120
1121@section Integrating libavcodec or libavformat in your program
1122
1123You can integrate all the source code of the libraries to link them
1124statically to avoid any version problem. All you need is to provide a
1125'config.mak' and a 'config.h' in the parent directory. See the defines
1126generated by ./configure to understand what is needed.
1127
1128You can use libavcodec or libavformat in your commercial program, but
1129@emph{any patch you make must be published}. The best way to proceed is
4c5f7207 1130to send your patches to the FFmpeg mailing list.
9181577c 1131
80d1c272 1132@node Coding Rules
9181577c
FB
1133@section Coding Rules
1134
4c5f7207 1135FFmpeg is programmed in the ISO C90 language with a few additional
cb6e87c1
FH
1136features from ISO C99, namely:
1137@itemize @bullet
1138@item
1139the @samp{inline} keyword;
1140@item
1141@samp{//} comments;
1142@item
1143designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
1144@item
114afa9c 1145compound literals (@samp{x = (struct s) @{ 17, 23 @};})
cb6e87c1
FH
1146@end itemize
1147
1148These features are supported by all compilers we care about, so we won't
1149accept patches to remove their use unless they absolutely don't impair
1150clarity and performance.
1151
4c5f7207 1152All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
cb6e87c1
FH
1153compiles with several other compilers, such as the Compaq ccc compiler
1154or Sun Studio 9, and we would like to keep it that way unless it would
1155be exceedingly involved. To ensure compatibility, please don't use any
4c5f7207 1156additional C99 features or GCC extensions. Especially watch out for:
cb6e87c1
FH
1157@itemize @bullet
1158@item
1159mixing statements and declarations;
1160@item
1161@samp{long long} (use @samp{int64_t} instead);
1162@item
1163@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
1164@item
019c8838 1165GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
cb6e87c1 1166@end itemize
9181577c 1167
53862e0f 1168Indent size is 4.
b86e38a0 1169The presentation is the one specified by 'indent -i4 -kr -nut'.
53862e0f
DB
1170The TAB character is forbidden outside of Makefiles as is any
1171form of trailing whitespace. Commits containing either will be
1172rejected by the CVS repository.
9181577c 1173
4c5f7207 1174Main priority in FFmpeg is simplicity and small code size (=less
9181577c
FB
1175bugs).
1176
4c5f7207
DB
1177Comments: Use the JavaDoc/Doxygen
1178format (see examples below) so that code documentation
1179can be generated automatically. All nontrivial functions should have a comment
1180above them explaining what the function does, even if it's just one sentence.
1181All structures and their member variables should be documented, too.
f4888b83
MN
1182@example
1183/**
2185824b
MR
1184 * @@file mpeg.c
1185 * MPEG codec.
1186 * @@author ...
1187 */
f4888b83
MN
1188
1189/**
2185824b
MR
1190 * Summary sentence.
1191 * more text ...
1192 * ...
1193 */
114afa9c 1194typedef struct Foobar@{
2185824b
MR
1195 int var1; /**< var1 description */
1196 int var2; ///< var2 description
1197 /** var3 description */
1198 int var3;
114afa9c 1199@} Foobar;
f4888b83
MN
1200
1201/**
2185824b
MR
1202 * Summary sentence.
1203 * more text ...
1204 * ...
1205 * @@param my_parameter description of my_parameter
1206 * @@return return value description
1207 */
f4888b83
MN
1208int myfunc(int my_parameter)
1209...
1210@end example
9181577c 1211
115329f1 1212fprintf and printf are forbidden in libavformat and libavcodec,
36d9b4e8
MN
1213please use av_log() instead.
1214
7a57b90c
MN
1215@node CVS Policy
1216@section CVS Policy
1217
1218@enumerate
115329f1 1219@item
7a57b90c 1220 You must not commit code which breaks FFmpeg! (Meaning unfinished but
4c5f7207 1221 enabled code which breaks compilation or compiles but does not work or
7a57b90c
MN
1222 breaks the regression tests)
1223 You can commit unfinished stuff (for testing etc), but it must be disabled
1224 (#ifdef etc) by default so it does not interfere with other developers'
1225 work.
115329f1 1226@item
7a57b90c 1227 You don't have to over-test things. If it works for you, and you think it
4c5f7207
DB
1228 should work for others, then commit. If your code has problems
1229 (portability, triggers compiler bugs, unusual environment etc) they will be
7a57b90c 1230 reported and eventually fixed.
115329f1 1231@item
7a57b90c
MN
1232 Do not commit unrelated changes together, split them into self-contained
1233 pieces.
1234@item
1235 Do not change behavior of the program (renaming options etc) without
019c8838 1236 first discussing it on the ffmpeg-devel mailing list. Do not remove
7a57b90c 1237 functionality from the code. Just improve!
115329f1 1238
4c5f7207 1239 Note: Redundant code can be removed.
7a57b90c
MN
1240@item
1241 Do not commit changes to the build system (Makefiles, configure script)
019c8838 1242 which change behavior, defaults etc, without asking first. The same
7a57b90c
MN
1243 applies to compiler warning fixes, trivial looking fixes and to code
1244 maintained by other developers. We usually have a reason for doing things
019c8838 1245 the way we do. Send your changes as patches to the ffmpeg-devel mailing
7a57b90c
MN
1246 list, and if the code maintainers say OK, you may commit. This does not
1247 apply to files you wrote and/or maintain.
1248@item
1249 We refuse source indentation and other cosmetic changes if they are mixed
1250 with functional changes, such commits will be rejected and removed. Every
1251 developer has his own indentation style, you should not change it. Of course
1252 if you (re)write something, you can use your own style, even though we would
4c5f7207
DB
1253 prefer if the indentation throughout FFmpeg was consistent (Many projects
1254 force a given indentation style - we don't.). If you really need to make
7a57b90c
MN
1255 indentation changes (try to avoid this), separate them strictly from real
1256 changes.
1257
114afa9c 1258 NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
115329f1 1259 then either do NOT change the indentation of the inner part within (don't
019c8838 1260 move it to the right)! or do so in a separate commit
7a57b90c
MN
1261@item
1262 Always fill out the commit log message. Describe in a few lines what you
1263 changed and why. You can refer to mailing list postings if you fix a
1264 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
1265@item
1266 If you apply a patch by someone else, include the name and email address in
1267 the CVS log message. Since the ffmpeg-cvslog mailing list is publicly
019c8838
DB
1268 archived you should add some SPAM protection to the email address. Send an
1269 answer to ffmpeg-devel (or wherever you got the patch from) saying that
7a57b90c
MN
1270 you applied the patch.
1271@item
1272 Do NOT commit to code actively maintained by others without permission. Send
019c8838 1273 a patch to ffmpeg-devel instead.
7a57b90c
MN
1274@item
1275 Subscribe to the ffmpeg-cvslog mailing list. The diffs of all CVS commits
1276 are sent there and reviewed by all the other developers. Bugs and possible
1277 improvements or general questions regarding commits are discussed there. We
1278 expect you to react if problems with your code are uncovered.
1279@item
1280 Update the documentation if you change behavior or add features. If you are
019c8838 1281 unsure how best to do this, send a patch to ffmpeg-devel, the documentation
7a57b90c
MN
1282 maintainer(s) will review and commit your stuff.
1283@item
1284 Revert a commit ONLY in case of a big blunder like committing something not
1285 intended to be committed or committing a wrong file, the wrong version of a
019c8838 1286 patch, CVS policy violation or broken code and you are going to recommit the
7a57b90c
MN
1287 right thing immediately.
1288
1289 Never revert changes made a long time ago or buggy code. Fix it in the
1290 normal way instead.
52f4aea0 1291@item
4c5f7207
DB
1292 Never write to unallocated memory, never write over the end of arrays,
1293 always check values read from some untrusted source before using them
1294 as array index or other risky things.
76bec1d8
AS
1295@item
1296 Remember to check if you need to bump versions for the specific libav
f0efbde7 1297 parts (libavutil, libavcodec, libavformat) you are changing. You need
76bec1d8
AS
1298 to change the version integer and the version string.
1299 Incrementing the first component means no backward compatibility to
f0efbde7 1300 previous versions (e.g. removal of a function).
76bec1d8
AS
1301 Incrementing the second component means backward compatible change
1302 (e.g. addition of a function).
1303 Incrementing the third component means a noteworthy binary compatible
1304 change (e.g. encoder bug fix that matters for the decoder).
ebd32fd7 1305@item
3f1965c4
DB
1306 If you add a new codec, remember to update the changelog, add it to
1307 the supported codecs table in the documentation and bump the second
1308 component of the @file{libavcodec} version number appropriately. If
1309 it has a fourcc, add it to @file{libavformat/avienc.c}, even if it
1310 is only a decoder.
114afa9c 1311@end enumerate
7a57b90c
MN
1312
1313We think our rules are not too hard. If you have comments, contact us.
1314
1315Note, these rules are mostly borrowed from the MPlayer project.
1316
1317@subsection Renaming/moving files or content of files
019c8838 1318 You CANNOT do that. Post a request for such a change to the mailing list
7a57b90c
MN
1319 Do NOT remove & readd a file - it will kill the changelog!!!!
1320
9181577c
FB
1321@section Submitting patches
1322
80d1c272
MN
1323First, (@pxref{Coding Rules}) above if you didn't yet.
1324
6a6810b1 1325When you submit your patch, try to send a unified diff (diff '-up'
9181577c
FB
1326option). I cannot read other diffs :-)
1327
6e5c1877 1328Also please do not submit patches which contain several unrelated changes.
115329f1 1329Split them into individual self-contained patches; this makes reviewing
7885603a
MN
1330them much easier.
1331
9181577c 1332Run the regression tests before submitting a patch so that you can
6bf40f39 1333verify that there are no big problems.
9181577c 1334
9181577c 1335Patches should be posted as base64 encoded attachments (or any other
4c5f7207 1336encoding which ensures that the patch won't be trashed during
115329f1 1337transmission) to the ffmpeg-devel mailing list, see
67c311fa 1338@url{http://www1.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
9181577c 1339
54fcf429 1340It also helps quite a bit if you tell us what the patch does (for example
4c5f7207 1341'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
54fcf429
MN
1342and has no lrint()')
1343
4c5f7207
DB
1344We reply to all submitted patches and either apply or reject with some
1345explanation why, but sometimes we are quite busy so it can take a week or two.
cf7f2b16 1346
9181577c
FB
1347@section Regression tests
1348
4c5f7207 1349Before submitting a patch (or committing to CVS), you should at least
9181577c
FB
1350test that you did not break anything.
1351
4c5f7207
DB
1352The regression tests build a synthetic video stream and a synthetic
1353audio stream. These are then encoded and decoded with all codecs or
9181577c 1354formats. The CRC (or MD5) of each generated file is recorded in a
4c5f7207 1355result file. A 'diff' is launched to compare the reference results and
9181577c
FB
1356the result file.
1357
4c5f7207 1358The regression tests then go on to test the FFserver code with a
6bf40f39
PG
1359limited set of streams. It is important that this step runs correctly
1360as well.
1361
36d9b4e8 1362Run 'make test' to test all the codecs and formats.
9181577c 1363
4c5f7207 1364Run 'make fulltest' to test all the codecs, formats and FFserver.
9181577c 1365
4c5f7207
DB
1366[Of course, some patches may change the results of the regression tests. In
1367this case, the reference results of the regression tests shall be modified
9181577c
FB
1368accordingly].
1369
1370@bye