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.

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