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.

5949 lines
196KB

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