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.

6214 lines
209KB

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