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.

4296 lines
138KB

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