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.

4346 lines
143KB

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