You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1261 lines
51KB

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