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.

4290 lines
141KB

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