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.

5066 lines
167KB

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