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.

5403 lines
173KB

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