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