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.

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