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.

6103 lines
201KB

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