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.

3783 lines
121KB

  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 libavcodec/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 33
  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. CODEC_ID_TQI,
  185. CODEC_ID_AURA,
  186. CODEC_ID_AURA2,
  187. CODEC_ID_V210X,
  188. CODEC_ID_TMV,
  189. CODEC_ID_V210,
  190. CODEC_ID_DPX,
  191. CODEC_ID_MAD,
  192. /* various PCM "codecs" */
  193. CODEC_ID_PCM_S16LE= 0x10000,
  194. CODEC_ID_PCM_S16BE,
  195. CODEC_ID_PCM_U16LE,
  196. CODEC_ID_PCM_U16BE,
  197. CODEC_ID_PCM_S8,
  198. CODEC_ID_PCM_U8,
  199. CODEC_ID_PCM_MULAW,
  200. CODEC_ID_PCM_ALAW,
  201. CODEC_ID_PCM_S32LE,
  202. CODEC_ID_PCM_S32BE,
  203. CODEC_ID_PCM_U32LE,
  204. CODEC_ID_PCM_U32BE,
  205. CODEC_ID_PCM_S24LE,
  206. CODEC_ID_PCM_S24BE,
  207. CODEC_ID_PCM_U24LE,
  208. CODEC_ID_PCM_U24BE,
  209. CODEC_ID_PCM_S24DAUD,
  210. CODEC_ID_PCM_ZORK,
  211. CODEC_ID_PCM_S16LE_PLANAR,
  212. CODEC_ID_PCM_DVD,
  213. CODEC_ID_PCM_F32BE,
  214. CODEC_ID_PCM_F32LE,
  215. CODEC_ID_PCM_F64BE,
  216. CODEC_ID_PCM_F64LE,
  217. /* various ADPCM codecs */
  218. CODEC_ID_ADPCM_IMA_QT= 0x11000,
  219. CODEC_ID_ADPCM_IMA_WAV,
  220. CODEC_ID_ADPCM_IMA_DK3,
  221. CODEC_ID_ADPCM_IMA_DK4,
  222. CODEC_ID_ADPCM_IMA_WS,
  223. CODEC_ID_ADPCM_IMA_SMJPEG,
  224. CODEC_ID_ADPCM_MS,
  225. CODEC_ID_ADPCM_4XM,
  226. CODEC_ID_ADPCM_XA,
  227. CODEC_ID_ADPCM_ADX,
  228. CODEC_ID_ADPCM_EA,
  229. CODEC_ID_ADPCM_G726,
  230. CODEC_ID_ADPCM_CT,
  231. CODEC_ID_ADPCM_SWF,
  232. CODEC_ID_ADPCM_YAMAHA,
  233. CODEC_ID_ADPCM_SBPRO_4,
  234. CODEC_ID_ADPCM_SBPRO_3,
  235. CODEC_ID_ADPCM_SBPRO_2,
  236. CODEC_ID_ADPCM_THP,
  237. CODEC_ID_ADPCM_IMA_AMV,
  238. CODEC_ID_ADPCM_EA_R1,
  239. CODEC_ID_ADPCM_EA_R3,
  240. CODEC_ID_ADPCM_EA_R2,
  241. CODEC_ID_ADPCM_IMA_EA_SEAD,
  242. CODEC_ID_ADPCM_IMA_EA_EACS,
  243. CODEC_ID_ADPCM_EA_XAS,
  244. CODEC_ID_ADPCM_EA_MAXIS_XA,
  245. CODEC_ID_ADPCM_IMA_ISS,
  246. /* AMR */
  247. CODEC_ID_AMR_NB= 0x12000,
  248. CODEC_ID_AMR_WB,
  249. /* RealAudio codecs*/
  250. CODEC_ID_RA_144= 0x13000,
  251. CODEC_ID_RA_288,
  252. /* various DPCM codecs */
  253. CODEC_ID_ROQ_DPCM= 0x14000,
  254. CODEC_ID_INTERPLAY_DPCM,
  255. CODEC_ID_XAN_DPCM,
  256. CODEC_ID_SOL_DPCM,
  257. /* audio codecs */
  258. CODEC_ID_MP2= 0x15000,
  259. CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
  260. CODEC_ID_AAC,
  261. CODEC_ID_AC3,
  262. CODEC_ID_DTS,
  263. CODEC_ID_VORBIS,
  264. CODEC_ID_DVAUDIO,
  265. CODEC_ID_WMAV1,
  266. CODEC_ID_WMAV2,
  267. CODEC_ID_MACE3,
  268. CODEC_ID_MACE6,
  269. CODEC_ID_VMDAUDIO,
  270. CODEC_ID_SONIC,
  271. CODEC_ID_SONIC_LS,
  272. CODEC_ID_FLAC,
  273. CODEC_ID_MP3ADU,
  274. CODEC_ID_MP3ON4,
  275. CODEC_ID_SHORTEN,
  276. CODEC_ID_ALAC,
  277. CODEC_ID_WESTWOOD_SND1,
  278. CODEC_ID_GSM, ///< as in Berlin toast format
  279. CODEC_ID_QDM2,
  280. CODEC_ID_COOK,
  281. CODEC_ID_TRUESPEECH,
  282. CODEC_ID_TTA,
  283. CODEC_ID_SMACKAUDIO,
  284. CODEC_ID_QCELP,
  285. CODEC_ID_WAVPACK,
  286. CODEC_ID_DSICINAUDIO,
  287. CODEC_ID_IMC,
  288. CODEC_ID_MUSEPACK7,
  289. CODEC_ID_MLP,
  290. CODEC_ID_GSM_MS, /* as found in WAV */
  291. CODEC_ID_ATRAC3,
  292. CODEC_ID_VOXWARE,
  293. CODEC_ID_APE,
  294. CODEC_ID_NELLYMOSER,
  295. CODEC_ID_MUSEPACK8,
  296. CODEC_ID_SPEEX,
  297. CODEC_ID_WMAVOICE,
  298. CODEC_ID_WMAPRO,
  299. CODEC_ID_WMALOSSLESS,
  300. CODEC_ID_ATRAC3P,
  301. CODEC_ID_EAC3,
  302. CODEC_ID_SIPR,
  303. CODEC_ID_MP1,
  304. CODEC_ID_TWINVQ,
  305. CODEC_ID_TRUEHD,
  306. CODEC_ID_MP4ALS,
  307. /* subtitle codecs */
  308. CODEC_ID_DVD_SUBTITLE= 0x17000,
  309. CODEC_ID_DVB_SUBTITLE,
  310. CODEC_ID_TEXT, ///< raw UTF-8 text
  311. CODEC_ID_XSUB,
  312. CODEC_ID_SSA,
  313. CODEC_ID_MOV_TEXT,
  314. CODEC_ID_HDMV_PGS_SUBTITLE,
  315. /* other specific kind of codecs (generally used for attachments) */
  316. CODEC_ID_TTF= 0x18000,
  317. CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
  318. CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
  319. * stream (only used by libavformat) */
  320. };
  321. enum CodecType {
  322. CODEC_TYPE_UNKNOWN = -1,
  323. CODEC_TYPE_VIDEO,
  324. CODEC_TYPE_AUDIO,
  325. CODEC_TYPE_DATA,
  326. CODEC_TYPE_SUBTITLE,
  327. CODEC_TYPE_ATTACHMENT,
  328. CODEC_TYPE_NB
  329. };
  330. /**
  331. * all in native-endian format
  332. */
  333. enum SampleFormat {
  334. SAMPLE_FMT_NONE = -1,
  335. SAMPLE_FMT_U8, ///< unsigned 8 bits
  336. SAMPLE_FMT_S16, ///< signed 16 bits
  337. SAMPLE_FMT_S32, ///< signed 32 bits
  338. SAMPLE_FMT_FLT, ///< float
  339. SAMPLE_FMT_DBL, ///< double
  340. SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
  341. };
  342. /* Audio channel masks */
  343. #define CH_FRONT_LEFT 0x00000001
  344. #define CH_FRONT_RIGHT 0x00000002
  345. #define CH_FRONT_CENTER 0x00000004
  346. #define CH_LOW_FREQUENCY 0x00000008
  347. #define CH_BACK_LEFT 0x00000010
  348. #define CH_BACK_RIGHT 0x00000020
  349. #define CH_FRONT_LEFT_OF_CENTER 0x00000040
  350. #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
  351. #define CH_BACK_CENTER 0x00000100
  352. #define CH_SIDE_LEFT 0x00000200
  353. #define CH_SIDE_RIGHT 0x00000400
  354. #define CH_TOP_CENTER 0x00000800
  355. #define CH_TOP_FRONT_LEFT 0x00001000
  356. #define CH_TOP_FRONT_CENTER 0x00002000
  357. #define CH_TOP_FRONT_RIGHT 0x00004000
  358. #define CH_TOP_BACK_LEFT 0x00008000
  359. #define CH_TOP_BACK_CENTER 0x00010000
  360. #define CH_TOP_BACK_RIGHT 0x00020000
  361. #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
  362. #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
  363. /* Audio channel convenience macros */
  364. #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
  365. #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
  366. #define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
  367. #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
  368. #define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
  369. #define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
  370. #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
  371. #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
  372. #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
  373. #define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
  374. #define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
  375. #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
  376. #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
  377. CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
  378. #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
  379. /* in bytes */
  380. #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
  381. /**
  382. * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
  383. * This is mainly needed because some optimized bitstream readers read
  384. * 32 or 64 bit at once and could read over the end.<br>
  385. * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  386. * MPEG bitstreams could cause overread and segfault.
  387. */
  388. #define FF_INPUT_BUFFER_PADDING_SIZE 8
  389. /**
  390. * minimum encoding buffer size
  391. * Used to avoid some checks during header writing.
  392. */
  393. #define FF_MIN_BUFFER_SIZE 16384
  394. /**
  395. * motion estimation type.
  396. */
  397. enum Motion_Est_ID {
  398. ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
  399. ME_FULL,
  400. ME_LOG,
  401. ME_PHODS,
  402. ME_EPZS, ///< enhanced predictive zonal search
  403. ME_X1, ///< reserved for experiments
  404. ME_HEX, ///< hexagon based search
  405. ME_UMH, ///< uneven multi-hexagon search
  406. ME_ITER, ///< iterative search
  407. ME_TESA, ///< transformed exhaustive search algorithm
  408. };
  409. enum AVDiscard{
  410. /* We leave some space between them for extensions (drop some
  411. * keyframes for intra-only or drop just some bidir frames). */
  412. AVDISCARD_NONE =-16, ///< discard nothing
  413. AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
  414. AVDISCARD_NONREF = 8, ///< discard all non reference
  415. AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
  416. AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
  417. AVDISCARD_ALL = 48, ///< discard all
  418. };
  419. enum AVColorPrimaries{
  420. AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
  421. AVCOL_PRI_UNSPECIFIED=2,
  422. AVCOL_PRI_BT470M =4,
  423. AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
  424. AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
  425. AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
  426. AVCOL_PRI_FILM =8,
  427. AVCOL_PRI_NB , ///< Not part of ABI
  428. };
  429. enum AVColorTransferCharacteristic{
  430. AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
  431. AVCOL_TRC_UNSPECIFIED=2,
  432. AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
  433. AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
  434. AVCOL_TRC_NB , ///< Not part of ABI
  435. };
  436. enum AVColorSpace{
  437. AVCOL_SPC_RGB =0,
  438. AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
  439. AVCOL_SPC_UNSPECIFIED=2,
  440. AVCOL_SPC_FCC =4,
  441. AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
  442. AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
  443. AVCOL_SPC_SMPTE240M =7,
  444. AVCOL_SPC_NB , ///< Not part of ABI
  445. };
  446. enum AVColorRange{
  447. AVCOL_RANGE_UNSPECIFIED=0,
  448. AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
  449. AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
  450. AVCOL_RANGE_NB , ///< Not part of ABI
  451. };
  452. /**
  453. * X X 3 4 X X are luma samples,
  454. * 1 2 1-6 are possible chroma positions
  455. * X X 5 6 X 0 is undefined/unknown position
  456. */
  457. enum AVChromaLocation{
  458. AVCHROMA_LOC_UNSPECIFIED=0,
  459. AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
  460. AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
  461. AVCHROMA_LOC_TOPLEFT =3, ///< DV
  462. AVCHROMA_LOC_TOP =4,
  463. AVCHROMA_LOC_BOTTOMLEFT =5,
  464. AVCHROMA_LOC_BOTTOM =6,
  465. AVCHROMA_LOC_NB , ///< Not part of ABI
  466. };
  467. typedef struct RcOverride{
  468. int start_frame;
  469. int end_frame;
  470. int qscale; // If this is 0 then quality_factor will be used instead.
  471. float quality_factor;
  472. } RcOverride;
  473. #define FF_MAX_B_FRAMES 16
  474. /* encoding support
  475. These flags can be passed in AVCodecContext.flags before initialization.
  476. Note: Not everything is supported yet.
  477. */
  478. #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
  479. #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
  480. #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
  481. #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
  482. #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
  483. #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
  484. /**
  485. * The parent program guarantees that the input for B-frames containing
  486. * streams is not written to for at least s->max_b_frames+1 frames, if
  487. * this is not set the input will be copied.
  488. */
  489. #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  490. #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
  491. #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
  492. #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
  493. #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
  494. #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
  495. #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
  496. #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
  497. location instead of only at frame boundaries. */
  498. #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
  499. #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
  500. #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
  501. #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
  502. #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
  503. #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
  504. /* Fx : Flag for h263+ extra options */
  505. #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
  506. #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
  507. #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
  508. #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
  509. #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
  510. #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
  511. #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
  512. #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
  513. #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
  514. #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
  515. #define CODEC_FLAG_CLOSED_GOP 0x80000000
  516. #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
  517. #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
  518. #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
  519. #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
  520. #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
  521. #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
  522. #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
  523. #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
  524. #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
  525. #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
  526. #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
  527. #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
  528. #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
  529. #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
  530. #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
  531. #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
  532. #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
  533. #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
  534. /* Unsupported options :
  535. * Syntax Arithmetic coding (SAC)
  536. * Reference Picture Selection
  537. * Independent Segment Decoding */
  538. /* /Fx */
  539. /* codec capabilities */
  540. #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
  541. /**
  542. * Codec uses get_buffer() for allocating buffers.
  543. * direct rendering method 1
  544. */
  545. #define CODEC_CAP_DR1 0x0002
  546. /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
  547. #define CODEC_CAP_PARSE_ONLY 0x0004
  548. #define CODEC_CAP_TRUNCATED 0x0008
  549. /* Codec can export data for HW decoding (XvMC). */
  550. #define CODEC_CAP_HWACCEL 0x0010
  551. /**
  552. * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
  553. * If this is not set, the codec is guaranteed to never be fed with NULL data.
  554. */
  555. #define CODEC_CAP_DELAY 0x0020
  556. /**
  557. * Codec can be fed a final frame with a smaller size.
  558. * This can be used to prevent truncation of the last audio samples.
  559. */
  560. #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
  561. /**
  562. * Codec can export data for HW decoding (VDPAU).
  563. */
  564. #define CODEC_CAP_HWACCEL_VDPAU 0x0080
  565. //The following defines may change, don't expect compatibility if you use them.
  566. #define MB_TYPE_INTRA4x4 0x0001
  567. #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
  568. #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
  569. #define MB_TYPE_16x16 0x0008
  570. #define MB_TYPE_16x8 0x0010
  571. #define MB_TYPE_8x16 0x0020
  572. #define MB_TYPE_8x8 0x0040
  573. #define MB_TYPE_INTERLACED 0x0080
  574. #define MB_TYPE_DIRECT2 0x0100 //FIXME
  575. #define MB_TYPE_ACPRED 0x0200
  576. #define MB_TYPE_GMC 0x0400
  577. #define MB_TYPE_SKIP 0x0800
  578. #define MB_TYPE_P0L0 0x1000
  579. #define MB_TYPE_P1L0 0x2000
  580. #define MB_TYPE_P0L1 0x4000
  581. #define MB_TYPE_P1L1 0x8000
  582. #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
  583. #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
  584. #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
  585. #define MB_TYPE_QUANT 0x00010000
  586. #define MB_TYPE_CBP 0x00020000
  587. //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
  588. /**
  589. * Pan Scan area.
  590. * This specifies the area which should be displayed.
  591. * Note there may be multiple such areas for one frame.
  592. */
  593. typedef struct AVPanScan{
  594. /**
  595. * id
  596. * - encoding: Set by user.
  597. * - decoding: Set by libavcodec.
  598. */
  599. int id;
  600. /**
  601. * width and height in 1/16 pel
  602. * - encoding: Set by user.
  603. * - decoding: Set by libavcodec.
  604. */
  605. int width;
  606. int height;
  607. /**
  608. * position of the top left corner in 1/16 pel for up to 3 fields/frames
  609. * - encoding: Set by user.
  610. * - decoding: Set by libavcodec.
  611. */
  612. int16_t position[3][2];
  613. }AVPanScan;
  614. #define FF_COMMON_FRAME \
  615. /**\
  616. * pointer to the picture planes.\
  617. * This might be different from the first allocated byte\
  618. * - encoding: \
  619. * - decoding: \
  620. */\
  621. uint8_t *data[4];\
  622. int linesize[4];\
  623. /**\
  624. * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
  625. * This isn't used by libavcodec unless the default get/release_buffer() is used.\
  626. * - encoding: \
  627. * - decoding: \
  628. */\
  629. uint8_t *base[4];\
  630. /**\
  631. * 1 -> keyframe, 0-> not\
  632. * - encoding: Set by libavcodec.\
  633. * - decoding: Set by libavcodec.\
  634. */\
  635. int key_frame;\
  636. \
  637. /**\
  638. * Picture type of the frame, see ?_TYPE below.\
  639. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
  640. * - decoding: Set by libavcodec.\
  641. */\
  642. int pict_type;\
  643. \
  644. /**\
  645. * presentation timestamp in time_base units (time when frame should be shown to user)\
  646. * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
  647. * - encoding: MUST be set by user.\
  648. * - decoding: Set by libavcodec.\
  649. */\
  650. int64_t pts;\
  651. \
  652. /**\
  653. * picture number in bitstream order\
  654. * - encoding: set by\
  655. * - decoding: Set by libavcodec.\
  656. */\
  657. int coded_picture_number;\
  658. /**\
  659. * picture number in display order\
  660. * - encoding: set by\
  661. * - decoding: Set by libavcodec.\
  662. */\
  663. int display_picture_number;\
  664. \
  665. /**\
  666. * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
  667. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
  668. * - decoding: Set by libavcodec.\
  669. */\
  670. int quality; \
  671. \
  672. /**\
  673. * buffer age (1->was last buffer and dint change, 2->..., ...).\
  674. * Set to INT_MAX if the buffer has not been used yet.\
  675. * - encoding: unused\
  676. * - decoding: MUST be set by get_buffer().\
  677. */\
  678. int age;\
  679. \
  680. /**\
  681. * is this picture used as reference\
  682. * The values for this are the same as the MpegEncContext.picture_structure\
  683. * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
  684. * Set to 4 for delayed, non-reference frames.\
  685. * - encoding: unused\
  686. * - decoding: Set by libavcodec. (before get_buffer() call)).\
  687. */\
  688. int reference;\
  689. \
  690. /**\
  691. * QP table\
  692. * - encoding: unused\
  693. * - decoding: Set by libavcodec.\
  694. */\
  695. int8_t *qscale_table;\
  696. /**\
  697. * QP store stride\
  698. * - encoding: unused\
  699. * - decoding: Set by libavcodec.\
  700. */\
  701. int qstride;\
  702. \
  703. /**\
  704. * mbskip_table[mb]>=1 if MB didn't change\
  705. * stride= mb_width = (width+15)>>4\
  706. * - encoding: unused\
  707. * - decoding: Set by libavcodec.\
  708. */\
  709. uint8_t *mbskip_table;\
  710. \
  711. /**\
  712. * motion vector table\
  713. * @code\
  714. * example:\
  715. * int mv_sample_log2= 4 - motion_subsample_log2;\
  716. * int mb_width= (width+15)>>4;\
  717. * int mv_stride= (mb_width << mv_sample_log2) + 1;\
  718. * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
  719. * @endcode\
  720. * - encoding: Set by user.\
  721. * - decoding: Set by libavcodec.\
  722. */\
  723. int16_t (*motion_val[2])[2];\
  724. \
  725. /**\
  726. * macroblock type table\
  727. * mb_type_base + mb_width + 2\
  728. * - encoding: Set by user.\
  729. * - decoding: Set by libavcodec.\
  730. */\
  731. uint32_t *mb_type;\
  732. \
  733. /**\
  734. * log2 of the size of the block which a single vector in motion_val represents: \
  735. * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
  736. * - encoding: unused\
  737. * - decoding: Set by libavcodec.\
  738. */\
  739. uint8_t motion_subsample_log2;\
  740. \
  741. /**\
  742. * for some private data of the user\
  743. * - encoding: unused\
  744. * - decoding: Set by user.\
  745. */\
  746. void *opaque;\
  747. \
  748. /**\
  749. * error\
  750. * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
  751. * - decoding: unused\
  752. */\
  753. uint64_t error[4];\
  754. \
  755. /**\
  756. * type of the buffer (to keep track of who has to deallocate data[*])\
  757. * - encoding: Set by the one who allocates it.\
  758. * - decoding: Set by the one who allocates it.\
  759. * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
  760. */\
  761. int type;\
  762. \
  763. /**\
  764. * When decoding, this signals how much the picture must be delayed.\
  765. * extra_delay = repeat_pict / (2*fps)\
  766. * - encoding: unused\
  767. * - decoding: Set by libavcodec.\
  768. */\
  769. int repeat_pict;\
  770. \
  771. /**\
  772. * \
  773. */\
  774. int qscale_type;\
  775. \
  776. /**\
  777. * The content of the picture is interlaced.\
  778. * - encoding: Set by user.\
  779. * - decoding: Set by libavcodec. (default 0)\
  780. */\
  781. int interlaced_frame;\
  782. \
  783. /**\
  784. * If the content is interlaced, is top field displayed first.\
  785. * - encoding: Set by user.\
  786. * - decoding: Set by libavcodec.\
  787. */\
  788. int top_field_first;\
  789. \
  790. /**\
  791. * Pan scan.\
  792. * - encoding: Set by user.\
  793. * - decoding: Set by libavcodec.\
  794. */\
  795. AVPanScan *pan_scan;\
  796. \
  797. /**\
  798. * Tell user application that palette has changed from previous frame.\
  799. * - encoding: ??? (no palette-enabled encoder yet)\
  800. * - decoding: Set by libavcodec. (default 0).\
  801. */\
  802. int palette_has_changed;\
  803. \
  804. /**\
  805. * codec suggestion on buffer type if != 0\
  806. * - encoding: unused\
  807. * - decoding: Set by libavcodec. (before get_buffer() call)).\
  808. */\
  809. int buffer_hints;\
  810. \
  811. /**\
  812. * DCT coefficients\
  813. * - encoding: unused\
  814. * - decoding: Set by libavcodec.\
  815. */\
  816. short *dct_coeff;\
  817. \
  818. /**\
  819. * motion referece frame index\
  820. * - encoding: Set by user.\
  821. * - decoding: Set by libavcodec.\
  822. */\
  823. int8_t *ref_index[2];\
  824. \
  825. /**\
  826. * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
  827. * output in AVFrame.reordered_opaque\
  828. * - encoding: unused\
  829. * - decoding: Read by user.\
  830. */\
  831. int64_t reordered_opaque;\
  832. \
  833. /**\
  834. * hardware accelerator private data (FFmpeg allocated)\
  835. * - encoding: unused\
  836. * - decoding: Set by libavcodec\
  837. */\
  838. void *hwaccel_picture_private;\
  839. #define FF_QSCALE_TYPE_MPEG1 0
  840. #define FF_QSCALE_TYPE_MPEG2 1
  841. #define FF_QSCALE_TYPE_H264 2
  842. #define FF_BUFFER_TYPE_INTERNAL 1
  843. #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
  844. #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
  845. #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
  846. #define FF_I_TYPE 1 ///< Intra
  847. #define FF_P_TYPE 2 ///< Predicted
  848. #define FF_B_TYPE 3 ///< Bi-dir predicted
  849. #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
  850. #define FF_SI_TYPE 5 ///< Switching Intra
  851. #define FF_SP_TYPE 6 ///< Switching Predicted
  852. #define FF_BI_TYPE 7
  853. #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
  854. #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
  855. #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
  856. #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
  857. typedef struct AVPacket {
  858. /**
  859. * Presentation timestamp in AVStream->time_base units; the time at which
  860. * the decompressed packet will be presented to the user.
  861. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  862. * pts MUST be larger or equal to dts as presentation cannot happen before
  863. * decompression, unless one wants to view hex dumps. Some formats misuse
  864. * the terms dts and pts/cts to mean something different. Such timestamps
  865. * must be converted to true pts/dts before they are stored in AVPacket.
  866. */
  867. int64_t pts;
  868. /**
  869. * Decompression timestamp in AVStream->time_base units; the time at which
  870. * the packet is decompressed.
  871. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  872. */
  873. int64_t dts;
  874. uint8_t *data;
  875. int size;
  876. int stream_index;
  877. int flags;
  878. /**
  879. * Duration of this packet in AVStream->time_base units, 0 if unknown.
  880. * Equals next_pts - this_pts in presentation order.
  881. */
  882. int duration;
  883. void (*destruct)(struct AVPacket *);
  884. void *priv;
  885. int64_t pos; ///< byte position in stream, -1 if unknown
  886. /**
  887. * Time difference in AVStream->time_base units from the pts of this
  888. * packet to the point at which the output from the decoder has converged
  889. * independent from the availability of previous frames. That is, the
  890. * frames are virtually identical no matter if decoding started from
  891. * the very first frame or from this keyframe.
  892. * Is AV_NOPTS_VALUE if unknown.
  893. * This field is not the display duration of the current packet.
  894. *
  895. * The purpose of this field is to allow seeking in streams that have no
  896. * keyframes in the conventional sense. It corresponds to the
  897. * recovery point SEI in H.264 and match_time_delta in NUT. It is also
  898. * essential for some types of subtitle streams to ensure that all
  899. * subtitles are correctly displayed after seeking.
  900. */
  901. int64_t convergence_duration;
  902. } AVPacket;
  903. #define AV_PKT_FLAG_KEY 0x0001
  904. #if LIBAVCODEC_VERSION_MAJOR < 53
  905. #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
  906. #endif
  907. /**
  908. * Audio Video Frame.
  909. * New fields can be added to the end of FF_COMMON_FRAME with minor version
  910. * bumps.
  911. * Removal, reordering and changes to existing fields require a major
  912. * version bump. No fields should be added into AVFrame before or after
  913. * FF_COMMON_FRAME!
  914. * sizeof(AVFrame) must not be used outside libav*.
  915. */
  916. typedef struct AVFrame {
  917. FF_COMMON_FRAME
  918. } AVFrame;
  919. /**
  920. * main external API structure.
  921. * New fields can be added to the end with minor version bumps.
  922. * Removal, reordering and changes to existing fields require a major
  923. * version bump.
  924. * sizeof(AVCodecContext) must not be used outside libav*.
  925. */
  926. typedef struct AVCodecContext {
  927. /**
  928. * information on struct for av_log
  929. * - set by avcodec_alloc_context
  930. */
  931. const AVClass *av_class;
  932. /**
  933. * the average bitrate
  934. * - encoding: Set by user; unused for constant quantizer encoding.
  935. * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
  936. */
  937. int bit_rate;
  938. /**
  939. * number of bits the bitstream is allowed to diverge from the reference.
  940. * the reference can be CBR (for CBR pass1) or VBR (for pass2)
  941. * - encoding: Set by user; unused for constant quantizer encoding.
  942. * - decoding: unused
  943. */
  944. int bit_rate_tolerance;
  945. /**
  946. * CODEC_FLAG_*.
  947. * - encoding: Set by user.
  948. * - decoding: Set by user.
  949. */
  950. int flags;
  951. /**
  952. * Some codecs need additional format info. It is stored here.
  953. * If any muxer uses this then ALL demuxers/parsers AND encoders for the
  954. * specific codec MUST set it correctly otherwise stream copy breaks.
  955. * In general use of this field by muxers is not recommanded.
  956. * - encoding: Set by libavcodec.
  957. * - decoding: Set by libavcodec. (FIXME: Is this OK?)
  958. */
  959. int sub_id;
  960. /**
  961. * Motion estimation algorithm used for video coding.
  962. * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
  963. * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
  964. * - encoding: MUST be set by user.
  965. * - decoding: unused
  966. */
  967. int me_method;
  968. /**
  969. * some codecs need / can use extradata like Huffman tables.
  970. * mjpeg: Huffman tables
  971. * rv10: additional flags
  972. * mpeg4: global headers (they can be in the bitstream or here)
  973. * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
  974. * than extradata_size to avoid prolems if it is read with the bitstream reader.
  975. * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
  976. * - encoding: Set/allocated/freed by libavcodec.
  977. * - decoding: Set/allocated/freed by user.
  978. */
  979. uint8_t *extradata;
  980. int extradata_size;
  981. /**
  982. * This is the fundamental unit of time (in seconds) in terms
  983. * of which frame timestamps are represented. For fixed-fps content,
  984. * timebase should be 1/framerate and timestamp increments should be
  985. * identically 1.
  986. * - encoding: MUST be set by user.
  987. * - decoding: Set by libavcodec.
  988. */
  989. AVRational time_base;
  990. /* video only */
  991. /**
  992. * picture width / height.
  993. * - encoding: MUST be set by user.
  994. * - decoding: Set by libavcodec.
  995. * Note: For compatibility it is possible to set this instead of
  996. * coded_width/height before decoding.
  997. */
  998. int width, height;
  999. #define FF_ASPECT_EXTENDED 15
  1000. /**
  1001. * the number of pictures in a group of pictures, or 0 for intra_only
  1002. * - encoding: Set by user.
  1003. * - decoding: unused
  1004. */
  1005. int gop_size;
  1006. /**
  1007. * Pixel format, see PIX_FMT_xxx.
  1008. * - encoding: Set by user.
  1009. * - decoding: Set by libavcodec.
  1010. */
  1011. enum PixelFormat pix_fmt;
  1012. /**
  1013. * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
  1014. * has to read frames at native frame rate.
  1015. * - encoding: Set by user.
  1016. * - decoding: unused
  1017. */
  1018. int rate_emu;
  1019. /**
  1020. * If non NULL, 'draw_horiz_band' is called by the libavcodec
  1021. * decoder to draw a horizontal band. It improves cache usage. Not
  1022. * all codecs can do that. You must check the codec capabilities
  1023. * beforehand.
  1024. * The function is also used by hardware acceleration APIs.
  1025. * It is called at least once during frame decoding to pass
  1026. * the data needed for hardware render.
  1027. * In that mode instead of pixel data, AVFrame points to
  1028. * a structure specific to the acceleration API. The application
  1029. * reads the structure and can change some fields to indicate progress
  1030. * or mark state.
  1031. * - encoding: unused
  1032. * - decoding: Set by user.
  1033. * @param height the height of the slice
  1034. * @param y the y position of the slice
  1035. * @param type 1->top field, 2->bottom field, 3->frame
  1036. * @param offset offset into the AVFrame.data from which the slice should be read
  1037. */
  1038. void (*draw_horiz_band)(struct AVCodecContext *s,
  1039. const AVFrame *src, int offset[4],
  1040. int y, int type, int height);
  1041. /* audio only */
  1042. int sample_rate; ///< samples per second
  1043. int channels; ///< number of audio channels
  1044. /**
  1045. * audio sample format
  1046. * - encoding: Set by user.
  1047. * - decoding: Set by libavcodec.
  1048. */
  1049. enum SampleFormat sample_fmt; ///< sample format
  1050. /* The following data should not be initialized. */
  1051. /**
  1052. * Samples per packet, initialized when calling 'init'.
  1053. */
  1054. int frame_size;
  1055. int frame_number; ///< audio or video frame number
  1056. #if LIBAVCODEC_VERSION_MAJOR < 53
  1057. int real_pict_num; ///< Returns the real picture number of previous encoded frame.
  1058. #endif
  1059. /**
  1060. * Number of frames the decoded output will be delayed relative to
  1061. * the encoded input.
  1062. * - encoding: Set by libavcodec.
  1063. * - decoding: unused
  1064. */
  1065. int delay;
  1066. /* - encoding parameters */
  1067. float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
  1068. float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
  1069. /**
  1070. * minimum quantizer
  1071. * - encoding: Set by user.
  1072. * - decoding: unused
  1073. */
  1074. int qmin;
  1075. /**
  1076. * maximum quantizer
  1077. * - encoding: Set by user.
  1078. * - decoding: unused
  1079. */
  1080. int qmax;
  1081. /**
  1082. * maximum quantizer difference between frames
  1083. * - encoding: Set by user.
  1084. * - decoding: unused
  1085. */
  1086. int max_qdiff;
  1087. /**
  1088. * maximum number of B-frames between non-B-frames
  1089. * Note: The output will be delayed by max_b_frames+1 relative to the input.
  1090. * - encoding: Set by user.
  1091. * - decoding: unused
  1092. */
  1093. int max_b_frames;
  1094. /**
  1095. * qscale factor between IP and B-frames
  1096. * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
  1097. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1098. * - encoding: Set by user.
  1099. * - decoding: unused
  1100. */
  1101. float b_quant_factor;
  1102. /** obsolete FIXME remove */
  1103. int rc_strategy;
  1104. #define FF_RC_STRATEGY_XVID 1
  1105. int b_frame_strategy;
  1106. /**
  1107. * hurry up amount
  1108. * - encoding: unused
  1109. * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
  1110. * @deprecated Deprecated in favor of skip_idct and skip_frame.
  1111. */
  1112. int hurry_up;
  1113. struct AVCodec *codec;
  1114. void *priv_data;
  1115. int rtp_payload_size; /* The size of the RTP payload: the coder will */
  1116. /* do its best to deliver a chunk with size */
  1117. /* below rtp_payload_size, the chunk will start */
  1118. /* with a start code on some codecs like H.263. */
  1119. /* This doesn't take account of any particular */
  1120. /* headers inside the transmitted RTP payload. */
  1121. /* The RTP callback: This function is called */
  1122. /* every time the encoder has a packet to send. */
  1123. /* It depends on the encoder if the data starts */
  1124. /* with a Start Code (it should). H.263 does. */
  1125. /* mb_nb contains the number of macroblocks */
  1126. /* encoded in the RTP payload. */
  1127. void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
  1128. /* statistics, used for 2-pass encoding */
  1129. int mv_bits;
  1130. int header_bits;
  1131. int i_tex_bits;
  1132. int p_tex_bits;
  1133. int i_count;
  1134. int p_count;
  1135. int skip_count;
  1136. int misc_bits;
  1137. /**
  1138. * number of bits used for the previously encoded frame
  1139. * - encoding: Set by libavcodec.
  1140. * - decoding: unused
  1141. */
  1142. int frame_bits;
  1143. /**
  1144. * Private data of the user, can be used to carry app specific stuff.
  1145. * - encoding: Set by user.
  1146. * - decoding: Set by user.
  1147. */
  1148. void *opaque;
  1149. char codec_name[32];
  1150. enum CodecType codec_type; /* see CODEC_TYPE_xxx */
  1151. enum CodecID codec_id; /* see CODEC_ID_xxx */
  1152. /**
  1153. * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1154. * This is used to work around some encoder bugs.
  1155. * A demuxer should set this to what is stored in the field used to identify the codec.
  1156. * If there are multiple such fields in a container then the demuxer should choose the one
  1157. * which maximizes the information about the used codec.
  1158. * If the codec tag field in a container is larger then 32 bits then the demuxer should
  1159. * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
  1160. * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
  1161. * first.
  1162. * - encoding: Set by user, if not then the default based on codec_id will be used.
  1163. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1164. */
  1165. unsigned int codec_tag;
  1166. /**
  1167. * Work around bugs in encoders which sometimes cannot be detected automatically.
  1168. * - encoding: Set by user
  1169. * - decoding: Set by user
  1170. */
  1171. int workaround_bugs;
  1172. #define FF_BUG_AUTODETECT 1 ///< autodetection
  1173. #define FF_BUG_OLD_MSMPEG4 2
  1174. #define FF_BUG_XVID_ILACE 4
  1175. #define FF_BUG_UMP4 8
  1176. #define FF_BUG_NO_PADDING 16
  1177. #define FF_BUG_AMV 32
  1178. #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
  1179. #define FF_BUG_QPEL_CHROMA 64
  1180. #define FF_BUG_STD_QPEL 128
  1181. #define FF_BUG_QPEL_CHROMA2 256
  1182. #define FF_BUG_DIRECT_BLOCKSIZE 512
  1183. #define FF_BUG_EDGE 1024
  1184. #define FF_BUG_HPEL_CHROMA 2048
  1185. #define FF_BUG_DC_CLIP 4096
  1186. #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
  1187. //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
  1188. /**
  1189. * luma single coefficient elimination threshold
  1190. * - encoding: Set by user.
  1191. * - decoding: unused
  1192. */
  1193. int luma_elim_threshold;
  1194. /**
  1195. * chroma single coeff elimination threshold
  1196. * - encoding: Set by user.
  1197. * - decoding: unused
  1198. */
  1199. int chroma_elim_threshold;
  1200. /**
  1201. * strictly follow the standard (MPEG4, ...).
  1202. * - encoding: Set by user.
  1203. * - decoding: Set by user.
  1204. * Setting this to STRICT or higher means the encoder and decoder will
  1205. * generally do stupid things. While setting it to inofficial or lower
  1206. * will mean the encoder might use things that are not supported by all
  1207. * spec compliant decoders. Decoders make no difference between normal,
  1208. * inofficial and experimental, that is they always try to decode things
  1209. * when they can unless they are explicitly asked to behave stupid
  1210. * (=strictly conform to the specs)
  1211. */
  1212. int strict_std_compliance;
  1213. #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
  1214. #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
  1215. #define FF_COMPLIANCE_NORMAL 0
  1216. #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
  1217. #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
  1218. /**
  1219. * qscale offset between IP and B-frames
  1220. * - encoding: Set by user.
  1221. * - decoding: unused
  1222. */
  1223. float b_quant_offset;
  1224. /**
  1225. * Error recognization; higher values will detect more errors but may
  1226. * misdetect some more or less valid parts as errors.
  1227. * - encoding: unused
  1228. * - decoding: Set by user.
  1229. */
  1230. int error_recognition;
  1231. #define FF_ER_CAREFUL 1
  1232. #define FF_ER_COMPLIANT 2
  1233. #define FF_ER_AGGRESSIVE 3
  1234. #define FF_ER_VERY_AGGRESSIVE 4
  1235. /**
  1236. * Called at the beginning of each frame to get a buffer for it.
  1237. * If pic.reference is set then the frame will be read later by libavcodec.
  1238. * avcodec_align_dimensions() should be used to find the required width and
  1239. * height, as they normally need to be rounded up to the next multiple of 16.
  1240. * if CODEC_CAP_DR1 is not set then get_buffer() must call
  1241. * avcodec_default_get_buffer() instead of providing buffers allocated by
  1242. * some other means.
  1243. * - encoding: unused
  1244. * - decoding: Set by libavcodec., user can override.
  1245. */
  1246. int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1247. /**
  1248. * Called to release buffers which were allocated with get_buffer.
  1249. * A released buffer can be reused in get_buffer().
  1250. * pic.data[*] must be set to NULL.
  1251. * - encoding: unused
  1252. * - decoding: Set by libavcodec., user can override.
  1253. */
  1254. void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1255. /**
  1256. * Size of the frame reordering buffer in the decoder.
  1257. * For MPEG-2 it is 1 IPB or 0 low delay IP.
  1258. * - encoding: Set by libavcodec.
  1259. * - decoding: Set by libavcodec.
  1260. */
  1261. int has_b_frames;
  1262. /**
  1263. * number of bytes per packet if constant and known or 0
  1264. * Used by some WAV based audio codecs.
  1265. */
  1266. int block_align;
  1267. int parse_only; /* - decoding only: If true, only parsing is done
  1268. (function avcodec_parse_frame()). The frame
  1269. data is returned. Only MPEG codecs support this now. */
  1270. /**
  1271. * 0-> h263 quant 1-> mpeg quant
  1272. * - encoding: Set by user.
  1273. * - decoding: unused
  1274. */
  1275. int mpeg_quant;
  1276. /**
  1277. * pass1 encoding statistics output buffer
  1278. * - encoding: Set by libavcodec.
  1279. * - decoding: unused
  1280. */
  1281. char *stats_out;
  1282. /**
  1283. * pass2 encoding statistics input buffer
  1284. * Concatenated stuff from stats_out of pass1 should be placed here.
  1285. * - encoding: Allocated/set/freed by user.
  1286. * - decoding: unused
  1287. */
  1288. char *stats_in;
  1289. /**
  1290. * ratecontrol qmin qmax limiting method
  1291. * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
  1292. * - encoding: Set by user.
  1293. * - decoding: unused
  1294. */
  1295. float rc_qsquish;
  1296. float rc_qmod_amp;
  1297. int rc_qmod_freq;
  1298. /**
  1299. * ratecontrol override, see RcOverride
  1300. * - encoding: Allocated/set/freed by user.
  1301. * - decoding: unused
  1302. */
  1303. RcOverride *rc_override;
  1304. int rc_override_count;
  1305. /**
  1306. * rate control equation
  1307. * - encoding: Set by user
  1308. * - decoding: unused
  1309. */
  1310. const char *rc_eq;
  1311. /**
  1312. * maximum bitrate
  1313. * - encoding: Set by user.
  1314. * - decoding: unused
  1315. */
  1316. int rc_max_rate;
  1317. /**
  1318. * minimum bitrate
  1319. * - encoding: Set by user.
  1320. * - decoding: unused
  1321. */
  1322. int rc_min_rate;
  1323. /**
  1324. * decoder bitstream buffer size
  1325. * - encoding: Set by user.
  1326. * - decoding: unused
  1327. */
  1328. int rc_buffer_size;
  1329. float rc_buffer_aggressivity;
  1330. /**
  1331. * qscale factor between P and I-frames
  1332. * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
  1333. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1334. * - encoding: Set by user.
  1335. * - decoding: unused
  1336. */
  1337. float i_quant_factor;
  1338. /**
  1339. * qscale offset between P and I-frames
  1340. * - encoding: Set by user.
  1341. * - decoding: unused
  1342. */
  1343. float i_quant_offset;
  1344. /**
  1345. * initial complexity for pass1 ratecontrol
  1346. * - encoding: Set by user.
  1347. * - decoding: unused
  1348. */
  1349. float rc_initial_cplx;
  1350. /**
  1351. * DCT algorithm, see FF_DCT_* below
  1352. * - encoding: Set by user.
  1353. * - decoding: unused
  1354. */
  1355. int dct_algo;
  1356. #define FF_DCT_AUTO 0
  1357. #define FF_DCT_FASTINT 1
  1358. #define FF_DCT_INT 2
  1359. #define FF_DCT_MMX 3
  1360. #define FF_DCT_MLIB 4
  1361. #define FF_DCT_ALTIVEC 5
  1362. #define FF_DCT_FAAN 6
  1363. /**
  1364. * luminance masking (0-> disabled)
  1365. * - encoding: Set by user.
  1366. * - decoding: unused
  1367. */
  1368. float lumi_masking;
  1369. /**
  1370. * temporary complexity masking (0-> disabled)
  1371. * - encoding: Set by user.
  1372. * - decoding: unused
  1373. */
  1374. float temporal_cplx_masking;
  1375. /**
  1376. * spatial complexity masking (0-> disabled)
  1377. * - encoding: Set by user.
  1378. * - decoding: unused
  1379. */
  1380. float spatial_cplx_masking;
  1381. /**
  1382. * p block masking (0-> disabled)
  1383. * - encoding: Set by user.
  1384. * - decoding: unused
  1385. */
  1386. float p_masking;
  1387. /**
  1388. * darkness masking (0-> disabled)
  1389. * - encoding: Set by user.
  1390. * - decoding: unused
  1391. */
  1392. float dark_masking;
  1393. /**
  1394. * IDCT algorithm, see FF_IDCT_* below.
  1395. * - encoding: Set by user.
  1396. * - decoding: Set by user.
  1397. */
  1398. int idct_algo;
  1399. #define FF_IDCT_AUTO 0
  1400. #define FF_IDCT_INT 1
  1401. #define FF_IDCT_SIMPLE 2
  1402. #define FF_IDCT_SIMPLEMMX 3
  1403. #define FF_IDCT_LIBMPEG2MMX 4
  1404. #define FF_IDCT_PS2 5
  1405. #define FF_IDCT_MLIB 6
  1406. #define FF_IDCT_ARM 7
  1407. #define FF_IDCT_ALTIVEC 8
  1408. #define FF_IDCT_SH4 9
  1409. #define FF_IDCT_SIMPLEARM 10
  1410. #define FF_IDCT_H264 11
  1411. #define FF_IDCT_VP3 12
  1412. #define FF_IDCT_IPP 13
  1413. #define FF_IDCT_XVIDMMX 14
  1414. #define FF_IDCT_CAVS 15
  1415. #define FF_IDCT_SIMPLEARMV5TE 16
  1416. #define FF_IDCT_SIMPLEARMV6 17
  1417. #define FF_IDCT_SIMPLEVIS 18
  1418. #define FF_IDCT_WMV2 19
  1419. #define FF_IDCT_FAAN 20
  1420. #define FF_IDCT_EA 21
  1421. #define FF_IDCT_SIMPLENEON 22
  1422. #define FF_IDCT_SIMPLEALPHA 23
  1423. /**
  1424. * slice count
  1425. * - encoding: Set by libavcodec.
  1426. * - decoding: Set by user (or 0).
  1427. */
  1428. int slice_count;
  1429. /**
  1430. * slice offsets in the frame in bytes
  1431. * - encoding: Set/allocated by libavcodec.
  1432. * - decoding: Set/allocated by user (or NULL).
  1433. */
  1434. int *slice_offset;
  1435. /**
  1436. * error concealment flags
  1437. * - encoding: unused
  1438. * - decoding: Set by user.
  1439. */
  1440. int error_concealment;
  1441. #define FF_EC_GUESS_MVS 1
  1442. #define FF_EC_DEBLOCK 2
  1443. /**
  1444. * dsp_mask could be add used to disable unwanted CPU features
  1445. * CPU features (i.e. MMX, SSE. ...)
  1446. *
  1447. * With the FORCE flag you may instead enable given CPU features.
  1448. * (Dangerous: Usable in case of misdetection, improper usage however will
  1449. * result into program crash.)
  1450. */
  1451. unsigned dsp_mask;
  1452. #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
  1453. /* lower 16 bits - CPU features */
  1454. #define FF_MM_MMX 0x0001 ///< standard MMX
  1455. #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
  1456. #if LIBAVCODEC_VERSION_MAJOR < 53
  1457. #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
  1458. #endif
  1459. #define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
  1460. #define FF_MM_SSE 0x0008 ///< SSE functions
  1461. #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
  1462. #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
  1463. #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
  1464. #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
  1465. #define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
  1466. #define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
  1467. #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
  1468. #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
  1469. /**
  1470. * bits per sample/pixel from the demuxer (needed for huffyuv).
  1471. * - encoding: Set by libavcodec.
  1472. * - decoding: Set by user.
  1473. */
  1474. int bits_per_coded_sample;
  1475. /**
  1476. * prediction method (needed for huffyuv)
  1477. * - encoding: Set by user.
  1478. * - decoding: unused
  1479. */
  1480. int prediction_method;
  1481. #define FF_PRED_LEFT 0
  1482. #define FF_PRED_PLANE 1
  1483. #define FF_PRED_MEDIAN 2
  1484. /**
  1485. * sample aspect ratio (0 if unknown)
  1486. * That is the width of a pixel divided by the height of the pixel.
  1487. * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
  1488. * - encoding: Set by user.
  1489. * - decoding: Set by libavcodec.
  1490. */
  1491. AVRational sample_aspect_ratio;
  1492. /**
  1493. * the picture in the bitstream
  1494. * - encoding: Set by libavcodec.
  1495. * - decoding: Set by libavcodec.
  1496. */
  1497. AVFrame *coded_frame;
  1498. /**
  1499. * debug
  1500. * - encoding: Set by user.
  1501. * - decoding: Set by user.
  1502. */
  1503. int debug;
  1504. #define FF_DEBUG_PICT_INFO 1
  1505. #define FF_DEBUG_RC 2
  1506. #define FF_DEBUG_BITSTREAM 4
  1507. #define FF_DEBUG_MB_TYPE 8
  1508. #define FF_DEBUG_QP 16
  1509. #define FF_DEBUG_MV 32
  1510. #define FF_DEBUG_DCT_COEFF 0x00000040
  1511. #define FF_DEBUG_SKIP 0x00000080
  1512. #define FF_DEBUG_STARTCODE 0x00000100
  1513. #define FF_DEBUG_PTS 0x00000200
  1514. #define FF_DEBUG_ER 0x00000400
  1515. #define FF_DEBUG_MMCO 0x00000800
  1516. #define FF_DEBUG_BUGS 0x00001000
  1517. #define FF_DEBUG_VIS_QP 0x00002000
  1518. #define FF_DEBUG_VIS_MB_TYPE 0x00004000
  1519. #define FF_DEBUG_BUFFERS 0x00008000
  1520. /**
  1521. * debug
  1522. * - encoding: Set by user.
  1523. * - decoding: Set by user.
  1524. */
  1525. int debug_mv;
  1526. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
  1527. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
  1528. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
  1529. /**
  1530. * error
  1531. * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
  1532. * - decoding: unused
  1533. */
  1534. uint64_t error[4];
  1535. /**
  1536. * minimum MB quantizer
  1537. * - encoding: unused
  1538. * - decoding: unused
  1539. */
  1540. int mb_qmin;
  1541. /**
  1542. * maximum MB quantizer
  1543. * - encoding: unused
  1544. * - decoding: unused
  1545. */
  1546. int mb_qmax;
  1547. /**
  1548. * motion estimation comparison function
  1549. * - encoding: Set by user.
  1550. * - decoding: unused
  1551. */
  1552. int me_cmp;
  1553. /**
  1554. * subpixel motion estimation comparison function
  1555. * - encoding: Set by user.
  1556. * - decoding: unused
  1557. */
  1558. int me_sub_cmp;
  1559. /**
  1560. * macroblock comparison function (not supported yet)
  1561. * - encoding: Set by user.
  1562. * - decoding: unused
  1563. */
  1564. int mb_cmp;
  1565. /**
  1566. * interlaced DCT comparison function
  1567. * - encoding: Set by user.
  1568. * - decoding: unused
  1569. */
  1570. int ildct_cmp;
  1571. #define FF_CMP_SAD 0
  1572. #define FF_CMP_SSE 1
  1573. #define FF_CMP_SATD 2
  1574. #define FF_CMP_DCT 3
  1575. #define FF_CMP_PSNR 4
  1576. #define FF_CMP_BIT 5
  1577. #define FF_CMP_RD 6
  1578. #define FF_CMP_ZERO 7
  1579. #define FF_CMP_VSAD 8
  1580. #define FF_CMP_VSSE 9
  1581. #define FF_CMP_NSSE 10
  1582. #define FF_CMP_W53 11
  1583. #define FF_CMP_W97 12
  1584. #define FF_CMP_DCTMAX 13
  1585. #define FF_CMP_DCT264 14
  1586. #define FF_CMP_CHROMA 256
  1587. /**
  1588. * ME diamond size & shape
  1589. * - encoding: Set by user.
  1590. * - decoding: unused
  1591. */
  1592. int dia_size;
  1593. /**
  1594. * amount of previous MV predictors (2a+1 x 2a+1 square)
  1595. * - encoding: Set by user.
  1596. * - decoding: unused
  1597. */
  1598. int last_predictor_count;
  1599. /**
  1600. * prepass for motion estimation
  1601. * - encoding: Set by user.
  1602. * - decoding: unused
  1603. */
  1604. int pre_me;
  1605. /**
  1606. * motion estimation prepass comparison function
  1607. * - encoding: Set by user.
  1608. * - decoding: unused
  1609. */
  1610. int me_pre_cmp;
  1611. /**
  1612. * ME prepass diamond size & shape
  1613. * - encoding: Set by user.
  1614. * - decoding: unused
  1615. */
  1616. int pre_dia_size;
  1617. /**
  1618. * subpel ME quality
  1619. * - encoding: Set by user.
  1620. * - decoding: unused
  1621. */
  1622. int me_subpel_quality;
  1623. /**
  1624. * callback to negotiate the pixelFormat
  1625. * @param fmt is the list of formats which are supported by the codec,
  1626. * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
  1627. * The first is always the native one.
  1628. * @return the chosen format
  1629. * - encoding: unused
  1630. * - decoding: Set by user, if not set the native format will be chosen.
  1631. */
  1632. enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
  1633. /**
  1634. * DTG active format information (additional aspect ratio
  1635. * information only used in DVB MPEG-2 transport streams)
  1636. * 0 if not set.
  1637. *
  1638. * - encoding: unused
  1639. * - decoding: Set by decoder.
  1640. */
  1641. int dtg_active_format;
  1642. #define FF_DTG_AFD_SAME 8
  1643. #define FF_DTG_AFD_4_3 9
  1644. #define FF_DTG_AFD_16_9 10
  1645. #define FF_DTG_AFD_14_9 11
  1646. #define FF_DTG_AFD_4_3_SP_14_9 13
  1647. #define FF_DTG_AFD_16_9_SP_14_9 14
  1648. #define FF_DTG_AFD_SP_4_3 15
  1649. /**
  1650. * maximum motion estimation search range in subpel units
  1651. * If 0 then no limit.
  1652. *
  1653. * - encoding: Set by user.
  1654. * - decoding: unused
  1655. */
  1656. int me_range;
  1657. /**
  1658. * intra quantizer bias
  1659. * - encoding: Set by user.
  1660. * - decoding: unused
  1661. */
  1662. int intra_quant_bias;
  1663. #define FF_DEFAULT_QUANT_BIAS 999999
  1664. /**
  1665. * inter quantizer bias
  1666. * - encoding: Set by user.
  1667. * - decoding: unused
  1668. */
  1669. int inter_quant_bias;
  1670. /**
  1671. * color table ID
  1672. * - encoding: unused
  1673. * - decoding: Which clrtable should be used for 8bit RGB images.
  1674. * Tables have to be stored somewhere. FIXME
  1675. */
  1676. int color_table_id;
  1677. /**
  1678. * internal_buffer count
  1679. * Don't touch, used by libavcodec default_get_buffer().
  1680. */
  1681. int internal_buffer_count;
  1682. /**
  1683. * internal_buffers
  1684. * Don't touch, used by libavcodec default_get_buffer().
  1685. */
  1686. void *internal_buffer;
  1687. #define FF_LAMBDA_SHIFT 7
  1688. #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
  1689. #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
  1690. #define FF_LAMBDA_MAX (256*128-1)
  1691. #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
  1692. /**
  1693. * Global quality for codecs which cannot change it per frame.
  1694. * This should be proportional to MPEG-1/2/4 qscale.
  1695. * - encoding: Set by user.
  1696. * - decoding: unused
  1697. */
  1698. int global_quality;
  1699. #define FF_CODER_TYPE_VLC 0
  1700. #define FF_CODER_TYPE_AC 1
  1701. #define FF_CODER_TYPE_RAW 2
  1702. #define FF_CODER_TYPE_RLE 3
  1703. #define FF_CODER_TYPE_DEFLATE 4
  1704. /**
  1705. * coder type
  1706. * - encoding: Set by user.
  1707. * - decoding: unused
  1708. */
  1709. int coder_type;
  1710. /**
  1711. * context model
  1712. * - encoding: Set by user.
  1713. * - decoding: unused
  1714. */
  1715. int context_model;
  1716. #if 0
  1717. /**
  1718. *
  1719. * - encoding: unused
  1720. * - decoding: Set by user.
  1721. */
  1722. uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
  1723. #endif
  1724. /**
  1725. * slice flags
  1726. * - encoding: unused
  1727. * - decoding: Set by user.
  1728. */
  1729. int slice_flags;
  1730. #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
  1731. #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
  1732. #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
  1733. /**
  1734. * XVideo Motion Acceleration
  1735. * - encoding: forbidden
  1736. * - decoding: set by decoder
  1737. */
  1738. int xvmc_acceleration;
  1739. /**
  1740. * macroblock decision mode
  1741. * - encoding: Set by user.
  1742. * - decoding: unused
  1743. */
  1744. int mb_decision;
  1745. #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
  1746. #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
  1747. #define FF_MB_DECISION_RD 2 ///< rate distortion
  1748. /**
  1749. * custom intra quantization matrix
  1750. * - encoding: Set by user, can be NULL.
  1751. * - decoding: Set by libavcodec.
  1752. */
  1753. uint16_t *intra_matrix;
  1754. /**
  1755. * custom inter quantization matrix
  1756. * - encoding: Set by user, can be NULL.
  1757. * - decoding: Set by libavcodec.
  1758. */
  1759. uint16_t *inter_matrix;
  1760. /**
  1761. * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1762. * This is used to work around some encoder bugs.
  1763. * - encoding: unused
  1764. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1765. */
  1766. unsigned int stream_codec_tag;
  1767. /**
  1768. * scene change detection threshold
  1769. * 0 is default, larger means fewer detected scene changes.
  1770. * - encoding: Set by user.
  1771. * - decoding: unused
  1772. */
  1773. int scenechange_threshold;
  1774. /**
  1775. * minimum Lagrange multipler
  1776. * - encoding: Set by user.
  1777. * - decoding: unused
  1778. */
  1779. int lmin;
  1780. /**
  1781. * maximum Lagrange multipler
  1782. * - encoding: Set by user.
  1783. * - decoding: unused
  1784. */
  1785. int lmax;
  1786. /**
  1787. * palette control structure
  1788. * - encoding: ??? (no palette-enabled encoder yet)
  1789. * - decoding: Set by user.
  1790. */
  1791. struct AVPaletteControl *palctrl;
  1792. /**
  1793. * noise reduction strength
  1794. * - encoding: Set by user.
  1795. * - decoding: unused
  1796. */
  1797. int noise_reduction;
  1798. /**
  1799. * Called at the beginning of a frame to get cr buffer for it.
  1800. * Buffer type (size, hints) must be the same. libavcodec won't check it.
  1801. * libavcodec will pass previous buffer in pic, function should return
  1802. * same buffer or new buffer with old frame "painted" into it.
  1803. * If pic.data[0] == NULL must behave like get_buffer().
  1804. * if CODEC_CAP_DR1 is not set then reget_buffer() must call
  1805. * avcodec_default_reget_buffer() instead of providing buffers allocated by
  1806. * some other means.
  1807. * - encoding: unused
  1808. * - decoding: Set by libavcodec., user can override
  1809. */
  1810. int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1811. /**
  1812. * Number of bits which should be loaded into the rc buffer before decoding starts.
  1813. * - encoding: Set by user.
  1814. * - decoding: unused
  1815. */
  1816. int rc_initial_buffer_occupancy;
  1817. /**
  1818. *
  1819. * - encoding: Set by user.
  1820. * - decoding: unused
  1821. */
  1822. int inter_threshold;
  1823. /**
  1824. * CODEC_FLAG2_*
  1825. * - encoding: Set by user.
  1826. * - decoding: Set by user.
  1827. */
  1828. int flags2;
  1829. /**
  1830. * Simulates errors in the bitstream to test error concealment.
  1831. * - encoding: Set by user.
  1832. * - decoding: unused
  1833. */
  1834. int error_rate;
  1835. /**
  1836. * MP3 antialias algorithm, see FF_AA_* below.
  1837. * - encoding: unused
  1838. * - decoding: Set by user.
  1839. */
  1840. int antialias_algo;
  1841. #define FF_AA_AUTO 0
  1842. #define FF_AA_FASTINT 1 //not implemented yet
  1843. #define FF_AA_INT 2
  1844. #define FF_AA_FLOAT 3
  1845. /**
  1846. * quantizer noise shaping
  1847. * - encoding: Set by user.
  1848. * - decoding: unused
  1849. */
  1850. int quantizer_noise_shaping;
  1851. /**
  1852. * thread count
  1853. * is used to decide how many independent tasks should be passed to execute()
  1854. * - encoding: Set by user.
  1855. * - decoding: Set by user.
  1856. */
  1857. int thread_count;
  1858. /**
  1859. * The codec may call this to execute several independent things.
  1860. * It will return only after finishing all tasks.
  1861. * The user may replace this with some multithreaded implementation,
  1862. * the default implementation will execute the parts serially.
  1863. * @param count the number of things to execute
  1864. * - encoding: Set by libavcodec, user can override.
  1865. * - decoding: Set by libavcodec, user can override.
  1866. */
  1867. int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
  1868. /**
  1869. * thread opaque
  1870. * Can be used by execute() to store some per AVCodecContext stuff.
  1871. * - encoding: set by execute()
  1872. * - decoding: set by execute()
  1873. */
  1874. void *thread_opaque;
  1875. /**
  1876. * Motion estimation threshold below which no motion estimation is
  1877. * performed, but instead the user specified motion vectors are used.
  1878. *
  1879. * - encoding: Set by user.
  1880. * - decoding: unused
  1881. */
  1882. int me_threshold;
  1883. /**
  1884. * Macroblock threshold below which the user specified macroblock types will be used.
  1885. * - encoding: Set by user.
  1886. * - decoding: unused
  1887. */
  1888. int mb_threshold;
  1889. /**
  1890. * precision of the intra DC coefficient - 8
  1891. * - encoding: Set by user.
  1892. * - decoding: unused
  1893. */
  1894. int intra_dc_precision;
  1895. /**
  1896. * noise vs. sse weight for the nsse comparsion function
  1897. * - encoding: Set by user.
  1898. * - decoding: unused
  1899. */
  1900. int nsse_weight;
  1901. /**
  1902. * Number of macroblock rows at the top which are skipped.
  1903. * - encoding: unused
  1904. * - decoding: Set by user.
  1905. */
  1906. int skip_top;
  1907. /**
  1908. * Number of macroblock rows at the bottom which are skipped.
  1909. * - encoding: unused
  1910. * - decoding: Set by user.
  1911. */
  1912. int skip_bottom;
  1913. /**
  1914. * profile
  1915. * - encoding: Set by user.
  1916. * - decoding: Set by libavcodec.
  1917. */
  1918. int profile;
  1919. #define FF_PROFILE_UNKNOWN -99
  1920. #define FF_PROFILE_AAC_MAIN 0
  1921. #define FF_PROFILE_AAC_LOW 1
  1922. #define FF_PROFILE_AAC_SSR 2
  1923. #define FF_PROFILE_AAC_LTP 3
  1924. /**
  1925. * level
  1926. * - encoding: Set by user.
  1927. * - decoding: Set by libavcodec.
  1928. */
  1929. int level;
  1930. #define FF_LEVEL_UNKNOWN -99
  1931. /**
  1932. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  1933. * - encoding: unused
  1934. * - decoding: Set by user.
  1935. */
  1936. int lowres;
  1937. /**
  1938. * Bitstream width / height, may be different from width/height if lowres
  1939. * or other things are used.
  1940. * - encoding: unused
  1941. * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
  1942. */
  1943. int coded_width, coded_height;
  1944. /**
  1945. * frame skip threshold
  1946. * - encoding: Set by user.
  1947. * - decoding: unused
  1948. */
  1949. int frame_skip_threshold;
  1950. /**
  1951. * frame skip factor
  1952. * - encoding: Set by user.
  1953. * - decoding: unused
  1954. */
  1955. int frame_skip_factor;
  1956. /**
  1957. * frame skip exponent
  1958. * - encoding: Set by user.
  1959. * - decoding: unused
  1960. */
  1961. int frame_skip_exp;
  1962. /**
  1963. * frame skip comparison function
  1964. * - encoding: Set by user.
  1965. * - decoding: unused
  1966. */
  1967. int frame_skip_cmp;
  1968. /**
  1969. * Border processing masking, raises the quantizer for mbs on the borders
  1970. * of the picture.
  1971. * - encoding: Set by user.
  1972. * - decoding: unused
  1973. */
  1974. float border_masking;
  1975. /**
  1976. * minimum MB lagrange multipler
  1977. * - encoding: Set by user.
  1978. * - decoding: unused
  1979. */
  1980. int mb_lmin;
  1981. /**
  1982. * maximum MB lagrange multipler
  1983. * - encoding: Set by user.
  1984. * - decoding: unused
  1985. */
  1986. int mb_lmax;
  1987. /**
  1988. *
  1989. * - encoding: Set by user.
  1990. * - decoding: unused
  1991. */
  1992. int me_penalty_compensation;
  1993. /**
  1994. *
  1995. * - encoding: unused
  1996. * - decoding: Set by user.
  1997. */
  1998. enum AVDiscard skip_loop_filter;
  1999. /**
  2000. *
  2001. * - encoding: unused
  2002. * - decoding: Set by user.
  2003. */
  2004. enum AVDiscard skip_idct;
  2005. /**
  2006. *
  2007. * - encoding: unused
  2008. * - decoding: Set by user.
  2009. */
  2010. enum AVDiscard skip_frame;
  2011. /**
  2012. *
  2013. * - encoding: Set by user.
  2014. * - decoding: unused
  2015. */
  2016. int bidir_refine;
  2017. /**
  2018. *
  2019. * - encoding: Set by user.
  2020. * - decoding: unused
  2021. */
  2022. int brd_scale;
  2023. /**
  2024. * constant rate factor - quality-based VBR - values ~correspond to qps
  2025. * - encoding: Set by user.
  2026. * - decoding: unused
  2027. */
  2028. float crf;
  2029. /**
  2030. * constant quantization parameter rate control method
  2031. * - encoding: Set by user.
  2032. * - decoding: unused
  2033. */
  2034. int cqp;
  2035. /**
  2036. * minimum GOP size
  2037. * - encoding: Set by user.
  2038. * - decoding: unused
  2039. */
  2040. int keyint_min;
  2041. /**
  2042. * number of reference frames
  2043. * - encoding: Set by user.
  2044. * - decoding: Set by lavc.
  2045. */
  2046. int refs;
  2047. /**
  2048. * chroma qp offset from luma
  2049. * - encoding: Set by user.
  2050. * - decoding: unused
  2051. */
  2052. int chromaoffset;
  2053. /**
  2054. * Influences how often B-frames are used.
  2055. * - encoding: Set by user.
  2056. * - decoding: unused
  2057. */
  2058. int bframebias;
  2059. /**
  2060. * trellis RD quantization
  2061. * - encoding: Set by user.
  2062. * - decoding: unused
  2063. */
  2064. int trellis;
  2065. /**
  2066. * Reduce fluctuations in qp (before curve compression).
  2067. * - encoding: Set by user.
  2068. * - decoding: unused
  2069. */
  2070. float complexityblur;
  2071. /**
  2072. * in-loop deblocking filter alphac0 parameter
  2073. * alpha is in the range -6...6
  2074. * - encoding: Set by user.
  2075. * - decoding: unused
  2076. */
  2077. int deblockalpha;
  2078. /**
  2079. * in-loop deblocking filter beta parameter
  2080. * beta is in the range -6...6
  2081. * - encoding: Set by user.
  2082. * - decoding: unused
  2083. */
  2084. int deblockbeta;
  2085. /**
  2086. * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
  2087. * - encoding: Set by user.
  2088. * - decoding: unused
  2089. */
  2090. int partitions;
  2091. #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
  2092. #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
  2093. #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
  2094. #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
  2095. #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
  2096. /**
  2097. * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
  2098. * - encoding: Set by user.
  2099. * - decoding: unused
  2100. */
  2101. int directpred;
  2102. /**
  2103. * Audio cutoff bandwidth (0 means "automatic")
  2104. * - encoding: Set by user.
  2105. * - decoding: unused
  2106. */
  2107. int cutoff;
  2108. /**
  2109. * Multiplied by qscale for each frame and added to scene_change_score.
  2110. * - encoding: Set by user.
  2111. * - decoding: unused
  2112. */
  2113. int scenechange_factor;
  2114. /**
  2115. *
  2116. * Note: Value depends upon the compare function used for fullpel ME.
  2117. * - encoding: Set by user.
  2118. * - decoding: unused
  2119. */
  2120. int mv0_threshold;
  2121. /**
  2122. * Adjusts sensitivity of b_frame_strategy 1.
  2123. * - encoding: Set by user.
  2124. * - decoding: unused
  2125. */
  2126. int b_sensitivity;
  2127. /**
  2128. * - encoding: Set by user.
  2129. * - decoding: unused
  2130. */
  2131. int compression_level;
  2132. #define FF_COMPRESSION_DEFAULT -1
  2133. /**
  2134. * Sets whether to use LPC mode - used by FLAC encoder.
  2135. * - encoding: Set by user.
  2136. * - decoding: unused
  2137. */
  2138. int use_lpc;
  2139. /**
  2140. * LPC coefficient precision - used by FLAC encoder
  2141. * - encoding: Set by user.
  2142. * - decoding: unused
  2143. */
  2144. int lpc_coeff_precision;
  2145. /**
  2146. * - encoding: Set by user.
  2147. * - decoding: unused
  2148. */
  2149. int min_prediction_order;
  2150. /**
  2151. * - encoding: Set by user.
  2152. * - decoding: unused
  2153. */
  2154. int max_prediction_order;
  2155. /**
  2156. * search method for selecting prediction order
  2157. * - encoding: Set by user.
  2158. * - decoding: unused
  2159. */
  2160. int prediction_order_method;
  2161. /**
  2162. * - encoding: Set by user.
  2163. * - decoding: unused
  2164. */
  2165. int min_partition_order;
  2166. /**
  2167. * - encoding: Set by user.
  2168. * - decoding: unused
  2169. */
  2170. int max_partition_order;
  2171. /**
  2172. * GOP timecode frame start number, in non drop frame format
  2173. * - encoding: Set by user.
  2174. * - decoding: unused
  2175. */
  2176. int64_t timecode_frame_start;
  2177. #if LIBAVCODEC_VERSION_MAJOR < 53
  2178. /**
  2179. * Decoder should decode to this many channels if it can (0 for default)
  2180. * - encoding: unused
  2181. * - decoding: Set by user.
  2182. * @deprecated Deprecated in favor of request_channel_layout.
  2183. */
  2184. int request_channels;
  2185. #endif
  2186. /**
  2187. * Percentage of dynamic range compression to be applied by the decoder.
  2188. * The default value is 1.0, corresponding to full compression.
  2189. * - encoding: unused
  2190. * - decoding: Set by user.
  2191. */
  2192. float drc_scale;
  2193. /**
  2194. * opaque 64bit number (generally a PTS) that will be reordered and
  2195. * output in AVFrame.reordered_opaque
  2196. * - encoding: unused
  2197. * - decoding: Set by user.
  2198. */
  2199. int64_t reordered_opaque;
  2200. /**
  2201. * Bits per sample/pixel of internal libavcodec pixel/sample format.
  2202. * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
  2203. * - encoding: set by user.
  2204. * - decoding: set by libavcodec.
  2205. */
  2206. int bits_per_raw_sample;
  2207. /**
  2208. * Audio channel layout.
  2209. * - encoding: set by user.
  2210. * - decoding: set by libavcodec.
  2211. */
  2212. int64_t channel_layout;
  2213. /**
  2214. * Request decoder to use this channel layout if it can (0 for default)
  2215. * - encoding: unused
  2216. * - decoding: Set by user.
  2217. */
  2218. int64_t request_channel_layout;
  2219. /**
  2220. * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
  2221. * - encoding: Set by user.
  2222. * - decoding: unused.
  2223. */
  2224. float rc_max_available_vbv_use;
  2225. /**
  2226. * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
  2227. * - encoding: Set by user.
  2228. * - decoding: unused.
  2229. */
  2230. float rc_min_vbv_overflow_use;
  2231. /**
  2232. * Hardware accelerator in use
  2233. * - encoding: unused.
  2234. * - decoding: Set by libavcodec
  2235. */
  2236. struct AVHWAccel *hwaccel;
  2237. /**
  2238. * For some codecs, the time base is closer to the field rate than the frame rate.
  2239. * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
  2240. * if no telecine is used ...
  2241. *
  2242. * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
  2243. */
  2244. int ticks_per_frame;
  2245. /**
  2246. * Hardware accelerator context.
  2247. * For some hardware accelerators, a global context needs to be
  2248. * provided by the user. In that case, this holds display-dependent
  2249. * data FFmpeg cannot instantiate itself. Please refer to the
  2250. * FFmpeg HW accelerator documentation to know how to fill this
  2251. * is. e.g. for VA API, this is a struct vaapi_context.
  2252. * - encoding: unused
  2253. * - decoding: Set by user
  2254. */
  2255. void *hwaccel_context;
  2256. /**
  2257. * Chromaticity coordinates of the source primaries.
  2258. * - encoding: Set by user
  2259. * - decoding: Set by libavcodec
  2260. */
  2261. enum AVColorPrimaries color_primaries;
  2262. /**
  2263. * Color Transfer Characteristic.
  2264. * - encoding: Set by user
  2265. * - decoding: Set by libavcodec
  2266. */
  2267. enum AVColorTransferCharacteristic color_trc;
  2268. /**
  2269. * YUV colorspace type.
  2270. * - encoding: Set by user
  2271. * - decoding: Set by libavcodec
  2272. */
  2273. enum AVColorSpace colorspace;
  2274. /**
  2275. * MPEG vs JPEG YUV range.
  2276. * - encoding: Set by user
  2277. * - decoding: Set by libavcodec
  2278. */
  2279. enum AVColorRange color_range;
  2280. /**
  2281. * This defines the location of chroma samples.
  2282. * - encoding: Set by user
  2283. * - decoding: Set by libavcodec
  2284. */
  2285. enum AVChromaLocation chroma_sample_location;
  2286. } AVCodecContext;
  2287. /**
  2288. * AVCodec.
  2289. */
  2290. typedef struct AVCodec {
  2291. /**
  2292. * Name of the codec implementation.
  2293. * The name is globally unique among encoders and among decoders (but an
  2294. * encoder and a decoder can share the same name).
  2295. * This is the primary way to find a codec from the user perspective.
  2296. */
  2297. const char *name;
  2298. enum CodecType type;
  2299. enum CodecID id;
  2300. int priv_data_size;
  2301. int (*init)(AVCodecContext *);
  2302. int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
  2303. int (*close)(AVCodecContext *);
  2304. int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
  2305. /**
  2306. * Codec capabilities.
  2307. * see CODEC_CAP_*
  2308. */
  2309. int capabilities;
  2310. struct AVCodec *next;
  2311. /**
  2312. * Flush buffers.
  2313. * Will be called when seeking
  2314. */
  2315. void (*flush)(AVCodecContext *);
  2316. const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
  2317. const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
  2318. /**
  2319. * Descriptive name for the codec, meant to be more human readable than name.
  2320. * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
  2321. */
  2322. const char *long_name;
  2323. const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
  2324. const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
  2325. const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
  2326. } AVCodec;
  2327. /**
  2328. * AVHWAccel.
  2329. */
  2330. typedef struct AVHWAccel {
  2331. /**
  2332. * Name of the hardware accelerated codec.
  2333. * The name is globally unique among encoders and among decoders (but an
  2334. * encoder and a decoder can share the same name).
  2335. */
  2336. const char *name;
  2337. /**
  2338. * Type of codec implemented by the hardware accelerator.
  2339. *
  2340. * See CODEC_TYPE_xxx
  2341. */
  2342. enum CodecType type;
  2343. /**
  2344. * Codec implemented by the hardware accelerator.
  2345. *
  2346. * See CODEC_ID_xxx
  2347. */
  2348. enum CodecID id;
  2349. /**
  2350. * Supported pixel format.
  2351. *
  2352. * Only hardware accelerated formats are supported here.
  2353. */
  2354. enum PixelFormat pix_fmt;
  2355. /**
  2356. * Hardware accelerated codec capabilities.
  2357. * see FF_HWACCEL_CODEC_CAP_*
  2358. */
  2359. int capabilities;
  2360. struct AVHWAccel *next;
  2361. /**
  2362. * Called at the beginning of each frame or field picture.
  2363. *
  2364. * Meaningful frame information (codec specific) is guaranteed to
  2365. * be parsed at this point. This function is mandatory.
  2366. *
  2367. * Note that buf can be NULL along with buf_size set to 0.
  2368. * Otherwise, this means the whole frame is available at this point.
  2369. *
  2370. * @param avctx the codec context
  2371. * @param buf the frame data buffer base
  2372. * @param buf_size the size of the frame in bytes
  2373. * @return zero if successful, a negative value otherwise
  2374. */
  2375. int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  2376. /**
  2377. * Callback for each slice.
  2378. *
  2379. * Meaningful slice information (codec specific) is guaranteed to
  2380. * be parsed at this point. This function is mandatory.
  2381. *
  2382. * @param avctx the codec context
  2383. * @param buf the slice data buffer base
  2384. * @param buf_size the size of the slice in bytes
  2385. * @return zero if successful, a negative value otherwise
  2386. */
  2387. int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  2388. /**
  2389. * Called at the end of each frame or field picture.
  2390. *
  2391. * The whole picture is parsed at this point and can now be sent
  2392. * to the hardware accelerator. This function is mandatory.
  2393. *
  2394. * @param avctx the codec context
  2395. * @return zero if successful, a negative value otherwise
  2396. */
  2397. int (*end_frame)(AVCodecContext *avctx);
  2398. /**
  2399. * Size of HW accelerator private data.
  2400. *
  2401. * Private data is allocated with av_mallocz() before
  2402. * AVCodecContext.get_buffer() and deallocated after
  2403. * AVCodecContext.release_buffer().
  2404. */
  2405. int priv_data_size;
  2406. } AVHWAccel;
  2407. /**
  2408. * four components are given, that's all.
  2409. * the last component is alpha
  2410. */
  2411. typedef struct AVPicture {
  2412. uint8_t *data[4];
  2413. int linesize[4]; ///< number of bytes per line
  2414. } AVPicture;
  2415. #if LIBAVCODEC_VERSION_MAJOR < 53
  2416. /**
  2417. * AVPaletteControl
  2418. * This structure defines a method for communicating palette changes
  2419. * between and demuxer and a decoder.
  2420. *
  2421. * @deprecated Use AVPacket to send palette changes instead.
  2422. * This is totally broken.
  2423. */
  2424. #define AVPALETTE_SIZE 1024
  2425. #define AVPALETTE_COUNT 256
  2426. typedef struct AVPaletteControl {
  2427. /* Demuxer sets this to 1 to indicate the palette has changed;
  2428. * decoder resets to 0. */
  2429. int palette_changed;
  2430. /* 4-byte ARGB palette entries, stored in native byte order; note that
  2431. * the individual palette components should be on a 8-bit scale; if
  2432. * the palette data comes from an IBM VGA native format, the component
  2433. * data is probably 6 bits in size and needs to be scaled. */
  2434. unsigned int palette[AVPALETTE_COUNT];
  2435. } AVPaletteControl attribute_deprecated;
  2436. #endif
  2437. enum AVSubtitleType {
  2438. SUBTITLE_NONE,
  2439. SUBTITLE_BITMAP, ///< A bitmap, pict will be set
  2440. /**
  2441. * Plain text, the text field must be set by the decoder and is
  2442. * authoritative. ass and pict fields may contain approximations.
  2443. */
  2444. SUBTITLE_TEXT,
  2445. /**
  2446. * Formatted text, the ass field must be set by the decoder and is
  2447. * authoritative. pict and text fields may contain approximations.
  2448. */
  2449. SUBTITLE_ASS,
  2450. };
  2451. typedef struct AVSubtitleRect {
  2452. int x; ///< top left corner of pict, undefined when pict is not set
  2453. int y; ///< top left corner of pict, undefined when pict is not set
  2454. int w; ///< width of pict, undefined when pict is not set
  2455. int h; ///< height of pict, undefined when pict is not set
  2456. int nb_colors; ///< number of colors in pict, undefined when pict is not set
  2457. /**
  2458. * data+linesize for the bitmap of this subtitle.
  2459. * can be set for text/ass as well once they where rendered
  2460. */
  2461. AVPicture pict;
  2462. enum AVSubtitleType type;
  2463. char *text; ///< 0 terminated plain UTF-8 text
  2464. /**
  2465. * 0 terminated ASS/SSA compatible event line.
  2466. * The pressentation of this is unaffected by the other values in this
  2467. * struct.
  2468. */
  2469. char *ass;
  2470. } AVSubtitleRect;
  2471. typedef struct AVSubtitle {
  2472. uint16_t format; /* 0 = graphics */
  2473. uint32_t start_display_time; /* relative to packet pts, in ms */
  2474. uint32_t end_display_time; /* relative to packet pts, in ms */
  2475. unsigned num_rects;
  2476. AVSubtitleRect **rects;
  2477. int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
  2478. } AVSubtitle;
  2479. /* packet functions */
  2480. /**
  2481. * @deprecated use NULL instead
  2482. */
  2483. attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
  2484. /**
  2485. * Default packet destructor.
  2486. */
  2487. void av_destruct_packet(AVPacket *pkt);
  2488. /**
  2489. * Initialize optional fields of a packet with default values.
  2490. *
  2491. * @param pkt packet
  2492. */
  2493. void av_init_packet(AVPacket *pkt);
  2494. /**
  2495. * Allocate the payload of a packet and initialize its fields with
  2496. * default values.
  2497. *
  2498. * @param pkt packet
  2499. * @param size wanted payload size
  2500. * @return 0 if OK, AVERROR_xxx otherwise
  2501. */
  2502. int av_new_packet(AVPacket *pkt, int size);
  2503. /**
  2504. * Reduce packet size, correctly zeroing padding
  2505. *
  2506. * @param pkt packet
  2507. * @param size new size
  2508. */
  2509. void av_shrink_packet(AVPacket *pkt, int size);
  2510. /**
  2511. * @warning This is a hack - the packet memory allocation stuff is broken. The
  2512. * packet is allocated if it was not really allocated.
  2513. */
  2514. int av_dup_packet(AVPacket *pkt);
  2515. /**
  2516. * Free a packet.
  2517. *
  2518. * @param pkt packet to free
  2519. */
  2520. void av_free_packet(AVPacket *pkt);
  2521. /* resample.c */
  2522. struct ReSampleContext;
  2523. struct AVResampleContext;
  2524. typedef struct ReSampleContext ReSampleContext;
  2525. #if LIBAVCODEC_VERSION_MAJOR < 53
  2526. /**
  2527. * @deprecated Use av_audio_resample_init() instead.
  2528. */
  2529. attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
  2530. int output_rate, int input_rate);
  2531. #endif
  2532. /**
  2533. * Initializes audio resampling context
  2534. *
  2535. * @param output_channels number of output channels
  2536. * @param input_channels number of input channels
  2537. * @param output_rate output sample rate
  2538. * @param input_rate input sample rate
  2539. * @param sample_fmt_out requested output sample format
  2540. * @param sample_fmt_in input sample format
  2541. * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
  2542. * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  2543. * @param linear If 1 then the used FIR filter will be linearly interpolated
  2544. between the 2 closest, if 0 the closest will be used
  2545. * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
  2546. * @return allocated ReSampleContext, NULL if error occured
  2547. */
  2548. ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
  2549. int output_rate, int input_rate,
  2550. enum SampleFormat sample_fmt_out,
  2551. enum SampleFormat sample_fmt_in,
  2552. int filter_length, int log2_phase_count,
  2553. int linear, double cutoff);
  2554. int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
  2555. void audio_resample_close(ReSampleContext *s);
  2556. /**
  2557. * Initializes an audio resampler.
  2558. * Note, if either rate is not an integer then simply scale both rates up so they are.
  2559. * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
  2560. * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  2561. * @param linear If 1 then the used FIR filter will be linearly interpolated
  2562. between the 2 closest, if 0 the closest will be used
  2563. * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
  2564. */
  2565. struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
  2566. /**
  2567. * resamples.
  2568. * @param src an array of unconsumed samples
  2569. * @param consumed the number of samples of src which have been consumed are returned here
  2570. * @param src_size the number of unconsumed samples available
  2571. * @param dst_size the amount of space in samples available in dst
  2572. * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
  2573. * @return the number of samples written in dst or -1 if an error occurred
  2574. */
  2575. int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
  2576. /**
  2577. * Compensates samplerate/timestamp drift. The compensation is done by changing
  2578. * the resampler parameters, so no audible clicks or similar distortions occur
  2579. * @param compensation_distance distance in output samples over which the compensation should be performed
  2580. * @param sample_delta number of output samples which should be output less
  2581. *
  2582. * example: av_resample_compensate(c, 10, 500)
  2583. * here instead of 510 samples only 500 samples would be output
  2584. *
  2585. * note, due to rounding the actual compensation might be slightly different,
  2586. * especially if the compensation_distance is large and the in_rate used during init is small
  2587. */
  2588. void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
  2589. void av_resample_close(struct AVResampleContext *c);
  2590. /**
  2591. * Allocate memory for a picture. Call avpicture_free to free it.
  2592. *
  2593. * @param picture the picture to be filled in
  2594. * @param pix_fmt the format of the picture
  2595. * @param width the width of the picture
  2596. * @param height the height of the picture
  2597. * @return zero if successful, a negative value if not
  2598. */
  2599. int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
  2600. /**
  2601. * Free a picture previously allocated by avpicture_alloc().
  2602. *
  2603. * @param picture the AVPicture to be freed
  2604. */
  2605. void avpicture_free(AVPicture *picture);
  2606. /**
  2607. * Fill in the AVPicture fields.
  2608. * The fields of the given AVPicture are filled in by using the 'ptr' address
  2609. * which points to the image data buffer. Depending on the specified picture
  2610. * format, one or multiple image data pointers and line sizes will be set.
  2611. * If a planar format is specified, several pointers will be set pointing to
  2612. * the different picture planes and the line sizes of the different planes
  2613. * will be stored in the lines_sizes array.
  2614. * Call with ptr == NULL to get the required size for the ptr buffer.
  2615. *
  2616. * @param picture AVPicture whose fields are to be filled in
  2617. * @param ptr Buffer which will contain or contains the actual image data
  2618. * @param pix_fmt The format in which the picture data is stored.
  2619. * @param width the width of the image in pixels
  2620. * @param height the height of the image in pixels
  2621. * @return size of the image data in bytes
  2622. */
  2623. int avpicture_fill(AVPicture *picture, uint8_t *ptr,
  2624. enum PixelFormat pix_fmt, int width, int height);
  2625. int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
  2626. unsigned char *dest, int dest_size);
  2627. /**
  2628. * Calculate the size in bytes that a picture of the given width and height
  2629. * would occupy if stored in the given picture format.
  2630. * Note that this returns the size of a compact representation as generated
  2631. * by avpicture_layout, which can be smaller than the size required for e.g.
  2632. * avpicture_fill.
  2633. *
  2634. * @param pix_fmt the given picture format
  2635. * @param width the width of the image
  2636. * @param height the height of the image
  2637. * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
  2638. */
  2639. int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
  2640. void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
  2641. const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
  2642. void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
  2643. /**
  2644. * Returns the pixel format corresponding to the name name.
  2645. *
  2646. * If there is no pixel format with name name, then looks for a
  2647. * pixel format with the name corresponding to the native endian
  2648. * format of name.
  2649. * For example in a little-endian system, first looks for "gray16",
  2650. * then for "gray16le".
  2651. *
  2652. * Finally if no pixel format has been found, returns PIX_FMT_NONE.
  2653. */
  2654. enum PixelFormat avcodec_get_pix_fmt(const char* name);
  2655. unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
  2656. #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
  2657. #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
  2658. #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
  2659. #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
  2660. #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
  2661. #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
  2662. /**
  2663. * Computes what kind of losses will occur when converting from one specific
  2664. * pixel format to another.
  2665. * When converting from one pixel format to another, information loss may occur.
  2666. * For example, when converting from RGB24 to GRAY, the color information will
  2667. * be lost. Similarly, other losses occur when converting from some formats to
  2668. * other formats. These losses can involve loss of chroma, but also loss of
  2669. * resolution, loss of color depth, loss due to the color space conversion, loss
  2670. * of the alpha bits or loss due to color quantization.
  2671. * avcodec_get_fix_fmt_loss() informs you about the various types of losses
  2672. * which will occur when converting from one pixel format to another.
  2673. *
  2674. * @param[in] dst_pix_fmt destination pixel format
  2675. * @param[in] src_pix_fmt source pixel format
  2676. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  2677. * @return Combination of flags informing you what kind of losses will occur.
  2678. */
  2679. int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
  2680. int has_alpha);
  2681. /**
  2682. * Finds the best pixel format to convert to given a certain source pixel
  2683. * format. When converting from one pixel format to another, information loss
  2684. * may occur. For example, when converting from RGB24 to GRAY, the color
  2685. * information will be lost. Similarly, other losses occur when converting from
  2686. * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
  2687. * the given pixel formats should be used to suffer the least amount of loss.
  2688. * The pixel formats from which it chooses one, are determined by the
  2689. * pix_fmt_mask parameter.
  2690. *
  2691. * @code
  2692. * src_pix_fmt = PIX_FMT_YUV420P;
  2693. * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
  2694. * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
  2695. * @endcode
  2696. *
  2697. * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
  2698. * @param[in] src_pix_fmt source pixel format
  2699. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  2700. * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  2701. * @return The best pixel format to convert to or -1 if none was found.
  2702. */
  2703. enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
  2704. int has_alpha, int *loss_ptr);
  2705. /**
  2706. * Print in buf the string corresponding to the pixel format with
  2707. * number pix_fmt, or an header if pix_fmt is negative.
  2708. *
  2709. * @param[in] buf the buffer where to write the string
  2710. * @param[in] buf_size the size of buf
  2711. * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
  2712. * a negative value to print the corresponding header.
  2713. * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
  2714. */
  2715. void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
  2716. #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
  2717. #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
  2718. /**
  2719. * Tell if an image really has transparent alpha values.
  2720. * @return ored mask of FF_ALPHA_xxx constants
  2721. */
  2722. int img_get_alpha_info(const AVPicture *src,
  2723. enum PixelFormat pix_fmt, int width, int height);
  2724. /* deinterlace a picture */
  2725. /* deinterlace - if not supported return -1 */
  2726. int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
  2727. enum PixelFormat pix_fmt, int width, int height);
  2728. /* external high level API */
  2729. /**
  2730. * If c is NULL, returns the first registered codec,
  2731. * if c is non-NULL, returns the next registered codec after c,
  2732. * or NULL if c is the last one.
  2733. */
  2734. AVCodec *av_codec_next(AVCodec *c);
  2735. /**
  2736. * Returns the LIBAVCODEC_VERSION_INT constant.
  2737. */
  2738. unsigned avcodec_version(void);
  2739. /**
  2740. * Initializes libavcodec.
  2741. *
  2742. * @warning This function must be called before any other libavcodec
  2743. * function.
  2744. */
  2745. void avcodec_init(void);
  2746. #if LIBAVCODEC_VERSION_MAJOR < 53
  2747. /**
  2748. * @deprecated Deprecated in favor of avcodec_register().
  2749. */
  2750. attribute_deprecated void register_avcodec(AVCodec *codec);
  2751. #endif
  2752. /**
  2753. * Register the codec codec and initialize libavcodec.
  2754. *
  2755. * @see avcodec_init()
  2756. */
  2757. void avcodec_register(AVCodec *codec);
  2758. /**
  2759. * Finds a registered encoder with a matching codec ID.
  2760. *
  2761. * @param id CodecID of the requested encoder
  2762. * @return An encoder if one was found, NULL otherwise.
  2763. */
  2764. AVCodec *avcodec_find_encoder(enum CodecID id);
  2765. /**
  2766. * Finds a registered encoder with the specified name.
  2767. *
  2768. * @param name name of the requested encoder
  2769. * @return An encoder if one was found, NULL otherwise.
  2770. */
  2771. AVCodec *avcodec_find_encoder_by_name(const char *name);
  2772. /**
  2773. * Finds a registered decoder with a matching codec ID.
  2774. *
  2775. * @param id CodecID of the requested decoder
  2776. * @return A decoder if one was found, NULL otherwise.
  2777. */
  2778. AVCodec *avcodec_find_decoder(enum CodecID id);
  2779. /**
  2780. * Finds a registered decoder with the specified name.
  2781. *
  2782. * @param name name of the requested decoder
  2783. * @return A decoder if one was found, NULL otherwise.
  2784. */
  2785. AVCodec *avcodec_find_decoder_by_name(const char *name);
  2786. void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
  2787. /**
  2788. * Sets the fields of the given AVCodecContext to default values.
  2789. *
  2790. * @param s The AVCodecContext of which the fields should be set to default values.
  2791. */
  2792. void avcodec_get_context_defaults(AVCodecContext *s);
  2793. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  2794. * we WILL change its arguments and name a few times! */
  2795. void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
  2796. /**
  2797. * Allocates an AVCodecContext and sets its fields to default values. The
  2798. * resulting struct can be deallocated by simply calling av_free().
  2799. *
  2800. * @return An AVCodecContext filled with default values or NULL on failure.
  2801. * @see avcodec_get_context_defaults
  2802. */
  2803. AVCodecContext *avcodec_alloc_context(void);
  2804. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  2805. * we WILL change its arguments and name a few times! */
  2806. AVCodecContext *avcodec_alloc_context2(enum CodecType);
  2807. /**
  2808. * Sets the fields of the given AVFrame to default values.
  2809. *
  2810. * @param pic The AVFrame of which the fields should be set to default values.
  2811. */
  2812. void avcodec_get_frame_defaults(AVFrame *pic);
  2813. /**
  2814. * Allocates an AVFrame and sets its fields to default values. The resulting
  2815. * struct can be deallocated by simply calling av_free().
  2816. *
  2817. * @return An AVFrame filled with default values or NULL on failure.
  2818. * @see avcodec_get_frame_defaults
  2819. */
  2820. AVFrame *avcodec_alloc_frame(void);
  2821. int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
  2822. void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
  2823. int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
  2824. void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
  2825. /**
  2826. * Checks if the given dimension of a picture is valid, meaning that all
  2827. * bytes of the picture can be addressed with a signed int.
  2828. *
  2829. * @param[in] w Width of the picture.
  2830. * @param[in] h Height of the picture.
  2831. * @return Zero if valid, a negative value if invalid.
  2832. */
  2833. int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
  2834. enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
  2835. int avcodec_thread_init(AVCodecContext *s, int thread_count);
  2836. void avcodec_thread_free(AVCodecContext *s);
  2837. int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  2838. int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  2839. //FIXME func typedef
  2840. /**
  2841. * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
  2842. * function the context has to be allocated.
  2843. *
  2844. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  2845. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  2846. * retrieving a codec.
  2847. *
  2848. * @warning This function is not thread safe!
  2849. *
  2850. * @code
  2851. * avcodec_register_all();
  2852. * codec = avcodec_find_decoder(CODEC_ID_H264);
  2853. * if (!codec)
  2854. * exit(1);
  2855. *
  2856. * context = avcodec_alloc_context();
  2857. *
  2858. * if (avcodec_open(context, codec) < 0)
  2859. * exit(1);
  2860. * @endcode
  2861. *
  2862. * @param avctx The context which will be set up to use the given codec.
  2863. * @param codec The codec to use within the context.
  2864. * @return zero on success, a negative value on error
  2865. * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
  2866. */
  2867. int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
  2868. #if LIBAVCODEC_VERSION_MAJOR < 53
  2869. /**
  2870. * Decodes an audio frame from buf into samples.
  2871. * Wrapper function which calls avcodec_decode_audio3.
  2872. *
  2873. * @deprecated Use avcodec_decode_audio3 instead.
  2874. * @param avctx the codec context
  2875. * @param[out] samples the output buffer
  2876. * @param[in,out] frame_size_ptr the output buffer size in bytes
  2877. * @param[in] buf the input buffer
  2878. * @param[in] buf_size the input buffer size in bytes
  2879. * @return On error a negative value is returned, otherwise the number of bytes
  2880. * used or zero if no frame could be decompressed.
  2881. */
  2882. attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
  2883. int *frame_size_ptr,
  2884. const uint8_t *buf, int buf_size);
  2885. #endif
  2886. /**
  2887. * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
  2888. * Some decoders may support multiple frames in a single AVPacket, such
  2889. * decoders would then just decode the first frame.
  2890. * If no frame
  2891. * could be decompressed, frame_size_ptr is zero. Otherwise, it is the
  2892. * decompressed frame size in bytes.
  2893. *
  2894. * @warning You must set frame_size_ptr to the allocated size of the
  2895. * output buffer before calling avcodec_decode_audio3().
  2896. *
  2897. * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
  2898. * the actual read bytes because some optimized bitstream readers read 32 or 64
  2899. * bits at once and could read over the end.
  2900. *
  2901. * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
  2902. * no overreading happens for damaged MPEG streams.
  2903. *
  2904. * @note You might have to align the input buffer avpkt->data and output buffer
  2905. * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
  2906. * necessary at all, on others it won't work at all if not aligned and on others
  2907. * it will work but it will have an impact on performance.
  2908. *
  2909. * In practice, avpkt->data should have 4 byte alignment at minimum and
  2910. * samples should be 16 byte aligned unless the CPU doesn't need it
  2911. * (AltiVec and SSE do).
  2912. *
  2913. * @param avctx the codec context
  2914. * @param[out] samples the output buffer, sample type in avctx->sample_fmt
  2915. * @param[in,out] frame_size_ptr the output buffer size in bytes
  2916. * @param[in] avpkt The input AVPacket containing the input buffer.
  2917. * You can create such packet with av_init_packet() and by then setting
  2918. * data and size, some decoders might in addition need other fields.
  2919. * All decoders are designed to use the least fields possible though.
  2920. * @return On error a negative value is returned, otherwise the number of bytes
  2921. * used or zero if no frame could be decompressed.
  2922. */
  2923. int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
  2924. int *frame_size_ptr,
  2925. AVPacket *avpkt);
  2926. #if LIBAVCODEC_VERSION_MAJOR < 53
  2927. /**
  2928. * Decodes a video frame from buf into picture.
  2929. * Wrapper function which calls avcodec_decode_video2.
  2930. *
  2931. * @deprecated Use avcodec_decode_video2 instead.
  2932. * @param avctx the codec context
  2933. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  2934. * @param[in] buf the input buffer
  2935. * @param[in] buf_size the size of the input buffer in bytes
  2936. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  2937. * @return On error a negative value is returned, otherwise the number of bytes
  2938. * used or zero if no frame could be decompressed.
  2939. */
  2940. attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
  2941. int *got_picture_ptr,
  2942. const uint8_t *buf, int buf_size);
  2943. #endif
  2944. /**
  2945. * Decodes the video frame of size avpkt->size from avpkt->data into picture.
  2946. * Some decoders may support multiple frames in a single AVPacket, such
  2947. * decoders would then just decode the first frame.
  2948. *
  2949. * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
  2950. * the actual read bytes because some optimized bitstream readers read 32 or 64
  2951. * bits at once and could read over the end.
  2952. *
  2953. * @warning The end of the input buffer buf should be set to 0 to ensure that
  2954. * no overreading happens for damaged MPEG streams.
  2955. *
  2956. * @note You might have to align the input buffer avpkt->data.
  2957. * The alignment requirements depend on the CPU: on some CPUs it isn't
  2958. * necessary at all, on others it won't work at all if not aligned and on others
  2959. * it will work but it will have an impact on performance.
  2960. *
  2961. * In practice, avpkt->data should have 4 byte alignment at minimum.
  2962. *
  2963. * @note Some codecs have a delay between input and output, these need to be
  2964. * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
  2965. *
  2966. * @param avctx the codec context
  2967. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  2968. * @param[in] avpkt The input AVpacket containing the input buffer.
  2969. * You can create such packet with av_init_packet() and by then setting
  2970. * data and size, some decoders might in addition need other fields like
  2971. * flags&PKT_FLAG_KEY. All decoders are designed to use the least
  2972. * fields possible.
  2973. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  2974. * @return On error a negative value is returned, otherwise the number of bytes
  2975. * used or zero if no frame could be decompressed.
  2976. */
  2977. int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
  2978. int *got_picture_ptr,
  2979. AVPacket *avpkt);
  2980. #if LIBAVCODEC_VERSION_MAJOR < 53
  2981. /* Decode a subtitle message. Return -1 if error, otherwise return the
  2982. * number of bytes used. If no subtitle could be decompressed,
  2983. * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
  2984. attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
  2985. int *got_sub_ptr,
  2986. const uint8_t *buf, int buf_size);
  2987. #endif
  2988. /**
  2989. * Decodes a subtitle message.
  2990. * Returns a negative value on error, otherwise returns the number of bytes used.
  2991. * If no subtitle could be decompressed, got_sub_ptr is zero.
  2992. * Otherwise, the subtitle is stored in *sub.
  2993. *
  2994. * @param avctx the codec context
  2995. * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
  2996. * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
  2997. * @param[in] avpkt The input AVPacket containing the input buffer.
  2998. */
  2999. int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
  3000. int *got_sub_ptr,
  3001. AVPacket *avpkt);
  3002. int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
  3003. int *data_size_ptr,
  3004. uint8_t *buf, int buf_size);
  3005. /**
  3006. * Encodes an audio frame from samples into buf.
  3007. *
  3008. * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
  3009. * However, for PCM audio the user will know how much space is needed
  3010. * because it depends on the value passed in buf_size as described
  3011. * below. In that case a lower value can be used.
  3012. *
  3013. * @param avctx the codec context
  3014. * @param[out] buf the output buffer
  3015. * @param[in] buf_size the output buffer size
  3016. * @param[in] samples the input buffer containing the samples
  3017. * The number of samples read from this buffer is frame_size*channels,
  3018. * both of which are defined in avctx.
  3019. * For PCM audio the number of samples read from samples is equal to
  3020. * buf_size * input_sample_size / output_sample_size.
  3021. * @return On error a negative value is returned, on success zero or the number
  3022. * of bytes used to encode the data read from the input buffer.
  3023. */
  3024. int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3025. const short *samples);
  3026. /**
  3027. * Encodes a video frame from pict into buf.
  3028. * The input picture should be
  3029. * stored using a specific format, namely avctx.pix_fmt.
  3030. *
  3031. * @param avctx the codec context
  3032. * @param[out] buf the output buffer for the bitstream of encoded frame
  3033. * @param[in] buf_size the size of the output buffer in bytes
  3034. * @param[in] pict the input picture to encode
  3035. * @return On error a negative value is returned, on success zero or the number
  3036. * of bytes used from the output buffer.
  3037. */
  3038. int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3039. const AVFrame *pict);
  3040. int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3041. const AVSubtitle *sub);
  3042. int avcodec_close(AVCodecContext *avctx);
  3043. /**
  3044. * Register all the codecs, parsers and bitstream filters which were enabled at
  3045. * configuration time. If you do not call this function you can select exactly
  3046. * which formats you want to support, by using the individual registration
  3047. * functions.
  3048. *
  3049. * @see avcodec_register
  3050. * @see av_register_codec_parser
  3051. * @see av_register_bitstream_filter
  3052. */
  3053. void avcodec_register_all(void);
  3054. /**
  3055. * Flush buffers, should be called when seeking or when switching to a different stream.
  3056. */
  3057. void avcodec_flush_buffers(AVCodecContext *avctx);
  3058. void avcodec_default_free_buffers(AVCodecContext *s);
  3059. /* misc useful functions */
  3060. /**
  3061. * Returns a single letter to describe the given picture type pict_type.
  3062. *
  3063. * @param[in] pict_type the picture type
  3064. * @return A single character representing the picture type.
  3065. */
  3066. char av_get_pict_type_char(int pict_type);
  3067. /**
  3068. * Returns codec bits per sample.
  3069. *
  3070. * @param[in] codec_id the codec
  3071. * @return Number of bits per sample or zero if unknown for the given codec.
  3072. */
  3073. int av_get_bits_per_sample(enum CodecID codec_id);
  3074. /**
  3075. * Returns sample format bits per sample.
  3076. *
  3077. * @param[in] sample_fmt the sample format
  3078. * @return Number of bits per sample or zero if unknown for the given sample format.
  3079. */
  3080. int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
  3081. /* frame parsing */
  3082. typedef struct AVCodecParserContext {
  3083. void *priv_data;
  3084. struct AVCodecParser *parser;
  3085. int64_t frame_offset; /* offset of the current frame */
  3086. int64_t cur_offset; /* current offset
  3087. (incremented by each av_parser_parse()) */
  3088. int64_t next_frame_offset; /* offset of the next frame */
  3089. /* video info */
  3090. int pict_type; /* XXX: Put it back in AVCodecContext. */
  3091. /**
  3092. * This field is used for proper frame duration computation in lavf.
  3093. * It signals, how much longer the frame duration of the current frame
  3094. * is compared to normal frame duration.
  3095. *
  3096. * frame_duration = (1 + repeat_pict) * time_base
  3097. *
  3098. * It is used by codecs like H.264 to display telecined material.
  3099. */
  3100. int repeat_pict; /* XXX: Put it back in AVCodecContext. */
  3101. int64_t pts; /* pts of the current frame */
  3102. int64_t dts; /* dts of the current frame */
  3103. /* private data */
  3104. int64_t last_pts;
  3105. int64_t last_dts;
  3106. int fetch_timestamp;
  3107. #define AV_PARSER_PTS_NB 4
  3108. int cur_frame_start_index;
  3109. int64_t cur_frame_offset[AV_PARSER_PTS_NB];
  3110. int64_t cur_frame_pts[AV_PARSER_PTS_NB];
  3111. int64_t cur_frame_dts[AV_PARSER_PTS_NB];
  3112. int flags;
  3113. #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
  3114. int64_t offset; ///< byte offset from starting packet start
  3115. int64_t cur_frame_end[AV_PARSER_PTS_NB];
  3116. /*!
  3117. * Set by parser to 1 for key frames and 0 for non-key frames.
  3118. * It is initialized to -1, so if the parser doesn't set this flag,
  3119. * old-style fallback using FF_I_TYPE picture type as key frames
  3120. * will be used.
  3121. */
  3122. int key_frame;
  3123. /**
  3124. * Time difference in stream time base units from the pts of this
  3125. * packet to the point at which the output from the decoder has converged
  3126. * independent from the availability of previous frames. That is, the
  3127. * frames are virtually identical no matter if decoding started from
  3128. * the very first frame or from this keyframe.
  3129. * Is AV_NOPTS_VALUE if unknown.
  3130. * This field is not the display duration of the current frame.
  3131. *
  3132. * The purpose of this field is to allow seeking in streams that have no
  3133. * keyframes in the conventional sense. It corresponds to the
  3134. * recovery point SEI in H.264 and match_time_delta in NUT. It is also
  3135. * essential for some types of subtitle streams to ensure that all
  3136. * subtitles are correctly displayed after seeking.
  3137. */
  3138. int64_t convergence_duration;
  3139. // Timestamp generation support:
  3140. /**
  3141. * Synchronization point for start of timestamp generation.
  3142. *
  3143. * Set to >0 for sync point, 0 for no sync point and <0 for undefined
  3144. * (default).
  3145. *
  3146. * For example, this corresponds to presence of H.264 buffering period
  3147. * SEI message.
  3148. */
  3149. int dts_sync_point;
  3150. /**
  3151. * Offset of the current timestamp against last timestamp sync point in
  3152. * units of AVCodecContext.time_base.
  3153. *
  3154. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  3155. * contain a valid timestamp offset.
  3156. *
  3157. * Note that the timestamp of sync point has usually a nonzero
  3158. * dts_ref_dts_delta, which refers to the previous sync point. Offset of
  3159. * the next frame after timestamp sync point will be usually 1.
  3160. *
  3161. * For example, this corresponds to H.264 cpb_removal_delay.
  3162. */
  3163. int dts_ref_dts_delta;
  3164. /**
  3165. * Presentation delay of current frame in units of AVCodecContext.time_base.
  3166. *
  3167. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  3168. * contain valid non-negative timestamp delta (presentation time of a frame
  3169. * must not lie in the past).
  3170. *
  3171. * This delay represents the difference between decoding and presentation
  3172. * time of the frame.
  3173. *
  3174. * For example, this corresponds to H.264 dpb_output_delay.
  3175. */
  3176. int pts_dts_delta;
  3177. /**
  3178. * Position of the packet in file.
  3179. *
  3180. * Analogous to cur_frame_pts/dts
  3181. */
  3182. int64_t cur_frame_pos[AV_PARSER_PTS_NB];
  3183. /**
  3184. * Byte position of currently parsed frame in stream.
  3185. */
  3186. int64_t pos;
  3187. /**
  3188. * Previous frame byte position.
  3189. */
  3190. int64_t last_pos;
  3191. } AVCodecParserContext;
  3192. typedef struct AVCodecParser {
  3193. int codec_ids[5]; /* several codec IDs are permitted */
  3194. int priv_data_size;
  3195. int (*parser_init)(AVCodecParserContext *s);
  3196. int (*parser_parse)(AVCodecParserContext *s,
  3197. AVCodecContext *avctx,
  3198. const uint8_t **poutbuf, int *poutbuf_size,
  3199. const uint8_t *buf, int buf_size);
  3200. void (*parser_close)(AVCodecParserContext *s);
  3201. int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
  3202. struct AVCodecParser *next;
  3203. } AVCodecParser;
  3204. AVCodecParser *av_parser_next(AVCodecParser *c);
  3205. void av_register_codec_parser(AVCodecParser *parser);
  3206. AVCodecParserContext *av_parser_init(int codec_id);
  3207. #if LIBAVCODEC_VERSION_MAJOR < 53
  3208. attribute_deprecated
  3209. int av_parser_parse(AVCodecParserContext *s,
  3210. AVCodecContext *avctx,
  3211. uint8_t **poutbuf, int *poutbuf_size,
  3212. const uint8_t *buf, int buf_size,
  3213. int64_t pts, int64_t dts);
  3214. #endif
  3215. /**
  3216. * Parse a packet.
  3217. *
  3218. * @param s parser context.
  3219. * @param avctx codec context.
  3220. * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
  3221. * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
  3222. * @param buf input buffer.
  3223. * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
  3224. * @param pts input presentation timestamp.
  3225. * @param dts input decoding timestamp.
  3226. * @param pos input byte position in stream.
  3227. * @return the number of bytes of the input bitstream used.
  3228. *
  3229. * Example:
  3230. * @code
  3231. * while(in_len){
  3232. * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
  3233. * in_data, in_len,
  3234. * pts, dts, pos);
  3235. * in_data += len;
  3236. * in_len -= len;
  3237. *
  3238. * if(size)
  3239. * decode_frame(data, size);
  3240. * }
  3241. * @endcode
  3242. */
  3243. int av_parser_parse2(AVCodecParserContext *s,
  3244. AVCodecContext *avctx,
  3245. uint8_t **poutbuf, int *poutbuf_size,
  3246. const uint8_t *buf, int buf_size,
  3247. int64_t pts, int64_t dts,
  3248. int64_t pos);
  3249. int av_parser_change(AVCodecParserContext *s,
  3250. AVCodecContext *avctx,
  3251. uint8_t **poutbuf, int *poutbuf_size,
  3252. const uint8_t *buf, int buf_size, int keyframe);
  3253. void av_parser_close(AVCodecParserContext *s);
  3254. typedef struct AVBitStreamFilterContext {
  3255. void *priv_data;
  3256. struct AVBitStreamFilter *filter;
  3257. AVCodecParserContext *parser;
  3258. struct AVBitStreamFilterContext *next;
  3259. } AVBitStreamFilterContext;
  3260. typedef struct AVBitStreamFilter {
  3261. const char *name;
  3262. int priv_data_size;
  3263. int (*filter)(AVBitStreamFilterContext *bsfc,
  3264. AVCodecContext *avctx, const char *args,
  3265. uint8_t **poutbuf, int *poutbuf_size,
  3266. const uint8_t *buf, int buf_size, int keyframe);
  3267. void (*close)(AVBitStreamFilterContext *bsfc);
  3268. struct AVBitStreamFilter *next;
  3269. } AVBitStreamFilter;
  3270. void av_register_bitstream_filter(AVBitStreamFilter *bsf);
  3271. AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
  3272. int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
  3273. AVCodecContext *avctx, const char *args,
  3274. uint8_t **poutbuf, int *poutbuf_size,
  3275. const uint8_t *buf, int buf_size, int keyframe);
  3276. void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
  3277. AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
  3278. /* memory */
  3279. /**
  3280. * Reallocates the given block if it is not large enough, otherwise it
  3281. * does nothing.
  3282. *
  3283. * @see av_realloc
  3284. */
  3285. void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
  3286. /**
  3287. * Allocates a buffer, reusing the given one if large enough.
  3288. *
  3289. * Contrary to av_fast_realloc the current buffer contents might not be
  3290. * preserved and on error the old buffer is freed, thus no special
  3291. * handling to avoid memleaks is necessary.
  3292. *
  3293. * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
  3294. * @param size size of the buffer *ptr points to
  3295. * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
  3296. * *size 0 if an error occurred.
  3297. */
  3298. void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
  3299. /**
  3300. * Copy image 'src' to 'dst'.
  3301. */
  3302. void av_picture_copy(AVPicture *dst, const AVPicture *src,
  3303. enum PixelFormat pix_fmt, int width, int height);
  3304. /**
  3305. * Crop image top and left side.
  3306. */
  3307. int av_picture_crop(AVPicture *dst, const AVPicture *src,
  3308. enum PixelFormat pix_fmt, int top_band, int left_band);
  3309. /**
  3310. * Pad image.
  3311. */
  3312. int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
  3313. int padtop, int padbottom, int padleft, int padright, int *color);
  3314. unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  3315. /**
  3316. * Parses str and put in width_ptr and height_ptr the detected values.
  3317. *
  3318. * @return 0 in case of a successful parsing, a negative value otherwise
  3319. * @param[in] str the string to parse: it has to be a string in the format
  3320. * <width>x<height> or a valid video frame size abbreviation.
  3321. * @param[in,out] width_ptr pointer to the variable which will contain the detected
  3322. * frame width value
  3323. * @param[in,out] height_ptr pointer to the variable which will contain the detected
  3324. * frame height value
  3325. */
  3326. int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
  3327. /**
  3328. * Parses str and put in frame_rate the detected values.
  3329. *
  3330. * @return 0 in case of a successful parsing, a negative value otherwise
  3331. * @param[in] str the string to parse: it has to be a string in the format
  3332. * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
  3333. * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
  3334. * frame rate
  3335. */
  3336. int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
  3337. /* error handling */
  3338. #if EINVAL > 0
  3339. #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
  3340. #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
  3341. #else
  3342. /* Some platforms have E* and errno already negated. */
  3343. #define AVERROR(e) (e)
  3344. #define AVUNERROR(e) (e)
  3345. #endif
  3346. #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
  3347. #define AVERROR_IO AVERROR(EIO) /**< I/O error */
  3348. #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
  3349. #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
  3350. #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
  3351. #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
  3352. #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
  3353. #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
  3354. #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
  3355. #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
  3356. /**
  3357. * Logs a generic warning message about a missing feature. This function is
  3358. * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
  3359. * only, and would normally not be used by applications.
  3360. * @param[in] avc a pointer to an arbitrary struct of which the first field is
  3361. * a pointer to an AVClass struct
  3362. * @param[in] feature string containing the name of the missing feature
  3363. * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
  3364. * If want_sample is non-zero, additional verbage will be added to the log
  3365. * message which tells the user how to report samples to the development
  3366. * mailing list.
  3367. */
  3368. void av_log_missing_feature(void *avc, const char *feature, int want_sample);
  3369. /**
  3370. * Logs a generic warning message asking for a sample. This function is
  3371. * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
  3372. * only, and would normally not be used by applications.
  3373. * @param[in] avc a pointer to an arbitrary struct of which the first field is
  3374. * a pointer to an AVClass struct
  3375. * @param[in] msg string containing an optional message, or NULL if no message
  3376. */
  3377. void av_log_ask_for_sample(void *avc, const char *msg);
  3378. /**
  3379. * Registers the hardware accelerator hwaccel.
  3380. */
  3381. void av_register_hwaccel(AVHWAccel *hwaccel);
  3382. /**
  3383. * If hwaccel is NULL, returns the first registered hardware accelerator,
  3384. * if hwaccel is non-NULL, returns the next registered hardware accelerator
  3385. * after hwaccel, or NULL if hwaccel is the last one.
  3386. */
  3387. AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
  3388. /**
  3389. * Lock operation used by lockmgr
  3390. */
  3391. enum AVLockOp {
  3392. AV_LOCK_CREATE, ///< Create a mutex
  3393. AV_LOCK_OBTAIN, ///< Lock the mutex
  3394. AV_LOCK_RELEASE, ///< Unlock the mutex
  3395. AV_LOCK_DESTROY, ///< Free mutex resources
  3396. };
  3397. /**
  3398. * Register a user provided lock manager supporting the operations
  3399. * specified by AVLockOp. mutex points to a (void *) where the
  3400. * lockmgr should store/get a pointer to a user allocated mutex. It's
  3401. * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
  3402. *
  3403. * @param cb User defined callback. Note: FFmpeg may invoke calls to this
  3404. * callback during the call to av_lockmgr_register().
  3405. * Thus, the application must be prepared to handle that.
  3406. * If cb is set to NULL the lockmgr will be unregistered.
  3407. * Also note that during unregistration the previously registered
  3408. * lockmgr callback may also be invoked.
  3409. */
  3410. int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
  3411. #endif /* AVCODEC_AVCODEC_H */