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.

6311 lines
209KB

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