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.

4255 lines
136KB

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