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