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.

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