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.

4653 lines
152KB

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