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.

3870 lines
125KB

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