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.

4666 lines
152KB

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