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.

5338 lines
175KB

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