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.

4920 lines
164KB

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