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.

3751 lines
120KB

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