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.

6299 lines
208KB

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