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.

5082 lines
168KB

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