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.

4713 lines
154KB

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