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