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.

4714 lines
153KB

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