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