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.

3688 lines
118KB

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