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.

3965 lines
128KB

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