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.

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