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.

5309 lines
169KB

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