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.

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