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