Statistics
| Branch: | Revision:

ffmpeg / doc / general.texi @ d2f532c8

History | View | Annotate | Download (54.7 KB)

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 Flash Video (FLV)         @tab   @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 Quake II CIN video     @tab   @tab X
94
@item id RoQ                    @tab X @tab X
95
    @tab Used in Quake III, Jedi Knight 2, other computer games.
96
@item IFF                       @tab   @tab X
97
    @tab Interchange File Format
98
@item Interplay MVE             @tab   @tab X
99
    @tab Format used in various Interplay computer games.
100
@item LMLM4                     @tab   @tab X
101
    @tab Used by Linux Media Labs MPEG-4 PCI boards
102
@item Matroska                  @tab X @tab X
103
@item Matroska audio            @tab X @tab
104
@item MAXIS XA                  @tab   @tab X
105
    @tab Used in Sim City 3000; file extension .xa.
106
@item Monkey's Audio            @tab   @tab X
107
@item Motion Pixels MVI         @tab   @tab X
108
@item MOV/QuickTime/MP4         @tab X @tab X
109
    @tab 3GP, 3GP2, PSP, iPod variants supported
110
@item MP2                       @tab X @tab X
111
@item MP3                       @tab X @tab X
112
@item MPEG-1 System             @tab X @tab X
113
    @tab muxed audio and video, VCD format supported
114
@item MPEG-PS (program stream)  @tab X @tab X
115
    @tab also known as @code{VOB} file, SVCD and DVD format supported
116
@item MPEG-TS (transport stream) @tab X @tab X
117
    @tab also known as DVB Transport Stream
118
@item MPEG-4                    @tab X @tab X
119
    @tab MPEG-4 is a variant of QuickTime.
120
@item MIME multipart JPEG       @tab X @tab
121
@item MSN TCP webcam            @tab   @tab X
122
    @tab Used by MSN Messenger webcam streams.
123
@item MTV                       @tab   @tab X
124
@item Musepack                  @tab   @tab X
125
@item Musepack SV8              @tab   @tab X
126
@item Material eXchange Format (MXF) @tab X @tab X
127
    @tab SMPTE 377M, used by D-Cinema, broadcast industry.
128
@item Material eXchange Format (MXF), D-10 Mapping @tab X @tab X
129
    @tab SMPTE 386M, D-10/IMX Mapping.
130
@item NC camera feed            @tab   @tab X
131
    @tab NC (AVIP NC4600) camera streams
132
@item Nullsoft Streaming Video  @tab   @tab X
133
@item NuppelVideo               @tab   @tab X
134
@item NUT                       @tab X @tab X
135
    @tab NUT Open Container Format
136
@item Ogg                       @tab X @tab X
137
@item TechnoTrend PVA           @tab   @tab X
138
    @tab Used by TechnoTrend DVB PCI boards.
139
@item raw ADTS (AAC)            @tab X @tab X
140
@item raw AC-3                  @tab X @tab X
141
@item raw Chinese AVS video     @tab   @tab X
142
@item raw CRI ADX               @tab X @tab X
143
@item raw Dirac                 @tab X @tab X
144
@item raw DNxHD                 @tab X @tab X
145
@item raw DTS                   @tab X @tab X
146
@item raw E-AC-3                @tab X @tab X
147
@item raw FLAC                  @tab X @tab X
148
@item raw GSM                   @tab   @tab X
149
@item raw H.261                 @tab X @tab X
150
@item raw H.263                 @tab X @tab X
151
@item raw H.264                 @tab X @tab X
152
@item raw Ingenient MJPEG       @tab   @tab X
153
@item raw MJPEG                 @tab X @tab X
154
@item raw MLP                   @tab   @tab X
155
@item raw MPEG                  @tab   @tab X
156
@item raw MPEG-1                @tab   @tab X
157
@item raw MPEG-2                @tab   @tab X
158
@item raw MPEG-4                @tab X @tab X
159
@item raw NULL                  @tab X @tab
160
@item raw video                 @tab X @tab X
161
@item raw id RoQ                @tab X @tab
162
@item raw Shorten               @tab   @tab X
163
@item raw VC-1                  @tab   @tab X
164
@item raw PCM A-law             @tab X @tab X
165
@item raw PCM mu-law            @tab X @tab X
166
@item raw PCM signed 8 bit      @tab X @tab X
167
@item raw PCM signed 16 bit big-endian  @tab X @tab X
168
@item raw PCM signed 16 bit little-endian  @tab X @tab X
169
@item raw PCM signed 24 bit big-endian  @tab X @tab X
170
@item raw PCM signed 24 bit little-endian  @tab X @tab X
171
@item raw PCM signed 32 bit big-endian  @tab X @tab X
172
@item raw PCM signed 32 bit little-endian  @tab X @tab X
173
@item raw PCM unsigned 8 bit    @tab X @tab X
174
@item raw PCM unsigned 16 bit big-endian  @tab X @tab X
175
@item raw PCM unsigned 16 bit little-endian  @tab X @tab X
176
@item raw PCM unsigned 24 bit big-endian  @tab X @tab X
177
@item raw PCM unsigned 24 bit little-endian  @tab X @tab X
178
@item raw PCM unsigned 32 bit big-endian  @tab X @tab X
179
@item raw PCM unsigned 32 bit little-endian  @tab X @tab X
180
@item raw PCM floating-point 32 bit big-endian  @tab X @tab X
181
@item raw PCM floating-point 32 bit little-endian  @tab X @tab X
182
@item raw PCM floating-point 64 bit big-endian  @tab X @tab X
183
@item raw PCM floating-point 64 bit little-endian  @tab X @tab X
184
@item RDT                       @tab   @tab X
185
@item REDCODE R3D               @tab   @tab X
186
    @tab File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
187
@item RealMedia                 @tab X @tab X
188
@item Redirector                @tab   @tab X
189
@item Renderware TeXture Dictionary @tab   @tab X
190
@item RL2                       @tab   @tab X
191
    @tab Audio and video format used in some games by Entertainment Software Partners.
192
@item RPL/ARMovie               @tab   @tab X
193
@item RTP                       @tab   @tab X
194
@item RTSP                      @tab   @tab X
195
@item SDP                       @tab   @tab X
196
@item Sega FILM/CPK             @tab   @tab X
197
    @tab Used in many Sega Saturn console games.
198
@item Sierra SOL                @tab   @tab X
199
    @tab .sol files used in Sierra Online games.
200
@item Sierra VMD                @tab   @tab X
201
    @tab Used in Sierra CD-ROM games.
202
@item Smacker                   @tab   @tab X
203
    @tab Multimedia format used by many games.
204
@item Sony OpenMG (OMA)         @tab   @tab X
205
    @tab Audio format used in Sony Sonic Stage and Sony Vegas.
206
@item Sony PlayStation STR      @tab   @tab X
207
@item SUN AU format             @tab X @tab X
208
@item THP                       @tab   @tab X
209
    @tab Used on the Nintendo GameCube.
210
@item Tiertex Limited SEQ       @tab   @tab X
211
    @tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
212
@item True Audio                @tab   @tab X
213
@item VC-1 test bitstream       @tab X @tab X
214
@item NTT TwinVQ (VQF)          @tab   @tab X
215
    @tab Nippon Telegraph and Telephone Corporation TwinVQ.
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
237
    @tab one raw file per component
238
@item animated GIF @tab X @tab X
239
    @tab Only uncompressed GIFs are generated.
240
@item BMP          @tab X @tab X
241
    @tab Microsoft BMP image
242
@item JPEG         @tab X @tab X
243
    @tab Progressive JPEG is not supported.
244
@item JPEG 2000    @tab   @tab E
245
    @tab decoding supported through external library libopenjpeg
246
@item JPEG-LS      @tab X @tab X
247
@item LJPEG        @tab X @tab
248
    @tab Lossless JPEG
249
@item PAM          @tab X @tab X
250
    @tab PAM is a PNM extension with alpha support.
251
@item PBM          @tab X @tab X
252
    @tab Portable BitMap image
253
@item PCX          @tab   @tab X
254
    @tab PC Paintbrush
255
@item PGM          @tab X @tab X
256
    @tab Portable GrayMap image
257
@item PGMYUV       @tab X @tab X
258
    @tab PGM with U and V components in YUV 4:2:0
259
@item PNG          @tab X @tab X
260
    @tab 2/4 bpp not supported yet
261
@item PPM          @tab X @tab X
262
    @tab Portable PixelMap image
263
@item PTX          @tab   @tab X
264
    @tab V.Flash PTX format
265
@item SGI          @tab X @tab X
266
    @tab SGI RGB image format
267
@item Sun Rasterfile  @tab   @tab X
268
    @tab Sun RAS image format
269
@item TIFF         @tab X @tab X
270
    @tab YUV, JPEG and some extension is not supported yet.
271
@item Truevision Targa  @tab X @tab X
272
    @tab Targa (.TGA) image format
273
@end multitable
274

    
275
@code{X} means that encoding (resp. decoding) is supported.
276

    
277
@code{E} means that support is provided through an external library.
278

    
279
@section Video Codecs
280

    
281
@multitable @columnfractions .4 .1 .1 .4
282
@item Name @tab Encoding @tab Decoding @tab Comments
283
@item 4X Movie               @tab     @tab  X
284
    @tab Used in certain computer games.
285
@item 8SVX exponential       @tab     @tab  X
286
@item 8SVX fibonacci         @tab     @tab  X
287
@item American Laser Games MM  @tab    @tab X
288
    @tab Used in games like Mad Dog McCree.
289
@item AMV Video              @tab     @tab  X
290
    @tab Used in Chinese MP3 players.
291
@item Apple MJPEG-B          @tab     @tab  X
292
@item Apple QuickDraw        @tab     @tab  X
293
    @tab fourcc: qdrw
294
@item Asus v1                @tab  X  @tab  X
295
    @tab fourcc: ASV1
296
@item Asus v2                @tab  X  @tab  X
297
    @tab fourcc: ASV2
298
@item ATI VCR1               @tab     @tab  X
299
    @tab fourcc: VCR1
300
@item ATI VCR2               @tab     @tab  X
301
    @tab fourcc: VCR2
302
@item Autodesk Animator Flic video  @tab     @tab  X
303
@item Autodesk RLE           @tab     @tab  X
304
    @tab fourcc: AASC
305
@item AVS (Audio Video Standard) video  @tab     @tab  X
306
    @tab Video encoding used by the Creature Shock game.
307
@item Beam Software VB       @tab     @tab  X
308
@item Bethesda VID video     @tab     @tab  X
309
    @tab Used in some games from Bethesda Softworks.
310
@item Brute Force & Ignorance   @tab   @tab X
311
    @tab Used in the game Flash Traffic: City of Angels.
312
@item C93 video              @tab     @tab  X
313
    @tab Codec used in Cyberia game.
314
@item CamStudio              @tab     @tab  X
315
    @tab fourcc: CSCD
316
@item Chinese AVS video      @tab     @tab  X
317
    @tab AVS1-P2, JiZhun profile
318
@item Delphine Software International CIN video  @tab     @tab  X
319
    @tab Codec used in Delphine Software International games.
320
@item Cinepak                @tab     @tab  X
321
@item Cirrus Logic AccuPak   @tab     @tab  X
322
    @tab fourcc: CLJR
323
@item Creative YUV (CYUV)    @tab     @tab  X
324
@item Dirac                  @tab  E  @tab  E
325
    @tab supported through external libdirac/libschroedinger libraries
326
@item DNxHD                  @tab   X @tab  X
327
    @tab aka SMPTE VC3
328
@item Duck TrueMotion 1.0   @tab     @tab  X
329
    @tab fourcc: DUCK
330
@item Duck TrueMotion 2.0    @tab     @tab  X
331
    @tab fourcc: TM20
332
@item DV (Digital Video)     @tab  X  @tab  X
333
@item Feeble Files/ScummVM DXA  @tab     @tab  X
334
    @tab Codec originally used in Feeble Files game.
335
@item Electronic Arts CMV video  @tab     @tab  X
336
    @tab Used in NHL 95 game.
337
@item Electronic Arts TGV video  @tab     @tab  X
338
@item Electronic Arts TGQ video  @tab     @tab  X
339
@item Electronic Arts TQI video  @tab     @tab  X
340
@item Escape 124             @tab     @tab  X
341
@item FFmpeg codec #1        @tab  X  @tab  X
342
    @tab experimental lossless codec (fourcc: FFV1)
343
@item Flash Screen Video v1  @tab  X  @tab  X
344
    @tab fourcc: FSV1
345
@item Flash Video (FLV)      @tab  X  @tab  X
346
    @tab Sorenson H.263 used in Flash
347
@item Fraps                  @tab     @tab  X
348
@item H.261                  @tab  X  @tab  X
349
@item H.263 / H.263-1996     @tab  X  @tab  X
350
@item H.263+ / H.263-1998 / H.263 version 2  @tab  X  @tab  X
351
@item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10  @tab  E  @tab  X
352
    @tab encoding supported through external library libx264
353
@item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (VDPAU acceleration)  @tab  E  @tab  X
354
@item HuffYUV                @tab  X  @tab  X
355
@item HuffYUV FFmpeg variant @tab  X  @tab  X
356
@item IBM Ultimotion         @tab     @tab  X
357
    @tab fourcc: ULTI
358
@item id Cinematic video     @tab     @tab  X
359
    @tab Used in Quake II.
360
@item id RoQ video           @tab  X  @tab  X
361
    @tab Used in Quake III, Jedi Knight 2, other computer games.
362
@item Intel H.263            @tab     @tab  X
363
@item Intel Indeo 2          @tab     @tab  X
364
@item Intel Indeo 3          @tab     @tab  X
365
@item Interplay C93          @tab     @tab  X
366
    @tab Used in the game Cyberia from Interplay.
367
@item Interplay MVE video    @tab     @tab  X
368
    @tab Used in Interplay .MVE files.
369
@item Karl Morton's video codec  @tab     @tab  X
370
    @tab Codec used in Worms games.
371
@item LCL (LossLess Codec Library) MSZH  @tab     @tab  X
372
@item LCL (LossLess Codec Library) ZLIB  @tab  E  @tab  E
373
@item LOCO                   @tab     @tab  X
374
@item lossless MJPEG         @tab  X  @tab  X
375
@item Microsoft RLE          @tab     @tab  X
376
@item Microsoft Video 1      @tab     @tab  X
377
@item Mimic                  @tab     @tab  X
378
    @tab Used in MSN Messenger Webcam streams.
379
@item Miro VideoXL           @tab     @tab  X
380
    @tab fourcc: VIXL
381
@item MJPEG (Motion JPEG)    @tab  X  @tab  X
382
@item Motion Pixels video    @tab     @tab  X
383
@item MPEG-1 video           @tab  X  @tab  X
384
@item MPEG-1/2 video XvMC (X-Video Motion Compensation)  @tab     @tab  X
385
@item MPEG-1/2 video (VDPAU acceleration)  @tab     @tab  X
386
@item MPEG-2 video           @tab  X  @tab  X
387
@item MPEG-4 part 2          @tab  X  @tab  X
388
    @ libxvidcore can be used alternatively for encoding.
389
@item MPEG-4 part 2 Microsoft variant version 1  @tab  X  @tab  X
390
@item MPEG-4 part 2 Microsoft variant version 2  @tab  X  @tab  X
391
@item MPEG-4 part 2 Microsoft variant version 3  @tab  X  @tab  X
392
@item Nintendo Gamecube THP video  @tab     @tab  X
393
@item NuppelVideo/RTjpeg     @tab     @tab  X
394
    @tab Video encoding used in NuppelVideo files.
395
@item On2 VP3                @tab     @tab  X
396
    @tab still experimental
397
@item On2 VP5                @tab     @tab  X
398
    @tab fourcc: VP50
399
@item On2 VP6                @tab     @tab  X
400
    @tab fourcc: VP60,VP61,VP62
401
@item planar RGB             @tab     @tab  X
402
    @tab fourcc: 8BPS
403
@item Q-team QPEG            @tab     @tab  X
404
    @tab fourccs: QPEG, Q1.0, Q1.1
405
@item QuickTime 8BPS video   @tab     @tab  X
406
@item QuickTime Animation (RLE) video  @tab  X  @tab  X
407
    @tab fourcc: 'rle '
408
@item QuickTime Graphics (SMC)  @tab     @tab  X
409
    @tab fourcc: 'smc '
410
@item QuickTime video (RPZA) @tab     @tab  X
411
    @tab fourcc: rpza
412
@item Raw Video              @tab  X  @tab  X
413
@item RealVideo 1.0          @tab  X  @tab  X
414
@item RealVideo 2.0          @tab  X  @tab  X
415
@item RealVideo 3.0          @tab     @tab  X
416
    @tab still far from ideal
417
@item RealVideo 4.0          @tab     @tab  X
418
@item Renderware TXD (TeXture Dictionary)  @tab     @tab  X
419
    @tab Texture dictionaries used by the Renderware Engine.
420
@item RL2 video              @tab     @tab  X
421
    @tab used in some games by Entertainment Software Partners
422
@item Sierra VMD video       @tab     @tab  X
423
    @tab Used in Sierra VMD files.
424
@item Smacker video          @tab     @tab  X
425
    @tab Video encoding used in Smacker.
426
@item SMPTE VC-1             @tab     @tab  X
427
@item Snow                   @tab  X  @tab  X
428
    @tab experimental wavelet codec (fourcc: SNOW)
429
@item Sony PlayStation MDEC (Motion DECoder)  @tab     @tab  X
430
@item Sorenson Vector Quantizer 1  @tab  X  @tab  X
431
    @tab fourcc: SVQ1
432
@item Sorenson Vector Quantizer 3  @tab     @tab  X
433
    @tab fourcc: SVQ3
434
@item Sunplus JPEG (SP5X)    @tab     @tab  X
435
    @tab fourcc: SP5X
436
@item TechSmith Screen Capture Codec  @tab     @tab  X
437
    @tab fourcc: TSCC
438
@item Theora                 @tab  E  @tab  X
439
    @tab encoding supported through external library libtheora
440
@item Tiertex Limited SEQ video  @tab     @tab  X
441
    @tab Codec used in DOS CD-ROM FlashBack game.
442
@item VMware Screen Codec / VMware Video  @tab     @tab  X
443
    @tab Codec used in videos captured by VMware.
444
@item Westwood Studios VQA (Vector Quantized Animation) video  @tab     @tab  X
445
@item Windows Media Video 7  @tab  X  @tab  X
446
@item Windows Media Video 8  @tab  X  @tab  X
447
@item Windows Media Video 9  @tab     @tab  X
448
    @tab not completely working
449
@item Wing Commander III / Xan  @tab     @tab  X
450
    @tab Used in Wing Commander III .MVE files.
451
@item Winnov WNV1            @tab     @tab  X
452
@item WMV7                   @tab  X  @tab  X
453
@item YAMAHA SMAF            @tab  X  @tab  X
454
@item ZLIB                   @tab  X  @tab  X
455
    @tab part of LCL, encoder experimental
456
@item Zip Motion Blocks Video  @tab   X @tab  X
457
    @tab Encoder works only in PAL8.
458
@end multitable
459

    
460
@code{X} means that encoding (resp. decoding) is supported.
461

    
462
@code{E} means that support is provided through an external library.
463

    
464
@section Audio Codecs
465

    
466
@multitable @columnfractions .4 .1 .1 .4
467
@item Name @tab Encoding @tab Decoding @tab Comments
468
@item 8SVX audio             @tab     @tab  X
469
@item AAC                    @tab  E  @tab  X
470
    @tab encoding supported through external library libfaac
471
@item AC-3                   @tab IX  @tab  X
472
@item ADPCM 4X Movie         @tab     @tab  X
473
@item ADPCM CDROM XA         @tab     @tab  X
474
@item ADPCM Creative Technology @tab     @tab  X
475
    @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
476
@item ADPCM Electronic Arts  @tab     @tab  X
477
    @tab Used in various EA titles.
478
@item ADPCM Electronic Arts Maxis CDROM XS  @tab     @tab  X
479
    @tab Used in Sim City 3000.
480
@item ADPCM Electronic Arts R1  @tab     @tab  X
481
@item ADPCM Electronic Arts R2  @tab     @tab  X
482
@item ADPCM Electronic Arts R3  @tab     @tab  X
483
@item ADPCM Electronic Arts XAS @tab     @tab  X
484
@item ADPCM G.726            @tab  X  @tab  X
485
@item ADPCM IMA AMV          @tab     @tab  X
486
    @tab Used in AMV files
487
@item ADPCM IMA Electronic Arts EACS  @tab     @tab  X
488
@item ADPCM IMA Electronic Arts SEAD  @tab     @tab  X
489
@item ADPCM IMA Funcom       @tab     @tab  X
490
@item ADPCM IMA QuickTime    @tab  X  @tab  X
491
@item ADPCM IMA Loki SDL MJPEG  @tab     @tab  X
492
@item ADPCM IMA WAV          @tab  X  @tab  X
493
@item ADPCM IMA Westwood     @tab     @tab  X
494
@item ADPCM ISS IMA          @tab     @tab  X
495
    @tab Used in FunCom games.
496
@item ADPCM IMA Duck DK3     @tab     @tab  X
497
    @tab Used in some Sega Saturn console games.
498
@item ADPCM IMA Duck DK4     @tab     @tab  X
499
    @tab Used in some Sega Saturn console games.
500
@item ADPCM Microsoft        @tab  X  @tab  X
501
@item ADPCM MS IMA           @tab  X  @tab  X
502
@item ADPCM Nintendo Gamecube THP  @tab     @tab  X
503
@item ADPCM QT IMA           @tab  X  @tab  X
504
@item ADPCM SEGA CRI ADX     @tab  X  @tab  X
505
    @tab Used in Sega Dreamcast games.
506
@item ADPCM Shockwave Flash  @tab  X  @tab  X
507
@item ADPCM SMJPEG IMA       @tab     @tab  X
508
    @tab Used in certain Loki game ports.
509
@item ADPCM Sound Blaster Pro 2-bit  @tab     @tab  X
510
@item ADPCM Sound Blaster Pro 2.6-bit  @tab     @tab  X
511
@item ADPCM Sound Blaster Pro 4-bit  @tab     @tab  X
512
@item ADPCM Westwood Studios IMA @tab     @tab  X
513
    @tab Used in Westwood Studios games like Command and Conquer.
514
@item ADPCM Yamaha           @tab  X  @tab  X
515
@item AMR-NB                 @tab  E  @tab  E
516
    @tab supported through external library libamrnb
517
@item AMR-WB                 @tab  E  @tab  E
518
    @tab supported through external library libamrwb
519
@item Apple lossless audio   @tab  X  @tab  X
520
    @tab QuickTime fourcc 'alac'
521
@item Atrac 3                @tab     @tab  X
522
@item Delphine Software International CIN audio  @tab     @tab  X
523
    @tab Codec used in Delphine Software International games.
524
@item COOK                   @tab     @tab  X
525
    @tab All versions except 5.1 are supported.
526
@item DCA (DTS Coherent Acoustics)  @tab     @tab  X
527
@item DPCM id RoQ            @tab  X  @tab  X
528
    @tab Used in Quake III, Jedi Knight 2, other computer games.
529
@item DPCM Interplay         @tab     @tab  X
530
    @tab Used in various Interplay computer games.
531
@item DPCM Sierra Online     @tab     @tab  X
532
    @tab Used in Sierra Online game audio files.
533
@item DPCM Sol               @tab     @tab  X
534
@item DPCM Xan               @tab     @tab  X
535
@item DSP Group TrueSpeech   @tab     @tab  X
536
@item DV audio               @tab     @tab  X
537
@item Enhanced AC-3          @tab     @tab  X
538
@item FLAC (Free Lossless Audio Codec)  @tab  X  @tab  IX
539
@item G.729                  @tab     @tab  X
540
@item GSM                    @tab  E  @tab  E
541
    @tab supported through external library libgsm
542
@item GSM Microsoft variant  @tab  E  @tab  E
543
    @tab supported through external library libgsm
544
@item IMC (Intel Music Coder)  @tab     @tab  X
545
@item MACE (Macintosh Audio Compression/Expansion) 3:1  @tab     @tab  X
546
@item MACE (Macintosh Audio Compression/Expansion) 6:1  @tab     @tab  X
547
@item MLP(Meridian Lossless Packing)/TrueHD  @tab     @tab  X
548
    @tab Used in DVD-Audio and Blu-Ray discs.
549
@item Monkey's Audio         @tab     @tab  X
550
    @tab Only versions 3.97-3.99 are supported.
551
@item MP1 (MPEG audio layer 1)  @tab     @tab IX
552
@item MP2 (MPEG audio layer 2)  @tab IX  @tab IX
553
@item MP3 (MPEG audio layer 3)  @tab  E  @tab IX
554
    @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
555
@item Musepack SV7           @tab     @tab  X
556
@item Musepack SV8           @tab     @tab  X
557
@item Nellymoser Asao        @tab  X  @tab  X
558
@item PCM A-law              @tab  X  @tab  X
559
@item PCM mu-law             @tab  X  @tab  X
560
@item PCM 16-bit little-endian planar  @tab     @tab  X
561
@item PCM 32-bit floating point big-endian  @tab  X  @tab  X
562
@item PCM 32-bit floating point little-endian  @tab  X  @tab  X
563
@item PCM 64-bit floating point big-endian  @tab  X  @tab  X
564
@item PCM 64-bit floating point little-endian  @tab  X  @tab  X
565
@item PCM D-Cinema audio signed 24-bit   @tab  X  @tab  X
566
@item PCM signed 8-bit       @tab  X  @tab  X
567
@item PCM signed 16-bit big-endian  @tab  X  @tab  X
568
@item PCM signed 16-bit little-endian  @tab  X  @tab  X
569
@item PCM signed 24-bit big-endian  @tab  X  @tab  X
570
@item PCM signed 24-bit little-endian  @tab  X  @tab  X
571
@item PCM signed 32-bit big-endian  @tab  X  @tab  X
572
@item PCM signed 32-bit little-endian  @tab  X  @tab  X
573
@item PCM unsigned 8-bit     @tab  X  @tab  X
574
@item PCM unsigned 16-bit big-endian  @tab  X  @tab  X
575
@item PCM unsigned 16-bit little-endian  @tab  X  @tab  X
576
@item PCM unsigned 24-bit big-endian  @tab  X  @tab  X
577
@item PCM unsigned 24-bit little-endian  @tab  X  @tab  X
578
@item PCM unsigned 32-bit big-endian  @tab  X  @tab  X
579
@item PCM unsigned 32-bit little-endian  @tab  X  @tab  X
580
@item PCM Zork               @tab  X  @tab  X
581
@item QCELP / PureVoice      @tab     @tab  X
582
@item QDesign Music Codec 2  @tab     @tab  X
583
    @tab There are still some distortions.
584
@item RealAudio 1.0 (14.4K)  @tab     @tab  X
585
    @tab Real 14400 bit/s codec
586
@item RealAudio 2.0 (28.8K)  @tab     @tab  X
587
    @tab Real 28800 bit/s codec
588
@item RealAudio 3.0 (dnet)   @tab IX  @tab  X
589
    @tab Real low bitrate AC-3 codec
590
@item Shorten                @tab     @tab  X
591
@item Sierra VMD audio       @tab     @tab  X
592
    @tab Used in Sierra VMD files.
593
@item Smacker audio          @tab     @tab  X
594
@item Sonic                  @tab  X  @tab  X
595
    @tab experimental codec
596
@item Sonic lossless         @tab  X  @tab  X
597
    @tab experimental codec
598
@item Speex                  @tab     @tab  E
599
    @tab supported through external library libspeex
600
@item True Audio (TTA)       @tab     @tab  X
601
@item Vorbis                 @tab  E  @tab  X
602
    @ A native but very primitive encoder exists.
603
@item WavPack                @tab     @tab  X
604
@item Westwood Audio (SND1)  @tab     @tab  X
605
@item Windows Media Audio 1  @tab  X  @tab  X
606
@item Windows Media Audio 2  @tab  X  @tab  X
607
    @tab Used in Origin's Wing Commander IV AVI files.
608
@end multitable
609

    
610
@code{X} means that encoding (resp. decoding) is supported.
611

    
612
@code{E} means that support is provided through an external library.
613

    
614
@code{I} means that an integer-only version is available, too (ensures high
615
performance on systems without hardware floating point support).
616

    
617
@section Subtitle Formats
618

    
619
@multitable @columnfractions .4 .1 .1 .1 .1 .1
620
@item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
621
@item SSA/ASS      @tab X @tab X
622
@item DVB          @tab X @tab X @tab X @tab X
623
@item DVD          @tab X @tab X @tab X @tab X
624
@item XSUB         @tab   @tab   @tab   @tab X
625
@end multitable
626

    
627
@code{X} means that the feature is supported.
628

    
629
@section Network Protocols
630

    
631
@multitable @columnfractions .4 .1 .1 .1 .1 .1
632
@item Name         @tab Support
633
@item file         @tab X
634
@item Gopher       @tab X
635
@item HTTP         @tab X
636
@item pipe         @tab X
637
@item RTP          @tab X
638
@item TCP          @tab X
639
@item UDP          @tab X
640
@end multitable
641

    
642
@code{X} means that the protocol is supported.
643

    
644

    
645
@chapter Platform Specific information
646

    
647
@section BSD
648

    
649
BSD make will not build FFmpeg, you need to install and use GNU Make
650
(@file{gmake}).
651

    
652
@section Windows
653

    
654
To get help and instructions for building FFmpeg under Windows, check out
655
the FFmpeg Windows Help Forum at
656
@url{http://ffmpeg.arrozcru.org/}.
657

    
658
@subsection Native Windows compilation
659

    
660
FFmpeg can be built to run natively on Windows using the MinGW tools. Install
661
the latest versions of MSYS and MinGW from @url{http://www.mingw.org/}.
662
You can find detailed installation
663
instructions in the download section and the FAQ.
664

    
665
FFmpeg does not build out-of-the-box with the packages the automated MinGW
666
installer provides. It also requires coreutils to be installed and many other
667
packages updated to the latest version. The minimum version for some packages
668
are listed below:
669

    
670
@itemize
671
@item bash 3.1
672
@item msys-make 3.81-2 (note: not mingw32-make)
673
@item w32api 3.13
674
@item mingw-runtime 3.15
675
@end itemize
676

    
677
You will also need to pass @code{-fno-common} to the compiler to work around
678
a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
679

    
680
Within the MSYS shell, configure and make with:
681

    
682
@example
683
./configure --enable-memalign-hack --extra-cflags=-fno-common
684
make
685
make install
686
@end example
687

    
688
This will install @file{ffmpeg.exe} along with many other development files
689
to @file{/usr/local}. You may specify another install path using the
690
@code{--prefix} option in @file{configure}.
691

    
692
Notes:
693

    
694
@itemize
695

    
696
@item In order to compile FFplay, you must have the MinGW development library
697
of SDL. Get it from @url{http://www.libsdl.org}.
698
Edit the @file{bin/sdl-config} script so that it points to the correct prefix
699
where SDL was installed. Verify that @file{sdl-config} can be launched from
700
the MSYS command line.
701

    
702
@item By using @code{./configure --enable-shared} when configuring FFmpeg,
703
you can build libavutil, libavcodec and libavformat as DLLs.
704

    
705
@end itemize
706

    
707
@subsection Microsoft Visual C++ compatibility
708

    
709
As stated in the FAQ, FFmpeg will not compile under MSVC++. However, if you
710
want to use the libav* libraries in your own applications, you can still
711
compile those applications using MSVC++. But the libav* libraries you link
712
to @emph{must} be built with MinGW. However, you will not be able to debug
713
inside the libav* libraries, since MSVC++ does not recognize the debug
714
symbols generated by GCC.
715
We strongly recommend you to move over from MSVC++ to MinGW tools.
716

    
717
This description of how to use the FFmpeg libraries with MSVC++ is based on
718
Microsoft Visual C++ 2005 Express Edition. If you have a different version,
719
you might have to modify the procedures slightly.
720

    
721
@subsubsection Using static libraries
722

    
723
Assuming you have just built and installed FFmpeg in @file{/usr/local}.
724

    
725
@enumerate
726

    
727
@item Create a new console application ("File / New / Project") and then
728
select "Win32 Console Application". On the appropriate page of the
729
Application Wizard, uncheck the "Precompiled headers" option.
730

    
731
@item Write the source code for your application, or, for testing, just
732
copy the code from an existing sample application into the source file
733
that MSVC++ has already created for you. For example, you can copy
734
@file{output_example.c} from the FFmpeg distribution.
735

    
736
@item Open the "Project / Properties" dialog box. In the "Configuration"
737
combo box, select "All Configurations" so that the changes you make will
738
affect both debug and release builds. In the tree view on the left hand
739
side, select "C/C++ / General", then edit the "Additional Include
740
Directories" setting to contain the path where the FFmpeg includes were
741
installed (i.e. @file{c:\msys\1.0\local\include}).
742
Do not add MinGW's include directory here, or the include files will
743
conflict with MSVC's.
744

    
745
@item Still in the "Project / Properties" dialog box, select
746
"Linker / General" from the tree view and edit the
747
"Additional Library Directories" setting to contain the @file{lib}
748
directory where FFmpeg was installed (i.e. @file{c:\msys\1.0\local\lib}),
749
the directory where MinGW libs are installed (i.e. @file{c:\mingw\lib}),
750
and the directory where MinGW's GCC libs are installed
751
(i.e. @file{C:\mingw\lib\gcc\mingw32\4.2.1-sjlj}). Then select
752
"Linker / Input" from the tree view, and add the files @file{libavformat.a},
753
@file{libavcodec.a}, @file{libavutil.a}, @file{libmingwex.a},
754
@file{libgcc.a}, and any other libraries you used (i.e. @file{libz.a})
755
to the end of "Additional Dependencies".
756

    
757
@item Now, select "C/C++ / Code Generation" from the tree view. Select
758
"Debug" in the "Configuration" combo box. Make sure that "Runtime
759
Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
760
the "Configuration" combo box and make sure that "Runtime Library" is
761
set to "Multi-threaded DLL".
762

    
763
@item Click "OK" to close the "Project / Properties" dialog box.
764

    
765
@item MSVC++ lacks some C99 header files that are fundamental for FFmpeg.
766
Get msinttypes from @url{http://code.google.com/p/msinttypes/downloads/list}
767
and install it in MSVC++'s include directory
768
(i.e. @file{C:\Program Files\Microsoft Visual Studio 8\VC\include}).
769

    
770
@item MSVC++ also does not understand the @code{inline} keyword used by
771
FFmpeg, so you must add this line before @code{#include}ing libav*:
772
@example
773
#define inline _inline
774
@end example
775

    
776
@item Build your application, everything should work.
777

    
778
@end enumerate
779

    
780
@subsubsection Using shared libraries
781

    
782
This is how to create DLL and LIB files that are compatible with MSVC++:
783

    
784
@enumerate
785

    
786
@item Add a call to @file{vcvars32.bat} (which sets up the environment
787
variables for the Visual C++ tools) as the first line of @file{msys.bat}.
788
The standard location for @file{vcvars32.bat} is
789
@file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
790
and the standard location for @file{msys.bat} is @file{C:\msys\1.0\msys.bat}.
791
If this corresponds to your setup, add the following line as the first line
792
of @file{msys.bat}:
793

    
794
@example
795
call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"
796
@end example
797

    
798
Alternatively, you may start the @file{Visual Studio 2005 Command Prompt},
799
and run @file{c:\msys\1.0\msys.bat} from there.
800

    
801
@item Within the MSYS shell, run @code{lib.exe}. If you get a help message
802
from @file{Microsoft (R) Library Manager}, this means your environment
803
variables are set up correctly, the @file{Microsoft (R) Library Manager}
804
is on the path and will be used by FFmpeg to create
805
MSVC++-compatible import libraries.
806

    
807
@item Build FFmpeg with
808

    
809
@example
810
./configure --enable-shared --enable-memalign-hack
811
make
812
make install
813
@end example
814

    
815
Your install path (@file{/usr/local/} by default) should now have the
816
necessary DLL and LIB files under the @file{bin} directory.
817

    
818
@end enumerate
819

    
820
To use those files with MSVC++, do the same as you would do with
821
the static libraries, as described above. But in Step 4,
822
you should only need to add the directory where the LIB files are installed
823
(i.e. @file{c:\msys\usr\local\bin}). This is not a typo, the LIB files are
824
installed in the @file{bin} directory. And instead of adding @file{libxx.a}
825
files, you should add @file{avcodec.lib}, @file{avformat.lib}, and
826
@file{avutil.lib}. There should be no need for @file{libmingwex.a},
827
@file{libgcc.a}, and @file{wsock32.lib}, nor any other external library
828
statically linked into the DLLs. The @file{bin} directory contains a bunch
829
of DLL files, but the ones that are actually used to run your application
830
are the ones with a major version number in their filenames
831
(i.e. @file{avcodec-51.dll}).
832

    
833
@subsection Cross compilation for Windows with Linux
834

    
835
You must use the MinGW cross compilation tools available at
836
@url{http://www.mingw.org/}.
837

    
838
Then configure FFmpeg with the following options:
839
@example
840
./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
841
@end example
842
(you can change the cross-prefix according to the prefix chosen for the
843
MinGW tools).
844

    
845
Then you can easily test FFmpeg with Wine
846
(@url{http://www.winehq.com/}).
847

    
848
@subsection Compilation under Cygwin
849

    
850
The main issue with the 1.5.x Cygwin versions is that newlib, its C library,
851
does not contain llrint().  You need to upgrade to the unstable 1.7.x versions,
852
or leverage the implementation in MinGW (as explained below).
853

    
854
Just install your Cygwin with all the "Base" packages, plus the
855
following "Devel" ones:
856
@example
857
binutils, gcc-core, make, subversion, mingw-runtime, diffutils
858
@end example
859

    
860
The experimental gcc4 package is still buggy, hence please
861
use the official gcc 3.4.4 or a 4.2.x compiled from source by yourself.
862

    
863
Install the current binutils-20080624-2 as they work fine (the old
864
binutils-20060709-1 proved buggy on shared builds).
865

    
866
Then create a small library that just contains llrint():
867

    
868
@example
869
ar x /usr/lib/mingw/libmingwex.a llrint.o
870
ar cq /usr/local/lib/libllrint.a llrint.o
871
@end example
872

    
873
Then run
874

    
875
@example
876
./configure --enable-static --disable-shared  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
877
@end example
878

    
879
to make a static build or
880

    
881
@example
882
./configure --enable-shared --disable-static  --extra-ldflags='-L /usr/local/lib' --extra-libs='-l llrint'
883
@end example
884

    
885
to build shared libraries.
886

    
887
If you want to build FFmpeg with additional libraries, download Cygwin
888
"Devel" packages for Ogg and Vorbis from any Cygwin packages repository:
889
@example
890
libogg-devel, libvorbis-devel
891
@end example
892

    
893
These library packages are only available from Cygwin Ports
894
(@url{http://sourceware.org/cygwinports/}) :
895

    
896
@example
897
yasm, libSDL-devel, libdirac-devel, libfaac-devel, libfaad-devel, libgsm-devel,
898
libmp3lame-devel, libschroedinger1.0-devel, speex-devel, libtheora-devel,
899
libxvidcore-devel
900
@end example
901

    
902
The recommendation for libnut and x264 is to build them from source by
903
yourself, as they evolve too quickly for Cygwin Ports to be up to date.
904

    
905
Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
906
of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
907

    
908
@subsection Crosscompilation for Windows under Cygwin
909

    
910
With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
911

    
912
Just install your Cygwin as explained before, plus these additional
913
"Devel" packages:
914
@example
915
gcc-mingw-core, mingw-runtime, mingw-zlib
916
@end example
917

    
918
and add some special flags to your configure invocation.
919

    
920
For a static build run
921
@example
922
./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
923
@end example
924

    
925
and for a build with shared libraries
926
@example
927
./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
928
@end example
929

    
930
@section BeOS
931

    
932
BeOS support is broken in mysterious ways.
933

    
934
@section OS/2
935

    
936
For information about compiling FFmpeg on OS/2 see
937
@url{http://www.edm2.com/index.php/FFmpeg}.
938

    
939
@chapter Developers Guide
940

    
941
@section API
942
@itemize @bullet
943
@item libavcodec is the library containing the codecs (both encoding and
944
decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
945

    
946
@item libavformat is the library containing the file format handling (mux and
947
demux code for several formats). Look at @file{ffplay.c} to use it in a
948
player. See @file{output_example.c} to use it to generate audio or video
949
streams.
950

    
951
@end itemize
952

    
953
@section Integrating libavcodec or libavformat in your program
954

    
955
You can integrate all the source code of the libraries to link them
956
statically to avoid any version problem. All you need is to provide a
957
'config.mak' and a 'config.h' in the parent directory. See the defines
958
generated by ./configure to understand what is needed.
959

    
960
You can use libavcodec or libavformat in your commercial program, but
961
@emph{any patch you make must be published}. The best way to proceed is
962
to send your patches to the FFmpeg mailing list.
963

    
964
@node Coding Rules
965
@section Coding Rules
966

    
967
FFmpeg is programmed in the ISO C90 language with a few additional
968
features from ISO C99, namely:
969
@itemize @bullet
970
@item
971
the @samp{inline} keyword;
972
@item
973
@samp{//} comments;
974
@item
975
designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
976
@item
977
compound literals (@samp{x = (struct s) @{ 17, 23 @};})
978
@end itemize
979

    
980
These features are supported by all compilers we care about, so we will not
981
accept patches to remove their use unless they absolutely do not impair
982
clarity and performance.
983

    
984
All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
985
compiles with several other compilers, such as the Compaq ccc compiler
986
or Sun Studio 9, and we would like to keep it that way unless it would
987
be exceedingly involved. To ensure compatibility, please do not use any
988
additional C99 features or GCC extensions. Especially watch out for:
989
@itemize @bullet
990
@item
991
mixing statements and declarations;
992
@item
993
@samp{long long} (use @samp{int64_t} instead);
994
@item
995
@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
996
@item
997
GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
998
@end itemize
999

    
1000
Indent size is 4.
1001
The presentation is the one specified by 'indent -i4 -kr -nut'.
1002
The TAB character is forbidden outside of Makefiles as is any
1003
form of trailing whitespace. Commits containing either will be
1004
rejected by the Subversion repository.
1005

    
1006
The main priority in FFmpeg is simplicity and small code size in order to
1007
minimize the bug count.
1008

    
1009
Comments: Use the JavaDoc/Doxygen
1010
format (see examples below) so that code documentation
1011
can be generated automatically. All nontrivial functions should have a comment
1012
above them explaining what the function does, even if it is just one sentence.
1013
All structures and their member variables should be documented, too.
1014
@example
1015
/**
1016
 * @@file mpeg.c
1017
 * MPEG codec.
1018
 * @@author ...
1019
 */
1020

    
1021
/**
1022
 * Summary sentence.
1023
 * more text ...
1024
 * ...
1025
 */
1026
typedef struct Foobar@{
1027
    int var1; /**< var1 description */
1028
    int var2; ///< var2 description
1029
    /** var3 description */
1030
    int var3;
1031
@} Foobar;
1032

    
1033
/**
1034
 * Summary sentence.
1035
 * more text ...
1036
 * ...
1037
 * @@param my_parameter description of my_parameter
1038
 * @@return return value description
1039
 */
1040
int myfunc(int my_parameter)
1041
...
1042
@end example
1043

    
1044
fprintf and printf are forbidden in libavformat and libavcodec,
1045
please use av_log() instead.
1046

    
1047
Casts should be used only when necessary. Unneeded parentheses
1048
should also be avoided if they don't make the code easier to understand.
1049

    
1050
@section Development Policy
1051

    
1052
@enumerate
1053
@item
1054
   Contributions should be licensed under the LGPL 2.1, including an
1055
   "or any later version" clause, or the MIT license.  GPL 2 including
1056
   an "or any later version" clause is also acceptable, but LGPL is
1057
   preferred.
1058
@item
1059
   You must not commit code which breaks FFmpeg! (Meaning unfinished but
1060
   enabled code which breaks compilation or compiles but does not work or
1061
   breaks the regression tests)
1062
   You can commit unfinished stuff (for testing etc), but it must be disabled
1063
   (#ifdef etc) by default so it does not interfere with other developers'
1064
   work.
1065
@item
1066
   You do not have to over-test things. If it works for you, and you think it
1067
   should work for others, then commit. If your code has problems
1068
   (portability, triggers compiler bugs, unusual environment etc) they will be
1069
   reported and eventually fixed.
1070
@item
1071
   Do not commit unrelated changes together, split them into self-contained
1072
   pieces. Also do not forget that if part B depends on part A, but A does not
1073
   depend on B, then A can and should be committed first and separate from B.
1074
   Keeping changes well split into self-contained parts makes reviewing and
1075
   understanding them on the commit log mailing list easier. This also helps
1076
   in case of debugging later on.
1077
   Also if you have doubts about splitting or not splitting, do not hesitate to
1078
   ask/discuss it on the developer mailing list.
1079
@item
1080
   Do not change behavior of the program (renaming options etc) without
1081
   first discussing it on the ffmpeg-devel mailing list. Do not remove
1082
   functionality from the code. Just improve!
1083

    
1084
   Note: Redundant code can be removed.
1085
@item
1086
   Do not commit changes to the build system (Makefiles, configure script)
1087
   which change behavior, defaults etc, without asking first. The same
1088
   applies to compiler warning fixes, trivial looking fixes and to code
1089
   maintained by other developers. We usually have a reason for doing things
1090
   the way we do. Send your changes as patches to the ffmpeg-devel mailing
1091
   list, and if the code maintainers say OK, you may commit. This does not
1092
   apply to files you wrote and/or maintain.
1093
@item
1094
   We refuse source indentation and other cosmetic changes if they are mixed
1095
   with functional changes, such commits will be rejected and removed. Every
1096
   developer has his own indentation style, you should not change it. Of course
1097
   if you (re)write something, you can use your own style, even though we would
1098
   prefer if the indentation throughout FFmpeg was consistent (Many projects
1099
   force a given indentation style - we do not.). If you really need to make
1100
   indentation changes (try to avoid this), separate them strictly from real
1101
   changes.
1102

    
1103
   NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
1104
   then either do NOT change the indentation of the inner part within (do not
1105
   move it to the right)! or do so in a separate commit
1106
@item
1107
   Always fill out the commit log message. Describe in a few lines what you
1108
   changed and why. You can refer to mailing list postings if you fix a
1109
   particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
1110
@item
1111
   If you apply a patch by someone else, include the name and email address in
1112
   the log message. Since the ffmpeg-cvslog mailing list is publicly
1113
   archived you should add some SPAM protection to the email address. Send an
1114
   answer to ffmpeg-devel (or wherever you got the patch from) saying that
1115
   you applied the patch.
1116
@item
1117
   When applying patches that have been discussed (at length) on the mailing
1118
   list, reference the thread in the log message.
1119
@item
1120
    Do NOT commit to code actively maintained by others without permission.
1121
    Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
1122
    timeframe (12h for build failures and security fixes, 3 days small changes,
1123
    1 week for big patches) then commit your patch if you think it is OK.
1124
    Also note, the maintainer can simply ask for more time to review!
1125
@item
1126
    Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
1127
    are sent there and reviewed by all the other developers. Bugs and possible
1128
    improvements or general questions regarding commits are discussed there. We
1129
    expect you to react if problems with your code are uncovered.
1130
@item
1131
    Update the documentation if you change behavior or add features. If you are
1132
    unsure how best to do this, send a patch to ffmpeg-devel, the documentation
1133
    maintainer(s) will review and commit your stuff.
1134
@item
1135
    Try to keep important discussions and requests (also) on the public
1136
    developer mailing list, so that all developers can benefit from them.
1137
@item
1138
    Never write to unallocated memory, never write over the end of arrays,
1139
    always check values read from some untrusted source before using them
1140
    as array index or other risky things.
1141
@item
1142
    Remember to check if you need to bump versions for the specific libav
1143
    parts (libavutil, libavcodec, libavformat) you are changing. You need
1144
    to change the version integer.
1145
    Incrementing the first component means no backward compatibility to
1146
    previous versions (e.g. removal of a function from the public API).
1147
    Incrementing the second component means backward compatible change
1148
    (e.g. addition of a function to the public API or extension of an
1149
    existing data structure).
1150
    Incrementing the third component means a noteworthy binary compatible
1151
    change (e.g. encoder bug fix that matters for the decoder).
1152
@item
1153
    Compiler warnings indicate potential bugs or code with bad style. If a type of
1154
    warning always points to correct and clean code, that warning should
1155
    be disabled, not the code changed.
1156
    Thus the remaining warnings can either be bugs or correct code.
1157
    If it is a bug, the bug has to be fixed. If it is not, the code should
1158
    be changed to not generate a warning unless that causes a slowdown
1159
    or obfuscates the code.
1160
@item
1161
    If you add a new file, give it a proper license header. Do not copy and
1162
    paste it from a random place, use an existing file as template.
1163
@end enumerate
1164

    
1165
We think our rules are not too hard. If you have comments, contact us.
1166

    
1167
Note, these rules are mostly borrowed from the MPlayer project.
1168

    
1169
@section Submitting patches
1170

    
1171
First, (@pxref{Coding Rules}) above if you did not yet.
1172

    
1173
When you submit your patch, try to send a unified diff (diff '-up'
1174
option). We cannot read other diffs :-)
1175

    
1176
Also please do not submit a patch which contains several unrelated changes.
1177
Split it into separate, self-contained pieces. This does not mean splitting
1178
file by file. Instead, make the patch as small as possible while still
1179
keeping it as a logical unit that contains an individual change, even
1180
if it spans multiple files. This makes reviewing your patches much easier
1181
for us and greatly increases your chances of getting your patch applied.
1182

    
1183
Run the regression tests before submitting a patch so that you can
1184
verify that there are no big problems.
1185

    
1186
Patches should be posted as base64 encoded attachments (or any other
1187
encoding which ensures that the patch will not be trashed during
1188
transmission) to the ffmpeg-devel mailing list, see
1189
@url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
1190

    
1191
It also helps quite a bit if you tell us what the patch does (for example
1192
'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
1193
and has no lrint()')
1194

    
1195
Also please if you send several patches, send each patch as a separate mail,
1196
do not attach several unrelated patches to the same mail.
1197

    
1198
@section New codecs or formats checklist
1199

    
1200
@enumerate
1201
@item
1202
    Did you use av_cold for codec initialization and close functions?
1203
@item
1204
    Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
1205
    AVInputFormat/AVOutputFormat struct?
1206
@item
1207
    Did you bump the minor version number in @file{avcodec.h} or
1208
    @file{avformat.h}?
1209
@item
1210
    Did you register it in @file{allcodecs.c} or @file{allformats.c}?
1211
@item
1212
    Did you add the CodecID to @file{avcodec.h}?
1213
@item
1214
    If it has a fourcc, did you add it to @file{libavformat/riff.c},
1215
    even if it is only a decoder?
1216
@item
1217
    Did you add a rule to compile the appropriate files in the Makefile?
1218
    Remember to do this even if you're just adding a format to a file that is
1219
    already being compiled by some other rule, like a raw demuxer.
1220
@item
1221
    Did you add an entry to the table of supported formats or codecs in the
1222
    documentation?
1223
@item
1224
    Did you add an entry in the Changelog?
1225
@item
1226
    If it depends on a parser or a library, did you add that dependency in
1227
    configure?
1228
@item
1229
    Did you "svn add" the appropriate files before commiting?
1230
@end enumerate
1231

    
1232
@section patch submission checklist
1233

    
1234
@enumerate
1235
@item
1236
    Do the regression tests pass with the patch applied?
1237
@item
1238
    Does @code{make checkheaders} pass with the patch applied?
1239
@item
1240
    Is the patch a unified diff?
1241
@item
1242
    Is the patch against latest FFmpeg SVN?
1243
@item
1244
    Are you subscribed to ffmpeg-dev?
1245
    (the list is subscribers only due to spam)
1246
@item
1247
    Have you checked that the changes are minimal, so that the same cannot be
1248
    achieved with a smaller patch and/or simpler final code?
1249
@item
1250
    If the change is to speed critical code, did you benchmark it?
1251
@item
1252
    If you did any benchmarks, did you provide them in the mail?
1253
@item
1254
    Have you checked that the patch does not introduce buffer overflows or
1255
    other security issues?
1256
@item
1257
    Did you test your decoder or demuxer against damaged data? If no, see
1258
    tools/trasher and the noise bitstream filter. Your decoder or demuxer
1259
    should not crash or end in a (near) infinite loop when fed damaged data.
1260
@item
1261
    Is the patch created from the root of the source tree, so it can be
1262
    applied with @code{patch -p0}?
1263
@item
1264
    Does the patch not mix functional and cosmetic changes?
1265
@item
1266
    Did you add tabs or trailing whitespace to the code? Both are forbidden.
1267
@item
1268
    Is the patch attached to the email you send?
1269
@item
1270
    Is the mime type of the patch correct? It should be text/x-diff or
1271
    text/x-patch or at least text/plain and not application/octet-stream.
1272
@item
1273
    If the patch fixes a bug, did you provide a verbose analysis of the bug?
1274
@item
1275
    If the patch fixes a bug, did you provide enough information, including
1276
    a sample, so the bug can be reproduced and the fix can be verified?
1277
    Note please do not attach samples >100k to mails but rather provide a
1278
    URL, you can upload to ftp://upload.ffmpeg.org
1279
@item
1280
    Did you provide a verbose summary about what the patch does change?
1281
@item
1282
    Did you provide a verbose explanation why it changes things like it does?
1283
@item
1284
    Did you provide a verbose summary of the user visible advantages and
1285
    disadvantages if the patch is applied?
1286
@item
1287
    Did you provide an example so we can verify the new feature added by the
1288
    patch easily?
1289
@item
1290
    If you added a new file, did you insert a license header? It should be
1291
    taken from FFmpeg, not randomly copied and pasted from somewhere else.
1292
@item
1293
    You should maintain alphabetical order in alphabetically ordered lists as
1294
    long as doing so does not break API/ABI compatibility.
1295
@item
1296
    Lines with similar content should be aligned vertically when doing so
1297
    improves readability.
1298
@item
1299
    Did you provide a suggestion for a clear commit log message?
1300
@end enumerate
1301

    
1302
@section Patch review process
1303

    
1304
All patches posted to ffmpeg-devel will be reviewed, unless they contain a
1305
clear note that the patch is not for SVN.
1306
Reviews and comments will be posted as replies to the patch on the
1307
mailing list. The patch submitter then has to take care of every comment,
1308
that can be by resubmitting a changed patch or by discussion. Resubmitted
1309
patches will themselves be reviewed like any other patch. If at some point
1310
a patch passes review with no comments then it is approved, that can for
1311
simple and small patches happen immediately while large patches will generally
1312
have to be changed and reviewed many times before they are approved.
1313
After a patch is approved it will be committed to the repository.
1314

    
1315
We will review all submitted patches, but sometimes we are quite busy so
1316
especially for large patches this can take several weeks.
1317

    
1318
When resubmitting patches, please do not make any significant changes
1319
not related to the comments received during review. Such patches will
1320
be rejected. Instead, submit  significant changes or new features as
1321
separate patches.
1322

    
1323
@section Regression tests
1324

    
1325
Before submitting a patch (or committing to the repository), you should at least
1326
test that you did not break anything.
1327

    
1328
The regression tests build a synthetic video stream and a synthetic
1329
audio stream. These are then encoded and decoded with all codecs or
1330
formats. The CRC (or MD5) of each generated file is recorded in a
1331
result file. A 'diff' is launched to compare the reference results and
1332
the result file.
1333

    
1334
The regression tests then go on to test the FFserver code with a
1335
limited set of streams. It is important that this step runs correctly
1336
as well.
1337

    
1338
Run 'make test' to test all the codecs and formats.
1339

    
1340
Run 'make fulltest' to test all the codecs, formats and FFserver.
1341

    
1342
[Of course, some patches may change the results of the regression tests. In
1343
this case, the reference results of the regression tests shall be modified
1344
accordingly].
1345

    
1346
@bye