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.

4912 lines
161KB

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