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.

2992 lines
92KB

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