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