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.

4567 lines
147KB

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