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.

2934 lines
90KB

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