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