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