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.

4766 lines
153KB

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