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.

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