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.

3024 lines
93KB

  1. /*
  2. * copyright (c) 2001 Fabrice Bellard
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef FFMPEG_AVCODEC_H
  21. #define FFMPEG_AVCODEC_H
  22. /**
  23. * @file avcodec.h
  24. * external API header
  25. */
  26. #include "libavutil/avutil.h"
  27. #define LIBAVCODEC_VERSION_MAJOR 51
  28. #define LIBAVCODEC_VERSION_MINOR 54
  29. #define LIBAVCODEC_VERSION_MICRO 0
  30. #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
  31. LIBAVCODEC_VERSION_MINOR, \
  32. LIBAVCODEC_VERSION_MICRO)
  33. #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
  34. LIBAVCODEC_VERSION_MINOR, \
  35. LIBAVCODEC_VERSION_MICRO)
  36. #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
  37. #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
  38. #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
  39. #define AV_TIME_BASE 1000000
  40. #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
  41. /**
  42. * Identifies the syntax and semantics of the bitstream.
  43. * The principle is roughly:
  44. * Two decoders with the same ID can decode the same streams.
  45. * Two encoders with the same ID can encode compatible streams.
  46. * There may be slight deviations from the principle due to implementation
  47. * details.
  48. *
  49. * If you add a codec ID to this list, add it so that
  50. * 1. no value of a existing codec ID changes (that would break ABI),
  51. * 2. it is as close as possible to similar codecs.
  52. */
  53. enum CodecID {
  54. CODEC_ID_NONE,
  55. /* video codecs */
  56. CODEC_ID_MPEG1VIDEO,
  57. CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  58. CODEC_ID_MPEG2VIDEO_XVMC,
  59. CODEC_ID_H261,
  60. CODEC_ID_H263,
  61. CODEC_ID_RV10,
  62. CODEC_ID_RV20,
  63. CODEC_ID_MJPEG,
  64. CODEC_ID_MJPEGB,
  65. CODEC_ID_LJPEG,
  66. CODEC_ID_SP5X,
  67. CODEC_ID_JPEGLS,
  68. CODEC_ID_MPEG4,
  69. CODEC_ID_RAWVIDEO,
  70. CODEC_ID_MSMPEG4V1,
  71. CODEC_ID_MSMPEG4V2,
  72. CODEC_ID_MSMPEG4V3,
  73. CODEC_ID_WMV1,
  74. CODEC_ID_WMV2,
  75. CODEC_ID_H263P,
  76. CODEC_ID_H263I,
  77. CODEC_ID_FLV1,
  78. CODEC_ID_SVQ1,
  79. CODEC_ID_SVQ3,
  80. CODEC_ID_DVVIDEO,
  81. CODEC_ID_HUFFYUV,
  82. CODEC_ID_CYUV,
  83. CODEC_ID_H264,
  84. CODEC_ID_INDEO3,
  85. CODEC_ID_VP3,
  86. CODEC_ID_THEORA,
  87. CODEC_ID_ASV1,
  88. CODEC_ID_ASV2,
  89. CODEC_ID_FFV1,
  90. CODEC_ID_4XM,
  91. CODEC_ID_VCR1,
  92. CODEC_ID_CLJR,
  93. CODEC_ID_MDEC,
  94. CODEC_ID_ROQ,
  95. CODEC_ID_INTERPLAY_VIDEO,
  96. CODEC_ID_XAN_WC3,
  97. CODEC_ID_XAN_WC4,
  98. CODEC_ID_RPZA,
  99. CODEC_ID_CINEPAK,
  100. CODEC_ID_WS_VQA,
  101. CODEC_ID_MSRLE,
  102. CODEC_ID_MSVIDEO1,
  103. CODEC_ID_IDCIN,
  104. CODEC_ID_8BPS,
  105. CODEC_ID_SMC,
  106. CODEC_ID_FLIC,
  107. CODEC_ID_TRUEMOTION1,
  108. CODEC_ID_VMDVIDEO,
  109. CODEC_ID_MSZH,
  110. CODEC_ID_ZLIB,
  111. CODEC_ID_QTRLE,
  112. CODEC_ID_SNOW,
  113. CODEC_ID_TSCC,
  114. CODEC_ID_ULTI,
  115. CODEC_ID_QDRAW,
  116. CODEC_ID_VIXL,
  117. CODEC_ID_QPEG,
  118. CODEC_ID_XVID,
  119. CODEC_ID_PNG,
  120. CODEC_ID_PPM,
  121. CODEC_ID_PBM,
  122. CODEC_ID_PGM,
  123. CODEC_ID_PGMYUV,
  124. CODEC_ID_PAM,
  125. CODEC_ID_FFVHUFF,
  126. CODEC_ID_RV30,
  127. CODEC_ID_RV40,
  128. CODEC_ID_VC1,
  129. CODEC_ID_WMV3,
  130. CODEC_ID_LOCO,
  131. CODEC_ID_WNV1,
  132. CODEC_ID_AASC,
  133. CODEC_ID_INDEO2,
  134. CODEC_ID_FRAPS,
  135. CODEC_ID_TRUEMOTION2,
  136. CODEC_ID_BMP,
  137. CODEC_ID_CSCD,
  138. CODEC_ID_MMVIDEO,
  139. CODEC_ID_ZMBV,
  140. CODEC_ID_AVS,
  141. CODEC_ID_SMACKVIDEO,
  142. CODEC_ID_NUV,
  143. CODEC_ID_KMVC,
  144. CODEC_ID_FLASHSV,
  145. CODEC_ID_CAVS,
  146. CODEC_ID_JPEG2000,
  147. CODEC_ID_VMNC,
  148. CODEC_ID_VP5,
  149. CODEC_ID_VP6,
  150. CODEC_ID_VP6F,
  151. CODEC_ID_TARGA,
  152. CODEC_ID_DSICINVIDEO,
  153. CODEC_ID_TIERTEXSEQVIDEO,
  154. CODEC_ID_TIFF,
  155. CODEC_ID_GIF,
  156. CODEC_ID_FFH264,
  157. CODEC_ID_DXA,
  158. CODEC_ID_DNXHD,
  159. CODEC_ID_THP,
  160. CODEC_ID_SGI,
  161. CODEC_ID_C93,
  162. CODEC_ID_BETHSOFTVID,
  163. CODEC_ID_PTX,
  164. CODEC_ID_TXD,
  165. CODEC_ID_VP6A,
  166. CODEC_ID_AMV,
  167. CODEC_ID_VB,
  168. CODEC_ID_PCX,
  169. CODEC_ID_SUNRAST,
  170. CODEC_ID_INDEO4,
  171. CODEC_ID_INDEO5,
  172. CODEC_ID_MIMIC,
  173. CODEC_ID_RL2,
  174. CODEC_ID_8SVX_EXP,
  175. CODEC_ID_8SVX_FIB,
  176. CODEC_ID_ESCAPE124,
  177. CODEC_ID_DIRAC,
  178. CODEC_ID_BFI,
  179. /* various PCM "codecs" */
  180. CODEC_ID_PCM_S16LE= 0x10000,
  181. CODEC_ID_PCM_S16BE,
  182. CODEC_ID_PCM_U16LE,
  183. CODEC_ID_PCM_U16BE,
  184. CODEC_ID_PCM_S8,
  185. CODEC_ID_PCM_U8,
  186. CODEC_ID_PCM_MULAW,
  187. CODEC_ID_PCM_ALAW,
  188. CODEC_ID_PCM_S32LE,
  189. CODEC_ID_PCM_S32BE,
  190. CODEC_ID_PCM_U32LE,
  191. CODEC_ID_PCM_U32BE,
  192. CODEC_ID_PCM_S24LE,
  193. CODEC_ID_PCM_S24BE,
  194. CODEC_ID_PCM_U24LE,
  195. CODEC_ID_PCM_U24BE,
  196. CODEC_ID_PCM_S24DAUD,
  197. CODEC_ID_PCM_ZORK,
  198. CODEC_ID_PCM_S16LE_PLANAR,
  199. /* various ADPCM codecs */
  200. CODEC_ID_ADPCM_IMA_QT= 0x11000,
  201. CODEC_ID_ADPCM_IMA_WAV,
  202. CODEC_ID_ADPCM_IMA_DK3,
  203. CODEC_ID_ADPCM_IMA_DK4,
  204. CODEC_ID_ADPCM_IMA_WS,
  205. CODEC_ID_ADPCM_IMA_SMJPEG,
  206. CODEC_ID_ADPCM_MS,
  207. CODEC_ID_ADPCM_4XM,
  208. CODEC_ID_ADPCM_XA,
  209. CODEC_ID_ADPCM_ADX,
  210. CODEC_ID_ADPCM_EA,
  211. CODEC_ID_ADPCM_G726,
  212. CODEC_ID_ADPCM_CT,
  213. CODEC_ID_ADPCM_SWF,
  214. CODEC_ID_ADPCM_YAMAHA,
  215. CODEC_ID_ADPCM_SBPRO_4,
  216. CODEC_ID_ADPCM_SBPRO_3,
  217. CODEC_ID_ADPCM_SBPRO_2,
  218. CODEC_ID_ADPCM_THP,
  219. CODEC_ID_ADPCM_IMA_AMV,
  220. CODEC_ID_ADPCM_EA_R1,
  221. CODEC_ID_ADPCM_EA_R3,
  222. CODEC_ID_ADPCM_EA_R2,
  223. CODEC_ID_ADPCM_IMA_EA_SEAD,
  224. CODEC_ID_ADPCM_IMA_EA_EACS,
  225. CODEC_ID_ADPCM_EA_XAS,
  226. /* AMR */
  227. CODEC_ID_AMR_NB= 0x12000,
  228. CODEC_ID_AMR_WB,
  229. /* RealAudio codecs*/
  230. CODEC_ID_RA_144= 0x13000,
  231. CODEC_ID_RA_288,
  232. /* various DPCM codecs */
  233. CODEC_ID_ROQ_DPCM= 0x14000,
  234. CODEC_ID_INTERPLAY_DPCM,
  235. CODEC_ID_XAN_DPCM,
  236. CODEC_ID_SOL_DPCM,
  237. /* audio codecs */
  238. CODEC_ID_MP2= 0x15000,
  239. CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
  240. CODEC_ID_AAC,
  241. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  242. CODEC_ID_MPEG4AAC,
  243. #endif
  244. CODEC_ID_AC3,
  245. CODEC_ID_DTS,
  246. CODEC_ID_VORBIS,
  247. CODEC_ID_DVAUDIO,
  248. CODEC_ID_WMAV1,
  249. CODEC_ID_WMAV2,
  250. CODEC_ID_MACE3,
  251. CODEC_ID_MACE6,
  252. CODEC_ID_VMDAUDIO,
  253. CODEC_ID_SONIC,
  254. CODEC_ID_SONIC_LS,
  255. CODEC_ID_FLAC,
  256. CODEC_ID_MP3ADU,
  257. CODEC_ID_MP3ON4,
  258. CODEC_ID_SHORTEN,
  259. CODEC_ID_ALAC,
  260. CODEC_ID_WESTWOOD_SND1,
  261. CODEC_ID_GSM, ///< as in Berlin toast format
  262. CODEC_ID_QDM2,
  263. CODEC_ID_COOK,
  264. CODEC_ID_TRUESPEECH,
  265. CODEC_ID_TTA,
  266. CODEC_ID_SMACKAUDIO,
  267. CODEC_ID_QCELP,
  268. CODEC_ID_WAVPACK,
  269. CODEC_ID_DSICINAUDIO,
  270. CODEC_ID_IMC,
  271. CODEC_ID_MUSEPACK7,
  272. CODEC_ID_MLP,
  273. CODEC_ID_GSM_MS, /* as found in WAV */
  274. CODEC_ID_ATRAC3,
  275. CODEC_ID_VOXWARE,
  276. CODEC_ID_APE,
  277. CODEC_ID_NELLYMOSER,
  278. CODEC_ID_MUSEPACK8,
  279. CODEC_ID_SPEEX,
  280. CODEC_ID_WMAVOICE,
  281. CODEC_ID_WMAPRO,
  282. CODEC_ID_WMALOSSLESS,
  283. /* subtitle codecs */
  284. CODEC_ID_DVD_SUBTITLE= 0x17000,
  285. CODEC_ID_DVB_SUBTITLE,
  286. CODEC_ID_TEXT, ///< raw UTF-8 text
  287. CODEC_ID_XSUB,
  288. CODEC_ID_SSA,
  289. CODEC_ID_MOV_TEXT,
  290. /* other specific kind of codecs (generally used for attachments) */
  291. CODEC_ID_TTF= 0x18000,
  292. CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
  293. * stream (only used by libavformat) */
  294. };
  295. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  296. /* CODEC_ID_MP3LAME is obsolete */
  297. #define CODEC_ID_MP3LAME CODEC_ID_MP3
  298. #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
  299. #endif
  300. enum CodecType {
  301. CODEC_TYPE_UNKNOWN = -1,
  302. CODEC_TYPE_VIDEO,
  303. CODEC_TYPE_AUDIO,
  304. CODEC_TYPE_DATA,
  305. CODEC_TYPE_SUBTITLE,
  306. CODEC_TYPE_ATTACHMENT,
  307. CODEC_TYPE_NB
  308. };
  309. /**
  310. * Currently unused, may be used if 24/32 bits samples are ever supported.
  311. * all in native-endian format
  312. */
  313. enum SampleFormat {
  314. SAMPLE_FMT_NONE = -1,
  315. SAMPLE_FMT_U8, ///< unsigned 8 bits
  316. SAMPLE_FMT_S16, ///< signed 16 bits
  317. SAMPLE_FMT_S24, ///< signed 24 bits
  318. SAMPLE_FMT_S32, ///< signed 32 bits
  319. SAMPLE_FMT_FLT, ///< float
  320. };
  321. /* in bytes */
  322. #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
  323. /**
  324. * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
  325. * This is mainly needed because some optimized bitstream readers read
  326. * 32 or 64 bit at once and could read over the end.<br>
  327. * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  328. * MPEG bitstreams could cause overread and segfault.
  329. */
  330. #define FF_INPUT_BUFFER_PADDING_SIZE 8
  331. /**
  332. * minimum encoding buffer size
  333. * Used to avoid some checks during header writing.
  334. */
  335. #define FF_MIN_BUFFER_SIZE 16384
  336. /**
  337. * motion estimation type.
  338. */
  339. enum Motion_Est_ID {
  340. ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
  341. ME_FULL,
  342. ME_LOG,
  343. ME_PHODS,
  344. ME_EPZS, ///< enhanced predictive zonal search
  345. ME_X1, ///< reserved for experiments
  346. ME_HEX, ///< hexagon based search
  347. ME_UMH, ///< uneven multi-hexagon search
  348. ME_ITER, ///< iterative search
  349. };
  350. enum AVDiscard{
  351. /* We leave some space between them for extensions (drop some
  352. * keyframes for intra-only or drop just some bidir frames). */
  353. AVDISCARD_NONE =-16, ///< discard nothing
  354. AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
  355. AVDISCARD_NONREF = 8, ///< discard all non reference
  356. AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
  357. AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
  358. AVDISCARD_ALL = 48, ///< discard all
  359. };
  360. typedef struct RcOverride{
  361. int start_frame;
  362. int end_frame;
  363. int qscale; // If this is 0 then quality_factor will be used instead.
  364. float quality_factor;
  365. } RcOverride;
  366. #define FF_MAX_B_FRAMES 16
  367. /* encoding support
  368. These flags can be passed in AVCodecContext.flags before initialization.
  369. Note: Not everything is supported yet.
  370. */
  371. #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
  372. #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
  373. #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
  374. #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
  375. #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
  376. #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
  377. /**
  378. * The parent program guarantees that the input for B-frames containing
  379. * streams is not written to for at least s->max_b_frames+1 frames, if
  380. * this is not set the input will be copied.
  381. */
  382. #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  383. #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
  384. #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
  385. #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
  386. #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
  387. #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
  388. #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
  389. #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
  390. location instead of only at frame boundaries. */
  391. #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
  392. #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
  393. #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
  394. #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
  395. #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
  396. #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
  397. #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
  398. /* Fx : Flag for h263+ extra options */
  399. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  400. #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
  401. #endif
  402. #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
  403. #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
  404. #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
  405. #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
  406. #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
  407. #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
  408. #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
  409. #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
  410. #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
  411. #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
  412. #define CODEC_FLAG_CLOSED_GOP 0x80000000
  413. #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
  414. #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
  415. #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
  416. #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
  417. #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
  418. #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
  419. #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
  420. #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
  421. #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
  422. #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
  423. #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
  424. #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
  425. #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
  426. #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
  427. #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
  428. #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
  429. #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
  430. #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
  431. /* Unsupported options :
  432. * Syntax Arithmetic coding (SAC)
  433. * Reference Picture Selection
  434. * Independent Segment Decoding */
  435. /* /Fx */
  436. /* codec capabilities */
  437. #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
  438. /**
  439. * Codec uses get_buffer() for allocating buffers.
  440. * direct rendering method 1
  441. */
  442. #define CODEC_CAP_DR1 0x0002
  443. /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
  444. #define CODEC_CAP_PARSE_ONLY 0x0004
  445. #define CODEC_CAP_TRUNCATED 0x0008
  446. /* Codec can export data for HW decoding (XvMC). */
  447. #define CODEC_CAP_HWACCEL 0x0010
  448. /**
  449. * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
  450. * If this is not set, the codec is guaranteed to never be fed with NULL data.
  451. */
  452. #define CODEC_CAP_DELAY 0x0020
  453. /**
  454. * Codec can be fed a final frame with a smaller size.
  455. * This can be used to prevent truncation of the last audio samples.
  456. */
  457. #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
  458. //The following defines may change, don't expect compatibility if you use them.
  459. #define MB_TYPE_INTRA4x4 0x0001
  460. #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
  461. #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
  462. #define MB_TYPE_16x16 0x0008
  463. #define MB_TYPE_16x8 0x0010
  464. #define MB_TYPE_8x16 0x0020
  465. #define MB_TYPE_8x8 0x0040
  466. #define MB_TYPE_INTERLACED 0x0080
  467. #define MB_TYPE_DIRECT2 0x0100 //FIXME
  468. #define MB_TYPE_ACPRED 0x0200
  469. #define MB_TYPE_GMC 0x0400
  470. #define MB_TYPE_SKIP 0x0800
  471. #define MB_TYPE_P0L0 0x1000
  472. #define MB_TYPE_P1L0 0x2000
  473. #define MB_TYPE_P0L1 0x4000
  474. #define MB_TYPE_P1L1 0x8000
  475. #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
  476. #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
  477. #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
  478. #define MB_TYPE_QUANT 0x00010000
  479. #define MB_TYPE_CBP 0x00020000
  480. //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
  481. /**
  482. * Pan Scan area.
  483. * This specifies the area which should be displayed.
  484. * Note there may be multiple such areas for one frame.
  485. */
  486. typedef struct AVPanScan{
  487. /**
  488. * id
  489. * - encoding: Set by user.
  490. * - decoding: Set by libavcodec.
  491. */
  492. int id;
  493. /**
  494. * width and height in 1/16 pel
  495. * - encoding: Set by user.
  496. * - decoding: Set by libavcodec.
  497. */
  498. int width;
  499. int height;
  500. /**
  501. * position of the top left corner in 1/16 pel for up to 3 fields/frames
  502. * - encoding: Set by user.
  503. * - decoding: Set by libavcodec.
  504. */
  505. int16_t position[3][2];
  506. }AVPanScan;
  507. #define FF_COMMON_FRAME \
  508. /**\
  509. * pointer to the picture planes.\
  510. * This might be different from the first allocated byte\
  511. * - encoding: \
  512. * - decoding: \
  513. */\
  514. uint8_t *data[4];\
  515. int linesize[4];\
  516. /**\
  517. * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
  518. * This isn't used by libavcodec unless the default get/release_buffer() is used.\
  519. * - encoding: \
  520. * - decoding: \
  521. */\
  522. uint8_t *base[4];\
  523. /**\
  524. * 1 -> keyframe, 0-> not\
  525. * - encoding: Set by libavcodec.\
  526. * - decoding: Set by libavcodec.\
  527. */\
  528. int key_frame;\
  529. \
  530. /**\
  531. * Picture type of the frame, see ?_TYPE below.\
  532. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
  533. * - decoding: Set by libavcodec.\
  534. */\
  535. int pict_type;\
  536. \
  537. /**\
  538. * presentation timestamp in time_base units (time when frame should be shown to user)\
  539. * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
  540. * - encoding: MUST be set by user.\
  541. * - decoding: Set by libavcodec.\
  542. */\
  543. int64_t pts;\
  544. \
  545. /**\
  546. * picture number in bitstream order\
  547. * - encoding: set by\
  548. * - decoding: Set by libavcodec.\
  549. */\
  550. int coded_picture_number;\
  551. /**\
  552. * picture number in display order\
  553. * - encoding: set by\
  554. * - decoding: Set by libavcodec.\
  555. */\
  556. int display_picture_number;\
  557. \
  558. /**\
  559. * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
  560. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
  561. * - decoding: Set by libavcodec.\
  562. */\
  563. int quality; \
  564. \
  565. /**\
  566. * buffer age (1->was last buffer and dint change, 2->..., ...).\
  567. * Set to INT_MAX if the buffer has not been used yet.\
  568. * - encoding: unused\
  569. * - decoding: MUST be set by get_buffer().\
  570. */\
  571. int age;\
  572. \
  573. /**\
  574. * is this picture used as reference\
  575. * The values for this are the same as the MpegEncContext.picture_structure\
  576. * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
  577. * - encoding: unused\
  578. * - decoding: Set by libavcodec. (before get_buffer() call)).\
  579. */\
  580. int reference;\
  581. \
  582. /**\
  583. * QP table\
  584. * - encoding: unused\
  585. * - decoding: Set by libavcodec.\
  586. */\
  587. int8_t *qscale_table;\
  588. /**\
  589. * QP store stride\
  590. * - encoding: unused\
  591. * - decoding: Set by libavcodec.\
  592. */\
  593. int qstride;\
  594. \
  595. /**\
  596. * mbskip_table[mb]>=1 if MB didn't change\
  597. * stride= mb_width = (width+15)>>4\
  598. * - encoding: unused\
  599. * - decoding: Set by libavcodec.\
  600. */\
  601. uint8_t *mbskip_table;\
  602. \
  603. /**\
  604. * motion vector table\
  605. * @code\
  606. * example:\
  607. * int mv_sample_log2= 4 - motion_subsample_log2;\
  608. * int mb_width= (width+15)>>4;\
  609. * int mv_stride= (mb_width << mv_sample_log2) + 1;\
  610. * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
  611. * @endcode\
  612. * - encoding: Set by user.\
  613. * - decoding: Set by libavcodec.\
  614. */\
  615. int16_t (*motion_val[2])[2];\
  616. \
  617. /**\
  618. * macroblock type table\
  619. * mb_type_base + mb_width + 2\
  620. * - encoding: Set by user.\
  621. * - decoding: Set by libavcodec.\
  622. */\
  623. uint32_t *mb_type;\
  624. \
  625. /**\
  626. * log2 of the size of the block which a single vector in motion_val represents: \
  627. * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
  628. * - encoding: unused\
  629. * - decoding: Set by libavcodec.\
  630. */\
  631. uint8_t motion_subsample_log2;\
  632. \
  633. /**\
  634. * for some private data of the user\
  635. * - encoding: unused\
  636. * - decoding: Set by user.\
  637. */\
  638. void *opaque;\
  639. \
  640. /**\
  641. * error\
  642. * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
  643. * - decoding: unused\
  644. */\
  645. uint64_t error[4];\
  646. \
  647. /**\
  648. * type of the buffer (to keep track of who has to deallocate data[*])\
  649. * - encoding: Set by the one who allocates it.\
  650. * - decoding: Set by the one who allocates it.\
  651. * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
  652. */\
  653. int type;\
  654. \
  655. /**\
  656. * When decoding, this signals how much the picture must be delayed.\
  657. * extra_delay = repeat_pict / (2*fps)\
  658. * - encoding: unused\
  659. * - decoding: Set by libavcodec.\
  660. */\
  661. int repeat_pict;\
  662. \
  663. /**\
  664. * \
  665. */\
  666. int qscale_type;\
  667. \
  668. /**\
  669. * The content of the picture is interlaced.\
  670. * - encoding: Set by user.\
  671. * - decoding: Set by libavcodec. (default 0)\
  672. */\
  673. int interlaced_frame;\
  674. \
  675. /**\
  676. * If the content is interlaced, is top field displayed first.\
  677. * - encoding: Set by user.\
  678. * - decoding: Set by libavcodec.\
  679. */\
  680. int top_field_first;\
  681. \
  682. /**\
  683. * Pan scan.\
  684. * - encoding: Set by user.\
  685. * - decoding: Set by libavcodec.\
  686. */\
  687. AVPanScan *pan_scan;\
  688. \
  689. /**\
  690. * Tell user application that palette has changed from previous frame.\
  691. * - encoding: ??? (no palette-enabled encoder yet)\
  692. * - decoding: Set by libavcodec. (default 0).\
  693. */\
  694. int palette_has_changed;\
  695. \
  696. /**\
  697. * codec suggestion on buffer type if != 0\
  698. * - encoding: unused\
  699. * - decoding: Set by libavcodec. (before get_buffer() call)).\
  700. */\
  701. int buffer_hints;\
  702. \
  703. /**\
  704. * DCT coefficients\
  705. * - encoding: unused\
  706. * - decoding: Set by libavcodec.\
  707. */\
  708. short *dct_coeff;\
  709. \
  710. /**\
  711. * motion referece frame index\
  712. * - encoding: Set by user.\
  713. * - decoding: Set by libavcodec.\
  714. */\
  715. int8_t *ref_index[2];
  716. #define FF_QSCALE_TYPE_MPEG1 0
  717. #define FF_QSCALE_TYPE_MPEG2 1
  718. #define FF_QSCALE_TYPE_H264 2
  719. #define FF_BUFFER_TYPE_INTERNAL 1
  720. #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
  721. #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
  722. #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
  723. #define FF_I_TYPE 1 ///< Intra
  724. #define FF_P_TYPE 2 ///< Predicted
  725. #define FF_B_TYPE 3 ///< Bi-dir predicted
  726. #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
  727. #define FF_SI_TYPE 5 ///< Switching Intra
  728. #define FF_SP_TYPE 6 ///< Switching Predicted
  729. #define FF_BI_TYPE 7
  730. #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
  731. #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
  732. #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
  733. #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
  734. /**
  735. * Audio Video Frame.
  736. * New fields can be added to the end of FF_COMMON_FRAME with minor version
  737. * bumps.
  738. * Removal, reordering and changes to existing fields require a major
  739. * version bump. No fields should be added into AVFrame before or after
  740. * FF_COMMON_FRAME!
  741. * sizeof(AVFrame) must not be used outside libav*.
  742. */
  743. typedef struct AVFrame {
  744. FF_COMMON_FRAME
  745. } AVFrame;
  746. #define DEFAULT_FRAME_RATE_BASE 1001000
  747. /**
  748. * main external API structure.
  749. * New fields can be added to the end with minor version bumps.
  750. * Removal, reordering and changes to existing fields require a major
  751. * version bump.
  752. * sizeof(AVCodecContext) must not be used outside libav*.
  753. */
  754. typedef struct AVCodecContext {
  755. /**
  756. * information on struct for av_log
  757. * - set by avcodec_alloc_context
  758. */
  759. const AVClass *av_class;
  760. /**
  761. * the average bitrate
  762. * - encoding: Set by user; unused for constant quantizer encoding.
  763. * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
  764. */
  765. int bit_rate;
  766. /**
  767. * number of bits the bitstream is allowed to diverge from the reference.
  768. * the reference can be CBR (for CBR pass1) or VBR (for pass2)
  769. * - encoding: Set by user; unused for constant quantizer encoding.
  770. * - decoding: unused
  771. */
  772. int bit_rate_tolerance;
  773. /**
  774. * CODEC_FLAG_*.
  775. * - encoding: Set by user.
  776. * - decoding: Set by user.
  777. */
  778. int flags;
  779. /**
  780. * Some codecs need additional format info. It is stored here.
  781. * If any muxer uses this then ALL demuxers/parsers AND encoders for the
  782. * specific codec MUST set it correctly otherwise stream copy breaks.
  783. * In general use of this field by muxers is not recommanded.
  784. * - encoding: Set by libavcodec.
  785. * - decoding: Set by libavcodec. (FIXME: Is this OK?)
  786. */
  787. int sub_id;
  788. /**
  789. * Motion estimation algorithm used for video coding.
  790. * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
  791. * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
  792. * - encoding: MUST be set by user.
  793. * - decoding: unused
  794. */
  795. int me_method;
  796. /**
  797. * some codecs need / can use extradata like Huffman tables.
  798. * mjpeg: Huffman tables
  799. * rv10: additional flags
  800. * mpeg4: global headers (they can be in the bitstream or here)
  801. * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
  802. * than extradata_size to avoid prolems if it is read with the bitstream reader.
  803. * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
  804. * - encoding: Set/allocated/freed by libavcodec.
  805. * - decoding: Set/allocated/freed by user.
  806. */
  807. uint8_t *extradata;
  808. int extradata_size;
  809. /**
  810. * This is the fundamental unit of time (in seconds) in terms
  811. * of which frame timestamps are represented. For fixed-fps content,
  812. * timebase should be 1/framerate and timestamp increments should be
  813. * identically 1.
  814. * - encoding: MUST be set by user.
  815. * - decoding: Set by libavcodec.
  816. */
  817. AVRational time_base;
  818. /* video only */
  819. /**
  820. * picture width / height.
  821. * - encoding: MUST be set by user.
  822. * - decoding: Set by libavcodec.
  823. * Note: For compatibility it is possible to set this instead of
  824. * coded_width/height before decoding.
  825. */
  826. int width, height;
  827. #define FF_ASPECT_EXTENDED 15
  828. /**
  829. * the number of pictures in a group of pictures, or 0 for intra_only
  830. * - encoding: Set by user.
  831. * - decoding: unused
  832. */
  833. int gop_size;
  834. /**
  835. * Pixel format, see PIX_FMT_xxx.
  836. * - encoding: Set by user.
  837. * - decoding: Set by libavcodec.
  838. */
  839. enum PixelFormat pix_fmt;
  840. /**
  841. * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
  842. * has to read frames at native frame rate.
  843. * - encoding: Set by user.
  844. * - decoding: unused
  845. */
  846. int rate_emu;
  847. /**
  848. * If non NULL, 'draw_horiz_band' is called by the libavcodec
  849. * decoder to draw a horizontal band. It improves cache usage. Not
  850. * all codecs can do that. You must check the codec capabilities
  851. * beforehand.
  852. * - encoding: unused
  853. * - decoding: Set by user.
  854. * @param height the height of the slice
  855. * @param y the y position of the slice
  856. * @param type 1->top field, 2->bottom field, 3->frame
  857. * @param offset offset into the AVFrame.data from which the slice should be read
  858. */
  859. void (*draw_horiz_band)(struct AVCodecContext *s,
  860. const AVFrame *src, int offset[4],
  861. int y, int type, int height);
  862. /* audio only */
  863. int sample_rate; ///< samples per second
  864. int channels;
  865. /**
  866. * audio sample format
  867. * - encoding: Set by user.
  868. * - decoding: Set by libavcodec.
  869. */
  870. enum SampleFormat sample_fmt; ///< sample format, currently unused
  871. /* The following data should not be initialized. */
  872. /**
  873. * Samples per packet, initialized when calling 'init'.
  874. */
  875. int frame_size;
  876. int frame_number; ///< audio or video frame number
  877. int real_pict_num; ///< Returns the real picture number of previous encoded frame.
  878. /**
  879. * Number of frames the decoded output will be delayed relative to
  880. * the encoded input.
  881. * - encoding: Set by libavcodec.
  882. * - decoding: unused
  883. */
  884. int delay;
  885. /* - encoding parameters */
  886. float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
  887. float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
  888. /**
  889. * minimum quantizer
  890. * - encoding: Set by user.
  891. * - decoding: unused
  892. */
  893. int qmin;
  894. /**
  895. * maximum quantizer
  896. * - encoding: Set by user.
  897. * - decoding: unused
  898. */
  899. int qmax;
  900. /**
  901. * maximum quantizer difference between frames
  902. * - encoding: Set by user.
  903. * - decoding: unused
  904. */
  905. int max_qdiff;
  906. /**
  907. * maximum number of B-frames between non-B-frames
  908. * Note: The output will be delayed by max_b_frames+1 relative to the input.
  909. * - encoding: Set by user.
  910. * - decoding: unused
  911. */
  912. int max_b_frames;
  913. /**
  914. * qscale factor between IP and B-frames
  915. * - encoding: Set by user.
  916. * - decoding: unused
  917. */
  918. float b_quant_factor;
  919. /** obsolete FIXME remove */
  920. int rc_strategy;
  921. #define FF_RC_STRATEGY_XVID 1
  922. int b_frame_strategy;
  923. /**
  924. * hurry up amount
  925. * - encoding: unused
  926. * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
  927. * @deprecated Deprecated in favor of skip_idct and skip_frame.
  928. */
  929. int hurry_up;
  930. struct AVCodec *codec;
  931. void *priv_data;
  932. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  933. /* unused, FIXME remove*/
  934. int rtp_mode;
  935. #endif
  936. int rtp_payload_size; /* The size of the RTP payload: the coder will */
  937. /* do its best to deliver a chunk with size */
  938. /* below rtp_payload_size, the chunk will start */
  939. /* with a start code on some codecs like H.263. */
  940. /* This doesn't take account of any particular */
  941. /* headers inside the transmitted RTP payload. */
  942. /* The RTP callback: This function is called */
  943. /* every time the encoder has a packet to send. */
  944. /* It depends on the encoder if the data starts */
  945. /* with a Start Code (it should). H.263 does. */
  946. /* mb_nb contains the number of macroblocks */
  947. /* encoded in the RTP payload. */
  948. void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
  949. /* statistics, used for 2-pass encoding */
  950. int mv_bits;
  951. int header_bits;
  952. int i_tex_bits;
  953. int p_tex_bits;
  954. int i_count;
  955. int p_count;
  956. int skip_count;
  957. int misc_bits;
  958. /**
  959. * number of bits used for the previously encoded frame
  960. * - encoding: Set by libavcodec.
  961. * - decoding: unused
  962. */
  963. int frame_bits;
  964. /**
  965. * Private data of the user, can be used to carry app specific stuff.
  966. * - encoding: Set by user.
  967. * - decoding: Set by user.
  968. */
  969. void *opaque;
  970. char codec_name[32];
  971. enum CodecType codec_type; /* see CODEC_TYPE_xxx */
  972. enum CodecID codec_id; /* see CODEC_ID_xxx */
  973. /**
  974. * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  975. * This is used to work around some encoder bugs.
  976. * A demuxer should set this to what is stored in the field used to identify the codec.
  977. * If there are multiple such fields in a container then the demuxer should choose the one
  978. * which maximizes the information about the used codec.
  979. * If the codec tag field in a container is larger then 32 bits then the demuxer should
  980. * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
  981. * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
  982. * first.
  983. * - encoding: Set by user, if not then the default based on codec_id will be used.
  984. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  985. */
  986. unsigned int codec_tag;
  987. /**
  988. * Work around bugs in encoders which sometimes cannot be detected automatically.
  989. * - encoding: Set by user
  990. * - decoding: Set by user
  991. */
  992. int workaround_bugs;
  993. #define FF_BUG_AUTODETECT 1 ///< autodetection
  994. #define FF_BUG_OLD_MSMPEG4 2
  995. #define FF_BUG_XVID_ILACE 4
  996. #define FF_BUG_UMP4 8
  997. #define FF_BUG_NO_PADDING 16
  998. #define FF_BUG_AMV 32
  999. #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
  1000. #define FF_BUG_QPEL_CHROMA 64
  1001. #define FF_BUG_STD_QPEL 128
  1002. #define FF_BUG_QPEL_CHROMA2 256
  1003. #define FF_BUG_DIRECT_BLOCKSIZE 512
  1004. #define FF_BUG_EDGE 1024
  1005. #define FF_BUG_HPEL_CHROMA 2048
  1006. #define FF_BUG_DC_CLIP 4096
  1007. #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
  1008. //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
  1009. /**
  1010. * luma single coefficient elimination threshold
  1011. * - encoding: Set by user.
  1012. * - decoding: unused
  1013. */
  1014. int luma_elim_threshold;
  1015. /**
  1016. * chroma single coeff elimination threshold
  1017. * - encoding: Set by user.
  1018. * - decoding: unused
  1019. */
  1020. int chroma_elim_threshold;
  1021. /**
  1022. * strictly follow the standard (MPEG4, ...).
  1023. * - encoding: Set by user.
  1024. * - decoding: unused
  1025. */
  1026. int strict_std_compliance;
  1027. #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
  1028. #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
  1029. #define FF_COMPLIANCE_NORMAL 0
  1030. #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
  1031. #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
  1032. /**
  1033. * qscale offset between IP and B-frames
  1034. * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
  1035. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1036. * - encoding: Set by user.
  1037. * - decoding: unused
  1038. */
  1039. float b_quant_offset;
  1040. /**
  1041. * Error resilience; higher values will detect more errors but may
  1042. * misdetect some more or less valid parts as errors.
  1043. * - encoding: unused
  1044. * - decoding: Set by user.
  1045. */
  1046. int error_resilience;
  1047. #define FF_ER_CAREFUL 1
  1048. #define FF_ER_COMPLIANT 2
  1049. #define FF_ER_AGGRESSIVE 3
  1050. #define FF_ER_VERY_AGGRESSIVE 4
  1051. /**
  1052. * Called at the beginning of each frame to get a buffer for it.
  1053. * If pic.reference is set then the frame will be read later by libavcodec.
  1054. * avcodec_align_dimensions() should be used to find the required width and
  1055. * height, as they normally need to be rounded up to the next multiple of 16.
  1056. * - encoding: unused
  1057. * - decoding: Set by libavcodec., user can override.
  1058. */
  1059. int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1060. /**
  1061. * Called to release buffers which were allocated with get_buffer.
  1062. * A released buffer can be reused in get_buffer().
  1063. * pic.data[*] must be set to NULL.
  1064. * - encoding: unused
  1065. * - decoding: Set by libavcodec., user can override.
  1066. */
  1067. void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1068. /**
  1069. * If 1 the stream has a 1 frame delay during decoding.
  1070. * - encoding: Set by libavcodec.
  1071. * - decoding: Set by libavcodec.
  1072. */
  1073. int has_b_frames;
  1074. /**
  1075. * number of bytes per packet if constant and known or 0
  1076. * Used by some WAV based audio codecs.
  1077. */
  1078. int block_align;
  1079. int parse_only; /* - decoding only: If true, only parsing is done
  1080. (function avcodec_parse_frame()). The frame
  1081. data is returned. Only MPEG codecs support this now. */
  1082. /**
  1083. * 0-> h263 quant 1-> mpeg quant
  1084. * - encoding: Set by user.
  1085. * - decoding: unused
  1086. */
  1087. int mpeg_quant;
  1088. /**
  1089. * pass1 encoding statistics output buffer
  1090. * - encoding: Set by libavcodec.
  1091. * - decoding: unused
  1092. */
  1093. char *stats_out;
  1094. /**
  1095. * pass2 encoding statistics input buffer
  1096. * Concatenated stuff from stats_out of pass1 should be placed here.
  1097. * - encoding: Allocated/set/freed by user.
  1098. * - decoding: unused
  1099. */
  1100. char *stats_in;
  1101. /**
  1102. * ratecontrol qmin qmax limiting method
  1103. * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
  1104. * - encoding: Set by user.
  1105. * - decoding: unused
  1106. */
  1107. float rc_qsquish;
  1108. float rc_qmod_amp;
  1109. int rc_qmod_freq;
  1110. /**
  1111. * ratecontrol override, see RcOverride
  1112. * - encoding: Allocated/set/freed by user.
  1113. * - decoding: unused
  1114. */
  1115. RcOverride *rc_override;
  1116. int rc_override_count;
  1117. /**
  1118. * rate control equation
  1119. * - encoding: Set by user
  1120. * - decoding: unused
  1121. */
  1122. const char *rc_eq;
  1123. /**
  1124. * maximum bitrate
  1125. * - encoding: Set by user.
  1126. * - decoding: unused
  1127. */
  1128. int rc_max_rate;
  1129. /**
  1130. * minimum bitrate
  1131. * - encoding: Set by user.
  1132. * - decoding: unused
  1133. */
  1134. int rc_min_rate;
  1135. /**
  1136. * decoder bitstream buffer size
  1137. * - encoding: Set by user.
  1138. * - decoding: unused
  1139. */
  1140. int rc_buffer_size;
  1141. float rc_buffer_aggressivity;
  1142. /**
  1143. * qscale factor between P and I-frames
  1144. * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
  1145. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1146. * - encoding: Set by user.
  1147. * - decoding: unused
  1148. */
  1149. float i_quant_factor;
  1150. /**
  1151. * qscale offset between P and I-frames
  1152. * - encoding: Set by user.
  1153. * - decoding: unused
  1154. */
  1155. float i_quant_offset;
  1156. /**
  1157. * initial complexity for pass1 ratecontrol
  1158. * - encoding: Set by user.
  1159. * - decoding: unused
  1160. */
  1161. float rc_initial_cplx;
  1162. /**
  1163. * DCT algorithm, see FF_DCT_* below
  1164. * - encoding: Set by user.
  1165. * - decoding: unused
  1166. */
  1167. int dct_algo;
  1168. #define FF_DCT_AUTO 0
  1169. #define FF_DCT_FASTINT 1
  1170. #define FF_DCT_INT 2
  1171. #define FF_DCT_MMX 3
  1172. #define FF_DCT_MLIB 4
  1173. #define FF_DCT_ALTIVEC 5
  1174. #define FF_DCT_FAAN 6
  1175. /**
  1176. * luminance masking (0-> disabled)
  1177. * - encoding: Set by user.
  1178. * - decoding: unused
  1179. */
  1180. float lumi_masking;
  1181. /**
  1182. * temporary complexity masking (0-> disabled)
  1183. * - encoding: Set by user.
  1184. * - decoding: unused
  1185. */
  1186. float temporal_cplx_masking;
  1187. /**
  1188. * spatial complexity masking (0-> disabled)
  1189. * - encoding: Set by user.
  1190. * - decoding: unused
  1191. */
  1192. float spatial_cplx_masking;
  1193. /**
  1194. * p block masking (0-> disabled)
  1195. * - encoding: Set by user.
  1196. * - decoding: unused
  1197. */
  1198. float p_masking;
  1199. /**
  1200. * darkness masking (0-> disabled)
  1201. * - encoding: Set by user.
  1202. * - decoding: unused
  1203. */
  1204. float dark_masking;
  1205. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  1206. /* for binary compatibility */
  1207. int unused;
  1208. #endif
  1209. /**
  1210. * IDCT algorithm, see FF_IDCT_* below.
  1211. * - encoding: Set by user.
  1212. * - decoding: Set by user.
  1213. */
  1214. int idct_algo;
  1215. #define FF_IDCT_AUTO 0
  1216. #define FF_IDCT_INT 1
  1217. #define FF_IDCT_SIMPLE 2
  1218. #define FF_IDCT_SIMPLEMMX 3
  1219. #define FF_IDCT_LIBMPEG2MMX 4
  1220. #define FF_IDCT_PS2 5
  1221. #define FF_IDCT_MLIB 6
  1222. #define FF_IDCT_ARM 7
  1223. #define FF_IDCT_ALTIVEC 8
  1224. #define FF_IDCT_SH4 9
  1225. #define FF_IDCT_SIMPLEARM 10
  1226. #define FF_IDCT_H264 11
  1227. #define FF_IDCT_VP3 12
  1228. #define FF_IDCT_IPP 13
  1229. #define FF_IDCT_XVIDMMX 14
  1230. #define FF_IDCT_CAVS 15
  1231. #define FF_IDCT_SIMPLEARMV5TE 16
  1232. #define FF_IDCT_SIMPLEARMV6 17
  1233. #define FF_IDCT_SIMPLEVIS 18
  1234. #define FF_IDCT_WMV2 19
  1235. #define FF_IDCT_FAAN 20
  1236. /**
  1237. * slice count
  1238. * - encoding: Set by libavcodec.
  1239. * - decoding: Set by user (or 0).
  1240. */
  1241. int slice_count;
  1242. /**
  1243. * slice offsets in the frame in bytes
  1244. * - encoding: Set/allocated by libavcodec.
  1245. * - decoding: Set/allocated by user (or NULL).
  1246. */
  1247. int *slice_offset;
  1248. /**
  1249. * error concealment flags
  1250. * - encoding: unused
  1251. * - decoding: Set by user.
  1252. */
  1253. int error_concealment;
  1254. #define FF_EC_GUESS_MVS 1
  1255. #define FF_EC_DEBLOCK 2
  1256. /**
  1257. * dsp_mask could be add used to disable unwanted CPU features
  1258. * CPU features (i.e. MMX, SSE. ...)
  1259. *
  1260. * With the FORCE flag you may instead enable given CPU features.
  1261. * (Dangerous: Usable in case of misdetection, improper usage however will
  1262. * result into program crash.)
  1263. */
  1264. unsigned dsp_mask;
  1265. #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
  1266. /* lower 16 bits - CPU features */
  1267. #define FF_MM_MMX 0x0001 ///< standard MMX
  1268. #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
  1269. #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
  1270. #define FF_MM_SSE 0x0008 ///< SSE functions
  1271. #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
  1272. #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
  1273. #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
  1274. #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
  1275. #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
  1276. /**
  1277. * bits per sample/pixel from the demuxer (needed for huffyuv).
  1278. * - encoding: Set by libavcodec.
  1279. * - decoding: Set by user.
  1280. */
  1281. int bits_per_sample;
  1282. /**
  1283. * prediction method (needed for huffyuv)
  1284. * - encoding: Set by user.
  1285. * - decoding: unused
  1286. */
  1287. int prediction_method;
  1288. #define FF_PRED_LEFT 0
  1289. #define FF_PRED_PLANE 1
  1290. #define FF_PRED_MEDIAN 2
  1291. /**
  1292. * sample aspect ratio (0 if unknown)
  1293. * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
  1294. * - encoding: Set by user.
  1295. * - decoding: Set by libavcodec.
  1296. */
  1297. AVRational sample_aspect_ratio;
  1298. /**
  1299. * the picture in the bitstream
  1300. * - encoding: Set by libavcodec.
  1301. * - decoding: Set by libavcodec.
  1302. */
  1303. AVFrame *coded_frame;
  1304. /**
  1305. * debug
  1306. * - encoding: Set by user.
  1307. * - decoding: Set by user.
  1308. */
  1309. int debug;
  1310. #define FF_DEBUG_PICT_INFO 1
  1311. #define FF_DEBUG_RC 2
  1312. #define FF_DEBUG_BITSTREAM 4
  1313. #define FF_DEBUG_MB_TYPE 8
  1314. #define FF_DEBUG_QP 16
  1315. #define FF_DEBUG_MV 32
  1316. #define FF_DEBUG_DCT_COEFF 0x00000040
  1317. #define FF_DEBUG_SKIP 0x00000080
  1318. #define FF_DEBUG_STARTCODE 0x00000100
  1319. #define FF_DEBUG_PTS 0x00000200
  1320. #define FF_DEBUG_ER 0x00000400
  1321. #define FF_DEBUG_MMCO 0x00000800
  1322. #define FF_DEBUG_BUGS 0x00001000
  1323. #define FF_DEBUG_VIS_QP 0x00002000
  1324. #define FF_DEBUG_VIS_MB_TYPE 0x00004000
  1325. /**
  1326. * debug
  1327. * - encoding: Set by user.
  1328. * - decoding: Set by user.
  1329. */
  1330. int debug_mv;
  1331. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
  1332. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
  1333. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
  1334. /**
  1335. * error
  1336. * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
  1337. * - decoding: unused
  1338. */
  1339. uint64_t error[4];
  1340. /**
  1341. * minimum MB quantizer
  1342. * - encoding: unused
  1343. * - decoding: unused
  1344. */
  1345. int mb_qmin;
  1346. /**
  1347. * maximum MB quantizer
  1348. * - encoding: unused
  1349. * - decoding: unused
  1350. */
  1351. int mb_qmax;
  1352. /**
  1353. * motion estimation comparison function
  1354. * - encoding: Set by user.
  1355. * - decoding: unused
  1356. */
  1357. int me_cmp;
  1358. /**
  1359. * subpixel motion estimation comparison function
  1360. * - encoding: Set by user.
  1361. * - decoding: unused
  1362. */
  1363. int me_sub_cmp;
  1364. /**
  1365. * macroblock comparison function (not supported yet)
  1366. * - encoding: Set by user.
  1367. * - decoding: unused
  1368. */
  1369. int mb_cmp;
  1370. /**
  1371. * interlaced DCT comparison function
  1372. * - encoding: Set by user.
  1373. * - decoding: unused
  1374. */
  1375. int ildct_cmp;
  1376. #define FF_CMP_SAD 0
  1377. #define FF_CMP_SSE 1
  1378. #define FF_CMP_SATD 2
  1379. #define FF_CMP_DCT 3
  1380. #define FF_CMP_PSNR 4
  1381. #define FF_CMP_BIT 5
  1382. #define FF_CMP_RD 6
  1383. #define FF_CMP_ZERO 7
  1384. #define FF_CMP_VSAD 8
  1385. #define FF_CMP_VSSE 9
  1386. #define FF_CMP_NSSE 10
  1387. #define FF_CMP_W53 11
  1388. #define FF_CMP_W97 12
  1389. #define FF_CMP_DCTMAX 13
  1390. #define FF_CMP_DCT264 14
  1391. #define FF_CMP_CHROMA 256
  1392. /**
  1393. * ME diamond size & shape
  1394. * - encoding: Set by user.
  1395. * - decoding: unused
  1396. */
  1397. int dia_size;
  1398. /**
  1399. * amount of previous MV predictors (2a+1 x 2a+1 square)
  1400. * - encoding: Set by user.
  1401. * - decoding: unused
  1402. */
  1403. int last_predictor_count;
  1404. /**
  1405. * prepass for motion estimation
  1406. * - encoding: Set by user.
  1407. * - decoding: unused
  1408. */
  1409. int pre_me;
  1410. /**
  1411. * motion estimation prepass comparison function
  1412. * - encoding: Set by user.
  1413. * - decoding: unused
  1414. */
  1415. int me_pre_cmp;
  1416. /**
  1417. * ME prepass diamond size & shape
  1418. * - encoding: Set by user.
  1419. * - decoding: unused
  1420. */
  1421. int pre_dia_size;
  1422. /**
  1423. * subpel ME quality
  1424. * - encoding: Set by user.
  1425. * - decoding: unused
  1426. */
  1427. int me_subpel_quality;
  1428. /**
  1429. * callback to negotiate the pixelFormat
  1430. * @param fmt is the list of formats which are supported by the codec,
  1431. * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
  1432. * The first is always the native one.
  1433. * @return the chosen format
  1434. * - encoding: unused
  1435. * - decoding: Set by user, if not set the native format will be chosen.
  1436. */
  1437. enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
  1438. /**
  1439. * DTG active format information (additional aspect ratio
  1440. * information only used in DVB MPEG-2 transport streams)
  1441. * 0 if not set.
  1442. *
  1443. * - encoding: unused
  1444. * - decoding: Set by decoder.
  1445. */
  1446. int dtg_active_format;
  1447. #define FF_DTG_AFD_SAME 8
  1448. #define FF_DTG_AFD_4_3 9
  1449. #define FF_DTG_AFD_16_9 10
  1450. #define FF_DTG_AFD_14_9 11
  1451. #define FF_DTG_AFD_4_3_SP_14_9 13
  1452. #define FF_DTG_AFD_16_9_SP_14_9 14
  1453. #define FF_DTG_AFD_SP_4_3 15
  1454. /**
  1455. * maximum motion estimation search range in subpel units
  1456. * If 0 then no limit.
  1457. *
  1458. * - encoding: Set by user.
  1459. * - decoding: unused
  1460. */
  1461. int me_range;
  1462. /**
  1463. * intra quantizer bias
  1464. * - encoding: Set by user.
  1465. * - decoding: unused
  1466. */
  1467. int intra_quant_bias;
  1468. #define FF_DEFAULT_QUANT_BIAS 999999
  1469. /**
  1470. * inter quantizer bias
  1471. * - encoding: Set by user.
  1472. * - decoding: unused
  1473. */
  1474. int inter_quant_bias;
  1475. /**
  1476. * color table ID
  1477. * - encoding: unused
  1478. * - decoding: Which clrtable should be used for 8bit RGB images.
  1479. * Tables have to be stored somewhere. FIXME
  1480. */
  1481. int color_table_id;
  1482. /**
  1483. * internal_buffer count
  1484. * Don't touch, used by libavcodec default_get_buffer().
  1485. */
  1486. int internal_buffer_count;
  1487. /**
  1488. * internal_buffers
  1489. * Don't touch, used by libavcodec default_get_buffer().
  1490. */
  1491. void *internal_buffer;
  1492. #define FF_LAMBDA_SHIFT 7
  1493. #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
  1494. #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
  1495. #define FF_LAMBDA_MAX (256*128-1)
  1496. #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
  1497. /**
  1498. * Global quality for codecs which cannot change it per frame.
  1499. * This should be proportional to MPEG-1/2/4 qscale.
  1500. * - encoding: Set by user.
  1501. * - decoding: unused
  1502. */
  1503. int global_quality;
  1504. #define FF_CODER_TYPE_VLC 0
  1505. #define FF_CODER_TYPE_AC 1
  1506. #define FF_CODER_TYPE_RAW 2
  1507. #define FF_CODER_TYPE_RLE 3
  1508. #define FF_CODER_TYPE_DEFLATE 4
  1509. /**
  1510. * coder type
  1511. * - encoding: Set by user.
  1512. * - decoding: unused
  1513. */
  1514. int coder_type;
  1515. /**
  1516. * context model
  1517. * - encoding: Set by user.
  1518. * - decoding: unused
  1519. */
  1520. int context_model;
  1521. #if 0
  1522. /**
  1523. *
  1524. * - encoding: unused
  1525. * - decoding: Set by user.
  1526. */
  1527. uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
  1528. #endif
  1529. /**
  1530. * slice flags
  1531. * - encoding: unused
  1532. * - decoding: Set by user.
  1533. */
  1534. int slice_flags;
  1535. #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
  1536. #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
  1537. #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
  1538. /**
  1539. * XVideo Motion Acceleration
  1540. * - encoding: forbidden
  1541. * - decoding: set by decoder
  1542. */
  1543. int xvmc_acceleration;
  1544. /**
  1545. * macroblock decision mode
  1546. * - encoding: Set by user.
  1547. * - decoding: unused
  1548. */
  1549. int mb_decision;
  1550. #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
  1551. #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
  1552. #define FF_MB_DECISION_RD 2 ///< rate distoration
  1553. /**
  1554. * custom intra quantization matrix
  1555. * - encoding: Set by user, can be NULL.
  1556. * - decoding: Set by libavcodec.
  1557. */
  1558. uint16_t *intra_matrix;
  1559. /**
  1560. * custom inter quantization matrix
  1561. * - encoding: Set by user, can be NULL.
  1562. * - decoding: Set by libavcodec.
  1563. */
  1564. uint16_t *inter_matrix;
  1565. /**
  1566. * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1567. * This is used to work around some encoder bugs.
  1568. * - encoding: unused
  1569. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1570. */
  1571. unsigned int stream_codec_tag;
  1572. /**
  1573. * scene change detection threshold
  1574. * 0 is default, larger means fewer detected scene changes.
  1575. * - encoding: Set by user.
  1576. * - decoding: unused
  1577. */
  1578. int scenechange_threshold;
  1579. /**
  1580. * minimum Lagrange multipler
  1581. * - encoding: Set by user.
  1582. * - decoding: unused
  1583. */
  1584. int lmin;
  1585. /**
  1586. * maximum Lagrange multipler
  1587. * - encoding: Set by user.
  1588. * - decoding: unused
  1589. */
  1590. int lmax;
  1591. /**
  1592. * palette control structure
  1593. * - encoding: ??? (no palette-enabled encoder yet)
  1594. * - decoding: Set by user.
  1595. */
  1596. struct AVPaletteControl *palctrl;
  1597. /**
  1598. * noise reduction strength
  1599. * - encoding: Set by user.
  1600. * - decoding: unused
  1601. */
  1602. int noise_reduction;
  1603. /**
  1604. * Called at the beginning of a frame to get cr buffer for it.
  1605. * Buffer type (size, hints) must be the same. libavcodec won't check it.
  1606. * libavcodec will pass previous buffer in pic, function should return
  1607. * same buffer or new buffer with old frame "painted" into it.
  1608. * If pic.data[0] == NULL must behave like get_buffer().
  1609. * - encoding: unused
  1610. * - decoding: Set by libavcodec., user can override
  1611. */
  1612. int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1613. /**
  1614. * Number of bits which should be loaded into the rc buffer before decoding starts.
  1615. * - encoding: Set by user.
  1616. * - decoding: unused
  1617. */
  1618. int rc_initial_buffer_occupancy;
  1619. /**
  1620. *
  1621. * - encoding: Set by user.
  1622. * - decoding: unused
  1623. */
  1624. int inter_threshold;
  1625. /**
  1626. * CODEC_FLAG2_*
  1627. * - encoding: Set by user.
  1628. * - decoding: Set by user.
  1629. */
  1630. int flags2;
  1631. /**
  1632. * Simulates errors in the bitstream to test error concealment.
  1633. * - encoding: Set by user.
  1634. * - decoding: unused
  1635. */
  1636. int error_rate;
  1637. /**
  1638. * MP3 antialias algorithm, see FF_AA_* below.
  1639. * - encoding: unused
  1640. * - decoding: Set by user.
  1641. */
  1642. int antialias_algo;
  1643. #define FF_AA_AUTO 0
  1644. #define FF_AA_FASTINT 1 //not implemented yet
  1645. #define FF_AA_INT 2
  1646. #define FF_AA_FLOAT 3
  1647. /**
  1648. * quantizer noise shaping
  1649. * - encoding: Set by user.
  1650. * - decoding: unused
  1651. */
  1652. int quantizer_noise_shaping;
  1653. /**
  1654. * thread count
  1655. * is used to decide how many independent tasks should be passed to execute()
  1656. * - encoding: Set by user.
  1657. * - decoding: Set by user.
  1658. */
  1659. int thread_count;
  1660. /**
  1661. * The codec may call this to execute several independent things.
  1662. * It will return only after finishing all tasks.
  1663. * The user may replace this with some multithreaded implementation,
  1664. * the default implementation will execute the parts serially.
  1665. * @param count the number of things to execute
  1666. * - encoding: Set by libavcodec, user can override.
  1667. * - decoding: Set by libavcodec, user can override.
  1668. */
  1669. int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
  1670. /**
  1671. * thread opaque
  1672. * Can be used by execute() to store some per AVCodecContext stuff.
  1673. * - encoding: set by execute()
  1674. * - decoding: set by execute()
  1675. */
  1676. void *thread_opaque;
  1677. /**
  1678. * Motion estimation threshold below which no motion estimation is
  1679. * performed, but instead the user specified motion vectors are used.
  1680. *
  1681. * - encoding: Set by user.
  1682. * - decoding: unused
  1683. */
  1684. int me_threshold;
  1685. /**
  1686. * Macroblock threshold below which the user specified macroblock types will be used.
  1687. * - encoding: Set by user.
  1688. * - decoding: unused
  1689. */
  1690. int mb_threshold;
  1691. /**
  1692. * precision of the intra DC coefficient - 8
  1693. * - encoding: Set by user.
  1694. * - decoding: unused
  1695. */
  1696. int intra_dc_precision;
  1697. /**
  1698. * noise vs. sse weight for the nsse comparsion function
  1699. * - encoding: Set by user.
  1700. * - decoding: unused
  1701. */
  1702. int nsse_weight;
  1703. /**
  1704. * Number of macroblock rows at the top which are skipped.
  1705. * - encoding: unused
  1706. * - decoding: Set by user.
  1707. */
  1708. int skip_top;
  1709. /**
  1710. * Number of macroblock rows at the bottom which are skipped.
  1711. * - encoding: unused
  1712. * - decoding: Set by user.
  1713. */
  1714. int skip_bottom;
  1715. /**
  1716. * profile
  1717. * - encoding: Set by user.
  1718. * - decoding: Set by libavcodec.
  1719. */
  1720. int profile;
  1721. #define FF_PROFILE_UNKNOWN -99
  1722. #define FF_PROFILE_AAC_MAIN 0
  1723. #define FF_PROFILE_AAC_LOW 1
  1724. #define FF_PROFILE_AAC_SSR 2
  1725. #define FF_PROFILE_AAC_LTP 3
  1726. /**
  1727. * level
  1728. * - encoding: Set by user.
  1729. * - decoding: Set by libavcodec.
  1730. */
  1731. int level;
  1732. #define FF_LEVEL_UNKNOWN -99
  1733. /**
  1734. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  1735. * - encoding: unused
  1736. * - decoding: Set by user.
  1737. */
  1738. int lowres;
  1739. /**
  1740. * Bitstream width / height, may be different from width/height if lowres
  1741. * or other things are used.
  1742. * - encoding: unused
  1743. * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
  1744. */
  1745. int coded_width, coded_height;
  1746. /**
  1747. * frame skip threshold
  1748. * - encoding: Set by user.
  1749. * - decoding: unused
  1750. */
  1751. int frame_skip_threshold;
  1752. /**
  1753. * frame skip factor
  1754. * - encoding: Set by user.
  1755. * - decoding: unused
  1756. */
  1757. int frame_skip_factor;
  1758. /**
  1759. * frame skip exponent
  1760. * - encoding: Set by user.
  1761. * - decoding: unused
  1762. */
  1763. int frame_skip_exp;
  1764. /**
  1765. * frame skip comparison function
  1766. * - encoding: Set by user.
  1767. * - decoding: unused
  1768. */
  1769. int frame_skip_cmp;
  1770. /**
  1771. * Border processing masking, raises the quantizer for mbs on the borders
  1772. * of the picture.
  1773. * - encoding: Set by user.
  1774. * - decoding: unused
  1775. */
  1776. float border_masking;
  1777. /**
  1778. * minimum MB lagrange multipler
  1779. * - encoding: Set by user.
  1780. * - decoding: unused
  1781. */
  1782. int mb_lmin;
  1783. /**
  1784. * maximum MB lagrange multipler
  1785. * - encoding: Set by user.
  1786. * - decoding: unused
  1787. */
  1788. int mb_lmax;
  1789. /**
  1790. *
  1791. * - encoding: Set by user.
  1792. * - decoding: unused
  1793. */
  1794. int me_penalty_compensation;
  1795. /**
  1796. *
  1797. * - encoding: unused
  1798. * - decoding: Set by user.
  1799. */
  1800. enum AVDiscard skip_loop_filter;
  1801. /**
  1802. *
  1803. * - encoding: unused
  1804. * - decoding: Set by user.
  1805. */
  1806. enum AVDiscard skip_idct;
  1807. /**
  1808. *
  1809. * - encoding: unused
  1810. * - decoding: Set by user.
  1811. */
  1812. enum AVDiscard skip_frame;
  1813. /**
  1814. *
  1815. * - encoding: Set by user.
  1816. * - decoding: unused
  1817. */
  1818. int bidir_refine;
  1819. /**
  1820. *
  1821. * - encoding: Set by user.
  1822. * - decoding: unused
  1823. */
  1824. int brd_scale;
  1825. /**
  1826. * constant rate factor - quality-based VBR - values ~correspond to qps
  1827. * - encoding: Set by user.
  1828. * - decoding: unused
  1829. */
  1830. float crf;
  1831. /**
  1832. * constant quantization parameter rate control method
  1833. * - encoding: Set by user.
  1834. * - decoding: unused
  1835. */
  1836. int cqp;
  1837. /**
  1838. * minimum GOP size
  1839. * - encoding: Set by user.
  1840. * - decoding: unused
  1841. */
  1842. int keyint_min;
  1843. /**
  1844. * number of reference frames
  1845. * - encoding: Set by user.
  1846. * - decoding: unused
  1847. */
  1848. int refs;
  1849. /**
  1850. * chroma qp offset from luma
  1851. * - encoding: Set by user.
  1852. * - decoding: unused
  1853. */
  1854. int chromaoffset;
  1855. /**
  1856. * Influences how often B-frames are used.
  1857. * - encoding: Set by user.
  1858. * - decoding: unused
  1859. */
  1860. int bframebias;
  1861. /**
  1862. * trellis RD quantization
  1863. * - encoding: Set by user.
  1864. * - decoding: unused
  1865. */
  1866. int trellis;
  1867. /**
  1868. * Reduce fluctuations in qp (before curve compression).
  1869. * - encoding: Set by user.
  1870. * - decoding: unused
  1871. */
  1872. float complexityblur;
  1873. /**
  1874. * in-loop deblocking filter alphac0 parameter
  1875. * alpha is in the range -6...6
  1876. * - encoding: Set by user.
  1877. * - decoding: unused
  1878. */
  1879. int deblockalpha;
  1880. /**
  1881. * in-loop deblocking filter beta parameter
  1882. * beta is in the range -6...6
  1883. * - encoding: Set by user.
  1884. * - decoding: unused
  1885. */
  1886. int deblockbeta;
  1887. /**
  1888. * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
  1889. * - encoding: Set by user.
  1890. * - decoding: unused
  1891. */
  1892. int partitions;
  1893. #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
  1894. #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
  1895. #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
  1896. #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
  1897. #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
  1898. /**
  1899. * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
  1900. * - encoding: Set by user.
  1901. * - decoding: unused
  1902. */
  1903. int directpred;
  1904. /**
  1905. * Audio cutoff bandwidth (0 means "automatic")
  1906. * - encoding: Set by user.
  1907. * - decoding: unused
  1908. */
  1909. int cutoff;
  1910. /**
  1911. * Multiplied by qscale for each frame and added to scene_change_score.
  1912. * - encoding: Set by user.
  1913. * - decoding: unused
  1914. */
  1915. int scenechange_factor;
  1916. /**
  1917. *
  1918. * Note: Value depends upon the compare function used for fullpel ME.
  1919. * - encoding: Set by user.
  1920. * - decoding: unused
  1921. */
  1922. int mv0_threshold;
  1923. /**
  1924. * Adjusts sensitivity of b_frame_strategy 1.
  1925. * - encoding: Set by user.
  1926. * - decoding: unused
  1927. */
  1928. int b_sensitivity;
  1929. /**
  1930. * - encoding: Set by user.
  1931. * - decoding: unused
  1932. */
  1933. int compression_level;
  1934. #define FF_COMPRESSION_DEFAULT -1
  1935. /**
  1936. * Sets whether to use LPC mode - used by FLAC encoder.
  1937. * - encoding: Set by user.
  1938. * - decoding: unused
  1939. */
  1940. int use_lpc;
  1941. /**
  1942. * LPC coefficient precision - used by FLAC encoder
  1943. * - encoding: Set by user.
  1944. * - decoding: unused
  1945. */
  1946. int lpc_coeff_precision;
  1947. /**
  1948. * - encoding: Set by user.
  1949. * - decoding: unused
  1950. */
  1951. int min_prediction_order;
  1952. /**
  1953. * - encoding: Set by user.
  1954. * - decoding: unused
  1955. */
  1956. int max_prediction_order;
  1957. /**
  1958. * search method for selecting prediction order
  1959. * - encoding: Set by user.
  1960. * - decoding: unused
  1961. */
  1962. int prediction_order_method;
  1963. /**
  1964. * - encoding: Set by user.
  1965. * - decoding: unused
  1966. */
  1967. int min_partition_order;
  1968. /**
  1969. * - encoding: Set by user.
  1970. * - decoding: unused
  1971. */
  1972. int max_partition_order;
  1973. /**
  1974. * GOP timecode frame start number, in non drop frame format
  1975. * - encoding: Set by user.
  1976. * - decoding: unused
  1977. */
  1978. int64_t timecode_frame_start;
  1979. /**
  1980. * Decoder should decode to this many channels if it can (0 for default)
  1981. * - encoding: unused
  1982. * - decoding: Set by user.
  1983. */
  1984. int request_channels;
  1985. /**
  1986. * Percentage of dynamic range compression to be applied by the decoder.
  1987. * The default value is 1.0, corresponding to full compression.
  1988. * - encoding: unused
  1989. * - decoding: Set by user.
  1990. */
  1991. float drc_scale;
  1992. } AVCodecContext;
  1993. /**
  1994. * AVCodec.
  1995. */
  1996. typedef struct AVCodec {
  1997. /**
  1998. * Name of the codec implementation.
  1999. * The name is globally unique among encoders and among decoders (but an
  2000. * encoder and a decoder can share the same name).
  2001. * This is the primary way to find a codec from the user perspective.
  2002. */
  2003. const char *name;
  2004. enum CodecType type;
  2005. enum CodecID id;
  2006. int priv_data_size;
  2007. int (*init)(AVCodecContext *);
  2008. int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
  2009. int (*close)(AVCodecContext *);
  2010. int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
  2011. const uint8_t *buf, int buf_size);
  2012. /**
  2013. * Codec capabilities.
  2014. * see CODEC_CAP_*
  2015. */
  2016. int capabilities;
  2017. struct AVCodec *next;
  2018. /**
  2019. * Flush buffers.
  2020. * Will be called when seeking
  2021. */
  2022. void (*flush)(AVCodecContext *);
  2023. const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
  2024. const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
  2025. } AVCodec;
  2026. /**
  2027. * four components are given, that's all.
  2028. * the last component is alpha
  2029. */
  2030. typedef struct AVPicture {
  2031. uint8_t *data[4];
  2032. int linesize[4]; ///< number of bytes per line
  2033. } AVPicture;
  2034. /**
  2035. * AVPaletteControl
  2036. * This structure defines a method for communicating palette changes
  2037. * between and demuxer and a decoder.
  2038. *
  2039. * @deprecated Use AVPacket to send palette changes instead.
  2040. * This is totally broken.
  2041. */
  2042. #define AVPALETTE_SIZE 1024
  2043. #define AVPALETTE_COUNT 256
  2044. typedef struct AVPaletteControl {
  2045. /* Demuxer sets this to 1 to indicate the palette has changed;
  2046. * decoder resets to 0. */
  2047. int palette_changed;
  2048. /* 4-byte ARGB palette entries, stored in native byte order; note that
  2049. * the individual palette components should be on a 8-bit scale; if
  2050. * the palette data comes from an IBM VGA native format, the component
  2051. * data is probably 6 bits in size and needs to be scaled. */
  2052. unsigned int palette[AVPALETTE_COUNT];
  2053. } AVPaletteControl attribute_deprecated;
  2054. typedef struct AVSubtitleRect {
  2055. uint16_t x;
  2056. uint16_t y;
  2057. uint16_t w;
  2058. uint16_t h;
  2059. uint16_t nb_colors;
  2060. int linesize;
  2061. uint32_t *rgba_palette;
  2062. uint8_t *bitmap;
  2063. } AVSubtitleRect;
  2064. typedef struct AVSubtitle {
  2065. uint16_t format; /* 0 = graphics */
  2066. uint32_t start_display_time; /* relative to packet pts, in ms */
  2067. uint32_t end_display_time; /* relative to packet pts, in ms */
  2068. uint32_t num_rects;
  2069. AVSubtitleRect *rects;
  2070. } AVSubtitle;
  2071. /* resample.c */
  2072. struct ReSampleContext;
  2073. struct AVResampleContext;
  2074. typedef struct ReSampleContext ReSampleContext;
  2075. ReSampleContext *audio_resample_init(int output_channels, int input_channels,
  2076. int output_rate, int input_rate);
  2077. int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
  2078. void audio_resample_close(ReSampleContext *s);
  2079. struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
  2080. int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
  2081. void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
  2082. void av_resample_close(struct AVResampleContext *c);
  2083. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  2084. /* YUV420 format is assumed ! */
  2085. /**
  2086. * @deprecated Use the software scaler (swscale) instead.
  2087. */
  2088. typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
  2089. /**
  2090. * @deprecated Use the software scaler (swscale) instead.
  2091. */
  2092. attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
  2093. int input_width, int input_height);
  2094. /**
  2095. * @deprecated Use the software scaler (swscale) instead.
  2096. */
  2097. attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
  2098. int iwidth, int iheight,
  2099. int topBand, int bottomBand,
  2100. int leftBand, int rightBand,
  2101. int padtop, int padbottom,
  2102. int padleft, int padright);
  2103. /**
  2104. * @deprecated Use the software scaler (swscale) instead.
  2105. */
  2106. attribute_deprecated void img_resample(struct ImgReSampleContext *s,
  2107. AVPicture *output, const AVPicture *input);
  2108. /**
  2109. * @deprecated Use the software scaler (swscale) instead.
  2110. */
  2111. attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
  2112. #endif
  2113. /**
  2114. * Allocate memory for a picture. Call avpicture_free to free it.
  2115. *
  2116. * @param picture the picture to be filled in
  2117. * @param pix_fmt the format of the picture
  2118. * @param width the width of the picture
  2119. * @param height the height of the picture
  2120. * @return zero if successful, a negative value if not
  2121. */
  2122. int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
  2123. /**
  2124. * Free a picture previously allocated by avpicture_alloc().
  2125. *
  2126. * @param picture the AVPicture to be freed
  2127. */
  2128. void avpicture_free(AVPicture *picture);
  2129. /**
  2130. * Fill in the AVPicture fields.
  2131. * The fields of the given AVPicture are filled in by using the 'ptr' address
  2132. * which points to the image data buffer. Depending on the specified picture
  2133. * format, one or multiple image data pointers and line sizes will be set.
  2134. * If a planar format is specified, several pointers will be set pointing to
  2135. * the different picture planes and the line sizes of the different planes
  2136. * will be stored in the lines_sizes array.
  2137. *
  2138. * @param picture AVPicture whose fields are to be filled in
  2139. * @param ptr Buffer which will contain or contains the actual image data
  2140. * @param pix_fmt The format in which the picture data is stored.
  2141. * @param width the width of the image in pixels
  2142. * @param height the height of the image in pixels
  2143. * @return size of the image data in bytes
  2144. */
  2145. int avpicture_fill(AVPicture *picture, uint8_t *ptr,
  2146. int pix_fmt, int width, int height);
  2147. int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
  2148. unsigned char *dest, int dest_size);
  2149. /**
  2150. * Calculate the size in bytes that a picture of the given width and height
  2151. * would occupy if stored in the given picture format.
  2152. *
  2153. * @param pix_fmt the given picture format
  2154. * @param width the width of the image
  2155. * @param height the height of the image
  2156. * @return Image data size in bytes
  2157. */
  2158. int avpicture_get_size(int pix_fmt, int width, int height);
  2159. void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
  2160. const char *avcodec_get_pix_fmt_name(int pix_fmt);
  2161. void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
  2162. enum PixelFormat avcodec_get_pix_fmt(const char* name);
  2163. unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
  2164. #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
  2165. #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
  2166. #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
  2167. #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
  2168. #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
  2169. #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
  2170. /**
  2171. * Computes what kind of losses will occur when converting from one specific
  2172. * pixel format to another.
  2173. * When converting from one pixel format to another, information loss may occur.
  2174. * For example, when converting from RGB24 to GRAY, the color information will
  2175. * be lost. Similarly, other losses occur when converting from some formats to
  2176. * other formats. These losses can involve loss of chroma, but also loss of
  2177. * resolution, loss of color depth, loss due to the color space conversion, loss
  2178. * of the alpha bits or loss due to color quantization.
  2179. * avcodec_get_fix_fmt_loss() informs you about the various types of losses
  2180. * which will occur when converting from one pixel format to another.
  2181. *
  2182. * @param[in] dst_pix_fmt destination pixel format
  2183. * @param[in] src_pix_fmt source pixel format
  2184. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  2185. * @return Combination of flags informing you what kind of losses will occur.
  2186. */
  2187. int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
  2188. int has_alpha);
  2189. /**
  2190. * Finds the best pixel format to convert to given a certain source pixel
  2191. * format. When converting from one pixel format to another, information loss
  2192. * may occur. For example, when converting from RGB24 to GRAY, the color
  2193. * information will be lost. Similarly, other losses occur when converting from
  2194. * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
  2195. * the given pixel formats should be used to suffer the least amount of loss.
  2196. * The pixel formats from which it chooses one, are determined by the
  2197. * \p pix_fmt_mask parameter.
  2198. *
  2199. * @code
  2200. * src_pix_fmt = PIX_FMT_YUV420P;
  2201. * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
  2202. * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
  2203. * @endcode
  2204. *
  2205. * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
  2206. * @param[in] src_pix_fmt source pixel format
  2207. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  2208. * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  2209. * @return The best pixel format to convert to or -1 if none was found.
  2210. */
  2211. int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
  2212. int has_alpha, int *loss_ptr);
  2213. /**
  2214. * Print in buf the string corresponding to the pixel format with
  2215. * number pix_fmt, or an header if pix_fmt is negative.
  2216. *
  2217. * @param[in] buf the buffer where to write the string
  2218. * @param[in] buf_size the size of buf
  2219. * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
  2220. * a negative value to print the corresponding header.
  2221. * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
  2222. */
  2223. void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
  2224. #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
  2225. #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
  2226. /**
  2227. * Tell if an image really has transparent alpha values.
  2228. * @return ored mask of FF_ALPHA_xxx constants
  2229. */
  2230. int img_get_alpha_info(const AVPicture *src,
  2231. int pix_fmt, int width, int height);
  2232. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  2233. /**
  2234. * convert among pixel formats
  2235. * @deprecated Use the software scaler (swscale) instead.
  2236. */
  2237. attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
  2238. const AVPicture *src, int pix_fmt,
  2239. int width, int height);
  2240. #endif
  2241. /* deinterlace a picture */
  2242. /* deinterlace - if not supported return -1 */
  2243. int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
  2244. int pix_fmt, int width, int height);
  2245. /* external high level API */
  2246. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  2247. extern AVCodec *first_avcodec;
  2248. #endif
  2249. AVCodec *av_codec_next(AVCodec *c);
  2250. /* returns LIBAVCODEC_VERSION_INT constant */
  2251. unsigned avcodec_version(void);
  2252. /* returns LIBAVCODEC_BUILD constant */
  2253. unsigned avcodec_build(void);
  2254. /**
  2255. * Initializes libavcodec.
  2256. *
  2257. * @warning This function \e must be called before any other libavcodec
  2258. * function.
  2259. */
  2260. void avcodec_init(void);
  2261. void register_avcodec(AVCodec *format);
  2262. /**
  2263. * Finds a registered encoder with a matching codec ID.
  2264. *
  2265. * @param id CodecID of the requested encoder
  2266. * @return An encoder if one was found, NULL otherwise.
  2267. */
  2268. AVCodec *avcodec_find_encoder(enum CodecID id);
  2269. /**
  2270. * Finds a registered encoder with the specified name.
  2271. *
  2272. * @param name name of the requested encoder
  2273. * @return An encoder if one was found, NULL otherwise.
  2274. */
  2275. AVCodec *avcodec_find_encoder_by_name(const char *name);
  2276. /**
  2277. * Finds a registered decoder with a matching codec ID.
  2278. *
  2279. * @param id CodecID of the requested decoder
  2280. * @return A decoder if one was found, NULL otherwise.
  2281. */
  2282. AVCodec *avcodec_find_decoder(enum CodecID id);
  2283. /**
  2284. * Finds a registered decoder with the specified name.
  2285. *
  2286. * @param name name of the requested decoder
  2287. * @return A decoder if one was found, NULL otherwise.
  2288. */
  2289. AVCodec *avcodec_find_decoder_by_name(const char *name);
  2290. void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
  2291. /**
  2292. * Sets the fields of the given AVCodecContext to default values.
  2293. *
  2294. * @param s The AVCodecContext of which the fields should be set to default values.
  2295. */
  2296. void avcodec_get_context_defaults(AVCodecContext *s);
  2297. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  2298. * we WILL change its arguments and name a few times! */
  2299. void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
  2300. /**
  2301. * Allocates an AVCodecContext and sets its fields to default values. The
  2302. * resulting struct can be deallocated by simply calling av_free().
  2303. *
  2304. * @return An AVCodecContext filled with default values or NULL on failure.
  2305. * @see avcodec_get_context_defaults
  2306. */
  2307. AVCodecContext *avcodec_alloc_context(void);
  2308. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  2309. * we WILL change its arguments and name a few times! */
  2310. AVCodecContext *avcodec_alloc_context2(enum CodecType);
  2311. /**
  2312. * Sets the fields of the given AVFrame to default values.
  2313. *
  2314. * @param pic The AVFrame of which the fields should be set to default values.
  2315. */
  2316. void avcodec_get_frame_defaults(AVFrame *pic);
  2317. /**
  2318. * Allocates an AVFrame and sets its fields to default values. The resulting
  2319. * struct can be deallocated by simply calling av_free().
  2320. *
  2321. * @return An AVFrame filled with default values or NULL on failure.
  2322. * @see avcodec_get_frame_defaults
  2323. */
  2324. AVFrame *avcodec_alloc_frame(void);
  2325. int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
  2326. void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
  2327. int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
  2328. void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
  2329. /**
  2330. * Checks if the given dimension of a picture is valid, meaning that all
  2331. * bytes of the picture can be addressed with a signed int.
  2332. *
  2333. * @param[in] w Width of the picture.
  2334. * @param[in] h Height of the picture.
  2335. * @return Zero if valid, a negative value if invalid.
  2336. */
  2337. int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
  2338. enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
  2339. int avcodec_thread_init(AVCodecContext *s, int thread_count);
  2340. void avcodec_thread_free(AVCodecContext *s);
  2341. int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
  2342. int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
  2343. //FIXME func typedef
  2344. /**
  2345. * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
  2346. * function the context has to be allocated.
  2347. *
  2348. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  2349. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  2350. * retrieving a codec.
  2351. *
  2352. * @warning This function is not thread safe!
  2353. *
  2354. * @code
  2355. * avcodec_register_all();
  2356. * codec = avcodec_find_decoder(CODEC_ID_H264);
  2357. * if (!codec)
  2358. * exit(1);
  2359. *
  2360. * context = avcodec_alloc_context();
  2361. *
  2362. * if (avcodec_open(context, codec) < 0)
  2363. * exit(1);
  2364. * @endcode
  2365. *
  2366. * @param avctx The context which will be set up to use the given codec.
  2367. * @param codec The codec to use within the context.
  2368. * @return zero on success, a negative value on error
  2369. * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
  2370. */
  2371. int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
  2372. /**
  2373. * @deprecated Use avcodec_decode_audio2() instead.
  2374. */
  2375. attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
  2376. int *frame_size_ptr,
  2377. const uint8_t *buf, int buf_size);
  2378. /**
  2379. * Decodes an audio frame from \p buf into \p samples.
  2380. * The avcodec_decode_audio2() function decodes an audio frame from the input
  2381. * buffer \p buf of size \p buf_size. To decode it, it makes use of the
  2382. * audio codec which was coupled with \p avctx using avcodec_open(). The
  2383. * resulting decoded frame is stored in output buffer \p samples. If no frame
  2384. * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
  2385. * decompressed frame size in \e bytes.
  2386. *
  2387. * @warning You \e must set \p frame_size_ptr to the allocated size of the
  2388. * output buffer before calling avcodec_decode_audio2().
  2389. *
  2390. * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
  2391. * the actual read bytes because some optimized bitstream readers read 32 or 64
  2392. * bits at once and could read over the end.
  2393. *
  2394. * @warning The end of the input buffer \p buf should be set to 0 to ensure that
  2395. * no overreading happens for damaged MPEG streams.
  2396. *
  2397. * @note You might have to align the input buffer \p buf and output buffer \p
  2398. * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
  2399. * necessary at all, on others it won't work at all if not aligned and on others
  2400. * it will work but it will have an impact on performance. In practice, the
  2401. * bitstream should have 4 byte alignment at minimum and all sample data should
  2402. * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
  2403. * the linesize is not a multiple of 16 then there's no sense in aligning the
  2404. * start of the buffer to 16.
  2405. *
  2406. * @param avctx the codec context
  2407. * @param[out] samples the output buffer
  2408. * @param[in,out] frame_size_ptr the output buffer size in bytes
  2409. * @param[in] buf the input buffer
  2410. * @param[in] buf_size the input buffer size in bytes
  2411. * @return On error a negative value is returned, otherwise the number of bytes
  2412. * used or zero if no frame could be decompressed.
  2413. */
  2414. int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
  2415. int *frame_size_ptr,
  2416. const uint8_t *buf, int buf_size);
  2417. /**
  2418. * Decodes a video frame from \p buf into \p picture.
  2419. * The avcodec_decode_video() function decodes a video frame from the input
  2420. * buffer \p buf of size \p buf_size. To decode it, it makes use of the
  2421. * video codec which was coupled with \p avctx using avcodec_open(). The
  2422. * resulting decoded frame is stored in \p picture.
  2423. *
  2424. * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
  2425. * the actual read bytes because some optimized bitstream readers read 32 or 64
  2426. * bits at once and could read over the end.
  2427. *
  2428. * @warning The end of the input buffer \p buf should be set to 0 to ensure that
  2429. * no overreading happens for damaged MPEG streams.
  2430. *
  2431. * @note You might have to align the input buffer \p buf and output buffer \p
  2432. * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
  2433. * necessary at all, on others it won't work at all if not aligned and on others
  2434. * it will work but it will have an impact on performance. In practice, the
  2435. * bitstream should have 4 byte alignment at minimum and all sample data should
  2436. * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
  2437. * the linesize is not a multiple of 16 then there's no sense in aligning the
  2438. * start of the buffer to 16.
  2439. *
  2440. * @param avctx the codec context
  2441. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  2442. * @param[in] buf the input buffer
  2443. * @param[in] buf_size the size of the input buffer in bytes
  2444. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  2445. * @return On error a negative value is returned, otherwise the number of bytes
  2446. * used or zero if no frame could be decompressed.
  2447. */
  2448. int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
  2449. int *got_picture_ptr,
  2450. const uint8_t *buf, int buf_size);
  2451. /* Decode a subtitle message. Return -1 if error, otherwise return the
  2452. * number of bytes used. If no subtitle could be decompressed,
  2453. * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
  2454. int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
  2455. int *got_sub_ptr,
  2456. const uint8_t *buf, int buf_size);
  2457. int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
  2458. int *data_size_ptr,
  2459. uint8_t *buf, int buf_size);
  2460. /**
  2461. * Encodes an audio frame from \p samples into \p buf.
  2462. * The avcodec_encode_audio() function encodes an audio frame from the input
  2463. * buffer \p samples. To encode it, it makes use of the audio codec which was
  2464. * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
  2465. * stored in output buffer \p buf.
  2466. *
  2467. * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
  2468. *
  2469. * @param avctx the codec context
  2470. * @param[out] buf the output buffer
  2471. * @param[in] buf_size the output buffer size
  2472. * @param[in] samples the input buffer containing the samples
  2473. * The number of samples read from this buffer is frame_size*channels,
  2474. * both of which are defined in \p avctx.
  2475. * @return On error a negative value is returned, on success zero or the number
  2476. * of bytes used to encode the data read from the input buffer.
  2477. */
  2478. int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  2479. const short *samples);
  2480. /**
  2481. * Encodes a video frame from \p pict into \p buf.
  2482. * The avcodec_encode_video() function encodes a video frame from the input
  2483. * \p pict. To encode it, it makes use of the video codec which was coupled with
  2484. * \p avctx using avcodec_open(). The resulting encoded bytes representing the
  2485. * frame are stored in the output buffer \p buf. The input picture should be
  2486. * stored using a specific format, namely \c avctx.pix_fmt.
  2487. *
  2488. * @param avctx the codec context
  2489. * @param[out] buf the output buffer for the bitstream of encoded frame
  2490. * @param[in] buf_size the size of the output buffer in bytes
  2491. * @param[in] pict the input picture to encode
  2492. * @return On error a negative value is returned, on success zero or the number
  2493. * of bytes used from the input buffer.
  2494. */
  2495. int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  2496. const AVFrame *pict);
  2497. int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  2498. const AVSubtitle *sub);
  2499. int avcodec_close(AVCodecContext *avctx);
  2500. void avcodec_register_all(void);
  2501. /**
  2502. * Flush buffers, should be called when seeking or when switching to a different stream.
  2503. */
  2504. void avcodec_flush_buffers(AVCodecContext *avctx);
  2505. void avcodec_default_free_buffers(AVCodecContext *s);
  2506. /* misc useful functions */
  2507. /**
  2508. * Returns a single letter to describe the given picture type \p pict_type.
  2509. *
  2510. * @param[in] pict_type the picture type
  2511. * @return A single character representing the picture type.
  2512. */
  2513. char av_get_pict_type_char(int pict_type);
  2514. /**
  2515. * Returns codec bits per sample.
  2516. *
  2517. * @param[in] codec_id the codec
  2518. * @return Number of bits per sample or zero if unknown for the given codec.
  2519. */
  2520. int av_get_bits_per_sample(enum CodecID codec_id);
  2521. /**
  2522. * Returns sample format bits per sample.
  2523. *
  2524. * @param[in] sample_fmt the sample format
  2525. * @return Number of bits per sample or zero if unknown for the given sample format.
  2526. */
  2527. int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
  2528. /* frame parsing */
  2529. typedef struct AVCodecParserContext {
  2530. void *priv_data;
  2531. struct AVCodecParser *parser;
  2532. int64_t frame_offset; /* offset of the current frame */
  2533. int64_t cur_offset; /* current offset
  2534. (incremented by each av_parser_parse()) */
  2535. int64_t last_frame_offset; /* offset of the last frame */
  2536. /* video info */
  2537. int pict_type; /* XXX: Put it back in AVCodecContext. */
  2538. int repeat_pict; /* XXX: Put it back in AVCodecContext. */
  2539. int64_t pts; /* pts of the current frame */
  2540. int64_t dts; /* dts of the current frame */
  2541. /* private data */
  2542. int64_t last_pts;
  2543. int64_t last_dts;
  2544. int fetch_timestamp;
  2545. #define AV_PARSER_PTS_NB 4
  2546. int cur_frame_start_index;
  2547. int64_t cur_frame_offset[AV_PARSER_PTS_NB];
  2548. int64_t cur_frame_pts[AV_PARSER_PTS_NB];
  2549. int64_t cur_frame_dts[AV_PARSER_PTS_NB];
  2550. int flags;
  2551. #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
  2552. int64_t offset; ///< byte offset from starting packet start
  2553. int64_t last_offset;
  2554. } AVCodecParserContext;
  2555. typedef struct AVCodecParser {
  2556. int codec_ids[5]; /* several codec IDs are permitted */
  2557. int priv_data_size;
  2558. int (*parser_init)(AVCodecParserContext *s);
  2559. int (*parser_parse)(AVCodecParserContext *s,
  2560. AVCodecContext *avctx,
  2561. const uint8_t **poutbuf, int *poutbuf_size,
  2562. const uint8_t *buf, int buf_size);
  2563. void (*parser_close)(AVCodecParserContext *s);
  2564. int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
  2565. struct AVCodecParser *next;
  2566. } AVCodecParser;
  2567. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  2568. extern AVCodecParser *av_first_parser;
  2569. #endif
  2570. AVCodecParser *av_parser_next(AVCodecParser *c);
  2571. void av_register_codec_parser(AVCodecParser *parser);
  2572. AVCodecParserContext *av_parser_init(int codec_id);
  2573. int av_parser_parse(AVCodecParserContext *s,
  2574. AVCodecContext *avctx,
  2575. uint8_t **poutbuf, int *poutbuf_size,
  2576. const uint8_t *buf, int buf_size,
  2577. int64_t pts, int64_t dts);
  2578. int av_parser_change(AVCodecParserContext *s,
  2579. AVCodecContext *avctx,
  2580. uint8_t **poutbuf, int *poutbuf_size,
  2581. const uint8_t *buf, int buf_size, int keyframe);
  2582. void av_parser_close(AVCodecParserContext *s);
  2583. typedef struct AVBitStreamFilterContext {
  2584. void *priv_data;
  2585. struct AVBitStreamFilter *filter;
  2586. AVCodecParserContext *parser;
  2587. struct AVBitStreamFilterContext *next;
  2588. } AVBitStreamFilterContext;
  2589. typedef struct AVBitStreamFilter {
  2590. const char *name;
  2591. int priv_data_size;
  2592. int (*filter)(AVBitStreamFilterContext *bsfc,
  2593. AVCodecContext *avctx, const char *args,
  2594. uint8_t **poutbuf, int *poutbuf_size,
  2595. const uint8_t *buf, int buf_size, int keyframe);
  2596. void (*close)(AVBitStreamFilterContext *bsfc);
  2597. struct AVBitStreamFilter *next;
  2598. } AVBitStreamFilter;
  2599. void av_register_bitstream_filter(AVBitStreamFilter *bsf);
  2600. AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
  2601. int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
  2602. AVCodecContext *avctx, const char *args,
  2603. uint8_t **poutbuf, int *poutbuf_size,
  2604. const uint8_t *buf, int buf_size, int keyframe);
  2605. void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
  2606. AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
  2607. /* memory */
  2608. /**
  2609. * Reallocates the given block if it is not large enough, otherwise it
  2610. * does nothing.
  2611. *
  2612. * @see av_realloc
  2613. */
  2614. void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
  2615. /* for static data only */
  2616. /**
  2617. * Frees all static arrays and resets their pointers to 0.
  2618. * Call this function to release all statically allocated tables.
  2619. *
  2620. * @deprecated. Code which uses av_free_static is broken/misdesigned
  2621. * and should correctly use static arrays
  2622. *
  2623. */
  2624. attribute_deprecated void av_free_static(void);
  2625. /**
  2626. * Allocation of static arrays.
  2627. *
  2628. * @warning Do not use for normal allocation.
  2629. *
  2630. * @param[in] size The amount of memory you need in bytes.
  2631. * @return block of memory of the requested size
  2632. * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
  2633. * and should correctly use static arrays
  2634. */
  2635. attribute_deprecated av_malloc_attrib av_alloc_size(1)
  2636. void *av_mallocz_static(unsigned int size);
  2637. /**
  2638. * Copy image 'src' to 'dst'.
  2639. */
  2640. void av_picture_copy(AVPicture *dst, const AVPicture *src,
  2641. int pix_fmt, int width, int height);
  2642. /**
  2643. * Crop image top and left side.
  2644. */
  2645. int av_picture_crop(AVPicture *dst, const AVPicture *src,
  2646. int pix_fmt, int top_band, int left_band);
  2647. /**
  2648. * Pad image.
  2649. */
  2650. int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
  2651. int padtop, int padbottom, int padleft, int padright, int *color);
  2652. #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
  2653. /**
  2654. * @deprecated Use the software scaler (swscale) instead.
  2655. */
  2656. attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
  2657. int pix_fmt, int width, int height);
  2658. /**
  2659. * @deprecated Use the software scaler (swscale) instead.
  2660. */
  2661. attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
  2662. int pix_fmt, int top_band, int left_band);
  2663. /**
  2664. * @deprecated Use the software scaler (swscale) instead.
  2665. */
  2666. attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
  2667. int padtop, int padbottom, int padleft, int padright, int *color);
  2668. #endif
  2669. extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  2670. /**
  2671. * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
  2672. *
  2673. * @return 0 in case of a successful parsing, a negative value otherwise
  2674. * @param[in] str the string to parse: it has to be a string in the format
  2675. * <width>x<height> or a valid video frame size abbreviation.
  2676. * @param[in,out] width_ptr pointer to the variable which will contain the detected
  2677. * frame width value
  2678. * @param[in,out] height_ptr pointer to the variable which will contain the detected
  2679. * frame height value
  2680. */
  2681. int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
  2682. /**
  2683. * Parses \p str and put in \p frame_rate the detected values.
  2684. *
  2685. * @return 0 in case of a successful parsing, a negative value otherwise
  2686. * @param[in] str the string to parse: it has to be a string in the format
  2687. * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
  2688. * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
  2689. * frame rate
  2690. */
  2691. int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
  2692. /* error handling */
  2693. #if EINVAL > 0
  2694. #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
  2695. #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
  2696. #else
  2697. /* Some platforms have E* and errno already negated. */
  2698. #define AVERROR(e) (e)
  2699. #define AVUNERROR(e) (e)
  2700. #endif
  2701. #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
  2702. #define AVERROR_IO AVERROR(EIO) /**< I/O error */
  2703. #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
  2704. #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
  2705. #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
  2706. #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
  2707. #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
  2708. #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
  2709. #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
  2710. #endif /* FFMPEG_AVCODEC_H */