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.

5764 lines
191KB

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