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.

4053 lines
131KB

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