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.

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