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.

5083 lines
172KB

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