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.

5069 lines
167KB

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