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.

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