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.

4561 lines
146KB

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