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.

4612 lines
150KB

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