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.

5604 lines
186KB

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