for more formats. None of them are used by default, their use has to be
explicitly requested by passing the appropriate flags to @file{./configure}.
-@section AMR
+@section OpenCORE AMR
-AMR comes in two different flavors, wideband and narrowband. FFmpeg can make
-use of the AMR wideband (floating-point mode) and the AMR narrowband
-(floating-point mode) reference decoders and encoders.
+FFmpeg can make use of the OpenCORE libraries for AMR-NB
+decoding/encoding and AMR-WB decoding.
-Go to @url{http://www.penguin.cz/~utx/amr} and follow the instructions for
-installing the libraries. Then pass @code{--enable-libamr-nb} and/or
-@code{--enable-libamr-wb} to configure to enable the libraries.
+Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the instructions for
+installing the libraries. Then pass @code{--enable-libopencore-amrnb} and/or
+@code{--enable-libopencore-amrwb} to configure to enable the libraries.
-Note that libamr is copyrighted without any sort of license grant. This means
-that you can use it if you legally obtained it but you are not allowed to
-redistribute it in any way. @strong{Any FFmpeg binaries with libamr support
-you create are non-free and unredistributable!}
+Note that OpenCORE is under the Apache License 2.0 (see
+@url{http://www.apache.org/licenses/LICENSE-2.0} for details), which is
+incompatible with the LGPL version 2.1 and GPL version 2. You have to
+upgrade FFmpeg's license to LGPL version 3 (or if you have enabled
+GPL components, GPL version 3) to use it.
@chapter Supported File Formats and Codecs
-You can use the @code{-formats} option to have an exhaustive list.
+You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list.
@section File Formats
@item Name @tab Encoding @tab Decoding @tab Comments
@item 4xm @tab @tab X
@tab 4X Technologies format, used in some games.
+@item 8088flex TMV @tab @tab X
@item Audio IFF (AIFF) @tab X @tab X
@item American Laser Games MM @tab @tab X
@tab Multimedia format used in games like Mad Dog McCree.
@tab Used in the game Cyberia from Interplay.
@item Delphine Software International CIN @tab @tab X
@tab Multimedia format used by Delphine Software games.
+@item Core Audio Format @tab @tab X
+ @tab Apple Core Audio Format
@item CRC testing format @tab X @tab
@item Creative Voice @tab X @tab X
@tab Created for the Sound Blaster Pro.
@tab Only embedded audio is decoded.
@item FLI/FLC/FLX animation @tab @tab X
@tab .fli/.flc files
-@item FLV @tab X @tab X
+@item Flash Video (FLV) @tab @tab X
@tab Macromedia Flash video files
@item framecrc testing format @tab X @tab
@item FunCom ISS @tab @tab X
@item GXF @tab X @tab X
@tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley
playout servers.
-@item id Cinematic @tab @tab X
- @tab Used in Quake II.
+@item id Quake II CIN video @tab @tab X
@item id RoQ @tab X @tab X
@tab Used in Quake III, Jedi Knight 2, other computer games.
+@item IEC61937 encapsulation @tab X @tab
@item IFF @tab @tab X
@tab Interchange File Format
@item Interplay MVE @tab @tab X
@item Matroska audio @tab X @tab
@item MAXIS XA @tab @tab X
@tab Used in Sim City 3000; file extension .xa.
+@item MD Studio @tab @tab X
@item Monkey's Audio @tab @tab X
@item Motion Pixels MVI @tab @tab X
@item MOV/QuickTime/MP4 @tab X @tab X
@tab 3GP, 3GP2, PSP, iPod variants supported
-@item MP2 @tab X @tab
-@item MP3 @tab X @tab
-@item MPEG audio @tab X @tab X
+@item MP2 @tab X @tab X
+@item MP3 @tab X @tab X
@item MPEG-1 System @tab X @tab X
@tab muxed audio and video, VCD format supported
@item MPEG-PS (program stream) @tab X @tab X
@tab SMPTE 386M, D-10/IMX Mapping.
@item NC camera feed @tab @tab X
@tab NC (AVIP NC4600) camera streams
+@item NTT TwinVQ (VQF) @tab @tab X
+ @tab Nippon Telegraph and Telephone Corporation TwinVQ.
@item Nullsoft Streaming Video @tab @tab X
@item NuppelVideo @tab @tab X
@item NUT @tab X @tab X
@item Ogg @tab X @tab X
@item TechnoTrend PVA @tab @tab X
@tab Used by TechnoTrend DVB PCI boards.
+@item QCP @tab @tab X
@item raw ADTS (AAC) @tab X @tab X
@item raw AC-3 @tab X @tab X
@item raw Chinese AVS video @tab @tab X
@item raw video @tab X @tab X
@item raw id RoQ @tab X @tab
@item raw Shorten @tab @tab X
+@item raw TrueHD @tab X @tab X
@item raw VC-1 @tab @tab X
@item raw PCM A-law @tab X @tab X
@item raw PCM mu-law @tab X @tab X
@item RL2 @tab @tab X
@tab Audio and video format used in some games by Entertainment Software Partners.
@item RPL/ARMovie @tab @tab X
+@item RTMP @tab @tab X
@item RTP @tab @tab X
@item RTSP @tab @tab X
@item SDP @tab @tab X
@item Sony OpenMG (OMA) @tab @tab X
@tab Audio format used in Sony Sonic Stage and Sony Vegas.
@item Sony PlayStation STR @tab @tab X
+@item Sony Wave64 (W64) @tab @tab X
+@item SoX native format @tab X @tab X
@item SUN AU format @tab X @tab X
@item THP @tab @tab X
@tab Used on the Nintendo GameCube.
@tab one raw file per component
@item animated GIF @tab X @tab X
@tab Only uncompressed GIFs are generated.
+@item BMP @tab X @tab X
+ @tab Microsoft BMP image
+@item DPX @tab @tab X
+ @tab Digital Picture Exchange
@item JPEG @tab X @tab X
@tab Progressive JPEG is not supported.
@item JPEG 2000 @tab @tab E
@tab decoding supported through external library libopenjpeg
+@item JPEG-LS @tab X @tab X
+@item LJPEG @tab X @tab
+ @tab Lossless JPEG
@item PAM @tab X @tab X
@tab PAM is a PNM extension with alpha support.
-@item PCX @tab @tab X
+@item PBM @tab X @tab X
+ @tab Portable BitMap image
+@item PCX @tab X @tab X
@tab PC Paintbrush
-@item PGM, PPM @tab X @tab X
+@item PGM @tab X @tab X
+ @tab Portable GrayMap image
@item PGMYUV @tab X @tab X
@tab PGM with U and V components in YUV 4:2:0
@item PNG @tab X @tab X
@tab 2/4 bpp not supported yet
+@item PPM @tab X @tab X
+ @tab Portable PixelMap image
@item PTX @tab @tab X
@tab V.Flash PTX format
-@item RAS @tab @tab X
- @tab Sun Rasterfile
@item SGI @tab X @tab X
@tab SGI RGB image format
-@item Targa @tab @tab X
- @tab Targa (.TGA) image format
+@item Sun Rasterfile @tab @tab X
+ @tab Sun RAS image format
@item TIFF @tab X @tab X
@tab YUV, JPEG and some extension is not supported yet.
+@item Truevision Targa @tab X @tab X
+ @tab Targa (.TGA) image format
@end multitable
@code{X} means that encoding (resp. decoding) is supported.
@multitable @columnfractions .4 .1 .1 .4
@item Name @tab Encoding @tab Decoding @tab Comments
-@item 4X Video @tab @tab X
+@item 4X Movie @tab @tab X
@tab Used in certain computer games.
+@item 8088flex TMV @tab @tab X
+@item 8SVX exponential @tab @tab X
+@item 8SVX fibonacci @tab @tab X
@item American Laser Games MM @tab @tab X
@tab Used in games like Mad Dog McCree.
-@item AMV @tab @tab X
+@item AMV Video @tab @tab X
@tab Used in Chinese MP3 players.
-@item Apple Animation @tab X @tab X
- @tab fourcc: 'rle '
-@item Apple Graphics @tab @tab X
- @tab fourcc: 'smc '
@item Apple MJPEG-B @tab @tab X
@item Apple QuickDraw @tab @tab X
@tab fourcc: qdrw
-@item Apple Video @tab @tab X
- @tab fourcc: rpza
@item Asus v1 @tab X @tab X
@tab fourcc: ASV1
@item Asus v2 @tab X @tab X
@tab fourcc: VCR1
@item ATI VCR2 @tab @tab X
@tab fourcc: VCR2
+@item Autodesk Animator Flic video @tab @tab X
@item Autodesk RLE @tab @tab X
@tab fourcc: AASC
-@item AVID DNxHD @tab X @tab X
- @tab aka SMPTE VC3
-@item AVS video @tab @tab X
+@item AVS (Audio Video Standard) video @tab @tab X
@tab Video encoding used by the Creature Shock game.
-@item Bethsoft VID @tab @tab X
+@item Beam Software VB @tab @tab X
+@item Bethesda VID video @tab @tab X
@tab Used in some games from Bethesda Softworks.
+@item Brute Force & Ignorance @tab @tab X
+ @tab Used in the game Flash Traffic: City of Angels.
@item C93 video @tab @tab X
@tab Codec used in Cyberia game.
@item CamStudio @tab @tab X
@tab fourcc: CSCD
-@item Cin video @tab @tab X
- @tab Codec used in Delphine Software games.
+@item Chinese AVS video @tab @tab X
+ @tab AVS1-P2, JiZhun profile
+@item Delphine Software International CIN video @tab @tab X
+ @tab Codec used in Delphine Software International games.
@item Cinepak @tab @tab X
@item Cirrus Logic AccuPak @tab @tab X
@tab fourcc: CLJR
-@item Creative YUV @tab @tab X
- @tab fourcc: CYUV
+@item Creative YUV (CYUV) @tab @tab X
@item Dirac @tab E @tab E
@tab supported through external libdirac/libschroedinger libraries
-@item Duck TrueMotion v1 @tab @tab X
+@item DNxHD @tab X @tab X
+ @tab aka SMPTE VC3
+@item Duck TrueMotion 1.0 @tab @tab X
@tab fourcc: DUCK
-@item Duck TrueMotion v2 @tab @tab X
+@item Duck TrueMotion 2.0 @tab @tab X
@tab fourcc: TM20
-@item DV @tab X @tab X
-@item DXA Video @tab @tab X
+@item DV (Digital Video) @tab X @tab X
+@item Feeble Files/ScummVM DXA @tab @tab X
@tab Codec originally used in Feeble Files game.
-@item Electronic Arts CMV @tab @tab X
+@item Electronic Arts CMV video @tab @tab X
@tab Used in NHL 95 game.
-@item Electronic Arts TGV @tab @tab X
-@item Electronic Arts TGQ @tab @tab X
-@item Electronic Arts TQI @tab @tab X
-@item FFmpeg Video 1 @tab X @tab X
+@item Electronic Arts Madcow video @tab @tab X
+@item Electronic Arts TGV video @tab @tab X
+@item Electronic Arts TGQ video @tab @tab X
+@item Electronic Arts TQI video @tab @tab X
+@item Escape 124 @tab @tab X
+@item FFmpeg video codec #1 @tab X @tab X
@tab experimental lossless codec (fourcc: FFV1)
-@item Flash Screen Video @tab X @tab X
+@item Flash Screen Video v1 @tab X @tab X
@tab fourcc: FSV1
-@item FLIC video @tab @tab X
-@item FLV @tab X @tab X
+@item Flash Video (FLV) @tab X @tab X
@tab Sorenson H.263 used in Flash
-@item Fraps FPS1 @tab @tab X
+@item Fraps @tab @tab X
@item H.261 @tab X @tab X
-@item H.263(+) @tab X @tab X
- @tab also known as RealVideo 1.0
-@item H.264 @tab E @tab X
+@item H.263 / H.263-1996 @tab X @tab X
+@item H.263+ / H.263-1998 / H.263 version 2 @tab X @tab X
+@item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 @tab E @tab X
@tab encoding supported through external library libx264
+@item H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (VDPAU acceleration) @tab E @tab X
@item HuffYUV @tab X @tab X
+@item HuffYUV FFmpeg variant @tab X @tab X
@item IBM Ultimotion @tab @tab X
@tab fourcc: ULTI
@item id Cinematic video @tab @tab X
@tab Used in Quake II.
-@item id RoQ @tab X @tab X
+@item id RoQ video @tab X @tab X
@tab Used in Quake III, Jedi Knight 2, other computer games.
+@item Intel H.263 @tab @tab X
+@item Intel Indeo 2 @tab @tab X
@item Intel Indeo 3 @tab @tab X
-@item Interplay Video @tab @tab X
+@item Interplay C93 @tab @tab X
+ @tab Used in the game Cyberia from Interplay.
+@item Interplay MVE video @tab @tab X
@tab Used in Interplay .MVE files.
-@item JPEG-LS @tab X @tab X
- @tab fourcc: MJLS, lossless and near-lossless is supported.
-@item KMVC @tab @tab X
+@item Karl Morton's video codec @tab @tab X
@tab Codec used in Worms games.
+@item LCL (LossLess Codec Library) MSZH @tab @tab X
+@item LCL (LossLess Codec Library) ZLIB @tab E @tab E
@item LOCO @tab @tab X
@item lossless MJPEG @tab X @tab X
@item Microsoft RLE @tab @tab X
-@item Microsoft Video-1 @tab @tab X
+@item Microsoft Video 1 @tab @tab X
@item Mimic @tab @tab X
@tab Used in MSN Messenger Webcam streams.
@item Miro VideoXL @tab @tab X
@tab fourcc: VIXL
-@item MJPEG @tab X @tab X
-@item Motion Pixels Video @tab @tab X
-@item MPEG-1 @tab X @tab X
-@item MPEG-2 @tab X @tab X
-@item MPEG-4 @tab X @tab X
-@item MSMPEG4 V1 @tab X @tab X
-@item MSMPEG4 V2 @tab X @tab X
-@item MSMPEG4 V3 @tab X @tab X
-@item MSZH @tab @tab X
- @tab Part of LCL
+@item MJPEG (Motion JPEG) @tab X @tab X
+@item Motion Pixels video @tab @tab X
+@item MPEG-1 video @tab X @tab X
+@item MPEG-1/2 video XvMC (X-Video Motion Compensation) @tab @tab X
+@item MPEG-1/2 video (VDPAU acceleration) @tab @tab X
+@item MPEG-2 video @tab X @tab X
+@item MPEG-4 part 2 @tab X @tab X
+ @ libxvidcore can be used alternatively for encoding.
+@item MPEG-4 part 2 Microsoft variant version 1 @tab X @tab X
+@item MPEG-4 part 2 Microsoft variant version 2 @tab X @tab X
+@item MPEG-4 part 2 Microsoft variant version 3 @tab X @tab X
+@item Nintendo Gamecube THP video @tab @tab X
+@item NuppelVideo/RTjpeg @tab @tab X
+ @tab Video encoding used in NuppelVideo files.
@item On2 VP3 @tab @tab X
@tab still experimental
@item On2 VP5 @tab @tab X
@tab fourcc: VP60,VP61,VP62
@item planar RGB @tab @tab X
@tab fourcc: 8BPS
-@item QPEG @tab @tab X
+@item Q-team QPEG @tab @tab X
@tab fourccs: QPEG, Q1.0, Q1.1
+@item QuickTime 8BPS video @tab @tab X
+@item QuickTime Animation (RLE) video @tab X @tab X
+ @tab fourcc: 'rle '
+@item QuickTime Graphics (SMC) @tab @tab X
+ @tab fourcc: 'smc '
+@item QuickTime video (RPZA) @tab @tab X
+ @tab fourcc: rpza
+@item Raw Video @tab X @tab X
@item RealVideo 1.0 @tab X @tab X
@item RealVideo 2.0 @tab X @tab X
@item RealVideo 3.0 @tab @tab X
@tab still far from ideal
@item RealVideo 4.0 @tab @tab X
-@item Renderware TXD @tab @tab X
+@item Renderware TXD (TeXture Dictionary) @tab @tab X
@tab Texture dictionaries used by the Renderware Engine.
-@item RTjpeg @tab @tab X
- @tab Video encoding used in NuppelVideo files.
+@item RL2 video @tab @tab X
+ @tab used in some games by Entertainment Software Partners
+@item Sierra VMD video @tab @tab X
+ @tab Used in Sierra VMD files.
@item Smacker video @tab @tab X
@tab Video encoding used in Smacker.
+@item SMPTE VC-1 @tab @tab X
@item Snow @tab X @tab X
@tab experimental wavelet codec (fourcc: SNOW)
-@item Sony PlayStation MDEC @tab @tab X
-@item Sorenson Video 1 @tab X @tab X
+@item Sony PlayStation MDEC (Motion DECoder) @tab @tab X
+@item Sorenson Vector Quantizer 1 @tab X @tab X
@tab fourcc: SVQ1
-@item Sorenson Video 3 @tab @tab X
+@item Sorenson Vector Quantizer 3 @tab @tab X
@tab fourcc: SVQ3
-@item Sunplus MJPEG @tab @tab X
+@item Sunplus JPEG (SP5X) @tab @tab X
@tab fourcc: SP5X
-@item TechSmith Camtasia @tab @tab X
+@item TechSmith Screen Capture Codec @tab @tab X
@tab fourcc: TSCC
@item Theora @tab E @tab X
@tab encoding supported through external library libtheora
-@item THP @tab @tab X
- @tab Used on the Nintendo GameCube.
-@item Tiertex Seq video @tab @tab X
+@item Tiertex Limited SEQ video @tab @tab X
@tab Codec used in DOS CD-ROM FlashBack game.
-@item VC-1 @tab @tab X
-@item VMD Video @tab @tab X
- @tab Used in Sierra VMD files.
-@item VMware Video @tab @tab X
+@item V210 Quicktime Uncompressed 4:2:2 10-bit @tab X @tab X
+@item VMware Screen Codec / VMware Video @tab @tab X
@tab Codec used in videos captured by VMware.
-@item Westwood VQA @tab @tab X
-@item Winnov WNV1 @tab @tab X
-@item WMV7 @tab X @tab X
-@item WMV8 @tab X @tab X
-@item WMV9 @tab @tab X
+@item Westwood Studios VQA (Vector Quantized Animation) video @tab @tab X
+@item Windows Media Video 7 @tab X @tab X
+@item Windows Media Video 8 @tab X @tab X
+@item Windows Media Video 9 @tab @tab X
@tab not completely working
-@item Xan/WC3 @tab @tab X
+@item Wing Commander III / Xan @tab @tab X
@tab Used in Wing Commander III .MVE files.
+@item Winnov WNV1 @tab @tab X
+@item WMV7 @tab X @tab X
@item YAMAHA SMAF @tab X @tab X
@item ZLIB @tab X @tab X
@tab part of LCL, encoder experimental
-@item ZMBV @tab X @tab X
+@item Zip Motion Blocks Video @tab X @tab X
@tab Encoder works only in PAL8.
@end multitable
@multitable @columnfractions .4 .1 .1 .4
@item Name @tab Encoding @tab Decoding @tab Comments
-@item 4X IMA ADPCM @tab @tab X
@item 8SVX audio @tab @tab X
@item AAC @tab E @tab X
@tab encoding supported through external library libfaac
-@item AC-3 @tab IX @tab IX
-@item AMR-NB @tab E @tab E
- @tab supported through external library libamrnb
-@item AMR-WB @tab E @tab E
- @tab supported through external library libamrwb
-@item AMV IMA ADPCM @tab @tab X
+@item AC-3 @tab IX @tab X
+@item ADPCM 4X Movie @tab @tab X
+@item ADPCM CDROM XA @tab @tab X
+@item ADPCM Creative Technology @tab @tab X
+ @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
+@item ADPCM Electronic Arts @tab @tab X
+ @tab Used in various EA titles.
+@item ADPCM Electronic Arts Maxis CDROM XS @tab @tab X
+ @tab Used in Sim City 3000.
+@item ADPCM Electronic Arts R1 @tab @tab X
+@item ADPCM Electronic Arts R2 @tab @tab X
+@item ADPCM Electronic Arts R3 @tab @tab X
+@item ADPCM Electronic Arts XAS @tab @tab X
+@item ADPCM G.726 @tab X @tab X
+@item ADPCM IMA AMV @tab @tab X
@tab Used in AMV files
+@item ADPCM IMA Electronic Arts EACS @tab @tab X
+@item ADPCM IMA Electronic Arts SEAD @tab @tab X
+@item ADPCM IMA Funcom @tab @tab X
+@item ADPCM IMA QuickTime @tab X @tab X
+@item ADPCM IMA Loki SDL MJPEG @tab @tab X
+@item ADPCM IMA WAV @tab X @tab X
+@item ADPCM IMA Westwood @tab @tab X
+@item ADPCM ISS IMA @tab @tab X
+ @tab Used in FunCom games.
+@item ADPCM IMA Duck DK3 @tab @tab X
+ @tab Used in some Sega Saturn console games.
+@item ADPCM IMA Duck DK4 @tab @tab X
+ @tab Used in some Sega Saturn console games.
+@item ADPCM Microsoft @tab X @tab X
+@item ADPCM MS IMA @tab X @tab X
+@item ADPCM Nintendo Gamecube THP @tab @tab X
+@item ADPCM QT IMA @tab X @tab X
+@item ADPCM SEGA CRI ADX @tab X @tab X
+ @tab Used in Sega Dreamcast games.
+@item ADPCM Shockwave Flash @tab X @tab X
+@item ADPCM SMJPEG IMA @tab @tab X
+ @tab Used in certain Loki game ports.
+@item ADPCM Sound Blaster Pro 2-bit @tab @tab X
+@item ADPCM Sound Blaster Pro 2.6-bit @tab @tab X
+@item ADPCM Sound Blaster Pro 4-bit @tab @tab X
+@item ADPCM Westwood Studios IMA @tab @tab X
+ @tab Used in Westwood Studios games like Command and Conquer.
+@item ADPCM Yamaha @tab X @tab X
+@item AMR-NB @tab E @tab E
+ @tab supported through external library libopencore-amrnb
+@item AMR-WB @tab @tab E
+ @tab decoding supported through external library libopencore-amrwb
@item Apple lossless audio @tab X @tab X
@tab QuickTime fourcc 'alac'
-@item Apple MACE 3 @tab @tab X
-@item Apple MACE 6 @tab @tab X
-@item ATRAC 3 @tab @tab X
-@item CD-ROM XA ADPCM @tab @tab X
-@item Cin audio @tab @tab X
+@item Atrac 1 @tab @tab X
+@item Atrac 3 @tab @tab X
+@item Delphine Software International CIN audio @tab @tab X
@tab Codec used in Delphine Software International games.
-@item Creative ADPCM @tab @tab X
- @tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
-@item CRI ADX ADPCM @tab X @tab X
- @tab Used in Sega Dreamcast games.
+@item COOK @tab @tab X
+ @tab All versions except 5.1 are supported.
+@item DCA (DTS Coherent Acoustics) @tab @tab X
+@item DPCM id RoQ @tab X @tab X
+ @tab Used in Quake III, Jedi Knight 2, other computer games.
+@item DPCM Interplay @tab @tab X
+ @tab Used in various Interplay computer games.
+@item DPCM Sierra Online @tab @tab X
+ @tab Used in Sierra Online game audio files.
+@item DPCM Sol @tab @tab X
+@item DPCM Xan @tab @tab X
+ @tab Used in Origin's Wing Commander IV AVI files.
@item DSP Group TrueSpeech @tab @tab X
-@item DTS Coherent Audio @tab @tab X
-@item Duck DK3 IMA ADPCM @tab @tab X
- @tab Used in some Sega Saturn console games.
-@item Duck DK4 IMA ADPCM @tab @tab X
- @tab Used in some Sega Saturn console games.
@item DV audio @tab @tab X
-@item Electronic Arts ADPCM @tab @tab X
- @tab Used in various EA titles.
@item Enhanced AC-3 @tab @tab X
-@item FLAC lossless audio @tab IX @tab X
-@item G.726 ADPCM @tab X @tab X
+@item FLAC (Free Lossless Audio Codec) @tab X @tab IX
+@item G.729 @tab @tab X
@item GSM @tab E @tab E
@tab supported through external library libgsm
-@item GSM_MS @tab E @tab E
+@item GSM Microsoft variant @tab E @tab E
@tab supported through external library libgsm
-@item id RoQ DPCM @tab X @tab X
- @tab Used in Quake III, Jedi Knight 2, other computer games.
-@item Intel Music Coder @tab @tab X
-@item Interplay MVE DPCM @tab @tab X
- @tab Used in various Interplay computer games.
-@item ISS IMA ADPCM @tab @tab X
- @tab Used in FunCom games.
-@item MAXIS EA ADPCM @tab @tab X
- @tab Used in Sim City 3000.
-@item Microsoft ADPCM @tab X @tab X
-@item MLP/TrueHD @tab @tab X
- @tab Used in DVD-Audio and Blu-Ray discs.
+@item IMC (Intel Music Coder) @tab @tab X
+@item MACE (Macintosh Audio Compression/Expansion) 3:1 @tab @tab X
+@item MACE (Macintosh Audio Compression/Expansion) 6:1 @tab @tab X
+@item MLP (Meridian Lossless Packing) @tab @tab X
+ @tab Used in DVD-Audio discs.
@item Monkey's Audio @tab @tab X
@tab Only versions 3.97-3.99 are supported.
-@item MPEG audio layer 3 @tab E @tab IX
- @tab encoding supported through external library LAME
-@item MPEG audio layer 2 @tab IX @tab IX
-@item MS IMA ADPCM @tab X @tab X
-@item Musepack @tab @tab X
- @tab SV7 and SV8 are supported.
-@item Nellymoser ASAO @tab X @tab X
+@item MP1 (MPEG audio layer 1) @tab @tab IX
+@item MP2 (MPEG audio layer 2) @tab IX @tab IX
+@item MP3 (MPEG audio layer 3) @tab E @tab IX
+ @tab encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
+@item MPEG-4 Audio Lossless Coding (ALS) @tab @tab X
+@item Musepack SV7 @tab @tab X
+@item Musepack SV8 @tab @tab X
+@item Nellymoser Asao @tab X @tab X
+@item PCM A-law @tab X @tab X
+@item PCM mu-law @tab X @tab X
+@item PCM 16-bit little-endian planar @tab @tab X
+@item PCM 32-bit floating point big-endian @tab X @tab X
+@item PCM 32-bit floating point little-endian @tab X @tab X
+@item PCM 64-bit floating point big-endian @tab X @tab X
+@item PCM 64-bit floating point little-endian @tab X @tab X
+@item PCM D-Cinema audio signed 24-bit @tab X @tab X
+@item PCM signed 8-bit @tab X @tab X
+@item PCM signed 16-bit big-endian @tab X @tab X
+@item PCM signed 16-bit little-endian @tab X @tab X
+@item PCM signed 24-bit big-endian @tab X @tab X
+@item PCM signed 24-bit little-endian @tab X @tab X
+@item PCM signed 32-bit big-endian @tab X @tab X
+@item PCM signed 32-bit little-endian @tab X @tab X
+@item PCM signed 16/20/24-bit big-endian in MPEG-TS @tab @tab X
+@item PCM unsigned 8-bit @tab X @tab X
+@item PCM unsigned 16-bit big-endian @tab X @tab X
+@item PCM unsigned 16-bit little-endian @tab X @tab X
+@item PCM unsigned 24-bit big-endian @tab X @tab X
+@item PCM unsigned 24-bit little-endian @tab X @tab X
+@item PCM unsigned 32-bit big-endian @tab X @tab X
+@item PCM unsigned 32-bit little-endian @tab X @tab X
+@item PCM Zork @tab X @tab X
@item QCELP / PureVoice @tab @tab X
-@item Qdesign QDM2 @tab @tab X
+@item QDesign Music Codec 2 @tab @tab X
@tab There are still some distortions.
-@item QT IMA ADPCM @tab X @tab X
-@item RA144 @tab @tab X
+@item RealAudio 1.0 (14.4K) @tab @tab X
@tab Real 14400 bit/s codec
-@item RA288 @tab @tab X
+@item RealAudio 2.0 (28.8K) @tab @tab X
@tab Real 28800 bit/s codec
-@item RADnet @tab IX @tab IX
+@item RealAudio 3.0 (dnet) @tab IX @tab X
@tab Real low bitrate AC-3 codec
-@item Real COOK @tab @tab X
- @tab All versions except 5.1 are supported.
@item Shorten @tab @tab X
-@item Sierra Online DPCM @tab @tab X
- @tab Used in Sierra Online game audio files.
+@item Sierra VMD audio @tab @tab X
+ @tab Used in Sierra VMD files.
@item Smacker audio @tab @tab X
-@item SMJPEG IMA ADPCM @tab @tab X
- @tab Used in certain Loki game ports.
@item Sonic @tab X @tab X
@tab experimental codec
@item Sonic lossless @tab X @tab X
@tab experimental codec
@item Speex @tab @tab E
@tab supported through external library libspeex
-@item THP ADPCM @tab @tab X
- @tab Used on the Nintendo GameCube.
@item True Audio (TTA) @tab @tab X
-@item Vorbis @tab X @tab X
+@item TrueHD @tab @tab X
+ @tab Used in HD-DVD and Blu-Ray discs.
+@item TwinVQ (VQF flavor) @tab @tab X
+@item Vorbis @tab E @tab X
+ @ A native but very primitive encoder exists.
@item WavPack @tab @tab X
-@item Westwood Studios IMA ADPCM @tab @tab X
- @tab Used in Westwood Studios games like Command and Conquer.
-@item WMA v1/v2 @tab X @tab X
-@item Xan DPCM @tab @tab X
- @tab Used in Origin's Wing Commander IV AVI files.
+@item Westwood Audio (SND1) @tab @tab X
+@item Windows Media Audio 1 @tab X @tab X
+@item Windows Media Audio 2 @tab X @tab X
+@item Windows Media Audio Pro @tab @tab X
@end multitable
@code{X} means that encoding (resp. decoding) is supported.
@section Subtitle Formats
-@multitable @columnfractions .4 .1 .1 .1 .1 .1
+@multitable @columnfractions .4 .1 .1 .1 .1
@item Name @tab Muxing @tab Demuxing @tab Encoding @tab Decoding
@item SSA/ASS @tab X @tab X
@item DVB @tab X @tab X @tab X @tab X
@item DVD @tab X @tab X @tab X @tab X
-@item XSUB @tab @tab @tab @tab X
+@item PGS @tab @tab @tab @tab X
+@item XSUB @tab @tab @tab X @tab X
@end multitable
@code{X} means that the feature is supported.
@section Network Protocols
-@multitable @columnfractions .4 .1 .1 .1 .1 .1
+@multitable @columnfractions .4 .1
@item Name @tab Support
@item file @tab X
@item Gopher @tab X
@code{X} means that the protocol is supported.
+@section Input/Output Devices
+
+@multitable @columnfractions .4 .1 .1
+@item Name @tab Input @tab Output
+@item ALSA @tab X @tab X
+@item BEOS audio @tab X @tab X
+@item BKTR @tab X @tab
+@item DV1394 @tab X @tab
+@item JACK @tab X @tab
+@item LIBDC1394 @tab X @tab
+@item OSS @tab X @tab X
+@item Video4Linux @tab X @tab
+@item Video4Linux2 @tab X @tab
+@item VfW capture @tab X @tab
+@item X11 grabbing @tab X @tab
+@end multitable
+
+@code{X} means that input/output is supported.
+
+
@chapter Platform Specific information
@section BSD
@item mingw-runtime 3.15
@end itemize
-You will also need to pass @code{-fno-common} to the compiler to work around
+FFmpeg automatically passes @code{-fno-common} to the compiler to work around
a GCC bug (see @url{http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216}).
Within the MSYS shell, configure and make with:
@example
-./configure --enable-memalign-hack --extra-cflags=-fno-common
+./configure --enable-memalign-hack
make
make install
@end example
@itemize
-@item In order to compile vhooks, you must have a POSIX-compliant libdl in
-your MinGW system. Get dlfcn-win32 from
-@url{http://code.google.com/p/dlfcn-win32}.
+@item Building natively using MSYS can be sped up by disabling implicit rules
+in the Makefile by calling @code{make -r} instead of plain @code{make}. This
+speed up is close to non-existent for normal one-off builds and is only
+noticeable when running make for a second time (for example in
+@code{make install}).
@item In order to compile FFplay, you must have the MinGW development library
of SDL. Get it from @url{http://www.libsdl.org}.
@item Write the source code for your application, or, for testing, just
copy the code from an existing sample application into the source file
that MSVC++ has already created for you. For example, you can copy
-@file{output_example.c} from the FFmpeg distribution.
+@file{libavformat/output-example.c} from the FFmpeg distribution.
@item Open the "Project / Properties" dialog box. In the "Configuration"
combo box, select "All Configurations" so that the changes you make will
Just install your Cygwin with all the "Base" packages, plus the
following "Devel" ones:
@example
-binutils, gcc-core, make, subversion, mingw-runtime, diffutils
+binutils, gcc-core, make, subversion, mingw-runtime
+@end example
+
+And the following "Utils" one:
+@example
+diffutils
@end example
The experimental gcc4 package is still buggy, hence please
For information about compiling FFmpeg on OS/2 see
@url{http://www.edm2.com/index.php/FFmpeg}.
-@chapter Developers Guide
-
-@section API
-@itemize @bullet
-@item libavcodec is the library containing the codecs (both encoding and
-decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
-
-@item libavformat is the library containing the file format handling (mux and
-demux code for several formats). Look at @file{ffplay.c} to use it in a
-player. See @file{output_example.c} to use it to generate audio or video
-streams.
-
-@end itemize
-
-@section Integrating libavcodec or libavformat in your program
-
-You can integrate all the source code of the libraries to link them
-statically to avoid any version problem. All you need is to provide a
-'config.mak' and a 'config.h' in the parent directory. See the defines
-generated by ./configure to understand what is needed.
-
-You can use libavcodec or libavformat in your commercial program, but
-@emph{any patch you make must be published}. The best way to proceed is
-to send your patches to the FFmpeg mailing list.
-
-@node Coding Rules
-@section Coding Rules
-
-FFmpeg is programmed in the ISO C90 language with a few additional
-features from ISO C99, namely:
-@itemize @bullet
-@item
-the @samp{inline} keyword;
-@item
-@samp{//} comments;
-@item
-designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
-@item
-compound literals (@samp{x = (struct s) @{ 17, 23 @};})
-@end itemize
-
-These features are supported by all compilers we care about, so we will not
-accept patches to remove their use unless they absolutely do not impair
-clarity and performance.
-
-All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
-compiles with several other compilers, such as the Compaq ccc compiler
-or Sun Studio 9, and we would like to keep it that way unless it would
-be exceedingly involved. To ensure compatibility, please do not use any
-additional C99 features or GCC extensions. Especially watch out for:
-@itemize @bullet
-@item
-mixing statements and declarations;
-@item
-@samp{long long} (use @samp{int64_t} instead);
-@item
-@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
-@item
-GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
-@end itemize
-
-Indent size is 4.
-The presentation is the one specified by 'indent -i4 -kr -nut'.
-The TAB character is forbidden outside of Makefiles as is any
-form of trailing whitespace. Commits containing either will be
-rejected by the Subversion repository.
-
-The main priority in FFmpeg is simplicity and small code size in order to
-minimize the bug count.
-
-Comments: Use the JavaDoc/Doxygen
-format (see examples below) so that code documentation
-can be generated automatically. All nontrivial functions should have a comment
-above them explaining what the function does, even if it is just one sentence.
-All structures and their member variables should be documented, too.
-@example
-/**
- * @@file mpeg.c
- * MPEG codec.
- * @@author ...
- */
-
-/**
- * Summary sentence.
- * more text ...
- * ...
- */
-typedef struct Foobar@{
- int var1; /**< var1 description */
- int var2; ///< var2 description
- /** var3 description */
- int var3;
-@} Foobar;
-
-/**
- * Summary sentence.
- * more text ...
- * ...
- * @@param my_parameter description of my_parameter
- * @@return return value description
- */
-int myfunc(int my_parameter)
-...
-@end example
-
-fprintf and printf are forbidden in libavformat and libavcodec,
-please use av_log() instead.
-
-Casts should be used only when necessary. Unneeded parentheses
-should also be avoided if they don't make the code easier to understand.
-
-@section Development Policy
-
-@enumerate
-@item
- Contributions should be licensed under the LGPL 2.1, including an
- "or any later version" clause, or the MIT license. GPL 2 including
- an "or any later version" clause is also acceptable, but LGPL is
- preferred.
-@item
- You must not commit code which breaks FFmpeg! (Meaning unfinished but
- enabled code which breaks compilation or compiles but does not work or
- breaks the regression tests)
- You can commit unfinished stuff (for testing etc), but it must be disabled
- (#ifdef etc) by default so it does not interfere with other developers'
- work.
-@item
- You do not have to over-test things. If it works for you, and you think it
- should work for others, then commit. If your code has problems
- (portability, triggers compiler bugs, unusual environment etc) they will be
- reported and eventually fixed.
-@item
- Do not commit unrelated changes together, split them into self-contained
- pieces. Also do not forget that if part B depends on part A, but A does not
- depend on B, then A can and should be committed first and separate from B.
- Keeping changes well split into self-contained parts makes reviewing and
- understanding them on the commit log mailing list easier. This also helps
- in case of debugging later on.
- Also if you have doubts about splitting or not splitting, do not hesitate to
- ask/discuss it on the developer mailing list.
-@item
- Do not change behavior of the program (renaming options etc) without
- first discussing it on the ffmpeg-devel mailing list. Do not remove
- functionality from the code. Just improve!
-
- Note: Redundant code can be removed.
-@item
- Do not commit changes to the build system (Makefiles, configure script)
- which change behavior, defaults etc, without asking first. The same
- applies to compiler warning fixes, trivial looking fixes and to code
- maintained by other developers. We usually have a reason for doing things
- the way we do. Send your changes as patches to the ffmpeg-devel mailing
- list, and if the code maintainers say OK, you may commit. This does not
- apply to files you wrote and/or maintain.
-@item
- We refuse source indentation and other cosmetic changes if they are mixed
- with functional changes, such commits will be rejected and removed. Every
- developer has his own indentation style, you should not change it. Of course
- if you (re)write something, you can use your own style, even though we would
- prefer if the indentation throughout FFmpeg was consistent (Many projects
- force a given indentation style - we do not.). If you really need to make
- indentation changes (try to avoid this), separate them strictly from real
- changes.
-
- NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
- then either do NOT change the indentation of the inner part within (do not
- move it to the right)! or do so in a separate commit
-@item
- Always fill out the commit log message. Describe in a few lines what you
- changed and why. You can refer to mailing list postings if you fix a
- particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
-@item
- If you apply a patch by someone else, include the name and email address in
- the log message. Since the ffmpeg-cvslog mailing list is publicly
- archived you should add some SPAM protection to the email address. Send an
- answer to ffmpeg-devel (or wherever you got the patch from) saying that
- you applied the patch.
-@item
- When applying patches that have been discussed (at length) on the mailing
- list, reference the thread in the log message.
-@item
- Do NOT commit to code actively maintained by others without permission.
- Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
- timeframe (12h for build failures and security fixes, 3 days small changes,
- 1 week for big patches) then commit your patch if you think it is OK.
- Also note, the maintainer can simply ask for more time to review!
-@item
- Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
- are sent there and reviewed by all the other developers. Bugs and possible
- improvements or general questions regarding commits are discussed there. We
- expect you to react if problems with your code are uncovered.
-@item
- Update the documentation if you change behavior or add features. If you are
- unsure how best to do this, send a patch to ffmpeg-devel, the documentation
- maintainer(s) will review and commit your stuff.
-@item
- Try to keep important discussions and requests (also) on the public
- developer mailing list, so that all developers can benefit from them.
-@item
- Never write to unallocated memory, never write over the end of arrays,
- always check values read from some untrusted source before using them
- as array index or other risky things.
-@item
- Remember to check if you need to bump versions for the specific libav
- parts (libavutil, libavcodec, libavformat) you are changing. You need
- to change the version integer.
- Incrementing the first component means no backward compatibility to
- previous versions (e.g. removal of a function from the public API).
- Incrementing the second component means backward compatible change
- (e.g. addition of a function to the public API or extension of an
- existing data structure).
- Incrementing the third component means a noteworthy binary compatible
- change (e.g. encoder bug fix that matters for the decoder).
-@item
- Compiler warnings indicate potential bugs or code with bad style. If a type of
- warning always points to correct and clean code, that warning should
- be disabled, not the code changed.
- Thus the remaining warnings can either be bugs or correct code.
- If it is a bug, the bug has to be fixed. If it is not, the code should
- be changed to not generate a warning unless that causes a slowdown
- or obfuscates the code.
-@item
- If you add a new file, give it a proper license header. Do not copy and
- paste it from a random place, use an existing file as template.
-@end enumerate
-
-We think our rules are not too hard. If you have comments, contact us.
-
-Note, these rules are mostly borrowed from the MPlayer project.
-
-@section Submitting patches
-
-First, (@pxref{Coding Rules}) above if you did not yet.
-
-When you submit your patch, try to send a unified diff (diff '-up'
-option). We cannot read other diffs :-)
-
-Also please do not submit a patch which contains several unrelated changes.
-Split it into separate, self-contained pieces. This does not mean splitting
-file by file. Instead, make the patch as small as possible while still
-keeping it as a logical unit that contains an individual change, even
-if it spans multiple files. This makes reviewing your patches much easier
-for us and greatly increases your chances of getting your patch applied.
-
-Run the regression tests before submitting a patch so that you can
-verify that there are no big problems.
-
-Patches should be posted as base64 encoded attachments (or any other
-encoding which ensures that the patch will not be trashed during
-transmission) to the ffmpeg-devel mailing list, see
-@url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
-
-It also helps quite a bit if you tell us what the patch does (for example
-'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
-and has no lrint()')
-
-Also please if you send several patches, send each patch as a separate mail,
-do not attach several unrelated patches to the same mail.
-
-@section New codecs or formats checklist
-
-@enumerate
-@item
- Did you use av_cold for codec initialization and close functions?
-@item
- Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
- AVInputFormat/AVOutputFormat struct?
-@item
- Did you bump the minor version number in @file{avcodec.h} or
- @file{avformat.h}?
-@item
- Did you register it in @file{allcodecs.c} or @file{allformats.c}?
-@item
- Did you add the CodecID to @file{avcodec.h}?
-@item
- If it has a fourcc, did you add it to @file{libavformat/riff.c},
- even if it is only a decoder?
-@item
- Did you add a rule to compile the appropriate files in the Makefile?
- Remember to do this even if you're just adding a format to a file that is
- already being compiled by some other rule, like a raw demuxer.
-@item
- Did you add an entry to the table of supported formats or codecs in the
- documentation?
-@item
- Did you add an entry in the Changelog?
-@item
- If it depends on a parser or a library, did you add that dependency in
- configure?
-@item
- Did you "svn add" the appropriate files before commiting?
-@end enumerate
-
-@section patch submission checklist
-
-@enumerate
-@item
- Do the regression tests pass with the patch applied?
-@item
- Does @code{make checkheaders} pass with the patch applied?
-@item
- Is the patch a unified diff?
-@item
- Is the patch against latest FFmpeg SVN?
-@item
- Are you subscribed to ffmpeg-dev?
- (the list is subscribers only due to spam)
-@item
- Have you checked that the changes are minimal, so that the same cannot be
- achieved with a smaller patch and/or simpler final code?
-@item
- If the change is to speed critical code, did you benchmark it?
-@item
- If you did any benchmarks, did you provide them in the mail?
-@item
- Have you checked that the patch does not introduce buffer overflows or
- other security issues?
-@item
- Did you test your decoder or demuxer against damaged data? If no, see
- tools/trasher and the noise bitstream filter. Your decoder or demuxer
- should not crash or end in a (near) infinite loop when fed damaged data.
-@item
- Is the patch created from the root of the source tree, so it can be
- applied with @code{patch -p0}?
-@item
- Does the patch not mix functional and cosmetic changes?
-@item
- Did you add tabs or trailing whitespace to the code? Both are forbidden.
-@item
- Is the patch attached to the email you send?
-@item
- Is the mime type of the patch correct? It should be text/x-diff or
- text/x-patch or at least text/plain and not application/octet-stream.
-@item
- If the patch fixes a bug, did you provide a verbose analysis of the bug?
-@item
- If the patch fixes a bug, did you provide enough information, including
- a sample, so the bug can be reproduced and the fix can be verified?
- Note please do not attach samples >100k to mails but rather provide a
- URL, you can upload to ftp://upload.ffmpeg.org
-@item
- Did you provide a verbose summary about what the patch does change?
-@item
- Did you provide a verbose explanation why it changes things like it does?
-@item
- Did you provide a verbose summary of the user visible advantages and
- disadvantages if the patch is applied?
-@item
- Did you provide an example so we can verify the new feature added by the
- patch easily?
-@item
- If you added a new file, did you insert a license header? It should be
- taken from FFmpeg, not randomly copied and pasted from somewhere else.
-@item
- You should maintain alphabetical order in alphabetically ordered lists as
- long as doing so does not break API/ABI compatibility.
-@item
- Lines with similar content should be aligned vertically when doing so
- improves readability.
-@item
- Did you provide a suggestion for a clear commit log message?
-@end enumerate
-
-@section Patch review process
-
-All patches posted to ffmpeg-devel will be reviewed, unless they contain a
-clear note that the patch is not for SVN.
-Reviews and comments will be posted as replies to the patch on the
-mailing list. The patch submitter then has to take care of every comment,
-that can be by resubmitting a changed patch or by discussion. Resubmitted
-patches will themselves be reviewed like any other patch. If at some point
-a patch passes review with no comments then it is approved, that can for
-simple and small patches happen immediately while large patches will generally
-have to be changed and reviewed many times before they are approved.
-After a patch is approved it will be committed to the repository.
-
-We will review all submitted patches, but sometimes we are quite busy so
-especially for large patches this can take several weeks.
-
-When resubmitting patches, please do not make any significant changes
-not related to the comments received during review. Such patches will
-be rejected. Instead, submit significant changes or new features as
-separate patches.
-
-@section Regression tests
-
-Before submitting a patch (or committing to the repository), you should at least
-test that you did not break anything.
-
-The regression tests build a synthetic video stream and a synthetic
-audio stream. These are then encoded and decoded with all codecs or
-formats. The CRC (or MD5) of each generated file is recorded in a
-result file. A 'diff' is launched to compare the reference results and
-the result file.
-
-The regression tests then go on to test the FFserver code with a
-limited set of streams. It is important that this step runs correctly
-as well.
-
-Run 'make test' to test all the codecs and formats.
-
-Run 'make fulltest' to test all the codecs, formats and FFserver.
-
-[Of course, some patches may change the results of the regression tests. In
-this case, the reference results of the regression tests shall be modified
-accordingly].
-
@bye
projects / frescor / ffmpeg.git / blobdiff