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.

5246 lines
168KB

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