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.

5213 lines
175KB

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