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