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.

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