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.

4537 lines
151KB

  1. /*
  2. * copyright (c) 2001 Fabrice Bellard
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef AVCODEC_AVCODEC_H
  21. #define AVCODEC_AVCODEC_H
  22. /**
  23. * @file
  24. * external API header
  25. */
  26. #include <errno.h>
  27. #include "libavutil/samplefmt.h"
  28. #include "libavutil/avutil.h"
  29. #include "libavutil/cpu.h"
  30. #include "libavutil/dict.h"
  31. #include "libavutil/log.h"
  32. #include "libavutil/pixfmt.h"
  33. #include "libavutil/rational.h"
  34. #include "libavutil/audioconvert.h"
  35. #include "libavcodec/version.h"
  36. /**
  37. * @defgroup libavc Encoding/Decoding Library
  38. * @{
  39. *
  40. * @defgroup lavc_decoding Decoding
  41. * @{
  42. * @}
  43. *
  44. * @defgroup lavc_encoding Encoding
  45. * @{
  46. * @}
  47. *
  48. * @defgroup lavc_codec Codecs
  49. * @{
  50. * @defgroup lavc_codec_native Native Codecs
  51. * @{
  52. * @}
  53. * @defgroup lavc_codec_wrappers External library wrappers
  54. * @{
  55. * @}
  56. * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
  57. * @{
  58. * @}
  59. * @}
  60. * @defgroup lavc_internal Internal
  61. * @{
  62. * @}
  63. * @}
  64. *
  65. */
  66. /**
  67. * Identify the syntax and semantics of the bitstream.
  68. * The principle is roughly:
  69. * Two decoders with the same ID can decode the same streams.
  70. * Two encoders with the same ID can encode compatible streams.
  71. * There may be slight deviations from the principle due to implementation
  72. * details.
  73. *
  74. * If you add a codec ID to this list, add it so that
  75. * 1. no value of a existing codec ID changes (that would break ABI),
  76. * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
  77. * This ensures that 2 forks can independently add CodecIDs without producing conflicts.
  78. */
  79. enum CodecID {
  80. CODEC_ID_NONE,
  81. /* video codecs */
  82. CODEC_ID_MPEG1VIDEO,
  83. CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  84. CODEC_ID_MPEG2VIDEO_XVMC,
  85. CODEC_ID_H261,
  86. CODEC_ID_H263,
  87. CODEC_ID_RV10,
  88. CODEC_ID_RV20,
  89. CODEC_ID_MJPEG,
  90. CODEC_ID_MJPEGB,
  91. CODEC_ID_LJPEG,
  92. CODEC_ID_SP5X,
  93. CODEC_ID_JPEGLS,
  94. CODEC_ID_MPEG4,
  95. CODEC_ID_RAWVIDEO,
  96. CODEC_ID_MSMPEG4V1,
  97. CODEC_ID_MSMPEG4V2,
  98. CODEC_ID_MSMPEG4V3,
  99. CODEC_ID_WMV1,
  100. CODEC_ID_WMV2,
  101. CODEC_ID_H263P,
  102. CODEC_ID_H263I,
  103. CODEC_ID_FLV1,
  104. CODEC_ID_SVQ1,
  105. CODEC_ID_SVQ3,
  106. CODEC_ID_DVVIDEO,
  107. CODEC_ID_HUFFYUV,
  108. CODEC_ID_CYUV,
  109. CODEC_ID_H264,
  110. CODEC_ID_INDEO3,
  111. CODEC_ID_VP3,
  112. CODEC_ID_THEORA,
  113. CODEC_ID_ASV1,
  114. CODEC_ID_ASV2,
  115. CODEC_ID_FFV1,
  116. CODEC_ID_4XM,
  117. CODEC_ID_VCR1,
  118. CODEC_ID_CLJR,
  119. CODEC_ID_MDEC,
  120. CODEC_ID_ROQ,
  121. CODEC_ID_INTERPLAY_VIDEO,
  122. CODEC_ID_XAN_WC3,
  123. CODEC_ID_XAN_WC4,
  124. CODEC_ID_RPZA,
  125. CODEC_ID_CINEPAK,
  126. CODEC_ID_WS_VQA,
  127. CODEC_ID_MSRLE,
  128. CODEC_ID_MSVIDEO1,
  129. CODEC_ID_IDCIN,
  130. CODEC_ID_8BPS,
  131. CODEC_ID_SMC,
  132. CODEC_ID_FLIC,
  133. CODEC_ID_TRUEMOTION1,
  134. CODEC_ID_VMDVIDEO,
  135. CODEC_ID_MSZH,
  136. CODEC_ID_ZLIB,
  137. CODEC_ID_QTRLE,
  138. CODEC_ID_SNOW,
  139. CODEC_ID_TSCC,
  140. CODEC_ID_ULTI,
  141. CODEC_ID_QDRAW,
  142. CODEC_ID_VIXL,
  143. CODEC_ID_QPEG,
  144. CODEC_ID_PNG,
  145. CODEC_ID_PPM,
  146. CODEC_ID_PBM,
  147. CODEC_ID_PGM,
  148. CODEC_ID_PGMYUV,
  149. CODEC_ID_PAM,
  150. CODEC_ID_FFVHUFF,
  151. CODEC_ID_RV30,
  152. CODEC_ID_RV40,
  153. CODEC_ID_VC1,
  154. CODEC_ID_WMV3,
  155. CODEC_ID_LOCO,
  156. CODEC_ID_WNV1,
  157. CODEC_ID_AASC,
  158. CODEC_ID_INDEO2,
  159. CODEC_ID_FRAPS,
  160. CODEC_ID_TRUEMOTION2,
  161. CODEC_ID_BMP,
  162. CODEC_ID_CSCD,
  163. CODEC_ID_MMVIDEO,
  164. CODEC_ID_ZMBV,
  165. CODEC_ID_AVS,
  166. CODEC_ID_SMACKVIDEO,
  167. CODEC_ID_NUV,
  168. CODEC_ID_KMVC,
  169. CODEC_ID_FLASHSV,
  170. CODEC_ID_CAVS,
  171. CODEC_ID_JPEG2000,
  172. CODEC_ID_VMNC,
  173. CODEC_ID_VP5,
  174. CODEC_ID_VP6,
  175. CODEC_ID_VP6F,
  176. CODEC_ID_TARGA,
  177. CODEC_ID_DSICINVIDEO,
  178. CODEC_ID_TIERTEXSEQVIDEO,
  179. CODEC_ID_TIFF,
  180. CODEC_ID_GIF,
  181. CODEC_ID_DXA,
  182. CODEC_ID_DNXHD,
  183. CODEC_ID_THP,
  184. CODEC_ID_SGI,
  185. CODEC_ID_C93,
  186. CODEC_ID_BETHSOFTVID,
  187. CODEC_ID_PTX,
  188. CODEC_ID_TXD,
  189. CODEC_ID_VP6A,
  190. CODEC_ID_AMV,
  191. CODEC_ID_VB,
  192. CODEC_ID_PCX,
  193. CODEC_ID_SUNRAST,
  194. CODEC_ID_INDEO4,
  195. CODEC_ID_INDEO5,
  196. CODEC_ID_MIMIC,
  197. CODEC_ID_RL2,
  198. CODEC_ID_ESCAPE124,
  199. CODEC_ID_DIRAC,
  200. CODEC_ID_BFI,
  201. CODEC_ID_CMV,
  202. CODEC_ID_MOTIONPIXELS,
  203. CODEC_ID_TGV,
  204. CODEC_ID_TGQ,
  205. CODEC_ID_TQI,
  206. CODEC_ID_AURA,
  207. CODEC_ID_AURA2,
  208. CODEC_ID_V210X,
  209. CODEC_ID_TMV,
  210. CODEC_ID_V210,
  211. CODEC_ID_DPX,
  212. CODEC_ID_MAD,
  213. CODEC_ID_FRWU,
  214. CODEC_ID_FLASHSV2,
  215. CODEC_ID_CDGRAPHICS,
  216. CODEC_ID_R210,
  217. CODEC_ID_ANM,
  218. CODEC_ID_BINKVIDEO,
  219. CODEC_ID_IFF_ILBM,
  220. CODEC_ID_IFF_BYTERUN1,
  221. CODEC_ID_KGV1,
  222. CODEC_ID_YOP,
  223. CODEC_ID_VP8,
  224. CODEC_ID_PICTOR,
  225. CODEC_ID_ANSI,
  226. CODEC_ID_A64_MULTI,
  227. CODEC_ID_A64_MULTI5,
  228. CODEC_ID_R10K,
  229. CODEC_ID_MXPEG,
  230. CODEC_ID_LAGARITH,
  231. CODEC_ID_PRORES,
  232. CODEC_ID_JV,
  233. CODEC_ID_DFA,
  234. CODEC_ID_WMV3IMAGE,
  235. CODEC_ID_VC1IMAGE,
  236. CODEC_ID_UTVIDEO,
  237. CODEC_ID_BMV_VIDEO,
  238. CODEC_ID_VBLE,
  239. CODEC_ID_DXTORY,
  240. CODEC_ID_V410,
  241. CODEC_ID_XWD,
  242. CODEC_ID_CDXL,
  243. CODEC_ID_XBM,
  244. CODEC_ID_ZEROCODEC,
  245. CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
  246. CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
  247. CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
  248. CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
  249. CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
  250. CODEC_ID_V308 = MKBETAG('V','3','0','8'),
  251. CODEC_ID_V408 = MKBETAG('V','4','0','8'),
  252. CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
  253. /* various PCM "codecs" */
  254. CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
  255. CODEC_ID_PCM_S16LE = 0x10000,
  256. CODEC_ID_PCM_S16BE,
  257. CODEC_ID_PCM_U16LE,
  258. CODEC_ID_PCM_U16BE,
  259. CODEC_ID_PCM_S8,
  260. CODEC_ID_PCM_U8,
  261. CODEC_ID_PCM_MULAW,
  262. CODEC_ID_PCM_ALAW,
  263. CODEC_ID_PCM_S32LE,
  264. CODEC_ID_PCM_S32BE,
  265. CODEC_ID_PCM_U32LE,
  266. CODEC_ID_PCM_U32BE,
  267. CODEC_ID_PCM_S24LE,
  268. CODEC_ID_PCM_S24BE,
  269. CODEC_ID_PCM_U24LE,
  270. CODEC_ID_PCM_U24BE,
  271. CODEC_ID_PCM_S24DAUD,
  272. CODEC_ID_PCM_ZORK,
  273. CODEC_ID_PCM_S16LE_PLANAR,
  274. CODEC_ID_PCM_DVD,
  275. CODEC_ID_PCM_F32BE,
  276. CODEC_ID_PCM_F32LE,
  277. CODEC_ID_PCM_F64BE,
  278. CODEC_ID_PCM_F64LE,
  279. CODEC_ID_PCM_BLURAY,
  280. CODEC_ID_PCM_LXF,
  281. CODEC_ID_S302M,
  282. CODEC_ID_PCM_S8_PLANAR,
  283. /* various ADPCM codecs */
  284. CODEC_ID_ADPCM_IMA_QT = 0x11000,
  285. CODEC_ID_ADPCM_IMA_WAV,
  286. CODEC_ID_ADPCM_IMA_DK3,
  287. CODEC_ID_ADPCM_IMA_DK4,
  288. CODEC_ID_ADPCM_IMA_WS,
  289. CODEC_ID_ADPCM_IMA_SMJPEG,
  290. CODEC_ID_ADPCM_MS,
  291. CODEC_ID_ADPCM_4XM,
  292. CODEC_ID_ADPCM_XA,
  293. CODEC_ID_ADPCM_ADX,
  294. CODEC_ID_ADPCM_EA,
  295. CODEC_ID_ADPCM_G726,
  296. CODEC_ID_ADPCM_CT,
  297. CODEC_ID_ADPCM_SWF,
  298. CODEC_ID_ADPCM_YAMAHA,
  299. CODEC_ID_ADPCM_SBPRO_4,
  300. CODEC_ID_ADPCM_SBPRO_3,
  301. CODEC_ID_ADPCM_SBPRO_2,
  302. CODEC_ID_ADPCM_THP,
  303. CODEC_ID_ADPCM_IMA_AMV,
  304. CODEC_ID_ADPCM_EA_R1,
  305. CODEC_ID_ADPCM_EA_R3,
  306. CODEC_ID_ADPCM_EA_R2,
  307. CODEC_ID_ADPCM_IMA_EA_SEAD,
  308. CODEC_ID_ADPCM_IMA_EA_EACS,
  309. CODEC_ID_ADPCM_EA_XAS,
  310. CODEC_ID_ADPCM_EA_MAXIS_XA,
  311. CODEC_ID_ADPCM_IMA_ISS,
  312. CODEC_ID_ADPCM_G722,
  313. CODEC_ID_ADPCM_IMA_APC,
  314. /* AMR */
  315. CODEC_ID_AMR_NB = 0x12000,
  316. CODEC_ID_AMR_WB,
  317. /* RealAudio codecs*/
  318. CODEC_ID_RA_144 = 0x13000,
  319. CODEC_ID_RA_288,
  320. /* various DPCM codecs */
  321. CODEC_ID_ROQ_DPCM = 0x14000,
  322. CODEC_ID_INTERPLAY_DPCM,
  323. CODEC_ID_XAN_DPCM,
  324. CODEC_ID_SOL_DPCM,
  325. /* audio codecs */
  326. CODEC_ID_MP2 = 0x15000,
  327. CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
  328. CODEC_ID_AAC,
  329. CODEC_ID_AC3,
  330. CODEC_ID_DTS,
  331. CODEC_ID_VORBIS,
  332. CODEC_ID_DVAUDIO,
  333. CODEC_ID_WMAV1,
  334. CODEC_ID_WMAV2,
  335. CODEC_ID_MACE3,
  336. CODEC_ID_MACE6,
  337. CODEC_ID_VMDAUDIO,
  338. CODEC_ID_FLAC,
  339. CODEC_ID_MP3ADU,
  340. CODEC_ID_MP3ON4,
  341. CODEC_ID_SHORTEN,
  342. CODEC_ID_ALAC,
  343. CODEC_ID_WESTWOOD_SND1,
  344. CODEC_ID_GSM, ///< as in Berlin toast format
  345. CODEC_ID_QDM2,
  346. CODEC_ID_COOK,
  347. CODEC_ID_TRUESPEECH,
  348. CODEC_ID_TTA,
  349. CODEC_ID_SMACKAUDIO,
  350. CODEC_ID_QCELP,
  351. CODEC_ID_WAVPACK,
  352. CODEC_ID_DSICINAUDIO,
  353. CODEC_ID_IMC,
  354. CODEC_ID_MUSEPACK7,
  355. CODEC_ID_MLP,
  356. CODEC_ID_GSM_MS, /* as found in WAV */
  357. CODEC_ID_ATRAC3,
  358. CODEC_ID_VOXWARE,
  359. CODEC_ID_APE,
  360. CODEC_ID_NELLYMOSER,
  361. CODEC_ID_MUSEPACK8,
  362. CODEC_ID_SPEEX,
  363. CODEC_ID_WMAVOICE,
  364. CODEC_ID_WMAPRO,
  365. CODEC_ID_WMALOSSLESS,
  366. CODEC_ID_ATRAC3P,
  367. CODEC_ID_EAC3,
  368. CODEC_ID_SIPR,
  369. CODEC_ID_MP1,
  370. CODEC_ID_TWINVQ,
  371. CODEC_ID_TRUEHD,
  372. CODEC_ID_MP4ALS,
  373. CODEC_ID_ATRAC1,
  374. CODEC_ID_BINKAUDIO_RDFT,
  375. CODEC_ID_BINKAUDIO_DCT,
  376. CODEC_ID_AAC_LATM,
  377. CODEC_ID_QDMC,
  378. CODEC_ID_CELT,
  379. CODEC_ID_G723_1,
  380. CODEC_ID_G729,
  381. CODEC_ID_8SVX_EXP,
  382. CODEC_ID_8SVX_FIB,
  383. CODEC_ID_BMV_AUDIO,
  384. CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
  385. CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
  386. CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
  387. CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
  388. /* subtitle codecs */
  389. CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
  390. CODEC_ID_DVD_SUBTITLE = 0x17000,
  391. CODEC_ID_DVB_SUBTITLE,
  392. CODEC_ID_TEXT, ///< raw UTF-8 text
  393. CODEC_ID_XSUB,
  394. CODEC_ID_SSA,
  395. CODEC_ID_MOV_TEXT,
  396. CODEC_ID_HDMV_PGS_SUBTITLE,
  397. CODEC_ID_DVB_TELETEXT,
  398. CODEC_ID_SRT,
  399. CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
  400. /* other specific kind of codecs (generally used for attachments) */
  401. CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
  402. CODEC_ID_TTF = 0x18000,
  403. CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
  404. CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
  405. CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
  406. CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
  407. CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
  408. * stream (only used by libavformat) */
  409. CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
  410. * stream (only used by libavformat) */
  411. CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
  412. };
  413. #if FF_API_OLD_DECODE_AUDIO
  414. /* in bytes */
  415. #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
  416. #endif
  417. /**
  418. * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
  419. * This is mainly needed because some optimized bitstream readers read
  420. * 32 or 64 bit at once and could read over the end.<br>
  421. * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  422. * MPEG bitstreams could cause overread and segfault.
  423. */
  424. #define FF_INPUT_BUFFER_PADDING_SIZE 16
  425. /**
  426. * minimum encoding buffer size
  427. * Used to avoid some checks during header writing.
  428. */
  429. #define FF_MIN_BUFFER_SIZE 16384
  430. /**
  431. * motion estimation type.
  432. */
  433. enum Motion_Est_ID {
  434. ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
  435. ME_FULL,
  436. ME_LOG,
  437. ME_PHODS,
  438. ME_EPZS, ///< enhanced predictive zonal search
  439. ME_X1, ///< reserved for experiments
  440. ME_HEX, ///< hexagon based search
  441. ME_UMH, ///< uneven multi-hexagon search
  442. ME_ITER, ///< iterative search
  443. ME_TESA, ///< transformed exhaustive search algorithm
  444. };
  445. enum AVDiscard{
  446. /* We leave some space between them for extensions (drop some
  447. * keyframes for intra-only or drop just some bidir frames). */
  448. AVDISCARD_NONE =-16, ///< discard nothing
  449. AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
  450. AVDISCARD_NONREF = 8, ///< discard all non reference
  451. AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
  452. AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
  453. AVDISCARD_ALL = 48, ///< discard all
  454. };
  455. enum AVColorPrimaries{
  456. AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
  457. AVCOL_PRI_UNSPECIFIED=2,
  458. AVCOL_PRI_BT470M =4,
  459. AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
  460. AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
  461. AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
  462. AVCOL_PRI_FILM =8,
  463. AVCOL_PRI_NB , ///< Not part of ABI
  464. };
  465. enum AVColorTransferCharacteristic{
  466. AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
  467. AVCOL_TRC_UNSPECIFIED=2,
  468. AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
  469. AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
  470. AVCOL_TRC_SMPTE240M =7,
  471. AVCOL_TRC_NB , ///< Not part of ABI
  472. };
  473. enum AVColorSpace{
  474. AVCOL_SPC_RGB =0,
  475. AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
  476. AVCOL_SPC_UNSPECIFIED=2,
  477. AVCOL_SPC_FCC =4,
  478. 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
  479. AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
  480. AVCOL_SPC_SMPTE240M =7,
  481. AVCOL_SPC_YCGCO =8,
  482. AVCOL_SPC_NB , ///< Not part of ABI
  483. };
  484. enum AVColorRange{
  485. AVCOL_RANGE_UNSPECIFIED=0,
  486. AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
  487. AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
  488. AVCOL_RANGE_NB , ///< Not part of ABI
  489. };
  490. /**
  491. * X X 3 4 X X are luma samples,
  492. * 1 2 1-6 are possible chroma positions
  493. * X X 5 6 X 0 is undefined/unknown position
  494. */
  495. enum AVChromaLocation{
  496. AVCHROMA_LOC_UNSPECIFIED=0,
  497. AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
  498. AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
  499. AVCHROMA_LOC_TOPLEFT =3, ///< DV
  500. AVCHROMA_LOC_TOP =4,
  501. AVCHROMA_LOC_BOTTOMLEFT =5,
  502. AVCHROMA_LOC_BOTTOM =6,
  503. AVCHROMA_LOC_NB , ///< Not part of ABI
  504. };
  505. enum AVAudioServiceType {
  506. AV_AUDIO_SERVICE_TYPE_MAIN = 0,
  507. AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
  508. AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
  509. AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
  510. AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
  511. AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
  512. AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
  513. AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
  514. AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
  515. AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
  516. };
  517. typedef struct RcOverride{
  518. int start_frame;
  519. int end_frame;
  520. int qscale; // If this is 0 then quality_factor will be used instead.
  521. float quality_factor;
  522. } RcOverride;
  523. #define FF_MAX_B_FRAMES 16
  524. /* encoding support
  525. These flags can be passed in AVCodecContext.flags before initialization.
  526. Note: Not everything is supported yet.
  527. */
  528. #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
  529. #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
  530. #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
  531. #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
  532. #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
  533. /**
  534. * The parent program guarantees that the input for B-frames containing
  535. * streams is not written to for at least s->max_b_frames+1 frames, if
  536. * this is not set the input will be copied.
  537. */
  538. #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  539. #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
  540. #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
  541. #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
  542. #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
  543. #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
  544. #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
  545. location instead of only at frame boundaries. */
  546. #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
  547. #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
  548. #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
  549. #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
  550. #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
  551. /* Fx : Flag for h263+ extra options */
  552. #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
  553. #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
  554. #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
  555. #define CODEC_FLAG_CLOSED_GOP 0x80000000
  556. #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
  557. #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
  558. #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
  559. #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
  560. #if FF_API_MPV_GLOBAL_OPTS
  561. #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
  562. #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
  563. #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
  564. #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
  565. #endif
  566. #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
  567. #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
  568. /* Unsupported options :
  569. * Syntax Arithmetic coding (SAC)
  570. * Reference Picture Selection
  571. * Independent Segment Decoding */
  572. /* /Fx */
  573. /* codec capabilities */
  574. #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
  575. /**
  576. * Codec uses get_buffer() for allocating buffers and supports custom allocators.
  577. * If not set, it might not use get_buffer() at all or use operations that
  578. * assume the buffer was allocated by avcodec_default_get_buffer.
  579. */
  580. #define CODEC_CAP_DR1 0x0002
  581. #define CODEC_CAP_TRUNCATED 0x0008
  582. /* Codec can export data for HW decoding (XvMC). */
  583. #define CODEC_CAP_HWACCEL 0x0010
  584. /**
  585. * Encoder or decoder requires flushing with NULL input at the end in order to
  586. * give the complete and correct output.
  587. *
  588. * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
  589. * with NULL data. The user can still send NULL data to the public encode
  590. * or decode function, but libavcodec will not pass it along to the codec
  591. * unless this flag is set.
  592. *
  593. * Decoders:
  594. * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
  595. * avpkt->size=0 at the end to get the delayed data until the decoder no longer
  596. * returns frames.
  597. *
  598. * Encoders:
  599. * The encoder needs to be fed with NULL data at the end of encoding until the
  600. * encoder no longer returns data.
  601. *
  602. * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
  603. * flag also means that the encoder must set the pts and duration for
  604. * each output packet. If this flag is not set, the pts and duration will
  605. * be determined by libavcodec from the input frame.
  606. */
  607. #define CODEC_CAP_DELAY 0x0020
  608. /**
  609. * Codec can be fed a final frame with a smaller size.
  610. * This can be used to prevent truncation of the last audio samples.
  611. */
  612. #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
  613. /**
  614. * Codec can export data for HW decoding (VDPAU).
  615. */
  616. #define CODEC_CAP_HWACCEL_VDPAU 0x0080
  617. /**
  618. * Codec can output multiple frames per AVPacket
  619. * Normally demuxers return one frame at a time, demuxers which do not do
  620. * are connected to a parser to split what they return into proper frames.
  621. * This flag is reserved to the very rare category of codecs which have a
  622. * bitstream that cannot be split into frames without timeconsuming
  623. * operations like full decoding. Demuxers carring such bitstreams thus
  624. * may return multiple frames in a packet. This has many disadvantages like
  625. * prohibiting stream copy in many cases thus it should only be considered
  626. * as a last resort.
  627. */
  628. #define CODEC_CAP_SUBFRAMES 0x0100
  629. /**
  630. * Codec is experimental and is thus avoided in favor of non experimental
  631. * encoders
  632. */
  633. #define CODEC_CAP_EXPERIMENTAL 0x0200
  634. /**
  635. * Codec should fill in channel configuration and samplerate instead of container
  636. */
  637. #define CODEC_CAP_CHANNEL_CONF 0x0400
  638. /**
  639. * Codec is able to deal with negative linesizes
  640. */
  641. #define CODEC_CAP_NEG_LINESIZES 0x0800
  642. /**
  643. * Codec supports frame-level multithreading.
  644. */
  645. #define CODEC_CAP_FRAME_THREADS 0x1000
  646. /**
  647. * Codec supports slice-based (or partition-based) multithreading.
  648. */
  649. #define CODEC_CAP_SLICE_THREADS 0x2000
  650. /**
  651. * Codec supports changed parameters at any point.
  652. */
  653. #define CODEC_CAP_PARAM_CHANGE 0x4000
  654. /**
  655. * Codec supports avctx->thread_count == 0 (auto).
  656. */
  657. #define CODEC_CAP_AUTO_THREADS 0x8000
  658. /**
  659. * Audio encoder supports receiving a different number of samples in each call.
  660. */
  661. #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
  662. /**
  663. * Codec is lossless.
  664. */
  665. #define CODEC_CAP_LOSSLESS 0x80000000
  666. //The following defines may change, don't expect compatibility if you use them.
  667. #define MB_TYPE_INTRA4x4 0x0001
  668. #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
  669. #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
  670. #define MB_TYPE_16x16 0x0008
  671. #define MB_TYPE_16x8 0x0010
  672. #define MB_TYPE_8x16 0x0020
  673. #define MB_TYPE_8x8 0x0040
  674. #define MB_TYPE_INTERLACED 0x0080
  675. #define MB_TYPE_DIRECT2 0x0100 //FIXME
  676. #define MB_TYPE_ACPRED 0x0200
  677. #define MB_TYPE_GMC 0x0400
  678. #define MB_TYPE_SKIP 0x0800
  679. #define MB_TYPE_P0L0 0x1000
  680. #define MB_TYPE_P1L0 0x2000
  681. #define MB_TYPE_P0L1 0x4000
  682. #define MB_TYPE_P1L1 0x8000
  683. #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
  684. #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
  685. #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
  686. #define MB_TYPE_QUANT 0x00010000
  687. #define MB_TYPE_CBP 0x00020000
  688. //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
  689. /**
  690. * Pan Scan area.
  691. * This specifies the area which should be displayed.
  692. * Note there may be multiple such areas for one frame.
  693. */
  694. typedef struct AVPanScan{
  695. /**
  696. * id
  697. * - encoding: Set by user.
  698. * - decoding: Set by libavcodec.
  699. */
  700. int id;
  701. /**
  702. * width and height in 1/16 pel
  703. * - encoding: Set by user.
  704. * - decoding: Set by libavcodec.
  705. */
  706. int width;
  707. int height;
  708. /**
  709. * position of the top left corner in 1/16 pel for up to 3 fields/frames
  710. * - encoding: Set by user.
  711. * - decoding: Set by libavcodec.
  712. */
  713. int16_t position[3][2];
  714. }AVPanScan;
  715. #define FF_QSCALE_TYPE_MPEG1 0
  716. #define FF_QSCALE_TYPE_MPEG2 1
  717. #define FF_QSCALE_TYPE_H264 2
  718. #define FF_QSCALE_TYPE_VP56 3
  719. #define FF_BUFFER_TYPE_INTERNAL 1
  720. #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
  721. #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
  722. #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
  723. #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
  724. #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
  725. #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
  726. #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
  727. enum AVPacketSideDataType {
  728. AV_PKT_DATA_PALETTE,
  729. AV_PKT_DATA_NEW_EXTRADATA,
  730. AV_PKT_DATA_PARAM_CHANGE,
  731. AV_PKT_DATA_H263_MB_INFO,
  732. };
  733. typedef struct AVPacket {
  734. /**
  735. * Presentation timestamp in AVStream->time_base units; the time at which
  736. * the decompressed packet will be presented to the user.
  737. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  738. * pts MUST be larger or equal to dts as presentation cannot happen before
  739. * decompression, unless one wants to view hex dumps. Some formats misuse
  740. * the terms dts and pts/cts to mean something different. Such timestamps
  741. * must be converted to true pts/dts before they are stored in AVPacket.
  742. */
  743. int64_t pts;
  744. /**
  745. * Decompression timestamp in AVStream->time_base units; the time at which
  746. * the packet is decompressed.
  747. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  748. */
  749. int64_t dts;
  750. uint8_t *data;
  751. int size;
  752. int stream_index;
  753. /**
  754. * A combination of AV_PKT_FLAG values
  755. */
  756. int flags;
  757. /**
  758. * Additional packet data that can be provided by the container.
  759. * Packet can contain several types of side information.
  760. */
  761. struct {
  762. uint8_t *data;
  763. int size;
  764. enum AVPacketSideDataType type;
  765. } *side_data;
  766. int side_data_elems;
  767. /**
  768. * Duration of this packet in AVStream->time_base units, 0 if unknown.
  769. * Equals next_pts - this_pts in presentation order.
  770. */
  771. int duration;
  772. void (*destruct)(struct AVPacket *);
  773. void *priv;
  774. int64_t pos; ///< byte position in stream, -1 if unknown
  775. /**
  776. * Time difference in AVStream->time_base units from the pts of this
  777. * packet to the point at which the output from the decoder has converged
  778. * independent from the availability of previous frames. That is, the
  779. * frames are virtually identical no matter if decoding started from
  780. * the very first frame or from this keyframe.
  781. * Is AV_NOPTS_VALUE if unknown.
  782. * This field is not the display duration of the current packet.
  783. * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
  784. * set.
  785. *
  786. * The purpose of this field is to allow seeking in streams that have no
  787. * keyframes in the conventional sense. It corresponds to the
  788. * recovery point SEI in H.264 and match_time_delta in NUT. It is also
  789. * essential for some types of subtitle streams to ensure that all
  790. * subtitles are correctly displayed after seeking.
  791. */
  792. int64_t convergence_duration;
  793. } AVPacket;
  794. #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
  795. #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
  796. /**
  797. * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
  798. * u32le param_flags
  799. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
  800. * s32le channel_count
  801. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
  802. * u64le channel_layout
  803. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
  804. * s32le sample_rate
  805. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
  806. * s32le width
  807. * s32le height
  808. */
  809. /**
  810. * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
  811. * structures with info about macroblocks relevant to splitting the
  812. * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
  813. * That is, it does not necessarily contain info about all macroblocks,
  814. * as long as the distance between macroblocks in the info is smaller
  815. * than the target payload size.
  816. * Each MB info structure is 12 bytes, and is laid out as follows:
  817. * u32le bit offset from the start of the packet
  818. * u8 current quantizer at the start of the macroblock
  819. * u8 GOB number
  820. * u16le macroblock address within the GOB
  821. * u8 horizontal MV predictor
  822. * u8 vertical MV predictor
  823. * u8 horizontal MV predictor for block number 3
  824. * u8 vertical MV predictor for block number 3
  825. */
  826. enum AVSideDataParamChangeFlags {
  827. AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
  828. AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
  829. AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
  830. AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
  831. };
  832. /**
  833. * Audio Video Frame.
  834. * New fields can be added to the end of AVFRAME with minor version
  835. * bumps. Similarly fields that are marked as to be only accessed by
  836. * av_opt_ptr() can be reordered. This allows 2 forks to add fields
  837. * without breaking compatibility with each other.
  838. * Removal, reordering and changes in the remaining cases require
  839. * a major version bump.
  840. * sizeof(AVFrame) must not be used outside libavcodec.
  841. */
  842. typedef struct AVFrame {
  843. #define AV_NUM_DATA_POINTERS 8
  844. /**
  845. * pointer to the picture/channel planes.
  846. * This might be different from the first allocated byte
  847. * - encoding: Set by user
  848. * - decoding: set by AVCodecContext.get_buffer()
  849. */
  850. uint8_t *data[AV_NUM_DATA_POINTERS];
  851. /**
  852. * Size, in bytes, of the data for each picture/channel plane.
  853. *
  854. * For audio, only linesize[0] may be set. For planar audio, each channel
  855. * plane must be the same size.
  856. *
  857. * - encoding: Set by user
  858. * - decoding: set by AVCodecContext.get_buffer()
  859. */
  860. int linesize[AV_NUM_DATA_POINTERS];
  861. /**
  862. * pointers to the data planes/channels.
  863. *
  864. * For video, this should simply point to data[].
  865. *
  866. * For planar audio, each channel has a separate data pointer, and
  867. * linesize[0] contains the size of each channel buffer.
  868. * For packed audio, there is just one data pointer, and linesize[0]
  869. * contains the total size of the buffer for all channels.
  870. *
  871. * Note: Both data and extended_data will always be set by get_buffer(),
  872. * but for planar audio with more channels that can fit in data,
  873. * extended_data must be used by the decoder in order to access all
  874. * channels.
  875. *
  876. * encoding: unused
  877. * decoding: set by AVCodecContext.get_buffer()
  878. */
  879. uint8_t **extended_data;
  880. /**
  881. * width and height of the video frame
  882. * - encoding: unused
  883. * - decoding: Read by user.
  884. */
  885. int width, height;
  886. /**
  887. * number of audio samples (per channel) described by this frame
  888. * - encoding: Set by user
  889. * - decoding: Set by libavcodec
  890. */
  891. int nb_samples;
  892. /**
  893. * format of the frame, -1 if unknown or unset
  894. * Values correspond to enum PixelFormat for video frames,
  895. * enum AVSampleFormat for audio)
  896. * - encoding: unused
  897. * - decoding: Read by user.
  898. */
  899. int format;
  900. /**
  901. * 1 -> keyframe, 0-> not
  902. * - encoding: Set by libavcodec.
  903. * - decoding: Set by libavcodec.
  904. */
  905. int key_frame;
  906. /**
  907. * Picture type of the frame, see ?_TYPE below.
  908. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
  909. * - decoding: Set by libavcodec.
  910. */
  911. enum AVPictureType pict_type;
  912. /**
  913. * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
  914. * This isn't used by libavcodec unless the default get/release_buffer() is used.
  915. * - encoding:
  916. * - decoding:
  917. */
  918. uint8_t *base[AV_NUM_DATA_POINTERS];
  919. /**
  920. * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
  921. * - encoding: unused
  922. * - decoding: Read by user.
  923. */
  924. AVRational sample_aspect_ratio;
  925. /**
  926. * presentation timestamp in time_base units (time when frame should be shown to user)
  927. * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
  928. * - encoding: MUST be set by user.
  929. * - decoding: Set by libavcodec.
  930. */
  931. int64_t pts;
  932. /**
  933. * reordered pts from the last AVPacket that has been input into the decoder
  934. * - encoding: unused
  935. * - decoding: Read by user.
  936. */
  937. int64_t pkt_pts;
  938. /**
  939. * dts from the last AVPacket that has been input into the decoder
  940. * - encoding: unused
  941. * - decoding: Read by user.
  942. */
  943. int64_t pkt_dts;
  944. /**
  945. * picture number in bitstream order
  946. * - encoding: set by
  947. * - decoding: Set by libavcodec.
  948. */
  949. int coded_picture_number;
  950. /**
  951. * picture number in display order
  952. * - encoding: set by
  953. * - decoding: Set by libavcodec.
  954. */
  955. int display_picture_number;
  956. /**
  957. * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
  958. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
  959. * - decoding: Set by libavcodec.
  960. */
  961. int quality;
  962. /**
  963. * is this picture used as reference
  964. * The values for this are the same as the MpegEncContext.picture_structure
  965. * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
  966. * Set to 4 for delayed, non-reference frames.
  967. * - encoding: unused
  968. * - decoding: Set by libavcodec. (before get_buffer() call)).
  969. */
  970. int reference;
  971. /**
  972. * QP table
  973. * - encoding: unused
  974. * - decoding: Set by libavcodec.
  975. */
  976. int8_t *qscale_table;
  977. /**
  978. * QP store stride
  979. * - encoding: unused
  980. * - decoding: Set by libavcodec.
  981. */
  982. int qstride;
  983. /**
  984. *
  985. */
  986. int qscale_type;
  987. /**
  988. * mbskip_table[mb]>=1 if MB didn't change
  989. * stride= mb_width = (width+15)>>4
  990. * - encoding: unused
  991. * - decoding: Set by libavcodec.
  992. */
  993. uint8_t *mbskip_table;
  994. /**
  995. * motion vector table
  996. * @code
  997. * example:
  998. * int mv_sample_log2= 4 - motion_subsample_log2;
  999. * int mb_width= (width+15)>>4;
  1000. * int mv_stride= (mb_width << mv_sample_log2) + 1;
  1001. * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
  1002. * @endcode
  1003. * - encoding: Set by user.
  1004. * - decoding: Set by libavcodec.
  1005. */
  1006. int16_t (*motion_val[2])[2];
  1007. /**
  1008. * macroblock type table
  1009. * mb_type_base + mb_width + 2
  1010. * - encoding: Set by user.
  1011. * - decoding: Set by libavcodec.
  1012. */
  1013. uint32_t *mb_type;
  1014. /**
  1015. * DCT coefficients
  1016. * - encoding: unused
  1017. * - decoding: Set by libavcodec.
  1018. */
  1019. short *dct_coeff;
  1020. /**
  1021. * motion reference frame index
  1022. * the order in which these are stored can depend on the codec.
  1023. * - encoding: Set by user.
  1024. * - decoding: Set by libavcodec.
  1025. */
  1026. int8_t *ref_index[2];
  1027. /**
  1028. * for some private data of the user
  1029. * - encoding: unused
  1030. * - decoding: Set by user.
  1031. */
  1032. void *opaque;
  1033. /**
  1034. * error
  1035. * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
  1036. * - decoding: unused
  1037. */
  1038. uint64_t error[AV_NUM_DATA_POINTERS];
  1039. /**
  1040. * type of the buffer (to keep track of who has to deallocate data[*])
  1041. * - encoding: Set by the one who allocates it.
  1042. * - decoding: Set by the one who allocates it.
  1043. * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
  1044. */
  1045. int type;
  1046. /**
  1047. * When decoding, this signals how much the picture must be delayed.
  1048. * extra_delay = repeat_pict / (2*fps)
  1049. * - encoding: unused
  1050. * - decoding: Set by libavcodec.
  1051. */
  1052. int repeat_pict;
  1053. /**
  1054. * The content of the picture is interlaced.
  1055. * - encoding: Set by user.
  1056. * - decoding: Set by libavcodec. (default 0)
  1057. */
  1058. int interlaced_frame;
  1059. /**
  1060. * If the content is interlaced, is top field displayed first.
  1061. * - encoding: Set by user.
  1062. * - decoding: Set by libavcodec.
  1063. */
  1064. int top_field_first;
  1065. /**
  1066. * Tell user application that palette has changed from previous frame.
  1067. * - encoding: ??? (no palette-enabled encoder yet)
  1068. * - decoding: Set by libavcodec. (default 0).
  1069. */
  1070. int palette_has_changed;
  1071. /**
  1072. * codec suggestion on buffer type if != 0
  1073. * - encoding: unused
  1074. * - decoding: Set by libavcodec. (before get_buffer() call)).
  1075. */
  1076. int buffer_hints;
  1077. /**
  1078. * Pan scan.
  1079. * - encoding: Set by user.
  1080. * - decoding: Set by libavcodec.
  1081. */
  1082. AVPanScan *pan_scan;
  1083. /**
  1084. * reordered opaque 64bit (generally an integer or a double precision float
  1085. * PTS but can be anything).
  1086. * The user sets AVCodecContext.reordered_opaque to represent the input at
  1087. * that time,
  1088. * the decoder reorders values as needed and sets AVFrame.reordered_opaque
  1089. * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
  1090. * @deprecated in favor of pkt_pts
  1091. * - encoding: unused
  1092. * - decoding: Read by user.
  1093. */
  1094. int64_t reordered_opaque;
  1095. /**
  1096. * hardware accelerator private data (FFmpeg-allocated)
  1097. * - encoding: unused
  1098. * - decoding: Set by libavcodec
  1099. */
  1100. void *hwaccel_picture_private;
  1101. /**
  1102. * the AVCodecContext which ff_thread_get_buffer() was last called on
  1103. * - encoding: Set by libavcodec.
  1104. * - decoding: Set by libavcodec.
  1105. */
  1106. struct AVCodecContext *owner;
  1107. /**
  1108. * used by multithreading to store frame-specific info
  1109. * - encoding: Set by libavcodec.
  1110. * - decoding: Set by libavcodec.
  1111. */
  1112. void *thread_opaque;
  1113. /**
  1114. * log2 of the size of the block which a single vector in motion_val represents:
  1115. * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
  1116. * - encoding: unused
  1117. * - decoding: Set by libavcodec.
  1118. */
  1119. uint8_t motion_subsample_log2;
  1120. /**
  1121. * frame timestamp estimated using various heuristics, in stream time base
  1122. * Code outside libavcodec should access this field using:
  1123. * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
  1124. * - encoding: unused
  1125. * - decoding: set by libavcodec, read by user.
  1126. */
  1127. int64_t best_effort_timestamp;
  1128. /**
  1129. * reordered pos from the last AVPacket that has been input into the decoder
  1130. * Code outside libavcodec should access this field using:
  1131. * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
  1132. * - encoding: unused
  1133. * - decoding: Read by user.
  1134. */
  1135. int64_t pkt_pos;
  1136. } AVFrame;
  1137. struct AVCodecInternal;
  1138. enum AVFieldOrder {
  1139. AV_FIELD_UNKNOWN,
  1140. AV_FIELD_PROGRESSIVE,
  1141. AV_FIELD_TT, //< Top coded_first, top displayed first
  1142. AV_FIELD_BB, //< Bottom coded first, bottom displayed first
  1143. AV_FIELD_TB, //< Top coded first, bottom displayed first
  1144. AV_FIELD_BT, //< Bottom coded first, top displayed first
  1145. };
  1146. /**
  1147. * main external API structure.
  1148. * New fields can be added to the end with minor version bumps.
  1149. * Removal, reordering and changes to existing fields require a major
  1150. * version bump.
  1151. * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
  1152. * applications.
  1153. * sizeof(AVCodecContext) must not be used outside libav*.
  1154. */
  1155. typedef struct AVCodecContext {
  1156. /**
  1157. * information on struct for av_log
  1158. * - set by avcodec_alloc_context3
  1159. */
  1160. const AVClass *av_class;
  1161. int log_level_offset;
  1162. enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
  1163. struct AVCodec *codec;
  1164. char codec_name[32];
  1165. enum CodecID codec_id; /* see CODEC_ID_xxx */
  1166. /**
  1167. * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1168. * This is used to work around some encoder bugs.
  1169. * A demuxer should set this to what is stored in the field used to identify the codec.
  1170. * If there are multiple such fields in a container then the demuxer should choose the one
  1171. * which maximizes the information about the used codec.
  1172. * If the codec tag field in a container is larger than 32 bits then the demuxer should
  1173. * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
  1174. * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
  1175. * first.
  1176. * - encoding: Set by user, if not then the default based on codec_id will be used.
  1177. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1178. */
  1179. unsigned int codec_tag;
  1180. /**
  1181. * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1182. * This is used to work around some encoder bugs.
  1183. * - encoding: unused
  1184. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1185. */
  1186. unsigned int stream_codec_tag;
  1187. #if FF_API_SUB_ID
  1188. /**
  1189. * @deprecated this field is unused
  1190. */
  1191. attribute_deprecated int sub_id;
  1192. #endif
  1193. void *priv_data;
  1194. /**
  1195. * Private context used for internal data.
  1196. *
  1197. * Unlike priv_data, this is not codec-specific. It is used in general
  1198. * libavcodec functions.
  1199. */
  1200. struct AVCodecInternal *internal;
  1201. /**
  1202. * Private data of the user, can be used to carry app specific stuff.
  1203. * - encoding: Set by user.
  1204. * - decoding: Set by user.
  1205. */
  1206. void *opaque;
  1207. /**
  1208. * the average bitrate
  1209. * - encoding: Set by user; unused for constant quantizer encoding.
  1210. * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
  1211. */
  1212. int bit_rate;
  1213. /**
  1214. * number of bits the bitstream is allowed to diverge from the reference.
  1215. * the reference can be CBR (for CBR pass1) or VBR (for pass2)
  1216. * - encoding: Set by user; unused for constant quantizer encoding.
  1217. * - decoding: unused
  1218. */
  1219. int bit_rate_tolerance;
  1220. /**
  1221. * Global quality for codecs which cannot change it per frame.
  1222. * This should be proportional to MPEG-1/2/4 qscale.
  1223. * - encoding: Set by user.
  1224. * - decoding: unused
  1225. */
  1226. int global_quality;
  1227. /**
  1228. * - encoding: Set by user.
  1229. * - decoding: unused
  1230. */
  1231. int compression_level;
  1232. #define FF_COMPRESSION_DEFAULT -1
  1233. /**
  1234. * CODEC_FLAG_*.
  1235. * - encoding: Set by user.
  1236. * - decoding: Set by user.
  1237. */
  1238. int flags;
  1239. /**
  1240. * CODEC_FLAG2_*
  1241. * - encoding: Set by user.
  1242. * - decoding: Set by user.
  1243. */
  1244. int flags2;
  1245. /**
  1246. * some codecs need / can use extradata like Huffman tables.
  1247. * mjpeg: Huffman tables
  1248. * rv10: additional flags
  1249. * mpeg4: global headers (they can be in the bitstream or here)
  1250. * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
  1251. * than extradata_size to avoid prolems if it is read with the bitstream reader.
  1252. * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
  1253. * - encoding: Set/allocated/freed by libavcodec.
  1254. * - decoding: Set/allocated/freed by user.
  1255. */
  1256. uint8_t *extradata;
  1257. int extradata_size;
  1258. /**
  1259. * This is the fundamental unit of time (in seconds) in terms
  1260. * of which frame timestamps are represented. For fixed-fps content,
  1261. * timebase should be 1/framerate and timestamp increments should be
  1262. * identically 1.
  1263. * - encoding: MUST be set by user.
  1264. * - decoding: Set by libavcodec.
  1265. */
  1266. AVRational time_base;
  1267. /**
  1268. * For some codecs, the time base is closer to the field rate than the frame rate.
  1269. * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
  1270. * if no telecine is used ...
  1271. *
  1272. * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
  1273. */
  1274. int ticks_per_frame;
  1275. /**
  1276. * Encoding: Number of frames delay there will be from the encoder input to
  1277. * the decoder output. (we assume the decoder matches the spec)
  1278. * Decoding: Number of frames delay in addition to what a standard decoder
  1279. * as specified in the spec would produce.
  1280. *
  1281. * Video:
  1282. * Number of frames the decoded output will be delayed relative to the
  1283. * encoded input.
  1284. *
  1285. * Audio:
  1286. * Number of "priming" samples added to the beginning of the stream
  1287. * during encoding. The decoded output will be delayed by this many
  1288. * samples relative to the input to the encoder. Note that this field is
  1289. * purely informational and does not directly affect the pts output by
  1290. * the encoder, which should always be based on the actual presentation
  1291. * time, including any delay.
  1292. *
  1293. * - encoding: Set by libavcodec.
  1294. * - decoding: Set by libavcodec.
  1295. */
  1296. int delay;
  1297. /* video only */
  1298. /**
  1299. * picture width / height.
  1300. * - encoding: MUST be set by user.
  1301. * - decoding: Set by libavcodec.
  1302. * Note: For compatibility it is possible to set this instead of
  1303. * coded_width/height before decoding.
  1304. */
  1305. int width, height;
  1306. /**
  1307. * Bitstream width / height, may be different from width/height if lowres enabled.
  1308. * - encoding: unused
  1309. * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
  1310. */
  1311. int coded_width, coded_height;
  1312. #define FF_ASPECT_EXTENDED 15
  1313. /**
  1314. * the number of pictures in a group of pictures, or 0 for intra_only
  1315. * - encoding: Set by user.
  1316. * - decoding: unused
  1317. */
  1318. int gop_size;
  1319. /**
  1320. * Pixel format, see PIX_FMT_xxx.
  1321. * May be set by the demuxer if known from headers.
  1322. * May be overriden by the decoder if it knows better.
  1323. * - encoding: Set by user.
  1324. * - decoding: Set by user if known, overridden by libavcodec if known
  1325. */
  1326. enum PixelFormat pix_fmt;
  1327. /**
  1328. * Motion estimation algorithm used for video coding.
  1329. * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
  1330. * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
  1331. * - encoding: MUST be set by user.
  1332. * - decoding: unused
  1333. */
  1334. int me_method;
  1335. /**
  1336. * If non NULL, 'draw_horiz_band' is called by the libavcodec
  1337. * decoder to draw a horizontal band. It improves cache usage. Not
  1338. * all codecs can do that. You must check the codec capabilities
  1339. * beforehand.
  1340. * When multithreading is used, it may be called from multiple threads
  1341. * at the same time; threads might draw different parts of the same AVFrame,
  1342. * or multiple AVFrames, and there is no guarantee that slices will be drawn
  1343. * in order.
  1344. * The function is also used by hardware acceleration APIs.
  1345. * It is called at least once during frame decoding to pass
  1346. * the data needed for hardware render.
  1347. * In that mode instead of pixel data, AVFrame points to
  1348. * a structure specific to the acceleration API. The application
  1349. * reads the structure and can change some fields to indicate progress
  1350. * or mark state.
  1351. * - encoding: unused
  1352. * - decoding: Set by user.
  1353. * @param height the height of the slice
  1354. * @param y the y position of the slice
  1355. * @param type 1->top field, 2->bottom field, 3->frame
  1356. * @param offset offset into the AVFrame.data from which the slice should be read
  1357. */
  1358. void (*draw_horiz_band)(struct AVCodecContext *s,
  1359. const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
  1360. int y, int type, int height);
  1361. /**
  1362. * callback to negotiate the pixelFormat
  1363. * @param fmt is the list of formats which are supported by the codec,
  1364. * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
  1365. * The first is always the native one.
  1366. * @return the chosen format
  1367. * - encoding: unused
  1368. * - decoding: Set by user, if not set the native format will be chosen.
  1369. */
  1370. enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
  1371. /**
  1372. * maximum number of B-frames between non-B-frames
  1373. * Note: The output will be delayed by max_b_frames+1 relative to the input.
  1374. * - encoding: Set by user.
  1375. * - decoding: unused
  1376. */
  1377. int max_b_frames;
  1378. /**
  1379. * qscale factor between IP and B-frames
  1380. * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
  1381. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1382. * - encoding: Set by user.
  1383. * - decoding: unused
  1384. */
  1385. float b_quant_factor;
  1386. /** obsolete FIXME remove */
  1387. int rc_strategy;
  1388. #define FF_RC_STRATEGY_XVID 1
  1389. int b_frame_strategy;
  1390. #if FF_API_MPV_GLOBAL_OPTS
  1391. /**
  1392. * luma single coefficient elimination threshold
  1393. * - encoding: Set by user.
  1394. * - decoding: unused
  1395. */
  1396. attribute_deprecated int luma_elim_threshold;
  1397. /**
  1398. * chroma single coeff elimination threshold
  1399. * - encoding: Set by user.
  1400. * - decoding: unused
  1401. */
  1402. attribute_deprecated int chroma_elim_threshold;
  1403. #endif
  1404. /**
  1405. * qscale offset between IP and B-frames
  1406. * - encoding: Set by user.
  1407. * - decoding: unused
  1408. */
  1409. float b_quant_offset;
  1410. /**
  1411. * Size of the frame reordering buffer in the decoder.
  1412. * For MPEG-2 it is 1 IPB or 0 low delay IP.
  1413. * - encoding: Set by libavcodec.
  1414. * - decoding: Set by libavcodec.
  1415. */
  1416. int has_b_frames;
  1417. /**
  1418. * 0-> h263 quant 1-> mpeg quant
  1419. * - encoding: Set by user.
  1420. * - decoding: unused
  1421. */
  1422. int mpeg_quant;
  1423. /**
  1424. * qscale factor between P and I-frames
  1425. * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
  1426. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1427. * - encoding: Set by user.
  1428. * - decoding: unused
  1429. */
  1430. float i_quant_factor;
  1431. /**
  1432. * qscale offset between P and I-frames
  1433. * - encoding: Set by user.
  1434. * - decoding: unused
  1435. */
  1436. float i_quant_offset;
  1437. /**
  1438. * luminance masking (0-> disabled)
  1439. * - encoding: Set by user.
  1440. * - decoding: unused
  1441. */
  1442. float lumi_masking;
  1443. /**
  1444. * temporary complexity masking (0-> disabled)
  1445. * - encoding: Set by user.
  1446. * - decoding: unused
  1447. */
  1448. float temporal_cplx_masking;
  1449. /**
  1450. * spatial complexity masking (0-> disabled)
  1451. * - encoding: Set by user.
  1452. * - decoding: unused
  1453. */
  1454. float spatial_cplx_masking;
  1455. /**
  1456. * p block masking (0-> disabled)
  1457. * - encoding: Set by user.
  1458. * - decoding: unused
  1459. */
  1460. float p_masking;
  1461. /**
  1462. * darkness masking (0-> disabled)
  1463. * - encoding: Set by user.
  1464. * - decoding: unused
  1465. */
  1466. float dark_masking;
  1467. /**
  1468. * slice count
  1469. * - encoding: Set by libavcodec.
  1470. * - decoding: Set by user (or 0).
  1471. */
  1472. int slice_count;
  1473. /**
  1474. * prediction method (needed for huffyuv)
  1475. * - encoding: Set by user.
  1476. * - decoding: unused
  1477. */
  1478. int prediction_method;
  1479. #define FF_PRED_LEFT 0
  1480. #define FF_PRED_PLANE 1
  1481. #define FF_PRED_MEDIAN 2
  1482. /**
  1483. * slice offsets in the frame in bytes
  1484. * - encoding: Set/allocated by libavcodec.
  1485. * - decoding: Set/allocated by user (or NULL).
  1486. */
  1487. int *slice_offset;
  1488. /**
  1489. * sample aspect ratio (0 if unknown)
  1490. * That is the width of a pixel divided by the height of the pixel.
  1491. * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
  1492. * - encoding: Set by user.
  1493. * - decoding: Set by libavcodec.
  1494. */
  1495. AVRational sample_aspect_ratio;
  1496. /**
  1497. * motion estimation comparison function
  1498. * - encoding: Set by user.
  1499. * - decoding: unused
  1500. */
  1501. int me_cmp;
  1502. /**
  1503. * subpixel motion estimation comparison function
  1504. * - encoding: Set by user.
  1505. * - decoding: unused
  1506. */
  1507. int me_sub_cmp;
  1508. /**
  1509. * macroblock comparison function (not supported yet)
  1510. * - encoding: Set by user.
  1511. * - decoding: unused
  1512. */
  1513. int mb_cmp;
  1514. /**
  1515. * interlaced DCT comparison function
  1516. * - encoding: Set by user.
  1517. * - decoding: unused
  1518. */
  1519. int ildct_cmp;
  1520. #define FF_CMP_SAD 0
  1521. #define FF_CMP_SSE 1
  1522. #define FF_CMP_SATD 2
  1523. #define FF_CMP_DCT 3
  1524. #define FF_CMP_PSNR 4
  1525. #define FF_CMP_BIT 5
  1526. #define FF_CMP_RD 6
  1527. #define FF_CMP_ZERO 7
  1528. #define FF_CMP_VSAD 8
  1529. #define FF_CMP_VSSE 9
  1530. #define FF_CMP_NSSE 10
  1531. #define FF_CMP_W53 11
  1532. #define FF_CMP_W97 12
  1533. #define FF_CMP_DCTMAX 13
  1534. #define FF_CMP_DCT264 14
  1535. #define FF_CMP_CHROMA 256
  1536. /**
  1537. * ME diamond size & shape
  1538. * - encoding: Set by user.
  1539. * - decoding: unused
  1540. */
  1541. int dia_size;
  1542. /**
  1543. * amount of previous MV predictors (2a+1 x 2a+1 square)
  1544. * - encoding: Set by user.
  1545. * - decoding: unused
  1546. */
  1547. int last_predictor_count;
  1548. /**
  1549. * prepass for motion estimation
  1550. * - encoding: Set by user.
  1551. * - decoding: unused
  1552. */
  1553. int pre_me;
  1554. /**
  1555. * motion estimation prepass comparison function
  1556. * - encoding: Set by user.
  1557. * - decoding: unused
  1558. */
  1559. int me_pre_cmp;
  1560. /**
  1561. * ME prepass diamond size & shape
  1562. * - encoding: Set by user.
  1563. * - decoding: unused
  1564. */
  1565. int pre_dia_size;
  1566. /**
  1567. * subpel ME quality
  1568. * - encoding: Set by user.
  1569. * - decoding: unused
  1570. */
  1571. int me_subpel_quality;
  1572. /**
  1573. * DTG active format information (additional aspect ratio
  1574. * information only used in DVB MPEG-2 transport streams)
  1575. * 0 if not set.
  1576. *
  1577. * - encoding: unused
  1578. * - decoding: Set by decoder.
  1579. */
  1580. int dtg_active_format;
  1581. #define FF_DTG_AFD_SAME 8
  1582. #define FF_DTG_AFD_4_3 9
  1583. #define FF_DTG_AFD_16_9 10
  1584. #define FF_DTG_AFD_14_9 11
  1585. #define FF_DTG_AFD_4_3_SP_14_9 13
  1586. #define FF_DTG_AFD_16_9_SP_14_9 14
  1587. #define FF_DTG_AFD_SP_4_3 15
  1588. /**
  1589. * maximum motion estimation search range in subpel units
  1590. * If 0 then no limit.
  1591. *
  1592. * - encoding: Set by user.
  1593. * - decoding: unused
  1594. */
  1595. int me_range;
  1596. /**
  1597. * intra quantizer bias
  1598. * - encoding: Set by user.
  1599. * - decoding: unused
  1600. */
  1601. int intra_quant_bias;
  1602. #define FF_DEFAULT_QUANT_BIAS 999999
  1603. /**
  1604. * inter quantizer bias
  1605. * - encoding: Set by user.
  1606. * - decoding: unused
  1607. */
  1608. int inter_quant_bias;
  1609. #if FF_API_COLOR_TABLE_ID
  1610. /**
  1611. * color table ID
  1612. * - encoding: unused
  1613. * - decoding: Which clrtable should be used for 8bit RGB images.
  1614. * Tables have to be stored somewhere. FIXME
  1615. */
  1616. attribute_deprecated int color_table_id;
  1617. #endif
  1618. /**
  1619. * slice flags
  1620. * - encoding: unused
  1621. * - decoding: Set by user.
  1622. */
  1623. int slice_flags;
  1624. #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
  1625. #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
  1626. #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
  1627. /**
  1628. * XVideo Motion Acceleration
  1629. * - encoding: forbidden
  1630. * - decoding: set by decoder
  1631. */
  1632. int xvmc_acceleration;
  1633. /**
  1634. * macroblock decision mode
  1635. * - encoding: Set by user.
  1636. * - decoding: unused
  1637. */
  1638. int mb_decision;
  1639. #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
  1640. #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
  1641. #define FF_MB_DECISION_RD 2 ///< rate distortion
  1642. /**
  1643. * custom intra quantization matrix
  1644. * - encoding: Set by user, can be NULL.
  1645. * - decoding: Set by libavcodec.
  1646. */
  1647. uint16_t *intra_matrix;
  1648. /**
  1649. * custom inter quantization matrix
  1650. * - encoding: Set by user, can be NULL.
  1651. * - decoding: Set by libavcodec.
  1652. */
  1653. uint16_t *inter_matrix;
  1654. /**
  1655. * scene change detection threshold
  1656. * 0 is default, larger means fewer detected scene changes.
  1657. * - encoding: Set by user.
  1658. * - decoding: unused
  1659. */
  1660. int scenechange_threshold;
  1661. /**
  1662. * noise reduction strength
  1663. * - encoding: Set by user.
  1664. * - decoding: unused
  1665. */
  1666. int noise_reduction;
  1667. #if FF_API_INTER_THRESHOLD
  1668. /**
  1669. * @deprecated this field is unused
  1670. */
  1671. attribute_deprecated int inter_threshold;
  1672. #endif
  1673. #if FF_API_MPV_GLOBAL_OPTS
  1674. /**
  1675. * @deprecated use mpegvideo private options instead
  1676. */
  1677. attribute_deprecated int quantizer_noise_shaping;
  1678. #endif
  1679. /**
  1680. * Motion estimation threshold below which no motion estimation is
  1681. * performed, but instead the user specified motion vectors are used.
  1682. *
  1683. * - encoding: Set by user.
  1684. * - decoding: unused
  1685. */
  1686. int me_threshold;
  1687. /**
  1688. * Macroblock threshold below which the user specified macroblock types will be used.
  1689. * - encoding: Set by user.
  1690. * - decoding: unused
  1691. */
  1692. int mb_threshold;
  1693. /**
  1694. * precision of the intra DC coefficient - 8
  1695. * - encoding: Set by user.
  1696. * - decoding: unused
  1697. */
  1698. int intra_dc_precision;
  1699. /**
  1700. * Number of macroblock rows at the top which are skipped.
  1701. * - encoding: unused
  1702. * - decoding: Set by user.
  1703. */
  1704. int skip_top;
  1705. /**
  1706. * Number of macroblock rows at the bottom which are skipped.
  1707. * - encoding: unused
  1708. * - decoding: Set by user.
  1709. */
  1710. int skip_bottom;
  1711. /**
  1712. * Border processing masking, raises the quantizer for mbs on the borders
  1713. * of the picture.
  1714. * - encoding: Set by user.
  1715. * - decoding: unused
  1716. */
  1717. float border_masking;
  1718. /**
  1719. * minimum MB lagrange multipler
  1720. * - encoding: Set by user.
  1721. * - decoding: unused
  1722. */
  1723. int mb_lmin;
  1724. /**
  1725. * maximum MB lagrange multipler
  1726. * - encoding: Set by user.
  1727. * - decoding: unused
  1728. */
  1729. int mb_lmax;
  1730. /**
  1731. *
  1732. * - encoding: Set by user.
  1733. * - decoding: unused
  1734. */
  1735. int me_penalty_compensation;
  1736. /**
  1737. *
  1738. * - encoding: Set by user.
  1739. * - decoding: unused
  1740. */
  1741. int bidir_refine;
  1742. /**
  1743. *
  1744. * - encoding: Set by user.
  1745. * - decoding: unused
  1746. */
  1747. int brd_scale;
  1748. /**
  1749. * minimum GOP size
  1750. * - encoding: Set by user.
  1751. * - decoding: unused
  1752. */
  1753. int keyint_min;
  1754. /**
  1755. * number of reference frames
  1756. * - encoding: Set by user.
  1757. * - decoding: Set by lavc.
  1758. */
  1759. int refs;
  1760. /**
  1761. * chroma qp offset from luma
  1762. * - encoding: Set by user.
  1763. * - decoding: unused
  1764. */
  1765. int chromaoffset;
  1766. /**
  1767. * Multiplied by qscale for each frame and added to scene_change_score.
  1768. * - encoding: Set by user.
  1769. * - decoding: unused
  1770. */
  1771. int scenechange_factor;
  1772. /**
  1773. *
  1774. * Note: Value depends upon the compare function used for fullpel ME.
  1775. * - encoding: Set by user.
  1776. * - decoding: unused
  1777. */
  1778. int mv0_threshold;
  1779. /**
  1780. * Adjust sensitivity of b_frame_strategy 1.
  1781. * - encoding: Set by user.
  1782. * - decoding: unused
  1783. */
  1784. int b_sensitivity;
  1785. /**
  1786. * Chromaticity coordinates of the source primaries.
  1787. * - encoding: Set by user
  1788. * - decoding: Set by libavcodec
  1789. */
  1790. enum AVColorPrimaries color_primaries;
  1791. /**
  1792. * Color Transfer Characteristic.
  1793. * - encoding: Set by user
  1794. * - decoding: Set by libavcodec
  1795. */
  1796. enum AVColorTransferCharacteristic color_trc;
  1797. /**
  1798. * YUV colorspace type.
  1799. * - encoding: Set by user
  1800. * - decoding: Set by libavcodec
  1801. */
  1802. enum AVColorSpace colorspace;
  1803. /**
  1804. * MPEG vs JPEG YUV range.
  1805. * - encoding: Set by user
  1806. * - decoding: Set by libavcodec
  1807. */
  1808. enum AVColorRange color_range;
  1809. /**
  1810. * This defines the location of chroma samples.
  1811. * - encoding: Set by user
  1812. * - decoding: Set by libavcodec
  1813. */
  1814. enum AVChromaLocation chroma_sample_location;
  1815. /**
  1816. * Number of slices.
  1817. * Indicates number of picture subdivisions. Used for parallelized
  1818. * decoding.
  1819. * - encoding: Set by user
  1820. * - decoding: unused
  1821. */
  1822. int slices;
  1823. /** Field order
  1824. * - encoding: set by libavcodec
  1825. * - decoding: Set by libavcodec
  1826. */
  1827. enum AVFieldOrder field_order;
  1828. /* audio only */
  1829. int sample_rate; ///< samples per second
  1830. int channels; ///< number of audio channels
  1831. /**
  1832. * audio sample format
  1833. * - encoding: Set by user.
  1834. * - decoding: Set by libavcodec.
  1835. */
  1836. enum AVSampleFormat sample_fmt; ///< sample format
  1837. /* The following data should not be initialized. */
  1838. /**
  1839. * Samples per packet, initialized when calling 'init'.
  1840. */
  1841. int frame_size;
  1842. /**
  1843. * Frame counter, set by libavcodec.
  1844. *
  1845. * - decoding: total number of frames returned from the decoder so far.
  1846. * - encoding: total number of frames passed to the encoder so far.
  1847. *
  1848. * @note the counter is not incremented if encoding/decoding resulted in
  1849. * an error.
  1850. */
  1851. int frame_number;
  1852. /**
  1853. * number of bytes per packet if constant and known or 0
  1854. * Used by some WAV based audio codecs.
  1855. */
  1856. int block_align;
  1857. /**
  1858. * Audio cutoff bandwidth (0 means "automatic")
  1859. * - encoding: Set by user.
  1860. * - decoding: unused
  1861. */
  1862. int cutoff;
  1863. #if FF_API_REQUEST_CHANNELS
  1864. /**
  1865. * Decoder should decode to this many channels if it can (0 for default)
  1866. * - encoding: unused
  1867. * - decoding: Set by user.
  1868. * @deprecated Deprecated in favor of request_channel_layout.
  1869. */
  1870. int request_channels;
  1871. #endif
  1872. /**
  1873. * Audio channel layout.
  1874. * - encoding: set by user.
  1875. * - decoding: set by user, may be overwritten by libavcodec.
  1876. */
  1877. uint64_t channel_layout;
  1878. /**
  1879. * Request decoder to use this channel layout if it can (0 for default)
  1880. * - encoding: unused
  1881. * - decoding: Set by user.
  1882. */
  1883. uint64_t request_channel_layout;
  1884. /**
  1885. * Type of service that the audio stream conveys.
  1886. * - encoding: Set by user.
  1887. * - decoding: Set by libavcodec.
  1888. */
  1889. enum AVAudioServiceType audio_service_type;
  1890. /**
  1891. * desired sample format
  1892. * - encoding: Not used.
  1893. * - decoding: Set by user.
  1894. * Decoder will decode to this format if it can.
  1895. */
  1896. enum AVSampleFormat request_sample_fmt;
  1897. /**
  1898. * Called at the beginning of each frame to get a buffer for it.
  1899. *
  1900. * The function will set AVFrame.data[], AVFrame.linesize[].
  1901. * AVFrame.extended_data[] must also be set, but it should be the same as
  1902. * AVFrame.data[] except for planar audio with more channels than can fit
  1903. * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
  1904. * many data pointers as it can hold.
  1905. *
  1906. * if CODEC_CAP_DR1 is not set then get_buffer() must call
  1907. * avcodec_default_get_buffer() instead of providing buffers allocated by
  1908. * some other means.
  1909. *
  1910. * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
  1911. * need it. avcodec_default_get_buffer() aligns the output buffer properly,
  1912. * but if get_buffer() is overridden then alignment considerations should
  1913. * be taken into account.
  1914. *
  1915. * @see avcodec_default_get_buffer()
  1916. *
  1917. * Video:
  1918. *
  1919. * If pic.reference is set then the frame will be read later by libavcodec.
  1920. * avcodec_align_dimensions2() should be used to find the required width and
  1921. * height, as they normally need to be rounded up to the next multiple of 16.
  1922. *
  1923. * If frame multithreading is used and thread_safe_callbacks is set,
  1924. * it may be called from a different thread, but not from more than one at
  1925. * once. Does not need to be reentrant.
  1926. *
  1927. * @see release_buffer(), reget_buffer()
  1928. * @see avcodec_align_dimensions2()
  1929. *
  1930. * Audio:
  1931. *
  1932. * Decoders request a buffer of a particular size by setting
  1933. * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
  1934. * however, utilize only part of the buffer by setting AVFrame.nb_samples
  1935. * to a smaller value in the output frame.
  1936. *
  1937. * Decoders cannot use the buffer after returning from
  1938. * avcodec_decode_audio4(), so they will not call release_buffer(), as it
  1939. * is assumed to be released immediately upon return.
  1940. *
  1941. * As a convenience, av_samples_get_buffer_size() and
  1942. * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
  1943. * functions to find the required data size and to fill data pointers and
  1944. * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
  1945. * since all planes must be the same size.
  1946. *
  1947. * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
  1948. *
  1949. * - encoding: unused
  1950. * - decoding: Set by libavcodec, user can override.
  1951. */
  1952. int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1953. /**
  1954. * Called to release buffers which were allocated with get_buffer.
  1955. * A released buffer can be reused in get_buffer().
  1956. * pic.data[*] must be set to NULL.
  1957. * May be called from a different thread if frame multithreading is used,
  1958. * but not by more than one thread at once, so does not need to be reentrant.
  1959. * - encoding: unused
  1960. * - decoding: Set by libavcodec, user can override.
  1961. */
  1962. void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1963. /**
  1964. * Called at the beginning of a frame to get cr buffer for it.
  1965. * Buffer type (size, hints) must be the same. libavcodec won't check it.
  1966. * libavcodec will pass previous buffer in pic, function should return
  1967. * same buffer or new buffer with old frame "painted" into it.
  1968. * If pic.data[0] == NULL must behave like get_buffer().
  1969. * if CODEC_CAP_DR1 is not set then reget_buffer() must call
  1970. * avcodec_default_reget_buffer() instead of providing buffers allocated by
  1971. * some other means.
  1972. * - encoding: unused
  1973. * - decoding: Set by libavcodec, user can override.
  1974. */
  1975. int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1976. /* - encoding parameters */
  1977. float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
  1978. float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
  1979. /**
  1980. * minimum quantizer
  1981. * - encoding: Set by user.
  1982. * - decoding: unused
  1983. */
  1984. int qmin;
  1985. /**
  1986. * maximum quantizer
  1987. * - encoding: Set by user.
  1988. * - decoding: unused
  1989. */
  1990. int qmax;
  1991. /**
  1992. * maximum quantizer difference between frames
  1993. * - encoding: Set by user.
  1994. * - decoding: unused
  1995. */
  1996. int max_qdiff;
  1997. /**
  1998. * ratecontrol qmin qmax limiting method
  1999. * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
  2000. * - encoding: Set by user.
  2001. * - decoding: unused
  2002. */
  2003. float rc_qsquish;
  2004. float rc_qmod_amp;
  2005. int rc_qmod_freq;
  2006. /**
  2007. * decoder bitstream buffer size
  2008. * - encoding: Set by user.
  2009. * - decoding: unused
  2010. */
  2011. int rc_buffer_size;
  2012. /**
  2013. * ratecontrol override, see RcOverride
  2014. * - encoding: Allocated/set/freed by user.
  2015. * - decoding: unused
  2016. */
  2017. int rc_override_count;
  2018. RcOverride *rc_override;
  2019. /**
  2020. * rate control equation
  2021. * - encoding: Set by user
  2022. * - decoding: unused
  2023. */
  2024. const char *rc_eq;
  2025. /**
  2026. * maximum bitrate
  2027. * - encoding: Set by user.
  2028. * - decoding: unused
  2029. */
  2030. int rc_max_rate;
  2031. /**
  2032. * minimum bitrate
  2033. * - encoding: Set by user.
  2034. * - decoding: unused
  2035. */
  2036. int rc_min_rate;
  2037. float rc_buffer_aggressivity;
  2038. /**
  2039. * initial complexity for pass1 ratecontrol
  2040. * - encoding: Set by user.
  2041. * - decoding: unused
  2042. */
  2043. float rc_initial_cplx;
  2044. /**
  2045. * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
  2046. * - encoding: Set by user.
  2047. * - decoding: unused.
  2048. */
  2049. float rc_max_available_vbv_use;
  2050. /**
  2051. * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
  2052. * - encoding: Set by user.
  2053. * - decoding: unused.
  2054. */
  2055. float rc_min_vbv_overflow_use;
  2056. /**
  2057. * Number of bits which should be loaded into the rc buffer before decoding starts.
  2058. * - encoding: Set by user.
  2059. * - decoding: unused
  2060. */
  2061. int rc_initial_buffer_occupancy;
  2062. #define FF_CODER_TYPE_VLC 0
  2063. #define FF_CODER_TYPE_AC 1
  2064. #define FF_CODER_TYPE_RAW 2
  2065. #define FF_CODER_TYPE_RLE 3
  2066. #define FF_CODER_TYPE_DEFLATE 4
  2067. /**
  2068. * coder type
  2069. * - encoding: Set by user.
  2070. * - decoding: unused
  2071. */
  2072. int coder_type;
  2073. /**
  2074. * context model
  2075. * - encoding: Set by user.
  2076. * - decoding: unused
  2077. */
  2078. int context_model;
  2079. /**
  2080. * minimum Lagrange multipler
  2081. * - encoding: Set by user.
  2082. * - decoding: unused
  2083. */
  2084. int lmin;
  2085. /**
  2086. * maximum Lagrange multipler
  2087. * - encoding: Set by user.
  2088. * - decoding: unused
  2089. */
  2090. int lmax;
  2091. /**
  2092. * frame skip threshold
  2093. * - encoding: Set by user.
  2094. * - decoding: unused
  2095. */
  2096. int frame_skip_threshold;
  2097. /**
  2098. * frame skip factor
  2099. * - encoding: Set by user.
  2100. * - decoding: unused
  2101. */
  2102. int frame_skip_factor;
  2103. /**
  2104. * frame skip exponent
  2105. * - encoding: Set by user.
  2106. * - decoding: unused
  2107. */
  2108. int frame_skip_exp;
  2109. /**
  2110. * frame skip comparison function
  2111. * - encoding: Set by user.
  2112. * - decoding: unused
  2113. */
  2114. int frame_skip_cmp;
  2115. /**
  2116. * trellis RD quantization
  2117. * - encoding: Set by user.
  2118. * - decoding: unused
  2119. */
  2120. int trellis;
  2121. /**
  2122. * - encoding: Set by user.
  2123. * - decoding: unused
  2124. */
  2125. int min_prediction_order;
  2126. /**
  2127. * - encoding: Set by user.
  2128. * - decoding: unused
  2129. */
  2130. int max_prediction_order;
  2131. /**
  2132. * GOP timecode frame start number
  2133. * - encoding: Set by user, in non drop frame format
  2134. * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
  2135. */
  2136. int64_t timecode_frame_start;
  2137. /* The RTP callback: This function is called */
  2138. /* every time the encoder has a packet to send. */
  2139. /* It depends on the encoder if the data starts */
  2140. /* with a Start Code (it should). H.263 does. */
  2141. /* mb_nb contains the number of macroblocks */
  2142. /* encoded in the RTP payload. */
  2143. void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
  2144. int rtp_payload_size; /* The size of the RTP payload: the coder will */
  2145. /* do its best to deliver a chunk with size */
  2146. /* below rtp_payload_size, the chunk will start */
  2147. /* with a start code on some codecs like H.263. */
  2148. /* This doesn't take account of any particular */
  2149. /* headers inside the transmitted RTP payload. */
  2150. /* statistics, used for 2-pass encoding */
  2151. int mv_bits;
  2152. int header_bits;
  2153. int i_tex_bits;
  2154. int p_tex_bits;
  2155. int i_count;
  2156. int p_count;
  2157. int skip_count;
  2158. int misc_bits;
  2159. /**
  2160. * number of bits used for the previously encoded frame
  2161. * - encoding: Set by libavcodec.
  2162. * - decoding: unused
  2163. */
  2164. int frame_bits;
  2165. /**
  2166. * pass1 encoding statistics output buffer
  2167. * - encoding: Set by libavcodec.
  2168. * - decoding: unused
  2169. */
  2170. char *stats_out;
  2171. /**
  2172. * pass2 encoding statistics input buffer
  2173. * Concatenated stuff from stats_out of pass1 should be placed here.
  2174. * - encoding: Allocated/set/freed by user.
  2175. * - decoding: unused
  2176. */
  2177. char *stats_in;
  2178. /**
  2179. * Work around bugs in encoders which sometimes cannot be detected automatically.
  2180. * - encoding: Set by user
  2181. * - decoding: Set by user
  2182. */
  2183. int workaround_bugs;
  2184. #define FF_BUG_AUTODETECT 1 ///< autodetection
  2185. #define FF_BUG_OLD_MSMPEG4 2
  2186. #define FF_BUG_XVID_ILACE 4
  2187. #define FF_BUG_UMP4 8
  2188. #define FF_BUG_NO_PADDING 16
  2189. #define FF_BUG_AMV 32
  2190. #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
  2191. #define FF_BUG_QPEL_CHROMA 64
  2192. #define FF_BUG_STD_QPEL 128
  2193. #define FF_BUG_QPEL_CHROMA2 256
  2194. #define FF_BUG_DIRECT_BLOCKSIZE 512
  2195. #define FF_BUG_EDGE 1024
  2196. #define FF_BUG_HPEL_CHROMA 2048
  2197. #define FF_BUG_DC_CLIP 4096
  2198. #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
  2199. #define FF_BUG_TRUNCATED 16384
  2200. /**
  2201. * strictly follow the standard (MPEG4, ...).
  2202. * - encoding: Set by user.
  2203. * - decoding: Set by user.
  2204. * Setting this to STRICT or higher means the encoder and decoder will
  2205. * generally do stupid things, whereas setting it to unofficial or lower
  2206. * will mean the encoder might produce output that is not supported by all
  2207. * spec-compliant decoders. Decoders don't differentiate between normal,
  2208. * unofficial and experimental (that is, they always try to decode things
  2209. * when they can) unless they are explicitly asked to behave stupidly
  2210. * (=strictly conform to the specs)
  2211. */
  2212. int strict_std_compliance;
  2213. #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
  2214. #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
  2215. #define FF_COMPLIANCE_NORMAL 0
  2216. #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
  2217. #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
  2218. /**
  2219. * error concealment flags
  2220. * - encoding: unused
  2221. * - decoding: Set by user.
  2222. */
  2223. int error_concealment;
  2224. #define FF_EC_GUESS_MVS 1
  2225. #define FF_EC_DEBLOCK 2
  2226. /**
  2227. * debug
  2228. * - encoding: Set by user.
  2229. * - decoding: Set by user.
  2230. */
  2231. int debug;
  2232. #define FF_DEBUG_PICT_INFO 1
  2233. #define FF_DEBUG_RC 2
  2234. #define FF_DEBUG_BITSTREAM 4
  2235. #define FF_DEBUG_MB_TYPE 8
  2236. #define FF_DEBUG_QP 16
  2237. #define FF_DEBUG_MV 32
  2238. #define FF_DEBUG_DCT_COEFF 0x00000040
  2239. #define FF_DEBUG_SKIP 0x00000080
  2240. #define FF_DEBUG_STARTCODE 0x00000100
  2241. #define FF_DEBUG_PTS 0x00000200
  2242. #define FF_DEBUG_ER 0x00000400
  2243. #define FF_DEBUG_MMCO 0x00000800
  2244. #define FF_DEBUG_BUGS 0x00001000
  2245. #define FF_DEBUG_VIS_QP 0x00002000
  2246. #define FF_DEBUG_VIS_MB_TYPE 0x00004000
  2247. #define FF_DEBUG_BUFFERS 0x00008000
  2248. #define FF_DEBUG_THREADS 0x00010000
  2249. /**
  2250. * debug
  2251. * - encoding: Set by user.
  2252. * - decoding: Set by user.
  2253. */
  2254. int debug_mv;
  2255. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
  2256. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
  2257. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
  2258. /**
  2259. * Error recognition; may misdetect some more or less valid parts as errors.
  2260. * - encoding: unused
  2261. * - decoding: Set by user.
  2262. */
  2263. int err_recognition;
  2264. #define AV_EF_CRCCHECK (1<<0)
  2265. #define AV_EF_BITSTREAM (1<<1)
  2266. #define AV_EF_BUFFER (1<<2)
  2267. #define AV_EF_EXPLODE (1<<3)
  2268. #define AV_EF_CAREFUL (1<<16)
  2269. #define AV_EF_COMPLIANT (1<<17)
  2270. #define AV_EF_AGGRESSIVE (1<<18)
  2271. /**
  2272. * opaque 64bit number (generally a PTS) that will be reordered and
  2273. * output in AVFrame.reordered_opaque
  2274. * @deprecated in favor of pkt_pts
  2275. * - encoding: unused
  2276. * - decoding: Set by user.
  2277. */
  2278. int64_t reordered_opaque;
  2279. /**
  2280. * Hardware accelerator in use
  2281. * - encoding: unused.
  2282. * - decoding: Set by libavcodec
  2283. */
  2284. struct AVHWAccel *hwaccel;
  2285. /**
  2286. * Hardware accelerator context.
  2287. * For some hardware accelerators, a global context needs to be
  2288. * provided by the user. In that case, this holds display-dependent
  2289. * data FFmpeg cannot instantiate itself. Please refer to the
  2290. * FFmpeg HW accelerator documentation to know how to fill this
  2291. * is. e.g. for VA API, this is a struct vaapi_context.
  2292. * - encoding: unused
  2293. * - decoding: Set by user
  2294. */
  2295. void *hwaccel_context;
  2296. /**
  2297. * error
  2298. * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
  2299. * - decoding: unused
  2300. */
  2301. uint64_t error[AV_NUM_DATA_POINTERS];
  2302. /**
  2303. * DCT algorithm, see FF_DCT_* below
  2304. * - encoding: Set by user.
  2305. * - decoding: unused
  2306. */
  2307. int dct_algo;
  2308. #define FF_DCT_AUTO 0
  2309. #define FF_DCT_FASTINT 1
  2310. #define FF_DCT_INT 2
  2311. #define FF_DCT_MMX 3
  2312. #define FF_DCT_ALTIVEC 5
  2313. #define FF_DCT_FAAN 6
  2314. /**
  2315. * IDCT algorithm, see FF_IDCT_* below.
  2316. * - encoding: Set by user.
  2317. * - decoding: Set by user.
  2318. */
  2319. int idct_algo;
  2320. #define FF_IDCT_AUTO 0
  2321. #define FF_IDCT_INT 1
  2322. #define FF_IDCT_SIMPLE 2
  2323. #define FF_IDCT_SIMPLEMMX 3
  2324. #define FF_IDCT_LIBMPEG2MMX 4
  2325. #define FF_IDCT_MMI 5
  2326. #define FF_IDCT_ARM 7
  2327. #define FF_IDCT_ALTIVEC 8
  2328. #define FF_IDCT_SH4 9
  2329. #define FF_IDCT_SIMPLEARM 10
  2330. #define FF_IDCT_H264 11
  2331. #define FF_IDCT_VP3 12
  2332. #define FF_IDCT_IPP 13
  2333. #define FF_IDCT_XVIDMMX 14
  2334. #define FF_IDCT_CAVS 15
  2335. #define FF_IDCT_SIMPLEARMV5TE 16
  2336. #define FF_IDCT_SIMPLEARMV6 17
  2337. #define FF_IDCT_SIMPLEVIS 18
  2338. #define FF_IDCT_WMV2 19
  2339. #define FF_IDCT_FAAN 20
  2340. #define FF_IDCT_EA 21
  2341. #define FF_IDCT_SIMPLENEON 22
  2342. #define FF_IDCT_SIMPLEALPHA 23
  2343. #define FF_IDCT_BINK 24
  2344. /**
  2345. * dsp_mask could be add used to disable unwanted CPU features
  2346. * CPU features (i.e. MMX, SSE. ...)
  2347. *
  2348. * With the FORCE flag you may instead enable given CPU features.
  2349. * (Dangerous: Usable in case of misdetection, improper usage however will
  2350. * result into program crash.)
  2351. */
  2352. unsigned dsp_mask;
  2353. /**
  2354. * bits per sample/pixel from the demuxer (needed for huffyuv).
  2355. * - encoding: Set by libavcodec.
  2356. * - decoding: Set by user.
  2357. */
  2358. int bits_per_coded_sample;
  2359. /**
  2360. * Bits per sample/pixel of internal libavcodec pixel/sample format.
  2361. * - encoding: set by user.
  2362. * - decoding: set by libavcodec.
  2363. */
  2364. int bits_per_raw_sample;
  2365. /**
  2366. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  2367. * - encoding: unused
  2368. * - decoding: Set by user.
  2369. */
  2370. int lowres;
  2371. /**
  2372. * the picture in the bitstream
  2373. * - encoding: Set by libavcodec.
  2374. * - decoding: Set by libavcodec.
  2375. */
  2376. AVFrame *coded_frame;
  2377. /**
  2378. * thread count
  2379. * is used to decide how many independent tasks should be passed to execute()
  2380. * - encoding: Set by user.
  2381. * - decoding: Set by user.
  2382. */
  2383. int thread_count;
  2384. /**
  2385. * Which multithreading methods to use.
  2386. * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
  2387. * so clients which cannot provide future frames should not use it.
  2388. *
  2389. * - encoding: Set by user, otherwise the default is used.
  2390. * - decoding: Set by user, otherwise the default is used.
  2391. */
  2392. int thread_type;
  2393. #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
  2394. #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
  2395. /**
  2396. * Which multithreading methods are in use by the codec.
  2397. * - encoding: Set by libavcodec.
  2398. * - decoding: Set by libavcodec.
  2399. */
  2400. int active_thread_type;
  2401. /**
  2402. * Set by the client if its custom get_buffer() callback can be called
  2403. * from another thread, which allows faster multithreaded decoding.
  2404. * draw_horiz_band() will be called from other threads regardless of this setting.
  2405. * Ignored if the default get_buffer() is used.
  2406. * - encoding: Set by user.
  2407. * - decoding: Set by user.
  2408. */
  2409. int thread_safe_callbacks;
  2410. /**
  2411. * The codec may call this to execute several independent things.
  2412. * It will return only after finishing all tasks.
  2413. * The user may replace this with some multithreaded implementation,
  2414. * the default implementation will execute the parts serially.
  2415. * @param count the number of things to execute
  2416. * - encoding: Set by libavcodec, user can override.
  2417. * - decoding: Set by libavcodec, user can override.
  2418. */
  2419. int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
  2420. /**
  2421. * The codec may call this to execute several independent things.
  2422. * It will return only after finishing all tasks.
  2423. * The user may replace this with some multithreaded implementation,
  2424. * the default implementation will execute the parts serially.
  2425. * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
  2426. * @param c context passed also to func
  2427. * @param count the number of things to execute
  2428. * @param arg2 argument passed unchanged to func
  2429. * @param ret return values of executed functions, must have space for "count" values. May be NULL.
  2430. * @param func function that will be called count times, with jobnr from 0 to count-1.
  2431. * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
  2432. * two instances of func executing at the same time will have the same threadnr.
  2433. * @return always 0 currently, but code should handle a future improvement where when any call to func
  2434. * returns < 0 no further calls to func may be done and < 0 is returned.
  2435. * - encoding: Set by libavcodec, user can override.
  2436. * - decoding: Set by libavcodec, user can override.
  2437. */
  2438. int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
  2439. /**
  2440. * thread opaque
  2441. * Can be used by execute() to store some per AVCodecContext stuff.
  2442. * - encoding: set by execute()
  2443. * - decoding: set by execute()
  2444. */
  2445. void *thread_opaque;
  2446. /**
  2447. * noise vs. sse weight for the nsse comparsion function
  2448. * - encoding: Set by user.
  2449. * - decoding: unused
  2450. */
  2451. int nsse_weight;
  2452. /**
  2453. * profile
  2454. * - encoding: Set by user.
  2455. * - decoding: Set by libavcodec.
  2456. */
  2457. int profile;
  2458. #define FF_PROFILE_UNKNOWN -99
  2459. #define FF_PROFILE_RESERVED -100
  2460. #define FF_PROFILE_AAC_MAIN 0
  2461. #define FF_PROFILE_AAC_LOW 1
  2462. #define FF_PROFILE_AAC_SSR 2
  2463. #define FF_PROFILE_AAC_LTP 3
  2464. #define FF_PROFILE_DTS 20
  2465. #define FF_PROFILE_DTS_ES 30
  2466. #define FF_PROFILE_DTS_96_24 40
  2467. #define FF_PROFILE_DTS_HD_HRA 50
  2468. #define FF_PROFILE_DTS_HD_MA 60
  2469. #define FF_PROFILE_MPEG2_422 0
  2470. #define FF_PROFILE_MPEG2_HIGH 1
  2471. #define FF_PROFILE_MPEG2_SS 2
  2472. #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
  2473. #define FF_PROFILE_MPEG2_MAIN 4
  2474. #define FF_PROFILE_MPEG2_SIMPLE 5
  2475. #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
  2476. #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
  2477. #define FF_PROFILE_H264_BASELINE 66
  2478. #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
  2479. #define FF_PROFILE_H264_MAIN 77
  2480. #define FF_PROFILE_H264_EXTENDED 88
  2481. #define FF_PROFILE_H264_HIGH 100
  2482. #define FF_PROFILE_H264_HIGH_10 110
  2483. #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
  2484. #define FF_PROFILE_H264_HIGH_422 122
  2485. #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
  2486. #define FF_PROFILE_H264_HIGH_444 144
  2487. #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
  2488. #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
  2489. #define FF_PROFILE_H264_CAVLC_444 44
  2490. #define FF_PROFILE_VC1_SIMPLE 0
  2491. #define FF_PROFILE_VC1_MAIN 1
  2492. #define FF_PROFILE_VC1_COMPLEX 2
  2493. #define FF_PROFILE_VC1_ADVANCED 3
  2494. #define FF_PROFILE_MPEG4_SIMPLE 0
  2495. #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
  2496. #define FF_PROFILE_MPEG4_CORE 2
  2497. #define FF_PROFILE_MPEG4_MAIN 3
  2498. #define FF_PROFILE_MPEG4_N_BIT 4
  2499. #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
  2500. #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
  2501. #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
  2502. #define FF_PROFILE_MPEG4_HYBRID 8
  2503. #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
  2504. #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
  2505. #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
  2506. #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
  2507. #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
  2508. #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
  2509. #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
  2510. /**
  2511. * level
  2512. * - encoding: Set by user.
  2513. * - decoding: Set by libavcodec.
  2514. */
  2515. int level;
  2516. #define FF_LEVEL_UNKNOWN -99
  2517. /**
  2518. *
  2519. * - encoding: unused
  2520. * - decoding: Set by user.
  2521. */
  2522. enum AVDiscard skip_loop_filter;
  2523. /**
  2524. *
  2525. * - encoding: unused
  2526. * - decoding: Set by user.
  2527. */
  2528. enum AVDiscard skip_idct;
  2529. /**
  2530. *
  2531. * - encoding: unused
  2532. * - decoding: Set by user.
  2533. */
  2534. enum AVDiscard skip_frame;
  2535. /**
  2536. * Header containing style information for text subtitles.
  2537. * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
  2538. * [Script Info] and [V4+ Styles] section, plus the [Events] line and
  2539. * the Format line following. It shouldn't include any Dialogue line.
  2540. * - encoding: Set/allocated/freed by user (before avcodec_open2())
  2541. * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
  2542. */
  2543. uint8_t *subtitle_header;
  2544. int subtitle_header_size;
  2545. /**
  2546. * Simulates errors in the bitstream to test error concealment.
  2547. * - encoding: Set by user.
  2548. * - decoding: unused
  2549. */
  2550. int error_rate;
  2551. /**
  2552. * Current packet as passed into the decoder, to avoid having
  2553. * to pass the packet into every function. Currently only valid
  2554. * inside lavc and get/release_buffer callbacks.
  2555. * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
  2556. * - encoding: unused
  2557. */
  2558. AVPacket *pkt;
  2559. /**
  2560. * VBV delay coded in the last frame (in periods of a 27 MHz clock).
  2561. * Used for compliant TS muxing.
  2562. * - encoding: Set by libavcodec.
  2563. * - decoding: unused.
  2564. */
  2565. uint64_t vbv_delay;
  2566. /**
  2567. * Current statistics for PTS correction.
  2568. * - decoding: maintained and used by libavcodec, not intended to be used by user apps
  2569. * - encoding: unused
  2570. */
  2571. int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
  2572. int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
  2573. int64_t pts_correction_last_pts; /// PTS of the last frame
  2574. int64_t pts_correction_last_dts; /// DTS of the last frame
  2575. } AVCodecContext;
  2576. /**
  2577. * AVProfile.
  2578. */
  2579. typedef struct AVProfile {
  2580. int profile;
  2581. const char *name; ///< short name for the profile
  2582. } AVProfile;
  2583. typedef struct AVCodecDefault AVCodecDefault;
  2584. /**
  2585. * AVCodec.
  2586. */
  2587. typedef struct AVCodec {
  2588. /**
  2589. * Name of the codec implementation.
  2590. * The name is globally unique among encoders and among decoders (but an
  2591. * encoder and a decoder can share the same name).
  2592. * This is the primary way to find a codec from the user perspective.
  2593. */
  2594. const char *name;
  2595. /**
  2596. * Descriptive name for the codec, meant to be more human readable than name.
  2597. * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
  2598. */
  2599. const char *long_name;
  2600. enum AVMediaType type;
  2601. enum CodecID id;
  2602. /**
  2603. * Codec capabilities.
  2604. * see CODEC_CAP_*
  2605. */
  2606. int capabilities;
  2607. const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
  2608. const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
  2609. const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
  2610. const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
  2611. const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
  2612. uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
  2613. const AVClass *priv_class; ///< AVClass for the private context
  2614. const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
  2615. /*****************************************************************
  2616. * No fields below this line are part of the public API. They
  2617. * may not be used outside of libavcodec and can be changed and
  2618. * removed at will.
  2619. * New public fields should be added right above.
  2620. *****************************************************************
  2621. */
  2622. int priv_data_size;
  2623. struct AVCodec *next;
  2624. /**
  2625. * @name Frame-level threading support functions
  2626. * @{
  2627. */
  2628. /**
  2629. * If defined, called on thread contexts when they are created.
  2630. * If the codec allocates writable tables in init(), re-allocate them here.
  2631. * priv_data will be set to a copy of the original.
  2632. */
  2633. int (*init_thread_copy)(AVCodecContext *);
  2634. /**
  2635. * Copy necessary context variables from a previous thread context to the current one.
  2636. * If not defined, the next thread will start automatically; otherwise, the codec
  2637. * must call ff_thread_finish_setup().
  2638. *
  2639. * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
  2640. */
  2641. int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
  2642. /** @} */
  2643. /**
  2644. * Private codec-specific defaults.
  2645. */
  2646. const AVCodecDefault *defaults;
  2647. /**
  2648. * Initialize codec static data, called from avcodec_register().
  2649. */
  2650. void (*init_static_data)(struct AVCodec *codec);
  2651. int (*init)(AVCodecContext *);
  2652. int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
  2653. /**
  2654. * Encode data to an AVPacket.
  2655. *
  2656. * @param avctx codec context
  2657. * @param avpkt output AVPacket (may contain a user-provided buffer)
  2658. * @param[in] frame AVFrame containing the raw data to be encoded
  2659. * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
  2660. * non-empty packet was returned in avpkt.
  2661. * @return 0 on success, negative error code on failure
  2662. */
  2663. int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
  2664. int *got_packet_ptr);
  2665. int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
  2666. int (*close)(AVCodecContext *);
  2667. /**
  2668. * Flush buffers.
  2669. * Will be called when seeking
  2670. */
  2671. void (*flush)(AVCodecContext *);
  2672. } AVCodec;
  2673. /**
  2674. * AVHWAccel.
  2675. */
  2676. typedef struct AVHWAccel {
  2677. /**
  2678. * Name of the hardware accelerated codec.
  2679. * The name is globally unique among encoders and among decoders (but an
  2680. * encoder and a decoder can share the same name).
  2681. */
  2682. const char *name;
  2683. /**
  2684. * Type of codec implemented by the hardware accelerator.
  2685. *
  2686. * See AVMEDIA_TYPE_xxx
  2687. */
  2688. enum AVMediaType type;
  2689. /**
  2690. * Codec implemented by the hardware accelerator.
  2691. *
  2692. * See CODEC_ID_xxx
  2693. */
  2694. enum CodecID id;
  2695. /**
  2696. * Supported pixel format.
  2697. *
  2698. * Only hardware accelerated formats are supported here.
  2699. */
  2700. enum PixelFormat pix_fmt;
  2701. /**
  2702. * Hardware accelerated codec capabilities.
  2703. * see FF_HWACCEL_CODEC_CAP_*
  2704. */
  2705. int capabilities;
  2706. struct AVHWAccel *next;
  2707. /**
  2708. * Called at the beginning of each frame or field picture.
  2709. *
  2710. * Meaningful frame information (codec specific) is guaranteed to
  2711. * be parsed at this point. This function is mandatory.
  2712. *
  2713. * Note that buf can be NULL along with buf_size set to 0.
  2714. * Otherwise, this means the whole frame is available at this point.
  2715. *
  2716. * @param avctx the codec context
  2717. * @param buf the frame data buffer base
  2718. * @param buf_size the size of the frame in bytes
  2719. * @return zero if successful, a negative value otherwise
  2720. */
  2721. int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  2722. /**
  2723. * Callback for each slice.
  2724. *
  2725. * Meaningful slice information (codec specific) is guaranteed to
  2726. * be parsed at this point. This function is mandatory.
  2727. *
  2728. * @param avctx the codec context
  2729. * @param buf the slice data buffer base
  2730. * @param buf_size the size of the slice in bytes
  2731. * @return zero if successful, a negative value otherwise
  2732. */
  2733. int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  2734. /**
  2735. * Called at the end of each frame or field picture.
  2736. *
  2737. * The whole picture is parsed at this point and can now be sent
  2738. * to the hardware accelerator. This function is mandatory.
  2739. *
  2740. * @param avctx the codec context
  2741. * @return zero if successful, a negative value otherwise
  2742. */
  2743. int (*end_frame)(AVCodecContext *avctx);
  2744. /**
  2745. * Size of HW accelerator private data.
  2746. *
  2747. * Private data is allocated with av_mallocz() before
  2748. * AVCodecContext.get_buffer() and deallocated after
  2749. * AVCodecContext.release_buffer().
  2750. */
  2751. int priv_data_size;
  2752. } AVHWAccel;
  2753. /**
  2754. * four components are given, that's all.
  2755. * the last component is alpha
  2756. */
  2757. typedef struct AVPicture {
  2758. uint8_t *data[AV_NUM_DATA_POINTERS];
  2759. int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
  2760. } AVPicture;
  2761. #define AVPALETTE_SIZE 1024
  2762. #define AVPALETTE_COUNT 256
  2763. enum AVSubtitleType {
  2764. SUBTITLE_NONE,
  2765. SUBTITLE_BITMAP, ///< A bitmap, pict will be set
  2766. /**
  2767. * Plain text, the text field must be set by the decoder and is
  2768. * authoritative. ass and pict fields may contain approximations.
  2769. */
  2770. SUBTITLE_TEXT,
  2771. /**
  2772. * Formatted text, the ass field must be set by the decoder and is
  2773. * authoritative. pict and text fields may contain approximations.
  2774. */
  2775. SUBTITLE_ASS,
  2776. };
  2777. typedef struct AVSubtitleRect {
  2778. int x; ///< top left corner of pict, undefined when pict is not set
  2779. int y; ///< top left corner of pict, undefined when pict is not set
  2780. int w; ///< width of pict, undefined when pict is not set
  2781. int h; ///< height of pict, undefined when pict is not set
  2782. int nb_colors; ///< number of colors in pict, undefined when pict is not set
  2783. /**
  2784. * data+linesize for the bitmap of this subtitle.
  2785. * can be set for text/ass as well once they where rendered
  2786. */
  2787. AVPicture pict;
  2788. enum AVSubtitleType type;
  2789. char *text; ///< 0 terminated plain UTF-8 text
  2790. /**
  2791. * 0 terminated ASS/SSA compatible event line.
  2792. * The pressentation of this is unaffected by the other values in this
  2793. * struct.
  2794. */
  2795. char *ass;
  2796. } AVSubtitleRect;
  2797. typedef struct AVSubtitle {
  2798. uint16_t format; /* 0 = graphics */
  2799. uint32_t start_display_time; /* relative to packet pts, in ms */
  2800. uint32_t end_display_time; /* relative to packet pts, in ms */
  2801. unsigned num_rects;
  2802. AVSubtitleRect **rects;
  2803. int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
  2804. } AVSubtitle;
  2805. /* packet functions */
  2806. /**
  2807. * @deprecated use NULL instead
  2808. */
  2809. attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
  2810. /**
  2811. * Default packet destructor.
  2812. */
  2813. void av_destruct_packet(AVPacket *pkt);
  2814. /**
  2815. * Initialize optional fields of a packet with default values.
  2816. *
  2817. * @param pkt packet
  2818. */
  2819. void av_init_packet(AVPacket *pkt);
  2820. /**
  2821. * Allocate the payload of a packet and initialize its fields with
  2822. * default values.
  2823. *
  2824. * @param pkt packet
  2825. * @param size wanted payload size
  2826. * @return 0 if OK, AVERROR_xxx otherwise
  2827. */
  2828. int av_new_packet(AVPacket *pkt, int size);
  2829. /**
  2830. * Reduce packet size, correctly zeroing padding
  2831. *
  2832. * @param pkt packet
  2833. * @param size new size
  2834. */
  2835. void av_shrink_packet(AVPacket *pkt, int size);
  2836. /**
  2837. * Increase packet size, correctly zeroing padding
  2838. *
  2839. * @param pkt packet
  2840. * @param grow_by number of bytes by which to increase the size of the packet
  2841. */
  2842. int av_grow_packet(AVPacket *pkt, int grow_by);
  2843. /**
  2844. * @warning This is a hack - the packet memory allocation stuff is broken. The
  2845. * packet is allocated if it was not really allocated.
  2846. */
  2847. int av_dup_packet(AVPacket *pkt);
  2848. /**
  2849. * Free a packet.
  2850. *
  2851. * @param pkt packet to free
  2852. */
  2853. void av_free_packet(AVPacket *pkt);
  2854. /**
  2855. * Allocate new information of a packet.
  2856. *
  2857. * @param pkt packet
  2858. * @param type side information type
  2859. * @param size side information size
  2860. * @return pointer to fresh allocated data or NULL otherwise
  2861. */
  2862. uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  2863. int size);
  2864. /**
  2865. * Shrink the already allocated side data buffer
  2866. *
  2867. * @param pkt packet
  2868. * @param type side information type
  2869. * @param size new side information size
  2870. * @return 0 on success, < 0 on failure
  2871. */
  2872. int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  2873. int size);
  2874. /**
  2875. * Get side information from packet.
  2876. *
  2877. * @param pkt packet
  2878. * @param type desired side information type
  2879. * @param size pointer for side information size to store (optional)
  2880. * @return pointer to data if present or NULL otherwise
  2881. */
  2882. uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  2883. int *size);
  2884. int av_packet_merge_side_data(AVPacket *pkt);
  2885. int av_packet_split_side_data(AVPacket *pkt);
  2886. /* resample.c */
  2887. struct ReSampleContext;
  2888. struct AVResampleContext;
  2889. typedef struct ReSampleContext ReSampleContext;
  2890. /**
  2891. * Initialize audio resampling context.
  2892. *
  2893. * @param output_channels number of output channels
  2894. * @param input_channels number of input channels
  2895. * @param output_rate output sample rate
  2896. * @param input_rate input sample rate
  2897. * @param sample_fmt_out requested output sample format
  2898. * @param sample_fmt_in input sample format
  2899. * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
  2900. * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  2901. * @param linear if 1 then the used FIR filter will be linearly interpolated
  2902. between the 2 closest, if 0 the closest will be used
  2903. * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
  2904. * @return allocated ReSampleContext, NULL if error occurred
  2905. */
  2906. ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
  2907. int output_rate, int input_rate,
  2908. enum AVSampleFormat sample_fmt_out,
  2909. enum AVSampleFormat sample_fmt_in,
  2910. int filter_length, int log2_phase_count,
  2911. int linear, double cutoff);
  2912. int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
  2913. /**
  2914. * Free resample context.
  2915. *
  2916. * @param s a non-NULL pointer to a resample context previously
  2917. * created with av_audio_resample_init()
  2918. */
  2919. void audio_resample_close(ReSampleContext *s);
  2920. /**
  2921. * Initialize an audio resampler.
  2922. * Note, if either rate is not an integer then simply scale both rates up so they are.
  2923. * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
  2924. * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  2925. * @param linear If 1 then the used FIR filter will be linearly interpolated
  2926. between the 2 closest, if 0 the closest will be used
  2927. * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
  2928. */
  2929. struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
  2930. /**
  2931. * Resample an array of samples using a previously configured context.
  2932. * @param src an array of unconsumed samples
  2933. * @param consumed the number of samples of src which have been consumed are returned here
  2934. * @param src_size the number of unconsumed samples available
  2935. * @param dst_size the amount of space in samples available in dst
  2936. * @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.
  2937. * @return the number of samples written in dst or -1 if an error occurred
  2938. */
  2939. int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
  2940. /**
  2941. * Compensate samplerate/timestamp drift. The compensation is done by changing
  2942. * the resampler parameters, so no audible clicks or similar distortions occur
  2943. * @param compensation_distance distance in output samples over which the compensation should be performed
  2944. * @param sample_delta number of output samples which should be output less
  2945. *
  2946. * example: av_resample_compensate(c, 10, 500)
  2947. * here instead of 510 samples only 500 samples would be output
  2948. *
  2949. * note, due to rounding the actual compensation might be slightly different,
  2950. * especially if the compensation_distance is large and the in_rate used during init is small
  2951. */
  2952. void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
  2953. void av_resample_close(struct AVResampleContext *c);
  2954. /**
  2955. * Allocate memory for a picture. Call avpicture_free() to free it.
  2956. *
  2957. * @see avpicture_fill()
  2958. *
  2959. * @param picture the picture to be filled in
  2960. * @param pix_fmt the format of the picture
  2961. * @param width the width of the picture
  2962. * @param height the height of the picture
  2963. * @return zero if successful, a negative value if not
  2964. */
  2965. int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
  2966. /**
  2967. * Free a picture previously allocated by avpicture_alloc().
  2968. * The data buffer used by the AVPicture is freed, but the AVPicture structure
  2969. * itself is not.
  2970. *
  2971. * @param picture the AVPicture to be freed
  2972. */
  2973. void avpicture_free(AVPicture *picture);
  2974. /**
  2975. * Fill in the AVPicture fields.
  2976. * The fields of the given AVPicture are filled in by using the 'ptr' address
  2977. * which points to the image data buffer. Depending on the specified picture
  2978. * format, one or multiple image data pointers and line sizes will be set.
  2979. * If a planar format is specified, several pointers will be set pointing to
  2980. * the different picture planes and the line sizes of the different planes
  2981. * will be stored in the lines_sizes array.
  2982. * Call with ptr == NULL to get the required size for the ptr buffer.
  2983. *
  2984. * To allocate the buffer and fill in the AVPicture fields in one call,
  2985. * use avpicture_alloc().
  2986. *
  2987. * @param picture AVPicture whose fields are to be filled in
  2988. * @param ptr Buffer which will contain or contains the actual image data
  2989. * @param pix_fmt The format in which the picture data is stored.
  2990. * @param width the width of the image in pixels
  2991. * @param height the height of the image in pixels
  2992. * @return size of the image data in bytes
  2993. */
  2994. int avpicture_fill(AVPicture *picture, uint8_t *ptr,
  2995. enum PixelFormat pix_fmt, int width, int height);
  2996. /**
  2997. * Copy pixel data from an AVPicture into a buffer.
  2998. * The data is stored compactly, without any gaps for alignment or padding
  2999. * which may be applied by avpicture_fill().
  3000. *
  3001. * @see avpicture_get_size()
  3002. *
  3003. * @param[in] src AVPicture containing image data
  3004. * @param[in] pix_fmt The format in which the picture data is stored.
  3005. * @param[in] width the width of the image in pixels.
  3006. * @param[in] height the height of the image in pixels.
  3007. * @param[out] dest A buffer into which picture data will be copied.
  3008. * @param[in] dest_size The size of 'dest'.
  3009. * @return The number of bytes written to dest, or a negative value (error code) on error.
  3010. */
  3011. int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
  3012. unsigned char *dest, int dest_size);
  3013. /**
  3014. * Calculate the size in bytes that a picture of the given width and height
  3015. * would occupy if stored in the given picture format.
  3016. * Note that this returns the size of a compact representation as generated
  3017. * by avpicture_layout(), which can be smaller than the size required for e.g.
  3018. * avpicture_fill().
  3019. *
  3020. * @param pix_fmt the given picture format
  3021. * @param width the width of the image
  3022. * @param height the height of the image
  3023. * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
  3024. */
  3025. int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
  3026. void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
  3027. /**
  3028. * Get the name of a codec.
  3029. * @return a static string identifying the codec; never NULL
  3030. */
  3031. const char *avcodec_get_name(enum CodecID id);
  3032. void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
  3033. /**
  3034. * Return a value representing the fourCC code associated to the
  3035. * pixel format pix_fmt, or 0 if no associated fourCC code can be
  3036. * found.
  3037. */
  3038. unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
  3039. /**
  3040. * Put a string representing the codec tag codec_tag in buf.
  3041. *
  3042. * @param buf_size size in bytes of buf
  3043. * @return the length of the string that would have been generated if
  3044. * enough space had been available, excluding the trailing null
  3045. */
  3046. size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
  3047. #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
  3048. #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
  3049. #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
  3050. #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
  3051. #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
  3052. #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
  3053. /**
  3054. * Compute what kind of losses will occur when converting from one specific
  3055. * pixel format to another.
  3056. * When converting from one pixel format to another, information loss may occur.
  3057. * For example, when converting from RGB24 to GRAY, the color information will
  3058. * be lost. Similarly, other losses occur when converting from some formats to
  3059. * other formats. These losses can involve loss of chroma, but also loss of
  3060. * resolution, loss of color depth, loss due to the color space conversion, loss
  3061. * of the alpha bits or loss due to color quantization.
  3062. * avcodec_get_fix_fmt_loss() informs you about the various types of losses
  3063. * which will occur when converting from one pixel format to another.
  3064. *
  3065. * @param[in] dst_pix_fmt destination pixel format
  3066. * @param[in] src_pix_fmt source pixel format
  3067. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  3068. * @return Combination of flags informing you what kind of losses will occur
  3069. * (maximum loss for an invalid dst_pix_fmt).
  3070. */
  3071. int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
  3072. int has_alpha);
  3073. /**
  3074. * Find the best pixel format to convert to given a certain source pixel
  3075. * format. When converting from one pixel format to another, information loss
  3076. * may occur. For example, when converting from RGB24 to GRAY, the color
  3077. * information will be lost. Similarly, other losses occur when converting from
  3078. * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
  3079. * the given pixel formats should be used to suffer the least amount of loss.
  3080. * The pixel formats from which it chooses one, are determined by the
  3081. * pix_fmt_mask parameter.
  3082. *
  3083. * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
  3084. *
  3085. * @code
  3086. * src_pix_fmt = PIX_FMT_YUV420P;
  3087. * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
  3088. * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
  3089. * @endcode
  3090. *
  3091. * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
  3092. * @param[in] src_pix_fmt source pixel format
  3093. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  3094. * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  3095. * @return The best pixel format to convert to or -1 if none was found.
  3096. */
  3097. enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
  3098. int has_alpha, int *loss_ptr);
  3099. /**
  3100. * Find the best pixel format to convert to given a certain source pixel
  3101. * format and a selection of two destination pixel formats. When converting from
  3102. * one pixel format to another, information loss may occur. For example, when converting
  3103. * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
  3104. * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
  3105. * the given pixel formats should be used to suffer the least amount of loss.
  3106. *
  3107. * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
  3108. * returned.
  3109. *
  3110. * @code
  3111. * src_pix_fmt = PIX_FMT_YUV420P;
  3112. * dst_pix_fmt1= PIX_FMT_RGB24;
  3113. * dst_pix_fmt2= PIX_FMT_GRAY8;
  3114. * dst_pix_fmt3= PIX_FMT_RGB8;
  3115. * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
  3116. * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
  3117. * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
  3118. * @endcode
  3119. *
  3120. * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
  3121. * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
  3122. * @param[in] src_pix_fmt Source pixel format
  3123. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  3124. * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
  3125. * NULL or value of zero means we care about all losses. Out: the loss
  3126. * that occurs when converting from src to selected dst pixel format.
  3127. * @return The best pixel format to convert to or -1 if none was found.
  3128. */
  3129. enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
  3130. enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
  3131. /* deinterlace a picture */
  3132. /* deinterlace - if not supported return -1 */
  3133. int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
  3134. enum PixelFormat pix_fmt, int width, int height);
  3135. /* external high level API */
  3136. /**
  3137. * If c is NULL, returns the first registered codec,
  3138. * if c is non-NULL, returns the next registered codec after c,
  3139. * or NULL if c is the last one.
  3140. */
  3141. AVCodec *av_codec_next(AVCodec *c);
  3142. /**
  3143. * Return the LIBAVCODEC_VERSION_INT constant.
  3144. */
  3145. unsigned avcodec_version(void);
  3146. /**
  3147. * Return the libavcodec build-time configuration.
  3148. */
  3149. const char *avcodec_configuration(void);
  3150. /**
  3151. * Return the libavcodec license.
  3152. */
  3153. const char *avcodec_license(void);
  3154. /**
  3155. * Register the codec codec and initialize libavcodec.
  3156. *
  3157. * @warning either this function or avcodec_register_all() must be called
  3158. * before any other libavcodec functions.
  3159. *
  3160. * @see avcodec_register_all()
  3161. */
  3162. void avcodec_register(AVCodec *codec);
  3163. /**
  3164. * Find a registered encoder with a matching codec ID.
  3165. *
  3166. * @param id CodecID of the requested encoder
  3167. * @return An encoder if one was found, NULL otherwise.
  3168. */
  3169. AVCodec *avcodec_find_encoder(enum CodecID id);
  3170. /**
  3171. * Find a registered encoder with the specified name.
  3172. *
  3173. * @param name name of the requested encoder
  3174. * @return An encoder if one was found, NULL otherwise.
  3175. */
  3176. AVCodec *avcodec_find_encoder_by_name(const char *name);
  3177. /**
  3178. * Find a registered decoder with a matching codec ID.
  3179. *
  3180. * @param id CodecID of the requested decoder
  3181. * @return A decoder if one was found, NULL otherwise.
  3182. */
  3183. AVCodec *avcodec_find_decoder(enum CodecID id);
  3184. /**
  3185. * Find a registered decoder with the specified name.
  3186. *
  3187. * @param name name of the requested decoder
  3188. * @return A decoder if one was found, NULL otherwise.
  3189. */
  3190. AVCodec *avcodec_find_decoder_by_name(const char *name);
  3191. void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
  3192. /**
  3193. * Return a name for the specified profile, if available.
  3194. *
  3195. * @param codec the codec that is searched for the given profile
  3196. * @param profile the profile value for which a name is requested
  3197. * @return A name for the profile if found, NULL otherwise.
  3198. */
  3199. const char *av_get_profile_name(const AVCodec *codec, int profile);
  3200. #if FF_API_ALLOC_CONTEXT
  3201. /**
  3202. * Set the fields of the given AVCodecContext to default values.
  3203. *
  3204. * @param s The AVCodecContext of which the fields should be set to default values.
  3205. * @deprecated use avcodec_get_context_defaults3
  3206. */
  3207. attribute_deprecated
  3208. void avcodec_get_context_defaults(AVCodecContext *s);
  3209. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  3210. * we WILL change its arguments and name a few times! */
  3211. attribute_deprecated
  3212. void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
  3213. #endif
  3214. /**
  3215. * Set the fields of the given AVCodecContext to default values corresponding
  3216. * to the given codec (defaults may be codec-dependent).
  3217. *
  3218. * Do not call this function if a non-NULL codec has been passed
  3219. * to avcodec_alloc_context3() that allocated this AVCodecContext.
  3220. * If codec is non-NULL, it is illegal to call avcodec_open2() with a
  3221. * different codec on this AVCodecContext.
  3222. */
  3223. int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
  3224. #if FF_API_ALLOC_CONTEXT
  3225. /**
  3226. * Allocate an AVCodecContext and set its fields to default values. The
  3227. * resulting struct can be deallocated by simply calling av_free().
  3228. *
  3229. * @return An AVCodecContext filled with default values or NULL on failure.
  3230. * @see avcodec_get_context_defaults
  3231. *
  3232. * @deprecated use avcodec_alloc_context3()
  3233. */
  3234. attribute_deprecated
  3235. AVCodecContext *avcodec_alloc_context(void);
  3236. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  3237. * we WILL change its arguments and name a few times! */
  3238. attribute_deprecated
  3239. AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
  3240. #endif
  3241. /**
  3242. * Allocate an AVCodecContext and set its fields to default values. The
  3243. * resulting struct can be deallocated by calling avcodec_close() on it followed
  3244. * by av_free().
  3245. *
  3246. * @param codec if non-NULL, allocate private data and initialize defaults
  3247. * for the given codec. It is illegal to then call avcodec_open2()
  3248. * with a different codec.
  3249. * If NULL, then the codec-specific defaults won't be initialized,
  3250. * which may result in suboptimal default settings (this is
  3251. * important mainly for encoders, e.g. libx264).
  3252. *
  3253. * @return An AVCodecContext filled with default values or NULL on failure.
  3254. * @see avcodec_get_context_defaults
  3255. */
  3256. AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
  3257. /**
  3258. * Copy the settings of the source AVCodecContext into the destination
  3259. * AVCodecContext. The resulting destination codec context will be
  3260. * unopened, i.e. you are required to call avcodec_open2() before you
  3261. * can use this AVCodecContext to decode/encode video/audio data.
  3262. *
  3263. * @param dest target codec context, should be initialized with
  3264. * avcodec_alloc_context3(), but otherwise uninitialized
  3265. * @param src source codec context
  3266. * @return AVERROR() on error (e.g. memory allocation error), 0 on success
  3267. */
  3268. int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
  3269. /**
  3270. * Set the fields of the given AVFrame to default values.
  3271. *
  3272. * @param pic The AVFrame of which the fields should be set to default values.
  3273. */
  3274. void avcodec_get_frame_defaults(AVFrame *pic);
  3275. /**
  3276. * Allocate an AVFrame and set its fields to default values. The resulting
  3277. * struct can be deallocated by simply calling av_free().
  3278. *
  3279. * @return An AVFrame filled with default values or NULL on failure.
  3280. * @see avcodec_get_frame_defaults
  3281. */
  3282. AVFrame *avcodec_alloc_frame(void);
  3283. int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
  3284. void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
  3285. int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
  3286. /**
  3287. * Return the amount of padding in pixels which the get_buffer callback must
  3288. * provide around the edge of the image for codecs which do not have the
  3289. * CODEC_FLAG_EMU_EDGE flag.
  3290. *
  3291. * @return Required padding in pixels.
  3292. */
  3293. unsigned avcodec_get_edge_width(void);
  3294. /**
  3295. * Modify width and height values so that they will result in a memory
  3296. * buffer that is acceptable for the codec if you do not use any horizontal
  3297. * padding.
  3298. *
  3299. * May only be used if a codec with CODEC_CAP_DR1 has been opened.
  3300. * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
  3301. * according to avcodec_get_edge_width() before.
  3302. */
  3303. void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
  3304. /**
  3305. * Modify width and height values so that they will result in a memory
  3306. * buffer that is acceptable for the codec if you also ensure that all
  3307. * line sizes are a multiple of the respective linesize_align[i].
  3308. *
  3309. * May only be used if a codec with CODEC_CAP_DR1 has been opened.
  3310. * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
  3311. * according to avcodec_get_edge_width() before.
  3312. */
  3313. void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
  3314. int linesize_align[AV_NUM_DATA_POINTERS]);
  3315. enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
  3316. int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  3317. int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
  3318. //FIXME func typedef
  3319. #if FF_API_AVCODEC_OPEN
  3320. /**
  3321. * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
  3322. * function the context has to be allocated.
  3323. *
  3324. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  3325. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  3326. * retrieving a codec.
  3327. *
  3328. * @warning This function is not thread safe!
  3329. *
  3330. * @code
  3331. * avcodec_register_all();
  3332. * codec = avcodec_find_decoder(CODEC_ID_H264);
  3333. * if (!codec)
  3334. * exit(1);
  3335. *
  3336. * context = avcodec_alloc_context3(codec);
  3337. *
  3338. * if (avcodec_open(context, codec) < 0)
  3339. * exit(1);
  3340. * @endcode
  3341. *
  3342. * @param avctx The context which will be set up to use the given codec.
  3343. * @param codec The codec to use within the context.
  3344. * @return zero on success, a negative value on error
  3345. * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
  3346. *
  3347. * @deprecated use avcodec_open2
  3348. */
  3349. attribute_deprecated
  3350. int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
  3351. #endif
  3352. /**
  3353. * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
  3354. * function the context has to be allocated with avcodec_alloc_context3().
  3355. *
  3356. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  3357. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  3358. * retrieving a codec.
  3359. *
  3360. * @warning This function is not thread safe!
  3361. *
  3362. * @code
  3363. * avcodec_register_all();
  3364. * av_dict_set(&opts, "b", "2.5M", 0);
  3365. * codec = avcodec_find_decoder(CODEC_ID_H264);
  3366. * if (!codec)
  3367. * exit(1);
  3368. *
  3369. * context = avcodec_alloc_context3(codec);
  3370. *
  3371. * if (avcodec_open2(context, codec, opts) < 0)
  3372. * exit(1);
  3373. * @endcode
  3374. *
  3375. * @param avctx The context to initialize.
  3376. * @param codec The codec to open this context for. If a non-NULL codec has been
  3377. * previously passed to avcodec_alloc_context3() or
  3378. * avcodec_get_context_defaults3() for this context, then this
  3379. * parameter MUST be either NULL or equal to the previously passed
  3380. * codec.
  3381. * @param options A dictionary filled with AVCodecContext and codec-private options.
  3382. * On return this object will be filled with options that were not found.
  3383. *
  3384. * @return zero on success, a negative value on error
  3385. * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
  3386. * av_dict_set(), av_opt_find().
  3387. */
  3388. int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
  3389. #if FF_API_OLD_DECODE_AUDIO
  3390. /**
  3391. * Wrapper function which calls avcodec_decode_audio4.
  3392. *
  3393. * @deprecated Use avcodec_decode_audio4 instead.
  3394. *
  3395. * Decode the audio frame of size avpkt->size from avpkt->data into samples.
  3396. * Some decoders may support multiple frames in a single AVPacket, such
  3397. * decoders would then just decode the first frame. In this case,
  3398. * avcodec_decode_audio3 has to be called again with an AVPacket that contains
  3399. * the remaining data in order to decode the second frame etc.
  3400. * If no frame
  3401. * could be outputted, frame_size_ptr is zero. Otherwise, it is the
  3402. * decompressed frame size in bytes.
  3403. *
  3404. * @warning You must set frame_size_ptr to the allocated size of the
  3405. * output buffer before calling avcodec_decode_audio3().
  3406. *
  3407. * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
  3408. * the actual read bytes because some optimized bitstream readers read 32 or 64
  3409. * bits at once and could read over the end.
  3410. *
  3411. * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
  3412. * no overreading happens for damaged MPEG streams.
  3413. *
  3414. * @warning You must not provide a custom get_buffer() when using
  3415. * avcodec_decode_audio3(). Doing so will override it with
  3416. * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
  3417. * which does allow the application to provide a custom get_buffer().
  3418. *
  3419. * @note You might have to align the input buffer avpkt->data and output buffer
  3420. * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
  3421. * necessary at all, on others it won't work at all if not aligned and on others
  3422. * it will work but it will have an impact on performance.
  3423. *
  3424. * In practice, avpkt->data should have 4 byte alignment at minimum and
  3425. * samples should be 16 byte aligned unless the CPU doesn't need it
  3426. * (AltiVec and SSE do).
  3427. *
  3428. * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
  3429. * between input and output, these need to be fed with avpkt->data=NULL,
  3430. * avpkt->size=0 at the end to return the remaining frames.
  3431. *
  3432. * @param avctx the codec context
  3433. * @param[out] samples the output buffer, sample type in avctx->sample_fmt
  3434. * If the sample format is planar, each channel plane will
  3435. * be the same size, with no padding between channels.
  3436. * @param[in,out] frame_size_ptr the output buffer size in bytes
  3437. * @param[in] avpkt The input AVPacket containing the input buffer.
  3438. * You can create such packet with av_init_packet() and by then setting
  3439. * data and size, some decoders might in addition need other fields.
  3440. * All decoders are designed to use the least fields possible though.
  3441. * @return On error a negative value is returned, otherwise the number of bytes
  3442. * used or zero if no frame data was decompressed (used) from the input AVPacket.
  3443. */
  3444. attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
  3445. int *frame_size_ptr,
  3446. AVPacket *avpkt);
  3447. #endif
  3448. /**
  3449. * Decode the audio frame of size avpkt->size from avpkt->data into frame.
  3450. *
  3451. * Some decoders may support multiple frames in a single AVPacket. Such
  3452. * decoders would then just decode the first frame. In this case,
  3453. * avcodec_decode_audio4 has to be called again with an AVPacket containing
  3454. * the remaining data in order to decode the second frame, etc...
  3455. * Even if no frames are returned, the packet needs to be fed to the decoder
  3456. * with remaining data until it is completely consumed or an error occurs.
  3457. *
  3458. * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
  3459. * larger than the actual read bytes because some optimized bitstream
  3460. * readers read 32 or 64 bits at once and could read over the end.
  3461. *
  3462. * @note You might have to align the input buffer. The alignment requirements
  3463. * depend on the CPU and the decoder.
  3464. *
  3465. * @param avctx the codec context
  3466. * @param[out] frame The AVFrame in which to store decoded audio samples.
  3467. * Decoders request a buffer of a particular size by setting
  3468. * AVFrame.nb_samples prior to calling get_buffer(). The
  3469. * decoder may, however, only utilize part of the buffer by
  3470. * setting AVFrame.nb_samples to a smaller value in the
  3471. * output frame.
  3472. * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
  3473. * non-zero.
  3474. * @param[in] avpkt The input AVPacket containing the input buffer.
  3475. * At least avpkt->data and avpkt->size should be set. Some
  3476. * decoders might also require additional fields to be set.
  3477. * @return A negative error code is returned if an error occurred during
  3478. * decoding, otherwise the number of bytes consumed from the input
  3479. * AVPacket is returned.
  3480. */
  3481. int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
  3482. int *got_frame_ptr, AVPacket *avpkt);
  3483. /**
  3484. * Decode the video frame of size avpkt->size from avpkt->data into picture.
  3485. * Some decoders may support multiple frames in a single AVPacket, such
  3486. * decoders would then just decode the first frame.
  3487. *
  3488. * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
  3489. * the actual read bytes because some optimized bitstream readers read 32 or 64
  3490. * bits at once and could read over the end.
  3491. *
  3492. * @warning The end of the input buffer buf should be set to 0 to ensure that
  3493. * no overreading happens for damaged MPEG streams.
  3494. *
  3495. * @note You might have to align the input buffer avpkt->data.
  3496. * The alignment requirements depend on the CPU: on some CPUs it isn't
  3497. * necessary at all, on others it won't work at all if not aligned and on others
  3498. * it will work but it will have an impact on performance.
  3499. *
  3500. * In practice, avpkt->data should have 4 byte alignment at minimum.
  3501. *
  3502. * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
  3503. * between input and output, these need to be fed with avpkt->data=NULL,
  3504. * avpkt->size=0 at the end to return the remaining frames.
  3505. *
  3506. * @param avctx the codec context
  3507. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  3508. * Use avcodec_alloc_frame to get an AVFrame, the codec will
  3509. * allocate memory for the actual bitmap.
  3510. * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
  3511. * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
  3512. * decodes and the decoder tells the user once it does not need the data anymore,
  3513. * the user app can at this point free/reuse/keep the memory as it sees fit.
  3514. *
  3515. * @param[in] avpkt The input AVpacket containing the input buffer.
  3516. * You can create such packet with av_init_packet() and by then setting
  3517. * data and size, some decoders might in addition need other fields like
  3518. * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
  3519. * fields possible.
  3520. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  3521. * @return On error a negative value is returned, otherwise the number of bytes
  3522. * used or zero if no frame could be decompressed.
  3523. */
  3524. int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
  3525. int *got_picture_ptr,
  3526. const AVPacket *avpkt);
  3527. /**
  3528. * Decode a subtitle message.
  3529. * Return a negative value on error, otherwise return the number of bytes used.
  3530. * If no subtitle could be decompressed, got_sub_ptr is zero.
  3531. * Otherwise, the subtitle is stored in *sub.
  3532. * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
  3533. * simplicity, because the performance difference is expect to be negligible
  3534. * and reusing a get_buffer written for video codecs would probably perform badly
  3535. * due to a potentially very different allocation pattern.
  3536. *
  3537. * @param avctx the codec context
  3538. * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
  3539. freed with avsubtitle_free if *got_sub_ptr is set.
  3540. * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
  3541. * @param[in] avpkt The input AVPacket containing the input buffer.
  3542. */
  3543. int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
  3544. int *got_sub_ptr,
  3545. AVPacket *avpkt);
  3546. /**
  3547. * Free all allocated data in the given subtitle struct.
  3548. *
  3549. * @param sub AVSubtitle to free.
  3550. */
  3551. void avsubtitle_free(AVSubtitle *sub);
  3552. #if FF_API_OLD_ENCODE_AUDIO
  3553. /**
  3554. * Encode an audio frame from samples into buf.
  3555. *
  3556. * @deprecated Use avcodec_encode_audio2 instead.
  3557. *
  3558. * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
  3559. * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
  3560. * will know how much space is needed because it depends on the value passed
  3561. * in buf_size as described below. In that case a lower value can be used.
  3562. *
  3563. * @param avctx the codec context
  3564. * @param[out] buf the output buffer
  3565. * @param[in] buf_size the output buffer size
  3566. * @param[in] samples the input buffer containing the samples
  3567. * The number of samples read from this buffer is frame_size*channels,
  3568. * both of which are defined in avctx.
  3569. * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
  3570. * samples read from samples is equal to:
  3571. * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
  3572. * This also implies that av_get_bits_per_sample() must not return 0 for these
  3573. * codecs.
  3574. * @return On error a negative value is returned, on success zero or the number
  3575. * of bytes used to encode the data read from the input buffer.
  3576. */
  3577. int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
  3578. uint8_t *buf, int buf_size,
  3579. const short *samples);
  3580. #endif
  3581. /**
  3582. * Encode a frame of audio.
  3583. *
  3584. * Takes input samples from frame and writes the next output packet, if
  3585. * available, to avpkt. The output packet does not necessarily contain data for
  3586. * the most recent frame, as encoders can delay, split, and combine input frames
  3587. * internally as needed.
  3588. *
  3589. * @param avctx codec context
  3590. * @param avpkt output AVPacket.
  3591. * The user can supply an output buffer by setting
  3592. * avpkt->data and avpkt->size prior to calling the
  3593. * function, but if the size of the user-provided data is not
  3594. * large enough, encoding will fail. All other AVPacket fields
  3595. * will be reset by the encoder using av_init_packet(). If
  3596. * avpkt->data is NULL, the encoder will allocate it.
  3597. * The encoder will set avpkt->size to the size of the
  3598. * output packet.
  3599. *
  3600. * If this function fails or produces no output, avpkt will be
  3601. * freed using av_free_packet() (i.e. avpkt->destruct will be
  3602. * called to free the user supplied buffer).
  3603. * @param[in] frame AVFrame containing the raw audio data to be encoded.
  3604. * May be NULL when flushing an encoder that has the
  3605. * CODEC_CAP_DELAY capability set.
  3606. * There are 2 codec capabilities that affect the allowed
  3607. * values of frame->nb_samples.
  3608. * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
  3609. * frame may be smaller than avctx->frame_size, and all other
  3610. * frames must be equal to avctx->frame_size.
  3611. * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
  3612. * can have any number of samples.
  3613. * If neither is set, frame->nb_samples must be equal to
  3614. * avctx->frame_size for all frames.
  3615. * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
  3616. * output packet is non-empty, and to 0 if it is
  3617. * empty. If the function returns an error, the
  3618. * packet can be assumed to be invalid, and the
  3619. * value of got_packet_ptr is undefined and should
  3620. * not be used.
  3621. * @return 0 on success, negative error code on failure
  3622. */
  3623. int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
  3624. const AVFrame *frame, int *got_packet_ptr);
  3625. /**
  3626. * Fill audio frame data and linesize.
  3627. * AVFrame extended_data channel pointers are allocated if necessary for
  3628. * planar audio.
  3629. *
  3630. * @param frame the AVFrame
  3631. * frame->nb_samples must be set prior to calling the
  3632. * function. This function fills in frame->data,
  3633. * frame->extended_data, frame->linesize[0].
  3634. * @param nb_channels channel count
  3635. * @param sample_fmt sample format
  3636. * @param buf buffer to use for frame data
  3637. * @param buf_size size of buffer
  3638. * @param align plane size sample alignment
  3639. * @return 0 on success, negative error code on failure
  3640. */
  3641. int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
  3642. enum AVSampleFormat sample_fmt, const uint8_t *buf,
  3643. int buf_size, int align);
  3644. #if FF_API_OLD_ENCODE_VIDEO
  3645. /**
  3646. * @deprecated use avcodec_encode_video2() instead.
  3647. *
  3648. * Encode a video frame from pict into buf.
  3649. * The input picture should be
  3650. * stored using a specific format, namely avctx.pix_fmt.
  3651. *
  3652. * @param avctx the codec context
  3653. * @param[out] buf the output buffer for the bitstream of encoded frame
  3654. * @param[in] buf_size the size of the output buffer in bytes
  3655. * @param[in] pict the input picture to encode
  3656. * @return On error a negative value is returned, on success zero or the number
  3657. * of bytes used from the output buffer.
  3658. */
  3659. attribute_deprecated
  3660. int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3661. const AVFrame *pict);
  3662. #endif
  3663. /**
  3664. * Encode a frame of video.
  3665. *
  3666. * Takes input raw video data from frame and writes the next output packet, if
  3667. * available, to avpkt. The output packet does not necessarily contain data for
  3668. * the most recent frame, as encoders can delay and reorder input frames
  3669. * internally as needed.
  3670. *
  3671. * @param avctx codec context
  3672. * @param avpkt output AVPacket.
  3673. * The user can supply an output buffer by setting
  3674. * avpkt->data and avpkt->size prior to calling the
  3675. * function, but if the size of the user-provided data is not
  3676. * large enough, encoding will fail. All other AVPacket fields
  3677. * will be reset by the encoder using av_init_packet(). If
  3678. * avpkt->data is NULL, the encoder will allocate it.
  3679. * The encoder will set avpkt->size to the size of the
  3680. * output packet. The returned data (if any) belongs to the
  3681. * caller, he is responsible for freeing it.
  3682. *
  3683. * If this function fails or produces no output, avpkt will be
  3684. * freed using av_free_packet() (i.e. avpkt->destruct will be
  3685. * called to free the user supplied buffer).
  3686. * @param[in] frame AVFrame containing the raw video data to be encoded.
  3687. * May be NULL when flushing an encoder that has the
  3688. * CODEC_CAP_DELAY capability set.
  3689. * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
  3690. * output packet is non-empty, and to 0 if it is
  3691. * empty. If the function returns an error, the
  3692. * packet can be assumed to be invalid, and the
  3693. * value of got_packet_ptr is undefined and should
  3694. * not be used.
  3695. * @return 0 on success, negative error code on failure
  3696. */
  3697. int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
  3698. const AVFrame *frame, int *got_packet_ptr);
  3699. int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3700. const AVSubtitle *sub);
  3701. /**
  3702. * Close a given AVCodecContext and free all the data associated with it
  3703. * (but not the AVCodecContext itself).
  3704. *
  3705. * Calling this function on an AVCodecContext that hasn't been opened will free
  3706. * the codec-specific data allocated in avcodec_alloc_context3() /
  3707. * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
  3708. * do nothing.
  3709. */
  3710. int avcodec_close(AVCodecContext *avctx);
  3711. /**
  3712. * Register all the codecs, parsers and bitstream filters which were enabled at
  3713. * configuration time. If you do not call this function you can select exactly
  3714. * which formats you want to support, by using the individual registration
  3715. * functions.
  3716. *
  3717. * @see avcodec_register
  3718. * @see av_register_codec_parser
  3719. * @see av_register_bitstream_filter
  3720. */
  3721. void avcodec_register_all(void);
  3722. /**
  3723. * Flush buffers, should be called when seeking or when switching to a different stream.
  3724. */
  3725. void avcodec_flush_buffers(AVCodecContext *avctx);
  3726. void avcodec_default_free_buffers(AVCodecContext *s);
  3727. /* misc useful functions */
  3728. /**
  3729. * Return codec bits per sample.
  3730. *
  3731. * @param[in] codec_id the codec
  3732. * @return Number of bits per sample or zero if unknown for the given codec.
  3733. */
  3734. int av_get_bits_per_sample(enum CodecID codec_id);
  3735. /**
  3736. * Return the PCM codec associated with a sample format.
  3737. * @param be endianness, 0 for little, 1 for big,
  3738. * -1 (or anything else) for native
  3739. * @return CODEC_ID_PCM_* or CODEC_ID_NONE
  3740. */
  3741. enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
  3742. /**
  3743. * Return codec bits per sample.
  3744. * Only return non-zero if the bits per sample is exactly correct, not an
  3745. * approximation.
  3746. *
  3747. * @param[in] codec_id the codec
  3748. * @return Number of bits per sample or zero if unknown for the given codec.
  3749. */
  3750. int av_get_exact_bits_per_sample(enum CodecID codec_id);
  3751. /**
  3752. * Return audio frame duration.
  3753. *
  3754. * @param avctx codec context
  3755. * @param frame_bytes size of the frame, or 0 if unknown
  3756. * @return frame duration, in samples, if known. 0 if not able to
  3757. * determine.
  3758. */
  3759. int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
  3760. /* frame parsing */
  3761. typedef struct AVCodecParserContext {
  3762. void *priv_data;
  3763. struct AVCodecParser *parser;
  3764. int64_t frame_offset; /* offset of the current frame */
  3765. int64_t cur_offset; /* current offset
  3766. (incremented by each av_parser_parse()) */
  3767. int64_t next_frame_offset; /* offset of the next frame */
  3768. /* video info */
  3769. int pict_type; /* XXX: Put it back in AVCodecContext. */
  3770. /**
  3771. * This field is used for proper frame duration computation in lavf.
  3772. * It signals, how much longer the frame duration of the current frame
  3773. * is compared to normal frame duration.
  3774. *
  3775. * frame_duration = (1 + repeat_pict) * time_base
  3776. *
  3777. * It is used by codecs like H.264 to display telecined material.
  3778. */
  3779. int repeat_pict; /* XXX: Put it back in AVCodecContext. */
  3780. int64_t pts; /* pts of the current frame */
  3781. int64_t dts; /* dts of the current frame */
  3782. /* private data */
  3783. int64_t last_pts;
  3784. int64_t last_dts;
  3785. int fetch_timestamp;
  3786. #define AV_PARSER_PTS_NB 4
  3787. int cur_frame_start_index;
  3788. int64_t cur_frame_offset[AV_PARSER_PTS_NB];
  3789. int64_t cur_frame_pts[AV_PARSER_PTS_NB];
  3790. int64_t cur_frame_dts[AV_PARSER_PTS_NB];
  3791. int flags;
  3792. #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
  3793. #define PARSER_FLAG_ONCE 0x0002
  3794. /// Set if the parser has a valid file offset
  3795. #define PARSER_FLAG_FETCHED_OFFSET 0x0004
  3796. int64_t offset; ///< byte offset from starting packet start
  3797. int64_t cur_frame_end[AV_PARSER_PTS_NB];
  3798. /**
  3799. * Set by parser to 1 for key frames and 0 for non-key frames.
  3800. * It is initialized to -1, so if the parser doesn't set this flag,
  3801. * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
  3802. * will be used.
  3803. */
  3804. int key_frame;
  3805. /**
  3806. * Time difference in stream time base units from the pts of this
  3807. * packet to the point at which the output from the decoder has converged
  3808. * independent from the availability of previous frames. That is, the
  3809. * frames are virtually identical no matter if decoding started from
  3810. * the very first frame or from this keyframe.
  3811. * Is AV_NOPTS_VALUE if unknown.
  3812. * This field is not the display duration of the current frame.
  3813. * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
  3814. * set.
  3815. *
  3816. * The purpose of this field is to allow seeking in streams that have no
  3817. * keyframes in the conventional sense. It corresponds to the
  3818. * recovery point SEI in H.264 and match_time_delta in NUT. It is also
  3819. * essential for some types of subtitle streams to ensure that all
  3820. * subtitles are correctly displayed after seeking.
  3821. */
  3822. int64_t convergence_duration;
  3823. // Timestamp generation support:
  3824. /**
  3825. * Synchronization point for start of timestamp generation.
  3826. *
  3827. * Set to >0 for sync point, 0 for no sync point and <0 for undefined
  3828. * (default).
  3829. *
  3830. * For example, this corresponds to presence of H.264 buffering period
  3831. * SEI message.
  3832. */
  3833. int dts_sync_point;
  3834. /**
  3835. * Offset of the current timestamp against last timestamp sync point in
  3836. * units of AVCodecContext.time_base.
  3837. *
  3838. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  3839. * contain a valid timestamp offset.
  3840. *
  3841. * Note that the timestamp of sync point has usually a nonzero
  3842. * dts_ref_dts_delta, which refers to the previous sync point. Offset of
  3843. * the next frame after timestamp sync point will be usually 1.
  3844. *
  3845. * For example, this corresponds to H.264 cpb_removal_delay.
  3846. */
  3847. int dts_ref_dts_delta;
  3848. /**
  3849. * Presentation delay of current frame in units of AVCodecContext.time_base.
  3850. *
  3851. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  3852. * contain valid non-negative timestamp delta (presentation time of a frame
  3853. * must not lie in the past).
  3854. *
  3855. * This delay represents the difference between decoding and presentation
  3856. * time of the frame.
  3857. *
  3858. * For example, this corresponds to H.264 dpb_output_delay.
  3859. */
  3860. int pts_dts_delta;
  3861. /**
  3862. * Position of the packet in file.
  3863. *
  3864. * Analogous to cur_frame_pts/dts
  3865. */
  3866. int64_t cur_frame_pos[AV_PARSER_PTS_NB];
  3867. /**
  3868. * Byte position of currently parsed frame in stream.
  3869. */
  3870. int64_t pos;
  3871. /**
  3872. * Previous frame byte position.
  3873. */
  3874. int64_t last_pos;
  3875. /**
  3876. * Duration of the current frame.
  3877. * For audio, this is in units of 1 / AVCodecContext.sample_rate.
  3878. * For all other types, this is in units of AVCodecContext.time_base.
  3879. */
  3880. int duration;
  3881. } AVCodecParserContext;
  3882. typedef struct AVCodecParser {
  3883. int codec_ids[5]; /* several codec IDs are permitted */
  3884. int priv_data_size;
  3885. int (*parser_init)(AVCodecParserContext *s);
  3886. int (*parser_parse)(AVCodecParserContext *s,
  3887. AVCodecContext *avctx,
  3888. const uint8_t **poutbuf, int *poutbuf_size,
  3889. const uint8_t *buf, int buf_size);
  3890. void (*parser_close)(AVCodecParserContext *s);
  3891. int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
  3892. struct AVCodecParser *next;
  3893. } AVCodecParser;
  3894. AVCodecParser *av_parser_next(AVCodecParser *c);
  3895. void av_register_codec_parser(AVCodecParser *parser);
  3896. AVCodecParserContext *av_parser_init(int codec_id);
  3897. /**
  3898. * Parse a packet.
  3899. *
  3900. * @param s parser context.
  3901. * @param avctx codec context.
  3902. * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
  3903. * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
  3904. * @param buf input buffer.
  3905. * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
  3906. * @param pts input presentation timestamp.
  3907. * @param dts input decoding timestamp.
  3908. * @param pos input byte position in stream.
  3909. * @return the number of bytes of the input bitstream used.
  3910. *
  3911. * Example:
  3912. * @code
  3913. * while(in_len){
  3914. * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
  3915. * in_data, in_len,
  3916. * pts, dts, pos);
  3917. * in_data += len;
  3918. * in_len -= len;
  3919. *
  3920. * if(size)
  3921. * decode_frame(data, size);
  3922. * }
  3923. * @endcode
  3924. */
  3925. int av_parser_parse2(AVCodecParserContext *s,
  3926. AVCodecContext *avctx,
  3927. uint8_t **poutbuf, int *poutbuf_size,
  3928. const uint8_t *buf, int buf_size,
  3929. int64_t pts, int64_t dts,
  3930. int64_t pos);
  3931. int av_parser_change(AVCodecParserContext *s,
  3932. AVCodecContext *avctx,
  3933. uint8_t **poutbuf, int *poutbuf_size,
  3934. const uint8_t *buf, int buf_size, int keyframe);
  3935. void av_parser_close(AVCodecParserContext *s);
  3936. typedef struct AVBitStreamFilterContext {
  3937. void *priv_data;
  3938. struct AVBitStreamFilter *filter;
  3939. AVCodecParserContext *parser;
  3940. struct AVBitStreamFilterContext *next;
  3941. } AVBitStreamFilterContext;
  3942. typedef struct AVBitStreamFilter {
  3943. const char *name;
  3944. int priv_data_size;
  3945. int (*filter)(AVBitStreamFilterContext *bsfc,
  3946. AVCodecContext *avctx, const char *args,
  3947. uint8_t **poutbuf, int *poutbuf_size,
  3948. const uint8_t *buf, int buf_size, int keyframe);
  3949. void (*close)(AVBitStreamFilterContext *bsfc);
  3950. struct AVBitStreamFilter *next;
  3951. } AVBitStreamFilter;
  3952. void av_register_bitstream_filter(AVBitStreamFilter *bsf);
  3953. AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
  3954. int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
  3955. AVCodecContext *avctx, const char *args,
  3956. uint8_t **poutbuf, int *poutbuf_size,
  3957. const uint8_t *buf, int buf_size, int keyframe);
  3958. void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
  3959. AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
  3960. /* memory */
  3961. /**
  3962. * Reallocate the given block if it is not large enough, otherwise do nothing.
  3963. *
  3964. * @see av_realloc
  3965. */
  3966. void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
  3967. /**
  3968. * Allocate a buffer, reusing the given one if large enough.
  3969. *
  3970. * Contrary to av_fast_realloc the current buffer contents might not be
  3971. * preserved and on error the old buffer is freed, thus no special
  3972. * handling to avoid memleaks is necessary.
  3973. *
  3974. * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
  3975. * @param size size of the buffer *ptr points to
  3976. * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
  3977. * *size 0 if an error occurred.
  3978. */
  3979. void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
  3980. /**
  3981. * Same behaviour av_fast_malloc but the buffer has additional
  3982. * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
  3983. *
  3984. * In addition the whole buffer will initially and after resizes
  3985. * be 0-initialized so that no uninitialized data will ever appear.
  3986. */
  3987. void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
  3988. /**
  3989. * Copy image src to dst. Wraps av_picture_data_copy() above.
  3990. */
  3991. void av_picture_copy(AVPicture *dst, const AVPicture *src,
  3992. enum PixelFormat pix_fmt, int width, int height);
  3993. /**
  3994. * Crop image top and left side.
  3995. */
  3996. int av_picture_crop(AVPicture *dst, const AVPicture *src,
  3997. enum PixelFormat pix_fmt, int top_band, int left_band);
  3998. /**
  3999. * Pad image.
  4000. */
  4001. int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
  4002. int padtop, int padbottom, int padleft, int padright, int *color);
  4003. /**
  4004. * Encode extradata length to a buffer. Used by xiph codecs.
  4005. *
  4006. * @param s buffer to write to; must be at least (v/255+1) bytes long
  4007. * @param v size of extradata in bytes
  4008. * @return number of bytes written to the buffer.
  4009. */
  4010. unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  4011. /**
  4012. * Log a generic warning message about a missing feature. This function is
  4013. * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
  4014. * only, and would normally not be used by applications.
  4015. * @param[in] avc a pointer to an arbitrary struct of which the first field is
  4016. * a pointer to an AVClass struct
  4017. * @param[in] feature string containing the name of the missing feature
  4018. * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
  4019. * If want_sample is non-zero, additional verbage will be added to the log
  4020. * message which tells the user how to report samples to the development
  4021. * mailing list.
  4022. */
  4023. void av_log_missing_feature(void *avc, const char *feature, int want_sample);
  4024. /**
  4025. * Log a generic warning message asking for a sample. This function is
  4026. * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
  4027. * only, and would normally not be used by applications.
  4028. * @param[in] avc a pointer to an arbitrary struct of which the first field is
  4029. * a pointer to an AVClass struct
  4030. * @param[in] msg string containing an optional message, or NULL if no message
  4031. */
  4032. void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
  4033. /**
  4034. * Register the hardware accelerator hwaccel.
  4035. */
  4036. void av_register_hwaccel(AVHWAccel *hwaccel);
  4037. /**
  4038. * If hwaccel is NULL, returns the first registered hardware accelerator,
  4039. * if hwaccel is non-NULL, returns the next registered hardware accelerator
  4040. * after hwaccel, or NULL if hwaccel is the last one.
  4041. */
  4042. AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
  4043. /**
  4044. * Lock operation used by lockmgr
  4045. */
  4046. enum AVLockOp {
  4047. AV_LOCK_CREATE, ///< Create a mutex
  4048. AV_LOCK_OBTAIN, ///< Lock the mutex
  4049. AV_LOCK_RELEASE, ///< Unlock the mutex
  4050. AV_LOCK_DESTROY, ///< Free mutex resources
  4051. };
  4052. /**
  4053. * Register a user provided lock manager supporting the operations
  4054. * specified by AVLockOp. mutex points to a (void *) where the
  4055. * lockmgr should store/get a pointer to a user allocated mutex. It's
  4056. * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
  4057. *
  4058. * @param cb User defined callback. Note: FFmpeg may invoke calls to this
  4059. * callback during the call to av_lockmgr_register().
  4060. * Thus, the application must be prepared to handle that.
  4061. * If cb is set to NULL the lockmgr will be unregistered.
  4062. * Also note that during unregistration the previously registered
  4063. * lockmgr callback may also be invoked.
  4064. */
  4065. int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
  4066. /**
  4067. * Get the type of the given codec.
  4068. */
  4069. enum AVMediaType avcodec_get_type(enum CodecID codec_id);
  4070. /**
  4071. * Get the AVClass for AVCodecContext. It can be used in combination with
  4072. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  4073. *
  4074. * @see av_opt_find().
  4075. */
  4076. const AVClass *avcodec_get_class(void);
  4077. /**
  4078. * Get the AVClass for AVFrame. It can be used in combination with
  4079. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  4080. *
  4081. * @see av_opt_find().
  4082. */
  4083. const AVClass *avcodec_get_frame_class(void);
  4084. /**
  4085. * @return a positive value if s is open (i.e. avcodec_open2() was called on it
  4086. * with no corresponding avcodec_close()), 0 otherwise.
  4087. */
  4088. int avcodec_is_open(AVCodecContext *s);
  4089. /**
  4090. * @return a non-zero number if codec is an encoder, zero otherwise
  4091. */
  4092. int av_codec_is_encoder(AVCodec *codec);
  4093. /**
  4094. * @return a non-zero number if codec is a decoder, zero otherwise
  4095. */
  4096. int av_codec_is_decoder(AVCodec *codec);
  4097. #endif /* AVCODEC_AVCODEC_H */