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.

4164 lines
137KB

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