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.

3079 lines
96KB

  1. /*
  2. * copyright (c) 2001 Fabrice Bellard
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef AVCODEC_AVCODEC_H
  21. #define AVCODEC_AVCODEC_H
  22. /**
  23. * @file avcodec.h
  24. * external API header
  25. */
  26. #include "libavutil/avutil.h"
  27. #define LIBAVCODEC_VERSION_MAJOR 52
  28. #define LIBAVCODEC_VERSION_MINOR 10
  29. #define LIBAVCODEC_VERSION_MICRO 0
  30. #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
  31. LIBAVCODEC_VERSION_MINOR, \
  32. LIBAVCODEC_VERSION_MICRO)
  33. #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
  34. LIBAVCODEC_VERSION_MINOR, \
  35. LIBAVCODEC_VERSION_MICRO)
  36. #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
  37. #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
  38. #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
  39. #define AV_TIME_BASE 1000000
  40. #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
  41. /**
  42. * Identifies the syntax and semantics of the bitstream.
  43. * The principle is roughly:
  44. * Two decoders with the same ID can decode the same streams.
  45. * Two encoders with the same ID can encode compatible streams.
  46. * There may be slight deviations from the principle due to implementation
  47. * details.
  48. *
  49. * If you add a codec ID to this list, add it so that
  50. * 1. no value of a existing codec ID changes (that would break ABI),
  51. * 2. it is as close as possible to similar codecs.
  52. */
  53. enum CodecID {
  54. CODEC_ID_NONE,
  55. /* video codecs */
  56. CODEC_ID_MPEG1VIDEO,
  57. CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  58. CODEC_ID_MPEG2VIDEO_XVMC,
  59. CODEC_ID_H261,
  60. CODEC_ID_H263,
  61. CODEC_ID_RV10,
  62. CODEC_ID_RV20,
  63. CODEC_ID_MJPEG,
  64. CODEC_ID_MJPEGB,
  65. CODEC_ID_LJPEG,
  66. CODEC_ID_SP5X,
  67. CODEC_ID_JPEGLS,
  68. CODEC_ID_MPEG4,
  69. CODEC_ID_RAWVIDEO,
  70. CODEC_ID_MSMPEG4V1,
  71. CODEC_ID_MSMPEG4V2,
  72. CODEC_ID_MSMPEG4V3,
  73. CODEC_ID_WMV1,
  74. CODEC_ID_WMV2,
  75. CODEC_ID_H263P,
  76. CODEC_ID_H263I,
  77. CODEC_ID_FLV1,
  78. CODEC_ID_SVQ1,
  79. CODEC_ID_SVQ3,
  80. CODEC_ID_DVVIDEO,
  81. CODEC_ID_HUFFYUV,
  82. CODEC_ID_CYUV,
  83. CODEC_ID_H264,
  84. CODEC_ID_INDEO3,
  85. CODEC_ID_VP3,
  86. CODEC_ID_THEORA,
  87. CODEC_ID_ASV1,
  88. CODEC_ID_ASV2,
  89. CODEC_ID_FFV1,
  90. CODEC_ID_4XM,
  91. CODEC_ID_VCR1,
  92. CODEC_ID_CLJR,
  93. CODEC_ID_MDEC,
  94. CODEC_ID_ROQ,
  95. CODEC_ID_INTERPLAY_VIDEO,
  96. CODEC_ID_XAN_WC3,
  97. CODEC_ID_XAN_WC4,
  98. CODEC_ID_RPZA,
  99. CODEC_ID_CINEPAK,
  100. CODEC_ID_WS_VQA,
  101. CODEC_ID_MSRLE,
  102. CODEC_ID_MSVIDEO1,
  103. CODEC_ID_IDCIN,
  104. CODEC_ID_8BPS,
  105. CODEC_ID_SMC,
  106. CODEC_ID_FLIC,
  107. CODEC_ID_TRUEMOTION1,
  108. CODEC_ID_VMDVIDEO,
  109. CODEC_ID_MSZH,
  110. CODEC_ID_ZLIB,
  111. CODEC_ID_QTRLE,
  112. CODEC_ID_SNOW,
  113. CODEC_ID_TSCC,
  114. CODEC_ID_ULTI,
  115. CODEC_ID_QDRAW,
  116. CODEC_ID_VIXL,
  117. CODEC_ID_QPEG,
  118. CODEC_ID_XVID,
  119. CODEC_ID_PNG,
  120. CODEC_ID_PPM,
  121. CODEC_ID_PBM,
  122. CODEC_ID_PGM,
  123. CODEC_ID_PGMYUV,
  124. CODEC_ID_PAM,
  125. CODEC_ID_FFVHUFF,
  126. CODEC_ID_RV30,
  127. CODEC_ID_RV40,
  128. CODEC_ID_VC1,
  129. CODEC_ID_WMV3,
  130. CODEC_ID_LOCO,
  131. CODEC_ID_WNV1,
  132. CODEC_ID_AASC,
  133. CODEC_ID_INDEO2,
  134. CODEC_ID_FRAPS,
  135. CODEC_ID_TRUEMOTION2,
  136. CODEC_ID_BMP,
  137. CODEC_ID_CSCD,
  138. CODEC_ID_MMVIDEO,
  139. CODEC_ID_ZMBV,
  140. CODEC_ID_AVS,
  141. CODEC_ID_SMACKVIDEO,
  142. CODEC_ID_NUV,
  143. CODEC_ID_KMVC,
  144. CODEC_ID_FLASHSV,
  145. CODEC_ID_CAVS,
  146. CODEC_ID_JPEG2000,
  147. CODEC_ID_VMNC,
  148. CODEC_ID_VP5,
  149. CODEC_ID_VP6,
  150. CODEC_ID_VP6F,
  151. CODEC_ID_TARGA,
  152. CODEC_ID_DSICINVIDEO,
  153. CODEC_ID_TIERTEXSEQVIDEO,
  154. CODEC_ID_TIFF,
  155. CODEC_ID_GIF,
  156. CODEC_ID_FFH264,
  157. CODEC_ID_DXA,
  158. CODEC_ID_DNXHD,
  159. CODEC_ID_THP,
  160. CODEC_ID_SGI,
  161. CODEC_ID_C93,
  162. CODEC_ID_BETHSOFTVID,
  163. CODEC_ID_PTX,
  164. CODEC_ID_TXD,
  165. CODEC_ID_VP6A,
  166. CODEC_ID_AMV,
  167. CODEC_ID_VB,
  168. CODEC_ID_PCX,
  169. CODEC_ID_SUNRAST,
  170. CODEC_ID_INDEO4,
  171. CODEC_ID_INDEO5,
  172. CODEC_ID_MIMIC,
  173. CODEC_ID_RL2,
  174. CODEC_ID_8SVX_EXP,
  175. CODEC_ID_8SVX_FIB,
  176. CODEC_ID_ESCAPE124,
  177. CODEC_ID_DIRAC,
  178. CODEC_ID_BFI,
  179. CODEC_ID_CMV,
  180. CODEC_ID_MOTIONPIXELS,
  181. CODEC_ID_TGV,
  182. CODEC_ID_TGQ,
  183. /* "codecs" for HW decoding with VDPAU */
  184. CODEC_ID_H264_VDPAU= 0x9000,
  185. /* various PCM "codecs" */
  186. CODEC_ID_PCM_S16LE= 0x10000,
  187. CODEC_ID_PCM_S16BE,
  188. CODEC_ID_PCM_U16LE,
  189. CODEC_ID_PCM_U16BE,
  190. CODEC_ID_PCM_S8,
  191. CODEC_ID_PCM_U8,
  192. CODEC_ID_PCM_MULAW,
  193. CODEC_ID_PCM_ALAW,
  194. CODEC_ID_PCM_S32LE,
  195. CODEC_ID_PCM_S32BE,
  196. CODEC_ID_PCM_U32LE,
  197. CODEC_ID_PCM_U32BE,
  198. CODEC_ID_PCM_S24LE,
  199. CODEC_ID_PCM_S24BE,
  200. CODEC_ID_PCM_U24LE,
  201. CODEC_ID_PCM_U24BE,
  202. CODEC_ID_PCM_S24DAUD,
  203. CODEC_ID_PCM_ZORK,
  204. CODEC_ID_PCM_S16LE_PLANAR,
  205. CODEC_ID_PCM_DVD,
  206. CODEC_ID_PCM_F32BE,
  207. CODEC_ID_PCM_F32LE,
  208. CODEC_ID_PCM_F64BE,
  209. CODEC_ID_PCM_F64LE,
  210. /* various ADPCM codecs */
  211. CODEC_ID_ADPCM_IMA_QT= 0x11000,
  212. CODEC_ID_ADPCM_IMA_WAV,
  213. CODEC_ID_ADPCM_IMA_DK3,
  214. CODEC_ID_ADPCM_IMA_DK4,
  215. CODEC_ID_ADPCM_IMA_WS,
  216. CODEC_ID_ADPCM_IMA_SMJPEG,
  217. CODEC_ID_ADPCM_MS,
  218. CODEC_ID_ADPCM_4XM,
  219. CODEC_ID_ADPCM_XA,
  220. CODEC_ID_ADPCM_ADX,
  221. CODEC_ID_ADPCM_EA,
  222. CODEC_ID_ADPCM_G726,
  223. CODEC_ID_ADPCM_CT,
  224. CODEC_ID_ADPCM_SWF,
  225. CODEC_ID_ADPCM_YAMAHA,
  226. CODEC_ID_ADPCM_SBPRO_4,
  227. CODEC_ID_ADPCM_SBPRO_3,
  228. CODEC_ID_ADPCM_SBPRO_2,
  229. CODEC_ID_ADPCM_THP,
  230. CODEC_ID_ADPCM_IMA_AMV,
  231. CODEC_ID_ADPCM_EA_R1,
  232. CODEC_ID_ADPCM_EA_R3,
  233. CODEC_ID_ADPCM_EA_R2,
  234. CODEC_ID_ADPCM_IMA_EA_SEAD,
  235. CODEC_ID_ADPCM_IMA_EA_EACS,
  236. CODEC_ID_ADPCM_EA_XAS,
  237. CODEC_ID_ADPCM_EA_MAXIS_XA,
  238. /* AMR */
  239. CODEC_ID_AMR_NB= 0x12000,
  240. CODEC_ID_AMR_WB,
  241. /* RealAudio codecs*/
  242. CODEC_ID_RA_144= 0x13000,
  243. CODEC_ID_RA_288,
  244. /* various DPCM codecs */
  245. CODEC_ID_ROQ_DPCM= 0x14000,
  246. CODEC_ID_INTERPLAY_DPCM,
  247. CODEC_ID_XAN_DPCM,
  248. CODEC_ID_SOL_DPCM,
  249. /* audio codecs */
  250. CODEC_ID_MP2= 0x15000,
  251. CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
  252. CODEC_ID_AAC,
  253. CODEC_ID_AC3,
  254. CODEC_ID_DTS,
  255. CODEC_ID_VORBIS,
  256. CODEC_ID_DVAUDIO,
  257. CODEC_ID_WMAV1,
  258. CODEC_ID_WMAV2,
  259. CODEC_ID_MACE3,
  260. CODEC_ID_MACE6,
  261. CODEC_ID_VMDAUDIO,
  262. CODEC_ID_SONIC,
  263. CODEC_ID_SONIC_LS,
  264. CODEC_ID_FLAC,
  265. CODEC_ID_MP3ADU,
  266. CODEC_ID_MP3ON4,
  267. CODEC_ID_SHORTEN,
  268. CODEC_ID_ALAC,
  269. CODEC_ID_WESTWOOD_SND1,
  270. CODEC_ID_GSM, ///< as in Berlin toast format
  271. CODEC_ID_QDM2,
  272. CODEC_ID_COOK,
  273. CODEC_ID_TRUESPEECH,
  274. CODEC_ID_TTA,
  275. CODEC_ID_SMACKAUDIO,
  276. CODEC_ID_QCELP,
  277. CODEC_ID_WAVPACK,
  278. CODEC_ID_DSICINAUDIO,
  279. CODEC_ID_IMC,
  280. CODEC_ID_MUSEPACK7,
  281. CODEC_ID_MLP,
  282. CODEC_ID_GSM_MS, /* as found in WAV */
  283. CODEC_ID_ATRAC3,
  284. CODEC_ID_VOXWARE,
  285. CODEC_ID_APE,
  286. CODEC_ID_NELLYMOSER,
  287. CODEC_ID_MUSEPACK8,
  288. CODEC_ID_SPEEX,
  289. CODEC_ID_WMAVOICE,
  290. CODEC_ID_WMAPRO,
  291. CODEC_ID_WMALOSSLESS,
  292. CODEC_ID_ATRAC3P,
  293. CODEC_ID_EAC3,
  294. CODEC_ID_SIPR,
  295. /* subtitle codecs */
  296. CODEC_ID_DVD_SUBTITLE= 0x17000,
  297. CODEC_ID_DVB_SUBTITLE,
  298. CODEC_ID_TEXT, ///< raw UTF-8 text
  299. CODEC_ID_XSUB,
  300. CODEC_ID_SSA,
  301. CODEC_ID_MOV_TEXT,
  302. /* other specific kind of codecs (generally used for attachments) */
  303. CODEC_ID_TTF= 0x18000,
  304. CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
  305. CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
  306. * stream (only used by libavformat) */
  307. };
  308. enum CodecType {
  309. CODEC_TYPE_UNKNOWN = -1,
  310. CODEC_TYPE_VIDEO,
  311. CODEC_TYPE_AUDIO,
  312. CODEC_TYPE_DATA,
  313. CODEC_TYPE_SUBTITLE,
  314. CODEC_TYPE_ATTACHMENT,
  315. CODEC_TYPE_NB
  316. };
  317. /**
  318. * all in native-endian format
  319. */
  320. enum SampleFormat {
  321. SAMPLE_FMT_NONE = -1,
  322. SAMPLE_FMT_U8, ///< unsigned 8 bits
  323. SAMPLE_FMT_S16, ///< signed 16 bits
  324. SAMPLE_FMT_S32, ///< signed 32 bits
  325. SAMPLE_FMT_FLT, ///< float
  326. SAMPLE_FMT_DBL, ///< double
  327. SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
  328. };
  329. /* Audio channel masks */
  330. #define CH_FRONT_LEFT 0x00000001
  331. #define CH_FRONT_RIGHT 0x00000002
  332. #define CH_FRONT_CENTER 0x00000004
  333. #define CH_LOW_FREQUENCY 0x00000008
  334. #define CH_BACK_LEFT 0x00000010
  335. #define CH_BACK_RIGHT 0x00000020
  336. #define CH_FRONT_LEFT_OF_CENTER 0x00000040
  337. #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
  338. #define CH_BACK_CENTER 0x00000100
  339. #define CH_SIDE_LEFT 0x00000200
  340. #define CH_SIDE_RIGHT 0x00000400
  341. #define CH_TOP_CENTER 0x00000800
  342. #define CH_TOP_FRONT_LEFT 0x00001000
  343. #define CH_TOP_FRONT_CENTER 0x00002000
  344. #define CH_TOP_FRONT_RIGHT 0x00004000
  345. #define CH_TOP_BACK_LEFT 0x00008000
  346. #define CH_TOP_BACK_CENTER 0x00010000
  347. #define CH_TOP_BACK_RIGHT 0x00020000
  348. #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
  349. #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
  350. /* Audio channel convenience macros */
  351. #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
  352. #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
  353. #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
  354. #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
  355. #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
  356. #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
  357. #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
  358. #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
  359. CH_BACK_LEFT|CH_BACK_RIGHT|\
  360. CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
  361. #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
  362. /* in bytes */
  363. #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
  364. /**
  365. * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
  366. * This is mainly needed because some optimized bitstream readers read
  367. * 32 or 64 bit at once and could read over the end.<br>
  368. * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  369. * MPEG bitstreams could cause overread and segfault.
  370. */
  371. #define FF_INPUT_BUFFER_PADDING_SIZE 8
  372. /**
  373. * minimum encoding buffer size
  374. * Used to avoid some checks during header writing.
  375. */
  376. #define FF_MIN_BUFFER_SIZE 16384
  377. /**
  378. * motion estimation type.
  379. */
  380. enum Motion_Est_ID {
  381. ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
  382. ME_FULL,
  383. ME_LOG,
  384. ME_PHODS,
  385. ME_EPZS, ///< enhanced predictive zonal search
  386. ME_X1, ///< reserved for experiments
  387. ME_HEX, ///< hexagon based search
  388. ME_UMH, ///< uneven multi-hexagon search
  389. ME_ITER, ///< iterative search
  390. ME_TESA, ///< transformed exhaustive search algorithm
  391. };
  392. enum AVDiscard{
  393. /* We leave some space between them for extensions (drop some
  394. * keyframes for intra-only or drop just some bidir frames). */
  395. AVDISCARD_NONE =-16, ///< discard nothing
  396. AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
  397. AVDISCARD_NONREF = 8, ///< discard all non reference
  398. AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
  399. AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
  400. AVDISCARD_ALL = 48, ///< discard all
  401. };
  402. typedef struct RcOverride{
  403. int start_frame;
  404. int end_frame;
  405. int qscale; // If this is 0 then quality_factor will be used instead.
  406. float quality_factor;
  407. } RcOverride;
  408. #define FF_MAX_B_FRAMES 16
  409. /* encoding support
  410. These flags can be passed in AVCodecContext.flags before initialization.
  411. Note: Not everything is supported yet.
  412. */
  413. #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
  414. #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
  415. #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
  416. #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
  417. #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
  418. #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
  419. /**
  420. * The parent program guarantees that the input for B-frames containing
  421. * streams is not written to for at least s->max_b_frames+1 frames, if
  422. * this is not set the input will be copied.
  423. */
  424. #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  425. #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
  426. #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
  427. #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
  428. #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
  429. #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
  430. #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
  431. #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
  432. location instead of only at frame boundaries. */
  433. #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
  434. #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
  435. #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
  436. #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
  437. #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
  438. #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
  439. /* Fx : Flag for h263+ extra options */
  440. #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
  441. #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
  442. #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
  443. #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
  444. #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
  445. #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
  446. #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
  447. #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
  448. #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
  449. #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
  450. #define CODEC_FLAG_CLOSED_GOP 0x80000000
  451. #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
  452. #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
  453. #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
  454. #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
  455. #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
  456. #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
  457. #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
  458. #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
  459. #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
  460. #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
  461. #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
  462. #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
  463. #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
  464. #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
  465. #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
  466. #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
  467. #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
  468. #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
  469. /* Unsupported options :
  470. * Syntax Arithmetic coding (SAC)
  471. * Reference Picture Selection
  472. * Independent Segment Decoding */
  473. /* /Fx */
  474. /* codec capabilities */
  475. #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
  476. /**
  477. * Codec uses get_buffer() for allocating buffers.
  478. * direct rendering method 1
  479. */
  480. #define CODEC_CAP_DR1 0x0002
  481. /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
  482. #define CODEC_CAP_PARSE_ONLY 0x0004
  483. #define CODEC_CAP_TRUNCATED 0x0008
  484. /* Codec can export data for HW decoding (XvMC). */
  485. #define CODEC_CAP_HWACCEL 0x0010
  486. /**
  487. * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
  488. * If this is not set, the codec is guaranteed to never be fed with NULL data.
  489. */
  490. #define CODEC_CAP_DELAY 0x0020
  491. /**
  492. * Codec can be fed a final frame with a smaller size.
  493. * This can be used to prevent truncation of the last audio samples.
  494. */
  495. #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
  496. /**
  497. * Codec can export data for HW decoding (VDPAU).
  498. */
  499. #define CODEC_CAP_HWACCEL_VDPAU 0x0080
  500. //The following defines may change, don't expect compatibility if you use them.
  501. #define MB_TYPE_INTRA4x4 0x0001
  502. #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
  503. #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
  504. #define MB_TYPE_16x16 0x0008
  505. #define MB_TYPE_16x8 0x0010
  506. #define MB_TYPE_8x16 0x0020
  507. #define MB_TYPE_8x8 0x0040
  508. #define MB_TYPE_INTERLACED 0x0080
  509. #define MB_TYPE_DIRECT2 0x0100 //FIXME
  510. #define MB_TYPE_ACPRED 0x0200
  511. #define MB_TYPE_GMC 0x0400
  512. #define MB_TYPE_SKIP 0x0800
  513. #define MB_TYPE_P0L0 0x1000
  514. #define MB_TYPE_P1L0 0x2000
  515. #define MB_TYPE_P0L1 0x4000
  516. #define MB_TYPE_P1L1 0x8000
  517. #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
  518. #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
  519. #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
  520. #define MB_TYPE_QUANT 0x00010000
  521. #define MB_TYPE_CBP 0x00020000
  522. //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
  523. /**
  524. * Pan Scan area.
  525. * This specifies the area which should be displayed.
  526. * Note there may be multiple such areas for one frame.
  527. */
  528. typedef struct AVPanScan{
  529. /**
  530. * id
  531. * - encoding: Set by user.
  532. * - decoding: Set by libavcodec.
  533. */
  534. int id;
  535. /**
  536. * width and height in 1/16 pel
  537. * - encoding: Set by user.
  538. * - decoding: Set by libavcodec.
  539. */
  540. int width;
  541. int height;
  542. /**
  543. * position of the top left corner in 1/16 pel for up to 3 fields/frames
  544. * - encoding: Set by user.
  545. * - decoding: Set by libavcodec.
  546. */
  547. int16_t position[3][2];
  548. }AVPanScan;
  549. #define FF_COMMON_FRAME \
  550. /**\
  551. * pointer to the picture planes.\
  552. * This might be different from the first allocated byte\
  553. * - encoding: \
  554. * - decoding: \
  555. */\
  556. uint8_t *data[4];\
  557. int linesize[4];\
  558. /**\
  559. * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
  560. * This isn't used by libavcodec unless the default get/release_buffer() is used.\
  561. * - encoding: \
  562. * - decoding: \
  563. */\
  564. uint8_t *base[4];\
  565. /**\
  566. * 1 -> keyframe, 0-> not\
  567. * - encoding: Set by libavcodec.\
  568. * - decoding: Set by libavcodec.\
  569. */\
  570. int key_frame;\
  571. \
  572. /**\
  573. * Picture type of the frame, see ?_TYPE below.\
  574. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
  575. * - decoding: Set by libavcodec.\
  576. */\
  577. int pict_type;\
  578. \
  579. /**\
  580. * presentation timestamp in time_base units (time when frame should be shown to user)\
  581. * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
  582. * - encoding: MUST be set by user.\
  583. * - decoding: Set by libavcodec.\
  584. */\
  585. int64_t pts;\
  586. \
  587. /**\
  588. * picture number in bitstream order\
  589. * - encoding: set by\
  590. * - decoding: Set by libavcodec.\
  591. */\
  592. int coded_picture_number;\
  593. /**\
  594. * picture number in display order\
  595. * - encoding: set by\
  596. * - decoding: Set by libavcodec.\
  597. */\
  598. int display_picture_number;\
  599. \
  600. /**\
  601. * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
  602. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
  603. * - decoding: Set by libavcodec.\
  604. */\
  605. int quality; \
  606. \
  607. /**\
  608. * buffer age (1->was last buffer and dint change, 2->..., ...).\
  609. * Set to INT_MAX if the buffer has not been used yet.\
  610. * - encoding: unused\
  611. * - decoding: MUST be set by get_buffer().\
  612. */\
  613. int age;\
  614. \
  615. /**\
  616. * is this picture used as reference\
  617. * The values for this are the same as the MpegEncContext.picture_structure\
  618. * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
  619. * - encoding: unused\
  620. * - decoding: Set by libavcodec. (before get_buffer() call)).\
  621. */\
  622. int reference;\
  623. \
  624. /**\
  625. * QP table\
  626. * - encoding: unused\
  627. * - decoding: Set by libavcodec.\
  628. */\
  629. int8_t *qscale_table;\
  630. /**\
  631. * QP store stride\
  632. * - encoding: unused\
  633. * - decoding: Set by libavcodec.\
  634. */\
  635. int qstride;\
  636. \
  637. /**\
  638. * mbskip_table[mb]>=1 if MB didn't change\
  639. * stride= mb_width = (width+15)>>4\
  640. * - encoding: unused\
  641. * - decoding: Set by libavcodec.\
  642. */\
  643. uint8_t *mbskip_table;\
  644. \
  645. /**\
  646. * motion vector table\
  647. * @code\
  648. * example:\
  649. * int mv_sample_log2= 4 - motion_subsample_log2;\
  650. * int mb_width= (width+15)>>4;\
  651. * int mv_stride= (mb_width << mv_sample_log2) + 1;\
  652. * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
  653. * @endcode\
  654. * - encoding: Set by user.\
  655. * - decoding: Set by libavcodec.\
  656. */\
  657. int16_t (*motion_val[2])[2];\
  658. \
  659. /**\
  660. * macroblock type table\
  661. * mb_type_base + mb_width + 2\
  662. * - encoding: Set by user.\
  663. * - decoding: Set by libavcodec.\
  664. */\
  665. uint32_t *mb_type;\
  666. \
  667. /**\
  668. * log2 of the size of the block which a single vector in motion_val represents: \
  669. * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
  670. * - encoding: unused\
  671. * - decoding: Set by libavcodec.\
  672. */\
  673. uint8_t motion_subsample_log2;\
  674. \
  675. /**\
  676. * for some private data of the user\
  677. * - encoding: unused\
  678. * - decoding: Set by user.\
  679. */\
  680. void *opaque;\
  681. \
  682. /**\
  683. * error\
  684. * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
  685. * - decoding: unused\
  686. */\
  687. uint64_t error[4];\
  688. \
  689. /**\
  690. * type of the buffer (to keep track of who has to deallocate data[*])\
  691. * - encoding: Set by the one who allocates it.\
  692. * - decoding: Set by the one who allocates it.\
  693. * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
  694. */\
  695. int type;\
  696. \
  697. /**\
  698. * When decoding, this signals how much the picture must be delayed.\
  699. * extra_delay = repeat_pict / (2*fps)\
  700. * - encoding: unused\
  701. * - decoding: Set by libavcodec.\
  702. */\
  703. int repeat_pict;\
  704. \
  705. /**\
  706. * \
  707. */\
  708. int qscale_type;\
  709. \
  710. /**\
  711. * The content of the picture is interlaced.\
  712. * - encoding: Set by user.\
  713. * - decoding: Set by libavcodec. (default 0)\
  714. */\
  715. int interlaced_frame;\
  716. \
  717. /**\
  718. * If the content is interlaced, is top field displayed first.\
  719. * - encoding: Set by user.\
  720. * - decoding: Set by libavcodec.\
  721. */\
  722. int top_field_first;\
  723. \
  724. /**\
  725. * Pan scan.\
  726. * - encoding: Set by user.\
  727. * - decoding: Set by libavcodec.\
  728. */\
  729. AVPanScan *pan_scan;\
  730. \
  731. /**\
  732. * Tell user application that palette has changed from previous frame.\
  733. * - encoding: ??? (no palette-enabled encoder yet)\
  734. * - decoding: Set by libavcodec. (default 0).\
  735. */\
  736. int palette_has_changed;\
  737. \
  738. /**\
  739. * codec suggestion on buffer type if != 0\
  740. * - encoding: unused\
  741. * - decoding: Set by libavcodec. (before get_buffer() call)).\
  742. */\
  743. int buffer_hints;\
  744. \
  745. /**\
  746. * DCT coefficients\
  747. * - encoding: unused\
  748. * - decoding: Set by libavcodec.\
  749. */\
  750. short *dct_coeff;\
  751. \
  752. /**\
  753. * motion referece frame index\
  754. * - encoding: Set by user.\
  755. * - decoding: Set by libavcodec.\
  756. */\
  757. int8_t *ref_index[2];\
  758. \
  759. /**\
  760. * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
  761. * output in AVFrame.reordered_opaque\
  762. * - encoding: unused\
  763. * - decoding: Read by user.\
  764. */\
  765. int64_t reordered_opaque;\
  766. #define FF_QSCALE_TYPE_MPEG1 0
  767. #define FF_QSCALE_TYPE_MPEG2 1
  768. #define FF_QSCALE_TYPE_H264 2
  769. #define FF_BUFFER_TYPE_INTERNAL 1
  770. #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
  771. #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
  772. #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
  773. #define FF_I_TYPE 1 ///< Intra
  774. #define FF_P_TYPE 2 ///< Predicted
  775. #define FF_B_TYPE 3 ///< Bi-dir predicted
  776. #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
  777. #define FF_SI_TYPE 5 ///< Switching Intra
  778. #define FF_SP_TYPE 6 ///< Switching Predicted
  779. #define FF_BI_TYPE 7
  780. #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
  781. #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
  782. #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
  783. #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
  784. /**
  785. * Audio Video Frame.
  786. * New fields can be added to the end of FF_COMMON_FRAME with minor version
  787. * bumps.
  788. * Removal, reordering and changes to existing fields require a major
  789. * version bump. No fields should be added into AVFrame before or after
  790. * FF_COMMON_FRAME!
  791. * sizeof(AVFrame) must not be used outside libav*.
  792. */
  793. typedef struct AVFrame {
  794. FF_COMMON_FRAME
  795. } AVFrame;
  796. /**
  797. * main external API structure.
  798. * New fields can be added to the end with minor version bumps.
  799. * Removal, reordering and changes to existing fields require a major
  800. * version bump.
  801. * sizeof(AVCodecContext) must not be used outside libav*.
  802. */
  803. typedef struct AVCodecContext {
  804. /**
  805. * information on struct for av_log
  806. * - set by avcodec_alloc_context
  807. */
  808. const AVClass *av_class;
  809. /**
  810. * the average bitrate
  811. * - encoding: Set by user; unused for constant quantizer encoding.
  812. * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
  813. */
  814. int bit_rate;
  815. /**
  816. * number of bits the bitstream is allowed to diverge from the reference.
  817. * the reference can be CBR (for CBR pass1) or VBR (for pass2)
  818. * - encoding: Set by user; unused for constant quantizer encoding.
  819. * - decoding: unused
  820. */
  821. int bit_rate_tolerance;
  822. /**
  823. * CODEC_FLAG_*.
  824. * - encoding: Set by user.
  825. * - decoding: Set by user.
  826. */
  827. int flags;
  828. /**
  829. * Some codecs need additional format info. It is stored here.
  830. * If any muxer uses this then ALL demuxers/parsers AND encoders for the
  831. * specific codec MUST set it correctly otherwise stream copy breaks.
  832. * In general use of this field by muxers is not recommanded.
  833. * - encoding: Set by libavcodec.
  834. * - decoding: Set by libavcodec. (FIXME: Is this OK?)
  835. */
  836. int sub_id;
  837. /**
  838. * Motion estimation algorithm used for video coding.
  839. * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
  840. * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
  841. * - encoding: MUST be set by user.
  842. * - decoding: unused
  843. */
  844. int me_method;
  845. /**
  846. * some codecs need / can use extradata like Huffman tables.
  847. * mjpeg: Huffman tables
  848. * rv10: additional flags
  849. * mpeg4: global headers (they can be in the bitstream or here)
  850. * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
  851. * than extradata_size to avoid prolems if it is read with the bitstream reader.
  852. * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
  853. * - encoding: Set/allocated/freed by libavcodec.
  854. * - decoding: Set/allocated/freed by user.
  855. */
  856. uint8_t *extradata;
  857. int extradata_size;
  858. /**
  859. * This is the fundamental unit of time (in seconds) in terms
  860. * of which frame timestamps are represented. For fixed-fps content,
  861. * timebase should be 1/framerate and timestamp increments should be
  862. * identically 1.
  863. * - encoding: MUST be set by user.
  864. * - decoding: Set by libavcodec.
  865. */
  866. AVRational time_base;
  867. /* video only */
  868. /**
  869. * picture width / height.
  870. * - encoding: MUST be set by user.
  871. * - decoding: Set by libavcodec.
  872. * Note: For compatibility it is possible to set this instead of
  873. * coded_width/height before decoding.
  874. */
  875. int width, height;
  876. #define FF_ASPECT_EXTENDED 15
  877. /**
  878. * the number of pictures in a group of pictures, or 0 for intra_only
  879. * - encoding: Set by user.
  880. * - decoding: unused
  881. */
  882. int gop_size;
  883. /**
  884. * Pixel format, see PIX_FMT_xxx.
  885. * - encoding: Set by user.
  886. * - decoding: Set by libavcodec.
  887. */
  888. enum PixelFormat pix_fmt;
  889. /**
  890. * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
  891. * has to read frames at native frame rate.
  892. * - encoding: Set by user.
  893. * - decoding: unused
  894. */
  895. int rate_emu;
  896. /**
  897. * If non NULL, 'draw_horiz_band' is called by the libavcodec
  898. * decoder to draw a horizontal band. It improves cache usage. Not
  899. * all codecs can do that. You must check the codec capabilities
  900. * beforehand.
  901. * - encoding: unused
  902. * - decoding: Set by user.
  903. * @param height the height of the slice
  904. * @param y the y position of the slice
  905. * @param type 1->top field, 2->bottom field, 3->frame
  906. * @param offset offset into the AVFrame.data from which the slice should be read
  907. */
  908. void (*draw_horiz_band)(struct AVCodecContext *s,
  909. const AVFrame *src, int offset[4],
  910. int y, int type, int height);
  911. /* audio only */
  912. int sample_rate; ///< samples per second
  913. int channels; ///< number of audio channels
  914. /**
  915. * audio sample format
  916. * - encoding: Set by user.
  917. * - decoding: Set by libavcodec.
  918. */
  919. enum SampleFormat sample_fmt; ///< sample format, currently unused
  920. /* The following data should not be initialized. */
  921. /**
  922. * Samples per packet, initialized when calling 'init'.
  923. */
  924. int frame_size;
  925. int frame_number; ///< audio or video frame number
  926. int real_pict_num; ///< Returns the real picture number of previous encoded frame.
  927. /**
  928. * Number of frames the decoded output will be delayed relative to
  929. * the encoded input.
  930. * - encoding: Set by libavcodec.
  931. * - decoding: unused
  932. */
  933. int delay;
  934. /* - encoding parameters */
  935. float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
  936. float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
  937. /**
  938. * minimum quantizer
  939. * - encoding: Set by user.
  940. * - decoding: unused
  941. */
  942. int qmin;
  943. /**
  944. * maximum quantizer
  945. * - encoding: Set by user.
  946. * - decoding: unused
  947. */
  948. int qmax;
  949. /**
  950. * maximum quantizer difference between frames
  951. * - encoding: Set by user.
  952. * - decoding: unused
  953. */
  954. int max_qdiff;
  955. /**
  956. * maximum number of B-frames between non-B-frames
  957. * Note: The output will be delayed by max_b_frames+1 relative to the input.
  958. * - encoding: Set by user.
  959. * - decoding: unused
  960. */
  961. int max_b_frames;
  962. /**
  963. * qscale factor between IP and B-frames
  964. * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
  965. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  966. * - encoding: Set by user.
  967. * - decoding: unused
  968. */
  969. float b_quant_factor;
  970. /** obsolete FIXME remove */
  971. int rc_strategy;
  972. #define FF_RC_STRATEGY_XVID 1
  973. int b_frame_strategy;
  974. /**
  975. * hurry up amount
  976. * - encoding: unused
  977. * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
  978. * @deprecated Deprecated in favor of skip_idct and skip_frame.
  979. */
  980. int hurry_up;
  981. struct AVCodec *codec;
  982. void *priv_data;
  983. int rtp_payload_size; /* The size of the RTP payload: the coder will */
  984. /* do its best to deliver a chunk with size */
  985. /* below rtp_payload_size, the chunk will start */
  986. /* with a start code on some codecs like H.263. */
  987. /* This doesn't take account of any particular */
  988. /* headers inside the transmitted RTP payload. */
  989. /* The RTP callback: This function is called */
  990. /* every time the encoder has a packet to send. */
  991. /* It depends on the encoder if the data starts */
  992. /* with a Start Code (it should). H.263 does. */
  993. /* mb_nb contains the number of macroblocks */
  994. /* encoded in the RTP payload. */
  995. void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
  996. /* statistics, used for 2-pass encoding */
  997. int mv_bits;
  998. int header_bits;
  999. int i_tex_bits;
  1000. int p_tex_bits;
  1001. int i_count;
  1002. int p_count;
  1003. int skip_count;
  1004. int misc_bits;
  1005. /**
  1006. * number of bits used for the previously encoded frame
  1007. * - encoding: Set by libavcodec.
  1008. * - decoding: unused
  1009. */
  1010. int frame_bits;
  1011. /**
  1012. * Private data of the user, can be used to carry app specific stuff.
  1013. * - encoding: Set by user.
  1014. * - decoding: Set by user.
  1015. */
  1016. void *opaque;
  1017. char codec_name[32];
  1018. enum CodecType codec_type; /* see CODEC_TYPE_xxx */
  1019. enum CodecID codec_id; /* see CODEC_ID_xxx */
  1020. /**
  1021. * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1022. * This is used to work around some encoder bugs.
  1023. * A demuxer should set this to what is stored in the field used to identify the codec.
  1024. * If there are multiple such fields in a container then the demuxer should choose the one
  1025. * which maximizes the information about the used codec.
  1026. * If the codec tag field in a container is larger then 32 bits then the demuxer should
  1027. * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
  1028. * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
  1029. * first.
  1030. * - encoding: Set by user, if not then the default based on codec_id will be used.
  1031. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1032. */
  1033. unsigned int codec_tag;
  1034. /**
  1035. * Work around bugs in encoders which sometimes cannot be detected automatically.
  1036. * - encoding: Set by user
  1037. * - decoding: Set by user
  1038. */
  1039. int workaround_bugs;
  1040. #define FF_BUG_AUTODETECT 1 ///< autodetection
  1041. #define FF_BUG_OLD_MSMPEG4 2
  1042. #define FF_BUG_XVID_ILACE 4
  1043. #define FF_BUG_UMP4 8
  1044. #define FF_BUG_NO_PADDING 16
  1045. #define FF_BUG_AMV 32
  1046. #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
  1047. #define FF_BUG_QPEL_CHROMA 64
  1048. #define FF_BUG_STD_QPEL 128
  1049. #define FF_BUG_QPEL_CHROMA2 256
  1050. #define FF_BUG_DIRECT_BLOCKSIZE 512
  1051. #define FF_BUG_EDGE 1024
  1052. #define FF_BUG_HPEL_CHROMA 2048
  1053. #define FF_BUG_DC_CLIP 4096
  1054. #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
  1055. //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
  1056. /**
  1057. * luma single coefficient elimination threshold
  1058. * - encoding: Set by user.
  1059. * - decoding: unused
  1060. */
  1061. int luma_elim_threshold;
  1062. /**
  1063. * chroma single coeff elimination threshold
  1064. * - encoding: Set by user.
  1065. * - decoding: unused
  1066. */
  1067. int chroma_elim_threshold;
  1068. /**
  1069. * strictly follow the standard (MPEG4, ...).
  1070. * - encoding: Set by user.
  1071. * - decoding: Set by user.
  1072. * Setting this to STRICT or higher means the encoder and decoder will
  1073. * generally do stupid things. While setting it to inofficial or lower
  1074. * will mean the encoder might use things that are not supported by all
  1075. * spec compliant decoders. Decoders make no difference between normal,
  1076. * inofficial and experimental, that is they always try to decode things
  1077. * when they can unless they are explicitly asked to behave stupid
  1078. * (=strictly conform to the specs)
  1079. */
  1080. int strict_std_compliance;
  1081. #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
  1082. #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
  1083. #define FF_COMPLIANCE_NORMAL 0
  1084. #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
  1085. #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
  1086. /**
  1087. * qscale offset between IP and B-frames
  1088. * - encoding: Set by user.
  1089. * - decoding: unused
  1090. */
  1091. float b_quant_offset;
  1092. /**
  1093. * Error recognization; higher values will detect more errors but may
  1094. * misdetect some more or less valid parts as errors.
  1095. * - encoding: unused
  1096. * - decoding: Set by user.
  1097. */
  1098. int error_recognition;
  1099. #define FF_ER_CAREFUL 1
  1100. #define FF_ER_COMPLIANT 2
  1101. #define FF_ER_AGGRESSIVE 3
  1102. #define FF_ER_VERY_AGGRESSIVE 4
  1103. /**
  1104. * Called at the beginning of each frame to get a buffer for it.
  1105. * If pic.reference is set then the frame will be read later by libavcodec.
  1106. * avcodec_align_dimensions() should be used to find the required width and
  1107. * height, as they normally need to be rounded up to the next multiple of 16.
  1108. * - encoding: unused
  1109. * - decoding: Set by libavcodec., user can override.
  1110. */
  1111. int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1112. /**
  1113. * Called to release buffers which were allocated with get_buffer.
  1114. * A released buffer can be reused in get_buffer().
  1115. * pic.data[*] must be set to NULL.
  1116. * - encoding: unused
  1117. * - decoding: Set by libavcodec., user can override.
  1118. */
  1119. void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1120. /**
  1121. * If 1 the stream has a 1 frame delay during decoding.
  1122. * - encoding: Set by libavcodec.
  1123. * - decoding: Set by libavcodec.
  1124. */
  1125. int has_b_frames;
  1126. /**
  1127. * number of bytes per packet if constant and known or 0
  1128. * Used by some WAV based audio codecs.
  1129. */
  1130. int block_align;
  1131. int parse_only; /* - decoding only: If true, only parsing is done
  1132. (function avcodec_parse_frame()). The frame
  1133. data is returned. Only MPEG codecs support this now. */
  1134. /**
  1135. * 0-> h263 quant 1-> mpeg quant
  1136. * - encoding: Set by user.
  1137. * - decoding: unused
  1138. */
  1139. int mpeg_quant;
  1140. /**
  1141. * pass1 encoding statistics output buffer
  1142. * - encoding: Set by libavcodec.
  1143. * - decoding: unused
  1144. */
  1145. char *stats_out;
  1146. /**
  1147. * pass2 encoding statistics input buffer
  1148. * Concatenated stuff from stats_out of pass1 should be placed here.
  1149. * - encoding: Allocated/set/freed by user.
  1150. * - decoding: unused
  1151. */
  1152. char *stats_in;
  1153. /**
  1154. * ratecontrol qmin qmax limiting method
  1155. * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
  1156. * - encoding: Set by user.
  1157. * - decoding: unused
  1158. */
  1159. float rc_qsquish;
  1160. float rc_qmod_amp;
  1161. int rc_qmod_freq;
  1162. /**
  1163. * ratecontrol override, see RcOverride
  1164. * - encoding: Allocated/set/freed by user.
  1165. * - decoding: unused
  1166. */
  1167. RcOverride *rc_override;
  1168. int rc_override_count;
  1169. /**
  1170. * rate control equation
  1171. * - encoding: Set by user
  1172. * - decoding: unused
  1173. */
  1174. const char *rc_eq;
  1175. /**
  1176. * maximum bitrate
  1177. * - encoding: Set by user.
  1178. * - decoding: unused
  1179. */
  1180. int rc_max_rate;
  1181. /**
  1182. * minimum bitrate
  1183. * - encoding: Set by user.
  1184. * - decoding: unused
  1185. */
  1186. int rc_min_rate;
  1187. /**
  1188. * decoder bitstream buffer size
  1189. * - encoding: Set by user.
  1190. * - decoding: unused
  1191. */
  1192. int rc_buffer_size;
  1193. float rc_buffer_aggressivity;
  1194. /**
  1195. * qscale factor between P and I-frames
  1196. * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
  1197. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1198. * - encoding: Set by user.
  1199. * - decoding: unused
  1200. */
  1201. float i_quant_factor;
  1202. /**
  1203. * qscale offset between P and I-frames
  1204. * - encoding: Set by user.
  1205. * - decoding: unused
  1206. */
  1207. float i_quant_offset;
  1208. /**
  1209. * initial complexity for pass1 ratecontrol
  1210. * - encoding: Set by user.
  1211. * - decoding: unused
  1212. */
  1213. float rc_initial_cplx;
  1214. /**
  1215. * DCT algorithm, see FF_DCT_* below
  1216. * - encoding: Set by user.
  1217. * - decoding: unused
  1218. */
  1219. int dct_algo;
  1220. #define FF_DCT_AUTO 0
  1221. #define FF_DCT_FASTINT 1
  1222. #define FF_DCT_INT 2
  1223. #define FF_DCT_MMX 3
  1224. #define FF_DCT_MLIB 4
  1225. #define FF_DCT_ALTIVEC 5
  1226. #define FF_DCT_FAAN 6
  1227. /**
  1228. * luminance masking (0-> disabled)
  1229. * - encoding: Set by user.
  1230. * - decoding: unused
  1231. */
  1232. float lumi_masking;
  1233. /**
  1234. * temporary complexity masking (0-> disabled)
  1235. * - encoding: Set by user.
  1236. * - decoding: unused
  1237. */
  1238. float temporal_cplx_masking;
  1239. /**
  1240. * spatial complexity masking (0-> disabled)
  1241. * - encoding: Set by user.
  1242. * - decoding: unused
  1243. */
  1244. float spatial_cplx_masking;
  1245. /**
  1246. * p block masking (0-> disabled)
  1247. * - encoding: Set by user.
  1248. * - decoding: unused
  1249. */
  1250. float p_masking;
  1251. /**
  1252. * darkness masking (0-> disabled)
  1253. * - encoding: Set by user.
  1254. * - decoding: unused
  1255. */
  1256. float dark_masking;
  1257. /**
  1258. * IDCT algorithm, see FF_IDCT_* below.
  1259. * - encoding: Set by user.
  1260. * - decoding: Set by user.
  1261. */
  1262. int idct_algo;
  1263. #define FF_IDCT_AUTO 0
  1264. #define FF_IDCT_INT 1
  1265. #define FF_IDCT_SIMPLE 2
  1266. #define FF_IDCT_SIMPLEMMX 3
  1267. #define FF_IDCT_LIBMPEG2MMX 4
  1268. #define FF_IDCT_PS2 5
  1269. #define FF_IDCT_MLIB 6
  1270. #define FF_IDCT_ARM 7
  1271. #define FF_IDCT_ALTIVEC 8
  1272. #define FF_IDCT_SH4 9
  1273. #define FF_IDCT_SIMPLEARM 10
  1274. #define FF_IDCT_H264 11
  1275. #define FF_IDCT_VP3 12
  1276. #define FF_IDCT_IPP 13
  1277. #define FF_IDCT_XVIDMMX 14
  1278. #define FF_IDCT_CAVS 15
  1279. #define FF_IDCT_SIMPLEARMV5TE 16
  1280. #define FF_IDCT_SIMPLEARMV6 17
  1281. #define FF_IDCT_SIMPLEVIS 18
  1282. #define FF_IDCT_WMV2 19
  1283. #define FF_IDCT_FAAN 20
  1284. #define FF_IDCT_EA 21
  1285. #define FF_IDCT_SIMPLENEON 22
  1286. /**
  1287. * slice count
  1288. * - encoding: Set by libavcodec.
  1289. * - decoding: Set by user (or 0).
  1290. */
  1291. int slice_count;
  1292. /**
  1293. * slice offsets in the frame in bytes
  1294. * - encoding: Set/allocated by libavcodec.
  1295. * - decoding: Set/allocated by user (or NULL).
  1296. */
  1297. int *slice_offset;
  1298. /**
  1299. * error concealment flags
  1300. * - encoding: unused
  1301. * - decoding: Set by user.
  1302. */
  1303. int error_concealment;
  1304. #define FF_EC_GUESS_MVS 1
  1305. #define FF_EC_DEBLOCK 2
  1306. /**
  1307. * dsp_mask could be add used to disable unwanted CPU features
  1308. * CPU features (i.e. MMX, SSE. ...)
  1309. *
  1310. * With the FORCE flag you may instead enable given CPU features.
  1311. * (Dangerous: Usable in case of misdetection, improper usage however will
  1312. * result into program crash.)
  1313. */
  1314. unsigned dsp_mask;
  1315. #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
  1316. /* lower 16 bits - CPU features */
  1317. #define FF_MM_MMX 0x0001 ///< standard MMX
  1318. #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
  1319. #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
  1320. #define FF_MM_SSE 0x0008 ///< SSE functions
  1321. #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
  1322. #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
  1323. #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
  1324. #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
  1325. #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
  1326. #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
  1327. /**
  1328. * bits per sample/pixel from the demuxer (needed for huffyuv).
  1329. * - encoding: Set by libavcodec.
  1330. * - decoding: Set by user.
  1331. */
  1332. int bits_per_coded_sample;
  1333. /**
  1334. * prediction method (needed for huffyuv)
  1335. * - encoding: Set by user.
  1336. * - decoding: unused
  1337. */
  1338. int prediction_method;
  1339. #define FF_PRED_LEFT 0
  1340. #define FF_PRED_PLANE 1
  1341. #define FF_PRED_MEDIAN 2
  1342. /**
  1343. * sample aspect ratio (0 if unknown)
  1344. * That is the width of a pixel divided by the height of the pixel.
  1345. * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
  1346. * - encoding: Set by user.
  1347. * - decoding: Set by libavcodec.
  1348. */
  1349. AVRational sample_aspect_ratio;
  1350. /**
  1351. * the picture in the bitstream
  1352. * - encoding: Set by libavcodec.
  1353. * - decoding: Set by libavcodec.
  1354. */
  1355. AVFrame *coded_frame;
  1356. /**
  1357. * debug
  1358. * - encoding: Set by user.
  1359. * - decoding: Set by user.
  1360. */
  1361. int debug;
  1362. #define FF_DEBUG_PICT_INFO 1
  1363. #define FF_DEBUG_RC 2
  1364. #define FF_DEBUG_BITSTREAM 4
  1365. #define FF_DEBUG_MB_TYPE 8
  1366. #define FF_DEBUG_QP 16
  1367. #define FF_DEBUG_MV 32
  1368. #define FF_DEBUG_DCT_COEFF 0x00000040
  1369. #define FF_DEBUG_SKIP 0x00000080
  1370. #define FF_DEBUG_STARTCODE 0x00000100
  1371. #define FF_DEBUG_PTS 0x00000200
  1372. #define FF_DEBUG_ER 0x00000400
  1373. #define FF_DEBUG_MMCO 0x00000800
  1374. #define FF_DEBUG_BUGS 0x00001000
  1375. #define FF_DEBUG_VIS_QP 0x00002000
  1376. #define FF_DEBUG_VIS_MB_TYPE 0x00004000
  1377. #define FF_DEBUG_BUFFERS 0x00008000
  1378. /**
  1379. * debug
  1380. * - encoding: Set by user.
  1381. * - decoding: Set by user.
  1382. */
  1383. int debug_mv;
  1384. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
  1385. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
  1386. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
  1387. /**
  1388. * error
  1389. * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
  1390. * - decoding: unused
  1391. */
  1392. uint64_t error[4];
  1393. /**
  1394. * minimum MB quantizer
  1395. * - encoding: unused
  1396. * - decoding: unused
  1397. */
  1398. int mb_qmin;
  1399. /**
  1400. * maximum MB quantizer
  1401. * - encoding: unused
  1402. * - decoding: unused
  1403. */
  1404. int mb_qmax;
  1405. /**
  1406. * motion estimation comparison function
  1407. * - encoding: Set by user.
  1408. * - decoding: unused
  1409. */
  1410. int me_cmp;
  1411. /**
  1412. * subpixel motion estimation comparison function
  1413. * - encoding: Set by user.
  1414. * - decoding: unused
  1415. */
  1416. int me_sub_cmp;
  1417. /**
  1418. * macroblock comparison function (not supported yet)
  1419. * - encoding: Set by user.
  1420. * - decoding: unused
  1421. */
  1422. int mb_cmp;
  1423. /**
  1424. * interlaced DCT comparison function
  1425. * - encoding: Set by user.
  1426. * - decoding: unused
  1427. */
  1428. int ildct_cmp;
  1429. #define FF_CMP_SAD 0
  1430. #define FF_CMP_SSE 1
  1431. #define FF_CMP_SATD 2
  1432. #define FF_CMP_DCT 3
  1433. #define FF_CMP_PSNR 4
  1434. #define FF_CMP_BIT 5
  1435. #define FF_CMP_RD 6
  1436. #define FF_CMP_ZERO 7
  1437. #define FF_CMP_VSAD 8
  1438. #define FF_CMP_VSSE 9
  1439. #define FF_CMP_NSSE 10
  1440. #define FF_CMP_W53 11
  1441. #define FF_CMP_W97 12
  1442. #define FF_CMP_DCTMAX 13
  1443. #define FF_CMP_DCT264 14
  1444. #define FF_CMP_CHROMA 256
  1445. /**
  1446. * ME diamond size & shape
  1447. * - encoding: Set by user.
  1448. * - decoding: unused
  1449. */
  1450. int dia_size;
  1451. /**
  1452. * amount of previous MV predictors (2a+1 x 2a+1 square)
  1453. * - encoding: Set by user.
  1454. * - decoding: unused
  1455. */
  1456. int last_predictor_count;
  1457. /**
  1458. * prepass for motion estimation
  1459. * - encoding: Set by user.
  1460. * - decoding: unused
  1461. */
  1462. int pre_me;
  1463. /**
  1464. * motion estimation prepass comparison function
  1465. * - encoding: Set by user.
  1466. * - decoding: unused
  1467. */
  1468. int me_pre_cmp;
  1469. /**
  1470. * ME prepass diamond size & shape
  1471. * - encoding: Set by user.
  1472. * - decoding: unused
  1473. */
  1474. int pre_dia_size;
  1475. /**
  1476. * subpel ME quality
  1477. * - encoding: Set by user.
  1478. * - decoding: unused
  1479. */
  1480. int me_subpel_quality;
  1481. /**
  1482. * callback to negotiate the pixelFormat
  1483. * @param fmt is the list of formats which are supported by the codec,
  1484. * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
  1485. * The first is always the native one.
  1486. * @return the chosen format
  1487. * - encoding: unused
  1488. * - decoding: Set by user, if not set the native format will be chosen.
  1489. */
  1490. enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
  1491. /**
  1492. * DTG active format information (additional aspect ratio
  1493. * information only used in DVB MPEG-2 transport streams)
  1494. * 0 if not set.
  1495. *
  1496. * - encoding: unused
  1497. * - decoding: Set by decoder.
  1498. */
  1499. int dtg_active_format;
  1500. #define FF_DTG_AFD_SAME 8
  1501. #define FF_DTG_AFD_4_3 9
  1502. #define FF_DTG_AFD_16_9 10
  1503. #define FF_DTG_AFD_14_9 11
  1504. #define FF_DTG_AFD_4_3_SP_14_9 13
  1505. #define FF_DTG_AFD_16_9_SP_14_9 14
  1506. #define FF_DTG_AFD_SP_4_3 15
  1507. /**
  1508. * maximum motion estimation search range in subpel units
  1509. * If 0 then no limit.
  1510. *
  1511. * - encoding: Set by user.
  1512. * - decoding: unused
  1513. */
  1514. int me_range;
  1515. /**
  1516. * intra quantizer bias
  1517. * - encoding: Set by user.
  1518. * - decoding: unused
  1519. */
  1520. int intra_quant_bias;
  1521. #define FF_DEFAULT_QUANT_BIAS 999999
  1522. /**
  1523. * inter quantizer bias
  1524. * - encoding: Set by user.
  1525. * - decoding: unused
  1526. */
  1527. int inter_quant_bias;
  1528. /**
  1529. * color table ID
  1530. * - encoding: unused
  1531. * - decoding: Which clrtable should be used for 8bit RGB images.
  1532. * Tables have to be stored somewhere. FIXME
  1533. */
  1534. int color_table_id;
  1535. /**
  1536. * internal_buffer count
  1537. * Don't touch, used by libavcodec default_get_buffer().
  1538. */
  1539. int internal_buffer_count;
  1540. /**
  1541. * internal_buffers
  1542. * Don't touch, used by libavcodec default_get_buffer().
  1543. */
  1544. void *internal_buffer;
  1545. #define FF_LAMBDA_SHIFT 7
  1546. #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
  1547. #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
  1548. #define FF_LAMBDA_MAX (256*128-1)
  1549. #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
  1550. /**
  1551. * Global quality for codecs which cannot change it per frame.
  1552. * This should be proportional to MPEG-1/2/4 qscale.
  1553. * - encoding: Set by user.
  1554. * - decoding: unused
  1555. */
  1556. int global_quality;
  1557. #define FF_CODER_TYPE_VLC 0
  1558. #define FF_CODER_TYPE_AC 1
  1559. #define FF_CODER_TYPE_RAW 2
  1560. #define FF_CODER_TYPE_RLE 3
  1561. #define FF_CODER_TYPE_DEFLATE 4
  1562. /**
  1563. * coder type
  1564. * - encoding: Set by user.
  1565. * - decoding: unused
  1566. */
  1567. int coder_type;
  1568. /**
  1569. * context model
  1570. * - encoding: Set by user.
  1571. * - decoding: unused
  1572. */
  1573. int context_model;
  1574. #if 0
  1575. /**
  1576. *
  1577. * - encoding: unused
  1578. * - decoding: Set by user.
  1579. */
  1580. uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
  1581. #endif
  1582. /**
  1583. * slice flags
  1584. * - encoding: unused
  1585. * - decoding: Set by user.
  1586. */
  1587. int slice_flags;
  1588. #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
  1589. #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
  1590. #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
  1591. /**
  1592. * XVideo Motion Acceleration
  1593. * - encoding: forbidden
  1594. * - decoding: set by decoder
  1595. */
  1596. int xvmc_acceleration;
  1597. /**
  1598. * macroblock decision mode
  1599. * - encoding: Set by user.
  1600. * - decoding: unused
  1601. */
  1602. int mb_decision;
  1603. #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
  1604. #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
  1605. #define FF_MB_DECISION_RD 2 ///< rate distortion
  1606. /**
  1607. * custom intra quantization matrix
  1608. * - encoding: Set by user, can be NULL.
  1609. * - decoding: Set by libavcodec.
  1610. */
  1611. uint16_t *intra_matrix;
  1612. /**
  1613. * custom inter quantization matrix
  1614. * - encoding: Set by user, can be NULL.
  1615. * - decoding: Set by libavcodec.
  1616. */
  1617. uint16_t *inter_matrix;
  1618. /**
  1619. * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1620. * This is used to work around some encoder bugs.
  1621. * - encoding: unused
  1622. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1623. */
  1624. unsigned int stream_codec_tag;
  1625. /**
  1626. * scene change detection threshold
  1627. * 0 is default, larger means fewer detected scene changes.
  1628. * - encoding: Set by user.
  1629. * - decoding: unused
  1630. */
  1631. int scenechange_threshold;
  1632. /**
  1633. * minimum Lagrange multipler
  1634. * - encoding: Set by user.
  1635. * - decoding: unused
  1636. */
  1637. int lmin;
  1638. /**
  1639. * maximum Lagrange multipler
  1640. * - encoding: Set by user.
  1641. * - decoding: unused
  1642. */
  1643. int lmax;
  1644. /**
  1645. * palette control structure
  1646. * - encoding: ??? (no palette-enabled encoder yet)
  1647. * - decoding: Set by user.
  1648. */
  1649. struct AVPaletteControl *palctrl;
  1650. /**
  1651. * noise reduction strength
  1652. * - encoding: Set by user.
  1653. * - decoding: unused
  1654. */
  1655. int noise_reduction;
  1656. /**
  1657. * Called at the beginning of a frame to get cr buffer for it.
  1658. * Buffer type (size, hints) must be the same. libavcodec won't check it.
  1659. * libavcodec will pass previous buffer in pic, function should return
  1660. * same buffer or new buffer with old frame "painted" into it.
  1661. * If pic.data[0] == NULL must behave like get_buffer().
  1662. * - encoding: unused
  1663. * - decoding: Set by libavcodec., user can override
  1664. */
  1665. int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1666. /**
  1667. * Number of bits which should be loaded into the rc buffer before decoding starts.
  1668. * - encoding: Set by user.
  1669. * - decoding: unused
  1670. */
  1671. int rc_initial_buffer_occupancy;
  1672. /**
  1673. *
  1674. * - encoding: Set by user.
  1675. * - decoding: unused
  1676. */
  1677. int inter_threshold;
  1678. /**
  1679. * CODEC_FLAG2_*
  1680. * - encoding: Set by user.
  1681. * - decoding: Set by user.
  1682. */
  1683. int flags2;
  1684. /**
  1685. * Simulates errors in the bitstream to test error concealment.
  1686. * - encoding: Set by user.
  1687. * - decoding: unused
  1688. */
  1689. int error_rate;
  1690. /**
  1691. * MP3 antialias algorithm, see FF_AA_* below.
  1692. * - encoding: unused
  1693. * - decoding: Set by user.
  1694. */
  1695. int antialias_algo;
  1696. #define FF_AA_AUTO 0
  1697. #define FF_AA_FASTINT 1 //not implemented yet
  1698. #define FF_AA_INT 2
  1699. #define FF_AA_FLOAT 3
  1700. /**
  1701. * quantizer noise shaping
  1702. * - encoding: Set by user.
  1703. * - decoding: unused
  1704. */
  1705. int quantizer_noise_shaping;
  1706. /**
  1707. * thread count
  1708. * is used to decide how many independent tasks should be passed to execute()
  1709. * - encoding: Set by user.
  1710. * - decoding: Set by user.
  1711. */
  1712. int thread_count;
  1713. /**
  1714. * The codec may call this to execute several independent things.
  1715. * It will return only after finishing all tasks.
  1716. * The user may replace this with some multithreaded implementation,
  1717. * the default implementation will execute the parts serially.
  1718. * @param count the number of things to execute
  1719. * - encoding: Set by libavcodec, user can override.
  1720. * - decoding: Set by libavcodec, user can override.
  1721. */
  1722. int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
  1723. /**
  1724. * thread opaque
  1725. * Can be used by execute() to store some per AVCodecContext stuff.
  1726. * - encoding: set by execute()
  1727. * - decoding: set by execute()
  1728. */
  1729. void *thread_opaque;
  1730. /**
  1731. * Motion estimation threshold below which no motion estimation is
  1732. * performed, but instead the user specified motion vectors are used.
  1733. *
  1734. * - encoding: Set by user.
  1735. * - decoding: unused
  1736. */
  1737. int me_threshold;
  1738. /**
  1739. * Macroblock threshold below which the user specified macroblock types will be used.
  1740. * - encoding: Set by user.
  1741. * - decoding: unused
  1742. */
  1743. int mb_threshold;
  1744. /**
  1745. * precision of the intra DC coefficient - 8
  1746. * - encoding: Set by user.
  1747. * - decoding: unused
  1748. */
  1749. int intra_dc_precision;
  1750. /**
  1751. * noise vs. sse weight for the nsse comparsion function
  1752. * - encoding: Set by user.
  1753. * - decoding: unused
  1754. */
  1755. int nsse_weight;
  1756. /**
  1757. * Number of macroblock rows at the top which are skipped.
  1758. * - encoding: unused
  1759. * - decoding: Set by user.
  1760. */
  1761. int skip_top;
  1762. /**
  1763. * Number of macroblock rows at the bottom which are skipped.
  1764. * - encoding: unused
  1765. * - decoding: Set by user.
  1766. */
  1767. int skip_bottom;
  1768. /**
  1769. * profile
  1770. * - encoding: Set by user.
  1771. * - decoding: Set by libavcodec.
  1772. */
  1773. int profile;
  1774. #define FF_PROFILE_UNKNOWN -99
  1775. #define FF_PROFILE_AAC_MAIN 0
  1776. #define FF_PROFILE_AAC_LOW 1
  1777. #define FF_PROFILE_AAC_SSR 2
  1778. #define FF_PROFILE_AAC_LTP 3
  1779. /**
  1780. * level
  1781. * - encoding: Set by user.
  1782. * - decoding: Set by libavcodec.
  1783. */
  1784. int level;
  1785. #define FF_LEVEL_UNKNOWN -99
  1786. /**
  1787. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  1788. * - encoding: unused
  1789. * - decoding: Set by user.
  1790. */
  1791. int lowres;
  1792. /**
  1793. * Bitstream width / height, may be different from width/height if lowres
  1794. * or other things are used.
  1795. * - encoding: unused
  1796. * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
  1797. */
  1798. int coded_width, coded_height;
  1799. /**
  1800. * frame skip threshold
  1801. * - encoding: Set by user.
  1802. * - decoding: unused
  1803. */
  1804. int frame_skip_threshold;
  1805. /**
  1806. * frame skip factor
  1807. * - encoding: Set by user.
  1808. * - decoding: unused
  1809. */
  1810. int frame_skip_factor;
  1811. /**
  1812. * frame skip exponent
  1813. * - encoding: Set by user.
  1814. * - decoding: unused
  1815. */
  1816. int frame_skip_exp;
  1817. /**
  1818. * frame skip comparison function
  1819. * - encoding: Set by user.
  1820. * - decoding: unused
  1821. */
  1822. int frame_skip_cmp;
  1823. /**
  1824. * Border processing masking, raises the quantizer for mbs on the borders
  1825. * of the picture.
  1826. * - encoding: Set by user.
  1827. * - decoding: unused
  1828. */
  1829. float border_masking;
  1830. /**
  1831. * minimum MB lagrange multipler
  1832. * - encoding: Set by user.
  1833. * - decoding: unused
  1834. */
  1835. int mb_lmin;
  1836. /**
  1837. * maximum MB lagrange multipler
  1838. * - encoding: Set by user.
  1839. * - decoding: unused
  1840. */
  1841. int mb_lmax;
  1842. /**
  1843. *
  1844. * - encoding: Set by user.
  1845. * - decoding: unused
  1846. */
  1847. int me_penalty_compensation;
  1848. /**
  1849. *
  1850. * - encoding: unused
  1851. * - decoding: Set by user.
  1852. */
  1853. enum AVDiscard skip_loop_filter;
  1854. /**
  1855. *
  1856. * - encoding: unused
  1857. * - decoding: Set by user.
  1858. */
  1859. enum AVDiscard skip_idct;
  1860. /**
  1861. *
  1862. * - encoding: unused
  1863. * - decoding: Set by user.
  1864. */
  1865. enum AVDiscard skip_frame;
  1866. /**
  1867. *
  1868. * - encoding: Set by user.
  1869. * - decoding: unused
  1870. */
  1871. int bidir_refine;
  1872. /**
  1873. *
  1874. * - encoding: Set by user.
  1875. * - decoding: unused
  1876. */
  1877. int brd_scale;
  1878. /**
  1879. * constant rate factor - quality-based VBR - values ~correspond to qps
  1880. * - encoding: Set by user.
  1881. * - decoding: unused
  1882. */
  1883. float crf;
  1884. /**
  1885. * constant quantization parameter rate control method
  1886. * - encoding: Set by user.
  1887. * - decoding: unused
  1888. */
  1889. int cqp;
  1890. /**
  1891. * minimum GOP size
  1892. * - encoding: Set by user.
  1893. * - decoding: unused
  1894. */
  1895. int keyint_min;
  1896. /**
  1897. * number of reference frames
  1898. * - encoding: Set by user.
  1899. * - decoding: Set by lavc.
  1900. */
  1901. int refs;
  1902. /**
  1903. * chroma qp offset from luma
  1904. * - encoding: Set by user.
  1905. * - decoding: unused
  1906. */
  1907. int chromaoffset;
  1908. /**
  1909. * Influences how often B-frames are used.
  1910. * - encoding: Set by user.
  1911. * - decoding: unused
  1912. */
  1913. int bframebias;
  1914. /**
  1915. * trellis RD quantization
  1916. * - encoding: Set by user.
  1917. * - decoding: unused
  1918. */
  1919. int trellis;
  1920. /**
  1921. * Reduce fluctuations in qp (before curve compression).
  1922. * - encoding: Set by user.
  1923. * - decoding: unused
  1924. */
  1925. float complexityblur;
  1926. /**
  1927. * in-loop deblocking filter alphac0 parameter
  1928. * alpha is in the range -6...6
  1929. * - encoding: Set by user.
  1930. * - decoding: unused
  1931. */
  1932. int deblockalpha;
  1933. /**
  1934. * in-loop deblocking filter beta parameter
  1935. * beta is in the range -6...6
  1936. * - encoding: Set by user.
  1937. * - decoding: unused
  1938. */
  1939. int deblockbeta;
  1940. /**
  1941. * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
  1942. * - encoding: Set by user.
  1943. * - decoding: unused
  1944. */
  1945. int partitions;
  1946. #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
  1947. #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
  1948. #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
  1949. #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
  1950. #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
  1951. /**
  1952. * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
  1953. * - encoding: Set by user.
  1954. * - decoding: unused
  1955. */
  1956. int directpred;
  1957. /**
  1958. * Audio cutoff bandwidth (0 means "automatic")
  1959. * - encoding: Set by user.
  1960. * - decoding: unused
  1961. */
  1962. int cutoff;
  1963. /**
  1964. * Multiplied by qscale for each frame and added to scene_change_score.
  1965. * - encoding: Set by user.
  1966. * - decoding: unused
  1967. */
  1968. int scenechange_factor;
  1969. /**
  1970. *
  1971. * Note: Value depends upon the compare function used for fullpel ME.
  1972. * - encoding: Set by user.
  1973. * - decoding: unused
  1974. */
  1975. int mv0_threshold;
  1976. /**
  1977. * Adjusts sensitivity of b_frame_strategy 1.
  1978. * - encoding: Set by user.
  1979. * - decoding: unused
  1980. */
  1981. int b_sensitivity;
  1982. /**
  1983. * - encoding: Set by user.
  1984. * - decoding: unused
  1985. */
  1986. int compression_level;
  1987. #define FF_COMPRESSION_DEFAULT -1
  1988. /**
  1989. * Sets whether to use LPC mode - used by FLAC encoder.
  1990. * - encoding: Set by user.
  1991. * - decoding: unused
  1992. */
  1993. int use_lpc;
  1994. /**
  1995. * LPC coefficient precision - used by FLAC encoder
  1996. * - encoding: Set by user.
  1997. * - decoding: unused
  1998. */
  1999. int lpc_coeff_precision;
  2000. /**
  2001. * - encoding: Set by user.
  2002. * - decoding: unused
  2003. */
  2004. int min_prediction_order;
  2005. /**
  2006. * - encoding: Set by user.
  2007. * - decoding: unused
  2008. */
  2009. int max_prediction_order;
  2010. /**
  2011. * search method for selecting prediction order
  2012. * - encoding: Set by user.
  2013. * - decoding: unused
  2014. */
  2015. int prediction_order_method;
  2016. /**
  2017. * - encoding: Set by user.
  2018. * - decoding: unused
  2019. */
  2020. int min_partition_order;
  2021. /**
  2022. * - encoding: Set by user.
  2023. * - decoding: unused
  2024. */
  2025. int max_partition_order;
  2026. /**
  2027. * GOP timecode frame start number, in non drop frame format
  2028. * - encoding: Set by user.
  2029. * - decoding: unused
  2030. */
  2031. int64_t timecode_frame_start;
  2032. #if LIBAVCODEC_VERSION_MAJOR < 53
  2033. /**
  2034. * Decoder should decode to this many channels if it can (0 for default)
  2035. * - encoding: unused
  2036. * - decoding: Set by user.
  2037. * @deprecated Deprecated in favor of request_channel_layout.
  2038. */
  2039. int request_channels;
  2040. #endif
  2041. /**
  2042. * Percentage of dynamic range compression to be applied by the decoder.
  2043. * The default value is 1.0, corresponding to full compression.
  2044. * - encoding: unused
  2045. * - decoding: Set by user.
  2046. */
  2047. float drc_scale;
  2048. /**
  2049. * opaque 64bit number (generally a PTS) that will be reordered and
  2050. * output in AVFrame.reordered_opaque
  2051. * - encoding: unused
  2052. * - decoding: Set by user.
  2053. */
  2054. int64_t reordered_opaque;
  2055. /**
  2056. * Bits per sample/pixel of internal libavcodec pixel/sample format.
  2057. * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
  2058. * - encoding: set by user.
  2059. * - decoding: set by libavcodec.
  2060. */
  2061. int bits_per_raw_sample;
  2062. /**
  2063. * Audio channel layout.
  2064. * - encoding: set by user.
  2065. * - decoding: set by libavcodec.
  2066. */
  2067. int64_t channel_layout;
  2068. /**
  2069. * Request decoder to use this channel layout if it can (0 for default)
  2070. * - encoding: unused
  2071. * - decoding: Set by user.
  2072. */
  2073. int64_t request_channel_layout;
  2074. /**
  2075. * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
  2076. * - encoding: Set by user.
  2077. * - decoding: unused.
  2078. */
  2079. float rc_max_available_vbv_use;
  2080. /**
  2081. * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
  2082. * - encoding: Set by user.
  2083. * - decoding: unused.
  2084. */
  2085. float rc_min_vbv_overflow_use;
  2086. } AVCodecContext;
  2087. /**
  2088. * AVCodec.
  2089. */
  2090. typedef struct AVCodec {
  2091. /**
  2092. * Name of the codec implementation.
  2093. * The name is globally unique among encoders and among decoders (but an
  2094. * encoder and a decoder can share the same name).
  2095. * This is the primary way to find a codec from the user perspective.
  2096. */
  2097. const char *name;
  2098. enum CodecType type;
  2099. enum CodecID id;
  2100. int priv_data_size;
  2101. int (*init)(AVCodecContext *);
  2102. int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
  2103. int (*close)(AVCodecContext *);
  2104. int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
  2105. const uint8_t *buf, int buf_size);
  2106. /**
  2107. * Codec capabilities.
  2108. * see CODEC_CAP_*
  2109. */
  2110. int capabilities;
  2111. struct AVCodec *next;
  2112. /**
  2113. * Flush buffers.
  2114. * Will be called when seeking
  2115. */
  2116. void (*flush)(AVCodecContext *);
  2117. const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
  2118. const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
  2119. /**
  2120. * Descriptive name for the codec, meant to be more human readable than \p name.
  2121. * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
  2122. */
  2123. const char *long_name;
  2124. const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
  2125. const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
  2126. const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
  2127. } AVCodec;
  2128. /**
  2129. * four components are given, that's all.
  2130. * the last component is alpha
  2131. */
  2132. typedef struct AVPicture {
  2133. uint8_t *data[4];
  2134. int linesize[4]; ///< number of bytes per line
  2135. } AVPicture;
  2136. /**
  2137. * AVPaletteControl
  2138. * This structure defines a method for communicating palette changes
  2139. * between and demuxer and a decoder.
  2140. *
  2141. * @deprecated Use AVPacket to send palette changes instead.
  2142. * This is totally broken.
  2143. */
  2144. #define AVPALETTE_SIZE 1024
  2145. #define AVPALETTE_COUNT 256
  2146. typedef struct AVPaletteControl {
  2147. /* Demuxer sets this to 1 to indicate the palette has changed;
  2148. * decoder resets to 0. */
  2149. int palette_changed;
  2150. /* 4-byte ARGB palette entries, stored in native byte order; note that
  2151. * the individual palette components should be on a 8-bit scale; if
  2152. * the palette data comes from an IBM VGA native format, the component
  2153. * data is probably 6 bits in size and needs to be scaled. */
  2154. unsigned int palette[AVPALETTE_COUNT];
  2155. } AVPaletteControl attribute_deprecated;
  2156. enum AVSubtitleType {
  2157. SUBTITLE_NONE,
  2158. SUBTITLE_BITMAP, ///< A bitmap, pict will be set
  2159. /**
  2160. * Plain text, the text field must be set by the decoder and is
  2161. * authoritative. ass and pict fields may contain approximations.
  2162. */
  2163. SUBTITLE_TEXT,
  2164. /**
  2165. * Formatted text, the ass field must be set by the decoder and is
  2166. * authoritative. pict and text fields may contain approximations.
  2167. */
  2168. SUBTITLE_ASS,
  2169. };
  2170. typedef struct AVSubtitleRect {
  2171. int x; ///< top left corner of pict, undefined when pict is not set
  2172. int y; ///< top left corner of pict, undefined when pict is not set
  2173. int w; ///< width of pict, undefined when pict is not set
  2174. int h; ///< height of pict, undefined when pict is not set
  2175. int nb_colors; ///< number of colors in pict, undefined when pict is not set
  2176. /**
  2177. * data+linesize for the bitmap of this subtitle.
  2178. * can be set for text/ass as well once they where rendered
  2179. */
  2180. AVPicture pict;
  2181. enum AVSubtitleType type;
  2182. char *text; ///< 0 terminated plain UTF-8 text
  2183. /**
  2184. * 0 terminated ASS/SSA compatible event line.
  2185. * The pressentation of this is unaffected by the other values in this
  2186. * struct.
  2187. */
  2188. char *ass;
  2189. } AVSubtitleRect;
  2190. typedef struct AVSubtitle {
  2191. uint16_t format; /* 0 = graphics */
  2192. uint32_t start_display_time; /* relative to packet pts, in ms */
  2193. uint32_t end_display_time; /* relative to packet pts, in ms */
  2194. unsigned num_rects;
  2195. AVSubtitleRect **rects;
  2196. } AVSubtitle;
  2197. /* resample.c */
  2198. struct ReSampleContext;
  2199. struct AVResampleContext;
  2200. typedef struct ReSampleContext ReSampleContext;
  2201. ReSampleContext *audio_resample_init(int output_channels, int input_channels,
  2202. int output_rate, int input_rate);
  2203. int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
  2204. void audio_resample_close(ReSampleContext *s);
  2205. struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
  2206. int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
  2207. void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
  2208. void av_resample_close(struct AVResampleContext *c);
  2209. /**
  2210. * Allocate memory for a picture. Call avpicture_free to free it.
  2211. *
  2212. * @param picture the picture to be filled in
  2213. * @param pix_fmt the format of the picture
  2214. * @param width the width of the picture
  2215. * @param height the height of the picture
  2216. * @return zero if successful, a negative value if not
  2217. */
  2218. int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
  2219. /**
  2220. * Free a picture previously allocated by avpicture_alloc().
  2221. *
  2222. * @param picture the AVPicture to be freed
  2223. */
  2224. void avpicture_free(AVPicture *picture);
  2225. /**
  2226. * Fill in the AVPicture fields.
  2227. * The fields of the given AVPicture are filled in by using the 'ptr' address
  2228. * which points to the image data buffer. Depending on the specified picture
  2229. * format, one or multiple image data pointers and line sizes will be set.
  2230. * If a planar format is specified, several pointers will be set pointing to
  2231. * the different picture planes and the line sizes of the different planes
  2232. * will be stored in the lines_sizes array.
  2233. *
  2234. * @param picture AVPicture whose fields are to be filled in
  2235. * @param ptr Buffer which will contain or contains the actual image data
  2236. * @param pix_fmt The format in which the picture data is stored.
  2237. * @param width the width of the image in pixels
  2238. * @param height the height of the image in pixels
  2239. * @return size of the image data in bytes
  2240. */
  2241. int avpicture_fill(AVPicture *picture, uint8_t *ptr,
  2242. int pix_fmt, int width, int height);
  2243. int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
  2244. unsigned char *dest, int dest_size);
  2245. /**
  2246. * Calculate the size in bytes that a picture of the given width and height
  2247. * would occupy if stored in the given picture format.
  2248. *
  2249. * @param pix_fmt the given picture format
  2250. * @param width the width of the image
  2251. * @param height the height of the image
  2252. * @return Image data size in bytes
  2253. */
  2254. int avpicture_get_size(int pix_fmt, int width, int height);
  2255. void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
  2256. const char *avcodec_get_pix_fmt_name(int pix_fmt);
  2257. void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
  2258. enum PixelFormat avcodec_get_pix_fmt(const char* name);
  2259. unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
  2260. #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
  2261. #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
  2262. #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
  2263. #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
  2264. #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
  2265. #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
  2266. /**
  2267. * Computes what kind of losses will occur when converting from one specific
  2268. * pixel format to another.
  2269. * When converting from one pixel format to another, information loss may occur.
  2270. * For example, when converting from RGB24 to GRAY, the color information will
  2271. * be lost. Similarly, other losses occur when converting from some formats to
  2272. * other formats. These losses can involve loss of chroma, but also loss of
  2273. * resolution, loss of color depth, loss due to the color space conversion, loss
  2274. * of the alpha bits or loss due to color quantization.
  2275. * avcodec_get_fix_fmt_loss() informs you about the various types of losses
  2276. * which will occur when converting from one pixel format to another.
  2277. *
  2278. * @param[in] dst_pix_fmt destination pixel format
  2279. * @param[in] src_pix_fmt source pixel format
  2280. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  2281. * @return Combination of flags informing you what kind of losses will occur.
  2282. */
  2283. int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
  2284. int has_alpha);
  2285. /**
  2286. * Finds the best pixel format to convert to given a certain source pixel
  2287. * format. When converting from one pixel format to another, information loss
  2288. * may occur. For example, when converting from RGB24 to GRAY, the color
  2289. * information will be lost. Similarly, other losses occur when converting from
  2290. * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
  2291. * the given pixel formats should be used to suffer the least amount of loss.
  2292. * The pixel formats from which it chooses one, are determined by the
  2293. * \p pix_fmt_mask parameter.
  2294. *
  2295. * @code
  2296. * src_pix_fmt = PIX_FMT_YUV420P;
  2297. * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
  2298. * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
  2299. * @endcode
  2300. *
  2301. * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
  2302. * @param[in] src_pix_fmt source pixel format
  2303. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  2304. * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  2305. * @return The best pixel format to convert to or -1 if none was found.
  2306. */
  2307. int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
  2308. int has_alpha, int *loss_ptr);
  2309. /**
  2310. * Print in buf the string corresponding to the pixel format with
  2311. * number pix_fmt, or an header if pix_fmt is negative.
  2312. *
  2313. * @param[in] buf the buffer where to write the string
  2314. * @param[in] buf_size the size of buf
  2315. * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
  2316. * a negative value to print the corresponding header.
  2317. * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
  2318. */
  2319. void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
  2320. #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
  2321. #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
  2322. /**
  2323. * Tell if an image really has transparent alpha values.
  2324. * @return ored mask of FF_ALPHA_xxx constants
  2325. */
  2326. int img_get_alpha_info(const AVPicture *src,
  2327. int pix_fmt, int width, int height);
  2328. /* deinterlace a picture */
  2329. /* deinterlace - if not supported return -1 */
  2330. int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
  2331. int pix_fmt, int width, int height);
  2332. /* external high level API */
  2333. AVCodec *av_codec_next(AVCodec *c);
  2334. /**
  2335. * Returns the LIBAVCODEC_VERSION_INT constant.
  2336. */
  2337. unsigned avcodec_version(void);
  2338. /**
  2339. * Initializes libavcodec.
  2340. *
  2341. * @warning This function \e must be called before any other libavcodec
  2342. * function.
  2343. */
  2344. void avcodec_init(void);
  2345. /**
  2346. * Register the codec \p codec and initialize libavcodec.
  2347. *
  2348. * @see avcodec_init()
  2349. */
  2350. void register_avcodec(AVCodec *codec);
  2351. /**
  2352. * Finds a registered encoder with a matching codec ID.
  2353. *
  2354. * @param id CodecID of the requested encoder
  2355. * @return An encoder if one was found, NULL otherwise.
  2356. */
  2357. AVCodec *avcodec_find_encoder(enum CodecID id);
  2358. /**
  2359. * Finds a registered encoder with the specified name.
  2360. *
  2361. * @param name name of the requested encoder
  2362. * @return An encoder if one was found, NULL otherwise.
  2363. */
  2364. AVCodec *avcodec_find_encoder_by_name(const char *name);
  2365. /**
  2366. * Finds a registered decoder with a matching codec ID.
  2367. *
  2368. * @param id CodecID of the requested decoder
  2369. * @return A decoder if one was found, NULL otherwise.
  2370. */
  2371. AVCodec *avcodec_find_decoder(enum CodecID id);
  2372. /**
  2373. * Finds a registered decoder with the specified name.
  2374. *
  2375. * @param name name of the requested decoder
  2376. * @return A decoder if one was found, NULL otherwise.
  2377. */
  2378. AVCodec *avcodec_find_decoder_by_name(const char *name);
  2379. void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
  2380. /**
  2381. * Sets the fields of the given AVCodecContext to default values.
  2382. *
  2383. * @param s The AVCodecContext of which the fields should be set to default values.
  2384. */
  2385. void avcodec_get_context_defaults(AVCodecContext *s);
  2386. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  2387. * we WILL change its arguments and name a few times! */
  2388. void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
  2389. /**
  2390. * Allocates an AVCodecContext and sets its fields to default values. The
  2391. * resulting struct can be deallocated by simply calling av_free().
  2392. *
  2393. * @return An AVCodecContext filled with default values or NULL on failure.
  2394. * @see avcodec_get_context_defaults
  2395. */
  2396. AVCodecContext *avcodec_alloc_context(void);
  2397. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  2398. * we WILL change its arguments and name a few times! */
  2399. AVCodecContext *avcodec_alloc_context2(enum CodecType);
  2400. /**
  2401. * Sets the fields of the given AVFrame to default values.
  2402. *
  2403. * @param pic The AVFrame of which the fields should be set to default values.
  2404. */
  2405. void avcodec_get_frame_defaults(AVFrame *pic);
  2406. /**
  2407. * Allocates an AVFrame and sets its fields to default values. The resulting
  2408. * struct can be deallocated by simply calling av_free().
  2409. *
  2410. * @return An AVFrame filled with default values or NULL on failure.
  2411. * @see avcodec_get_frame_defaults
  2412. */
  2413. AVFrame *avcodec_alloc_frame(void);
  2414. int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
  2415. void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
  2416. int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
  2417. void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
  2418. /**
  2419. * Checks if the given dimension of a picture is valid, meaning that all
  2420. * bytes of the picture can be addressed with a signed int.
  2421. *
  2422. * @param[in] w Width of the picture.
  2423. * @param[in] h Height of the picture.
  2424. * @return Zero if valid, a negative value if invalid.
  2425. */
  2426. int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
  2427. enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
  2428. int avcodec_thread_init(AVCodecContext *s, int thread_count);
  2429. void avcodec_thread_free(AVCodecContext *s);
  2430. int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  2431. int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  2432. //FIXME func typedef
  2433. /**
  2434. * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
  2435. * function the context has to be allocated.
  2436. *
  2437. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  2438. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  2439. * retrieving a codec.
  2440. *
  2441. * @warning This function is not thread safe!
  2442. *
  2443. * @code
  2444. * avcodec_register_all();
  2445. * codec = avcodec_find_decoder(CODEC_ID_H264);
  2446. * if (!codec)
  2447. * exit(1);
  2448. *
  2449. * context = avcodec_alloc_context();
  2450. *
  2451. * if (avcodec_open(context, codec) < 0)
  2452. * exit(1);
  2453. * @endcode
  2454. *
  2455. * @param avctx The context which will be set up to use the given codec.
  2456. * @param codec The codec to use within the context.
  2457. * @return zero on success, a negative value on error
  2458. * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
  2459. */
  2460. int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
  2461. /**
  2462. * Decodes an audio frame from \p buf into \p samples.
  2463. * The avcodec_decode_audio2() function decodes an audio frame from the input
  2464. * buffer \p buf of size \p buf_size. To decode it, it makes use of the
  2465. * audio codec which was coupled with \p avctx using avcodec_open(). The
  2466. * resulting decoded frame is stored in output buffer \p samples. If no frame
  2467. * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
  2468. * decompressed frame size in \e bytes.
  2469. *
  2470. * @warning You \e must set \p frame_size_ptr to the allocated size of the
  2471. * output buffer before calling avcodec_decode_audio2().
  2472. *
  2473. * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
  2474. * the actual read bytes because some optimized bitstream readers read 32 or 64
  2475. * bits at once and could read over the end.
  2476. *
  2477. * @warning The end of the input buffer \p buf should be set to 0 to ensure that
  2478. * no overreading happens for damaged MPEG streams.
  2479. *
  2480. * @note You might have to align the input buffer \p buf and output buffer \p
  2481. * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
  2482. * necessary at all, on others it won't work at all if not aligned and on others
  2483. * it will work but it will have an impact on performance. In practice, the
  2484. * bitstream should have 4 byte alignment at minimum and all sample data should
  2485. * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
  2486. * the linesize is not a multiple of 16 then there's no sense in aligning the
  2487. * start of the buffer to 16.
  2488. *
  2489. * @param avctx the codec context
  2490. * @param[out] samples the output buffer
  2491. * @param[in,out] frame_size_ptr the output buffer size in bytes
  2492. * @param[in] buf the input buffer
  2493. * @param[in] buf_size the input buffer size in bytes
  2494. * @return On error a negative value is returned, otherwise the number of bytes
  2495. * used or zero if no frame could be decompressed.
  2496. */
  2497. int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
  2498. int *frame_size_ptr,
  2499. const uint8_t *buf, int buf_size);
  2500. /**
  2501. * Decodes a video frame from \p buf into \p picture.
  2502. * The avcodec_decode_video() function decodes a video frame from the input
  2503. * buffer \p buf of size \p buf_size. To decode it, it makes use of the
  2504. * video codec which was coupled with \p avctx using avcodec_open(). The
  2505. * resulting decoded frame is stored in \p picture.
  2506. *
  2507. * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
  2508. * the actual read bytes because some optimized bitstream readers read 32 or 64
  2509. * bits at once and could read over the end.
  2510. *
  2511. * @warning The end of the input buffer \p buf should be set to 0 to ensure that
  2512. * no overreading happens for damaged MPEG streams.
  2513. *
  2514. * @note You might have to align the input buffer \p buf and output buffer \p
  2515. * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
  2516. * necessary at all, on others it won't work at all if not aligned and on others
  2517. * it will work but it will have an impact on performance. In practice, the
  2518. * bitstream should have 4 byte alignment at minimum and all sample data should
  2519. * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
  2520. * the linesize is not a multiple of 16 then there's no sense in aligning the
  2521. * start of the buffer to 16.
  2522. *
  2523. * @note Some codecs have a delay between input and output, these need to be
  2524. * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
  2525. *
  2526. * @param avctx the codec context
  2527. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  2528. * @param[in] buf the input buffer
  2529. * @param[in] buf_size the size of the input buffer in bytes
  2530. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  2531. * @return On error a negative value is returned, otherwise the number of bytes
  2532. * used or zero if no frame could be decompressed.
  2533. */
  2534. int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
  2535. int *got_picture_ptr,
  2536. const uint8_t *buf, int buf_size);
  2537. /* Decode a subtitle message. Return -1 if error, otherwise return the
  2538. * number of bytes used. If no subtitle could be decompressed,
  2539. * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
  2540. int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
  2541. int *got_sub_ptr,
  2542. const uint8_t *buf, int buf_size);
  2543. int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
  2544. int *data_size_ptr,
  2545. uint8_t *buf, int buf_size);
  2546. /**
  2547. * Encodes an audio frame from \p samples into \p buf.
  2548. * The avcodec_encode_audio() function encodes an audio frame from the input
  2549. * buffer \p samples. To encode it, it makes use of the audio codec which was
  2550. * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
  2551. * stored in output buffer \p buf.
  2552. *
  2553. * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
  2554. *
  2555. * @param avctx the codec context
  2556. * @param[out] buf the output buffer
  2557. * @param[in] buf_size the output buffer size
  2558. * @param[in] samples the input buffer containing the samples
  2559. * The number of samples read from this buffer is frame_size*channels,
  2560. * both of which are defined in \p avctx.
  2561. * For PCM audio the number of samples read from \p samples is equal to
  2562. * \p buf_size * input_sample_size / output_sample_size.
  2563. * @return On error a negative value is returned, on success zero or the number
  2564. * of bytes used to encode the data read from the input buffer.
  2565. */
  2566. int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  2567. const short *samples);
  2568. /**
  2569. * Encodes a video frame from \p pict into \p buf.
  2570. * The avcodec_encode_video() function encodes a video frame from the input
  2571. * \p pict. To encode it, it makes use of the video codec which was coupled with
  2572. * \p avctx using avcodec_open(). The resulting encoded bytes representing the
  2573. * frame are stored in the output buffer \p buf. The input picture should be
  2574. * stored using a specific format, namely \c avctx.pix_fmt.
  2575. *
  2576. * @param avctx the codec context
  2577. * @param[out] buf the output buffer for the bitstream of encoded frame
  2578. * @param[in] buf_size the size of the output buffer in bytes
  2579. * @param[in] pict the input picture to encode
  2580. * @return On error a negative value is returned, on success zero or the number
  2581. * of bytes used from the input buffer.
  2582. */
  2583. int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  2584. const AVFrame *pict);
  2585. int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  2586. const AVSubtitle *sub);
  2587. int avcodec_close(AVCodecContext *avctx);
  2588. /**
  2589. * Register all the codecs, parsers and bitstream filters which were enabled at
  2590. * configuration time. If you do not call this function you can select exactly
  2591. * which formats you want to support, by using the individual registration
  2592. * functions.
  2593. *
  2594. * @see register_avcodec
  2595. * @see av_register_codec_parser
  2596. * @see av_register_bitstream_filter
  2597. */
  2598. void avcodec_register_all(void);
  2599. /**
  2600. * Flush buffers, should be called when seeking or when switching to a different stream.
  2601. */
  2602. void avcodec_flush_buffers(AVCodecContext *avctx);
  2603. void avcodec_default_free_buffers(AVCodecContext *s);
  2604. /* misc useful functions */
  2605. /**
  2606. * Returns a single letter to describe the given picture type \p pict_type.
  2607. *
  2608. * @param[in] pict_type the picture type
  2609. * @return A single character representing the picture type.
  2610. */
  2611. char av_get_pict_type_char(int pict_type);
  2612. /**
  2613. * Returns codec bits per sample.
  2614. *
  2615. * @param[in] codec_id the codec
  2616. * @return Number of bits per sample or zero if unknown for the given codec.
  2617. */
  2618. int av_get_bits_per_sample(enum CodecID codec_id);
  2619. /**
  2620. * Returns sample format bits per sample.
  2621. *
  2622. * @param[in] sample_fmt the sample format
  2623. * @return Number of bits per sample or zero if unknown for the given sample format.
  2624. */
  2625. int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
  2626. /* frame parsing */
  2627. typedef struct AVCodecParserContext {
  2628. void *priv_data;
  2629. struct AVCodecParser *parser;
  2630. int64_t frame_offset; /* offset of the current frame */
  2631. int64_t cur_offset; /* current offset
  2632. (incremented by each av_parser_parse()) */
  2633. int64_t next_frame_offset; /* offset of the next frame */
  2634. /* video info */
  2635. int pict_type; /* XXX: Put it back in AVCodecContext. */
  2636. int repeat_pict; /* XXX: Put it back in AVCodecContext. */
  2637. int64_t pts; /* pts of the current frame */
  2638. int64_t dts; /* dts of the current frame */
  2639. /* private data */
  2640. int64_t last_pts;
  2641. int64_t last_dts;
  2642. int fetch_timestamp;
  2643. #define AV_PARSER_PTS_NB 4
  2644. int cur_frame_start_index;
  2645. int64_t cur_frame_offset[AV_PARSER_PTS_NB];
  2646. int64_t cur_frame_pts[AV_PARSER_PTS_NB];
  2647. int64_t cur_frame_dts[AV_PARSER_PTS_NB];
  2648. int flags;
  2649. #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
  2650. int64_t offset; ///< byte offset from starting packet start
  2651. int64_t cur_frame_end[AV_PARSER_PTS_NB];
  2652. } AVCodecParserContext;
  2653. typedef struct AVCodecParser {
  2654. int codec_ids[5]; /* several codec IDs are permitted */
  2655. int priv_data_size;
  2656. int (*parser_init)(AVCodecParserContext *s);
  2657. int (*parser_parse)(AVCodecParserContext *s,
  2658. AVCodecContext *avctx,
  2659. const uint8_t **poutbuf, int *poutbuf_size,
  2660. const uint8_t *buf, int buf_size);
  2661. void (*parser_close)(AVCodecParserContext *s);
  2662. int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
  2663. struct AVCodecParser *next;
  2664. } AVCodecParser;
  2665. AVCodecParser *av_parser_next(AVCodecParser *c);
  2666. void av_register_codec_parser(AVCodecParser *parser);
  2667. AVCodecParserContext *av_parser_init(int codec_id);
  2668. int av_parser_parse(AVCodecParserContext *s,
  2669. AVCodecContext *avctx,
  2670. uint8_t **poutbuf, int *poutbuf_size,
  2671. const uint8_t *buf, int buf_size,
  2672. int64_t pts, int64_t dts);
  2673. int av_parser_change(AVCodecParserContext *s,
  2674. AVCodecContext *avctx,
  2675. uint8_t **poutbuf, int *poutbuf_size,
  2676. const uint8_t *buf, int buf_size, int keyframe);
  2677. void av_parser_close(AVCodecParserContext *s);
  2678. typedef struct AVBitStreamFilterContext {
  2679. void *priv_data;
  2680. struct AVBitStreamFilter *filter;
  2681. AVCodecParserContext *parser;
  2682. struct AVBitStreamFilterContext *next;
  2683. } AVBitStreamFilterContext;
  2684. typedef struct AVBitStreamFilter {
  2685. const char *name;
  2686. int priv_data_size;
  2687. int (*filter)(AVBitStreamFilterContext *bsfc,
  2688. AVCodecContext *avctx, const char *args,
  2689. uint8_t **poutbuf, int *poutbuf_size,
  2690. const uint8_t *buf, int buf_size, int keyframe);
  2691. void (*close)(AVBitStreamFilterContext *bsfc);
  2692. struct AVBitStreamFilter *next;
  2693. } AVBitStreamFilter;
  2694. void av_register_bitstream_filter(AVBitStreamFilter *bsf);
  2695. AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
  2696. int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
  2697. AVCodecContext *avctx, const char *args,
  2698. uint8_t **poutbuf, int *poutbuf_size,
  2699. const uint8_t *buf, int buf_size, int keyframe);
  2700. void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
  2701. AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
  2702. /* memory */
  2703. /**
  2704. * Reallocates the given block if it is not large enough, otherwise it
  2705. * does nothing.
  2706. *
  2707. * @see av_realloc
  2708. */
  2709. void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
  2710. /**
  2711. * Copy image 'src' to 'dst'.
  2712. */
  2713. void av_picture_copy(AVPicture *dst, const AVPicture *src,
  2714. int pix_fmt, int width, int height);
  2715. /**
  2716. * Crop image top and left side.
  2717. */
  2718. int av_picture_crop(AVPicture *dst, const AVPicture *src,
  2719. int pix_fmt, int top_band, int left_band);
  2720. /**
  2721. * Pad image.
  2722. */
  2723. int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
  2724. int padtop, int padbottom, int padleft, int padright, int *color);
  2725. unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  2726. /**
  2727. * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
  2728. *
  2729. * @return 0 in case of a successful parsing, a negative value otherwise
  2730. * @param[in] str the string to parse: it has to be a string in the format
  2731. * <width>x<height> or a valid video frame size abbreviation.
  2732. * @param[in,out] width_ptr pointer to the variable which will contain the detected
  2733. * frame width value
  2734. * @param[in,out] height_ptr pointer to the variable which will contain the detected
  2735. * frame height value
  2736. */
  2737. int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
  2738. /**
  2739. * Parses \p str and put in \p frame_rate the detected values.
  2740. *
  2741. * @return 0 in case of a successful parsing, a negative value otherwise
  2742. * @param[in] str the string to parse: it has to be a string in the format
  2743. * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
  2744. * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
  2745. * frame rate
  2746. */
  2747. int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
  2748. /* error handling */
  2749. #if EINVAL > 0
  2750. #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
  2751. #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
  2752. #else
  2753. /* Some platforms have E* and errno already negated. */
  2754. #define AVERROR(e) (e)
  2755. #define AVUNERROR(e) (e)
  2756. #endif
  2757. #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
  2758. #define AVERROR_IO AVERROR(EIO) /**< I/O error */
  2759. #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
  2760. #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
  2761. #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
  2762. #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
  2763. #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
  2764. #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
  2765. #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
  2766. #endif /* AVCODEC_AVCODEC_H */