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.

5020 lines
165KB

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