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.

5278 lines
170KB

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