Creative ADPCM decoder, format 0x200, courtesy of Konstantin Shishkov
[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 the parameters, when
18 possible. You have usually to give only the target bitrate you want.
19
20 FFmpeg can also convert from any sample rate to any other, and resize
21 video on the fly with a high quality polyphase filter.
22
23 @chapter Quick Start
24
25 @c man begin EXAMPLES
26 @section Video and Audio grabbing
27
28 FFmpeg can use a video4linux compatible video source and any Open Sound
29 System audio source:
30
31 @example
32 ffmpeg /tmp/out.mpg 
33 @end example
34
35 Note that you must activate the right video source and channel before
36 launching ffmpeg. You can use any TV viewer such as xawtv
37 (@url{http://bytesex.org/xawtv/}) by Gerd Knorr which I find very
38 good. You must also set correctly the audio recording levels with a
39 standard mixer.
40
41 @section Video and Audio file format conversion
42
43 * ffmpeg can use any supported file format and protocol as input: 
44
45 Examples:
46
47 * You can input from YUV files:
48
49 @example
50 ffmpeg -i /tmp/test%d.Y /tmp/out.mpg 
51 @end example
52
53 It will use the files: 
54 @example
55 /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
56 /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
57 @end example
58
59 The Y files use twice the resolution of the U and V files. They are
60 raw files, without header. They can be generated by all decent video
61 decoders. You must specify the size of the image with the @option{-s} option
62 if ffmpeg cannot guess it.
63
64 * You can input from a RAW YUV420P file:
65
66 @example
67 ffmpeg -i /tmp/test.yuv /tmp/out.avi
68 @end example
69
70 The RAW YUV420P is a file containing RAW YUV planar, for each frame first
71 come the Y plane followed by U and V planes, which are half vertical and
72 horizontal resolution.
73
74 * You can output to a RAW YUV420P file:
75
76 @example
77 ffmpeg -i mydivx.avi -o hugefile.yuv
78 @end example
79
80 * You can set several input files and output files:
81
82 @example
83 ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
84 @end example
85
86 Convert the audio file a.wav and the raw yuv video file a.yuv
87 to mpeg file a.mpg
88
89 * You can also do audio and video conversions at the same time:
90
91 @example
92 ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
93 @end example
94
95 Convert the sample rate of a.wav to 22050 Hz and encode it to MPEG audio.
96
97 * You can encode to several formats at the same time and define a
98 mapping from input stream to output streams:
99
100 @example
101 ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
102 @end example
103
104 Convert a.wav to a.mp2 at 64 kbits and b.mp2 at 128 kbits. '-map
105 file:index' specify which input stream is used for each output
106 stream, in the order of the definition of output streams.
107
108 * You can transcode decrypted VOBs
109
110 @example
111 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800 -g 300 -bf 2 -acodec mp3 -ab 128 snatch.avi
112 @end example
113
114 This is a typical DVD ripper example, input from a VOB file, output
115 to an AVI file with MPEG-4 video and MP3 audio, note that in this
116 command we use B frames so the MPEG-4 stream is DivX5 compatible, GOP
117 size is 300 that means an INTRA frame every 10 seconds for 29.97 fps
118 input video.  Also the audio stream is MP3 encoded so you need LAME
119 support which is enabled using @code{--enable-mp3lame} when
120 configuring.  The mapping is particularly useful for DVD transcoding
121 to get the desired audio language.
122
123 NOTE: to see the supported input formats, use @code{ffmpeg -formats}.
124 @c man end
125
126 @chapter Invocation
127
128 @section Syntax
129
130 The generic syntax is:
131
132 @example 
133 @c man begin SYNOPSIS
134 ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
135 @c man end
136 @end example
137 @c man begin DESCRIPTION
138 If no input file is given, audio/video grabbing is done.
139
140 As a general rule, options are applied to the next specified
141 file. For example, if you give the @option{-b 64} option, it sets the video
142 bitrate of the next file. Format option may be needed for raw input
143 files.
144
145 By default, ffmpeg tries to convert as losslessly as possible: it
146 uses the same audio and video parameter for the outputs as the one
147 specified for the inputs.
148 @c man end
149
150 @c man begin OPTIONS
151 @section Main options
152
153 @table @option
154 @item -L
155 show license
156
157 @item -h
158 show help
159
160 @item -formats
161 show available formats, codecs, protocols, ...
162
163 @item -f fmt              
164 force format
165
166 @item -i filename         
167 input file name
168
169 @item -y                  
170 overwrite output files
171
172 @item -t duration         
173 set the recording time in seconds. @code{hh:mm:ss[.xxx]} syntax is also
174 supported.
175
176 @item -ss position
177 seek to given time position. @code{hh:mm:ss[.xxx]} syntax is also
178 supported.
179
180 @item -title string       
181 set the title
182
183 @item -author string      
184 set the author
185
186 @item -copyright string   
187 set the copyright
188
189 @item -comment string     
190 set the comment
191
192 @item -target type
193 specify target file type ("vcd", "svcd", "dvd", "pal-vcd", "ntsc-svcd", ... ). All the format
194 options (bitrate, codecs, buffer sizes) are automatically set by this
195 option. You can just type:
196
197 @example
198 ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
199 @end example
200
201 Nevertheless you can specify additional options as long as you know they do not compromise the
202 standard, as in:
203
204 @example
205 ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
206 @end example
207
208 @item -hq
209 activate high quality settings
210
211 @item -itsoffset offset
212 set the input time offset in seconds. @code{[-]hh:mm:ss[.xxx]} syntax
213 is also supported.  This option affects all the input files that
214 follow it.  The offset is added to the input files' timestamps;
215 specifying a positive offset means that the corresponding streams are
216 delayed by 'offset' seconds.
217
218 @end table
219
220 @section Video Options
221
222 @table @option
223 @item -b bitrate
224 set the video bitrate in kbit/s (default = 200 kb/s)
225 @item -r fps           
226 set frame rate (default = 25)
227 @item -s size             
228 set frame size. The format is @samp{WxH} (default 160x128).  The
229 following abbreviations are recognized:
230 @table @samp
231 @item sqcif
232 128x96
233 @item qcif
234 176x144
235 @item cif
236 352x288
237 @item 4cif
238 704x576
239 @end table
240
241 @item -aspect aspect
242 set aspect ratio (4:3, 16:9 or 1.3333, 1.7777)
243 @item -croptop size
244 set top crop band size (in pixels)
245 @item -cropbottom size
246 set bottom crop band size (in pixels)
247 @item -cropleft size
248 set left crop band size (in pixels)
249 @item -cropright size
250 set right crop band size (in pixels)
251 @item -padtop size
252 set top pad band size (in pixels)
253 @item -padbottom size
254 set bottom pad band size (in pixels)
255 @item -padleft size
256 set left pad band size (in pixels)
257 @item -padright size
258 set right pad band size (in pixels)
259 @item -padcolor (hex color)
260 set color of padded bands. The value for pad color is expressed 
261 as a six digit hexidecimal number where the first two digits represent red, 
262 middle two digits green and last two digits blue. Defaults to 000000 (black)
263 @item -vn
264 disable video recording
265 @item -bt tolerance       
266 set video bitrate tolerance (in kbit/s)
267 @item -maxrate bitrate
268 set max video bitrate tolerance (in kbit/s)
269 @item -minrate bitrate
270 set min video bitrate tolerance (in kbit/s)
271 @item -bufsize size
272 set ratecontrol buffere size (in kbit)
273 @item -vcodec codec       
274 force video codec to @var{codec}. Use the @code{copy} special value to
275 tell that the raw codec data must be copied as is.
276 @item -sameq
277 use same video quality as source (implies VBR)
278
279 @item -pass n  
280 select the pass number (1 or 2). It is useful to do two pass
281 encoding. The statistics of the video are recorded in the first pass and
282 the video at the exact requested bit rate is generated in the second
283 pass.
284
285 @item -passlogfile file   
286 select two pass log file name to @var{file}.
287
288 @end table
289
290 @section Advanced Video Options
291
292 @table @option
293 @item -g gop_size         
294 set the group of picture size
295 @item -intra              
296 use only intra frames
297 @item -qscale q           
298 use fixed video quantiser scale (VBR)
299 @item -qmin q             
300 min video quantiser scale (VBR)
301 @item -qmax q             
302 max video quantiser scale (VBR)
303 @item -qdiff q            
304 max difference between the quantiser scale (VBR)
305 @item -qblur blur         
306 video quantiser scale blur (VBR)
307 @item -qcomp compression  
308 video quantiser scale compression (VBR)
309
310 @item -rc_init_cplx complexity
311 initial complexity for 1-pass encoding
312 @item -b_qfactor factor
313 qp factor between p and b frames
314 @item -i_qfactor factor
315 qp factor between p and i frames
316 @item -b_qoffset offset
317 qp offset between p and b frames
318 @item -i_qoffset offset
319 qp offset between p and i frames
320 @item -rc_eq equation
321 set rate control equation (@pxref{FFmpeg formula
322 evaluator}). Default is @code{tex^qComp}.
323 @item -rc_override override
324 rate control override for specific intervals
325 @item -me method
326 set motion estimation method to @var{method}. Available methods are
327 (from lower to best quality):
328 @table @samp
329 @item zero
330 Try just the (0, 0) vector.
331 @item phods
332 @item log
333 @item x1
334 @item epzs
335 (default method)
336 @item full
337 exhaustive search (slow and marginally better than epzs)
338 @end table
339
340 @item -dct_algo algo
341 set dct algorithm to @var{algo}. Available values are:
342 @table @samp
343 @item 0
344 FF_DCT_AUTO (default)
345 @item 1
346 FF_DCT_FASTINT
347 @item 2
348 FF_DCT_INT
349 @item 3
350 FF_DCT_MMX
351 @item 4
352 FF_DCT_MLIB
353 @item 5
354 FF_DCT_ALTIVEC
355 @end table
356
357 @item -idct_algo algo
358 set idct algorithm to @var{algo}. Available values are:
359 @table @samp
360 @item 0
361 FF_IDCT_AUTO (default)
362 @item 1
363 FF_IDCT_INT          
364 @item 2
365 FF_IDCT_SIMPLE       
366 @item 3
367 FF_IDCT_SIMPLEMMX    
368 @item 4
369 FF_IDCT_LIBMPEG2MMX  
370 @item 5
371 FF_IDCT_PS2          
372 @item 6
373 FF_IDCT_MLIB         
374 @item 7
375 FF_IDCT_ARM          
376 @item 8
377 FF_IDCT_ALTIVEC      
378 @item 9
379 FF_IDCT_SH4          
380 @item 10
381 FF_IDCT_SIMPLEARM    
382 @end table
383
384 @item -er n
385 set error resilience to @var{n}.
386 @table @samp
387 @item 1 
388 FF_ER_CAREFULL (default)
389 @item 2
390 FF_ER_COMPLIANT
391 @item 3
392 FF_ER_AGGRESSIVE
393 @item 4
394 FF_ER_VERY_AGGRESSIVE
395 @end table
396
397 @item -ec bit_mask
398 set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
399 the following values:
400 @table @samp
401 @item 1
402 FF_EC_GUESS_MVS (default=enabled)
403 @item 2
404 FF_EC_DEBLOCK (default=enabled)
405 @end table
406
407 @item -bf frames
408 use 'frames' B frames (supported for MPEG-1, MPEG-2 and MPEG-4)
409 @item -mbd mode
410 macroblock decision
411 @table @samp
412 @item 0
413 FF_MB_DECISION_SIMPLE: use mb_cmp (cannot change it yet in ffmpeg)
414 @item 1
415 FF_MB_DECISION_BITS: chooses the one which needs the fewest bits
416 @item 2
417 FF_MB_DECISION_RD: rate distoration
418 @end table
419
420 @item -4mv
421 use four motion vector by macroblock (only MPEG-4)
422 @item -part
423 use data partitioning (only MPEG-4)
424 @item -bug param
425 workaround not auto detected encoder bugs
426 @item -strict strictness
427 how strictly to follow the standarts
428 @item -aic
429 enable Advanced intra coding (h263+)
430 @item -umv
431 enable Unlimited Motion Vector (h263+)
432
433 @item -deinterlace
434 deinterlace pictures
435 @item -interlace
436 force interlacing support in encoder (only MPEG-2 and MPEG-4). Use this option
437 if your input file is interlaced and if you want to keep the interlaced
438 format for minimum losses. The alternative is to deinterlace the input
439 stream with @option{-deinterlace}, but deinterlacing introduces more
440 losses.
441 @item -psnr
442 calculate PSNR of compressed frames
443 @item -vstats
444 dump video coding statistics to @file{vstats_HHMMSS.log}.
445 @item -vhook module
446 insert video processing @var{module}. @var{module} contains the module
447 name and its parameters separated by spaces.
448 @end table
449
450 @section Audio Options
451
452 @table @option
453 @item -ar freq    
454 set the audio sampling freq (default = 44100 Hz)
455 @item -ab bitrate 
456 set the audio bitrate in kbit/s (default = 64)
457 @item -ac channels
458 set the number of audio channels (default = 1)
459 @item -an
460 disable audio recording
461 @item -acodec codec
462 force audio codec to @var{codec}. Use the @code{copy} special value to
463 tell that the raw codec data must be copied as is.
464 @end table
465
466 @section Audio/Video grab options
467
468 @table @option
469 @item -vd device
470 set video grab device (e.g. @file{/dev/video0})
471 @item -vc channel
472 set video grab channel (DV1394 only)
473 @item -tvstd standard
474 set television standard (NTSC, PAL (SECAM))
475 @item -dv1394
476 set DV1394 grab
477 @item -ad device
478 set audio device (e.g. @file{/dev/dsp})
479 @end table
480
481 @section Advanced options
482
483 @table @option
484 @item -map file:stream    
485 set input stream mapping
486 @item -debug
487 print specific debug info
488 @item -benchmark          
489 add timings for benchmarking
490 @item -hex                
491 dump each input packet
492 @item -bitexact
493 only use bit exact algorithms (for codec testing)
494 @item -ps size
495 set packet size in bits
496 @item -re
497 read input at native frame rate. Mainly used to simulate a grab device.
498 @item -loop
499 loop over the input stream. Currently it works only for image
500 streams. This option is used for ffserver automatic testing.
501 @end table
502
503 @node FFmpeg formula evaluator
504 @section FFmpeg formula evaluator
505
506 When evaluating a rate control string, FFmpeg uses an internal formula
507 evaluator. 
508
509 The following binary operators are available: @code{+}, @code{-},
510 @code{*}, @code{/}, @code{^}.
511
512 The following unary operators are available: @code{+}, @code{-},
513 @code{(...)}.
514
515 The following functions are available:
516 @table @var
517 @item sinh(x)
518 @item cosh(x)
519 @item tanh(x)
520 @item sin(x)
521 @item cos(x)
522 @item tan(x)
523 @item exp(x)
524 @item log(x)
525 @item squish(x)
526 @item gauss(x)
527 @item abs(x)
528 @item max(x, y)
529 @item min(x, y)
530 @item gt(x, y)
531 @item lt(x, y)
532 @item eq(x, y)
533 @item bits2qp(bits)
534 @item qp2bits(qp)
535 @end table
536
537 The following constants are available:
538 @table @var
539 @item PI
540 @item E
541 @item iTex
542 @item pTex
543 @item tex
544 @item mv
545 @item fCode
546 @item iCount
547 @item mcVar
548 @item var
549 @item isI
550 @item isP
551 @item isB
552 @item avgQP
553 @item qComp
554 @item avgIITex
555 @item avgPITex
556 @item avgPPTex
557 @item avgBPTex
558 @item avgTex
559 @end table
560
561 @c man end
562
563 @ignore
564
565 @setfilename ffmpeg
566 @settitle FFmpeg video converter
567
568 @c man begin SEEALSO
569 ffserver(1), ffplay(1) and the html documentation of @file{ffmpeg}.
570 @c man end
571
572 @c man begin AUTHOR
573 Fabrice Bellard
574 @c man end
575
576 @end ignore
577
578 @section Protocols
579
580 The filename can be @file{-} to read from the standard input or to write
581 to the standard output.
582
583 ffmpeg handles also many protocols specified with the URL syntax.
584
585 Use 'ffmpeg -formats' to have a list of the supported protocols.
586
587 The protocol @code{http:} is currently used only to communicate with
588 ffserver (see the ffserver documentation). When ffmpeg will be a
589 video player it will also be used for streaming :-)
590
591 @chapter Tips
592
593 @itemize
594 @item For streaming at very low bit rate application, use a low frame rate
595 and a small gop size. This is especially true for real video where
596 the Linux player does not seem to be very fast, so it can miss
597 frames. An example is:
598
599 @example
600 ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
601 @end example
602
603 @item  The parameter 'q' which is displayed while encoding is the current
604 quantizer. The value of 1 indicates that a very good quality could
605 be achieved. The value of 31 indicates the worst quality. If q=31
606 too often, it means that the encoder cannot compress enough to meet
607 your bit rate. You must either increase the bit rate, decrease the
608 frame rate or decrease the frame size.
609
610 @item If your computer is not fast enough, you can speed up the
611 compression at the expense of the compression ratio. You can use
612 '-me zero' to speed up motion estimation, and '-intra' to disable
613 completely motion estimation (you have only I frames, which means it
614 is about as good as JPEG compression).
615
616 @item To have very low bitrates in audio, reduce the sampling frequency
617 (down to 22050 kHz for mpeg audio, 22050 or 11025 for ac3).
618
619 @item To have a constant quality (but a variable bitrate), use the option
620 '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
621 quality).
622
623 @item When converting video files, you can use the '-sameq' option which
624 uses in the encoder the same quality factor than in the decoder. It
625 allows to be almost lossless in encoding.
626
627 @end itemize
628
629 @chapter Supported File Formats and Codecs
630
631 You can use the @code{-formats} option to have an exhaustive list.
632
633 @section File Formats
634
635 FFmpeg supports the following file formats through the @code{libavformat}
636 library:
637
638 @multitable @columnfractions .4 .1 .1
639 @item Supported File Format @tab Encoding @tab Decoding @tab Comments
640 @item MPEG audio @tab X @tab X
641 @item MPEG1 systems @tab X  @tab  X 
642 @tab muxed audio and video
643 @item MPEG2 PS @tab X  @tab  X 
644 @tab also known as @code{VOB} file
645 @item MPEG2 TS @tab    @tab  X 
646 @tab also known as DVB Transport Stream
647 @item ASF@tab X @tab X 
648 @item AVI@tab X @tab X 
649 @item WAV@tab X @tab X 
650 @item Macromedia Flash@tab X @tab X
651 @tab Only embedded audio is decoded
652 @item FLV              @tab  X @tab X
653 @tab Macromedia Flash video files
654 @item Real Audio and Video @tab X @tab X 
655 @item Raw AC3 @tab X  @tab  X 
656 @item Raw MJPEG @tab X  @tab  X 
657 @item Raw MPEG video @tab X  @tab  X 
658 @item Raw PCM8/16 bits, mulaw/Alaw@tab X  @tab  X 
659 @item Raw CRI ADX audio @tab X  @tab  X 
660 @item SUN AU format @tab X  @tab  X 
661 @item NUT @tab X @tab X @tab NUT Open Container Format
662 @item Quicktime        @tab X @tab  X 
663 @item MPEG4            @tab X @tab  X 
664 @tab MPEG4 is a variant of Quicktime
665 @item Raw MPEG4 video  @tab  X @tab  X 
666 @item DV               @tab  X @tab  X
667 @item 4xm              @tab    @tab X
668 @tab 4X Technologies format, used in some games
669 @item Playstation STR  @tab    @tab X
670 @item Id RoQ           @tab    @tab X
671 @tab used in Quake III, Jedi Knight 2, other computer games
672 @item Interplay MVE    @tab    @tab X
673 @tab format used in various Interplay computer games
674 @item WC3 Movie        @tab    @tab X
675 @tab multimedia format used in Origin's Wing Commander III computer game
676 @item Sega FILM/CPK    @tab    @tab X
677 @tab used in many Sega Saturn console games
678 @item Westwood Studios VQA/AUD  @tab    @tab X
679 @tab Multimedia formats used in Westwood Studios games
680 @item Id Cinematic (.cin) @tab    @tab X
681 @tab Used in Quake II
682 @item FLIC format      @tab    @tab X
683 @tab .fli/.flc files
684 @item Sierra VMD       @tab    @tab X
685 @tab used in Sierra CD-ROM games
686 @item Sierra Online    @tab    @tab X
687 @tab .sol files used in Sierra Online games
688 @item Matroska         @tab    @tab X
689 @end multitable
690
691 @code{X} means that the encoding (resp. decoding) is supported.
692
693 @section Image Formats
694
695 FFmpeg can read and write images for each frame of a video sequence. The
696 following image formats are supported:
697
698 @multitable @columnfractions .4 .1 .1
699 @item Supported Image Format @tab Encoding @tab Decoding @tab Comments
700 @item PGM, PPM     @tab X @tab X 
701 @item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support
702 @item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
703 @item JPEG         @tab X @tab X @tab Progressive JPEG is not supported
704 @item .Y.U.V       @tab X @tab X @tab One raw file per component
705 @item Animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated
706 @item PNG          @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet
707 @item SGI          @tab X @tab X @tab SGI RGB image format
708 @end multitable
709
710 @code{X} means that the encoding (resp. decoding) is supported.
711
712 @section Video Codecs
713
714 @multitable @columnfractions .4 .1 .1 .7
715 @item Supported Codec @tab Encoding @tab Decoding @tab Comments
716 @item MPEG1 video            @tab  X  @tab  X
717 @item MPEG2 video            @tab  X  @tab  X 
718 @item MPEG4                  @tab  X  @tab  X @tab Also known as DIVX4/5
719 @item MSMPEG4 V1             @tab  X  @tab  X
720 @item MSMPEG4 V2             @tab  X  @tab  X
721 @item MSMPEG4 V3             @tab  X  @tab  X @tab Also known as DIVX3
722 @item WMV7                   @tab  X  @tab  X
723 @item WMV8                   @tab  X  @tab  X @tab Not completely working
724 @item H263(+)                @tab  X  @tab  X @tab Also known as Real Video 1.0
725 @item MJPEG                  @tab  X  @tab  X 
726 @item Lossless MJPEG         @tab  X  @tab  X
727 @item Apple MJPEG-B          @tab     @tab  X
728 @item Sunplus MJPEG          @tab     @tab  X @tab fourcc: SP5X
729 @item DV                     @tab  X  @tab  X 
730 @item Huff YUV               @tab  X  @tab  X
731 @item FFmpeg Video 1         @tab  X  @tab  X @tab Experimental lossless codec (fourcc: FFV1)
732 @item FFmpeg Snow            @tab  X  @tab  X @tab Experimental wavelet codec (fourcc: SNOW)
733 @item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
734 @item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
735 @item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
736 @item H.264                  @tab     @tab  X
737 @item Sorenson Video 1       @tab  X  @tab  X @tab fourcc: SVQ1
738 @item Sorenson Video 3       @tab     @tab  X @tab fourcc: SVQ3
739 @item On2 VP3                @tab     @tab  X @tab still experimental
740 @item Theora                 @tab     @tab  X @tab still experimental
741 @item Intel Indeo 3          @tab     @tab  X @tab only works on i386 right now
742 @item FLV                    @tab  X  @tab  X @tab Flash H263 variant
743 @item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
744 @item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
745 @item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
746 @item 4X Video               @tab     @tab  X @tab used in certain computer games
747 @item Sony Playstation MDEC  @tab     @tab  X 
748 @item Id RoQ                 @tab     @tab  X @tab used in Quake III, Jedi Knight 2, other computer games
749 @item Xan/WC3                @tab     @tab  X @tab used in Wing Commander III .MVE files
750 @item Interplay Video        @tab     @tab  X @tab used in Interplay .MVE files
751 @item Apple Animation        @tab     @tab  X @tab fourcc: 'rle '
752 @item Apple Graphics         @tab     @tab  X @tab fourcc: 'smc '
753 @item Apple Video            @tab     @tab  X @tab fourcc: rpza
754 @item Apple QuickDraw        @tab     @tab  X @tab fourcc: qdrw
755 @item Cinepak                @tab     @tab  X
756 @item Microsoft RLE          @tab     @tab  X
757 @item Microsoft Video-1      @tab     @tab  X
758 @item Westwood VQA           @tab     @tab  X
759 @item Id Cinematic Video     @tab     @tab  X @tab used in Quake II
760 @item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
761 @item FLIC video             @tab     @tab  X
762 @item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
763 @item VMD Video              @tab     @tab  X @tab used in Sierra VMD files
764 @item MSZH                   @tab     @tab  X @tab Part of LCL
765 @item ZLIB                   @tab  X  @tab  X @tab Part of LCL, encoder experimental
766 @item TechSmith Camtasia     @tab     @tab  X @tab fourcc: TSCC
767 @item IBM Ultimotion         @tab     @tab  X @tab fourcc: ULTI
768 @end multitable
769
770 @code{X} means that the encoding (resp. decoding) is supported.
771
772 Check at @url{http://www.mplayerhq.hu/~michael/codec-features.html} to
773 get a precise comparison of FFmpeg MPEG4 codec compared to the other
774 solutions.
775
776 @section Audio Codecs
777
778 @multitable @columnfractions .4 .1 .1 .1 .7
779 @item Supported Codec @tab Encoding @tab Decoding @tab Comments
780 @item MPEG audio layer 2     @tab  IX  @tab  IX 
781 @item MPEG audio layer 1/3   @tab IX   @tab  IX
782 @tab MP3 encoding is supported through the external library LAME
783 @item AC3                    @tab  IX  @tab  IX
784 @tab liba52 is used internally for decoding
785 @item Vorbis                 @tab  X   @tab  X
786 @tab supported through the external library libvorbis
787 @item WMA V1/V2              @tab      @tab X
788 @item AAC                    @tab X    @tab X
789 @tab supported through the external library libfaac/libfaad
790 @item Microsoft ADPCM        @tab X    @tab X
791 @item MS IMA ADPCM           @tab X    @tab X
792 @item QT IMA ADPCM           @tab      @tab X
793 @item 4X IMA ADPCM           @tab      @tab X
794 @item G.726  ADPCM           @tab X    @tab X
795 @item Duck DK3 IMA ADPCM     @tab      @tab X
796 @tab used in some Sega Saturn console games
797 @item Duck DK4 IMA ADPCM     @tab      @tab X
798 @tab used in some Sega Saturn console games
799 @item Westwood Studios IMA ADPCM @tab      @tab X
800 @tab used in Westwood Studios games like Command and Conquer
801 @item SMJPEG IMA ADPCM       @tab      @tab X
802 @tab used in certain Loki game ports
803 @item CD-ROM XA ADPCM        @tab      @tab X
804 @item CRI ADX ADPCM          @tab X    @tab X
805 @tab used in Sega Dreamcast games
806 @item Electronic Arts ADPCM  @tab      @tab X
807 @tab used in various EA titles
808 @item Creative ADPCM         @tab      @tab X
809 @item RA144                  @tab      @tab X
810 @tab Real 14400 bit/s codec
811 @item RA288                  @tab      @tab X
812 @tab Real 28800 bit/s codec
813 @item RADnet                 @tab X    @tab IX
814 @tab Real lowbitrate AC3 codec, liba52 is used for decoding
815 @item AMR-NB                 @tab X    @tab X
816 @tab supported through an external library
817 @item AMR-WB                 @tab X    @tab X
818 @tab supported through an external library
819 @item DV audio               @tab      @tab X
820 @item Id RoQ DPCM            @tab      @tab X
821 @tab used in Quake III, Jedi Knight 2, other computer games
822 @item Interplay MVE DPCM     @tab      @tab X
823 @tab used in various Interplay computer games
824 @item Xan DPCM               @tab      @tab X
825 @tab used in Origin's Wing Commander IV AVI files
826 @item Sierra Online DPCM     @tab      @tab X
827 @tab used in Sierra Online game audio files
828 @item Apple MACE 3           @tab      @tab X
829 @item Apple MACE 6           @tab      @tab X
830 @item FLAC                   @tab      @tab X
831 @item FFmpeg Sonic           @tab X    @tab X
832 @tab Experimental lossy/lossless codec
833 @end multitable
834
835 @code{X} means that the encoding (resp. decoding) is supported.
836
837 @code{I} means that an integer only version is available too (ensures highest
838 performances on systems without hardware floating point support).
839
840 @chapter Platform Specific information
841
842 @section Linux
843
844 ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
845 preferred compiler now for ffmpeg. All future optimizations will depend on
846 features only found in GCC 3.2.
847
848 @section BSD
849
850 @section Windows
851
852 @subsection Native Windows compilation
853
854 @itemize
855 @item Install the current versions of MSYS and MinGW from
856 @url{http://www.mingw.org/}. You can find detailed installation
857 instructions in the download section and the FAQ.
858
859 @item If you want to test the FFmpeg Simple Media Player, also download 
860 the MinGW development library of SDL 1.2.x
861 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
862 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
863 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
864 directory. Edit the @file{sdl-config} script so that it gives the
865 correct SDL directory when invoked.
866
867 @item Extract the current version of FFmpeg (the latest release version or the current CVS snapshot whichever is recommended).
868  
869 @item Start the MSYS shell (file @file{msys.bat}).
870
871 @item Change to the FFMPEG directory and follow
872  the instructions of how to compile ffmpeg (file
873 @file{INSTALL}). Usually, launching @file{./configure} and @file{make}
874 suffices. If you have problems using SDL, verify that
875 @file{sdl-config} can be launched from the MSYS command line.
876
877 @item You can install FFmpeg in @file{Program Files/FFmpeg} by typing @file{make install}. Don't forget to copy @file{SDL.dll} at the place you launch 
878 @file{ffplay}.
879
880 @end itemize
881
882 Notes: 
883 @itemize
884
885 @item The target @file{make wininstaller} can be used to create a
886 Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
887 must be copied in the ffmpeg directory in order to build the
888 installer.
889
890 @item By using @code{./configure --enable-shared} when configuring ffmpeg, 
891 you can build @file{avcodec.dll} and @file{avformat.dll}. With
892 @code{make install} you install the FFmpeg DLLs and the associated
893 headers in @file{Program Files/FFmpeg}. 
894
895 @item Visual C++ compatibility: if you used @code{./configure --enable-shared} 
896 when configuring FFmpeg, then FFmpeg tries to use the Microsoft Visual
897 C++ @code{lib} tool to build @code{avcodec.lib} and
898 @code{avformat.lib}. With these libraries, you can link your Visual C++
899 code directly with the FFmpeg DLLs.
900
901 @end itemize
902
903 @subsection Cross compilation for Windows with Linux
904
905 You must use the MinGW cross compilation tools available at
906 @url{http://www.mingw.org/}.
907
908 Then configure ffmpeg with the following options:
909 @example
910 ./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
911 @end example
912 (you can change the cross-prefix according to the prefix choosen for the
913 MinGW tools).
914
915 Then you can easily test ffmpeg with wine
916 (@url{http://www.winehq.com/}).
917
918 @section MacOS X
919
920 @section BeOS
921
922 The configure script should guess the configuration itself.
923 Networking support is currently not finished.
924 errno issues fixed by Andrew Bachmann.
925
926 Old stuff:
927
928 François Revol - revol at free dot fr - April 2002
929
930 The configure script should guess the configuration itself, 
931 however I still didn't tested building on net_server version of BeOS.
932
933 ffserver is broken (needs poll() implementation).
934
935 There is still issues with errno codes, which are negative in BeOs, and
936 that ffmpeg negates when returning. This ends up turning errors into 
937 valid results, then crashes.
938 (To be fixed)
939
940 @chapter Developers Guide
941
942 @section API
943 @itemize
944 @item libavcodec is the library containing the codecs (both encoding and
945   decoding). See @file{libavcodec/apiexample.c} to see how to use it.
946
947 @item libavformat is the library containing the file formats handling (mux and
948   demux code for several formats). See @file{ffplay.c} to use it in a
949 player. See @file{output_example.c} to use it to generate audio or video
950 streams.
951
952 @end itemize
953
954 @section Integrating libavcodec or libavformat in your program
955
956 You can integrate all the source code of the libraries to link them
957 statically to avoid any version problem. All you need is to provide a
958 'config.mak' and a 'config.h' in the parent directory. See the defines
959 generated by ./configure to understand what is needed.
960
961 You can use libavcodec or libavformat in your commercial program, but
962 @emph{any patch you make must be published}. The best way to proceed is
963 to send your patches to the ffmpeg mailing list.
964
965 @node Coding Rules
966 @section Coding Rules
967
968 ffmpeg is programmed in the ISO C90 language with a few additional
969 features from ISO C99, namely:
970 @itemize @bullet
971 @item
972 the @samp{inline} keyword;
973 @item
974 @samp{//} comments;
975 @item
976 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
977 @item
978 compound literals (@samp{x = (struct s) { 17, 23 @};})
979 @end itemize
980
981 These features are supported by all compilers we care about, so we won't
982 accept patches to remove their use unless they absolutely don't impair
983 clarity and performance.
984
985 All code must compile with gcc 2.95 and gcc 3.3. Currently, ffmpeg also
986 compiles with several other compilers, such as the Compaq ccc compiler
987 or Sun Studio 9, and we would like to keep it that way unless it would
988 be exceedingly involved. To ensure compatibility, please don't use any
989 additional C99 features or gcc extensions. Watch out especially for:
990 @itemize @bullet
991 @item
992 mixing statements and declarations;
993 @item
994 @samp{long long} (use @samp{int64_t} instead);
995 @item
996 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
997 @item
998 gcc statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
999 @end itemize
1000
1001 Indent size is 4. The TAB character should not be used.
1002 The presentation is the one specified by 'indent -i4 -kr'.
1003
1004 Main priority in ffmpeg is simplicity and small code size (=less
1005 bugs).
1006
1007 Comments: use the JavaDoc/Doxygen 
1008 format (see examples below) so that a documentation
1009 can be generated automatically. All non trivial functions should have a comment
1010 above it explaining what the function does, even if its just one sentance.
1011 All Structures and their member variables should be documented too.
1012 @example
1013 /**
1014  * @file mpeg.c
1015  * mpeg codec.
1016  * @author ...
1017  */
1018
1019 /**
1020  * Summary sentance.
1021  * more text ...
1022  * ...
1023  */
1024 typedef struct Foobar{
1025     int var1; /**< var1 description */
1026     int var2; ///< var2 description
1027     /** var3 description */
1028     int var3;
1029 } Foobar;
1030
1031 /**
1032  * Summary sentance.
1033  * more text ...
1034  * ...
1035  * @param my_parameter description of my_parameter
1036  * @return return value description
1037  */
1038 int myfunc(int my_parameter)
1039 ...
1040 @end example
1041
1042 fprintf and printf are forbidden in libavformat and libavcodec, 
1043 please use av_log() instead.
1044
1045 @section Submitting patches
1046
1047 First, (@pxref{Coding Rules}) above if you didn't yet.
1048
1049 When you submit your patch, try to send a unified diff (diff '-up'
1050 option). I cannot read other diffs :-)
1051
1052 Run the regression tests before submitting a patch so that you can
1053 verify that there are no big problems.
1054
1055 Patches should be posted as base64 encoded attachments (or any other
1056 encoding which ensures that the patch wont be trashed during 
1057 transmission) to the ffmpeg-devel mailinglist, see 
1058 @url{http://lists.sourceforge.net/lists/listinfo/ffmpeg-devel}
1059
1060 It also helps quite a bit if you tell us what the patch does (for example
1061 'replaces lrint by lrintf') , and why (for example '*bsd isnt c99 compliant
1062 and has no lrint()')
1063
1064 We reply to all patches submitted and either apply or reject with some
1065 explanation why, but sometimes we are quite busy so it can take a week or 2
1066
1067 @section Regression tests
1068
1069 Before submitting a patch (or committing with CVS), you should at least
1070 test that you did not break anything.
1071
1072 The regression test build a synthetic video stream and a synthetic
1073 audio stream. Then these are encoded then decoded with all codecs or
1074 formats. The CRC (or MD5) of each generated file is recorded in a
1075 result file. Then a 'diff' is launched with the reference results and
1076 the result file.
1077
1078 The regression test then goes on to test the ffserver code with a 
1079 limited set of streams. It is important that this step runs correctly
1080 as well.
1081
1082 Run 'make test' to test all the codecs and formats.
1083
1084 Run 'make fulltest' to test all the codecs, formats and ffserver.
1085
1086 [Of course, some patches may change the regression tests results. In
1087 this case, the regression tests reference results shall be modified
1088 accordingly].
1089
1090 @bye