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.

4445 lines
145KB

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