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