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.

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