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.

6085 lines
200KB

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