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.

3601 lines
114KB

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