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.

4705 lines
153KB

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