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.

4300 lines
142KB

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