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.

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