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.

3928 lines
126KB

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