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.

5042 lines
167KB

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