Use more descriptive format names, similar to the format long_names.
[ffmpeg.git] / doc / general.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle General Documentation
4 @titlepage
5 @sp 7
6 @center @titlefont{General Documentation}
7 @sp 3
8 @end titlepage
9
10
11 @chapter external libraries
12
13 FFmpeg can be hooked up with a number of external libraries to add support
14 for more formats. None of them are used by default, their use has to be
15 explicitly requested by passing the appropriate flags to @file{./configure}.
16
17 @section AMR
18
19 AMR comes in two different flavors, wideband and narrowband. FFmpeg can make
20 use of the AMR wideband (floating-point mode) and the AMR narrowband
21 (floating-point mode) reference decoders and encoders.
22
23 Go to @url{http://www.penguin.cz/~utx/amr} and follow the instructions for
24 installing the libraries. Then pass @code{--enable-libamr-nb} and/or
25 @code{--enable-libamr-wb} to configure to enable the libraries.
26
27 Note that libamr is copyrighted without any sort of license grant. This means
28 that you can use it if you legally obtained it but you are not allowed to
29 redistribute it in any way. @strong{Any FFmpeg binaries with libamr support
30 you create are non-free and unredistributable!}
31
32
33 @chapter Supported File Formats and Codecs
34
35 You can use the @code{-formats} option to have an exhaustive list.
36
37 @section File Formats
38
39 FFmpeg supports the following file formats through the @code{libavformat}
40 library:
41
42 @multitable @columnfractions .4 .1 .1 .4
43 @item Name @tab Encoding @tab Decoding @tab Comments
44 @item 4xm                       @tab   @tab X
45     @tab 4X Technologies format, used in some games.
46 @item ADTS AAC audio            @tab X @tab X
47 @item American Laser Games MM   @tab   @tab X
48     @tab Multimedia format used in games like Mad Dog McCree.
49 @item ASF                       @tab X @tab X
50 @item AVI                       @tab X @tab X
51 @item AVS                       @tab   @tab X
52     @tab Multimedia format used by the Creature Shock game.
53 @item Beam Software SIFF        @tab   @tab X
54     @tab Audio and video format used in some games by Beam Software.
55 @item Bethesda Softworks VID    @tab   @tab X
56     @tab Used in some games from Bethesda Softworks.
57 @item Brute Force & Ignorance   @tab   @tab X
58     @tab Used in the game Flash Traffic: City of Angels.
59 @item Interplay C93             @tab   @tab X
60     @tab Used in the game Cyberia from Interplay.
61 @item Delphine Software International CIN @tab   @tab X
62     @tab Multimedia format used by Delphine Software games.
63 @item Creative Voice            @tab X @tab X
64     @tab Created for the Sound Blaster Pro.
65 @item CRYO APC                  @tab   @tab X
66     @tab Audio format used in some games by CRYO Interactive Entertainment.
67 @item DV video                  @tab X @tab X
68 @item DXA                       @tab   @tab X
69     @tab This format is used in the non-Windows version of the Feeble Files
70          game and different game cutscenes repacked for use with ScummVM.
71 @item Electronic Arts Multimedia  @tab    @tab X
72     @tab Used in various EA games; files have extensions like WVE and UV2.
73 @item Flash 9 (AVM2)            @tab X @tab X
74     @tab Only embedded audio is decoded.
75 @item FLI/FLC/FLX animation     @tab   @tab X
76     @tab .fli/.flc files
77 @item FLV                       @tab X @tab X
78     @tab Macromedia Flash video files
79 @item FunCom ISS                @tab   @tab X
80     @tab Audio format used in various games from FunCom like The Longest Journey.
81 @item GXF                       @tab X @tab X
82     @tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley
83          playout servers.
84 @item id Cinematic              @tab   @tab X
85     @tab Used in Quake II.
86 @item id RoQ                    @tab X @tab X
87     @tab Used in Quake III, Jedi Knight 2, other computer games.
88 @item IFF                       @tab   @tab X
89     @tab Interchange File Format
90 @item Interplay MVE             @tab   @tab X
91     @tab Format used in various Interplay computer games.
92 @item LMLM4                     @tab   @tab X
93     @tab Used by Linux Media Labs MPEG-4 PCI boards
94 @item Matroska                  @tab X @tab X
95 @item MAXIS XA                  @tab   @tab X
96     @tab Used in Sim City 3000; file extension .xa.
97 @item Monkey's Audio            @tab   @tab X
98 @item Motion Pixels MVI         @tab   @tab X
99 @item MOV/QuickTime/MP4         @tab X @tab X
100     @tab 3GP, 3GP2, PSP, iPod variants supported
101 @item MPEG audio                @tab X @tab X
102 @item MPEG-1 System             @tab X @tab X
103     @tab muxed audio and video, VCD format supported
104 @item MPEG-PS (program stream)  @tab X @tab X
105     @tab also known as @code{VOB} file, SVCD and DVD format supported
106 @item MPEG-TS (transport stream) @tab X @tab X
107     @tab also known as DVB Transport Stream
108 @item MPEG-4                    @tab X @tab X
109     @tab MPEG-4 is a variant of QuickTime.
110 @item MSN TCP webcam            @tab   @tab X
111     @tab Used by MSN Messenger webcam streams.
112 @item Material eXchange Format (MXF) @tab X @tab X
113     @tab SMPTE 377M, used by D-Cinema, broadcast industry.
114 @item NC camera feed            @tab   @tab X
115     @tab NC (AVIP NC4600) camera streams
116 @item Nullsoft Streaming Video  @tab   @tab X
117 @item NUT                       @tab X @tab X
118     @tab NUT Open Container Format
119 @item TechnoTrend PVA           @tab   @tab X
120     @tab Used by TechnoTrend DVB PCI boards.
121 @item raw AC-3                  @tab X @tab X
122 @item raw CRI ADX audio         @tab X @tab X
123 @item raw MJPEG                 @tab X @tab X
124 @item raw MPEG video            @tab X @tab X
125 @item raw MPEG-4 video          @tab X @tab X
126 @item raw PCM 8/16/32 bits, 32/64-bit floating point, mu-law/A-law @tab X  @tab  X
127 @item raw Shorten audio         @tab    @tab  X
128 @item REDCODE R3D               @tab   @tab X
129     @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
130 @item RealMedia                 @tab X @tab X
131 @item Renderware TeXture Dictionary @tab   @tab X
132 @item RL2                       @tab   @tab X
133     @tab Audio and video format used in some games by Entertainment Software Partners.
134 @item Sega FILM/CPK             @tab   @tab X
135     @tab Used in many Sega Saturn console games.
136 @item Sierra SOL                @tab   @tab X
137     @tab .sol files used in Sierra Online games.
138 @item Sierra VMD                @tab   @tab X
139     @tab Used in Sierra CD-ROM games.
140 @item Smacker                   @tab   @tab X
141     @tab Multimedia format used by many games.
142 @item Sony OpenMG (OMA)         @tab   @tab X
143     @tab Audio format used in Sony Sonic Stage and Sony Vegas.
144 @item Sony PlayStation STR      @tab   @tab X
145 @item SUN AU format             @tab X @tab X
146 @item THP                       @tab   @tab X
147     @tab Used on the Nintendo GameCube.
148 @item Tiertex Limited SEQ       @tab   @tab X
149     @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
150 @item WAV                       @tab X @tab X
151 @item Wing Commander III movie  @tab   @tab X
152     @tab Multimedia format used in Origin's Wing Commander III computer game.
153 @item Westwood Studios audio    @tab   @tab X
154     @tab Multimedia format used in Westwood Studios games.
155 @item Westwood Studios VQA      @tab   @tab X
156     @tab Multimedia format used in Westwood Studios games.
157 @end multitable
158
159 @code{X} means that encoding (resp. decoding) is supported.
160
161 @section Image Formats
162
163 FFmpeg can read and write images for each frame of a video sequence. The
164 following image formats are supported:
165
166 @multitable @columnfractions .4 .1 .1 .4
167 @item Name @tab Encoding @tab Decoding @tab Comments
168 @item .Y.U.V       @tab X @tab X @tab one raw file per component
169 @item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
170 @item JPEG         @tab X @tab X @tab Progressive JPEG is not supported.
171 @item JPEG 2000    @tab   @tab E @tab decoding supported through external library libopenjpeg
172 @item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support.
173 @item PCX          @tab   @tab X @tab PC Paintbrush
174 @item PGM, PPM     @tab X @tab X
175 @item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
176 @item PNG          @tab X @tab X @tab 2/4 bpp not supported yet
177 @item PTX          @tab   @tab X @tab V.Flash PTX format
178 @item RAS          @tab   @tab X @tab Sun Rasterfile
179 @item SGI          @tab X @tab X @tab SGI RGB image format
180 @item Targa        @tab   @tab X @tab Targa (.TGA) image format
181 @item TIFF         @tab X @tab X @tab YUV, JPEG and some extension is not supported yet.
182 @end multitable
183
184 @code{X} means that encoding (resp. decoding) is supported.
185
186 @code{E} means that support is provided through an external library.
187
188 @section Video Codecs
189
190 @multitable @columnfractions .4 .1 .1 .4
191 @item Name @tab Encoding @tab Decoding @tab Comments
192 @item 4X Video               @tab     @tab  X
193     @tab Used in certain computer games.
194 @item American Laser Games MM  @tab    @tab X
195     @tab Used in games like Mad Dog McCree.
196 @item AMV                    @tab     @tab  X
197     @tab Used in Chinese MP3 players.
198 @item Apple Animation        @tab  X  @tab  X
199     @tab fourcc: 'rle '
200 @item Apple Graphics         @tab     @tab  X
201     @tab fourcc: 'smc '
202 @item Apple MJPEG-B          @tab     @tab  X
203 @item Apple QuickDraw        @tab     @tab  X
204     @tab fourcc: qdrw
205 @item Apple Video            @tab     @tab  X
206     @tab fourcc: rpza
207 @item Asus v1                @tab  X  @tab  X
208     @tab fourcc: ASV1
209 @item Asus v2                @tab  X  @tab  X
210     @tab fourcc: ASV2
211 @item ATI VCR1               @tab     @tab  X
212     @tab fourcc: VCR1
213 @item ATI VCR2               @tab     @tab  X
214     @tab fourcc: VCR2
215 @item Autodesk RLE           @tab     @tab  X
216     @tab fourcc: AASC
217 @item AVID DNxHD             @tab   X @tab  X
218     @tab aka SMPTE VC3
219 @item AVS video              @tab     @tab  X
220     @tab Video encoding used by the Creature Shock game.
221 @item Bethsoft VID           @tab     @tab  X
222     @tab Used in some games from Bethesda Softworks.
223 @item C93 video              @tab     @tab  X
224     @tab Codec used in Cyberia game.
225 @item CamStudio              @tab     @tab  X
226     @tab fourcc: CSCD
227 @item Cin video              @tab     @tab  X
228     @tab Codec used in Delphine Software games.
229 @item Cinepak                @tab     @tab  X
230 @item Cirrus Logic AccuPak   @tab     @tab  X
231     @tab fourcc: CLJR
232 @item Creative YUV           @tab     @tab  X
233     @tab fourcc: CYUV
234 @item Dirac                  @tab  E  @tab  E
235     @tab supported through external libdirac/libschroedinger libraries
236 @item Duck TrueMotion v1     @tab     @tab  X
237     @tab fourcc: DUCK
238 @item Duck TrueMotion v2     @tab     @tab  X
239     @tab fourcc: TM20
240 @item DV                     @tab  X  @tab  X
241 @item DXA Video              @tab     @tab  X
242     @tab Codec originally used in Feeble Files game.
243 @item Electronic Arts CMV    @tab     @tab  X
244     @tab Used in NHL 95 game.
245 @item Electronic Arts TGV    @tab     @tab  X
246 @item Electronic Arts TGQ    @tab     @tab  X
247 @item Electronic Arts TQI    @tab     @tab  X
248 @item FFmpeg Video 1         @tab  X  @tab  X
249     @tab experimental lossless codec (fourcc: FFV1)
250 @item Flash Screen Video     @tab  X  @tab  X
251     @tab fourcc: FSV1
252 @item FLIC video             @tab     @tab  X
253 @item FLV                    @tab  X  @tab  X
254     @tab Sorenson H.263 used in Flash
255 @item Fraps FPS1             @tab     @tab  X
256 @item H.261                  @tab  X  @tab  X
257 @item H.263(+)               @tab  X  @tab  X
258     @tab also known as RealVideo 1.0
259 @item H.264                  @tab  E  @tab  X
260     @tab encoding supported through external library libx264
261 @item HuffYUV                @tab  X  @tab  X
262 @item IBM Ultimotion         @tab     @tab  X
263     @tab fourcc: ULTI
264 @item id Cinematic video     @tab     @tab  X
265     @tab Used in Quake II.
266 @item id RoQ                 @tab  X  @tab  X
267     @tab Used in Quake III, Jedi Knight 2, other computer games.
268 @item Intel Indeo 3          @tab     @tab  X
269 @item Interplay Video        @tab     @tab  X
270     @tab Used in Interplay .MVE files.
271 @item JPEG-LS                @tab  X  @tab  X
272     @tab fourcc: MJLS, lossless and near-lossless is supported.
273 @item KMVC                   @tab     @tab  X
274     @tab Codec used in Worms games.
275 @item LOCO                   @tab     @tab  X
276 @item lossless MJPEG         @tab  X  @tab  X
277 @item Microsoft RLE          @tab     @tab  X
278 @item Microsoft Video-1      @tab     @tab  X
279 @item Mimic                  @tab     @tab  X
280     @tab Used in MSN Messenger Webcam streams.
281 @item Miro VideoXL           @tab     @tab  X
282     @tab fourcc: VIXL
283 @item MJPEG                  @tab  X  @tab  X
284 @item Motion Pixels Video    @tab     @tab  X
285 @item MPEG-1                 @tab  X  @tab  X
286 @item MPEG-2                 @tab  X  @tab  X
287 @item MPEG-4                 @tab  X  @tab  X
288 @item MSMPEG4 V1             @tab  X  @tab  X
289 @item MSMPEG4 V2             @tab  X  @tab  X
290 @item MSMPEG4 V3             @tab  X  @tab  X
291 @item MSZH                   @tab     @tab  X
292     @tab Part of LCL
293 @item On2 VP3                @tab     @tab  X
294     @tab still experimental
295 @item On2 VP5                @tab     @tab  X
296     @tab fourcc: VP50
297 @item On2 VP6                @tab     @tab  X
298     @tab fourcc: VP60,VP61,VP62
299 @item planar RGB             @tab     @tab  X
300     @tab fourcc: 8BPS
301 @item QPEG                   @tab     @tab  X
302     @tab fourccs: QPEG, Q1.0, Q1.1
303 @item RealVideo 1.0          @tab  X  @tab  X
304 @item RealVideo 2.0          @tab  X  @tab  X
305 @item RealVideo 3.0          @tab     @tab  X
306     @tab still far from ideal
307 @item RealVideo 4.0          @tab     @tab  X
308 @item Renderware TXD         @tab     @tab  X
309     @tab Texture dictionaries used by the Renderware Engine.
310 @item RTjpeg                 @tab     @tab  X
311     @tab Video encoding used in NuppelVideo files.
312 @item Smacker video          @tab     @tab  X
313     @tab Video encoding used in Smacker.
314 @item Snow                   @tab  X  @tab  X
315     @tab experimental wavelet codec (fourcc: SNOW)
316 @item Sony PlayStation MDEC  @tab     @tab  X
317 @item Sorenson Video 1       @tab  X  @tab  X
318     @tab fourcc: SVQ1
319 @item Sorenson Video 3       @tab     @tab  X
320     @tab fourcc: SVQ3
321 @item Sunplus MJPEG          @tab     @tab  X
322     @tab fourcc: SP5X
323 @item TechSmith Camtasia     @tab     @tab  X
324     @tab fourcc: TSCC
325 @item Theora                 @tab  E  @tab  X
326     @tab encoding supported through external library libtheora
327 @item THP                    @tab     @tab  X
328     @tab Used on the Nintendo GameCube.
329 @item Tiertex Seq video      @tab     @tab  X
330     @tab Codec used in DOS CD-ROM FlashBack game.
331 @item VC-1                   @tab     @tab  X
332 @item VMD Video              @tab     @tab  X
333     @tab Used in Sierra VMD files.
334 @item VMware Video           @tab     @tab  X
335     @tab Codec used in videos captured by VMware.
336 @item Westwood VQA           @tab     @tab  X
337 @item Winnov WNV1            @tab     @tab  X
338 @item WMV7                   @tab  X  @tab  X
339 @item WMV8                   @tab  X  @tab  X
340 @item WMV9                   @tab     @tab  X
341     @tab not completely working
342 @item Xan/WC3                @tab     @tab  X
343     @tab Used in Wing Commander III .MVE files.
344 @item ZLIB                   @tab  X  @tab  X
345     @tab part of LCL, encoder experimental
346 @item ZMBV                   @tab   X @tab  X
347     @tab Encoder works only in PAL8.
348 @end multitable
349
350 @code{X} means that encoding (resp. decoding) is supported.
351
352 @code{E} means that support is provided through an external library.
353
354 @section Audio Codecs
355
356 @multitable @columnfractions .4 .1 .1 .4
357 @item Name @tab Encoding @tab Decoding @tab Comments
358 @item 4X IMA ADPCM           @tab     @tab  X
359 @item 8SVX audio             @tab     @tab  X
360 @item AAC                    @tab  E  @tab  X
361     @tab encoding supported through external library libfaac
362 @item AC-3                   @tab IX  @tab IX
363 @item AMR-NB                 @tab  E  @tab  E
364     @tab supported through external library libamrnb
365 @item AMR-WB                 @tab  E  @tab  E
366     @tab supported through external library libamrwb
367 @item AMV IMA ADPCM          @tab     @tab  X
368     @tab Used in AMV files
369 @item Apple lossless audio   @tab  X  @tab  X
370     @tab QuickTime fourcc 'alac'
371 @item Apple MACE 3           @tab     @tab  X
372 @item Apple MACE 6           @tab     @tab  X
373 @item ATRAC 3                @tab     @tab  X
374 @item CD-ROM XA ADPCM        @tab     @tab  X
375 @item Cin audio              @tab     @tab  X
376     @tab Codec used in Delphine Software International games.
377 @item Creative ADPCM         @tab     @tab  X
378     @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
379 @item CRI ADX ADPCM          @tab  X  @tab  X
380     @tab Used in Sega Dreamcast games.
381 @item DSP Group TrueSpeech   @tab     @tab  X
382 @item DTS Coherent Audio     @tab     @tab  X
383 @item Duck DK3 IMA ADPCM     @tab     @tab  X
384     @tab Used in some Sega Saturn console games.
385 @item Duck DK4 IMA ADPCM     @tab     @tab  X
386     @tab Used in some Sega Saturn console games.
387 @item DV audio               @tab     @tab  X
388 @item Electronic Arts ADPCM  @tab     @tab  X
389     @tab Used in various EA titles.
390 @item Enhanced AC-3          @tab     @tab  X
391 @item FLAC lossless audio    @tab IX  @tab  X
392 @item G.726  ADPCM           @tab  X  @tab  X
393 @item GSM                    @tab  E  @tab  E
394     @tab supported through external library libgsm
395 @item GSM_MS                 @tab  E  @tab  E
396     @tab supported through external library libgsm
397 @item id RoQ DPCM            @tab  X  @tab  X
398     @tab Used in Quake III, Jedi Knight 2, other computer games.
399 @item Intel Music Coder      @tab     @tab  X
400 @item Interplay MVE DPCM     @tab     @tab  X
401     @tab Used in various Interplay computer games.
402 @item ISS IMA ADPCM          @tab     @tab  X
403     @tab Used in FunCom games.
404 @item MAXIS EA ADPCM         @tab     @tab  X
405     @tab Used in Sim City 3000.
406 @item Microsoft ADPCM        @tab  X  @tab  X
407 @item MLP/TrueHD             @tab     @tab  X
408     @tab Used in DVD-Audio and Blu-Ray discs.
409 @item Monkey's Audio         @tab     @tab  X
410     @tab Only versions 3.97-3.99 are supported.
411 @item MPEG audio layer 3     @tab  E  @tab IX
412     @tab encoding supported through external library LAME
413 @item MPEG audio layer 2     @tab IX  @tab IX
414 @item MS IMA ADPCM           @tab  X  @tab  X
415 @item Musepack               @tab     @tab  X
416     @tab SV7 and SV8 are supported.
417 @item Nellymoser ASAO        @tab  X  @tab  X
418 @item QCELP / PureVoice      @tab     @tab  X
419 @item Qdesign QDM2           @tab     @tab  X
420     @tab There are still some distortions.
421 @item QT IMA ADPCM           @tab  X  @tab  X
422 @item RA144                  @tab     @tab  X
423     @tab Real 14400 bit/s codec
424 @item RA288                  @tab     @tab  X
425     @tab Real 28800 bit/s codec
426 @item RADnet                 @tab IX  @tab IX
427     @tab Real low bitrate AC-3 codec
428 @item Real COOK              @tab     @tab  X
429     @tab All versions except 5.1 are supported.
430 @item Shorten                @tab     @tab  X
431 @item Sierra Online DPCM     @tab     @tab  X
432     @tab Used in Sierra Online game audio files.
433 @item Smacker audio          @tab     @tab  X
434 @item SMJPEG IMA ADPCM       @tab     @tab  X
435     @tab Used in certain Loki game ports.
436 @item Sonic                  @tab  X  @tab  X
437     @tab experimental codec
438 @item Sonic lossless         @tab  X  @tab  X
439     @tab experimental codec
440 @item Speex                  @tab     @tab  E
441     @tab supported through external library libspeex
442 @item THP ADPCM              @tab     @tab  X
443     @tab Used on the Nintendo GameCube.
444 @item True Audio (TTA)       @tab     @tab  X
445 @item Vorbis                 @tab  X  @tab  X
446 @item WavPack                @tab     @tab  X
447 @item Westwood Studios IMA ADPCM @tab     @tab  X
448     @tab Used in Westwood Studios games like Command and Conquer.
449 @item WMA v1/v2              @tab  X  @tab  X
450 @item Xan DPCM               @tab     @tab  X
451     @tab Used in Origin's Wing Commander IV AVI files.
452 @end multitable
453
454 @code{X} means that encoding (resp. decoding) is supported.
455
456 @code{E} means that support is provided through an external library.
457
458 @code{I} means that an integer-only version is available, too (ensures high
459 performance on systems without hardware floating point support).
460
461 @section Subtitle Formats
462
463 @multitable @columnfractions .4 .1 .1 .1 .1 .1
464 @item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
465 @item SSA/ASS      @tab X @tab X
466 @item DVB          @tab X @tab X @tab X @tab X
467 @item DVD          @tab X @tab X @tab X @tab X
468 @item XSUB         @tab   @tab   @tab   @tab X
469 @end multitable
470
471 @code{X} means that the feature is supported.
472
473 @chapter Platform Specific information
474
475 @section BSD
476
477 BSD make will not build FFmpeg, you need to install and use GNU Make
478 (@file{gmake}).
479
480 @section Windows
481
482 To get help and instructions for building FFmpeg under Windows, check out
483 the FFmpeg Windows Help Forum at
484 @url{http://ffmpeg.arrozcru.org/}.
485
486 @subsection Native Windows compilation
487
488 FFmpeg can be built to run natively on Windows using the MinGW tools. Install
489 the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
490 You can find detailed installation
491 instructions in the download section and the FAQ.
492
493 FFmpeg does not build out-of-the-box with the packages the automated MinGW
494 installer provides. It also requires coreutils to be installed and many other
495 packages updated to the latest version. The minimum version for some packages
496 are listed below:
497
498 @itemize
499 @item bash 3.1
500 @item msys-make 3.81-2 (note: not mingw32-make)
501 @item w32api 3.13
502 @item mingw-runtime 3.15
503 @end itemize
504
505 You will also need to pass @code{-fno-common} to the compiler to work around
506 a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
507
508 Within the MSYS shell, configure and make with:
509
510 @example
511 ./configure --enable-memalign-hack --extra-cflags=-fno-common
512 make
513 make install
514 @end example
515
516 This will install @file{ffmpeg.exe} along with many other development files
517 to @file{/usr/local}. You may specify another install path using the
518 @code{--prefix} option in @file{configure}.
519
520 Notes:
521
522 @itemize
523
524 @item In order to compile vhooks, you must have a POSIX-compliant libdl in
525 your MinGW system. Get dlfcn-win32 from
526 @url{http://code.google.com/p/dlfcn-win32}.
527
528 @item In order to compile FFplay, you must have the MinGW development library
529 of SDL. Get it from @url{http://www.libsdl.org}.
530 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
531 where SDL was installed. Verify that @file{sdl-config} can be launched from
532 the MSYS command line.
533
534 @item By using @code{./configure --enable-shared} when configuring FFmpeg,
535 you can build libavutil, libavcodec and libavformat as DLLs.
536
537 @end itemize
538
539 @subsection Microsoft Visual C++ compatibility
540
541 As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
542 want to use the libav* libraries in your own applications, you can still
543 compile those applications using MSVC++. But the libav* libraries you link
544 to @emph{must} be built with MinGW. However, you will not be able to debug
545 inside the libav* libraries, since MSVC++ does not recognize the debug
546 symbols generated by GCC.
547 We strongly recommend you to move over from MSVC++ to MinGW tools.
548
549 This description of how to use the FFmpeg libraries with MSVC++ is based on
550 Microsoft Visual C++ 2005 Express Edition. If you have a different version,
551 you might have to modify the procedures slightly.
552
553 @subsubsection Using static libraries
554
555 Assuming you have just built and installed FFmpeg in @file{/usr/local}.
556
557 @enumerate
558
559 @item Create a new console application ("File / New / Project") and then
560 select "Win32 Console Application". On the appropriate page of the
561 Application Wizard, uncheck the "Precompiled headers" option.
562
563 @item Write the source code for your application, or, for testing, just
564 copy the code from an existing sample application into the source file
565 that MSVC++ has already created for you. For example, you can copy
566 @file{output_example.c} from the FFmpeg distribution.
567
568 @item Open the "Project / Properties" dialog box. In the "Configuration"
569 combo box, select "All Configurations" so that the changes you make will
570 affect both debug and release builds. In the tree view on the left hand
571 side, select "C/C++ / General", then edit the "Additional Include
572 Directories" setting to contain the path where the FFmpeg includes were
573 installed (i.e. @file{c:\msys\1.0\local\include}).
574 Do not add MinGW's include directory here, or the include files will
575 conflict with MSVC's.
576
577 @item Still in the "Project / Properties" dialog box, select
578 "Linker / General" from the tree view and edit the
579 "Additional Library Directories" setting to contain the @file{lib}
580 directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
581 the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
582 and the directory where MinGW's GCC libs are installed
583 (i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
584 "Linker / Input" from the tree view, and add the files @file{libavformat.a},
585 @file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
586 @file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
587 to the end of "Additional Dependencies".
588
589 @item Now, select "C/C++ / Code Generation" from the tree view. Select
590 "Debug" in the "Configuration" combo box. Make sure that "Runtime
591 Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
592 the "Configuration" combo box and make sure that "Runtime Library" is
593 set to "Multi-threaded DLL".
594
595 @item Click "OK" to close the "Project / Properties" dialog box.
596
597 @item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
598 Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
599 and install it in MSVC++'s include directory
600 (i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
601
602 @item MSVC++ also does not understand the @code{inline} keyword used by
603 FFmpeg, so you must add this line before @code{#include}ing libav*:
604 @example
605 #define inline _inline
606 @end example
607
608 @item Build your application, everything should work.
609
610 @end enumerate
611
612 @subsubsection Using shared libraries
613
614 This is how to create DLL and LIB files that are compatible with MSVC++:
615
616 @enumerate
617
618 @item Add a call to @file{vcvars32.bat} (which sets up the environment
619 variables for the Visual C++ tools) as the first line of @file{msys.bat}.
620 The standard location for @file{vcvars32.bat} is
621 @file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
622 and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
623 If this corresponds to your setup, add the following line as the first line
624 of @file{msys.bat}:
625
626 @example
627 call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
628 @end example
629
630 Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
631 and run @file{c:\msys\1.0\msys.bat} from there.
632
633 @item Within the MSYS shell, run @code{lib.exe}. If you get a help message
634 from @file{Microsoft (R) Library Manager}, this means your environment
635 variables are set up correctly, the @file{Microsoft (R) Library Manager}
636 is on the path and will be used by FFmpeg to create
637 MSVC++-compatible import libraries.
638
639 @item Build FFmpeg with
640
641 @example
642 ./configure --enable-shared --enable-memalign-hack
643 make
644 make install
645 @end example
646
647 Your install path (@file{/usr/local/} by default) should now have the
648 necessary DLL and LIB files under the @file{bin} directory.
649
650 @end enumerate
651
652 To use those files with MSVC++, do the same as you would do with
653 the static libraries, as described above. But in Step 4,
654 you should only need to add the directory where the LIB files are installed
655 (i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
656 installed in the @file{bin} directory. And instead of adding @file{libxx.a}
657 files, you should add @file{avcodec.lib}, @file{avformat.lib}, and
658 @file{avutil.lib}. There should be no need for @file{libmingwex.a},
659 @file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
660 statically linked into the DLLs. The @file{bin} directory contains a bunch
661 of DLL files, but the ones that are actually used to run your application
662 are the ones with a major version number in their filenames
663 (i.e. @file{avcodec-51.dll}).
664
665 @subsection Cross compilation for Windows with Linux
666
667 You must use the MinGW cross compilation tools available at
668 @url{http://www.mingw.org/}.
669
670 Then configure FFmpeg with the following options:
671 @example
672 ./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
673 @end example
674 (you can change the cross-prefix according to the prefix chosen for the
675 MinGW tools).
676
677 Then you can easily test FFmpeg with Wine
678 (@url{http://www.winehq.com/}).
679
680 @subsection Compilation under Cygwin
681
682 The main issue with the 1.5.x Cygwin versions is that newlib, its C library,
683 does not contain llrint().  You need to upgrade to the unstable 1.7.x versions,
684 or leverage the implementation in MinGW (as explained below).
685
686 Just install your Cygwin with all the "Base" packages, plus the
687 following "Devel" ones:
688 @example
689 binutils, gcc-core, make, subversion, mingw-runtime, diffutils
690 @end example
691
692 The experimental gcc4 package is still buggy, hence please
693 use the official gcc 3.4.4 or a 4.2.x compiled from source by yourself.
694
695 Install the current binutils-20080624-2 as they work fine (the old
696 binutils-20060709-1 proved buggy on shared builds).
697
698 Then create a small library that just contains llrint():
699
700 @example
701 ar x /usr/lib/mingw/libmingwex.a llrint.o
702 ar cq /usr/local/lib/libllrint.a llrint.o
703 @end example
704
705 Then run
706
707 @example
708 ./configure --enable-static --disable-shared  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
709 @end example
710
711 to make a static build or
712
713 @example
714 ./configure --enable-shared --disable-static  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
715 @end example
716
717 to build shared libraries.
718
719 If you want to build FFmpeg with additional libraries, download Cygwin
720 "Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
721 @example
722 libogg-devel, libvorbis-devel
723 @end example
724
725 These library packages are only available from Cygwin Ports
726 (@url{http://sourceware.org/cygwinports/}) :
727
728 @example
729 yasm, libSDL-devel, libdirac-devel, libfaac-devel, libfaad-devel, libgsm-devel,
730 libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
731 libxvidcore-devel
732 @end example
733
734 The recommendation for libnut and x264 is to build them from source by
735 yourself, as they evolve too quickly for Cygwin Ports to be up to date.
736
737 Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
738 of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
739
740 @subsection Crosscompilation for Windows under Cygwin
741
742 With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
743
744 Just install your Cygwin as explained before, plus these additional
745 "Devel" packages:
746 @example
747 gcc-mingw-core, mingw-runtime, mingw-zlib
748 @end example
749
750 and add some special flags to your configure invocation.
751
752 For a static build run
753 @example
754 ./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
755 @end example
756
757 and for a build with shared libraries
758 @example
759 ./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
760 @end example
761
762 @section BeOS
763
764 BeOS support is broken in mysterious ways.
765
766 @section OS/2
767
768 For information about compiling FFmpeg on OS/2 see
769 @url{http://www.edm2.com/index.php/FFmpeg}.
770
771 @chapter Developers Guide
772
773 @section API
774 @itemize @bullet
775 @item libavcodec is the library containing the codecs (both encoding and
776 decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
777
778 @item libavformat is the library containing the file format handling (mux and
779 demux code for several formats). Look at @file{ffplay.c} to use it in a
780 player. See @file{output_example.c} to use it to generate audio or video
781 streams.
782
783 @end itemize
784
785 @section Integrating libavcodec or libavformat in your program
786
787 You can integrate all the source code of the libraries to link them
788 statically to avoid any version problem. All you need is to provide a
789 'config.mak' and a 'config.h' in the parent directory. See the defines
790 generated by ./configure to understand what is needed.
791
792 You can use libavcodec or libavformat in your commercial program, but
793 @emph{any patch you make must be published}. The best way to proceed is
794 to send your patches to the FFmpeg mailing list.
795
796 @node Coding Rules
797 @section Coding Rules
798
799 FFmpeg is programmed in the ISO C90 language with a few additional
800 features from ISO C99, namely:
801 @itemize @bullet
802 @item
803 the @samp{inline} keyword;
804 @item
805 @samp{//} comments;
806 @item
807 designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
808 @item
809 compound literals (@samp{x = (struct s) @{ 17, 23 @};})
810 @end itemize
811
812 These features are supported by all compilers we care about, so we will not
813 accept patches to remove their use unless they absolutely do not impair
814 clarity and performance.
815
816 All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
817 compiles with several other compilers, such as the Compaq ccc compiler
818 or Sun Studio 9, and we would like to keep it that way unless it would
819 be exceedingly involved. To ensure compatibility, please do not use any
820 additional C99 features or GCC extensions. Especially watch out for:
821 @itemize @bullet
822 @item
823 mixing statements and declarations;
824 @item
825 @samp{long long} (use @samp{int64_t} instead);
826 @item
827 @samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
828 @item
829 GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
830 @end itemize
831
832 Indent size is 4.
833 The presentation is the one specified by 'indent -i4 -kr -nut'.
834 The TAB character is forbidden outside of Makefiles as is any
835 form of trailing whitespace. Commits containing either will be
836 rejected by the Subversion repository.
837
838 The main priority in FFmpeg is simplicity and small code size in order to
839 minimize the bug count.
840
841 Comments: Use the JavaDoc/Doxygen
842 format (see examples below) so that code documentation
843 can be generated automatically. All nontrivial functions should have a comment
844 above them explaining what the function does, even if it is just one sentence.
845 All structures and their member variables should be documented, too.
846 @example
847 /**
848  * @@file mpeg.c
849  * MPEG codec.
850  * @@author ...
851  */
852
853 /**
854  * Summary sentence.
855  * more text ...
856  * ...
857  */
858 typedef struct Foobar@{
859     int var1; /**< var1 description */
860     int var2; ///< var2 description
861     /** var3 description */
862     int var3;
863 @} Foobar;
864
865 /**
866  * Summary sentence.
867  * more text ...
868  * ...
869  * @@param my_parameter description of my_parameter
870  * @@return return value description
871  */
872 int myfunc(int my_parameter)
873 ...
874 @end example
875
876 fprintf and printf are forbidden in libavformat and libavcodec,
877 please use av_log() instead.
878
879 Casts should be used only when necessary. Unneeded parentheses
880 should also be avoided if they don't make the code easier to understand.
881
882 @section Development Policy
883
884 @enumerate
885 @item
886    Contributions should be licensed under the LGPL 2.1, including an
887    "or any later version" clause, or the MIT license.  GPL 2 including
888    an "or any later version" clause is also acceptable, but LGPL is
889    preferred.
890 @item
891    You must not commit code which breaks FFmpeg! (Meaning unfinished but
892    enabled code which breaks compilation or compiles but does not work or
893    breaks the regression tests)
894    You can commit unfinished stuff (for testing etc), but it must be disabled
895    (#ifdef etc) by default so it does not interfere with other developers'
896    work.
897 @item
898    You do not have to over-test things. If it works for you, and you think it
899    should work for others, then commit. If your code has problems
900    (portability, triggers compiler bugs, unusual environment etc) they will be
901    reported and eventually fixed.
902 @item
903    Do not commit unrelated changes together, split them into self-contained
904    pieces. Also do not forget that if part B depends on part A, but A does not
905    depend on B, then A can and should be committed first and separate from B.
906    Keeping changes well split into self-contained parts makes reviewing and
907    understanding them on the commit log mailing list easier. This also helps
908    in case of debugging later on.
909    Also if you have doubts about splitting or not splitting, do not hesitate to
910    ask/discuss it on the developer mailing list.
911 @item
912    Do not change behavior of the program (renaming options etc) without
913    first discussing it on the ffmpeg-devel mailing list. Do not remove
914    functionality from the code. Just improve!
915
916    Note: Redundant code can be removed.
917 @item
918    Do not commit changes to the build system (Makefiles, configure script)
919    which change behavior, defaults etc, without asking first. The same
920    applies to compiler warning fixes, trivial looking fixes and to code
921    maintained by other developers. We usually have a reason for doing things
922    the way we do. Send your changes as patches to the ffmpeg-devel mailing
923    list, and if the code maintainers say OK, you may commit. This does not
924    apply to files you wrote and/or maintain.
925 @item
926    We refuse source indentation and other cosmetic changes if they are mixed
927    with functional changes, such commits will be rejected and removed. Every
928    developer has his own indentation style, you should not change it. Of course
929    if you (re)write something, you can use your own style, even though we would
930    prefer if the indentation throughout FFmpeg was consistent (Many projects
931    force a given indentation style - we do not.). If you really need to make
932    indentation changes (try to avoid this), separate them strictly from real
933    changes.
934
935    NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
936    then either do NOT change the indentation of the inner part within (do not
937    move it to the right)! or do so in a separate commit
938 @item
939    Always fill out the commit log message. Describe in a few lines what you
940    changed and why. You can refer to mailing list postings if you fix a
941    particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
942 @item
943    If you apply a patch by someone else, include the name and email address in
944    the log message. Since the ffmpeg-cvslog mailing list is publicly
945    archived you should add some SPAM protection to the email address. Send an
946    answer to ffmpeg-devel (or wherever you got the patch from) saying that
947    you applied the patch.
948 @item
949    When applying patches that have been discussed (at length) on the mailing
950    list, reference the thread in the log message.
951 @item
952     Do NOT commit to code actively maintained by others without permission.
953     Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
954     timeframe (12h for build failures and security fixes, 3 days small changes,
955     1 week for big patches) then commit your patch if you think it is OK.
956     Also note, the maintainer can simply ask for more time to review!
957 @item
958     Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
959     are sent there and reviewed by all the other developers. Bugs and possible
960     improvements or general questions regarding commits are discussed there. We
961     expect you to react if problems with your code are uncovered.
962 @item
963     Update the documentation if you change behavior or add features. If you are
964     unsure how best to do this, send a patch to ffmpeg-devel, the documentation
965     maintainer(s) will review and commit your stuff.
966 @item
967     Try to keep important discussions and requests (also) on the public
968     developer mailing list, so that all developers can benefit from them.
969 @item
970     Never write to unallocated memory, never write over the end of arrays,
971     always check values read from some untrusted source before using them
972     as array index or other risky things.
973 @item
974     Remember to check if you need to bump versions for the specific libav
975     parts (libavutil, libavcodec, libavformat) you are changing. You need
976     to change the version integer.
977     Incrementing the first component means no backward compatibility to
978     previous versions (e.g. removal of a function from the public API).
979     Incrementing the second component means backward compatible change
980     (e.g. addition of a function to the public API or extension of an
981     existing data structure).
982     Incrementing the third component means a noteworthy binary compatible
983     change (e.g. encoder bug fix that matters for the decoder).
984 @item
985     Compiler warnings indicate potential bugs or code with bad style. If a type of
986     warning always points to correct and clean code, that warning should
987     be disabled, not the code changed.
988     Thus the remaining warnings can either be bugs or correct code.
989     If it is a bug, the bug has to be fixed. If it is not, the code should
990     be changed to not generate a warning unless that causes a slowdown
991     or obfuscates the code.
992 @item
993     If you add a new file, give it a proper license header. Do not copy and
994     paste it from a random place, use an existing file as template.
995 @end enumerate
996
997 We think our rules are not too hard. If you have comments, contact us.
998
999 Note, these rules are mostly borrowed from the MPlayer project.
1000
1001 @section Submitting patches
1002
1003 First, (@pxref{Coding Rules}) above if you did not yet.
1004
1005 When you submit your patch, try to send a unified diff (diff '-up'
1006 option). We cannot read other diffs :-)
1007
1008 Also please do not submit a patch which contains several unrelated changes.
1009 Split it into separate, self-contained pieces. This does not mean splitting
1010 file by file. Instead, make the patch as small as possible while still
1011 keeping it as a logical unit that contains an individual change, even
1012 if it spans multiple files. This makes reviewing your patches much easier
1013 for us and greatly increases your chances of getting your patch applied.
1014
1015 Run the regression tests before submitting a patch so that you can
1016 verify that there are no big problems.
1017
1018 Patches should be posted as base64 encoded attachments (or any other
1019 encoding which ensures that the patch will not be trashed during
1020 transmission) to the ffmpeg-devel mailing list, see
1021 @url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
1022
1023 It also helps quite a bit if you tell us what the patch does (for example
1024 'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
1025 and has no lrint()')
1026
1027 Also please if you send several patches, send each patch as a separate mail,
1028 do not attach several unrelated patches to the same mail.
1029
1030 @section New codecs or formats checklist
1031
1032 @enumerate
1033 @item
1034     Did you use av_cold for codec initialization and close functions?
1035 @item
1036     Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
1037     AVInputFormat/AVOutputFormat struct?
1038 @item
1039     Did you bump the minor version number in @file{avcodec.h} or
1040     @file{avformat.h}?
1041 @item
1042     Did you register it in @file{allcodecs.c} or @file{allformats.c}?
1043 @item
1044     Did you add the CodecID to @file{avcodec.h}?
1045 @item
1046     If it has a fourcc, did you add it to @file{libavformat/riff.c},
1047     even if it is only a decoder?
1048 @item
1049     Did you add a rule to compile the appropriate files in the Makefile?
1050     Remember to do this even if you're just adding a format to a file that is
1051     already being compiled by some other rule, like a raw demuxer.
1052 @item
1053     Did you add an entry to the table of supported formats or codecs in the
1054     documentation?
1055 @item
1056     Did you add an entry in the Changelog?
1057 @item
1058     If it depends on a parser or a library, did you add that dependency in
1059     configure?
1060 @item
1061     Did you "svn add" the appropriate files before commiting?
1062 @end enumerate
1063
1064 @section patch submission checklist
1065
1066 @enumerate
1067 @item
1068     Do the regression tests pass with the patch applied?
1069 @item
1070     Does @code{make checkheaders} pass with the patch applied?
1071 @item
1072     Is the patch a unified diff?
1073 @item
1074     Is the patch against latest FFmpeg SVN?
1075 @item
1076     Are you subscribed to ffmpeg-dev?
1077     (the list is subscribers only due to spam)
1078 @item
1079     Have you checked that the changes are minimal, so that the same cannot be
1080     achieved with a smaller patch and/or simpler final code?
1081 @item
1082     If the change is to speed critical code, did you benchmark it?
1083 @item
1084     If you did any benchmarks, did you provide them in the mail?
1085 @item
1086     Have you checked that the patch does not introduce buffer overflows or
1087     other security issues?
1088 @item
1089     Did you test your decoder or demuxer against damaged data? If no, see
1090     tools/trasher and the noise bitstream filter. Your decoder or demuxer
1091     should not crash or end in a (near) infinite loop when fed damaged data.
1092 @item
1093     Is the patch created from the root of the source tree, so it can be
1094     applied with @code{patch -p0}?
1095 @item
1096     Does the patch not mix functional and cosmetic changes?
1097 @item
1098     Did you add tabs or trailing whitespace to the code? Both are forbidden.
1099 @item
1100     Is the patch attached to the email you send?
1101 @item
1102     Is the mime type of the patch correct? It should be text/x-diff or
1103     text/x-patch or at least text/plain and not application/octet-stream.
1104 @item
1105     If the patch fixes a bug, did you provide a verbose analysis of the bug?
1106 @item
1107     If the patch fixes a bug, did you provide enough information, including
1108     a sample, so the bug can be reproduced and the fix can be verified?
1109     Note please do not attach samples >100k to mails but rather provide a
1110     URL, you can upload to ftp://upload.ffmpeg.org
1111 @item
1112     Did you provide a verbose summary about what the patch does change?
1113 @item
1114     Did you provide a verbose explanation why it changes things like it does?
1115 @item
1116     Did you provide a verbose summary of the user visible advantages and
1117     disadvantages if the patch is applied?
1118 @item
1119     Did you provide an example so we can verify the new feature added by the
1120     patch easily?
1121 @item
1122     If you added a new file, did you insert a license header? It should be
1123     taken from FFmpeg, not randomly copied and pasted from somewhere else.
1124 @item
1125     You should maintain alphabetical order in alphabetically ordered lists as
1126     long as doing so does not break API/ABI compatibility.
1127 @item
1128     Lines with similar content should be aligned vertically when doing so
1129     improves readability.
1130 @item
1131     Did you provide a suggestion for a clear commit log message?
1132 @end enumerate
1133
1134 @section Patch review process
1135
1136 All patches posted to ffmpeg-devel will be reviewed, unless they contain a
1137 clear note that the patch is not for SVN.
1138 Reviews and comments will be posted as replies to the patch on the
1139 mailing list. The patch submitter then has to take care of every comment,
1140 that can be by resubmitting a changed patch or by discussion. Resubmitted
1141 patches will themselves be reviewed like any other patch. If at some point
1142 a patch passes review with no comments then it is approved, that can for
1143 simple and small patches happen immediately while large patches will generally
1144 have to be changed and reviewed many times before they are approved.
1145 After a patch is approved it will be committed to the repository.
1146
1147 We will review all submitted patches, but sometimes we are quite busy so
1148 especially for large patches this can take several weeks.
1149
1150 When resubmitting patches, please do not make any significant changes
1151 not related to the comments received during review. Such patches will
1152 be rejected. Instead, submit  significant changes or new features as
1153 separate patches.
1154
1155 @section Regression tests
1156
1157 Before submitting a patch (or committing to the repository), you should at least
1158 test that you did not break anything.
1159
1160 The regression tests build a synthetic video stream and a synthetic
1161 audio stream. These are then encoded and decoded with all codecs or
1162 formats. The CRC (or MD5) of each generated file is recorded in a
1163 result file. A 'diff' is launched to compare the reference results and
1164 the result file.
1165
1166 The regression tests then go on to test the FFserver code with a
1167 limited set of streams. It is important that this step runs correctly
1168 as well.
1169
1170 Run 'make test' to test all the codecs and formats.
1171
1172 Run 'make fulltest' to test all the codecs, formats and FFserver.
1173
1174 [Of course, some patches may change the results of the regression tests. In
1175 this case, the reference results of the regression tests shall be modified
1176 accordingly].
1177
1178 @bye