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