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.

4142 lines
133KB

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