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.

4453 lines
148KB

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