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.

2962 lines
92KB

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