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