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.

4507 lines
146KB

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