]> git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h
avcodec: deprecate Lossless and Intra Only encoder capabilites
[ffmpeg] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
23
24 /**
25  * @file
26  * @ingroup libavc
27  * Libavcodec external API header
28  */
29
30 #include <errno.h>
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
43
44 #include "codec_desc.h"
45 #include "codec_id.h"
46 #include "packet.h"
47 #include "version.h"
48
49 /**
50  * @defgroup libavc libavcodec
51  * Encoding/Decoding Library
52  *
53  * @{
54  *
55  * @defgroup lavc_decoding Decoding
56  * @{
57  * @}
58  *
59  * @defgroup lavc_encoding Encoding
60  * @{
61  * @}
62  *
63  * @defgroup lavc_codec Codecs
64  * @{
65  * @defgroup lavc_codec_native Native Codecs
66  * @{
67  * @}
68  * @defgroup lavc_codec_wrappers External library wrappers
69  * @{
70  * @}
71  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
72  * @{
73  * @}
74  * @}
75  * @defgroup lavc_internal Internal
76  * @{
77  * @}
78  * @}
79  */
80
81 /**
82  * @ingroup libavc
83  * @defgroup lavc_encdec send/receive encoding and decoding API overview
84  * @{
85  *
86  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
87  * avcodec_receive_packet() functions provide an encode/decode API, which
88  * decouples input and output.
89  *
90  * The API is very similar for encoding/decoding and audio/video, and works as
91  * follows:
92  * - Set up and open the AVCodecContext as usual.
93  * - Send valid input:
94  *   - For decoding, call avcodec_send_packet() to give the decoder raw
95  *     compressed data in an AVPacket.
96  *   - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
97  *     containing uncompressed audio or video.
98  *
99  *   In both cases, it is recommended that AVPackets and AVFrames are
100  *   refcounted, or libavcodec might have to copy the input data. (libavformat
101  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
102  *   refcounted AVFrames.)
103  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
104  *   functions and process their output:
105  *   - For decoding, call avcodec_receive_frame(). On success, it will return
106  *     an AVFrame containing uncompressed audio or video data.
107  *   - For encoding, call avcodec_receive_packet(). On success, it will return
108  *     an AVPacket with a compressed frame.
109  *
110  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
111  *   AVERROR(EAGAIN) return value means that new input data is required to
112  *   return new output. In this case, continue with sending input. For each
113  *   input frame/packet, the codec will typically return 1 output frame/packet,
114  *   but it can also be 0 or more than 1.
115  *
116  * At the beginning of decoding or encoding, the codec might accept multiple
117  * input frames/packets without returning a frame, until its internal buffers
118  * are filled. This situation is handled transparently if you follow the steps
119  * outlined above.
120  *
121  * In theory, sending input can result in EAGAIN - this should happen only if
122  * not all output was received. You can use this to structure alternative decode
123  * or encode loops other than the one suggested above. For example, you could
124  * try sending new input on each iteration, and try to receive output if that
125  * returns EAGAIN.
126  *
127  * End of stream situations. These require "flushing" (aka draining) the codec,
128  * as the codec might buffer multiple frames or packets internally for
129  * performance or out of necessity (consider B-frames).
130  * This is handled as follows:
131  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
132  *   or avcodec_send_frame() (encoding) functions. This will enter draining
133  *   mode.
134  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
135  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
136  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
137  * - Before decoding can be resumed again, the codec has to be reset with
138  *   avcodec_flush_buffers().
139  *
140  * Using the API as outlined above is highly recommended. But it is also
141  * possible to call functions outside of this rigid schema. For example, you can
142  * call avcodec_send_packet() repeatedly without calling
143  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
144  * until the codec's internal buffer has been filled up (which is typically of
145  * size 1 per output frame, after initial input), and then reject input with
146  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
147  * read at least some output.
148  *
149  * Not all codecs will follow a rigid and predictable dataflow; the only
150  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
151  * one end implies that a receive/send call on the other end will succeed, or
152  * at least will not fail with AVERROR(EAGAIN). In general, no codec will
153  * permit unlimited buffering of input or output.
154  *
155  * This API replaces the following legacy functions:
156  * - avcodec_decode_video2() and avcodec_decode_audio4():
157  *   Use avcodec_send_packet() to feed input to the decoder, then use
158  *   avcodec_receive_frame() to receive decoded frames after each packet.
159  *   Unlike with the old video decoding API, multiple frames might result from
160  *   a packet. For audio, splitting the input packet into frames by partially
161  *   decoding packets becomes transparent to the API user. You never need to
162  *   feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
163  *   no data was read from the packet).
164  *   Additionally, sending a flush/draining packet is required only once.
165  * - avcodec_encode_video2()/avcodec_encode_audio2():
166  *   Use avcodec_send_frame() to feed input to the encoder, then use
167  *   avcodec_receive_packet() to receive encoded packets.
168  *   Providing user-allocated buffers for avcodec_receive_packet() is not
169  *   possible.
170  * - The new API does not handle subtitles yet.
171  *
172  * Mixing new and old function calls on the same AVCodecContext is not allowed,
173  * and will result in undefined behavior.
174  *
175  * Some codecs might require using the new API; using the old API will return
176  * an error when calling it. All codecs support the new API.
177  *
178  * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
179  * would be an invalid state, which could put the codec user into an endless
180  * loop. The API has no concept of time either: it cannot happen that trying to
181  * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
182  * later accepts the packet (with no other receive/flush API calls involved).
183  * The API is a strict state machine, and the passage of time is not supposed
184  * to influence it. Some timing-dependent behavior might still be deemed
185  * acceptable in certain cases. But it must never result in both send/receive
186  * returning EAGAIN at the same time at any point. It must also absolutely be
187  * avoided that the current state is "unstable" and can "flip-flop" between
188  * the send/receive APIs allowing progress. For example, it's not allowed that
189  * the codec randomly decides that it actually wants to consume a packet now
190  * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
191  * avcodec_send_packet() call.
192  * @}
193  */
194
195 /**
196  * @defgroup lavc_core Core functions/structures.
197  * @ingroup libavc
198  *
199  * Basic definitions, functions for querying libavcodec capabilities,
200  * allocating core structures, etc.
201  * @{
202  */
203
204 /**
205  * @ingroup lavc_decoding
206  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
207  * This is mainly needed because some optimized bitstream readers read
208  * 32 or 64 bit at once and could read over the end.<br>
209  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
210  * MPEG bitstreams could cause overread and segfault.
211  */
212 #define AV_INPUT_BUFFER_PADDING_SIZE 64
213
214 /**
215  * @ingroup lavc_encoding
216  * minimum encoding buffer size
217  * Used to avoid some checks during header writing.
218  */
219 #define AV_INPUT_BUFFER_MIN_SIZE 16384
220
221 /**
222  * @ingroup lavc_decoding
223  */
224 enum AVDiscard{
225     /* We leave some space between them for extensions (drop some
226      * keyframes for intra-only or drop just some bidir frames). */
227     AVDISCARD_NONE    =-16, ///< discard nothing
228     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
229     AVDISCARD_NONREF  =  8, ///< discard all non reference
230     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
231     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
232     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
233     AVDISCARD_ALL     = 48, ///< discard all
234 };
235
236 enum AVAudioServiceType {
237     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
238     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
239     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
240     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
241     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
242     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
243     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
244     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
245     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
246     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
247 };
248
249 /**
250  * @ingroup lavc_encoding
251  */
252 typedef struct RcOverride{
253     int start_frame;
254     int end_frame;
255     int qscale; // If this is 0 then quality_factor will be used instead.
256     float quality_factor;
257 } RcOverride;
258
259 /* encoding support
260    These flags can be passed in AVCodecContext.flags before initialization.
261    Note: Not everything is supported yet.
262 */
263
264 /**
265  * Allow decoders to produce frames with data planes that are not aligned
266  * to CPU requirements (e.g. due to cropping).
267  */
268 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
269 /**
270  * Use fixed qscale.
271  */
272 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
273 /**
274  * 4 MV per MB allowed / advanced prediction for H.263.
275  */
276 #define AV_CODEC_FLAG_4MV             (1 <<  2)
277 /**
278  * Output even those frames that might be corrupted.
279  */
280 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
281 /**
282  * Use qpel MC.
283  */
284 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
285 /**
286  * Don't output frames whose parameters differ from first
287  * decoded frame in stream.
288  */
289 #define AV_CODEC_FLAG_DROPCHANGED     (1 <<  5)
290 /**
291  * Use internal 2pass ratecontrol in first pass mode.
292  */
293 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
294 /**
295  * Use internal 2pass ratecontrol in second pass mode.
296  */
297 #define AV_CODEC_FLAG_PASS2           (1 << 10)
298 /**
299  * loop filter.
300  */
301 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
302 /**
303  * Only decode/encode grayscale.
304  */
305 #define AV_CODEC_FLAG_GRAY            (1 << 13)
306 /**
307  * error[?] variables will be set during encoding.
308  */
309 #define AV_CODEC_FLAG_PSNR            (1 << 15)
310 /**
311  * Input bitstream might be truncated at a random location
312  * instead of only at frame boundaries.
313  */
314 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
315 /**
316  * Use interlaced DCT.
317  */
318 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
319 /**
320  * Force low delay.
321  */
322 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
323 /**
324  * Place global headers in extradata instead of every keyframe.
325  */
326 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
327 /**
328  * Use only bitexact stuff (except (I)DCT).
329  */
330 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
331 /* Fx : Flag for H.263+ extra options */
332 /**
333  * H.263 advanced intra coding / MPEG-4 AC prediction
334  */
335 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
336 /**
337  * interlaced motion estimation
338  */
339 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
340 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
341
342 /**
343  * Allow non spec compliant speedup tricks.
344  */
345 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
346 /**
347  * Skip bitstream encoding.
348  */
349 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
350 /**
351  * Place global headers at every keyframe instead of in extradata.
352  */
353 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
354
355 /**
356  * timecode is in drop frame format. DEPRECATED!!!!
357  */
358 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
359
360 /**
361  * Input bitstream might be truncated at a packet boundaries
362  * instead of only at frame boundaries.
363  */
364 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
365 /**
366  * Discard cropping information from SPS.
367  */
368 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
369
370 /**
371  * Show all frames before the first keyframe
372  */
373 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
374 /**
375  * Export motion vectors through frame side data
376  */
377 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
378 /**
379  * Do not skip samples and export skip information as frame side data
380  */
381 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
382 /**
383  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
384  */
385 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP  (1 << 30)
386
387 /* Unsupported options :
388  *              Syntax Arithmetic coding (SAC)
389  *              Reference Picture Selection
390  *              Independent Segment Decoding */
391 /* /Fx */
392 /* codec capabilities */
393
394 /**
395  * Decoder can use draw_horiz_band callback.
396  */
397 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
398 /**
399  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
400  * If not set, it might not use get_buffer() at all or use operations that
401  * assume the buffer was allocated by avcodec_default_get_buffer.
402  */
403 #define AV_CODEC_CAP_DR1                 (1 <<  1)
404 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
405 /**
406  * Encoder or decoder requires flushing with NULL input at the end in order to
407  * give the complete and correct output.
408  *
409  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
410  *       with NULL data. The user can still send NULL data to the public encode
411  *       or decode function, but libavcodec will not pass it along to the codec
412  *       unless this flag is set.
413  *
414  * Decoders:
415  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
416  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
417  * returns frames.
418  *
419  * Encoders:
420  * The encoder needs to be fed with NULL data at the end of encoding until the
421  * encoder no longer returns data.
422  *
423  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
424  *       flag also means that the encoder must set the pts and duration for
425  *       each output packet. If this flag is not set, the pts and duration will
426  *       be determined by libavcodec from the input frame.
427  */
428 #define AV_CODEC_CAP_DELAY               (1 <<  5)
429 /**
430  * Codec can be fed a final frame with a smaller size.
431  * This can be used to prevent truncation of the last audio samples.
432  */
433 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
434
435 /**
436  * Codec can output multiple frames per AVPacket
437  * Normally demuxers return one frame at a time, demuxers which do not do
438  * are connected to a parser to split what they return into proper frames.
439  * This flag is reserved to the very rare category of codecs which have a
440  * bitstream that cannot be split into frames without timeconsuming
441  * operations like full decoding. Demuxers carrying such bitstreams thus
442  * may return multiple frames in a packet. This has many disadvantages like
443  * prohibiting stream copy in many cases thus it should only be considered
444  * as a last resort.
445  */
446 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
447 /**
448  * Codec is experimental and is thus avoided in favor of non experimental
449  * encoders
450  */
451 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
452 /**
453  * Codec should fill in channel configuration and samplerate instead of container
454  */
455 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
456 /**
457  * Codec supports frame-level multithreading.
458  */
459 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
460 /**
461  * Codec supports slice-based (or partition-based) multithreading.
462  */
463 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
464 /**
465  * Codec supports changed parameters at any point.
466  */
467 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
468 /**
469  * Codec supports avctx->thread_count == 0 (auto).
470  */
471 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
472 /**
473  * Audio encoder supports receiving a different number of samples in each call.
474  */
475 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
476 /**
477  * Decoder is not a preferred choice for probing.
478  * This indicates that the decoder is not a good choice for probing.
479  * It could for example be an expensive to spin up hardware decoder,
480  * or it could simply not provide a lot of useful information about
481  * the stream.
482  * A decoder marked with this flag should only be used as last resort
483  * choice for probing.
484  */
485 #define AV_CODEC_CAP_AVOID_PROBING       (1 << 17)
486
487 #if FF_API_UNUSED_CODEC_CAPS
488 /**
489  * Deprecated and unused. Use AVCodecDescriptor.props instead
490  */
491 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
492 /**
493  * Deprecated and unused. Use AVCodecDescriptor.props instead
494  */
495 #define AV_CODEC_CAP_LOSSLESS         0x80000000
496 #endif
497
498 /**
499  * Codec is backed by a hardware implementation. Typically used to
500  * identify a non-hwaccel hardware decoder. For information about hwaccels, use
501  * avcodec_get_hw_config() instead.
502  */
503 #define AV_CODEC_CAP_HARDWARE            (1 << 18)
504
505 /**
506  * Codec is potentially backed by a hardware implementation, but not
507  * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
508  * implementation provides some sort of internal fallback.
509  */
510 #define AV_CODEC_CAP_HYBRID              (1 << 19)
511
512 /**
513  * This codec takes the reordered_opaque field from input AVFrames
514  * and returns it in the corresponding field in AVCodecContext after
515  * encoding.
516  */
517 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
518
519 /**
520  * This encoder can be flushed using avcodec_flush_buffers(). If this flag is
521  * not set, the encoder must be closed and reopened to ensure that no frames
522  * remain pending.
523  */
524 #define AV_CODEC_CAP_ENCODER_FLUSH   (1 << 21)
525
526 /* Exported side data.
527    These flags can be passed in AVCodecContext.export_side_data before initialization.
528 */
529 /**
530  * Export motion vectors through frame side data
531  */
532 #define AV_CODEC_EXPORT_DATA_MVS         (1 << 0)
533 /**
534  * Export encoder Producer Reference Time through packet side data
535  */
536 #define AV_CODEC_EXPORT_DATA_PRFT        (1 << 1)
537 /**
538  * Decoding only.
539  * Export the AVVideoEncParams structure through frame side data.
540  */
541 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
542
543 /**
544  * Pan Scan area.
545  * This specifies the area which should be displayed.
546  * Note there may be multiple such areas for one frame.
547  */
548 typedef struct AVPanScan {
549     /**
550      * id
551      * - encoding: Set by user.
552      * - decoding: Set by libavcodec.
553      */
554     int id;
555
556     /**
557      * width and height in 1/16 pel
558      * - encoding: Set by user.
559      * - decoding: Set by libavcodec.
560      */
561     int width;
562     int height;
563
564     /**
565      * position of the top left corner in 1/16 pel for up to 3 fields/frames
566      * - encoding: Set by user.
567      * - decoding: Set by libavcodec.
568      */
569     int16_t position[3][2];
570 } AVPanScan;
571
572 /**
573  * This structure describes the bitrate properties of an encoded bitstream. It
574  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
575  * parameters for H.264/HEVC.
576  */
577 typedef struct AVCPBProperties {
578     /**
579      * Maximum bitrate of the stream, in bits per second.
580      * Zero if unknown or unspecified.
581      */
582 #if FF_API_UNSANITIZED_BITRATES
583     int max_bitrate;
584 #else
585     int64_t max_bitrate;
586 #endif
587     /**
588      * Minimum bitrate of the stream, in bits per second.
589      * Zero if unknown or unspecified.
590      */
591 #if FF_API_UNSANITIZED_BITRATES
592     int min_bitrate;
593 #else
594     int64_t min_bitrate;
595 #endif
596     /**
597      * Average bitrate of the stream, in bits per second.
598      * Zero if unknown or unspecified.
599      */
600 #if FF_API_UNSANITIZED_BITRATES
601     int avg_bitrate;
602 #else
603     int64_t avg_bitrate;
604 #endif
605
606     /**
607      * The size of the buffer to which the ratecontrol is applied, in bits.
608      * Zero if unknown or unspecified.
609      */
610     int buffer_size;
611
612     /**
613      * The delay between the time the packet this structure is associated with
614      * is received and the time when it should be decoded, in periods of a 27MHz
615      * clock.
616      *
617      * UINT64_MAX when unknown or unspecified.
618      */
619     uint64_t vbv_delay;
620 } AVCPBProperties;
621
622 /**
623  * This structure supplies correlation between a packet timestamp and a wall clock
624  * production time. The definition follows the Producer Reference Time ('prft')
625  * as defined in ISO/IEC 14496-12
626  */
627 typedef struct AVProducerReferenceTime {
628     /**
629      * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
630      */
631     int64_t wallclock;
632     int flags;
633 } AVProducerReferenceTime;
634
635 /**
636  * The decoder will keep a reference to the frame and may reuse it later.
637  */
638 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
639
640 struct AVCodecInternal;
641
642 enum AVFieldOrder {
643     AV_FIELD_UNKNOWN,
644     AV_FIELD_PROGRESSIVE,
645     AV_FIELD_TT,          //< Top coded_first, top displayed first
646     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
647     AV_FIELD_TB,          //< Top coded first, bottom displayed first
648     AV_FIELD_BT,          //< Bottom coded first, top displayed first
649 };
650
651 /**
652  * main external API structure.
653  * New fields can be added to the end with minor version bumps.
654  * Removal, reordering and changes to existing fields require a major
655  * version bump.
656  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
657  * applications.
658  * The name string for AVOptions options matches the associated command line
659  * parameter name and can be found in libavcodec/options_table.h
660  * The AVOption/command line parameter names differ in some cases from the C
661  * structure field names for historic reasons or brevity.
662  * sizeof(AVCodecContext) must not be used outside libav*.
663  */
664 typedef struct AVCodecContext {
665     /**
666      * information on struct for av_log
667      * - set by avcodec_alloc_context3
668      */
669     const AVClass *av_class;
670     int log_level_offset;
671
672     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
673     const struct AVCodec  *codec;
674     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
675
676     /**
677      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
678      * This is used to work around some encoder bugs.
679      * A demuxer should set this to what is stored in the field used to identify the codec.
680      * If there are multiple such fields in a container then the demuxer should choose the one
681      * which maximizes the information about the used codec.
682      * If the codec tag field in a container is larger than 32 bits then the demuxer should
683      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
684      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
685      * first.
686      * - encoding: Set by user, if not then the default based on codec_id will be used.
687      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
688      */
689     unsigned int codec_tag;
690
691     void *priv_data;
692
693     /**
694      * Private context used for internal data.
695      *
696      * Unlike priv_data, this is not codec-specific. It is used in general
697      * libavcodec functions.
698      */
699     struct AVCodecInternal *internal;
700
701     /**
702      * Private data of the user, can be used to carry app specific stuff.
703      * - encoding: Set by user.
704      * - decoding: Set by user.
705      */
706     void *opaque;
707
708     /**
709      * the average bitrate
710      * - encoding: Set by user; unused for constant quantizer encoding.
711      * - decoding: Set by user, may be overwritten by libavcodec
712      *             if this info is available in the stream
713      */
714     int64_t bit_rate;
715
716     /**
717      * number of bits the bitstream is allowed to diverge from the reference.
718      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
719      * - encoding: Set by user; unused for constant quantizer encoding.
720      * - decoding: unused
721      */
722     int bit_rate_tolerance;
723
724     /**
725      * Global quality for codecs which cannot change it per frame.
726      * This should be proportional to MPEG-1/2/4 qscale.
727      * - encoding: Set by user.
728      * - decoding: unused
729      */
730     int global_quality;
731
732     /**
733      * - encoding: Set by user.
734      * - decoding: unused
735      */
736     int compression_level;
737 #define FF_COMPRESSION_DEFAULT -1
738
739     /**
740      * AV_CODEC_FLAG_*.
741      * - encoding: Set by user.
742      * - decoding: Set by user.
743      */
744     int flags;
745
746     /**
747      * AV_CODEC_FLAG2_*
748      * - encoding: Set by user.
749      * - decoding: Set by user.
750      */
751     int flags2;
752
753     /**
754      * some codecs need / can use extradata like Huffman tables.
755      * MJPEG: Huffman tables
756      * rv10: additional flags
757      * MPEG-4: global headers (they can be in the bitstream or here)
758      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
759      * than extradata_size to avoid problems if it is read with the bitstream reader.
760      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
761      * Must be allocated with the av_malloc() family of functions.
762      * - encoding: Set/allocated/freed by libavcodec.
763      * - decoding: Set/allocated/freed by user.
764      */
765     uint8_t *extradata;
766     int extradata_size;
767
768     /**
769      * This is the fundamental unit of time (in seconds) in terms
770      * of which frame timestamps are represented. For fixed-fps content,
771      * timebase should be 1/framerate and timestamp increments should be
772      * identically 1.
773      * This often, but not always is the inverse of the frame rate or field rate
774      * for video. 1/time_base is not the average frame rate if the frame rate is not
775      * constant.
776      *
777      * Like containers, elementary streams also can store timestamps, 1/time_base
778      * is the unit in which these timestamps are specified.
779      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
780      * vop_time_increment_resolution and fixed_vop_rate
781      * (fixed_vop_rate == 0 implies that it is different from the framerate)
782      *
783      * - encoding: MUST be set by user.
784      * - decoding: the use of this field for decoding is deprecated.
785      *             Use framerate instead.
786      */
787     AVRational time_base;
788
789     /**
790      * For some codecs, the time base is closer to the field rate than the frame rate.
791      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
792      * if no telecine is used ...
793      *
794      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
795      */
796     int ticks_per_frame;
797
798     /**
799      * Codec delay.
800      *
801      * Encoding: Number of frames delay there will be from the encoder input to
802      *           the decoder output. (we assume the decoder matches the spec)
803      * Decoding: Number of frames delay in addition to what a standard decoder
804      *           as specified in the spec would produce.
805      *
806      * Video:
807      *   Number of frames the decoded output will be delayed relative to the
808      *   encoded input.
809      *
810      * Audio:
811      *   For encoding, this field is unused (see initial_padding).
812      *
813      *   For decoding, this is the number of samples the decoder needs to
814      *   output before the decoder's output is valid. When seeking, you should
815      *   start decoding this many samples prior to your desired seek point.
816      *
817      * - encoding: Set by libavcodec.
818      * - decoding: Set by libavcodec.
819      */
820     int delay;
821
822
823     /* video only */
824     /**
825      * picture width / height.
826      *
827      * @note Those fields may not match the values of the last
828      * AVFrame output by avcodec_decode_video2 due frame
829      * reordering.
830      *
831      * - encoding: MUST be set by user.
832      * - decoding: May be set by the user before opening the decoder if known e.g.
833      *             from the container. Some decoders will require the dimensions
834      *             to be set by the caller. During decoding, the decoder may
835      *             overwrite those values as required while parsing the data.
836      */
837     int width, height;
838
839     /**
840      * Bitstream width / height, may be different from width/height e.g. when
841      * the decoded frame is cropped before being output or lowres is enabled.
842      *
843      * @note Those field may not match the value of the last
844      * AVFrame output by avcodec_receive_frame() due frame
845      * reordering.
846      *
847      * - encoding: unused
848      * - decoding: May be set by the user before opening the decoder if known
849      *             e.g. from the container. During decoding, the decoder may
850      *             overwrite those values as required while parsing the data.
851      */
852     int coded_width, coded_height;
853
854     /**
855      * the number of pictures in a group of pictures, or 0 for intra_only
856      * - encoding: Set by user.
857      * - decoding: unused
858      */
859     int gop_size;
860
861     /**
862      * Pixel format, see AV_PIX_FMT_xxx.
863      * May be set by the demuxer if known from headers.
864      * May be overridden by the decoder if it knows better.
865      *
866      * @note This field may not match the value of the last
867      * AVFrame output by avcodec_receive_frame() due frame
868      * reordering.
869      *
870      * - encoding: Set by user.
871      * - decoding: Set by user if known, overridden by libavcodec while
872      *             parsing the data.
873      */
874     enum AVPixelFormat pix_fmt;
875
876     /**
877      * If non NULL, 'draw_horiz_band' is called by the libavcodec
878      * decoder to draw a horizontal band. It improves cache usage. Not
879      * all codecs can do that. You must check the codec capabilities
880      * beforehand.
881      * When multithreading is used, it may be called from multiple threads
882      * at the same time; threads might draw different parts of the same AVFrame,
883      * or multiple AVFrames, and there is no guarantee that slices will be drawn
884      * in order.
885      * The function is also used by hardware acceleration APIs.
886      * It is called at least once during frame decoding to pass
887      * the data needed for hardware render.
888      * In that mode instead of pixel data, AVFrame points to
889      * a structure specific to the acceleration API. The application
890      * reads the structure and can change some fields to indicate progress
891      * or mark state.
892      * - encoding: unused
893      * - decoding: Set by user.
894      * @param height the height of the slice
895      * @param y the y position of the slice
896      * @param type 1->top field, 2->bottom field, 3->frame
897      * @param offset offset into the AVFrame.data from which the slice should be read
898      */
899     void (*draw_horiz_band)(struct AVCodecContext *s,
900                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
901                             int y, int type, int height);
902
903     /**
904      * callback to negotiate the pixelFormat
905      * @param fmt is the list of formats which are supported by the codec,
906      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
907      * The first is always the native one.
908      * @note The callback may be called again immediately if initialization for
909      * the selected (hardware-accelerated) pixel format failed.
910      * @warning Behavior is undefined if the callback returns a value not
911      * in the fmt list of formats.
912      * @return the chosen format
913      * - encoding: unused
914      * - decoding: Set by user, if not set the native format will be chosen.
915      */
916     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
917
918     /**
919      * maximum number of B-frames between non-B-frames
920      * Note: The output will be delayed by max_b_frames+1 relative to the input.
921      * - encoding: Set by user.
922      * - decoding: unused
923      */
924     int max_b_frames;
925
926     /**
927      * qscale factor between IP and B-frames
928      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
929      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
930      * - encoding: Set by user.
931      * - decoding: unused
932      */
933     float b_quant_factor;
934
935 #if FF_API_PRIVATE_OPT
936     /** @deprecated use encoder private options instead */
937     attribute_deprecated
938     int b_frame_strategy;
939 #endif
940
941     /**
942      * qscale offset between IP and B-frames
943      * - encoding: Set by user.
944      * - decoding: unused
945      */
946     float b_quant_offset;
947
948     /**
949      * Size of the frame reordering buffer in the decoder.
950      * For MPEG-2 it is 1 IPB or 0 low delay IP.
951      * - encoding: Set by libavcodec.
952      * - decoding: Set by libavcodec.
953      */
954     int has_b_frames;
955
956 #if FF_API_PRIVATE_OPT
957     /** @deprecated use encoder private options instead */
958     attribute_deprecated
959     int mpeg_quant;
960 #endif
961
962     /**
963      * qscale factor between P- and I-frames
964      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
965      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
966      * - encoding: Set by user.
967      * - decoding: unused
968      */
969     float i_quant_factor;
970
971     /**
972      * qscale offset between P and I-frames
973      * - encoding: Set by user.
974      * - decoding: unused
975      */
976     float i_quant_offset;
977
978     /**
979      * luminance masking (0-> disabled)
980      * - encoding: Set by user.
981      * - decoding: unused
982      */
983     float lumi_masking;
984
985     /**
986      * temporary complexity masking (0-> disabled)
987      * - encoding: Set by user.
988      * - decoding: unused
989      */
990     float temporal_cplx_masking;
991
992     /**
993      * spatial complexity masking (0-> disabled)
994      * - encoding: Set by user.
995      * - decoding: unused
996      */
997     float spatial_cplx_masking;
998
999     /**
1000      * p block masking (0-> disabled)
1001      * - encoding: Set by user.
1002      * - decoding: unused
1003      */
1004     float p_masking;
1005
1006     /**
1007      * darkness masking (0-> disabled)
1008      * - encoding: Set by user.
1009      * - decoding: unused
1010      */
1011     float dark_masking;
1012
1013     /**
1014      * slice count
1015      * - encoding: Set by libavcodec.
1016      * - decoding: Set by user (or 0).
1017      */
1018     int slice_count;
1019
1020 #if FF_API_PRIVATE_OPT
1021     /** @deprecated use encoder private options instead */
1022     attribute_deprecated
1023      int prediction_method;
1024 #define FF_PRED_LEFT   0
1025 #define FF_PRED_PLANE  1
1026 #define FF_PRED_MEDIAN 2
1027 #endif
1028
1029     /**
1030      * slice offsets in the frame in bytes
1031      * - encoding: Set/allocated by libavcodec.
1032      * - decoding: Set/allocated by user (or NULL).
1033      */
1034     int *slice_offset;
1035
1036     /**
1037      * sample aspect ratio (0 if unknown)
1038      * That is the width of a pixel divided by the height of the pixel.
1039      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1040      * - encoding: Set by user.
1041      * - decoding: Set by libavcodec.
1042      */
1043     AVRational sample_aspect_ratio;
1044
1045     /**
1046      * motion estimation comparison function
1047      * - encoding: Set by user.
1048      * - decoding: unused
1049      */
1050     int me_cmp;
1051     /**
1052      * subpixel motion estimation comparison function
1053      * - encoding: Set by user.
1054      * - decoding: unused
1055      */
1056     int me_sub_cmp;
1057     /**
1058      * macroblock comparison function (not supported yet)
1059      * - encoding: Set by user.
1060      * - decoding: unused
1061      */
1062     int mb_cmp;
1063     /**
1064      * interlaced DCT comparison function
1065      * - encoding: Set by user.
1066      * - decoding: unused
1067      */
1068     int ildct_cmp;
1069 #define FF_CMP_SAD          0
1070 #define FF_CMP_SSE          1
1071 #define FF_CMP_SATD         2
1072 #define FF_CMP_DCT          3
1073 #define FF_CMP_PSNR         4
1074 #define FF_CMP_BIT          5
1075 #define FF_CMP_RD           6
1076 #define FF_CMP_ZERO         7
1077 #define FF_CMP_VSAD         8
1078 #define FF_CMP_VSSE         9
1079 #define FF_CMP_NSSE         10
1080 #define FF_CMP_W53          11
1081 #define FF_CMP_W97          12
1082 #define FF_CMP_DCTMAX       13
1083 #define FF_CMP_DCT264       14
1084 #define FF_CMP_MEDIAN_SAD   15
1085 #define FF_CMP_CHROMA       256
1086
1087     /**
1088      * ME diamond size & shape
1089      * - encoding: Set by user.
1090      * - decoding: unused
1091      */
1092     int dia_size;
1093
1094     /**
1095      * amount of previous MV predictors (2a+1 x 2a+1 square)
1096      * - encoding: Set by user.
1097      * - decoding: unused
1098      */
1099     int last_predictor_count;
1100
1101 #if FF_API_PRIVATE_OPT
1102     /** @deprecated use encoder private options instead */
1103     attribute_deprecated
1104     int pre_me;
1105 #endif
1106
1107     /**
1108      * motion estimation prepass comparison function
1109      * - encoding: Set by user.
1110      * - decoding: unused
1111      */
1112     int me_pre_cmp;
1113
1114     /**
1115      * ME prepass diamond size & shape
1116      * - encoding: Set by user.
1117      * - decoding: unused
1118      */
1119     int pre_dia_size;
1120
1121     /**
1122      * subpel ME quality
1123      * - encoding: Set by user.
1124      * - decoding: unused
1125      */
1126     int me_subpel_quality;
1127
1128     /**
1129      * maximum motion estimation search range in subpel units
1130      * If 0 then no limit.
1131      *
1132      * - encoding: Set by user.
1133      * - decoding: unused
1134      */
1135     int me_range;
1136
1137     /**
1138      * slice flags
1139      * - encoding: unused
1140      * - decoding: Set by user.
1141      */
1142     int slice_flags;
1143 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1144 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1145 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1146
1147     /**
1148      * macroblock decision mode
1149      * - encoding: Set by user.
1150      * - decoding: unused
1151      */
1152     int mb_decision;
1153 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1154 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1155 #define FF_MB_DECISION_RD     2        ///< rate distortion
1156
1157     /**
1158      * custom intra quantization matrix
1159      * Must be allocated with the av_malloc() family of functions, and will be freed in
1160      * avcodec_free_context().
1161      * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1162      * - decoding: Set/allocated/freed by libavcodec.
1163      */
1164     uint16_t *intra_matrix;
1165
1166     /**
1167      * custom inter quantization matrix
1168      * Must be allocated with the av_malloc() family of functions, and will be freed in
1169      * avcodec_free_context().
1170      * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1171      * - decoding: Set/allocated/freed by libavcodec.
1172      */
1173     uint16_t *inter_matrix;
1174
1175 #if FF_API_PRIVATE_OPT
1176     /** @deprecated use encoder private options instead */
1177     attribute_deprecated
1178     int scenechange_threshold;
1179
1180     /** @deprecated use encoder private options instead */
1181     attribute_deprecated
1182     int noise_reduction;
1183 #endif
1184
1185     /**
1186      * precision of the intra DC coefficient - 8
1187      * - encoding: Set by user.
1188      * - decoding: Set by libavcodec
1189      */
1190     int intra_dc_precision;
1191
1192     /**
1193      * Number of macroblock rows at the top which are skipped.
1194      * - encoding: unused
1195      * - decoding: Set by user.
1196      */
1197     int skip_top;
1198
1199     /**
1200      * Number of macroblock rows at the bottom which are skipped.
1201      * - encoding: unused
1202      * - decoding: Set by user.
1203      */
1204     int skip_bottom;
1205
1206     /**
1207      * minimum MB Lagrange multiplier
1208      * - encoding: Set by user.
1209      * - decoding: unused
1210      */
1211     int mb_lmin;
1212
1213     /**
1214      * maximum MB Lagrange multiplier
1215      * - encoding: Set by user.
1216      * - decoding: unused
1217      */
1218     int mb_lmax;
1219
1220 #if FF_API_PRIVATE_OPT
1221     /**
1222      * @deprecated use encoder private options instead
1223      */
1224     attribute_deprecated
1225     int me_penalty_compensation;
1226 #endif
1227
1228     /**
1229      * - encoding: Set by user.
1230      * - decoding: unused
1231      */
1232     int bidir_refine;
1233
1234 #if FF_API_PRIVATE_OPT
1235     /** @deprecated use encoder private options instead */
1236     attribute_deprecated
1237     int brd_scale;
1238 #endif
1239
1240     /**
1241      * minimum GOP size
1242      * - encoding: Set by user.
1243      * - decoding: unused
1244      */
1245     int keyint_min;
1246
1247     /**
1248      * number of reference frames
1249      * - encoding: Set by user.
1250      * - decoding: Set by lavc.
1251      */
1252     int refs;
1253
1254 #if FF_API_PRIVATE_OPT
1255     /** @deprecated use encoder private options instead */
1256     attribute_deprecated
1257     int chromaoffset;
1258 #endif
1259
1260     /**
1261      * Note: Value depends upon the compare function used for fullpel ME.
1262      * - encoding: Set by user.
1263      * - decoding: unused
1264      */
1265     int mv0_threshold;
1266
1267 #if FF_API_PRIVATE_OPT
1268     /** @deprecated use encoder private options instead */
1269     attribute_deprecated
1270     int b_sensitivity;
1271 #endif
1272
1273     /**
1274      * Chromaticity coordinates of the source primaries.
1275      * - encoding: Set by user
1276      * - decoding: Set by libavcodec
1277      */
1278     enum AVColorPrimaries color_primaries;
1279
1280     /**
1281      * Color Transfer Characteristic.
1282      * - encoding: Set by user
1283      * - decoding: Set by libavcodec
1284      */
1285     enum AVColorTransferCharacteristic color_trc;
1286
1287     /**
1288      * YUV colorspace type.
1289      * - encoding: Set by user
1290      * - decoding: Set by libavcodec
1291      */
1292     enum AVColorSpace colorspace;
1293
1294     /**
1295      * MPEG vs JPEG YUV range.
1296      * - encoding: Set by user
1297      * - decoding: Set by libavcodec
1298      */
1299     enum AVColorRange color_range;
1300
1301     /**
1302      * This defines the location of chroma samples.
1303      * - encoding: Set by user
1304      * - decoding: Set by libavcodec
1305      */
1306     enum AVChromaLocation chroma_sample_location;
1307
1308     /**
1309      * Number of slices.
1310      * Indicates number of picture subdivisions. Used for parallelized
1311      * decoding.
1312      * - encoding: Set by user
1313      * - decoding: unused
1314      */
1315     int slices;
1316
1317     /** Field order
1318      * - encoding: set by libavcodec
1319      * - decoding: Set by user.
1320      */
1321     enum AVFieldOrder field_order;
1322
1323     /* audio only */
1324     int sample_rate; ///< samples per second
1325     int channels;    ///< number of audio channels
1326
1327     /**
1328      * audio sample format
1329      * - encoding: Set by user.
1330      * - decoding: Set by libavcodec.
1331      */
1332     enum AVSampleFormat sample_fmt;  ///< sample format
1333
1334     /* The following data should not be initialized. */
1335     /**
1336      * Number of samples per channel in an audio frame.
1337      *
1338      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1339      *   except the last must contain exactly frame_size samples per channel.
1340      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1341      *   frame size is not restricted.
1342      * - decoding: may be set by some decoders to indicate constant frame size
1343      */
1344     int frame_size;
1345
1346     /**
1347      * Frame counter, set by libavcodec.
1348      *
1349      * - decoding: total number of frames returned from the decoder so far.
1350      * - encoding: total number of frames passed to the encoder so far.
1351      *
1352      *   @note the counter is not incremented if encoding/decoding resulted in
1353      *   an error.
1354      */
1355     int frame_number;
1356
1357     /**
1358      * number of bytes per packet if constant and known or 0
1359      * Used by some WAV based audio codecs.
1360      */
1361     int block_align;
1362
1363     /**
1364      * Audio cutoff bandwidth (0 means "automatic")
1365      * - encoding: Set by user.
1366      * - decoding: unused
1367      */
1368     int cutoff;
1369
1370     /**
1371      * Audio channel layout.
1372      * - encoding: set by user.
1373      * - decoding: set by user, may be overwritten by libavcodec.
1374      */
1375     uint64_t channel_layout;
1376
1377     /**
1378      * Request decoder to use this channel layout if it can (0 for default)
1379      * - encoding: unused
1380      * - decoding: Set by user.
1381      */
1382     uint64_t request_channel_layout;
1383
1384     /**
1385      * Type of service that the audio stream conveys.
1386      * - encoding: Set by user.
1387      * - decoding: Set by libavcodec.
1388      */
1389     enum AVAudioServiceType audio_service_type;
1390
1391     /**
1392      * desired sample format
1393      * - encoding: Not used.
1394      * - decoding: Set by user.
1395      * Decoder will decode to this format if it can.
1396      */
1397     enum AVSampleFormat request_sample_fmt;
1398
1399     /**
1400      * This callback is called at the beginning of each frame to get data
1401      * buffer(s) for it. There may be one contiguous buffer for all the data or
1402      * there may be a buffer per each data plane or anything in between. What
1403      * this means is, you may set however many entries in buf[] you feel necessary.
1404      * Each buffer must be reference-counted using the AVBuffer API (see description
1405      * of buf[] below).
1406      *
1407      * The following fields will be set in the frame before this callback is
1408      * called:
1409      * - format
1410      * - width, height (video only)
1411      * - sample_rate, channel_layout, nb_samples (audio only)
1412      * Their values may differ from the corresponding values in
1413      * AVCodecContext. This callback must use the frame values, not the codec
1414      * context values, to calculate the required buffer size.
1415      *
1416      * This callback must fill the following fields in the frame:
1417      * - data[]
1418      * - linesize[]
1419      * - extended_data:
1420      *   * if the data is planar audio with more than 8 channels, then this
1421      *     callback must allocate and fill extended_data to contain all pointers
1422      *     to all data planes. data[] must hold as many pointers as it can.
1423      *     extended_data must be allocated with av_malloc() and will be freed in
1424      *     av_frame_unref().
1425      *   * otherwise extended_data must point to data
1426      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1427      *   the frame's data and extended_data pointers must be contained in these. That
1428      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1429      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1430      *   and av_buffer_ref().
1431      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1432      *   this callback and filled with the extra buffers if there are more
1433      *   buffers than buf[] can hold. extended_buf will be freed in
1434      *   av_frame_unref().
1435      *
1436      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1437      * avcodec_default_get_buffer2() instead of providing buffers allocated by
1438      * some other means.
1439      *
1440      * Each data plane must be aligned to the maximum required by the target
1441      * CPU.
1442      *
1443      * @see avcodec_default_get_buffer2()
1444      *
1445      * Video:
1446      *
1447      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1448      * (read and/or written to if it is writable) later by libavcodec.
1449      *
1450      * avcodec_align_dimensions2() should be used to find the required width and
1451      * height, as they normally need to be rounded up to the next multiple of 16.
1452      *
1453      * Some decoders do not support linesizes changing between frames.
1454      *
1455      * If frame multithreading is used and thread_safe_callbacks is set,
1456      * this callback may be called from a different thread, but not from more
1457      * than one at once. Does not need to be reentrant.
1458      *
1459      * @see avcodec_align_dimensions2()
1460      *
1461      * Audio:
1462      *
1463      * Decoders request a buffer of a particular size by setting
1464      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1465      * however, utilize only part of the buffer by setting AVFrame.nb_samples
1466      * to a smaller value in the output frame.
1467      *
1468      * As a convenience, av_samples_get_buffer_size() and
1469      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1470      * functions to find the required data size and to fill data pointers and
1471      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1472      * since all planes must be the same size.
1473      *
1474      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1475      *
1476      * - encoding: unused
1477      * - decoding: Set by libavcodec, user can override.
1478      */
1479     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1480
1481     /**
1482      * If non-zero, the decoded audio and video frames returned from
1483      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1484      * and are valid indefinitely. The caller must free them with
1485      * av_frame_unref() when they are not needed anymore.
1486      * Otherwise, the decoded frames must not be freed by the caller and are
1487      * only valid until the next decode call.
1488      *
1489      * This is always automatically enabled if avcodec_receive_frame() is used.
1490      *
1491      * - encoding: unused
1492      * - decoding: set by the caller before avcodec_open2().
1493      */
1494     attribute_deprecated
1495     int refcounted_frames;
1496
1497     /* - encoding parameters */
1498     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1499     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1500
1501     /**
1502      * minimum quantizer
1503      * - encoding: Set by user.
1504      * - decoding: unused
1505      */
1506     int qmin;
1507
1508     /**
1509      * maximum quantizer
1510      * - encoding: Set by user.
1511      * - decoding: unused
1512      */
1513     int qmax;
1514
1515     /**
1516      * maximum quantizer difference between frames
1517      * - encoding: Set by user.
1518      * - decoding: unused
1519      */
1520     int max_qdiff;
1521
1522     /**
1523      * decoder bitstream buffer size
1524      * - encoding: Set by user.
1525      * - decoding: unused
1526      */
1527     int rc_buffer_size;
1528
1529     /**
1530      * ratecontrol override, see RcOverride
1531      * - encoding: Allocated/set/freed by user.
1532      * - decoding: unused
1533      */
1534     int rc_override_count;
1535     RcOverride *rc_override;
1536
1537     /**
1538      * maximum bitrate
1539      * - encoding: Set by user.
1540      * - decoding: Set by user, may be overwritten by libavcodec.
1541      */
1542     int64_t rc_max_rate;
1543
1544     /**
1545      * minimum bitrate
1546      * - encoding: Set by user.
1547      * - decoding: unused
1548      */
1549     int64_t rc_min_rate;
1550
1551     /**
1552      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1553      * - encoding: Set by user.
1554      * - decoding: unused.
1555      */
1556     float rc_max_available_vbv_use;
1557
1558     /**
1559      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1560      * - encoding: Set by user.
1561      * - decoding: unused.
1562      */
1563     float rc_min_vbv_overflow_use;
1564
1565     /**
1566      * Number of bits which should be loaded into the rc buffer before decoding starts.
1567      * - encoding: Set by user.
1568      * - decoding: unused
1569      */
1570     int rc_initial_buffer_occupancy;
1571
1572 #if FF_API_CODER_TYPE
1573 #define FF_CODER_TYPE_VLC       0
1574 #define FF_CODER_TYPE_AC        1
1575 #define FF_CODER_TYPE_RAW       2
1576 #define FF_CODER_TYPE_RLE       3
1577     /**
1578      * @deprecated use encoder private options instead
1579      */
1580     attribute_deprecated
1581     int coder_type;
1582 #endif /* FF_API_CODER_TYPE */
1583
1584 #if FF_API_PRIVATE_OPT
1585     /** @deprecated use encoder private options instead */
1586     attribute_deprecated
1587     int context_model;
1588 #endif
1589
1590 #if FF_API_PRIVATE_OPT
1591     /** @deprecated use encoder private options instead */
1592     attribute_deprecated
1593     int frame_skip_threshold;
1594
1595     /** @deprecated use encoder private options instead */
1596     attribute_deprecated
1597     int frame_skip_factor;
1598
1599     /** @deprecated use encoder private options instead */
1600     attribute_deprecated
1601     int frame_skip_exp;
1602
1603     /** @deprecated use encoder private options instead */
1604     attribute_deprecated
1605     int frame_skip_cmp;
1606 #endif /* FF_API_PRIVATE_OPT */
1607
1608     /**
1609      * trellis RD quantization
1610      * - encoding: Set by user.
1611      * - decoding: unused
1612      */
1613     int trellis;
1614
1615 #if FF_API_PRIVATE_OPT
1616     /** @deprecated use encoder private options instead */
1617     attribute_deprecated
1618     int min_prediction_order;
1619
1620     /** @deprecated use encoder private options instead */
1621     attribute_deprecated
1622     int max_prediction_order;
1623
1624     /** @deprecated use encoder private options instead */
1625     attribute_deprecated
1626     int64_t timecode_frame_start;
1627 #endif
1628
1629 #if FF_API_RTP_CALLBACK
1630     /**
1631      * @deprecated unused
1632      */
1633     /* The RTP callback: This function is called    */
1634     /* every time the encoder has a packet to send. */
1635     /* It depends on the encoder if the data starts */
1636     /* with a Start Code (it should). H.263 does.   */
1637     /* mb_nb contains the number of macroblocks     */
1638     /* encoded in the RTP payload.                  */
1639     attribute_deprecated
1640     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1641 #endif
1642
1643 #if FF_API_PRIVATE_OPT
1644     /** @deprecated use encoder private options instead */
1645     attribute_deprecated
1646     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1647                             /* do its best to deliver a chunk with size     */
1648                             /* below rtp_payload_size, the chunk will start */
1649                             /* with a start code on some codecs like H.263. */
1650                             /* This doesn't take account of any particular  */
1651                             /* headers inside the transmitted RTP payload.  */
1652 #endif
1653
1654 #if FF_API_STAT_BITS
1655     /* statistics, used for 2-pass encoding */
1656     attribute_deprecated
1657     int mv_bits;
1658     attribute_deprecated
1659     int header_bits;
1660     attribute_deprecated
1661     int i_tex_bits;
1662     attribute_deprecated
1663     int p_tex_bits;
1664     attribute_deprecated
1665     int i_count;
1666     attribute_deprecated
1667     int p_count;
1668     attribute_deprecated
1669     int skip_count;
1670     attribute_deprecated
1671     int misc_bits;
1672
1673     /** @deprecated this field is unused */
1674     attribute_deprecated
1675     int frame_bits;
1676 #endif
1677
1678     /**
1679      * pass1 encoding statistics output buffer
1680      * - encoding: Set by libavcodec.
1681      * - decoding: unused
1682      */
1683     char *stats_out;
1684
1685     /**
1686      * pass2 encoding statistics input buffer
1687      * Concatenated stuff from stats_out of pass1 should be placed here.
1688      * - encoding: Allocated/set/freed by user.
1689      * - decoding: unused
1690      */
1691     char *stats_in;
1692
1693     /**
1694      * Work around bugs in encoders which sometimes cannot be detected automatically.
1695      * - encoding: Set by user
1696      * - decoding: Set by user
1697      */
1698     int workaround_bugs;
1699 #define FF_BUG_AUTODETECT       1  ///< autodetection
1700 #define FF_BUG_XVID_ILACE       4
1701 #define FF_BUG_UMP4             8
1702 #define FF_BUG_NO_PADDING       16
1703 #define FF_BUG_AMV              32
1704 #define FF_BUG_QPEL_CHROMA      64
1705 #define FF_BUG_STD_QPEL         128
1706 #define FF_BUG_QPEL_CHROMA2     256
1707 #define FF_BUG_DIRECT_BLOCKSIZE 512
1708 #define FF_BUG_EDGE             1024
1709 #define FF_BUG_HPEL_CHROMA      2048
1710 #define FF_BUG_DC_CLIP          4096
1711 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1712 #define FF_BUG_TRUNCATED       16384
1713 #define FF_BUG_IEDGE           32768
1714
1715     /**
1716      * strictly follow the standard (MPEG-4, ...).
1717      * - encoding: Set by user.
1718      * - decoding: Set by user.
1719      * Setting this to STRICT or higher means the encoder and decoder will
1720      * generally do stupid things, whereas setting it to unofficial or lower
1721      * will mean the encoder might produce output that is not supported by all
1722      * spec-compliant decoders. Decoders don't differentiate between normal,
1723      * unofficial and experimental (that is, they always try to decode things
1724      * when they can) unless they are explicitly asked to behave stupidly
1725      * (=strictly conform to the specs)
1726      */
1727     int strict_std_compliance;
1728 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1729 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1730 #define FF_COMPLIANCE_NORMAL        0
1731 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1732 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1733
1734     /**
1735      * error concealment flags
1736      * - encoding: unused
1737      * - decoding: Set by user.
1738      */
1739     int error_concealment;
1740 #define FF_EC_GUESS_MVS   1
1741 #define FF_EC_DEBLOCK     2
1742 #define FF_EC_FAVOR_INTER 256
1743
1744     /**
1745      * debug
1746      * - encoding: Set by user.
1747      * - decoding: Set by user.
1748      */
1749     int debug;
1750 #define FF_DEBUG_PICT_INFO   1
1751 #define FF_DEBUG_RC          2
1752 #define FF_DEBUG_BITSTREAM   4
1753 #define FF_DEBUG_MB_TYPE     8
1754 #define FF_DEBUG_QP          16
1755 #if FF_API_DEBUG_MV
1756 /**
1757  * @deprecated this option does nothing
1758  */
1759 #define FF_DEBUG_MV          32
1760 #endif
1761 #define FF_DEBUG_DCT_COEFF   0x00000040
1762 #define FF_DEBUG_SKIP        0x00000080
1763 #define FF_DEBUG_STARTCODE   0x00000100
1764 #define FF_DEBUG_ER          0x00000400
1765 #define FF_DEBUG_MMCO        0x00000800
1766 #define FF_DEBUG_BUGS        0x00001000
1767 #if FF_API_DEBUG_MV
1768 #define FF_DEBUG_VIS_QP      0x00002000
1769 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1770 #endif
1771 #define FF_DEBUG_BUFFERS     0x00008000
1772 #define FF_DEBUG_THREADS     0x00010000
1773 #define FF_DEBUG_GREEN_MD    0x00800000
1774 #define FF_DEBUG_NOMC        0x01000000
1775
1776 #if FF_API_DEBUG_MV
1777     /**
1778      * debug
1779      * - encoding: Set by user.
1780      * - decoding: Set by user.
1781      */
1782     int debug_mv;
1783 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
1784 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
1785 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1786 #endif
1787
1788     /**
1789      * Error recognition; may misdetect some more or less valid parts as errors.
1790      * - encoding: unused
1791      * - decoding: Set by user.
1792      */
1793     int err_recognition;
1794
1795 /**
1796  * Verify checksums embedded in the bitstream (could be of either encoded or
1797  * decoded data, depending on the codec) and print an error message on mismatch.
1798  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1799  * decoder returning an error.
1800  */
1801 #define AV_EF_CRCCHECK  (1<<0)
1802 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
1803 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
1804 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
1805
1806 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
1807 #define AV_EF_CAREFUL    (1<<16)        ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
1808 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
1809 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
1810
1811
1812     /**
1813      * opaque 64-bit number (generally a PTS) that will be reordered and
1814      * output in AVFrame.reordered_opaque
1815      * - encoding: Set by libavcodec to the reordered_opaque of the input
1816      *             frame corresponding to the last returned packet. Only
1817      *             supported by encoders with the
1818      *             AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1819      * - decoding: Set by user.
1820      */
1821     int64_t reordered_opaque;
1822
1823     /**
1824      * Hardware accelerator in use
1825      * - encoding: unused.
1826      * - decoding: Set by libavcodec
1827      */
1828     const struct AVHWAccel *hwaccel;
1829
1830     /**
1831      * Hardware accelerator context.
1832      * For some hardware accelerators, a global context needs to be
1833      * provided by the user. In that case, this holds display-dependent
1834      * data FFmpeg cannot instantiate itself. Please refer to the
1835      * FFmpeg HW accelerator documentation to know how to fill this
1836      * is. e.g. for VA API, this is a struct vaapi_context.
1837      * - encoding: unused
1838      * - decoding: Set by user
1839      */
1840     void *hwaccel_context;
1841
1842     /**
1843      * error
1844      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1845      * - decoding: unused
1846      */
1847     uint64_t error[AV_NUM_DATA_POINTERS];
1848
1849     /**
1850      * DCT algorithm, see FF_DCT_* below
1851      * - encoding: Set by user.
1852      * - decoding: unused
1853      */
1854     int dct_algo;
1855 #define FF_DCT_AUTO    0
1856 #define FF_DCT_FASTINT 1
1857 #define FF_DCT_INT     2
1858 #define FF_DCT_MMX     3
1859 #define FF_DCT_ALTIVEC 5
1860 #define FF_DCT_FAAN    6
1861
1862     /**
1863      * IDCT algorithm, see FF_IDCT_* below.
1864      * - encoding: Set by user.
1865      * - decoding: Set by user.
1866      */
1867     int idct_algo;
1868 #define FF_IDCT_AUTO          0
1869 #define FF_IDCT_INT           1
1870 #define FF_IDCT_SIMPLE        2
1871 #define FF_IDCT_SIMPLEMMX     3
1872 #define FF_IDCT_ARM           7
1873 #define FF_IDCT_ALTIVEC       8
1874 #define FF_IDCT_SIMPLEARM     10
1875 #define FF_IDCT_XVID          14
1876 #define FF_IDCT_SIMPLEARMV5TE 16
1877 #define FF_IDCT_SIMPLEARMV6   17
1878 #define FF_IDCT_FAAN          20
1879 #define FF_IDCT_SIMPLENEON    22
1880 #define FF_IDCT_NONE          24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1881 #define FF_IDCT_SIMPLEAUTO    128
1882
1883     /**
1884      * bits per sample/pixel from the demuxer (needed for huffyuv).
1885      * - encoding: Set by libavcodec.
1886      * - decoding: Set by user.
1887      */
1888      int bits_per_coded_sample;
1889
1890     /**
1891      * Bits per sample/pixel of internal libavcodec pixel/sample format.
1892      * - encoding: set by user.
1893      * - decoding: set by libavcodec.
1894      */
1895     int bits_per_raw_sample;
1896
1897 #if FF_API_LOWRES
1898     /**
1899      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1900      * - encoding: unused
1901      * - decoding: Set by user.
1902      */
1903      int lowres;
1904 #endif
1905
1906 #if FF_API_CODED_FRAME
1907     /**
1908      * the picture in the bitstream
1909      * - encoding: Set by libavcodec.
1910      * - decoding: unused
1911      *
1912      * @deprecated use the quality factor packet side data instead
1913      */
1914     attribute_deprecated AVFrame *coded_frame;
1915 #endif
1916
1917     /**
1918      * thread count
1919      * is used to decide how many independent tasks should be passed to execute()
1920      * - encoding: Set by user.
1921      * - decoding: Set by user.
1922      */
1923     int thread_count;
1924
1925     /**
1926      * Which multithreading methods to use.
1927      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1928      * so clients which cannot provide future frames should not use it.
1929      *
1930      * - encoding: Set by user, otherwise the default is used.
1931      * - decoding: Set by user, otherwise the default is used.
1932      */
1933     int thread_type;
1934 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
1935 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
1936
1937     /**
1938      * Which multithreading methods are in use by the codec.
1939      * - encoding: Set by libavcodec.
1940      * - decoding: Set by libavcodec.
1941      */
1942     int active_thread_type;
1943
1944     /**
1945      * Set by the client if its custom get_buffer() callback can be called
1946      * synchronously from another thread, which allows faster multithreaded decoding.
1947      * draw_horiz_band() will be called from other threads regardless of this setting.
1948      * Ignored if the default get_buffer() is used.
1949      * - encoding: Set by user.
1950      * - decoding: Set by user.
1951      */
1952     int thread_safe_callbacks;
1953
1954     /**
1955      * The codec may call this to execute several independent things.
1956      * It will return only after finishing all tasks.
1957      * The user may replace this with some multithreaded implementation,
1958      * the default implementation will execute the parts serially.
1959      * @param count the number of things to execute
1960      * - encoding: Set by libavcodec, user can override.
1961      * - decoding: Set by libavcodec, user can override.
1962      */
1963     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1964
1965     /**
1966      * The codec may call this to execute several independent things.
1967      * It will return only after finishing all tasks.
1968      * The user may replace this with some multithreaded implementation,
1969      * the default implementation will execute the parts serially.
1970      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1971      * @param c context passed also to func
1972      * @param count the number of things to execute
1973      * @param arg2 argument passed unchanged to func
1974      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1975      * @param func function that will be called count times, with jobnr from 0 to count-1.
1976      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1977      *             two instances of func executing at the same time will have the same threadnr.
1978      * @return always 0 currently, but code should handle a future improvement where when any call to func
1979      *         returns < 0 no further calls to func may be done and < 0 is returned.
1980      * - encoding: Set by libavcodec, user can override.
1981      * - decoding: Set by libavcodec, user can override.
1982      */
1983     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1984
1985     /**
1986      * noise vs. sse weight for the nsse comparison function
1987      * - encoding: Set by user.
1988      * - decoding: unused
1989      */
1990      int nsse_weight;
1991
1992     /**
1993      * profile
1994      * - encoding: Set by user.
1995      * - decoding: Set by libavcodec.
1996      */
1997      int profile;
1998 #define FF_PROFILE_UNKNOWN -99
1999 #define FF_PROFILE_RESERVED -100
2000
2001 #define FF_PROFILE_AAC_MAIN 0
2002 #define FF_PROFILE_AAC_LOW  1
2003 #define FF_PROFILE_AAC_SSR  2
2004 #define FF_PROFILE_AAC_LTP  3
2005 #define FF_PROFILE_AAC_HE   4
2006 #define FF_PROFILE_AAC_HE_V2 28
2007 #define FF_PROFILE_AAC_LD   22
2008 #define FF_PROFILE_AAC_ELD  38
2009 #define FF_PROFILE_MPEG2_AAC_LOW 128
2010 #define FF_PROFILE_MPEG2_AAC_HE  131
2011
2012 #define FF_PROFILE_DNXHD         0
2013 #define FF_PROFILE_DNXHR_LB      1
2014 #define FF_PROFILE_DNXHR_SQ      2
2015 #define FF_PROFILE_DNXHR_HQ      3
2016 #define FF_PROFILE_DNXHR_HQX     4
2017 #define FF_PROFILE_DNXHR_444     5
2018
2019 #define FF_PROFILE_DTS         20
2020 #define FF_PROFILE_DTS_ES      30
2021 #define FF_PROFILE_DTS_96_24   40
2022 #define FF_PROFILE_DTS_HD_HRA  50
2023 #define FF_PROFILE_DTS_HD_MA   60
2024 #define FF_PROFILE_DTS_EXPRESS 70
2025
2026 #define FF_PROFILE_MPEG2_422    0
2027 #define FF_PROFILE_MPEG2_HIGH   1
2028 #define FF_PROFILE_MPEG2_SS     2
2029 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2030 #define FF_PROFILE_MPEG2_MAIN   4
2031 #define FF_PROFILE_MPEG2_SIMPLE 5
2032
2033 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2034 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2035
2036 #define FF_PROFILE_H264_BASELINE             66
2037 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2038 #define FF_PROFILE_H264_MAIN                 77
2039 #define FF_PROFILE_H264_EXTENDED             88
2040 #define FF_PROFILE_H264_HIGH                 100
2041 #define FF_PROFILE_H264_HIGH_10              110
2042 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2043 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
2044 #define FF_PROFILE_H264_HIGH_422             122
2045 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2046 #define FF_PROFILE_H264_STEREO_HIGH          128
2047 #define FF_PROFILE_H264_HIGH_444             144
2048 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2049 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2050 #define FF_PROFILE_H264_CAVLC_444            44
2051
2052 #define FF_PROFILE_VC1_SIMPLE   0
2053 #define FF_PROFILE_VC1_MAIN     1
2054 #define FF_PROFILE_VC1_COMPLEX  2
2055 #define FF_PROFILE_VC1_ADVANCED 3
2056
2057 #define FF_PROFILE_MPEG4_SIMPLE                     0
2058 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2059 #define FF_PROFILE_MPEG4_CORE                       2
2060 #define FF_PROFILE_MPEG4_MAIN                       3
2061 #define FF_PROFILE_MPEG4_N_BIT                      4
2062 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2063 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2064 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2065 #define FF_PROFILE_MPEG4_HYBRID                     8
2066 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2067 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2068 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2069 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2070 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2071 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2072 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2073
2074 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
2075 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
2076 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
2077 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2078 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2079
2080 #define FF_PROFILE_VP9_0                            0
2081 #define FF_PROFILE_VP9_1                            1
2082 #define FF_PROFILE_VP9_2                            2
2083 #define FF_PROFILE_VP9_3                            3
2084
2085 #define FF_PROFILE_HEVC_MAIN                        1
2086 #define FF_PROFILE_HEVC_MAIN_10                     2
2087 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2088 #define FF_PROFILE_HEVC_REXT                        4
2089
2090 #define FF_PROFILE_AV1_MAIN                         0
2091 #define FF_PROFILE_AV1_HIGH                         1
2092 #define FF_PROFILE_AV1_PROFESSIONAL                 2
2093
2094 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT            0xc0
2095 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2096 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT         0xc2
2097 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS                0xc3
2098 #define FF_PROFILE_MJPEG_JPEG_LS                         0xf7
2099
2100 #define FF_PROFILE_SBC_MSBC                         1
2101
2102 #define FF_PROFILE_PRORES_PROXY     0
2103 #define FF_PROFILE_PRORES_LT        1
2104 #define FF_PROFILE_PRORES_STANDARD  2
2105 #define FF_PROFILE_PRORES_HQ        3
2106 #define FF_PROFILE_PRORES_4444      4
2107 #define FF_PROFILE_PRORES_XQ        5
2108
2109 #define FF_PROFILE_ARIB_PROFILE_A 0
2110 #define FF_PROFILE_ARIB_PROFILE_C 1
2111
2112     /**
2113      * level
2114      * - encoding: Set by user.
2115      * - decoding: Set by libavcodec.
2116      */
2117      int level;
2118 #define FF_LEVEL_UNKNOWN -99
2119
2120     /**
2121      * Skip loop filtering for selected frames.
2122      * - encoding: unused
2123      * - decoding: Set by user.
2124      */
2125     enum AVDiscard skip_loop_filter;
2126
2127     /**
2128      * Skip IDCT/dequantization for selected frames.
2129      * - encoding: unused
2130      * - decoding: Set by user.
2131      */
2132     enum AVDiscard skip_idct;
2133
2134     /**
2135      * Skip decoding for selected frames.
2136      * - encoding: unused
2137      * - decoding: Set by user.
2138      */
2139     enum AVDiscard skip_frame;
2140
2141     /**
2142      * Header containing style information for text subtitles.
2143      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2144      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2145      * the Format line following. It shouldn't include any Dialogue line.
2146      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2147      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2148      */
2149     uint8_t *subtitle_header;
2150     int subtitle_header_size;
2151
2152 #if FF_API_VBV_DELAY
2153     /**
2154      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2155      * Used for compliant TS muxing.
2156      * - encoding: Set by libavcodec.
2157      * - decoding: unused.
2158      * @deprecated this value is now exported as a part of
2159      * AV_PKT_DATA_CPB_PROPERTIES packet side data
2160      */
2161     attribute_deprecated
2162     uint64_t vbv_delay;
2163 #endif
2164
2165 #if FF_API_SIDEDATA_ONLY_PKT
2166     /**
2167      * Encoding only and set by default. Allow encoders to output packets
2168      * that do not contain any encoded data, only side data.
2169      *
2170      * Some encoders need to output such packets, e.g. to update some stream
2171      * parameters at the end of encoding.
2172      *
2173      * @deprecated this field disables the default behaviour and
2174      *             it is kept only for compatibility.
2175      */
2176     attribute_deprecated
2177     int side_data_only_packets;
2178 #endif
2179
2180     /**
2181      * Audio only. The number of "priming" samples (padding) inserted by the
2182      * encoder at the beginning of the audio. I.e. this number of leading
2183      * decoded samples must be discarded by the caller to get the original audio
2184      * without leading padding.
2185      *
2186      * - decoding: unused
2187      * - encoding: Set by libavcodec. The timestamps on the output packets are
2188      *             adjusted by the encoder so that they always refer to the
2189      *             first sample of the data actually contained in the packet,
2190      *             including any added padding.  E.g. if the timebase is
2191      *             1/samplerate and the timestamp of the first input sample is
2192      *             0, the timestamp of the first output packet will be
2193      *             -initial_padding.
2194      */
2195     int initial_padding;
2196
2197     /**
2198      * - decoding: For codecs that store a framerate value in the compressed
2199      *             bitstream, the decoder may export it here. { 0, 1} when
2200      *             unknown.
2201      * - encoding: May be used to signal the framerate of CFR content to an
2202      *             encoder.
2203      */
2204     AVRational framerate;
2205
2206     /**
2207      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2208      * - encoding: unused.
2209      * - decoding: Set by libavcodec before calling get_format()
2210      */
2211     enum AVPixelFormat sw_pix_fmt;
2212
2213     /**
2214      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2215      * - encoding unused.
2216      * - decoding set by user.
2217      */
2218     AVRational pkt_timebase;
2219
2220     /**
2221      * AVCodecDescriptor
2222      * - encoding: unused.
2223      * - decoding: set by libavcodec.
2224      */
2225     const AVCodecDescriptor *codec_descriptor;
2226
2227 #if !FF_API_LOWRES
2228     /**
2229      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2230      * - encoding: unused
2231      * - decoding: Set by user.
2232      */
2233      int lowres;
2234 #endif
2235
2236     /**
2237      * Current statistics for PTS correction.
2238      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2239      * - encoding: unused
2240      */
2241     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2242     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2243     int64_t pts_correction_last_pts;       /// PTS of the last frame
2244     int64_t pts_correction_last_dts;       /// DTS of the last frame
2245
2246     /**
2247      * Character encoding of the input subtitles file.
2248      * - decoding: set by user
2249      * - encoding: unused
2250      */
2251     char *sub_charenc;
2252
2253     /**
2254      * Subtitles character encoding mode. Formats or codecs might be adjusting
2255      * this setting (if they are doing the conversion themselves for instance).
2256      * - decoding: set by libavcodec
2257      * - encoding: unused
2258      */
2259     int sub_charenc_mode;
2260 #define FF_SUB_CHARENC_MODE_DO_NOTHING  -1  ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
2261 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
2262 #define FF_SUB_CHARENC_MODE_PRE_DECODER  1  ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
2263 #define FF_SUB_CHARENC_MODE_IGNORE       2  ///< neither convert the subtitles, nor check them for valid UTF-8
2264
2265     /**
2266      * Skip processing alpha if supported by codec.
2267      * Note that if the format uses pre-multiplied alpha (common with VP6,
2268      * and recommended due to better video quality/compression)
2269      * the image will look as if alpha-blended onto a black background.
2270      * However for formats that do not use pre-multiplied alpha
2271      * there might be serious artefacts (though e.g. libswscale currently
2272      * assumes pre-multiplied alpha anyway).
2273      *
2274      * - decoding: set by user
2275      * - encoding: unused
2276      */
2277     int skip_alpha;
2278
2279     /**
2280      * Number of samples to skip after a discontinuity
2281      * - decoding: unused
2282      * - encoding: set by libavcodec
2283      */
2284     int seek_preroll;
2285
2286 #if !FF_API_DEBUG_MV
2287     /**
2288      * debug motion vectors
2289      * - encoding: Set by user.
2290      * - decoding: Set by user.
2291      */
2292     int debug_mv;
2293 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2294 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2295 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2296 #endif
2297
2298     /**
2299      * custom intra quantization matrix
2300      * - encoding: Set by user, can be NULL.
2301      * - decoding: unused.
2302      */
2303     uint16_t *chroma_intra_matrix;
2304
2305     /**
2306      * dump format separator.
2307      * can be ", " or "\n      " or anything else
2308      * - encoding: Set by user.
2309      * - decoding: Set by user.
2310      */
2311     uint8_t *dump_separator;
2312
2313     /**
2314      * ',' separated list of allowed decoders.
2315      * If NULL then all are allowed
2316      * - encoding: unused
2317      * - decoding: set by user
2318      */
2319     char *codec_whitelist;
2320
2321     /**
2322      * Properties of the stream that gets decoded
2323      * - encoding: unused
2324      * - decoding: set by libavcodec
2325      */
2326     unsigned properties;
2327 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
2328 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2329
2330     /**
2331      * Additional data associated with the entire coded stream.
2332      *
2333      * - decoding: unused
2334      * - encoding: may be set by libavcodec after avcodec_open2().
2335      */
2336     AVPacketSideData *coded_side_data;
2337     int            nb_coded_side_data;
2338
2339     /**
2340      * A reference to the AVHWFramesContext describing the input (for encoding)
2341      * or output (decoding) frames. The reference is set by the caller and
2342      * afterwards owned (and freed) by libavcodec - it should never be read by
2343      * the caller after being set.
2344      *
2345      * - decoding: This field should be set by the caller from the get_format()
2346      *             callback. The previous reference (if any) will always be
2347      *             unreffed by libavcodec before the get_format() call.
2348      *
2349      *             If the default get_buffer2() is used with a hwaccel pixel
2350      *             format, then this AVHWFramesContext will be used for
2351      *             allocating the frame buffers.
2352      *
2353      * - encoding: For hardware encoders configured to use a hwaccel pixel
2354      *             format, this field should be set by the caller to a reference
2355      *             to the AVHWFramesContext describing input frames.
2356      *             AVHWFramesContext.format must be equal to
2357      *             AVCodecContext.pix_fmt.
2358      *
2359      *             This field should be set before avcodec_open2() is called.
2360      */
2361     AVBufferRef *hw_frames_ctx;
2362
2363     /**
2364      * Control the form of AVSubtitle.rects[N]->ass
2365      * - decoding: set by user
2366      * - encoding: unused
2367      */
2368     int sub_text_format;
2369 #define FF_SUB_TEXT_FMT_ASS              0
2370 #if FF_API_ASS_TIMING
2371 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2372 #endif
2373
2374     /**
2375      * Audio only. The amount of padding (in samples) appended by the encoder to
2376      * the end of the audio. I.e. this number of decoded samples must be
2377      * discarded by the caller from the end of the stream to get the original
2378      * audio without any trailing padding.
2379      *
2380      * - decoding: unused
2381      * - encoding: unused
2382      */
2383     int trailing_padding;
2384
2385     /**
2386      * The number of pixels per image to maximally accept.
2387      *
2388      * - decoding: set by user
2389      * - encoding: set by user
2390      */
2391     int64_t max_pixels;
2392
2393     /**
2394      * A reference to the AVHWDeviceContext describing the device which will
2395      * be used by a hardware encoder/decoder.  The reference is set by the
2396      * caller and afterwards owned (and freed) by libavcodec.
2397      *
2398      * This should be used if either the codec device does not require
2399      * hardware frames or any that are used are to be allocated internally by
2400      * libavcodec.  If the user wishes to supply any of the frames used as
2401      * encoder input or decoder output then hw_frames_ctx should be used
2402      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
2403      * field will be ignored while decoding the associated stream segment, but
2404      * may again be used on a following one after another get_format() call.
2405      *
2406      * For both encoders and decoders this field should be set before
2407      * avcodec_open2() is called and must not be written to thereafter.
2408      *
2409      * Note that some decoders may require this field to be set initially in
2410      * order to support hw_frames_ctx at all - in that case, all frames
2411      * contexts used must be created on the same device.
2412      */
2413     AVBufferRef *hw_device_ctx;
2414
2415     /**
2416      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2417      * decoding (if active).
2418      * - encoding: unused
2419      * - decoding: Set by user (either before avcodec_open2(), or in the
2420      *             AVCodecContext.get_format callback)
2421      */
2422     int hwaccel_flags;
2423
2424     /**
2425      * Video decoding only. Certain video codecs support cropping, meaning that
2426      * only a sub-rectangle of the decoded frame is intended for display.  This
2427      * option controls how cropping is handled by libavcodec.
2428      *
2429      * When set to 1 (the default), libavcodec will apply cropping internally.
2430      * I.e. it will modify the output frame width/height fields and offset the
2431      * data pointers (only by as much as possible while preserving alignment, or
2432      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2433      * the frames output by the decoder refer only to the cropped area. The
2434      * crop_* fields of the output frames will be zero.
2435      *
2436      * When set to 0, the width/height fields of the output frames will be set
2437      * to the coded dimensions and the crop_* fields will describe the cropping
2438      * rectangle. Applying the cropping is left to the caller.
2439      *
2440      * @warning When hardware acceleration with opaque output frames is used,
2441      * libavcodec is unable to apply cropping from the top/left border.
2442      *
2443      * @note when this option is set to zero, the width/height fields of the
2444      * AVCodecContext and output AVFrames have different meanings. The codec
2445      * context fields store display dimensions (with the coded dimensions in
2446      * coded_width/height), while the frame fields store the coded dimensions
2447      * (with the display dimensions being determined by the crop_* fields).
2448      */
2449     int apply_cropping;
2450
2451     /*
2452      * Video decoding only.  Sets the number of extra hardware frames which
2453      * the decoder will allocate for use by the caller.  This must be set
2454      * before avcodec_open2() is called.
2455      *
2456      * Some hardware decoders require all frames that they will use for
2457      * output to be defined in advance before decoding starts.  For such
2458      * decoders, the hardware frame pool must therefore be of a fixed size.
2459      * The extra frames set here are on top of any number that the decoder
2460      * needs internally in order to operate normally (for example, frames
2461      * used as reference pictures).
2462      */
2463     int extra_hw_frames;
2464
2465     /**
2466      * The percentage of damaged samples to discard a frame.
2467      *
2468      * - decoding: set by user
2469      * - encoding: unused
2470      */
2471     int discard_damaged_percentage;
2472
2473     /**
2474      * The number of samples per frame to maximally accept.
2475      *
2476      * - decoding: set by user
2477      * - encoding: set by user
2478      */
2479     int64_t max_samples;
2480
2481     /**
2482      * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2483      * metadata exported in frame, packet, or coded stream side data by
2484      * decoders and encoders.
2485      *
2486      * - decoding: set by user
2487      * - encoding: set by user
2488      */
2489     int export_side_data;
2490 } AVCodecContext;
2491
2492 #if FF_API_CODEC_GET_SET
2493 /**
2494  * Accessors for some AVCodecContext fields. These used to be provided for ABI
2495  * compatibility, and do not need to be used anymore.
2496  */
2497 attribute_deprecated
2498 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
2499 attribute_deprecated
2500 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
2501
2502 attribute_deprecated
2503 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2504 attribute_deprecated
2505 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2506
2507 attribute_deprecated
2508 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2509
2510 #if FF_API_LOWRES
2511 attribute_deprecated
2512 int  av_codec_get_lowres(const AVCodecContext *avctx);
2513 attribute_deprecated
2514 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2515 #endif
2516
2517 attribute_deprecated
2518 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
2519 attribute_deprecated
2520 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2521
2522 attribute_deprecated
2523 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2524 attribute_deprecated
2525 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2526 #endif
2527
2528 /**
2529  * AVProfile.
2530  */
2531 typedef struct AVProfile {
2532     int profile;
2533     const char *name; ///< short name for the profile
2534 } AVProfile;
2535
2536 enum {
2537     /**
2538      * The codec supports this format via the hw_device_ctx interface.
2539      *
2540      * When selecting this format, AVCodecContext.hw_device_ctx should
2541      * have been set to a device of the specified type before calling
2542      * avcodec_open2().
2543      */
2544     AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2545     /**
2546      * The codec supports this format via the hw_frames_ctx interface.
2547      *
2548      * When selecting this format for a decoder,
2549      * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2550      * context inside the get_format() callback.  The frames context
2551      * must have been created on a device of the specified type.
2552      *
2553      * When selecting this format for an encoder,
2554      * AVCodecContext.hw_frames_ctx should be set to the context which
2555      * will be used for the input frames before calling avcodec_open2().
2556      */
2557     AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2558     /**
2559      * The codec supports this format by some internal method.
2560      *
2561      * This format can be selected without any additional configuration -
2562      * no device or frames context is required.
2563      */
2564     AV_CODEC_HW_CONFIG_METHOD_INTERNAL      = 0x04,
2565     /**
2566      * The codec supports this format by some ad-hoc method.
2567      *
2568      * Additional settings and/or function calls are required.  See the
2569      * codec-specific documentation for details.  (Methods requiring
2570      * this sort of configuration are deprecated and others should be
2571      * used in preference.)
2572      */
2573     AV_CODEC_HW_CONFIG_METHOD_AD_HOC        = 0x08,
2574 };
2575
2576 typedef struct AVCodecHWConfig {
2577     /**
2578      * For decoders, a hardware pixel format which that decoder may be
2579      * able to decode to if suitable hardware is available.
2580      *
2581      * For encoders, a pixel format which the encoder may be able to
2582      * accept.  If set to AV_PIX_FMT_NONE, this applies to all pixel
2583      * formats supported by the codec.
2584      */
2585     enum AVPixelFormat pix_fmt;
2586     /**
2587      * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2588      * setup methods which can be used with this configuration.
2589      */
2590     int methods;
2591     /**
2592      * The device type associated with the configuration.
2593      *
2594      * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2595      * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2596      */
2597     enum AVHWDeviceType device_type;
2598 } AVCodecHWConfig;
2599
2600 typedef struct AVCodecDefault AVCodecDefault;
2601
2602 struct AVSubtitle;
2603
2604 /**
2605  * AVCodec.
2606  */
2607 typedef struct AVCodec {
2608     /**
2609      * Name of the codec implementation.
2610      * The name is globally unique among encoders and among decoders (but an
2611      * encoder and a decoder can share the same name).
2612      * This is the primary way to find a codec from the user perspective.
2613      */
2614     const char *name;
2615     /**
2616      * Descriptive name for the codec, meant to be more human readable than name.
2617      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2618      */
2619     const char *long_name;
2620     enum AVMediaType type;
2621     enum AVCodecID id;
2622     /**
2623      * Codec capabilities.
2624      * see AV_CODEC_CAP_*
2625      */
2626     int capabilities;
2627     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2628     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2629     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2630     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2631     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2632     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2633     const AVClass *priv_class;              ///< AVClass for the private context
2634     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2635
2636     /**
2637      * Group name of the codec implementation.
2638      * This is a short symbolic name of the wrapper backing this codec. A
2639      * wrapper uses some kind of external implementation for the codec, such
2640      * as an external library, or a codec implementation provided by the OS or
2641      * the hardware.
2642      * If this field is NULL, this is a builtin, libavcodec native codec.
2643      * If non-NULL, this will be the suffix in AVCodec.name in most cases
2644      * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2645      */
2646     const char *wrapper_name;
2647
2648     /*****************************************************************
2649      * No fields below this line are part of the public API. They
2650      * may not be used outside of libavcodec and can be changed and
2651      * removed at will.
2652      * New public fields should be added right above.
2653      *****************************************************************
2654      */
2655     int priv_data_size;
2656     struct AVCodec *next;
2657     /**
2658      * @name Frame-level threading support functions
2659      * @{
2660      */
2661     /**
2662      * Copy necessary context variables from a previous thread context to the current one.
2663      * If not defined, the next thread will start automatically; otherwise, the codec
2664      * must call ff_thread_finish_setup().
2665      *
2666      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2667      */
2668     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2669     /** @} */
2670
2671     /**
2672      * Private codec-specific defaults.
2673      */
2674     const AVCodecDefault *defaults;
2675
2676     /**
2677      * Initialize codec static data, called from avcodec_register().
2678      *
2679      * This is not intended for time consuming operations as it is
2680      * run for every codec regardless of that codec being used.
2681      */
2682     void (*init_static_data)(struct AVCodec *codec);
2683
2684     int (*init)(AVCodecContext *);
2685     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2686                       const struct AVSubtitle *sub);
2687     /**
2688      * Encode data to an AVPacket.
2689      *
2690      * @param      avctx          codec context
2691      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2692      * @param[in]  frame          AVFrame containing the raw data to be encoded
2693      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2694      *                            non-empty packet was returned in avpkt.
2695      * @return 0 on success, negative error code on failure
2696      */
2697     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2698                    int *got_packet_ptr);
2699     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2700     int (*close)(AVCodecContext *);
2701     /**
2702      * Encode API with decoupled packet/frame dataflow. The API is the
2703      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2704      * that:
2705      * - never called if the codec is closed or the wrong type,
2706      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2707      * - only one drain frame is ever passed down,
2708      */
2709     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2710     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2711
2712     /**
2713      * Decode API with decoupled packet/frame dataflow. This function is called
2714      * to get one output frame. It should call ff_decode_get_packet() to obtain
2715      * input data.
2716      */
2717     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2718     /**
2719      * Flush buffers.
2720      * Will be called when seeking
2721      */
2722     void (*flush)(AVCodecContext *);
2723     /**
2724      * Internal codec capabilities.
2725      * See FF_CODEC_CAP_* in internal.h
2726      */
2727     int caps_internal;
2728
2729     /**
2730      * Decoding only, a comma-separated list of bitstream filters to apply to
2731      * packets before decoding.
2732      */
2733     const char *bsfs;
2734
2735     /**
2736      * Array of pointers to hardware configurations supported by the codec,
2737      * or NULL if no hardware supported.  The array is terminated by a NULL
2738      * pointer.
2739      *
2740      * The user can only access this field via avcodec_get_hw_config().
2741      */
2742     const struct AVCodecHWConfigInternal **hw_configs;
2743
2744     /**
2745      * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
2746      */
2747     const uint32_t *codec_tags;
2748 } AVCodec;
2749
2750 #if FF_API_CODEC_GET_SET
2751 attribute_deprecated
2752 int av_codec_get_max_lowres(const AVCodec *codec);
2753 #endif
2754
2755 struct MpegEncContext;
2756
2757 /**
2758  * Retrieve supported hardware configurations for a codec.
2759  *
2760  * Values of index from zero to some maximum return the indexed configuration
2761  * descriptor; all other values return NULL.  If the codec does not support
2762  * any hardware configurations then it will always return NULL.
2763  */
2764 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2765
2766 /**
2767  * @defgroup lavc_hwaccel AVHWAccel
2768  *
2769  * @note  Nothing in this structure should be accessed by the user.  At some
2770  *        point in future it will not be externally visible at all.
2771  *
2772  * @{
2773  */
2774 typedef struct AVHWAccel {
2775     /**
2776      * Name of the hardware accelerated codec.
2777      * The name is globally unique among encoders and among decoders (but an
2778      * encoder and a decoder can share the same name).
2779      */
2780     const char *name;
2781
2782     /**
2783      * Type of codec implemented by the hardware accelerator.
2784      *
2785      * See AVMEDIA_TYPE_xxx
2786      */
2787     enum AVMediaType type;
2788
2789     /**
2790      * Codec implemented by the hardware accelerator.
2791      *
2792      * See AV_CODEC_ID_xxx
2793      */
2794     enum AVCodecID id;
2795
2796     /**
2797      * Supported pixel format.
2798      *
2799      * Only hardware accelerated formats are supported here.
2800      */
2801     enum AVPixelFormat pix_fmt;
2802
2803     /**
2804      * Hardware accelerated codec capabilities.
2805      * see AV_HWACCEL_CODEC_CAP_*
2806      */
2807     int capabilities;
2808
2809     /*****************************************************************
2810      * No fields below this line are part of the public API. They
2811      * may not be used outside of libavcodec and can be changed and
2812      * removed at will.
2813      * New public fields should be added right above.
2814      *****************************************************************
2815      */
2816
2817     /**
2818      * Allocate a custom buffer
2819      */
2820     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2821
2822     /**
2823      * Called at the beginning of each frame or field picture.
2824      *
2825      * Meaningful frame information (codec specific) is guaranteed to
2826      * be parsed at this point. This function is mandatory.
2827      *
2828      * Note that buf can be NULL along with buf_size set to 0.
2829      * Otherwise, this means the whole frame is available at this point.
2830      *
2831      * @param avctx the codec context
2832      * @param buf the frame data buffer base
2833      * @param buf_size the size of the frame in bytes
2834      * @return zero if successful, a negative value otherwise
2835      */
2836     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2837
2838     /**
2839      * Callback for parameter data (SPS/PPS/VPS etc).
2840      *
2841      * Useful for hardware decoders which keep persistent state about the
2842      * video parameters, and need to receive any changes to update that state.
2843      *
2844      * @param avctx the codec context
2845      * @param type the nal unit type
2846      * @param buf the nal unit data buffer
2847      * @param buf_size the size of the nal unit in bytes
2848      * @return zero if successful, a negative value otherwise
2849      */
2850     int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2851
2852     /**
2853      * Callback for each slice.
2854      *
2855      * Meaningful slice information (codec specific) is guaranteed to
2856      * be parsed at this point. This function is mandatory.
2857      * The only exception is XvMC, that works on MB level.
2858      *
2859      * @param avctx the codec context
2860      * @param buf the slice data buffer base
2861      * @param buf_size the size of the slice in bytes
2862      * @return zero if successful, a negative value otherwise
2863      */
2864     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2865
2866     /**
2867      * Called at the end of each frame or field picture.
2868      *
2869      * The whole picture is parsed at this point and can now be sent
2870      * to the hardware accelerator. This function is mandatory.
2871      *
2872      * @param avctx the codec context
2873      * @return zero if successful, a negative value otherwise
2874      */
2875     int (*end_frame)(AVCodecContext *avctx);
2876
2877     /**
2878      * Size of per-frame hardware accelerator private data.
2879      *
2880      * Private data is allocated with av_mallocz() before
2881      * AVCodecContext.get_buffer() and deallocated after
2882      * AVCodecContext.release_buffer().
2883      */
2884     int frame_priv_data_size;
2885
2886     /**
2887      * Called for every Macroblock in a slice.
2888      *
2889      * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2890      * Instead of decoding to raw picture, MB parameters are
2891      * stored in an array provided by the video driver.
2892      *
2893      * @param s the mpeg context
2894      */
2895     void (*decode_mb)(struct MpegEncContext *s);
2896
2897     /**
2898      * Initialize the hwaccel private data.
2899      *
2900      * This will be called from ff_get_format(), after hwaccel and
2901      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2902      * is allocated.
2903      */
2904     int (*init)(AVCodecContext *avctx);
2905
2906     /**
2907      * Uninitialize the hwaccel private data.
2908      *
2909      * This will be called from get_format() or avcodec_close(), after hwaccel
2910      * and hwaccel_context are already uninitialized.
2911      */
2912     int (*uninit)(AVCodecContext *avctx);
2913
2914     /**
2915      * Size of the private data to allocate in
2916      * AVCodecInternal.hwaccel_priv_data.
2917      */
2918     int priv_data_size;
2919
2920     /**
2921      * Internal hwaccel capabilities.
2922      */
2923     int caps_internal;
2924
2925     /**
2926      * Fill the given hw_frames context with current codec parameters. Called
2927      * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2928      * details.
2929      *
2930      * This CAN be called before AVHWAccel.init is called, and you must assume
2931      * that avctx->hwaccel_priv_data is invalid.
2932      */
2933     int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2934 } AVHWAccel;
2935
2936 /**
2937  * HWAccel is experimental and is thus avoided in favor of non experimental
2938  * codecs
2939  */
2940 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2941
2942 /**
2943  * Hardware acceleration should be used for decoding even if the codec level
2944  * used is unknown or higher than the maximum supported level reported by the
2945  * hardware driver.
2946  *
2947  * It's generally a good idea to pass this flag unless you have a specific
2948  * reason not to, as hardware tends to under-report supported levels.
2949  */
2950 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2951
2952 /**
2953  * Hardware acceleration can output YUV pixel formats with a different chroma
2954  * sampling than 4:2:0 and/or other than 8 bits per component.
2955  */
2956 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2957
2958 /**
2959  * Hardware acceleration should still be attempted for decoding when the
2960  * codec profile does not match the reported capabilities of the hardware.
2961  *
2962  * For example, this can be used to try to decode baseline profile H.264
2963  * streams in hardware - it will often succeed, because many streams marked
2964  * as baseline profile actually conform to constrained baseline profile.
2965  *
2966  * @warning If the stream is actually not supported then the behaviour is
2967  *          undefined, and may include returning entirely incorrect output
2968  *          while indicating success.
2969  */
2970 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2971
2972 /**
2973  * @}
2974  */
2975
2976 #if FF_API_AVPICTURE
2977 /**
2978  * @defgroup lavc_picture AVPicture
2979  *
2980  * Functions for working with AVPicture
2981  * @{
2982  */
2983
2984 /**
2985  * Picture data structure.
2986  *
2987  * Up to four components can be stored into it, the last component is
2988  * alpha.
2989  * @deprecated use AVFrame or imgutils functions instead
2990  */
2991 typedef struct AVPicture {
2992     attribute_deprecated
2993     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
2994     attribute_deprecated
2995     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
2996 } AVPicture;
2997
2998 /**
2999  * @}
3000  */
3001 #endif
3002
3003 enum AVSubtitleType {
3004     SUBTITLE_NONE,
3005
3006     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3007
3008     /**
3009      * Plain text, the text field must be set by the decoder and is
3010      * authoritative. ass and pict fields may contain approximations.
3011      */
3012     SUBTITLE_TEXT,
3013
3014     /**
3015      * Formatted text, the ass field must be set by the decoder and is
3016      * authoritative. pict and text fields may contain approximations.
3017      */
3018     SUBTITLE_ASS,
3019 };
3020
3021 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3022
3023 typedef struct AVSubtitleRect {
3024     int x;         ///< top left corner  of pict, undefined when pict is not set
3025     int y;         ///< top left corner  of pict, undefined when pict is not set
3026     int w;         ///< width            of pict, undefined when pict is not set
3027     int h;         ///< height           of pict, undefined when pict is not set
3028     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3029
3030 #if FF_API_AVPICTURE
3031     /**
3032      * @deprecated unused
3033      */
3034     attribute_deprecated
3035     AVPicture pict;
3036 #endif
3037     /**
3038      * data+linesize for the bitmap of this subtitle.
3039      * Can be set for text/ass as well once they are rendered.
3040      */
3041     uint8_t *data[4];
3042     int linesize[4];
3043
3044     enum AVSubtitleType type;
3045
3046     char *text;                     ///< 0 terminated plain UTF-8 text
3047
3048     /**
3049      * 0 terminated ASS/SSA compatible event line.
3050      * The presentation of this is unaffected by the other values in this
3051      * struct.
3052      */
3053     char *ass;
3054
3055     int flags;
3056 } AVSubtitleRect;
3057
3058 typedef struct AVSubtitle {
3059     uint16_t format; /* 0 = graphics */
3060     uint32_t start_display_time; /* relative to packet pts, in ms */
3061     uint32_t end_display_time; /* relative to packet pts, in ms */
3062     unsigned num_rects;
3063     AVSubtitleRect **rects;
3064     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3065 } AVSubtitle;
3066
3067 /**
3068  * This struct describes the properties of an encoded stream.
3069  *
3070  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3071  * be allocated with avcodec_parameters_alloc() and freed with
3072  * avcodec_parameters_free().
3073  */
3074 typedef struct AVCodecParameters {
3075     /**
3076      * General type of the encoded data.
3077      */
3078     enum AVMediaType codec_type;
3079     /**
3080      * Specific type of the encoded data (the codec used).
3081      */
3082     enum AVCodecID   codec_id;
3083     /**
3084      * Additional information about the codec (corresponds to the AVI FOURCC).
3085      */
3086     uint32_t         codec_tag;
3087
3088     /**
3089      * Extra binary data needed for initializing the decoder, codec-dependent.
3090      *
3091      * Must be allocated with av_malloc() and will be freed by
3092      * avcodec_parameters_free(). The allocated size of extradata must be at
3093      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3094      * bytes zeroed.
3095      */
3096     uint8_t *extradata;
3097     /**
3098      * Size of the extradata content in bytes.
3099      */
3100     int      extradata_size;
3101
3102     /**
3103      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3104      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3105      */
3106     int format;
3107
3108     /**
3109      * The average bitrate of the encoded data (in bits per second).
3110      */
3111     int64_t bit_rate;
3112
3113     /**
3114      * The number of bits per sample in the codedwords.
3115      *
3116      * This is basically the bitrate per sample. It is mandatory for a bunch of
3117      * formats to actually decode them. It's the number of bits for one sample in
3118      * the actual coded bitstream.
3119      *
3120      * This could be for example 4 for ADPCM
3121      * For PCM formats this matches bits_per_raw_sample
3122      * Can be 0
3123      */
3124     int bits_per_coded_sample;
3125
3126     /**
3127      * This is the number of valid bits in each output sample. If the
3128      * sample format has more bits, the least significant bits are additional
3129      * padding bits, which are always 0. Use right shifts to reduce the sample
3130      * to its actual size. For example, audio formats with 24 bit samples will
3131      * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3132      * To get the original sample use "(int32_t)sample >> 8"."
3133      *
3134      * For ADPCM this might be 12 or 16 or similar
3135      * Can be 0
3136      */
3137     int bits_per_raw_sample;
3138
3139     /**
3140      * Codec-specific bitstream restrictions that the stream conforms to.
3141      */
3142     int profile;
3143     int level;
3144
3145     /**
3146      * Video only. The dimensions of the video frame in pixels.
3147      */
3148     int width;
3149     int height;
3150
3151     /**
3152      * Video only. The aspect ratio (width / height) which a single pixel
3153      * should have when displayed.
3154      *
3155      * When the aspect ratio is unknown / undefined, the numerator should be
3156      * set to 0 (the denominator may have any value).
3157      */
3158     AVRational sample_aspect_ratio;
3159
3160     /**
3161      * Video only. The order of the fields in interlaced video.
3162      */
3163     enum AVFieldOrder                  field_order;
3164
3165     /**
3166      * Video only. Additional colorspace characteristics.
3167      */
3168     enum AVColorRange                  color_range;
3169     enum AVColorPrimaries              color_primaries;
3170     enum AVColorTransferCharacteristic color_trc;
3171     enum AVColorSpace                  color_space;
3172     enum AVChromaLocation              chroma_location;
3173
3174     /**
3175      * Video only. Number of delayed frames.
3176      */
3177     int video_delay;
3178
3179     /**
3180      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3181      * unknown or unspecified, otherwise the number of bits set must be equal to
3182      * the channels field.
3183      */
3184     uint64_t channel_layout;
3185     /**
3186      * Audio only. The number of audio channels.
3187      */
3188     int      channels;
3189     /**
3190      * Audio only. The number of audio samples per second.
3191      */
3192     int      sample_rate;
3193     /**
3194      * Audio only. The number of bytes per coded audio frame, required by some
3195      * formats.
3196      *
3197      * Corresponds to nBlockAlign in WAVEFORMATEX.
3198      */
3199     int      block_align;
3200     /**
3201      * Audio only. Audio frame size, if known. Required by some formats to be static.
3202      */
3203     int      frame_size;
3204
3205     /**
3206      * Audio only. The amount of padding (in samples) inserted by the encoder at
3207      * the beginning of the audio. I.e. this number of leading decoded samples
3208      * must be discarded by the caller to get the original audio without leading
3209      * padding.
3210      */
3211     int initial_padding;
3212     /**
3213      * Audio only. The amount of padding (in samples) appended by the encoder to
3214      * the end of the audio. I.e. this number of decoded samples must be
3215      * discarded by the caller from the end of the stream to get the original
3216      * audio without any trailing padding.
3217      */
3218     int trailing_padding;
3219     /**
3220      * Audio only. Number of samples to skip after a discontinuity.
3221      */
3222     int seek_preroll;
3223 } AVCodecParameters;
3224
3225 /**
3226  * Iterate over all registered codecs.
3227  *
3228  * @param opaque a pointer where libavcodec will store the iteration state. Must
3229  *               point to NULL to start the iteration.
3230  *
3231  * @return the next registered codec or NULL when the iteration is
3232  *         finished
3233  */
3234 const AVCodec *av_codec_iterate(void **opaque);
3235
3236 #if FF_API_NEXT
3237 /**
3238  * If c is NULL, returns the first registered codec,
3239  * if c is non-NULL, returns the next registered codec after c,
3240  * or NULL if c is the last one.
3241  */
3242 attribute_deprecated
3243 AVCodec *av_codec_next(const AVCodec *c);
3244 #endif
3245
3246 /**
3247  * Return the LIBAVCODEC_VERSION_INT constant.
3248  */
3249 unsigned avcodec_version(void);
3250
3251 /**
3252  * Return the libavcodec build-time configuration.
3253  */
3254 const char *avcodec_configuration(void);
3255
3256 /**
3257  * Return the libavcodec license.
3258  */
3259 const char *avcodec_license(void);
3260
3261 #if FF_API_NEXT
3262 /**
3263  * Register the codec codec and initialize libavcodec.
3264  *
3265  * @warning either this function or avcodec_register_all() must be called
3266  * before any other libavcodec functions.
3267  *
3268  * @see avcodec_register_all()
3269  */
3270 attribute_deprecated
3271 void avcodec_register(AVCodec *codec);
3272
3273 /**
3274  * Register all the codecs, parsers and bitstream filters which were enabled at
3275  * configuration time. If you do not call this function you can select exactly
3276  * which formats you want to support, by using the individual registration
3277  * functions.
3278  *
3279  * @see avcodec_register
3280  * @see av_register_codec_parser
3281  * @see av_register_bitstream_filter
3282  */
3283 attribute_deprecated
3284 void avcodec_register_all(void);
3285 #endif
3286
3287 /**
3288  * Allocate an AVCodecContext and set its fields to default values. The
3289  * resulting struct should be freed with avcodec_free_context().
3290  *
3291  * @param codec if non-NULL, allocate private data and initialize defaults
3292  *              for the given codec. It is illegal to then call avcodec_open2()
3293  *              with a different codec.
3294  *              If NULL, then the codec-specific defaults won't be initialized,
3295  *              which may result in suboptimal default settings (this is
3296  *              important mainly for encoders, e.g. libx264).
3297  *
3298  * @return An AVCodecContext filled with default values or NULL on failure.
3299  */
3300 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3301
3302 /**
3303  * Free the codec context and everything associated with it and write NULL to
3304  * the provided pointer.
3305  */
3306 void avcodec_free_context(AVCodecContext **avctx);
3307
3308 #if FF_API_GET_CONTEXT_DEFAULTS
3309 /**
3310  * @deprecated This function should not be used, as closing and opening a codec
3311  * context multiple time is not supported. A new codec context should be
3312  * allocated for each new use.
3313  */
3314 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3315 #endif
3316
3317 /**
3318  * Get the AVClass for AVCodecContext. It can be used in combination with
3319  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3320  *
3321  * @see av_opt_find().
3322  */
3323 const AVClass *avcodec_get_class(void);
3324
3325 #if FF_API_COPY_CONTEXT
3326 /**
3327  * Get the AVClass for AVFrame. It can be used in combination with
3328  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3329  *
3330  * @see av_opt_find().
3331  */
3332 const AVClass *avcodec_get_frame_class(void);
3333
3334 /**
3335  * Get the AVClass for AVSubtitleRect. It can be used in combination with
3336  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3337  *
3338  * @see av_opt_find().
3339  */
3340 const AVClass *avcodec_get_subtitle_rect_class(void);
3341
3342 /**
3343  * Copy the settings of the source AVCodecContext into the destination
3344  * AVCodecContext. The resulting destination codec context will be
3345  * unopened, i.e. you are required to call avcodec_open2() before you
3346  * can use this AVCodecContext to decode/encode video/audio data.
3347  *
3348  * @param dest target codec context, should be initialized with
3349  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
3350  * @param src source codec context
3351  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3352  *
3353  * @deprecated The semantics of this function are ill-defined and it should not
3354  * be used. If you need to transfer the stream parameters from one codec context
3355  * to another, use an intermediate AVCodecParameters instance and the
3356  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3357  * functions.
3358  */
3359 attribute_deprecated
3360 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3361 #endif
3362
3363 /**
3364  * Allocate a new AVCodecParameters and set its fields to default values
3365  * (unknown/invalid/0). The returned struct must be freed with
3366  * avcodec_parameters_free().
3367  */
3368 AVCodecParameters *avcodec_parameters_alloc(void);
3369
3370 /**
3371  * Free an AVCodecParameters instance and everything associated with it and
3372  * write NULL to the supplied pointer.
3373  */
3374 void avcodec_parameters_free(AVCodecParameters **par);
3375
3376 /**
3377  * Copy the contents of src to dst. Any allocated fields in dst are freed and
3378  * replaced with newly allocated duplicates of the corresponding fields in src.
3379  *
3380  * @return >= 0 on success, a negative AVERROR code on failure.
3381  */
3382 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3383
3384 /**
3385  * Fill the parameters struct based on the values from the supplied codec
3386  * context. Any allocated fields in par are freed and replaced with duplicates
3387  * of the corresponding fields in codec.
3388  *
3389  * @return >= 0 on success, a negative AVERROR code on failure
3390  */
3391 int avcodec_parameters_from_context(AVCodecParameters *par,
3392                                     const AVCodecContext *codec);
3393
3394 /**
3395  * Fill the codec context based on the values from the supplied codec
3396  * parameters. Any allocated fields in codec that have a corresponding field in
3397  * par are freed and replaced with duplicates of the corresponding field in par.
3398  * Fields in codec that do not have a counterpart in par are not touched.
3399  *
3400  * @return >= 0 on success, a negative AVERROR code on failure.
3401  */
3402 int avcodec_parameters_to_context(AVCodecContext *codec,
3403                                   const AVCodecParameters *par);
3404
3405 /**
3406  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3407  * function the context has to be allocated with avcodec_alloc_context3().
3408  *
3409  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3410  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3411  * retrieving a codec.
3412  *
3413  * @warning This function is not thread safe!
3414  *
3415  * @note Always call this function before using decoding routines (such as
3416  * @ref avcodec_receive_frame()).
3417  *
3418  * @code
3419  * avcodec_register_all();
3420  * av_dict_set(&opts, "b", "2.5M", 0);
3421  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3422  * if (!codec)
3423  *     exit(1);
3424  *
3425  * context = avcodec_alloc_context3(codec);
3426  *
3427  * if (avcodec_open2(context, codec, opts) < 0)
3428  *     exit(1);
3429  * @endcode
3430  *
3431  * @param avctx The context to initialize.
3432  * @param codec The codec to open this context for. If a non-NULL codec has been
3433  *              previously passed to avcodec_alloc_context3() or
3434  *              for this context, then this parameter MUST be either NULL or
3435  *              equal to the previously passed codec.
3436  * @param options A dictionary filled with AVCodecContext and codec-private options.
3437  *                On return this object will be filled with options that were not found.
3438  *
3439  * @return zero on success, a negative value on error
3440  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3441  *      av_dict_set(), av_opt_find().
3442  */
3443 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3444
3445 /**
3446  * Close a given AVCodecContext and free all the data associated with it
3447  * (but not the AVCodecContext itself).
3448  *
3449  * Calling this function on an AVCodecContext that hasn't been opened will free
3450  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3451  * codec. Subsequent calls will do nothing.
3452  *
3453  * @note Do not use this function. Use avcodec_free_context() to destroy a
3454  * codec context (either open or closed). Opening and closing a codec context
3455  * multiple times is not supported anymore -- use multiple codec contexts
3456  * instead.
3457  */
3458 int avcodec_close(AVCodecContext *avctx);
3459
3460 /**
3461  * Free all allocated data in the given subtitle struct.
3462  *
3463  * @param sub AVSubtitle to free.
3464  */
3465 void avsubtitle_free(AVSubtitle *sub);
3466
3467 /**
3468  * @}
3469  */
3470
3471 /**
3472  * @addtogroup lavc_decoding
3473  * @{
3474  */
3475
3476 /**
3477  * Find a registered decoder with a matching codec ID.
3478  *
3479  * @param id AVCodecID of the requested decoder
3480  * @return A decoder if one was found, NULL otherwise.
3481  */
3482 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3483
3484 /**
3485  * Find a registered decoder with the specified name.
3486  *
3487  * @param name name of the requested decoder
3488  * @return A decoder if one was found, NULL otherwise.
3489  */
3490 AVCodec *avcodec_find_decoder_by_name(const char *name);
3491
3492 /**
3493  * The default callback for AVCodecContext.get_buffer2(). It is made public so
3494  * it can be called by custom get_buffer2() implementations for decoders without
3495  * AV_CODEC_CAP_DR1 set.
3496  */
3497 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3498
3499 /**
3500  * Modify width and height values so that they will result in a memory
3501  * buffer that is acceptable for the codec if you do not use any horizontal
3502  * padding.
3503  *
3504  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3505  */
3506 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3507
3508 /**
3509  * Modify width and height values so that they will result in a memory
3510  * buffer that is acceptable for the codec if you also ensure that all
3511  * line sizes are a multiple of the respective linesize_align[i].
3512  *
3513  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3514  */
3515 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3516                                int linesize_align[AV_NUM_DATA_POINTERS]);
3517
3518 /**
3519  * Converts AVChromaLocation to swscale x/y chroma position.
3520  *
3521  * The positions represent the chroma (0,0) position in a coordinates system
3522  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3523  *
3524  * @param xpos  horizontal chroma sample position
3525  * @param ypos  vertical   chroma sample position
3526  */
3527 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3528
3529 /**
3530  * Converts swscale x/y chroma position to AVChromaLocation.
3531  *
3532  * The positions represent the chroma (0,0) position in a coordinates system
3533  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3534  *
3535  * @param xpos  horizontal chroma sample position
3536  * @param ypos  vertical   chroma sample position
3537  */
3538 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3539
3540 /**
3541  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3542  *
3543  * Some decoders may support multiple frames in a single AVPacket. Such
3544  * decoders would then just decode the first frame and the return value would be
3545  * less than the packet size. In this case, avcodec_decode_audio4 has to be
3546  * called again with an AVPacket containing the remaining data in order to
3547  * decode the second frame, etc...  Even if no frames are returned, the packet
3548  * needs to be fed to the decoder with remaining data until it is completely
3549  * consumed or an error occurs.
3550  *
3551  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3552  * and output. This means that for some packets they will not immediately
3553  * produce decoded output and need to be flushed at the end of decoding to get
3554  * all the decoded data. Flushing is done by calling this function with packets
3555  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3556  * returning samples. It is safe to flush even those decoders that are not
3557  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3558  *
3559  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3560  *          larger than the actual read bytes because some optimized bitstream
3561  *          readers read 32 or 64 bits at once and could read over the end.
3562  *
3563  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3564  * before packets may be fed to the decoder.
3565  *
3566  * @param      avctx the codec context
3567  * @param[out] frame The AVFrame in which to store decoded audio samples.
3568  *                   The decoder will allocate a buffer for the decoded frame by
3569  *                   calling the AVCodecContext.get_buffer2() callback.
3570  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
3571  *                   reference counted and the returned reference belongs to the
3572  *                   caller. The caller must release the frame using av_frame_unref()
3573  *                   when the frame is no longer needed. The caller may safely write
3574  *                   to the frame if av_frame_is_writable() returns 1.
3575  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
3576  *                   reference belongs to the decoder and is valid only until the
3577  *                   next call to this function or until closing or flushing the
3578  *                   decoder. The caller may not write to it.
3579  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3580  *                           non-zero. Note that this field being set to zero
3581  *                           does not mean that an error has occurred. For
3582  *                           decoders with AV_CODEC_CAP_DELAY set, no given decode
3583  *                           call is guaranteed to produce a frame.
3584  * @param[in]  avpkt The input AVPacket containing the input buffer.
3585  *                   At least avpkt->data and avpkt->size should be set. Some
3586  *                   decoders might also require additional fields to be set.
3587  * @return A negative error code is returned if an error occurred during
3588  *         decoding, otherwise the number of bytes consumed from the input
3589  *         AVPacket is returned.
3590  *
3591 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3592  */
3593 attribute_deprecated
3594 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3595                           int *got_frame_ptr, const AVPacket *avpkt);
3596
3597 /**
3598  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3599  * Some decoders may support multiple frames in a single AVPacket, such
3600  * decoders would then just decode the first frame.
3601  *
3602  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3603  * the actual read bytes because some optimized bitstream readers read 32 or 64
3604  * bits at once and could read over the end.
3605  *
3606  * @warning The end of the input buffer buf should be set to 0 to ensure that
3607  * no overreading happens for damaged MPEG streams.
3608  *
3609  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3610  * between input and output, these need to be fed with avpkt->data=NULL,
3611  * avpkt->size=0 at the end to return the remaining frames.
3612  *
3613  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3614  * before packets may be fed to the decoder.
3615  *
3616  * @param avctx the codec context
3617  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3618  *             Use av_frame_alloc() to get an AVFrame. The codec will
3619  *             allocate memory for the actual bitmap by calling the
3620  *             AVCodecContext.get_buffer2() callback.
3621  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
3622  *             reference counted and the returned reference belongs to the
3623  *             caller. The caller must release the frame using av_frame_unref()
3624  *             when the frame is no longer needed. The caller may safely write
3625  *             to the frame if av_frame_is_writable() returns 1.
3626  *             When AVCodecContext.refcounted_frames is set to 0, the returned
3627  *             reference belongs to the decoder and is valid only until the
3628  *             next call to this function or until closing or flushing the
3629  *             decoder. The caller may not write to it.
3630  *
3631  * @param[in] avpkt The input AVPacket containing the input buffer.
3632  *            You can create such packet with av_init_packet() and by then setting
3633  *            data and size, some decoders might in addition need other fields like
3634  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3635  *            fields possible.
3636  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3637  * @return On error a negative value is returned, otherwise the number of bytes
3638  * used or zero if no frame could be decompressed.
3639  *
3640  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3641  */
3642 attribute_deprecated
3643 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3644                          int *got_picture_ptr,
3645                          const AVPacket *avpkt);
3646
3647 /**
3648  * Decode a subtitle message.
3649  * Return a negative value on error, otherwise return the number of bytes used.
3650  * If no subtitle could be decompressed, got_sub_ptr is zero.
3651  * Otherwise, the subtitle is stored in *sub.
3652  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3653  * simplicity, because the performance difference is expected to be negligible
3654  * and reusing a get_buffer written for video codecs would probably perform badly
3655  * due to a potentially very different allocation pattern.
3656  *
3657  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3658  * and output. This means that for some packets they will not immediately
3659  * produce decoded output and need to be flushed at the end of decoding to get
3660  * all the decoded data. Flushing is done by calling this function with packets
3661  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3662  * returning subtitles. It is safe to flush even those decoders that are not
3663  * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3664  *
3665  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3666  * before packets may be fed to the decoder.
3667  *
3668  * @param avctx the codec context
3669  * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3670  *                 must be freed with avsubtitle_free if *got_sub_ptr is set.
3671  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3672  * @param[in] avpkt The input AVPacket containing the input buffer.
3673  */
3674 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3675                             int *got_sub_ptr,
3676                             AVPacket *avpkt);
3677
3678 /**
3679  * Supply raw packet data as input to a decoder.
3680  *
3681  * Internally, this call will copy relevant AVCodecContext fields, which can
3682  * influence decoding per-packet, and apply them when the packet is actually
3683  * decoded. (For example AVCodecContext.skip_frame, which might direct the
3684  * decoder to drop the frame contained by the packet sent with this function.)
3685  *
3686  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3687  *          larger than the actual read bytes because some optimized bitstream
3688  *          readers read 32 or 64 bits at once and could read over the end.
3689  *
3690  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3691  *          on the same AVCodecContext. It will return unexpected results now
3692  *          or in future libavcodec versions.
3693  *
3694  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3695  *       before packets may be fed to the decoder.
3696  *
3697  * @param avctx codec context
3698  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3699  *                  frame, or several complete audio frames.
3700  *                  Ownership of the packet remains with the caller, and the
3701  *                  decoder will not write to the packet. The decoder may create
3702  *                  a reference to the packet data (or copy it if the packet is
3703  *                  not reference-counted).
3704  *                  Unlike with older APIs, the packet is always fully consumed,
3705  *                  and if it contains multiple frames (e.g. some audio codecs),
3706  *                  will require you to call avcodec_receive_frame() multiple
3707  *                  times afterwards before you can send a new packet.
3708  *                  It can be NULL (or an AVPacket with data set to NULL and
3709  *                  size set to 0); in this case, it is considered a flush
3710  *                  packet, which signals the end of the stream. Sending the
3711  *                  first flush packet will return success. Subsequent ones are
3712  *                  unnecessary and will return AVERROR_EOF. If the decoder
3713  *                  still has frames buffered, it will return them after sending
3714  *                  a flush packet.
3715  *
3716  * @return 0 on success, otherwise negative error code:
3717  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
3718  *                         must read output with avcodec_receive_frame() (once
3719  *                         all output is read, the packet should be resent, and
3720  *                         the call will not fail with EAGAIN).
3721  *      AVERROR_EOF:       the decoder has been flushed, and no new packets can
3722  *                         be sent to it (also returned if more than 1 flush
3723  *                         packet is sent)
3724  *      AVERROR(EINVAL):   codec not opened, it is an encoder, or requires flush
3725  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
3726  *      other errors: legitimate decoding errors
3727  */
3728 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3729
3730 /**
3731  * Return decoded output data from a decoder.
3732  *
3733  * @param avctx codec context
3734  * @param frame This will be set to a reference-counted video or audio
3735  *              frame (depending on the decoder type) allocated by the
3736  *              decoder. Note that the function will always call
3737  *              av_frame_unref(frame) before doing anything else.
3738  *
3739  * @return
3740  *      0:                 success, a frame was returned
3741  *      AVERROR(EAGAIN):   output is not available in this state - user must try
3742  *                         to send new input
3743  *      AVERROR_EOF:       the decoder has been fully flushed, and there will be
3744  *                         no more output frames
3745  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
3746  *      AVERROR_INPUT_CHANGED:   current decoded frame has changed parameters
3747  *                               with respect to first decoded frame. Applicable
3748  *                               when flag AV_CODEC_FLAG_DROPCHANGED is set.
3749  *      other negative values: legitimate decoding errors
3750  */
3751 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3752
3753 /**
3754  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3755  * to retrieve buffered output packets.
3756  *
3757  * @param avctx     codec context
3758  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3759  *                  Ownership of the frame remains with the caller, and the
3760  *                  encoder will not write to the frame. The encoder may create
3761  *                  a reference to the frame data (or copy it if the frame is
3762  *                  not reference-counted).
3763  *                  It can be NULL, in which case it is considered a flush
3764  *                  packet.  This signals the end of the stream. If the encoder
3765  *                  still has packets buffered, it will return them after this
3766  *                  call. Once flushing mode has been entered, additional flush
3767  *                  packets are ignored, and sending frames will return
3768  *                  AVERROR_EOF.
3769  *
3770  *                  For audio:
3771  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3772  *                  can have any number of samples.
3773  *                  If it is not set, frame->nb_samples must be equal to
3774  *                  avctx->frame_size for all frames except the last.
3775  *                  The final frame may be smaller than avctx->frame_size.
3776  * @return 0 on success, otherwise negative error code:
3777  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
3778  *                         must read output with avcodec_receive_packet() (once
3779  *                         all output is read, the packet should be resent, and
3780  *                         the call will not fail with EAGAIN).
3781  *      AVERROR_EOF:       the encoder has been flushed, and no new frames can
3782  *                         be sent to it
3783  *      AVERROR(EINVAL):   codec not opened, refcounted_frames not set, it is a
3784  *                         decoder, or requires flush
3785  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
3786  *      other errors: legitimate encoding errors
3787  */
3788 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3789
3790 /**
3791  * Read encoded data from the encoder.
3792  *
3793  * @param avctx codec context
3794  * @param avpkt This will be set to a reference-counted packet allocated by the
3795  *              encoder. Note that the function will always call
3796  *              av_packet_unref(avpkt) before doing anything else.
3797  * @return 0 on success, otherwise negative error code:
3798  *      AVERROR(EAGAIN):   output is not available in the current state - user
3799  *                         must try to send input
3800  *      AVERROR_EOF:       the encoder has been fully flushed, and there will be
3801  *                         no more output packets
3802  *      AVERROR(EINVAL):   codec not opened, or it is a decoder
3803  *      other errors: legitimate encoding errors
3804  */
3805 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3806
3807 /**
3808  * Create and return a AVHWFramesContext with values adequate for hardware
3809  * decoding. This is meant to get called from the get_format callback, and is
3810  * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3811  * This API is for decoding with certain hardware acceleration modes/APIs only.
3812  *
3813  * The returned AVHWFramesContext is not initialized. The caller must do this
3814  * with av_hwframe_ctx_init().
3815  *
3816  * Calling this function is not a requirement, but makes it simpler to avoid
3817  * codec or hardware API specific details when manually allocating frames.
3818  *
3819  * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3820  * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3821  * it unnecessary to call this function or having to care about
3822  * AVHWFramesContext initialization at all.
3823  *
3824  * There are a number of requirements for calling this function:
3825  *
3826  * - It must be called from get_format with the same avctx parameter that was
3827  *   passed to get_format. Calling it outside of get_format is not allowed, and
3828  *   can trigger undefined behavior.
3829  * - The function is not always supported (see description of return values).
3830  *   Even if this function returns successfully, hwaccel initialization could
3831  *   fail later. (The degree to which implementations check whether the stream
3832  *   is actually supported varies. Some do this check only after the user's
3833  *   get_format callback returns.)
3834  * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3835  *   user decides to use a AVHWFramesContext prepared with this API function,
3836  *   the user must return the same hw_pix_fmt from get_format.
3837  * - The device_ref passed to this function must support the given hw_pix_fmt.
3838  * - After calling this API function, it is the user's responsibility to
3839  *   initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3840  *   and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3841  *   before returning from get_format (this is implied by the normal
3842  *   AVCodecContext.hw_frames_ctx API rules).
3843  * - The AVHWFramesContext parameters may change every time time get_format is
3844  *   called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3845  *   you are inherently required to go through this process again on every
3846  *   get_format call.
3847  * - It is perfectly possible to call this function without actually using
3848  *   the resulting AVHWFramesContext. One use-case might be trying to reuse a
3849  *   previously initialized AVHWFramesContext, and calling this API function
3850  *   only to test whether the required frame parameters have changed.
3851  * - Fields that use dynamically allocated values of any kind must not be set
3852  *   by the user unless setting them is explicitly allowed by the documentation.
3853  *   If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3854  *   the new free callback must call the potentially set previous free callback.
3855  *   This API call may set any dynamically allocated fields, including the free
3856  *   callback.
3857  *
3858  * The function will set at least the following fields on AVHWFramesContext
3859  * (potentially more, depending on hwaccel API):
3860  *
3861  * - All fields set by av_hwframe_ctx_alloc().
3862  * - Set the format field to hw_pix_fmt.
3863  * - Set the sw_format field to the most suited and most versatile format. (An
3864  *   implication is that this will prefer generic formats over opaque formats
3865  *   with arbitrary restrictions, if possible.)
3866  * - Set the width/height fields to the coded frame size, rounded up to the
3867  *   API-specific minimum alignment.
3868  * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3869  *   field to the number of maximum reference surfaces possible with the codec,
3870  *   plus 1 surface for the user to work (meaning the user can safely reference
3871  *   at most 1 decoded surface at a time), plus additional buffering introduced
3872  *   by frame threading. If the hwaccel does not require pre-allocation, the
3873  *   field is left to 0, and the decoder will allocate new surfaces on demand
3874  *   during decoding.
3875  * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3876  *   hardware API.
3877  *
3878  * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3879  * with basic frame parameters set.
3880  *
3881  * The function is stateless, and does not change the AVCodecContext or the
3882  * device_ref AVHWDeviceContext.
3883  *
3884  * @param avctx The context which is currently calling get_format, and which
3885  *              implicitly contains all state needed for filling the returned
3886  *              AVHWFramesContext properly.
3887  * @param device_ref A reference to the AVHWDeviceContext describing the device
3888  *                   which will be used by the hardware decoder.
3889  * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3890  * @param out_frames_ref On success, set to a reference to an _uninitialized_
3891  *                       AVHWFramesContext, created from the given device_ref.
3892  *                       Fields will be set to values required for decoding.
3893  *                       Not changed if an error is returned.
3894  * @return zero on success, a negative value on error. The following error codes
3895  *         have special semantics:
3896  *      AVERROR(ENOENT): the decoder does not support this functionality. Setup
3897  *                       is always manual, or it is a decoder which does not
3898  *                       support setting AVCodecContext.hw_frames_ctx at all,
3899  *                       or it is a software format.
3900  *      AVERROR(EINVAL): it is known that hardware decoding is not supported for
3901  *                       this configuration, or the device_ref is not supported
3902  *                       for the hwaccel referenced by hw_pix_fmt.
3903  */
3904 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
3905                                      AVBufferRef *device_ref,
3906                                      enum AVPixelFormat hw_pix_fmt,
3907                                      AVBufferRef **out_frames_ref);
3908
3909
3910
3911 /**
3912  * @defgroup lavc_parsing Frame parsing
3913  * @{
3914  */
3915
3916 enum AVPictureStructure {
3917     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
3918     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
3919     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3920     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
3921 };
3922
3923 typedef struct AVCodecParserContext {
3924     void *priv_data;
3925     struct AVCodecParser *parser;
3926     int64_t frame_offset; /* offset of the current frame */
3927     int64_t cur_offset; /* current offset
3928                            (incremented by each av_parser_parse()) */
3929     int64_t next_frame_offset; /* offset of the next frame */
3930     /* video info */
3931     int pict_type; /* XXX: Put it back in AVCodecContext. */
3932     /**
3933      * This field is used for proper frame duration computation in lavf.
3934      * It signals, how much longer the frame duration of the current frame
3935      * is compared to normal frame duration.
3936      *
3937      * frame_duration = (1 + repeat_pict) * time_base
3938      *
3939      * It is used by codecs like H.264 to display telecined material.
3940      */
3941     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3942     int64_t pts;     /* pts of the current frame */
3943     int64_t dts;     /* dts of the current frame */
3944
3945     /* private data */
3946     int64_t last_pts;
3947     int64_t last_dts;
3948     int fetch_timestamp;
3949
3950 #define AV_PARSER_PTS_NB 4
3951     int cur_frame_start_index;
3952     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3953     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3954     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3955
3956     int flags;
3957 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3958 #define PARSER_FLAG_ONCE                      0x0002
3959 /// Set if the parser has a valid file offset
3960 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
3961 #define PARSER_FLAG_USE_CODEC_TS              0x1000
3962
3963     int64_t offset;      ///< byte offset from starting packet start
3964     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3965
3966     /**
3967      * Set by parser to 1 for key frames and 0 for non-key frames.
3968      * It is initialized to -1, so if the parser doesn't set this flag,
3969      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3970      * will be used.
3971      */
3972     int key_frame;
3973
3974 #if FF_API_CONVERGENCE_DURATION
3975     /**
3976      * @deprecated unused
3977      */
3978     attribute_deprecated
3979     int64_t convergence_duration;
3980 #endif
3981
3982     // Timestamp generation support:
3983     /**
3984      * Synchronization point for start of timestamp generation.
3985      *
3986      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3987      * (default).
3988      *
3989      * For example, this corresponds to presence of H.264 buffering period
3990      * SEI message.
3991      */
3992     int dts_sync_point;
3993
3994     /**
3995      * Offset of the current timestamp against last timestamp sync point in
3996      * units of AVCodecContext.time_base.
3997      *
3998      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3999      * contain a valid timestamp offset.
4000      *
4001      * Note that the timestamp of sync point has usually a nonzero
4002      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4003      * the next frame after timestamp sync point will be usually 1.
4004      *
4005      * For example, this corresponds to H.264 cpb_removal_delay.
4006      */
4007     int dts_ref_dts_delta;
4008
4009     /**
4010      * Presentation delay of current frame in units of AVCodecContext.time_base.
4011      *
4012      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4013      * contain valid non-negative timestamp delta (presentation time of a frame
4014      * must not lie in the past).
4015      *
4016      * This delay represents the difference between decoding and presentation
4017      * time of the frame.
4018      *
4019      * For example, this corresponds to H.264 dpb_output_delay.
4020      */
4021     int pts_dts_delta;
4022
4023     /**
4024      * Position of the packet in file.
4025      *
4026      * Analogous to cur_frame_pts/dts
4027      */
4028     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4029
4030     /**
4031      * Byte position of currently parsed frame in stream.
4032      */
4033     int64_t pos;
4034
4035     /**
4036      * Previous frame byte position.
4037      */
4038     int64_t last_pos;
4039
4040     /**
4041      * Duration of the current frame.
4042      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4043      * For all other types, this is in units of AVCodecContext.time_base.
4044      */
4045     int duration;
4046
4047     enum AVFieldOrder field_order;
4048
4049     /**
4050      * Indicate whether a picture is coded as a frame, top field or bottom field.
4051      *
4052      * For example, H.264 field_pic_flag equal to 0 corresponds to
4053      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4054      * equal to 1 and bottom_field_flag equal to 0 corresponds to
4055      * AV_PICTURE_STRUCTURE_TOP_FIELD.
4056      */
4057     enum AVPictureStructure picture_structure;
4058
4059     /**
4060      * Picture number incremented in presentation or output order.
4061      * This field may be reinitialized at the first picture of a new sequence.
4062      *
4063      * For example, this corresponds to H.264 PicOrderCnt.
4064      */
4065     int output_picture_number;
4066
4067     /**
4068      * Dimensions of the decoded video intended for presentation.
4069      */
4070     int width;
4071     int height;
4072
4073     /**
4074      * Dimensions of the coded video.
4075      */
4076     int coded_width;
4077     int coded_height;
4078
4079     /**
4080      * The format of the coded data, corresponds to enum AVPixelFormat for video
4081      * and for enum AVSampleFormat for audio.
4082      *
4083      * Note that a decoder can have considerable freedom in how exactly it
4084      * decodes the data, so the format reported here might be different from the
4085      * one returned by a decoder.
4086      */
4087     int format;
4088 } AVCodecParserContext;
4089
4090 typedef struct AVCodecParser {
4091     int codec_ids[5]; /* several codec IDs are permitted */
4092     int priv_data_size;
4093     int (*parser_init)(AVCodecParserContext *s);
4094     /* This callback never returns an error, a negative value means that
4095      * the frame start was in a previous packet. */
4096     int (*parser_parse)(AVCodecParserContext *s,
4097                         AVCodecContext *avctx,
4098                         const uint8_t **poutbuf, int *poutbuf_size,
4099                         const uint8_t *buf, int buf_size);
4100     void (*parser_close)(AVCodecParserContext *s);
4101     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4102     struct AVCodecParser *next;
4103 } AVCodecParser;
4104
4105 /**
4106  * Iterate over all registered codec parsers.
4107  *
4108  * @param opaque a pointer where libavcodec will store the iteration state. Must
4109  *               point to NULL to start the iteration.
4110  *
4111  * @return the next registered codec parser or NULL when the iteration is
4112  *         finished
4113  */
4114 const AVCodecParser *av_parser_iterate(void **opaque);
4115
4116 attribute_deprecated
4117 AVCodecParser *av_parser_next(const AVCodecParser *c);
4118
4119 attribute_deprecated
4120 void av_register_codec_parser(AVCodecParser *parser);
4121 AVCodecParserContext *av_parser_init(int codec_id);
4122
4123 /**
4124  * Parse a packet.
4125  *
4126  * @param s             parser context.
4127  * @param avctx         codec context.
4128  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4129  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4130  * @param buf           input buffer.
4131  * @param buf_size      buffer size in bytes without the padding. I.e. the full buffer
4132                         size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
4133                         To signal EOF, this should be 0 (so that the last frame
4134                         can be output).
4135  * @param pts           input presentation timestamp.
4136  * @param dts           input decoding timestamp.
4137  * @param pos           input byte position in stream.
4138  * @return the number of bytes of the input bitstream used.
4139  *
4140  * Example:
4141  * @code
4142  *   while(in_len){
4143  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4144  *                                        in_data, in_len,
4145  *                                        pts, dts, pos);
4146  *       in_data += len;
4147  *       in_len  -= len;
4148  *
4149  *       if(size)
4150  *          decode_frame(data, size);
4151  *   }
4152  * @endcode
4153  */
4154 int av_parser_parse2(AVCodecParserContext *s,
4155                      AVCodecContext *avctx,
4156                      uint8_t **poutbuf, int *poutbuf_size,
4157                      const uint8_t *buf, int buf_size,
4158                      int64_t pts, int64_t dts,
4159                      int64_t pos);
4160
4161 /**
4162  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4163  * @deprecated use AVBitStreamFilter
4164  */
4165 int av_parser_change(AVCodecParserContext *s,
4166                      AVCodecContext *avctx,
4167                      uint8_t **poutbuf, int *poutbuf_size,
4168                      const uint8_t *buf, int buf_size, int keyframe);
4169 void av_parser_close(AVCodecParserContext *s);
4170
4171 /**
4172  * @}
4173  * @}
4174  */
4175
4176 /**
4177  * @addtogroup lavc_encoding
4178  * @{
4179  */
4180
4181 /**
4182  * Find a registered encoder with a matching codec ID.
4183  *
4184  * @param id AVCodecID of the requested encoder
4185  * @return An encoder if one was found, NULL otherwise.
4186  */
4187 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4188
4189 /**
4190  * Find a registered encoder with the specified name.
4191  *
4192  * @param name name of the requested encoder
4193  * @return An encoder if one was found, NULL otherwise.
4194  */
4195 AVCodec *avcodec_find_encoder_by_name(const char *name);
4196
4197 /**
4198  * Encode a frame of audio.
4199  *
4200  * Takes input samples from frame and writes the next output packet, if
4201  * available, to avpkt. The output packet does not necessarily contain data for
4202  * the most recent frame, as encoders can delay, split, and combine input frames
4203  * internally as needed.
4204  *
4205  * @param avctx     codec context
4206  * @param avpkt     output AVPacket.
4207  *                  The user can supply an output buffer by setting
4208  *                  avpkt->data and avpkt->size prior to calling the
4209  *                  function, but if the size of the user-provided data is not
4210  *                  large enough, encoding will fail. If avpkt->data and
4211  *                  avpkt->size are set, avpkt->destruct must also be set. All
4212  *                  other AVPacket fields will be reset by the encoder using
4213  *                  av_init_packet(). If avpkt->data is NULL, the encoder will
4214  *                  allocate it. The encoder will set avpkt->size to the size
4215  *                  of the output packet.
4216  *
4217  *                  If this function fails or produces no output, avpkt will be
4218  *                  freed using av_packet_unref().
4219  * @param[in] frame AVFrame containing the raw audio data to be encoded.
4220  *                  May be NULL when flushing an encoder that has the
4221  *                  AV_CODEC_CAP_DELAY capability set.
4222  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4223  *                  can have any number of samples.
4224  *                  If it is not set, frame->nb_samples must be equal to
4225  *                  avctx->frame_size for all frames except the last.
4226  *                  The final frame may be smaller than avctx->frame_size.
4227  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4228  *                            output packet is non-empty, and to 0 if it is
4229  *                            empty. If the function returns an error, the
4230  *                            packet can be assumed to be invalid, and the
4231  *                            value of got_packet_ptr is undefined and should
4232  *                            not be used.
4233  * @return          0 on success, negative error code on failure
4234  *
4235  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4236  */
4237 attribute_deprecated
4238 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4239                           const AVFrame *frame, int *got_packet_ptr);
4240
4241 /**
4242  * Encode a frame of video.
4243  *
4244  * Takes input raw video data from frame and writes the next output packet, if
4245  * available, to avpkt. The output packet does not necessarily contain data for
4246  * the most recent frame, as encoders can delay and reorder input frames
4247  * internally as needed.
4248  *
4249  * @param avctx     codec context
4250  * @param avpkt     output AVPacket.
4251  *                  The user can supply an output buffer by setting
4252  *                  avpkt->data and avpkt->size prior to calling the
4253  *                  function, but if the size of the user-provided data is not
4254  *                  large enough, encoding will fail. All other AVPacket fields
4255  *                  will be reset by the encoder using av_init_packet(). If
4256  *                  avpkt->data is NULL, the encoder will allocate it.
4257  *                  The encoder will set avpkt->size to the size of the
4258  *                  output packet. The returned data (if any) belongs to the
4259  *                  caller, he is responsible for freeing it.
4260  *
4261  *                  If this function fails or produces no output, avpkt will be
4262  *                  freed using av_packet_unref().
4263  * @param[in] frame AVFrame containing the raw video data to be encoded.
4264  *                  May be NULL when flushing an encoder that has the
4265  *                  AV_CODEC_CAP_DELAY capability set.
4266  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4267  *                            output packet is non-empty, and to 0 if it is
4268  *                            empty. If the function returns an error, the
4269  *                            packet can be assumed to be invalid, and the
4270  *                            value of got_packet_ptr is undefined and should
4271  *                            not be used.
4272  * @return          0 on success, negative error code on failure
4273  *
4274  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4275  */
4276 attribute_deprecated
4277 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4278                           const AVFrame *frame, int *got_packet_ptr);
4279
4280 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4281                             const AVSubtitle *sub);
4282
4283
4284 /**
4285  * @}
4286  */
4287
4288 #if FF_API_AVPICTURE
4289 /**
4290  * @addtogroup lavc_picture
4291  * @{
4292  */
4293
4294 /**
4295  * @deprecated unused
4296  */
4297 attribute_deprecated
4298 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4299
4300 /**
4301  * @deprecated unused
4302  */
4303 attribute_deprecated
4304 void avpicture_free(AVPicture *picture);
4305
4306 /**
4307  * @deprecated use av_image_fill_arrays() instead.
4308  */
4309 attribute_deprecated
4310 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4311                    enum AVPixelFormat pix_fmt, int width, int height);
4312
4313 /**
4314  * @deprecated use av_image_copy_to_buffer() instead.
4315  */
4316 attribute_deprecated
4317 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4318                      int width, int height,
4319                      unsigned char *dest, int dest_size);
4320
4321 /**
4322  * @deprecated use av_image_get_buffer_size() instead.
4323  */
4324 attribute_deprecated
4325 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4326
4327 /**
4328  * @deprecated av_image_copy() instead.
4329  */
4330 attribute_deprecated
4331 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4332                      enum AVPixelFormat pix_fmt, int width, int height);
4333
4334 /**
4335  * @deprecated unused
4336  */
4337 attribute_deprecated
4338 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4339                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
4340
4341 /**
4342  * @deprecated unused
4343  */
4344 attribute_deprecated
4345 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4346             int padtop, int padbottom, int padleft, int padright, int *color);
4347
4348 /**
4349  * @}
4350  */
4351 #endif
4352
4353 /**
4354  * @defgroup lavc_misc Utility functions
4355  * @ingroup libavc
4356  *
4357  * Miscellaneous utility functions related to both encoding and decoding
4358  * (or neither).
4359  * @{
4360  */
4361
4362 /**
4363  * @defgroup lavc_misc_pixfmt Pixel formats
4364  *
4365  * Functions for working with pixel formats.
4366  * @{
4367  */
4368
4369 #if FF_API_GETCHROMA
4370 /**
4371  * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4372  */
4373
4374 attribute_deprecated
4375 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4376 #endif
4377
4378 /**
4379  * Return a value representing the fourCC code associated to the
4380  * pixel format pix_fmt, or 0 if no associated fourCC code can be
4381  * found.
4382  */
4383 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4384
4385 /**
4386  * @deprecated see av_get_pix_fmt_loss()
4387  */
4388 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4389                              int has_alpha);
4390
4391 /**
4392  * Find the best pixel format to convert to given a certain source pixel
4393  * format.  When converting from one pixel format to another, information loss
4394  * may occur.  For example, when converting from RGB24 to GRAY, the color
4395  * information will be lost. Similarly, other losses occur when converting from
4396  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4397  * the given pixel formats should be used to suffer the least amount of loss.
4398  * The pixel formats from which it chooses one, are determined by the
4399  * pix_fmt_list parameter.
4400  *
4401  *
4402  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4403  * @param[in] src_pix_fmt source pixel format
4404  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4405  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4406  * @return The best pixel format to convert to or -1 if none was found.
4407  */
4408 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4409                                             enum AVPixelFormat src_pix_fmt,
4410                                             int has_alpha, int *loss_ptr);
4411
4412 /**
4413  * @deprecated see av_find_best_pix_fmt_of_2()
4414  */
4415 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4416                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4417
4418 attribute_deprecated
4419 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4420                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4421
4422 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4423
4424 /**
4425  * @}
4426  */
4427
4428 #if FF_API_TAG_STRING
4429 /**
4430  * Put a string representing the codec tag codec_tag in buf.
4431  *
4432  * @param buf       buffer to place codec tag in
4433  * @param buf_size size in bytes of buf
4434  * @param codec_tag codec tag to assign
4435  * @return the length of the string that would have been generated if
4436  * enough space had been available, excluding the trailing null
4437  *
4438  * @deprecated see av_fourcc_make_string() and av_fourcc2str().
4439  */
4440 attribute_deprecated
4441 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4442 #endif
4443
4444 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4445
4446 /**
4447  * Return a name for the specified profile, if available.
4448  *
4449  * @param codec the codec that is searched for the given profile
4450  * @param profile the profile value for which a name is requested
4451  * @return A name for the profile if found, NULL otherwise.
4452  */
4453 const char *av_get_profile_name(const AVCodec *codec, int profile);
4454
4455 /**
4456  * Return a name for the specified profile, if available.
4457  *
4458  * @param codec_id the ID of the codec to which the requested profile belongs
4459  * @param profile the profile value for which a name is requested
4460  * @return A name for the profile if found, NULL otherwise.
4461  *
4462  * @note unlike av_get_profile_name(), which searches a list of profiles
4463  *       supported by a specific decoder or encoder implementation, this
4464  *       function searches the list of profiles from the AVCodecDescriptor
4465  */
4466 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4467
4468 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4469 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4470 //FIXME func typedef
4471
4472 /**
4473  * Fill AVFrame audio data and linesize pointers.
4474  *
4475  * The buffer buf must be a preallocated buffer with a size big enough
4476  * to contain the specified samples amount. The filled AVFrame data
4477  * pointers will point to this buffer.
4478  *
4479  * AVFrame extended_data channel pointers are allocated if necessary for
4480  * planar audio.
4481  *
4482  * @param frame       the AVFrame
4483  *                    frame->nb_samples must be set prior to calling the
4484  *                    function. This function fills in frame->data,
4485  *                    frame->extended_data, frame->linesize[0].
4486  * @param nb_channels channel count
4487  * @param sample_fmt  sample format
4488  * @param buf         buffer to use for frame data
4489  * @param buf_size    size of buffer
4490  * @param align       plane size sample alignment (0 = default)
4491  * @return            >=0 on success, negative error code on failure
4492  * @todo return the size in bytes required to store the samples in
4493  * case of success, at the next libavutil bump
4494  */
4495 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4496                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
4497                              int buf_size, int align);
4498
4499 /**
4500  * Reset the internal codec state / flush internal buffers. Should be called
4501  * e.g. when seeking or when switching to a different stream.
4502  *
4503  * @note for decoders, when refcounted frames are not used
4504  * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
4505  * returned from the decoder. When refcounted frames are used, the decoder just
4506  * releases any references it might keep internally, but the caller's reference
4507  * remains valid.
4508  *
4509  * @note for encoders, this function will only do something if the encoder
4510  * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
4511  * will drain any remaining packets, and can then be re-used for a different
4512  * stream (as opposed to sending a null frame which will leave the encoder
4513  * in a permanent EOF state after draining). This can be desirable if the
4514  * cost of tearing down and replacing the encoder instance is high.
4515  */
4516 void avcodec_flush_buffers(AVCodecContext *avctx);
4517
4518 /**
4519  * Return codec bits per sample.
4520  *
4521  * @param[in] codec_id the codec
4522  * @return Number of bits per sample or zero if unknown for the given codec.
4523  */
4524 int av_get_bits_per_sample(enum AVCodecID codec_id);
4525
4526 /**
4527  * Return the PCM codec associated with a sample format.
4528  * @param be  endianness, 0 for little, 1 for big,
4529  *            -1 (or anything else) for native
4530  * @return  AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4531  */
4532 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4533
4534 /**
4535  * Return codec bits per sample.
4536  * Only return non-zero if the bits per sample is exactly correct, not an
4537  * approximation.
4538  *
4539  * @param[in] codec_id the codec
4540  * @return Number of bits per sample or zero if unknown for the given codec.
4541  */
4542 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4543
4544 /**
4545  * Return audio frame duration.
4546  *
4547  * @param avctx        codec context
4548  * @param frame_bytes  size of the frame, or 0 if unknown
4549  * @return             frame duration, in samples, if known. 0 if not able to
4550  *                     determine.
4551  */
4552 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4553
4554 /**
4555  * This function is the same as av_get_audio_frame_duration(), except it works
4556  * with AVCodecParameters instead of an AVCodecContext.
4557  */
4558 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4559
4560 #if FF_API_OLD_BSF
4561 typedef struct AVBitStreamFilterContext {
4562     void *priv_data;
4563     const struct AVBitStreamFilter *filter;
4564     AVCodecParserContext *parser;
4565     struct AVBitStreamFilterContext *next;
4566     /**
4567      * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
4568      * Not for access by library users.
4569      */
4570     char *args;
4571 } AVBitStreamFilterContext;
4572 #endif
4573
4574 typedef struct AVBSFInternal AVBSFInternal;
4575
4576 /**
4577  * The bitstream filter state.
4578  *
4579  * This struct must be allocated with av_bsf_alloc() and freed with
4580  * av_bsf_free().
4581  *
4582  * The fields in the struct will only be changed (by the caller or by the
4583  * filter) as described in their documentation, and are to be considered
4584  * immutable otherwise.
4585  */
4586 typedef struct AVBSFContext {
4587     /**
4588      * A class for logging and AVOptions
4589      */
4590     const AVClass *av_class;
4591
4592     /**
4593      * The bitstream filter this context is an instance of.
4594      */
4595     const struct AVBitStreamFilter *filter;
4596
4597     /**
4598      * Opaque libavcodec internal data. Must not be touched by the caller in any
4599      * way.
4600      */
4601     AVBSFInternal *internal;
4602
4603     /**
4604      * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4605      * this is an AVOptions-enabled struct.
4606      */
4607     void *priv_data;
4608
4609     /**
4610      * Parameters of the input stream. This field is allocated in
4611      * av_bsf_alloc(), it needs to be filled by the caller before
4612      * av_bsf_init().
4613      */
4614     AVCodecParameters *par_in;
4615
4616     /**
4617      * Parameters of the output stream. This field is allocated in
4618      * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4619      */
4620     AVCodecParameters *par_out;
4621
4622     /**
4623      * The timebase used for the timestamps of the input packets. Set by the
4624      * caller before av_bsf_init().
4625      */
4626     AVRational time_base_in;
4627
4628     /**
4629      * The timebase used for the timestamps of the output packets. Set by the
4630      * filter in av_bsf_init().
4631      */
4632     AVRational time_base_out;
4633 } AVBSFContext;
4634
4635 typedef struct AVBitStreamFilter {
4636     const char *name;
4637
4638     /**
4639      * A list of codec ids supported by the filter, terminated by
4640      * AV_CODEC_ID_NONE.
4641      * May be NULL, in that case the bitstream filter works with any codec id.
4642      */
4643     const enum AVCodecID *codec_ids;
4644
4645     /**
4646      * A class for the private data, used to declare bitstream filter private
4647      * AVOptions. This field is NULL for bitstream filters that do not declare
4648      * any options.
4649      *
4650      * If this field is non-NULL, the first member of the filter private data
4651      * must be a pointer to AVClass, which will be set by libavcodec generic
4652      * code to this class.
4653      */
4654     const AVClass *priv_class;
4655
4656     /*****************************************************************
4657      * No fields below this line are part of the public API. They
4658      * may not be used outside of libavcodec and can be changed and
4659      * removed at will.
4660      * New public fields should be added right above.
4661      *****************************************************************
4662      */
4663
4664     int priv_data_size;
4665     int (*init)(AVBSFContext *ctx);
4666     int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4667     void (*close)(AVBSFContext *ctx);
4668     void (*flush)(AVBSFContext *ctx);
4669 } AVBitStreamFilter;
4670
4671 #if FF_API_OLD_BSF
4672 /**
4673  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4674  * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4675  */
4676 attribute_deprecated
4677 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4678 /**
4679  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4680  * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4681  * from the new bitstream filtering API (using AVBSFContext).
4682  */
4683 attribute_deprecated
4684 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4685 /**
4686  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4687  * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4688  * new bitstream filtering API (using AVBSFContext).
4689  */
4690 attribute_deprecated
4691 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4692                                AVCodecContext *avctx, const char *args,
4693                                uint8_t **poutbuf, int *poutbuf_size,
4694                                const uint8_t *buf, int buf_size, int keyframe);
4695 /**
4696  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4697  * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4698  * AVBSFContext).
4699  */
4700 attribute_deprecated
4701 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4702 /**
4703  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4704  * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4705  * AVBSFContext).
4706  */
4707 attribute_deprecated
4708 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4709 #endif
4710
4711 /**
4712  * @return a bitstream filter with the specified name or NULL if no such
4713  *         bitstream filter exists.
4714  */
4715 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4716
4717 /**
4718  * Iterate over all registered bitstream filters.
4719  *
4720  * @param opaque a pointer where libavcodec will store the iteration state. Must
4721  *               point to NULL to start the iteration.
4722  *
4723  * @return the next registered bitstream filter or NULL when the iteration is
4724  *         finished
4725  */
4726 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
4727 #if FF_API_NEXT
4728 attribute_deprecated
4729 const AVBitStreamFilter *av_bsf_next(void **opaque);
4730 #endif
4731
4732 /**
4733  * Allocate a context for a given bitstream filter. The caller must fill in the
4734  * context parameters as described in the documentation and then call
4735  * av_bsf_init() before sending any data to the filter.
4736  *
4737  * @param filter the filter for which to allocate an instance.
4738  * @param ctx a pointer into which the pointer to the newly-allocated context
4739  *            will be written. It must be freed with av_bsf_free() after the
4740  *            filtering is done.
4741  *
4742  * @return 0 on success, a negative AVERROR code on failure
4743  */
4744 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4745
4746 /**
4747  * Prepare the filter for use, after all the parameters and options have been
4748  * set.
4749  */
4750 int av_bsf_init(AVBSFContext *ctx);
4751
4752 /**
4753  * Submit a packet for filtering.
4754  *
4755  * After sending each packet, the filter must be completely drained by calling
4756  * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
4757  * AVERROR_EOF.
4758  *
4759  * @param pkt the packet to filter. The bitstream filter will take ownership of
4760  * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
4761  * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
4762  * it signals the end of the stream (i.e. no more non-empty packets will be sent;
4763  * sending more empty packets does nothing) and will cause the filter to output
4764  * any packets it may have buffered internally.
4765  *
4766  * @return 0 on success, a negative AVERROR on error. This function never fails if
4767  * pkt is empty.
4768  */
4769 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
4770
4771 /**
4772  * Retrieve a filtered packet.
4773  *
4774  * @param[out] pkt this struct will be filled with the contents of the filtered
4775  *                 packet. It is owned by the caller and must be freed using
4776  *                 av_packet_unref() when it is no longer needed.
4777  *                 This parameter should be "clean" (i.e. freshly allocated
4778  *                 with av_packet_alloc() or unreffed with av_packet_unref())
4779  *                 when this function is called. If this function returns
4780  *                 successfully, the contents of pkt will be completely
4781  *                 overwritten by the returned data. On failure, pkt is not
4782  *                 touched.
4783  *
4784  * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
4785  * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
4786  * will be no further output from the filter. Another negative AVERROR value if
4787  * an error occurs.
4788  *
4789  * @note one input packet may result in several output packets, so after sending
4790  * a packet with av_bsf_send_packet(), this function needs to be called
4791  * repeatedly until it stops returning 0. It is also possible for a filter to
4792  * output fewer packets than were sent to it, so this function may return
4793  * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
4794  */
4795 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
4796
4797 /**
4798  * Reset the internal bitstream filter state / flush internal buffers.
4799  */
4800 void av_bsf_flush(AVBSFContext *ctx);
4801
4802 /**
4803  * Free a bitstream filter context and everything associated with it; write NULL
4804  * into the supplied pointer.
4805  */
4806 void av_bsf_free(AVBSFContext **ctx);
4807
4808 /**
4809  * Get the AVClass for AVBSFContext. It can be used in combination with
4810  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4811  *
4812  * @see av_opt_find().
4813  */
4814 const AVClass *av_bsf_get_class(void);
4815
4816 /**
4817  * Structure for chain/list of bitstream filters.
4818  * Empty list can be allocated by av_bsf_list_alloc().
4819  */
4820 typedef struct AVBSFList AVBSFList;
4821
4822 /**
4823  * Allocate empty list of bitstream filters.
4824  * The list must be later freed by av_bsf_list_free()
4825  * or finalized by av_bsf_list_finalize().
4826  *
4827  * @return Pointer to @ref AVBSFList on success, NULL in case of failure
4828  */
4829 AVBSFList *av_bsf_list_alloc(void);
4830
4831 /**
4832  * Free list of bitstream filters.
4833  *
4834  * @param lst Pointer to pointer returned by av_bsf_list_alloc()
4835  */
4836 void av_bsf_list_free(AVBSFList **lst);
4837
4838 /**
4839  * Append bitstream filter to the list of bitstream filters.
4840  *
4841  * @param lst List to append to
4842  * @param bsf Filter context to be appended
4843  *
4844  * @return >=0 on success, negative AVERROR in case of failure
4845  */
4846 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
4847
4848 /**
4849  * Construct new bitstream filter context given it's name and options
4850  * and append it to the list of bitstream filters.
4851  *
4852  * @param lst      List to append to
4853  * @param bsf_name Name of the bitstream filter
4854  * @param options  Options for the bitstream filter, can be set to NULL
4855  *
4856  * @return >=0 on success, negative AVERROR in case of failure
4857  */
4858 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
4859 /**
4860  * Finalize list of bitstream filters.
4861  *
4862  * This function will transform @ref AVBSFList to single @ref AVBSFContext,
4863  * so the whole chain of bitstream filters can be treated as single filter
4864  * freshly allocated by av_bsf_alloc().
4865  * If the call is successful, @ref AVBSFList structure is freed and lst
4866  * will be set to NULL. In case of failure, caller is responsible for
4867  * freeing the structure by av_bsf_list_free()
4868  *
4869  * @param      lst Filter list structure to be transformed
4870  * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4871  *                 representing the chain of bitstream filters
4872  *
4873  * @return >=0 on success, negative AVERROR in case of failure
4874  */
4875 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
4876
4877 /**
4878  * Parse string describing list of bitstream filters and create single
4879  * @ref AVBSFContext describing the whole chain of bitstream filters.
4880  * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
4881  * allocated by av_bsf_alloc().
4882  *
4883  * @param      str String describing chain of bitstream filters in format
4884  *                 `bsf1[=opt1=val1:opt2=val2][,bsf2]`
4885  * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4886  *                 representing the chain of bitstream filters
4887  *
4888  * @return >=0 on success, negative AVERROR in case of failure
4889  */
4890 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
4891
4892 /**
4893  * Get null/pass-through bitstream filter.
4894  *
4895  * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
4896  *
4897  * @return
4898  */
4899 int av_bsf_get_null_filter(AVBSFContext **bsf);
4900
4901 /* memory */
4902
4903 /**
4904  * Same behaviour av_fast_malloc but the buffer has additional
4905  * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4906  *
4907  * In addition the whole buffer will initially and after resizes
4908  * be 0-initialized so that no uninitialized data will ever appear.
4909  */
4910 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4911
4912 /**
4913  * Same behaviour av_fast_padded_malloc except that buffer will always
4914  * be 0-initialized after call.
4915  */
4916 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4917
4918 /**
4919  * Encode extradata length to a buffer. Used by xiph codecs.
4920  *
4921  * @param s buffer to write to; must be at least (v/255+1) bytes long
4922  * @param v size of extradata in bytes
4923  * @return number of bytes written to the buffer.
4924  */
4925 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4926
4927 #if FF_API_USER_VISIBLE_AVHWACCEL
4928 /**
4929  * Register the hardware accelerator hwaccel.
4930  *
4931  * @deprecated  This function doesn't do anything.
4932  */
4933 attribute_deprecated
4934 void av_register_hwaccel(AVHWAccel *hwaccel);
4935
4936 /**
4937  * If hwaccel is NULL, returns the first registered hardware accelerator,
4938  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4939  * after hwaccel, or NULL if hwaccel is the last one.
4940  *
4941  * @deprecated  AVHWaccel structures contain no user-serviceable parts, so
4942  *              this function should not be used.
4943  */
4944 attribute_deprecated
4945 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4946 #endif
4947
4948 #if FF_API_LOCKMGR
4949 /**
4950  * Lock operation used by lockmgr
4951  *
4952  * @deprecated Deprecated together with av_lockmgr_register().
4953  */
4954 enum AVLockOp {
4955   AV_LOCK_CREATE,  ///< Create a mutex
4956   AV_LOCK_OBTAIN,  ///< Lock the mutex
4957   AV_LOCK_RELEASE, ///< Unlock the mutex
4958   AV_LOCK_DESTROY, ///< Free mutex resources
4959 };
4960
4961 /**
4962  * Register a user provided lock manager supporting the operations
4963  * specified by AVLockOp. The "mutex" argument to the function points
4964  * to a (void *) where the lockmgr should store/get a pointer to a user
4965  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4966  * value left by the last call for all other ops. If the lock manager is
4967  * unable to perform the op then it should leave the mutex in the same
4968  * state as when it was called and return a non-zero value. However,
4969  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4970  * have been successfully destroyed. If av_lockmgr_register succeeds
4971  * it will return a non-negative value, if it fails it will return a
4972  * negative value and destroy all mutex and unregister all callbacks.
4973  * av_lockmgr_register is not thread-safe, it must be called from a
4974  * single thread before any calls which make use of locking are used.
4975  *
4976  * @param cb User defined callback. av_lockmgr_register invokes calls
4977  *           to this callback and the previously registered callback.
4978  *           The callback will be used to create more than one mutex
4979  *           each of which must be backed by its own underlying locking
4980  *           mechanism (i.e. do not use a single static object to
4981  *           implement your lock manager). If cb is set to NULL the
4982  *           lockmgr will be unregistered.
4983  *
4984  * @deprecated This function does nothing, and always returns 0. Be sure to
4985  *             build with thread support to get basic thread safety.
4986  */
4987 attribute_deprecated
4988 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4989 #endif
4990
4991 /**
4992  * Get the type of the given codec.
4993  */
4994 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4995
4996 /**
4997  * Get the name of a codec.
4998  * @return  a static string identifying the codec; never NULL
4999  */
5000 const char *avcodec_get_name(enum AVCodecID id);
5001
5002 /**
5003  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5004  * with no corresponding avcodec_close()), 0 otherwise.
5005  */
5006 int avcodec_is_open(AVCodecContext *s);
5007
5008 /**
5009  * @return a non-zero number if codec is an encoder, zero otherwise
5010  */
5011 int av_codec_is_encoder(const AVCodec *codec);
5012
5013 /**
5014  * @return a non-zero number if codec is a decoder, zero otherwise
5015  */
5016 int av_codec_is_decoder(const AVCodec *codec);
5017
5018 /**
5019  * Allocate a CPB properties structure and initialize its fields to default
5020  * values.
5021  *
5022  * @param size if non-NULL, the size of the allocated struct will be written
5023  *             here. This is useful for embedding it in side data.
5024  *
5025  * @return the newly allocated struct or NULL on failure
5026  */
5027 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5028
5029 /**
5030  * @}
5031  */
5032
5033 #endif /* AVCODEC_AVCODEC_H */