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.

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