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.

4515 lines
150KB

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