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.

4691 lines
152KB

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