ae38d65e690ab1ca5f9a1615289e1360066c7aa4
[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 @item -newaudio
486 Add a new audio track to the output file. If you want to specify parameters,
487 do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
488
489 Mapping will be done automatically, if the number of output streams is equal to
490 the number of input streams, else it will pick the first one that matches. You
491 can override the mapping using @code{-map} as usual.
492
493 Example:
494 @example
495 ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384 test.mpg -acodec mp2 -ab 192 -newaudio
496 @end example
497 @end table
498
499 @section Audio/Video grab options
500
501 @table @option
502 @item -vd device
503 sEt video grab device (e.g. @file{/dev/video0}).
504 @item -vc channel
505 Set video grab channel (DV1394 only).
506 @item -tvstd standard
507 Set television standard (NTSC, PAL (SECAM)).
508 @item -dv1394
509 Set DV1394 grab.
510 @item -ad device
511 Set audio device (e.g. @file{/dev/dsp}).
512 @end table
513
514 @section Advanced options
515
516 @table @option
517 @item -map input stream id[:input stream id]
518 Set stream mapping from input streams to output streams.
519 Just enumerate the input streams in the order you want them in the output.
520 [input stream id] sets the (input) stream to sync against.
521 @item -debug
522 Print specific debug info.
523 @item -benchmark
524 Add timings for benchmarking.
525 @item -hex
526 Dump each input packet.
527 @item -bitexact
528 Only use bit exact algorithms (for codec testing).
529 @item -ps size
530 Set packet size in bits.
531 @item -re
532 Read input at native frame rate. Mainly used to simulate a grab device.
533 @item -loop
534 Loop over the input stream. Currently it works only for image
535 streams. This option is used for automatic FFserver testing.
536 @item -loop_output number_of_times
537 Repeatedly loop output for formats that support looping such as animated GIF
538 (0 will loop the output infinitely).
539 @item -vsync parameter
540 Video sync method. Video will be stretched/squeezed to match the timestamps,
541 it is done by duplicating and dropping frames. With -map you can select from
542 which stream the timestamps should be taken. You can leave either video or
543 audio unchanged and sync the remaining stream(s) to the unchanged one.
544 @item -async samples_per_second
545 Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
546 the parameter is the maximum samples per second by which the audio is changed.
547 -async 1 is a special case where only the start of the audio stream is corrected
548 without any later correction.
549 @end table
550
551 @node FFmpeg formula evaluator
552 @section FFmpeg formula evaluator
553
554 When evaluating a rate control string, FFmpeg uses an internal formula
555 evaluator.
556
557 The following binary operators are available: @code{+}, @code{-},
558 @code{*}, @code{/}, @code{^}.
559
560 The following unary operators are available: @code{+}, @code{-},
561 @code{(...)}.
562
563 The following functions are available:
564 @table @var
565 @item sinh(x)
566 @item cosh(x)
567 @item tanh(x)
568 @item sin(x)
569 @item cos(x)
570 @item tan(x)
571 @item exp(x)
572 @item log(x)
573 @item squish(x)
574 @item gauss(x)
575 @item abs(x)
576 @item max(x, y)
577 @item min(x, y)
578 @item gt(x, y)
579 @item lt(x, y)
580 @item eq(x, y)
581 @item bits2qp(bits)
582 @item qp2bits(qp)
583 @end table
584
585 The following constants are available:
586 @table @var
587 @item PI
588 @item E
589 @item iTex
590 @item pTex
591 @item tex
592 @item mv
593 @item fCode
594 @item iCount
595 @item mcVar
596 @item var
597 @item isI
598 @item isP
599 @item isB
600 @item avgQP
601 @item qComp
602 @item avgIITex
603 @item avgPITex
604 @item avgPPTex
605 @item avgBPTex
606 @item avgTex
607 @end table
608
609 @c man end
610
611 @ignore
612
613 @setfilename ffmpeg
614 @settitle FFmpeg video converter
615
616 @c man begin SEEALSO
617 ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
618 @c man end
619
620 @c man begin AUTHOR
621 Fabrice Bellard
622 @c man end
623
624 @end ignore
625
626 @section Protocols
627
628 The filename can be @file{-} to read from standard input or to write
629 to standard output.
630
631 FFmpeg also handles many protocols specified with an URL syntax.
632
633 Use 'ffmpeg -formats' to see a list of the supported protocols.
634
635 The protocol @code{http:} is currently used only to communicate with
636 FFserver (see the FFserver documentation). When FFmpeg will be a
637 video player it will also be used for streaming :-)
638
639 @chapter Tips
640
641 @itemize
642 @item For streaming at very low bitrate application, use a low frame rate
643 and a small GOP size. This is especially true for RealVideo where
644 the Linux player does not seem to be very fast, so it can miss
645 frames. An example is:
646
647 @example
648 ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
649 @end example
650
651 @item  The parameter 'q' which is displayed while encoding is the current
652 quantizer. The value 1 indicates that a very good quality could
653 be achieved. The value 31 indicates the worst quality. If q=31 appears
654 too often, it means that the encoder cannot compress enough to meet
655 your bitrate. You must either increase the bitrate, decrease the
656 frame rate or decrease the frame size.
657
658 @item If your computer is not fast enough, you can speed up the
659 compression at the expense of the compression ratio. You can use
660 '-me zero' to speed up motion estimation, and '-intra' to disable
661 motion estimation completely (you have only I-frames, which means it
662 is about as good as JPEG compression).
663
664 @item To have very low audio bitrates, reduce the sampling frequency
665 (down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
666
667 @item To have a constant quality (but a variable bitrate), use the option
668 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
669 quality).
670
671 @item When converting video files, you can use the '-sameq' option which
672 uses the same quality factor in the encoder as in the decoder.
673 It allows almost lossless encoding.
674
675 @end itemize
676
677 @chapter Supported File Formats and Codecs
678
679 You can use the @code{-formats} option to have an exhaustive list.
680
681 @section File Formats
682
683 FFmpeg supports the following file formats through the @code{libavformat}
684 library:
685
686 @multitable @columnfractions .4 .1 .1 .4
687 @item Supported File Format @tab Encoding @tab Decoding @tab Comments
688 @item MPEG audio @tab X @tab X
689 @item MPEG-1 systems @tab X  @tab  X
690 @tab muxed audio and video
691 @item MPEG-2 PS @tab X  @tab  X
692 @tab also known as @code{VOB} file
693 @item MPEG-2 TS @tab    @tab  X
694 @tab also known as DVB Transport Stream
695 @item ASF@tab X @tab X
696 @item AVI@tab X @tab X
697 @item WAV@tab X @tab X
698 @item Macromedia Flash@tab X @tab X
699 @tab Only embedded audio is decoded.
700 @item FLV              @tab  X @tab X
701 @tab Macromedia Flash video files
702 @item Real Audio and Video @tab X @tab X
703 @item Raw AC3 @tab X  @tab  X
704 @item Raw MJPEG @tab X  @tab  X
705 @item Raw MPEG video @tab X  @tab  X
706 @item Raw PCM8/16 bits, mulaw/Alaw@tab X  @tab  X
707 @item Raw CRI ADX audio @tab X  @tab  X
708 @item Raw Shorten audio @tab    @tab  X
709 @item SUN AU format @tab X  @tab  X
710 @item NUT @tab X @tab X @tab NUT Open Container Format
711 @item QuickTime        @tab X @tab  X
712 @item MPEG-4           @tab X @tab  X
713 @tab MPEG-4 is a variant of QuickTime.
714 @item Raw MPEG4 video  @tab  X @tab  X
715 @item DV               @tab  X @tab  X
716 @item 4xm              @tab    @tab X
717 @tab 4X Technologies format, used in some games.
718 @item Playstation STR  @tab    @tab X
719 @item Id RoQ           @tab    @tab X
720 @tab Used in Quake III, Jedi Knight 2, other computer games.
721 @item Interplay MVE    @tab    @tab X
722 @tab Format used in various Interplay computer games.
723 @item WC3 Movie        @tab    @tab X
724 @tab Multimedia format used in Origin's Wing Commander III computer game.
725 @item Sega FILM/CPK    @tab    @tab X
726 @tab Used in many Sega Saturn console games.
727 @item Westwood Studios VQA/AUD  @tab    @tab X
728 @tab Multimedia formats used in Westwood Studios games.
729 @item Id Cinematic (.cin) @tab    @tab X
730 @tab Used in Quake II.
731 @item FLIC format      @tab    @tab X
732 @tab .fli/.flc files
733 @item Sierra VMD       @tab    @tab X
734 @tab Used in Sierra CD-ROM games.
735 @item Sierra Online    @tab    @tab X
736 @tab .sol files used in Sierra Online games.
737 @item Matroska         @tab    @tab X
738 @item Electronic Arts Multimedia    @tab    @tab X
739 @tab Used in various EA games; files have extensions like WVE and UV2.
740 @item Nullsoft Video (NSV) format @tab    @tab X
741 @item ADTS AAC audio @tab X @tab X
742 @item Creative VOC @tab X @tab X @tab Created for the Sound Blaster Pro.
743 @item American Laser Games MM  @tab    @tab X
744 @tab Multimedia format used in games like Mad Dog McCree
745 @item AVS @tab    @tab X
746 @tab Multimedia format used by the Creature Shock game.
747 @item Smacker @tab    @tab X
748 @tab Multimedia format used by many games.
749 @item GXF @tab  X @tab X
750 @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley playout servers.
751 @item CIN @tab    @tab X
752 @tab Multimedia format used by Delphine Software games.
753 @item MXF @tab    @tab X
754 @tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
755 @item SEQ @tab    @tab X
756 @tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
757 @end multitable
758
759 @code{X} means that encoding (resp. decoding) is supported.
760
761 @section Image Formats
762
763 FFmpeg can read and write images for each frame of a video sequence. The
764 following image formats are supported:
765
766 @multitable @columnfractions .4 .1 .1 .4
767 @item Supported Image Format @tab Encoding @tab Decoding @tab Comments
768 @item PGM, PPM     @tab X @tab X
769 @item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support.
770 @item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
771 @item JPEG         @tab X @tab X @tab Progressive JPEG is not supported.
772 @item .Y.U.V       @tab X @tab X @tab one raw file per component
773 @item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
774 @item PNG          @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
775 @item Targa        @tab   @tab X @tab Targa (.TGA) image format.
776 @item TIFF         @tab   @tab X @tab Only 24 bit/pixel images are supported.
777 @item SGI          @tab X @tab X @tab SGI RGB image format
778 @end multitable
779
780 @code{X} means that encoding (resp. decoding) is supported.
781
782 @section Video Codecs
783
784 @multitable @columnfractions .4 .1 .1 .4
785 @item Supported Codec @tab Encoding @tab Decoding @tab Comments
786 @item MPEG-1 video           @tab  X  @tab  X
787 @item MPEG-2 video           @tab  X  @tab  X
788 @item MPEG-4                 @tab  X  @tab  X
789 @item MSMPEG4 V1             @tab  X  @tab  X
790 @item MSMPEG4 V2             @tab  X  @tab  X
791 @item MSMPEG4 V3             @tab  X  @tab  X
792 @item WMV7                   @tab  X  @tab  X
793 @item WMV8                   @tab  X  @tab  X @tab not completely working
794 @item H.261                  @tab  X  @tab  X
795 @item H.263(+)               @tab  X  @tab  X @tab also known as RealVideo 1.0
796 @item H.264                  @tab     @tab  X
797 @item RealVideo 1.0          @tab  X  @tab  X
798 @item RealVideo 2.0          @tab  X  @tab  X
799 @item MJPEG                  @tab  X  @tab  X
800 @item lossless MJPEG         @tab  X  @tab  X
801 @item JPEG-LS                @tab  X  @tab  X @tab fourcc: MJLS, lossless and near-lossless is supported
802 @item Apple MJPEG-B          @tab     @tab  X
803 @item Sunplus MJPEG          @tab     @tab  X @tab fourcc: SP5X
804 @item DV                     @tab  X  @tab  X
805 @item HuffYUV                @tab  X  @tab  X
806 @item FFmpeg Video 1         @tab  X  @tab  X @tab experimental lossless codec (fourcc: FFV1)
807 @item FFmpeg Snow            @tab  X  @tab  X @tab experimental wavelet codec (fourcc: SNOW)
808 @item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
809 @item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
810 @item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
811 @item Sorenson Video 1       @tab  X  @tab  X @tab fourcc: SVQ1
812 @item Sorenson Video 3       @tab     @tab  X @tab fourcc: SVQ3
813 @item On2 VP3                @tab     @tab  X @tab still experimental
814 @item On2 VP5                @tab     @tab  X @tab fourcc: VP50
815 @item On2 VP6                @tab     @tab  X @tab fourcc: VP62
816 @item Theora                 @tab     @tab  X @tab still experimental
817 @item Intel Indeo 3          @tab     @tab  X
818 @item FLV                    @tab  X  @tab  X @tab Sorenson H.263 used in Flash
819 @item Flash Screen Video     @tab     @tab  X @tab fourcc: FSV1
820 @item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
821 @item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
822 @item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
823 @item 4X Video               @tab     @tab  X @tab Used in certain computer games.
824 @item Sony Playstation MDEC  @tab     @tab  X
825 @item Id RoQ                 @tab     @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
826 @item Xan/WC3                @tab     @tab  X @tab Used in Wing Commander III .MVE files.
827 @item Interplay Video        @tab     @tab  X @tab Used in Interplay .MVE files.
828 @item Apple Animation        @tab     @tab  X @tab fourcc: 'rle '
829 @item Apple Graphics         @tab     @tab  X @tab fourcc: 'smc '
830 @item Apple Video            @tab     @tab  X @tab fourcc: rpza
831 @item Apple QuickDraw        @tab     @tab  X @tab fourcc: qdrw
832 @item Cinepak                @tab     @tab  X
833 @item Microsoft RLE          @tab     @tab  X
834 @item Microsoft Video-1      @tab     @tab  X
835 @item Westwood VQA           @tab     @tab  X
836 @item Id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
837 @item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
838 @item FLIC video             @tab     @tab  X
839 @item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
840 @item Duck TrueMotion v2     @tab     @tab  X @tab fourcc: TM20
841 @item VMD Video              @tab     @tab  X @tab Used in Sierra VMD files.
842 @item MSZH                   @tab     @tab  X @tab Part of LCL
843 @item ZLIB                   @tab  X  @tab  X @tab Part of LCL, encoder experimental
844 @item TechSmith Camtasia     @tab     @tab  X @tab fourcc: TSCC
845 @item IBM Ultimotion         @tab     @tab  X @tab fourcc: ULTI
846 @item Miro VideoXL           @tab     @tab  X @tab fourcc: VIXL
847 @item QPEG                   @tab     @tab  X @tab fourccs: QPEG, Q1.0, Q1.1
848 @item LOCO                   @tab     @tab  X @tab
849 @item Winnov WNV1            @tab     @tab  X @tab
850 @item Autodesk Animator Studio Codec  @tab     @tab  X @tab fourcc: AASC
851 @item Fraps FPS1             @tab     @tab  X @tab
852 @item CamStudio              @tab     @tab  X @tab fourcc: CSCD
853 @item American Laser Games Video  @tab    @tab X @tab Used in games like Mad Dog McCree
854 @item ZMBV                   @tab     @tab  X @tab
855 @item AVS Video              @tab     @tab  X @tab Video encoding used by the Creature Shock game.
856 @item Smacker Video          @tab     @tab  X @tab Video encoding used in Smacker.
857 @item RTjpeg                 @tab     @tab  X @tab Video encoding used in NuppelVideo files.
858 @item KMVC                   @tab     @tab  X @tab Codec used in Worms games.
859 @item VMware Video           @tab     @tab  X @tab Codec used in videos captured by VMware.
860 @item Cin Video              @tab     @tab  X @tab Codec used in Delphine Software games.
861 @item Tiertex Seq Video      @tab     @tab  X @tab Codec used in DOS CDROM FlashBack game.
862 @end multitable
863
864 @code{X} means that encoding (resp. decoding) is supported.
865
866 @section Audio Codecs
867
868 @multitable @columnfractions .4 .1 .1 .1 .7
869 @item Supported Codec @tab Encoding @tab Decoding @tab Comments
870 @item MPEG audio layer 2     @tab  IX  @tab  IX
871 @item MPEG audio layer 1/3   @tab IX   @tab  IX
872 @tab MP3 encoding is supported through the external library LAME.
873 @item AC3                    @tab  IX  @tab  IX
874 @tab liba52 is used internally for decoding.
875 @item Vorbis                 @tab  X   @tab  X
876 @tab Supported through the external library libvorbis.
877 @item WMA V1/V2              @tab      @tab X
878 @item AAC                    @tab X    @tab X
879 @tab Supported through the external library libfaac/libfaad.
880 @item Microsoft ADPCM        @tab X    @tab X
881 @item MS IMA ADPCM           @tab X    @tab X
882 @item QT IMA ADPCM           @tab      @tab X
883 @item 4X IMA ADPCM           @tab      @tab X
884 @item G.726  ADPCM           @tab X    @tab X
885 @item Duck DK3 IMA ADPCM     @tab      @tab X
886 @tab Used in some Sega Saturn console games.
887 @item Duck DK4 IMA ADPCM     @tab      @tab X
888 @tab Used in some Sega Saturn console games.
889 @item Westwood Studios IMA ADPCM @tab      @tab X
890 @tab Used in Westwood Studios games like Command and Conquer.
891 @item SMJPEG IMA ADPCM       @tab      @tab X
892 @tab Used in certain Loki game ports.
893 @item CD-ROM XA ADPCM        @tab      @tab X
894 @item CRI ADX ADPCM          @tab X    @tab X
895 @tab Used in Sega Dreamcast games.
896 @item Electronic Arts ADPCM  @tab      @tab X
897 @tab Used in various EA titles.
898 @item Creative ADPCM         @tab      @tab X
899 @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
900 @item RA144                  @tab      @tab X
901 @tab Real 14400 bit/s codec
902 @item RA288                  @tab      @tab X
903 @tab Real 28800 bit/s codec
904 @item RADnet                 @tab X    @tab IX
905 @tab Real low bitrate AC3 codec, liba52 is used for decoding.
906 @item AMR-NB                 @tab X    @tab X
907 @tab Supported through an external library.
908 @item AMR-WB                 @tab X    @tab X
909 @tab Supported through an external library.
910 @item DV audio               @tab      @tab X
911 @item Id RoQ DPCM            @tab      @tab X
912 @tab Used in Quake III, Jedi Knight 2, other computer games.
913 @item Interplay MVE DPCM     @tab      @tab X
914 @tab Used in various Interplay computer games.
915 @item Xan DPCM               @tab      @tab X
916 @tab Used in Origin's Wing Commander IV AVI files.
917 @item Sierra Online DPCM     @tab      @tab X
918 @tab Used in Sierra Online game audio files.
919 @item Apple MACE 3           @tab      @tab X
920 @item Apple MACE 6           @tab      @tab X
921 @item FLAC lossless audio    @tab      @tab X
922 @item Shorten lossless audio @tab      @tab X
923 @item Apple lossless audio   @tab      @tab X
924 @tab QuickTime fourcc 'alac'
925 @item FFmpeg Sonic           @tab X    @tab X
926 @tab experimental lossy/lossless codec
927 @item Qdesign QDM2           @tab      @tab X
928 @tab there are still some distortions
929 @item Real COOK              @tab      @tab X
930 @tab All versions except 5.1 are supported
931 @item DSP Group TrueSpeech   @tab      @tab X
932 @item True Audio (TTA)       @tab      @tab X
933 @item Smacker Audio          @tab      @tab X
934 @item WavPack Audio          @tab      @tab X
935 @item Cin Audio              @tab      @tab X
936 @tab Codec used in Delphine Software games.
937 @end multitable
938
939 @code{X} means that encoding (resp. decoding) is supported.
940
941 @code{I} means that an integer-only version is available, too (ensures high
942 performance on systems without hardware floating point support).
943
944 @chapter Platform Specific information
945
946 @section Linux
947
948 FFmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
949 preferred compiler now for FFmpeg. All future optimizations will depend on
950 features only found in GCC 3.2.
951
952 @section BSD
953
954 BSD make will not build FFmpeg, you need to install and use GNU Make
955 (@file{gmake}).
956
957 @section Windows
958
959 @subsection Native Windows compilation
960
961 @itemize
962 @item Install the current versions of MSYS and MinGW from
963 @url{http://www.mingw.org/}. You can find detailed installation
964 instructions in the download section and the FAQ.
965
966 @item If you want to test the FFplay, also download
967 the MinGW development library of SDL 1.2.x
968 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
969 @url{http://www.libsdl.org}. Unpack it in a temporary directory, and
970 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
971 directory. Edit the @file{sdl-config} script so that it gives the
972 correct SDL directory when invoked.
973
974 @item Extract the current version of FFmpeg.
975
976 @item Start the MSYS shell (file @file{msys.bat}).
977
978 @item Change to the FFmpeg directory and follow
979  the instructions of how to compile FFmpeg (file
980 @file{INSTALL}). Usually, launching @file{./configure} and @file{make}
981 suffices. If you have problems using SDL, verify that
982 @file{sdl-config} can be launched from the MSYS command line.
983
984 @item You can install FFmpeg in @file{Program Files/FFmpeg} by typing
985 @file{make install}. Don't forget to copy @file{SDL.dll} to the place
986 you launch @file{ffplay} from.
987
988 @end itemize
989
990 Notes:
991 @itemize
992
993 @item The target @file{make wininstaller} can be used to create a
994 Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
995 must be copied to the FFmpeg directory in order to build the
996 installer.
997
998 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
999 you can build @file{avcodec.dll} and @file{avformat.dll}. With
1000 @code{make install} you install the FFmpeg DLLs and the associated
1001 headers in @file{Program Files/FFmpeg}.
1002
1003 @item Visual C++ compatibility: If you used @code{./configure --enable-shared}
1004 when configuring FFmpeg, FFmpeg tries to use the Microsoft Visual
1005 C++ @code{lib} tool to build @code{avcodec.lib} and
1006 @code{avformat.lib}. With these libraries you can link your Visual C++
1007 code directly with the FFmpeg DLLs (see below).
1008
1009 @end itemize
1010
1011 @subsection Visual C++ compatibility
1012
1013 FFmpeg will not compile under Visual C++ -- and it has too many
1014 dependencies on the GCC compiler to make a port viable. However,
1015 if you want to use the FFmpeg libraries in your own applications,
1016 you can still compile those applications using Visual C++. An
1017 important restriction to this is that you have to use the
1018 dynamically linked versions of the FFmpeg libraries (i.e. the
1019 DLLs), and you have to make sure that Visual-C++-compatible
1020 import libraries are created during the FFmpeg build process.
1021
1022 This description of how to use the FFmpeg libraries with Visual C++ is
1023 based on Visual C++ 2005 Express Edition Beta 2. If you have a different
1024 version, you might have to modify the procedures slightly.
1025
1026 Here are the step-by-step instructions for building the FFmpeg libraries
1027 so they can be used with Visual C++:
1028
1029 @enumerate
1030
1031 @item Install Visual C++ (if you haven't done so already).
1032
1033 @item Install MinGW and MSYS as described above.
1034
1035 @item Add a call to @file{vcvars32.bat} (which sets up the environment
1036 variables for the Visual C++ tools) as the first line of
1037 @file{msys.bat}. The standard location for @file{vcvars32.bat} is
1038 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
1039 and the standard location for @file{msys.bat} is
1040 @file{C:\msys\1.0\msys.bat}. If this corresponds to your setup, add the
1041 following line as the first line of @file{msys.bat}:
1042
1043 @code{call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"}
1044
1045 @item Start the MSYS shell (file @file{msys.bat}) and type @code{link.exe}.
1046 If you get a help message with the command line options of @code{link.exe},
1047 this means your environment variables are set up correctly, the
1048 Microsoft linker is on the path and will be used by FFmpeg to
1049 create Visual-C++-compatible import libraries.
1050
1051 @item Extract the current version of FFmpeg and change to the FFmpeg directory.
1052
1053 @item Type the command
1054 @code{./configure --enable-shared --disable-static --enable-memalign-hack}
1055 to configure and, if that didn't produce any errors,
1056 type @code{make} to build FFmpeg.
1057
1058 @item The subdirectories @file{libavformat}, @file{libavcodec}, and
1059 @file{libavutil} should now contain the files @file{avformat.dll},
1060 @file{avformat.lib}, @file{avcodec.dll}, @file{avcodec.lib},
1061 @file{avutil.dll}, and @file{avutil.lib}, respectively. Copy the three
1062 DLLs to your System32 directory (typically @file{C:\Windows\System32}).
1063
1064 @end enumerate
1065
1066 And here is how to use these libraries with Visual C++:
1067
1068 @enumerate
1069
1070 @item Create a new console application ("File / New / Project") and then
1071 select "Win32 Console Application". On the appropriate page of the
1072 Application Wizard, uncheck the "Precompiled headers" option.
1073
1074 @item Write the source code for your application, or, for testing, just
1075 copy the code from an existing sample application into the source file
1076 that Visual C++ has already created for you. (Note that your source
1077 filehas to have a @code{.cpp} extension; otherwise, Visual C++ won't
1078 compile the FFmpeg headers correctly because in C mode, it doesn't
1079 recognize the @code{inline} keyword.)  For example, you can copy
1080 @file{output_example.c} from the FFmpeg distribution (but you will
1081 have to make minor modifications so the code will compile under
1082 C++, see below).
1083
1084 @item Open the "Project / Properties" dialog box. In the "Configuration"
1085 combo box, select "All Configurations" so that the changes you make will
1086 affect both debug and release builds. In the tree view on the left hand
1087 side, select "C/C++ / General", then edit the "Additional Include
1088 Directories" setting to contain the complete paths to the
1089 @file{libavformat}, @file{libavcodec}, and @file{libavutil}
1090 subdirectories of your FFmpeg directory. Note that the directories have
1091 to be separated using semicolons. Now select "Linker / General" from the
1092 tree view and edit the "Additional Library Directories" setting to
1093 contain the same three directories.
1094
1095 @item Still in the "Project / Properties" dialog box, select "Linker / Input"
1096 from the tree view, then add the files @file{avformat.lib},
1097 @file{avcodec.lib}, and @file{avutil.lib} to the end of the "Additional
1098 Dependencies". Note that the names of the libraries have to be separated
1099 using spaces.
1100
1101 @item Now, select "C/C++ / Code Generation" from the tree view. Select
1102 "Debug" in the "Configuration" combo box. Make sure that "Runtime
1103 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
1104 the "Configuration" combo box and make sure that "Runtime Library" is
1105 set to "Multi-threaded DLL".
1106
1107 @item Click "OK" to close the "Project / Properties" dialog box and build
1108 the application. Hopefully, it should compile and run cleanly. If you
1109 used @file{output_example.c} as your sample application, you will get a
1110 few compiler errors, but they are easy to fix. The first type of error
1111 occurs because Visual C++ doesn't allow an @code{int} to be converted to
1112 an @code{enum} without a cast. To solve the problem, insert the required
1113 casts (this error occurs once for a @code{CodecID} and once for a
1114 @code{CodecType}).  The second type of error occurs because C++ requires
1115 the return value of @code{malloc} to be cast to the exact type of the
1116 pointer it is being assigned to. Visual C++ will complain that, for
1117 example, @code{(void *)} is being assigned to @code{(uint8_t *)} without
1118 an explicit cast. So insert an explicit cast in these places to silence
1119 the compiler. The third type of error occurs because the @code{snprintf}
1120 library function is called @code{_snprintf} under Visual C++.  So just
1121 add an underscore to fix the problem. With these changes,
1122 @file{output_example.c} should compile under Visual C++, and the
1123 resulting executable should produce valid video files.
1124
1125 @end enumerate
1126
1127 @subsection Cross compilation for Windows with Linux
1128
1129 You must use the MinGW cross compilation tools available at
1130 @url{http://www.mingw.org/}.
1131
1132 Then configure FFmpeg with the following options:
1133 @example
1134 ./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
1135 @end example
1136 (you can change the cross-prefix according to the prefix chosen for the
1137 MinGW tools).
1138
1139 Then you can easily test FFmpeg with Wine
1140 (@url{http://www.winehq.com/}).
1141
1142 @subsection Compilation under Cygwin
1143
1144 Cygwin works very much like Unix.
1145
1146 Just install your Cygwin with all the "Base" packages, plus the
1147 following "Devel" ones:
1148 @example
1149 binutils, gcc-core, make, subversion
1150 @end example
1151
1152 Do not install binutils-20060709-1 (they are buggy on shared builds);
1153 use binutils-20050610-1 instead.
1154
1155 Then run
1156
1157 @example
1158 ./configure --enable-static --disable-shared
1159 @end example
1160
1161 to make a static build or
1162
1163 @example
1164 ./configure --enable-shared --disable-static
1165 @end example
1166
1167 to build shared libraries.
1168
1169 If you want to build FFmpeg with additional libraries, download Cygwin
1170 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository
1171 and/or SDL, xvid, faac, faad2 packages from Cygwin Ports,
1172 (@url{http://cygwinports.dotsrc.org/}).
1173
1174 @subsection Crosscompilation for Windows under Cygwin
1175
1176 With Cygwin you can create Windows binaries that don't need the cygwin1.dll.
1177
1178 Just install your Cygwin as explained before, plus these additional
1179 "Devel" packages:
1180 @example
1181 gcc-mingw-core, mingw-runtime, mingw-zlib
1182 @end example
1183
1184 and add some special flags to your configure invocation.
1185
1186 For a static build run
1187 @example
1188 ./configure --enable-mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1189 @end example
1190
1191 and for a build with shared libraries
1192 @example
1193 ./configure --enable-mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1194 @end example
1195
1196 @section Mac OS X
1197
1198 @section BeOS
1199
1200 The configure script should guess the configuration itself.
1201 Networking support is currently not finished.
1202 errno issues fixed by Andrew Bachmann.
1203
1204 Old stuff:
1205
1206 Fran├žois Revol - revol at free dot fr - April 2002
1207
1208 The configure script should guess the configuration itself,
1209 however I still didn't test building on the net_server version of BeOS.
1210
1211 FFserver is broken (needs poll() implementation).
1212
1213 There are still issues with errno codes, which are negative in BeOS, and
1214 that FFmpeg negates when returning. This ends up turning errors into
1215 valid results, then crashes.
1216 (To be fixed)
1217
1218 @chapter Developers Guide
1219
1220 @section API
1221 @itemize @bullet
1222 @item libavcodec is the library containing the codecs (both encoding and
1223 decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
1224
1225 @item libavformat is the library containing the file format handling (mux and
1226 demux code for several formats). Look at @file{ffplay.c} to use it in a
1227 player. See @file{output_example.c} to use it to generate audio or video
1228 streams.
1229
1230 @end itemize
1231
1232 @section Integrating libavcodec or libavformat in your program
1233
1234 You can integrate all the source code of the libraries to link them
1235 statically to avoid any version problem. All you need is to provide a
1236 'config.mak' and a 'config.h' in the parent directory. See the defines
1237 generated by ./configure to understand what is needed.
1238
1239 You can use libavcodec or libavformat in your commercial program, but
1240 @emph{any patch you make must be published}. The best way to proceed is
1241 to send your patches to the FFmpeg mailing list.
1242
1243 @node Coding Rules
1244 @section Coding Rules
1245
1246 FFmpeg is programmed in the ISO C90 language with a few additional
1247 features from ISO C99, namely:
1248 @itemize @bullet
1249 @item
1250 the @samp{inline} keyword;
1251 @item
1252 @samp{//} comments;
1253 @item
1254 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
1255 @item
1256 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
1257 @end itemize
1258
1259 These features are supported by all compilers we care about, so we won't
1260 accept patches to remove their use unless they absolutely don't impair
1261 clarity and performance.
1262
1263 All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
1264 compiles with several other compilers, such as the Compaq ccc compiler
1265 or Sun Studio 9, and we would like to keep it that way unless it would
1266 be exceedingly involved. To ensure compatibility, please don't use any
1267 additional C99 features or GCC extensions. Especially watch out for:
1268 @itemize @bullet
1269 @item
1270 mixing statements and declarations;
1271 @item
1272 @samp{long long} (use @samp{int64_t} instead);
1273 @item
1274 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
1275 @item
1276 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
1277 @end itemize
1278
1279 Indent size is 4.
1280 The presentation is the one specified by 'indent -i4 -kr -nut'.
1281 The TAB character is forbidden outside of Makefiles as is any
1282 form of trailing whitespace. Commits containing either will be
1283 rejected by the Subversion repository.
1284
1285 Main priority in FFmpeg is simplicity and small code size (=less
1286 bugs).
1287
1288 Comments: Use the JavaDoc/Doxygen
1289 format (see examples below) so that code documentation
1290 can be generated automatically. All nontrivial functions should have a comment
1291 above them explaining what the function does, even if it's just one sentence.
1292 All structures and their member variables should be documented, too.
1293 @example
1294 /**
1295  * @@file mpeg.c
1296  * MPEG codec.
1297  * @@author ...
1298  */
1299
1300 /**
1301  * Summary sentence.
1302  * more text ...
1303  * ...
1304  */
1305 typedef struct Foobar@{
1306     int var1; /**< var1 description */
1307     int var2; ///< var2 description
1308     /** var3 description */
1309     int var3;
1310 @} Foobar;
1311
1312 /**
1313  * Summary sentence.
1314  * more text ...
1315  * ...
1316  * @@param my_parameter description of my_parameter
1317  * @@return return value description
1318  */
1319 int myfunc(int my_parameter)
1320 ...
1321 @end example
1322
1323 fprintf and printf are forbidden in libavformat and libavcodec,
1324 please use av_log() instead.
1325
1326 @section Development Policy
1327
1328 @enumerate
1329 @item
1330    You must not commit code which breaks FFmpeg! (Meaning unfinished but
1331    enabled code which breaks compilation or compiles but does not work or
1332    breaks the regression tests)
1333    You can commit unfinished stuff (for testing etc), but it must be disabled
1334    (#ifdef etc) by default so it does not interfere with other developers'
1335    work.
1336 @item
1337    You don't have to over-test things. If it works for you, and you think it
1338    should work for others, then commit. If your code has problems
1339    (portability, triggers compiler bugs, unusual environment etc) they will be
1340    reported and eventually fixed.
1341 @item
1342    Do not commit unrelated changes together, split them into self-contained
1343    pieces.
1344 @item
1345    Do not change behavior of the program (renaming options etc) without
1346    first discussing it on the ffmpeg-devel mailing list. Do not remove
1347    functionality from the code. Just improve!
1348
1349    Note: Redundant code can be removed.
1350 @item
1351    Do not commit changes to the build system (Makefiles, configure script)
1352    which change behavior, defaults etc, without asking first. The same
1353    applies to compiler warning fixes, trivial looking fixes and to code
1354    maintained by other developers. We usually have a reason for doing things
1355    the way we do. Send your changes as patches to the ffmpeg-devel mailing
1356    list, and if the code maintainers say OK, you may commit. This does not
1357    apply to files you wrote and/or maintain.
1358 @item
1359    We refuse source indentation and other cosmetic changes if they are mixed
1360    with functional changes, such commits will be rejected and removed. Every
1361    developer has his own indentation style, you should not change it. Of course
1362    if you (re)write something, you can use your own style, even though we would
1363    prefer if the indentation throughout FFmpeg was consistent (Many projects
1364    force a given indentation style - we don't.). If you really need to make
1365    indentation changes (try to avoid this), separate them strictly from real
1366    changes.
1367
1368    NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
1369    then either do NOT change the indentation of the inner part within (don't
1370    move it to the right)! or do so in a separate commit
1371 @item
1372    Always fill out the commit log message. Describe in a few lines what you
1373    changed and why. You can refer to mailing list postings if you fix a
1374    particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
1375 @item
1376    If you apply a patch by someone else, include the name and email address in
1377    the log message. Since the ffmpeg-cvslog mailing list is publicly
1378    archived you should add some SPAM protection to the email address. Send an
1379    answer to ffmpeg-devel (or wherever you got the patch from) saying that
1380    you applied the patch.
1381 @item
1382     Do NOT commit to code actively maintained by others without permission.
1383     Send a patch to ffmpeg-devel instead. If noone answers within a reasonable
1384     timeframe (12h for build failures and security fixes, 3 days small changes,
1385     1 week for big patches) then commit your patch if you think it's OK.
1386     Also note, the maintainer can simply ask for more time to review!
1387 @item
1388     Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
1389     are sent there and reviewed by all the other developers. Bugs and possible
1390     improvements or general questions regarding commits are discussed there. We
1391     expect you to react if problems with your code are uncovered.
1392 @item
1393     Update the documentation if you change behavior or add features. If you are
1394     unsure how best to do this, send a patch to ffmpeg-devel, the documentation
1395     maintainer(s) will review and commit your stuff.
1396 @item
1397     Never write to unallocated memory, never write over the end of arrays,
1398     always check values read from some untrusted source before using them
1399     as array index or other risky things.
1400 @item
1401     Remember to check if you need to bump versions for the specific libav
1402     parts (libavutil, libavcodec, libavformat) you are changing. You need
1403     to change the version integer and the version string.
1404     Incrementing the first component means no backward compatibility to
1405     previous versions (e.g. removal of a function from the public API).
1406     Incrementing the second component means backward compatible change
1407     (e.g. addition of a function to the public API).
1408     Incrementing the third component means a noteworthy binary compatible
1409     change (e.g. encoder bug fix that matters for the decoder).
1410 @item
1411     If you add a new codec, remember to update the changelog, add it to
1412     the supported codecs table in the documentation and bump the second
1413     component of the @file{libavcodec} version number appropriately. If
1414     it has a fourcc, add it to @file{libavformat/avienc.c}, even if it
1415     is only a decoder.
1416 @end enumerate
1417
1418 We think our rules are not too hard. If you have comments, contact us.
1419
1420 Note, these rules are mostly borrowed from the MPlayer project.
1421
1422 @section Submitting patches
1423
1424 First, (@pxref{Coding Rules}) above if you didn't yet.
1425
1426 When you submit your patch, try to send a unified diff (diff '-up'
1427 option). I cannot read other diffs :-)
1428
1429 Also please do not submit patches which contain several unrelated changes.
1430 Split them into individual self-contained patches; this makes reviewing
1431 them much easier.
1432
1433 Run the regression tests before submitting a patch so that you can
1434 verify that there are no big problems.
1435
1436 Patches should be posted as base64 encoded attachments (or any other
1437 encoding which ensures that the patch won't be trashed during
1438 transmission) to the ffmpeg-devel mailing list, see
1439 @url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
1440
1441 It also helps quite a bit if you tell us what the patch does (for example
1442 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
1443 and has no lrint()')
1444
1445 We reply to all submitted patches and either apply or reject with some
1446 explanation why, but sometimes we are quite busy so it can take a week or two.
1447
1448 @section Regression tests
1449
1450 Before submitting a patch (or committing to the repository), you should at least
1451 test that you did not break anything.
1452
1453 The regression tests build a synthetic video stream and a synthetic
1454 audio stream. These are then encoded and decoded with all codecs or
1455 formats. The CRC (or MD5) of each generated file is recorded in a
1456 result file. A 'diff' is launched to compare the reference results and
1457 the result file.
1458
1459 The regression tests then go on to test the FFserver code with a
1460 limited set of streams. It is important that this step runs correctly
1461 as well.
1462
1463 Run 'make test' to test all the codecs and formats.
1464
1465 Run 'make fulltest' to test all the codecs, formats and FFserver.
1466
1467 [Of course, some patches may change the results of the regression tests. In
1468 this case, the reference results of the regression tests shall be modified
1469 accordingly].
1470
1471 @bye