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.

4208 lines
135KB

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