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.

4371 lines
143KB

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