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.

4797 lines
156KB

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