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.

3013 lines
93KB

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