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.

4964 lines
163KB

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