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.

6074 lines
200KB

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