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.

6350 lines
210KB

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