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.

4687 lines
153KB

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