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.

5103 lines
173KB

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