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.

6300 lines
208KB

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