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.

4533 lines
146KB

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