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.

3011 lines
93KB

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