FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
avcodec.h
Go to the documentation of this file.
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"
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 "version.h"
45 
46 /**
47  * @defgroup libavc libavcodec
48  * Encoding/Decoding Library
49  *
50  * @{
51  *
52  * @defgroup lavc_decoding Decoding
53  * @{
54  * @}
55  *
56  * @defgroup lavc_encoding Encoding
57  * @{
58  * @}
59  *
60  * @defgroup lavc_codec Codecs
61  * @{
62  * @defgroup lavc_codec_native Native Codecs
63  * @{
64  * @}
65  * @defgroup lavc_codec_wrappers External library wrappers
66  * @{
67  * @}
68  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69  * @{
70  * @}
71  * @}
72  * @defgroup lavc_internal Internal
73  * @{
74  * @}
75  * @}
76  */
77 
78 /**
79  * @ingroup libavc
80  * @defgroup lavc_encdec send/receive encoding and decoding API overview
81  * @{
82  *
83  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84  * avcodec_receive_packet() functions provide an encode/decode API, which
85  * decouples input and output.
86  *
87  * The API is very similar for encoding/decoding and audio/video, and works as
88  * follows:
89  * - Set up and open the AVCodecContext as usual.
90  * - Send valid input:
91  * - For decoding, call avcodec_send_packet() to give the decoder raw
92  * compressed data in an AVPacket.
93  * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94  * containing uncompressed audio or video.
95  * In both cases, it is recommended that AVPackets and AVFrames are
96  * refcounted, or libavcodec might have to copy the input data. (libavformat
97  * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
98  * refcounted AVFrames.)
99  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
100  * functions and process their output:
101  * - For decoding, call avcodec_receive_frame(). On success, it will return
102  * an AVFrame containing uncompressed audio or video data.
103  * - For encoding, call avcodec_receive_packet(). On success, it will return
104  * an AVPacket with a compressed frame.
105  * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
106  * AVERROR(EAGAIN) return value means that new input data is required to
107  * return new output. In this case, continue with sending input. For each
108  * input frame/packet, the codec will typically return 1 output frame/packet,
109  * but it can also be 0 or more than 1.
110  *
111  * At the beginning of decoding or encoding, the codec might accept multiple
112  * input frames/packets without returning a frame, until its internal buffers
113  * are filled. This situation is handled transparently if you follow the steps
114  * outlined above.
115  *
116  * In theory, sending input can result in EAGAIN - this should happen only if
117  * not all output was received. You can use this to structure alternative decode
118  * or encode loops other than the one suggested above. For example, you could
119  * try sending new input on each iteration, and try to receive output if that
120  * returns EAGAIN.
121  *
122  * End of stream situations. These require "flushing" (aka draining) the codec,
123  * as the codec might buffer multiple frames or packets internally for
124  * performance or out of necessity (consider B-frames).
125  * This is handled as follows:
126  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
127  * or avcodec_send_frame() (encoding) functions. This will enter draining
128  * mode.
129  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
130  * (encoding) in a loop until AVERROR_EOF is returned. The functions will
131  * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
132  * - Before decoding can be resumed again, the codec has to be reset with
133  * avcodec_flush_buffers().
134  *
135  * Using the API as outlined above is highly recommended. But it is also
136  * possible to call functions outside of this rigid schema. For example, you can
137  * call avcodec_send_packet() repeatedly without calling
138  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
139  * until the codec's internal buffer has been filled up (which is typically of
140  * size 1 per output frame, after initial input), and then reject input with
141  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
142  * read at least some output.
143  *
144  * Not all codecs will follow a rigid and predictable dataflow; the only
145  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
146  * one end implies that a receive/send call on the other end will succeed, or
147  * at least will not fail with AVERROR(EAGAIN). In general, no codec will
148  * permit unlimited buffering of input or output.
149  *
150  * This API replaces the following legacy functions:
151  * - avcodec_decode_video2() and avcodec_decode_audio4():
152  * Use avcodec_send_packet() to feed input to the decoder, then use
153  * avcodec_receive_frame() to receive decoded frames after each packet.
154  * Unlike with the old video decoding API, multiple frames might result from
155  * a packet. For audio, splitting the input packet into frames by partially
156  * decoding packets becomes transparent to the API user. You never need to
157  * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
158  * no data was read from the packet).
159  * Additionally, sending a flush/draining packet is required only once.
160  * - avcodec_encode_video2()/avcodec_encode_audio2():
161  * Use avcodec_send_frame() to feed input to the encoder, then use
162  * avcodec_receive_packet() to receive encoded packets.
163  * Providing user-allocated buffers for avcodec_receive_packet() is not
164  * possible.
165  * - The new API does not handle subtitles yet.
166  *
167  * Mixing new and old function calls on the same AVCodecContext is not allowed,
168  * and will result in undefined behavior.
169  *
170  * Some codecs might require using the new API; using the old API will return
171  * an error when calling it. All codecs support the new API.
172  *
173  * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
174  * would be an invalid state, which could put the codec user into an endless
175  * loop. The API has no concept of time either: it cannot happen that trying to
176  * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
177  * later accepts the packet (with no other receive/flush API calls involved).
178  * The API is a strict state machine, and the passage of time is not supposed
179  * to influence it. Some timing-dependent behavior might still be deemed
180  * acceptable in certain cases. But it must never result in both send/receive
181  * returning EAGAIN at the same time at any point. It must also absolutely be
182  * avoided that the current state is "unstable" and can "flip-flop" between
183  * the send/receive APIs allowing progress. For example, it's not allowed that
184  * the codec randomly decides that it actually wants to consume a packet now
185  * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
186  * avcodec_send_packet() call.
187  * @}
188  */
189 
190 /**
191  * @defgroup lavc_core Core functions/structures.
192  * @ingroup libavc
193  *
194  * Basic definitions, functions for querying libavcodec capabilities,
195  * allocating core structures, etc.
196  * @{
197  */
198 
199 
200 /**
201  * Identify the syntax and semantics of the bitstream.
202  * The principle is roughly:
203  * Two decoders with the same ID can decode the same streams.
204  * Two encoders with the same ID can encode compatible streams.
205  * There may be slight deviations from the principle due to implementation
206  * details.
207  *
208  * If you add a codec ID to this list, add it so that
209  * 1. no value of an existing codec ID changes (that would break ABI),
210  * 2. it is as close as possible to similar codecs
211  *
212  * After adding new codec IDs, do not forget to add an entry to the codec
213  * descriptor list and bump libavcodec minor version.
214  */
215 enum AVCodecID {
217 
218  /* video codecs */
220  AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
355 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
393 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
412 
449 
450  /* various PCM "codecs" */
451  AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
483 
488 
489  /* various ADPCM codecs */
521 
532 
533  /* AMR */
536 
537  /* RealAudio codecs*/
540 
541  /* various DPCM codecs */
546 
549 
550  /* audio codecs */
551  AV_CODEC_ID_MP2 = 0x15000,
552  AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
569  AV_CODEC_ID_GSM, ///< as in Berlin toast format
581  AV_CODEC_ID_GSM_MS, /* as found in WAV */
618 
638 
639  /* subtitle codecs */
640  AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
643  AV_CODEC_ID_TEXT, ///< raw UTF-8 text
650 
666 
667  /* other specific kind of codecs (generally used for attachments) */
668  AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
669  AV_CODEC_ID_TTF = 0x18000,
670 
671  AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
680 
681 
682  AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
683 
684  AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
685  * stream (only used by libavformat) */
686  AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
687  * stream (only used by libavformat) */
688  AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
689  AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
690 };
691 
692 /**
693  * This struct describes the properties of a single codec described by an
694  * AVCodecID.
695  * @see avcodec_descriptor_get()
696  */
697 typedef struct AVCodecDescriptor {
698  enum AVCodecID id;
700  /**
701  * Name of the codec described by this descriptor. It is non-empty and
702  * unique for each codec descriptor. It should contain alphanumeric
703  * characters and '_' only.
704  */
705  const char *name;
706  /**
707  * A more descriptive name for this codec. May be NULL.
708  */
709  const char *long_name;
710  /**
711  * Codec properties, a combination of AV_CODEC_PROP_* flags.
712  */
713  int props;
714  /**
715  * MIME type(s) associated with the codec.
716  * May be NULL; if not, a NULL-terminated array of MIME types.
717  * The first item is always non-NULL and is the preferred MIME type.
718  */
719  const char *const *mime_types;
720  /**
721  * If non-NULL, an array of profiles recognized for this codec.
722  * Terminated with FF_PROFILE_UNKNOWN.
723  */
724  const struct AVProfile *profiles;
726 
727 /**
728  * Codec uses only intra compression.
729  * Video and audio codecs only.
730  */
731 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
732 /**
733  * Codec supports lossy compression. Audio and video codecs only.
734  * @note a codec may support both lossy and lossless
735  * compression modes
736  */
737 #define AV_CODEC_PROP_LOSSY (1 << 1)
738 /**
739  * Codec supports lossless compression. Audio and video codecs only.
740  */
741 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
742 /**
743  * Codec supports frame reordering. That is, the coded order (the order in which
744  * the encoded packets are output by the encoders / stored / input to the
745  * decoders) may be different from the presentation order of the corresponding
746  * frames.
747  *
748  * For codecs that do not have this property set, PTS and DTS should always be
749  * equal.
750  */
751 #define AV_CODEC_PROP_REORDER (1 << 3)
752 /**
753  * Subtitle codec is bitmap based
754  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
755  */
756 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
757 /**
758  * Subtitle codec is text based.
759  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
760  */
761 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
762 
763 /**
764  * @ingroup lavc_decoding
765  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
766  * This is mainly needed because some optimized bitstream readers read
767  * 32 or 64 bit at once and could read over the end.<br>
768  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
769  * MPEG bitstreams could cause overread and segfault.
770  */
771 #define AV_INPUT_BUFFER_PADDING_SIZE 64
772 
773 /**
774  * @ingroup lavc_encoding
775  * minimum encoding buffer size
776  * Used to avoid some checks during header writing.
777  */
778 #define AV_INPUT_BUFFER_MIN_SIZE 16384
779 
780 /**
781  * @ingroup lavc_decoding
782  */
784  /* We leave some space between them for extensions (drop some
785  * keyframes for intra-only or drop just some bidir frames). */
786  AVDISCARD_NONE =-16, ///< discard nothing
787  AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
788  AVDISCARD_NONREF = 8, ///< discard all non reference
789  AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
790  AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
791  AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
792  AVDISCARD_ALL = 48, ///< discard all
793 };
794 
805  AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
806 };
807 
808 /**
809  * @ingroup lavc_encoding
810  */
811 typedef struct RcOverride{
814  int qscale; // If this is 0 then quality_factor will be used instead.
816 } RcOverride;
817 
818 /* encoding support
819  These flags can be passed in AVCodecContext.flags before initialization.
820  Note: Not everything is supported yet.
821 */
822 
823 /**
824  * Allow decoders to produce frames with data planes that are not aligned
825  * to CPU requirements (e.g. due to cropping).
826  */
827 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
828 /**
829  * Use fixed qscale.
830  */
831 #define AV_CODEC_FLAG_QSCALE (1 << 1)
832 /**
833  * 4 MV per MB allowed / advanced prediction for H.263.
834  */
835 #define AV_CODEC_FLAG_4MV (1 << 2)
836 /**
837  * Output even those frames that might be corrupted.
838  */
839 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
840 /**
841  * Use qpel MC.
842  */
843 #define AV_CODEC_FLAG_QPEL (1 << 4)
844 /**
845  * Use internal 2pass ratecontrol in first pass mode.
846  */
847 #define AV_CODEC_FLAG_PASS1 (1 << 9)
848 /**
849  * Use internal 2pass ratecontrol in second pass mode.
850  */
851 #define AV_CODEC_FLAG_PASS2 (1 << 10)
852 /**
853  * loop filter.
854  */
855 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
856 /**
857  * Only decode/encode grayscale.
858  */
859 #define AV_CODEC_FLAG_GRAY (1 << 13)
860 /**
861  * error[?] variables will be set during encoding.
862  */
863 #define AV_CODEC_FLAG_PSNR (1 << 15)
864 /**
865  * Input bitstream might be truncated at a random location
866  * instead of only at frame boundaries.
867  */
868 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
869 /**
870  * Use interlaced DCT.
871  */
872 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
873 /**
874  * Force low delay.
875  */
876 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
877 /**
878  * Place global headers in extradata instead of every keyframe.
879  */
880 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
881 /**
882  * Use only bitexact stuff (except (I)DCT).
883  */
884 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
885 /* Fx : Flag for H.263+ extra options */
886 /**
887  * H.263 advanced intra coding / MPEG-4 AC prediction
888  */
889 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
890 /**
891  * interlaced motion estimation
892  */
893 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
894 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
895 
896 /**
897  * Allow non spec compliant speedup tricks.
898  */
899 #define AV_CODEC_FLAG2_FAST (1 << 0)
900 /**
901  * Skip bitstream encoding.
902  */
903 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
904 /**
905  * Place global headers at every keyframe instead of in extradata.
906  */
907 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
908 
909 /**
910  * timecode is in drop frame format. DEPRECATED!!!!
911  */
912 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
913 
914 /**
915  * Input bitstream might be truncated at a packet boundaries
916  * instead of only at frame boundaries.
917  */
918 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
919 /**
920  * Discard cropping information from SPS.
921  */
922 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
923 
924 /**
925  * Show all frames before the first keyframe
926  */
927 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
928 /**
929  * Export motion vectors through frame side data
930  */
931 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
932 /**
933  * Do not skip samples and export skip information as frame side data
934  */
935 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
936 /**
937  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
938  */
939 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
940 
941 /* Unsupported options :
942  * Syntax Arithmetic coding (SAC)
943  * Reference Picture Selection
944  * Independent Segment Decoding */
945 /* /Fx */
946 /* codec capabilities */
947 
948 /**
949  * Decoder can use draw_horiz_band callback.
950  */
951 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
952 /**
953  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
954  * If not set, it might not use get_buffer() at all or use operations that
955  * assume the buffer was allocated by avcodec_default_get_buffer.
956  */
957 #define AV_CODEC_CAP_DR1 (1 << 1)
958 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
959 /**
960  * Encoder or decoder requires flushing with NULL input at the end in order to
961  * give the complete and correct output.
962  *
963  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
964  * with NULL data. The user can still send NULL data to the public encode
965  * or decode function, but libavcodec will not pass it along to the codec
966  * unless this flag is set.
967  *
968  * Decoders:
969  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
970  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
971  * returns frames.
972  *
973  * Encoders:
974  * The encoder needs to be fed with NULL data at the end of encoding until the
975  * encoder no longer returns data.
976  *
977  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
978  * flag also means that the encoder must set the pts and duration for
979  * each output packet. If this flag is not set, the pts and duration will
980  * be determined by libavcodec from the input frame.
981  */
982 #define AV_CODEC_CAP_DELAY (1 << 5)
983 /**
984  * Codec can be fed a final frame with a smaller size.
985  * This can be used to prevent truncation of the last audio samples.
986  */
987 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
988 
989 /**
990  * Codec can output multiple frames per AVPacket
991  * Normally demuxers return one frame at a time, demuxers which do not do
992  * are connected to a parser to split what they return into proper frames.
993  * This flag is reserved to the very rare category of codecs which have a
994  * bitstream that cannot be split into frames without timeconsuming
995  * operations like full decoding. Demuxers carrying such bitstreams thus
996  * may return multiple frames in a packet. This has many disadvantages like
997  * prohibiting stream copy in many cases thus it should only be considered
998  * as a last resort.
999  */
1000 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1001 /**
1002  * Codec is experimental and is thus avoided in favor of non experimental
1003  * encoders
1004  */
1005 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1006 /**
1007  * Codec should fill in channel configuration and samplerate instead of container
1008  */
1009 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1010 /**
1011  * Codec supports frame-level multithreading.
1012  */
1013 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1014 /**
1015  * Codec supports slice-based (or partition-based) multithreading.
1016  */
1017 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1018 /**
1019  * Codec supports changed parameters at any point.
1020  */
1021 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1022 /**
1023  * Codec supports avctx->thread_count == 0 (auto).
1024  */
1025 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1026 /**
1027  * Audio encoder supports receiving a different number of samples in each call.
1028  */
1029 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1030 /**
1031  * Decoder is not a preferred choice for probing.
1032  * This indicates that the decoder is not a good choice for probing.
1033  * It could for example be an expensive to spin up hardware decoder,
1034  * or it could simply not provide a lot of useful information about
1035  * the stream.
1036  * A decoder marked with this flag should only be used as last resort
1037  * choice for probing.
1038  */
1039 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1040 /**
1041  * Codec is intra only.
1042  */
1043 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1044 /**
1045  * Codec is lossless.
1046  */
1047 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1048 
1049 /**
1050  * Codec is backed by a hardware implementation. Typically used to
1051  * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1052  * avcodec_get_hw_config() instead.
1053  */
1054 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1055 
1056 /**
1057  * Codec is potentially backed by a hardware implementation, but not
1058  * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1059  * implementation provides some sort of internal fallback.
1060  */
1061 #define AV_CODEC_CAP_HYBRID (1 << 19)
1062 
1063 /**
1064  * Pan Scan area.
1065  * This specifies the area which should be displayed.
1066  * Note there may be multiple such areas for one frame.
1067  */
1068 typedef struct AVPanScan {
1069  /**
1070  * id
1071  * - encoding: Set by user.
1072  * - decoding: Set by libavcodec.
1073  */
1074  int id;
1075 
1076  /**
1077  * width and height in 1/16 pel
1078  * - encoding: Set by user.
1079  * - decoding: Set by libavcodec.
1080  */
1081  int width;
1082  int height;
1083 
1084  /**
1085  * position of the top left corner in 1/16 pel for up to 3 fields/frames
1086  * - encoding: Set by user.
1087  * - decoding: Set by libavcodec.
1088  */
1089  int16_t position[3][2];
1090 } AVPanScan;
1091 
1092 /**
1093  * This structure describes the bitrate properties of an encoded bitstream. It
1094  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1095  * parameters for H.264/HEVC.
1096  */
1097 typedef struct AVCPBProperties {
1098  /**
1099  * Maximum bitrate of the stream, in bits per second.
1100  * Zero if unknown or unspecified.
1101  */
1103  /**
1104  * Minimum bitrate of the stream, in bits per second.
1105  * Zero if unknown or unspecified.
1106  */
1108  /**
1109  * Average bitrate of the stream, in bits per second.
1110  * Zero if unknown or unspecified.
1111  */
1113 
1114  /**
1115  * The size of the buffer to which the ratecontrol is applied, in bits.
1116  * Zero if unknown or unspecified.
1117  */
1119 
1120  /**
1121  * The delay between the time the packet this structure is associated with
1122  * is received and the time when it should be decoded, in periods of a 27MHz
1123  * clock.
1124  *
1125  * UINT64_MAX when unknown or unspecified.
1126  */
1127  uint64_t vbv_delay;
1128 } AVCPBProperties;
1129 
1130 /**
1131  * The decoder will keep a reference to the frame and may reuse it later.
1132  */
1133 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1134 
1135 /**
1136  * @defgroup lavc_packet AVPacket
1137  *
1138  * Types and functions for working with AVPacket.
1139  * @{
1140  */
1142  /**
1143  * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1144  * bytes worth of palette. This side data signals that a new palette is
1145  * present.
1146  */
1148 
1149  /**
1150  * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1151  * that the extradata buffer was changed and the receiving side should
1152  * act upon it appropriately. The new extradata is embedded in the side
1153  * data buffer and should be immediately used for processing the current
1154  * frame or packet.
1155  */
1157 
1158  /**
1159  * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1160  * @code
1161  * u32le param_flags
1162  * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1163  * s32le channel_count
1164  * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1165  * u64le channel_layout
1166  * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1167  * s32le sample_rate
1168  * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1169  * s32le width
1170  * s32le height
1171  * @endcode
1172  */
1174 
1175  /**
1176  * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1177  * structures with info about macroblocks relevant to splitting the
1178  * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1179  * That is, it does not necessarily contain info about all macroblocks,
1180  * as long as the distance between macroblocks in the info is smaller
1181  * than the target payload size.
1182  * Each MB info structure is 12 bytes, and is laid out as follows:
1183  * @code
1184  * u32le bit offset from the start of the packet
1185  * u8 current quantizer at the start of the macroblock
1186  * u8 GOB number
1187  * u16le macroblock address within the GOB
1188  * u8 horizontal MV predictor
1189  * u8 vertical MV predictor
1190  * u8 horizontal MV predictor for block number 3
1191  * u8 vertical MV predictor for block number 3
1192  * @endcode
1193  */
1195 
1196  /**
1197  * This side data should be associated with an audio stream and contains
1198  * ReplayGain information in form of the AVReplayGain struct.
1199  */
1201 
1202  /**
1203  * This side data contains a 3x3 transformation matrix describing an affine
1204  * transformation that needs to be applied to the decoded video frames for
1205  * correct presentation.
1206  *
1207  * See libavutil/display.h for a detailed description of the data.
1208  */
1210 
1211  /**
1212  * This side data should be associated with a video stream and contains
1213  * Stereoscopic 3D information in form of the AVStereo3D struct.
1214  */
1216 
1217  /**
1218  * This side data should be associated with an audio stream and corresponds
1219  * to enum AVAudioServiceType.
1220  */
1222 
1223  /**
1224  * This side data contains quality related information from the encoder.
1225  * @code
1226  * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1227  * u8 picture type
1228  * u8 error count
1229  * u16 reserved
1230  * u64le[error count] sum of squared differences between encoder in and output
1231  * @endcode
1232  */
1234 
1235  /**
1236  * This side data contains an integer value representing the stream index
1237  * of a "fallback" track. A fallback track indicates an alternate
1238  * track to use when the current track can not be decoded for some reason.
1239  * e.g. no decoder available for codec.
1240  */
1242 
1243  /**
1244  * This side data corresponds to the AVCPBProperties struct.
1245  */
1247 
1248  /**
1249  * Recommmends skipping the specified number of samples
1250  * @code
1251  * u32le number of samples to skip from start of this packet
1252  * u32le number of samples to skip from end of this packet
1253  * u8 reason for start skip
1254  * u8 reason for end skip (0=padding silence, 1=convergence)
1255  * @endcode
1256  */
1258 
1259  /**
1260  * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1261  * the packet may contain "dual mono" audio specific to Japanese DTV
1262  * and if it is true, recommends only the selected channel to be used.
1263  * @code
1264  * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1265  * @endcode
1266  */
1268 
1269  /**
1270  * A list of zero terminated key/value strings. There is no end marker for
1271  * the list, so it is required to rely on the side data size to stop.
1272  */
1274 
1275  /**
1276  * Subtitle event position
1277  * @code
1278  * u32le x1
1279  * u32le y1
1280  * u32le x2
1281  * u32le y2
1282  * @endcode
1283  */
1285 
1286  /**
1287  * Data found in BlockAdditional element of matroska container. There is
1288  * no end marker for the data, so it is required to rely on the side data
1289  * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1290  * by data.
1291  */
1293 
1294  /**
1295  * The optional first identifier line of a WebVTT cue.
1296  */
1298 
1299  /**
1300  * The optional settings (rendering instructions) that immediately
1301  * follow the timestamp specifier of a WebVTT cue.
1302  */
1304 
1305  /**
1306  * A list of zero terminated key/value strings. There is no end marker for
1307  * the list, so it is required to rely on the side data size to stop. This
1308  * side data includes updated metadata which appeared in the stream.
1309  */
1311 
1312  /**
1313  * MPEGTS stream ID, this is required to pass the stream ID
1314  * information from the demuxer to the corresponding muxer.
1315  */
1317 
1318  /**
1319  * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1320  * should be associated with a video stream and contains data in the form
1321  * of the AVMasteringDisplayMetadata struct.
1322  */
1324 
1325  /**
1326  * This side data should be associated with a video stream and corresponds
1327  * to the AVSphericalMapping structure.
1328  */
1330 
1331  /**
1332  * Content light level (based on CTA-861.3). This metadata should be
1333  * associated with a video stream and contains data in the form of the
1334  * AVContentLightMetadata struct.
1335  */
1337 
1338  /**
1339  * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1340  * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1341  * The number of bytes of CC data is AVPacketSideData.size.
1342  */
1344 
1345  /**
1346  * The number of side data types.
1347  * This is not part of the public API/ABI in the sense that it may
1348  * change when new side data types are added.
1349  * This must stay the last enum value.
1350  * If its value becomes huge, some code using it
1351  * needs to be updated as it assumes it to be smaller than other limits.
1352  */
1354 };
1355 
1356 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1357 
1358 typedef struct AVPacketSideData {
1360  int size;
1363 
1364 /**
1365  * This structure stores compressed data. It is typically exported by demuxers
1366  * and then passed as input to decoders, or received as output from encoders and
1367  * then passed to muxers.
1368  *
1369  * For video, it should typically contain one compressed frame. For audio it may
1370  * contain several compressed frames. Encoders are allowed to output empty
1371  * packets, with no compressed data, containing only side data
1372  * (e.g. to update some stream parameters at the end of encoding).
1373  *
1374  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1375  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1376  * without libavcodec and libavformat major bump.
1377  *
1378  * The semantics of data ownership depends on the buf field.
1379  * If it is set, the packet data is dynamically allocated and is
1380  * valid indefinitely until a call to av_packet_unref() reduces the
1381  * reference count to 0.
1382  *
1383  * If the buf field is not set av_packet_ref() would make a copy instead
1384  * of increasing the reference count.
1385  *
1386  * The side data is always allocated with av_malloc(), copied by
1387  * av_packet_ref() and freed by av_packet_unref().
1388  *
1389  * @see av_packet_ref
1390  * @see av_packet_unref
1391  */
1392 typedef struct AVPacket {
1393  /**
1394  * A reference to the reference-counted buffer where the packet data is
1395  * stored.
1396  * May be NULL, then the packet data is not reference-counted.
1397  */
1399  /**
1400  * Presentation timestamp in AVStream->time_base units; the time at which
1401  * the decompressed packet will be presented to the user.
1402  * Can be AV_NOPTS_VALUE if it is not stored in the file.
1403  * pts MUST be larger or equal to dts as presentation cannot happen before
1404  * decompression, unless one wants to view hex dumps. Some formats misuse
1405  * the terms dts and pts/cts to mean something different. Such timestamps
1406  * must be converted to true pts/dts before they are stored in AVPacket.
1407  */
1408  int64_t pts;
1409  /**
1410  * Decompression timestamp in AVStream->time_base units; the time at which
1411  * the packet is decompressed.
1412  * Can be AV_NOPTS_VALUE if it is not stored in the file.
1413  */
1414  int64_t dts;
1416  int size;
1418  /**
1419  * A combination of AV_PKT_FLAG values
1420  */
1421  int flags;
1422  /**
1423  * Additional packet data that can be provided by the container.
1424  * Packet can contain several types of side information.
1425  */
1428 
1429  /**
1430  * Duration of this packet in AVStream->time_base units, 0 if unknown.
1431  * Equals next_pts - this_pts in presentation order.
1432  */
1433  int64_t duration;
1434 
1435  int64_t pos; ///< byte position in stream, -1 if unknown
1436 
1437 #if FF_API_CONVERGENCE_DURATION
1438  /**
1439  * @deprecated Same as the duration field, but as int64_t. This was required
1440  * for Matroska subtitles, whose duration values could overflow when the
1441  * duration field was still an int.
1442  */
1445 #endif
1446 } AVPacket;
1447 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1448 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1449 /**
1450  * Flag is used to discard packets which are required to maintain valid
1451  * decoder state but are not required for output and should be dropped
1452  * after decoding.
1453  **/
1454 #define AV_PKT_FLAG_DISCARD 0x0004
1455 /**
1456  * The packet comes from a trusted source.
1457  *
1458  * Otherwise-unsafe constructs such as arbitrary pointers to data
1459  * outside the packet may be followed.
1460  */
1461 #define AV_PKT_FLAG_TRUSTED 0x0008
1462 /**
1463  * Flag is used to indicate packets that contain frames that can
1464  * be discarded by the decoder. I.e. Non-reference frames.
1465  */
1466 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1467 
1468 
1474 };
1475 /**
1476  * @}
1477  */
1478 
1479 struct AVCodecInternal;
1480 
1484  AV_FIELD_TT, //< Top coded_first, top displayed first
1485  AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1486  AV_FIELD_TB, //< Top coded first, bottom displayed first
1487  AV_FIELD_BT, //< Bottom coded first, top displayed first
1488 };
1489 
1490 /**
1491  * main external API structure.
1492  * New fields can be added to the end with minor version bumps.
1493  * Removal, reordering and changes to existing fields require a major
1494  * version bump.
1495  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1496  * applications.
1497  * The name string for AVOptions options matches the associated command line
1498  * parameter name and can be found in libavcodec/options_table.h
1499  * The AVOption/command line parameter names differ in some cases from the C
1500  * structure field names for historic reasons or brevity.
1501  * sizeof(AVCodecContext) must not be used outside libav*.
1502  */
1503 typedef struct AVCodecContext {
1504  /**
1505  * information on struct for av_log
1506  * - set by avcodec_alloc_context3
1507  */
1510 
1511  enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1512  const struct AVCodec *codec;
1513  enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1514 
1515  /**
1516  * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1517  * This is used to work around some encoder bugs.
1518  * A demuxer should set this to what is stored in the field used to identify the codec.
1519  * If there are multiple such fields in a container then the demuxer should choose the one
1520  * which maximizes the information about the used codec.
1521  * If the codec tag field in a container is larger than 32 bits then the demuxer should
1522  * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1523  * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1524  * first.
1525  * - encoding: Set by user, if not then the default based on codec_id will be used.
1526  * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1527  */
1528  unsigned int codec_tag;
1529 
1530  void *priv_data;
1531 
1532  /**
1533  * Private context used for internal data.
1534  *
1535  * Unlike priv_data, this is not codec-specific. It is used in general
1536  * libavcodec functions.
1537  */
1538  struct AVCodecInternal *internal;
1539 
1540  /**
1541  * Private data of the user, can be used to carry app specific stuff.
1542  * - encoding: Set by user.
1543  * - decoding: Set by user.
1544  */
1545  void *opaque;
1546 
1547  /**
1548  * the average bitrate
1549  * - encoding: Set by user; unused for constant quantizer encoding.
1550  * - decoding: Set by user, may be overwritten by libavcodec
1551  * if this info is available in the stream
1552  */
1553  int64_t bit_rate;
1554 
1555  /**
1556  * number of bits the bitstream is allowed to diverge from the reference.
1557  * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1558  * - encoding: Set by user; unused for constant quantizer encoding.
1559  * - decoding: unused
1560  */
1562 
1563  /**
1564  * Global quality for codecs which cannot change it per frame.
1565  * This should be proportional to MPEG-1/2/4 qscale.
1566  * - encoding: Set by user.
1567  * - decoding: unused
1568  */
1570 
1571  /**
1572  * - encoding: Set by user.
1573  * - decoding: unused
1574  */
1576 #define FF_COMPRESSION_DEFAULT -1
1577 
1578  /**
1579  * AV_CODEC_FLAG_*.
1580  * - encoding: Set by user.
1581  * - decoding: Set by user.
1582  */
1583  int flags;
1584 
1585  /**
1586  * AV_CODEC_FLAG2_*
1587  * - encoding: Set by user.
1588  * - decoding: Set by user.
1589  */
1590  int flags2;
1591 
1592  /**
1593  * some codecs need / can use extradata like Huffman tables.
1594  * MJPEG: Huffman tables
1595  * rv10: additional flags
1596  * MPEG-4: global headers (they can be in the bitstream or here)
1597  * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1598  * than extradata_size to avoid problems if it is read with the bitstream reader.
1599  * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1600  * - encoding: Set/allocated/freed by libavcodec.
1601  * - decoding: Set/allocated/freed by user.
1602  */
1605 
1606  /**
1607  * This is the fundamental unit of time (in seconds) in terms
1608  * of which frame timestamps are represented. For fixed-fps content,
1609  * timebase should be 1/framerate and timestamp increments should be
1610  * identically 1.
1611  * This often, but not always is the inverse of the frame rate or field rate
1612  * for video. 1/time_base is not the average frame rate if the frame rate is not
1613  * constant.
1614  *
1615  * Like containers, elementary streams also can store timestamps, 1/time_base
1616  * is the unit in which these timestamps are specified.
1617  * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1618  * vop_time_increment_resolution and fixed_vop_rate
1619  * (fixed_vop_rate == 0 implies that it is different from the framerate)
1620  *
1621  * - encoding: MUST be set by user.
1622  * - decoding: the use of this field for decoding is deprecated.
1623  * Use framerate instead.
1624  */
1626 
1627  /**
1628  * For some codecs, the time base is closer to the field rate than the frame rate.
1629  * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1630  * if no telecine is used ...
1631  *
1632  * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1633  */
1635 
1636  /**
1637  * Codec delay.
1638  *
1639  * Encoding: Number of frames delay there will be from the encoder input to
1640  * the decoder output. (we assume the decoder matches the spec)
1641  * Decoding: Number of frames delay in addition to what a standard decoder
1642  * as specified in the spec would produce.
1643  *
1644  * Video:
1645  * Number of frames the decoded output will be delayed relative to the
1646  * encoded input.
1647  *
1648  * Audio:
1649  * For encoding, this field is unused (see initial_padding).
1650  *
1651  * For decoding, this is the number of samples the decoder needs to
1652  * output before the decoder's output is valid. When seeking, you should
1653  * start decoding this many samples prior to your desired seek point.
1654  *
1655  * - encoding: Set by libavcodec.
1656  * - decoding: Set by libavcodec.
1657  */
1658  int delay;
1659 
1660 
1661  /* video only */
1662  /**
1663  * picture width / height.
1664  *
1665  * @note Those fields may not match the values of the last
1666  * AVFrame output by avcodec_decode_video2 due frame
1667  * reordering.
1668  *
1669  * - encoding: MUST be set by user.
1670  * - decoding: May be set by the user before opening the decoder if known e.g.
1671  * from the container. Some decoders will require the dimensions
1672  * to be set by the caller. During decoding, the decoder may
1673  * overwrite those values as required while parsing the data.
1674  */
1676 
1677  /**
1678  * Bitstream width / height, may be different from width/height e.g. when
1679  * the decoded frame is cropped before being output or lowres is enabled.
1680  *
1681  * @note Those field may not match the value of the last
1682  * AVFrame output by avcodec_receive_frame() due frame
1683  * reordering.
1684  *
1685  * - encoding: unused
1686  * - decoding: May be set by the user before opening the decoder if known
1687  * e.g. from the container. During decoding, the decoder may
1688  * overwrite those values as required while parsing the data.
1689  */
1691 
1692  /**
1693  * the number of pictures in a group of pictures, or 0 for intra_only
1694  * - encoding: Set by user.
1695  * - decoding: unused
1696  */
1698 
1699  /**
1700  * Pixel format, see AV_PIX_FMT_xxx.
1701  * May be set by the demuxer if known from headers.
1702  * May be overridden by the decoder if it knows better.
1703  *
1704  * @note This field may not match the value of the last
1705  * AVFrame output by avcodec_receive_frame() due frame
1706  * reordering.
1707  *
1708  * - encoding: Set by user.
1709  * - decoding: Set by user if known, overridden by libavcodec while
1710  * parsing the data.
1711  */
1713 
1714  /**
1715  * If non NULL, 'draw_horiz_band' is called by the libavcodec
1716  * decoder to draw a horizontal band. It improves cache usage. Not
1717  * all codecs can do that. You must check the codec capabilities
1718  * beforehand.
1719  * When multithreading is used, it may be called from multiple threads
1720  * at the same time; threads might draw different parts of the same AVFrame,
1721  * or multiple AVFrames, and there is no guarantee that slices will be drawn
1722  * in order.
1723  * The function is also used by hardware acceleration APIs.
1724  * It is called at least once during frame decoding to pass
1725  * the data needed for hardware render.
1726  * In that mode instead of pixel data, AVFrame points to
1727  * a structure specific to the acceleration API. The application
1728  * reads the structure and can change some fields to indicate progress
1729  * or mark state.
1730  * - encoding: unused
1731  * - decoding: Set by user.
1732  * @param height the height of the slice
1733  * @param y the y position of the slice
1734  * @param type 1->top field, 2->bottom field, 3->frame
1735  * @param offset offset into the AVFrame.data from which the slice should be read
1736  */
1738  const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1739  int y, int type, int height);
1740 
1741  /**
1742  * callback to negotiate the pixelFormat
1743  * @param fmt is the list of formats which are supported by the codec,
1744  * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1745  * The first is always the native one.
1746  * @note The callback may be called again immediately if initialization for
1747  * the selected (hardware-accelerated) pixel format failed.
1748  * @warning Behavior is undefined if the callback returns a value not
1749  * in the fmt list of formats.
1750  * @return the chosen format
1751  * - encoding: unused
1752  * - decoding: Set by user, if not set the native format will be chosen.
1753  */
1754  enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1755 
1756  /**
1757  * maximum number of B-frames between non-B-frames
1758  * Note: The output will be delayed by max_b_frames+1 relative to the input.
1759  * - encoding: Set by user.
1760  * - decoding: unused
1761  */
1763 
1764  /**
1765  * qscale factor between IP and B-frames
1766  * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1767  * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1768  * - encoding: Set by user.
1769  * - decoding: unused
1770  */
1772 
1773 #if FF_API_PRIVATE_OPT
1774  /** @deprecated use encoder private options instead */
1777 #endif
1778 
1779  /**
1780  * qscale offset between IP and B-frames
1781  * - encoding: Set by user.
1782  * - decoding: unused
1783  */
1785 
1786  /**
1787  * Size of the frame reordering buffer in the decoder.
1788  * For MPEG-2 it is 1 IPB or 0 low delay IP.
1789  * - encoding: Set by libavcodec.
1790  * - decoding: Set by libavcodec.
1791  */
1793 
1794 #if FF_API_PRIVATE_OPT
1795  /** @deprecated use encoder private options instead */
1798 #endif
1799 
1800  /**
1801  * qscale factor between P- and I-frames
1802  * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1803  * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1804  * - encoding: Set by user.
1805  * - decoding: unused
1806  */
1808 
1809  /**
1810  * qscale offset between P and I-frames
1811  * - encoding: Set by user.
1812  * - decoding: unused
1813  */
1815 
1816  /**
1817  * luminance masking (0-> disabled)
1818  * - encoding: Set by user.
1819  * - decoding: unused
1820  */
1822 
1823  /**
1824  * temporary complexity masking (0-> disabled)
1825  * - encoding: Set by user.
1826  * - decoding: unused
1827  */
1829 
1830  /**
1831  * spatial complexity masking (0-> disabled)
1832  * - encoding: Set by user.
1833  * - decoding: unused
1834  */
1836 
1837  /**
1838  * p block masking (0-> disabled)
1839  * - encoding: Set by user.
1840  * - decoding: unused
1841  */
1842  float p_masking;
1843 
1844  /**
1845  * darkness masking (0-> disabled)
1846  * - encoding: Set by user.
1847  * - decoding: unused
1848  */
1850 
1851  /**
1852  * slice count
1853  * - encoding: Set by libavcodec.
1854  * - decoding: Set by user (or 0).
1855  */
1857 
1858 #if FF_API_PRIVATE_OPT
1859  /** @deprecated use encoder private options instead */
1862 #define FF_PRED_LEFT 0
1863 #define FF_PRED_PLANE 1
1864 #define FF_PRED_MEDIAN 2
1865 #endif
1866 
1867  /**
1868  * slice offsets in the frame in bytes
1869  * - encoding: Set/allocated by libavcodec.
1870  * - decoding: Set/allocated by user (or NULL).
1871  */
1873 
1874  /**
1875  * sample aspect ratio (0 if unknown)
1876  * That is the width of a pixel divided by the height of the pixel.
1877  * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1878  * - encoding: Set by user.
1879  * - decoding: Set by libavcodec.
1880  */
1882 
1883  /**
1884  * motion estimation comparison function
1885  * - encoding: Set by user.
1886  * - decoding: unused
1887  */
1888  int me_cmp;
1889  /**
1890  * subpixel motion estimation comparison function
1891  * - encoding: Set by user.
1892  * - decoding: unused
1893  */
1895  /**
1896  * macroblock comparison function (not supported yet)
1897  * - encoding: Set by user.
1898  * - decoding: unused
1899  */
1900  int mb_cmp;
1901  /**
1902  * interlaced DCT comparison function
1903  * - encoding: Set by user.
1904  * - decoding: unused
1905  */
1907 #define FF_CMP_SAD 0
1908 #define FF_CMP_SSE 1
1909 #define FF_CMP_SATD 2
1910 #define FF_CMP_DCT 3
1911 #define FF_CMP_PSNR 4
1912 #define FF_CMP_BIT 5
1913 #define FF_CMP_RD 6
1914 #define FF_CMP_ZERO 7
1915 #define FF_CMP_VSAD 8
1916 #define FF_CMP_VSSE 9
1917 #define FF_CMP_NSSE 10
1918 #define FF_CMP_W53 11
1919 #define FF_CMP_W97 12
1920 #define FF_CMP_DCTMAX 13
1921 #define FF_CMP_DCT264 14
1922 #define FF_CMP_MEDIAN_SAD 15
1923 #define FF_CMP_CHROMA 256
1924 
1925  /**
1926  * ME diamond size & shape
1927  * - encoding: Set by user.
1928  * - decoding: unused
1929  */
1931 
1932  /**
1933  * amount of previous MV predictors (2a+1 x 2a+1 square)
1934  * - encoding: Set by user.
1935  * - decoding: unused
1936  */
1938 
1939 #if FF_API_PRIVATE_OPT
1940  /** @deprecated use encoder private options instead */
1942  int pre_me;
1943 #endif
1944 
1945  /**
1946  * motion estimation prepass comparison function
1947  * - encoding: Set by user.
1948  * - decoding: unused
1949  */
1951 
1952  /**
1953  * ME prepass diamond size & shape
1954  * - encoding: Set by user.
1955  * - decoding: unused
1956  */
1958 
1959  /**
1960  * subpel ME quality
1961  * - encoding: Set by user.
1962  * - decoding: unused
1963  */
1965 
1966  /**
1967  * maximum motion estimation search range in subpel units
1968  * If 0 then no limit.
1969  *
1970  * - encoding: Set by user.
1971  * - decoding: unused
1972  */
1974 
1975  /**
1976  * slice flags
1977  * - encoding: unused
1978  * - decoding: Set by user.
1979  */
1981 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1982 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1983 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1984 
1985  /**
1986  * macroblock decision mode
1987  * - encoding: Set by user.
1988  * - decoding: unused
1989  */
1991 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1992 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1993 #define FF_MB_DECISION_RD 2 ///< rate distortion
1994 
1995  /**
1996  * custom intra quantization matrix
1997  * - encoding: Set by user, can be NULL.
1998  * - decoding: Set by libavcodec.
1999  */
2000  uint16_t *intra_matrix;
2001 
2002  /**
2003  * custom inter quantization matrix
2004  * - encoding: Set by user, can be NULL.
2005  * - decoding: Set by libavcodec.
2006  */
2007  uint16_t *inter_matrix;
2008 
2009 #if FF_API_PRIVATE_OPT
2010  /** @deprecated use encoder private options instead */
2013 
2014  /** @deprecated use encoder private options instead */
2017 #endif
2018 
2019  /**
2020  * precision of the intra DC coefficient - 8
2021  * - encoding: Set by user.
2022  * - decoding: Set by libavcodec
2023  */
2025 
2026  /**
2027  * Number of macroblock rows at the top which are skipped.
2028  * - encoding: unused
2029  * - decoding: Set by user.
2030  */
2032 
2033  /**
2034  * Number of macroblock rows at the bottom which are skipped.
2035  * - encoding: unused
2036  * - decoding: Set by user.
2037  */
2039 
2040  /**
2041  * minimum MB Lagrange multiplier
2042  * - encoding: Set by user.
2043  * - decoding: unused
2044  */
2045  int mb_lmin;
2046 
2047  /**
2048  * maximum MB Lagrange multiplier
2049  * - encoding: Set by user.
2050  * - decoding: unused
2051  */
2052  int mb_lmax;
2053 
2054 #if FF_API_PRIVATE_OPT
2055  /**
2056  * @deprecated use encoder private options instead
2057  */
2060 #endif
2061 
2062  /**
2063  * - encoding: Set by user.
2064  * - decoding: unused
2065  */
2067 
2068 #if FF_API_PRIVATE_OPT
2069  /** @deprecated use encoder private options instead */
2072 #endif
2073 
2074  /**
2075  * minimum GOP size
2076  * - encoding: Set by user.
2077  * - decoding: unused
2078  */
2080 
2081  /**
2082  * number of reference frames
2083  * - encoding: Set by user.
2084  * - decoding: Set by lavc.
2085  */
2086  int refs;
2087 
2088 #if FF_API_PRIVATE_OPT
2089  /** @deprecated use encoder private options instead */
2092 #endif
2093 
2094  /**
2095  * Note: Value depends upon the compare function used for fullpel ME.
2096  * - encoding: Set by user.
2097  * - decoding: unused
2098  */
2100 
2101 #if FF_API_PRIVATE_OPT
2102  /** @deprecated use encoder private options instead */
2105 #endif
2106 
2107  /**
2108  * Chromaticity coordinates of the source primaries.
2109  * - encoding: Set by user
2110  * - decoding: Set by libavcodec
2111  */
2113 
2114  /**
2115  * Color Transfer Characteristic.
2116  * - encoding: Set by user
2117  * - decoding: Set by libavcodec
2118  */
2120 
2121  /**
2122  * YUV colorspace type.
2123  * - encoding: Set by user
2124  * - decoding: Set by libavcodec
2125  */
2127 
2128  /**
2129  * MPEG vs JPEG YUV range.
2130  * - encoding: Set by user
2131  * - decoding: Set by libavcodec
2132  */
2134 
2135  /**
2136  * This defines the location of chroma samples.
2137  * - encoding: Set by user
2138  * - decoding: Set by libavcodec
2139  */
2141 
2142  /**
2143  * Number of slices.
2144  * Indicates number of picture subdivisions. Used for parallelized
2145  * decoding.
2146  * - encoding: Set by user
2147  * - decoding: unused
2148  */
2149  int slices;
2150 
2151  /** Field order
2152  * - encoding: set by libavcodec
2153  * - decoding: Set by user.
2154  */
2156 
2157  /* audio only */
2158  int sample_rate; ///< samples per second
2159  int channels; ///< number of audio channels
2160 
2161  /**
2162  * audio sample format
2163  * - encoding: Set by user.
2164  * - decoding: Set by libavcodec.
2165  */
2166  enum AVSampleFormat sample_fmt; ///< sample format
2167 
2168  /* The following data should not be initialized. */
2169  /**
2170  * Number of samples per channel in an audio frame.
2171  *
2172  * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2173  * except the last must contain exactly frame_size samples per channel.
2174  * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2175  * frame size is not restricted.
2176  * - decoding: may be set by some decoders to indicate constant frame size
2177  */
2179 
2180  /**
2181  * Frame counter, set by libavcodec.
2182  *
2183  * - decoding: total number of frames returned from the decoder so far.
2184  * - encoding: total number of frames passed to the encoder so far.
2185  *
2186  * @note the counter is not incremented if encoding/decoding resulted in
2187  * an error.
2188  */
2190 
2191  /**
2192  * number of bytes per packet if constant and known or 0
2193  * Used by some WAV based audio codecs.
2194  */
2196 
2197  /**
2198  * Audio cutoff bandwidth (0 means "automatic")
2199  * - encoding: Set by user.
2200  * - decoding: unused
2201  */
2202  int cutoff;
2203 
2204  /**
2205  * Audio channel layout.
2206  * - encoding: set by user.
2207  * - decoding: set by user, may be overwritten by libavcodec.
2208  */
2209  uint64_t channel_layout;
2210 
2211  /**
2212  * Request decoder to use this channel layout if it can (0 for default)
2213  * - encoding: unused
2214  * - decoding: Set by user.
2215  */
2217 
2218  /**
2219  * Type of service that the audio stream conveys.
2220  * - encoding: Set by user.
2221  * - decoding: Set by libavcodec.
2222  */
2224 
2225  /**
2226  * desired sample format
2227  * - encoding: Not used.
2228  * - decoding: Set by user.
2229  * Decoder will decode to this format if it can.
2230  */
2232 
2233  /**
2234  * This callback is called at the beginning of each frame to get data
2235  * buffer(s) for it. There may be one contiguous buffer for all the data or
2236  * there may be a buffer per each data plane or anything in between. What
2237  * this means is, you may set however many entries in buf[] you feel necessary.
2238  * Each buffer must be reference-counted using the AVBuffer API (see description
2239  * of buf[] below).
2240  *
2241  * The following fields will be set in the frame before this callback is
2242  * called:
2243  * - format
2244  * - width, height (video only)
2245  * - sample_rate, channel_layout, nb_samples (audio only)
2246  * Their values may differ from the corresponding values in
2247  * AVCodecContext. This callback must use the frame values, not the codec
2248  * context values, to calculate the required buffer size.
2249  *
2250  * This callback must fill the following fields in the frame:
2251  * - data[]
2252  * - linesize[]
2253  * - extended_data:
2254  * * if the data is planar audio with more than 8 channels, then this
2255  * callback must allocate and fill extended_data to contain all pointers
2256  * to all data planes. data[] must hold as many pointers as it can.
2257  * extended_data must be allocated with av_malloc() and will be freed in
2258  * av_frame_unref().
2259  * * otherwise extended_data must point to data
2260  * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2261  * the frame's data and extended_data pointers must be contained in these. That
2262  * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2263  * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2264  * and av_buffer_ref().
2265  * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2266  * this callback and filled with the extra buffers if there are more
2267  * buffers than buf[] can hold. extended_buf will be freed in
2268  * av_frame_unref().
2269  *
2270  * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2271  * avcodec_default_get_buffer2() instead of providing buffers allocated by
2272  * some other means.
2273  *
2274  * Each data plane must be aligned to the maximum required by the target
2275  * CPU.
2276  *
2277  * @see avcodec_default_get_buffer2()
2278  *
2279  * Video:
2280  *
2281  * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2282  * (read and/or written to if it is writable) later by libavcodec.
2283  *
2284  * avcodec_align_dimensions2() should be used to find the required width and
2285  * height, as they normally need to be rounded up to the next multiple of 16.
2286  *
2287  * Some decoders do not support linesizes changing between frames.
2288  *
2289  * If frame multithreading is used and thread_safe_callbacks is set,
2290  * this callback may be called from a different thread, but not from more
2291  * than one at once. Does not need to be reentrant.
2292  *
2293  * @see avcodec_align_dimensions2()
2294  *
2295  * Audio:
2296  *
2297  * Decoders request a buffer of a particular size by setting
2298  * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2299  * however, utilize only part of the buffer by setting AVFrame.nb_samples
2300  * to a smaller value in the output frame.
2301  *
2302  * As a convenience, av_samples_get_buffer_size() and
2303  * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2304  * functions to find the required data size and to fill data pointers and
2305  * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2306  * since all planes must be the same size.
2307  *
2308  * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2309  *
2310  * - encoding: unused
2311  * - decoding: Set by libavcodec, user can override.
2312  */
2314 
2315  /**
2316  * If non-zero, the decoded audio and video frames returned from
2317  * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2318  * and are valid indefinitely. The caller must free them with
2319  * av_frame_unref() when they are not needed anymore.
2320  * Otherwise, the decoded frames must not be freed by the caller and are
2321  * only valid until the next decode call.
2322  *
2323  * This is always automatically enabled if avcodec_receive_frame() is used.
2324  *
2325  * - encoding: unused
2326  * - decoding: set by the caller before avcodec_open2().
2327  */
2330 
2331  /* - encoding parameters */
2332  float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2333  float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2334 
2335  /**
2336  * minimum quantizer
2337  * - encoding: Set by user.
2338  * - decoding: unused
2339  */
2340  int qmin;
2341 
2342  /**
2343  * maximum quantizer
2344  * - encoding: Set by user.
2345  * - decoding: unused
2346  */
2347  int qmax;
2348 
2349  /**
2350  * maximum quantizer difference between frames
2351  * - encoding: Set by user.
2352  * - decoding: unused
2353  */
2355 
2356  /**
2357  * decoder bitstream buffer size
2358  * - encoding: Set by user.
2359  * - decoding: unused
2360  */
2362 
2363  /**
2364  * ratecontrol override, see RcOverride
2365  * - encoding: Allocated/set/freed by user.
2366  * - decoding: unused
2367  */
2370 
2371  /**
2372  * maximum bitrate
2373  * - encoding: Set by user.
2374  * - decoding: Set by user, may be overwritten by libavcodec.
2375  */
2376  int64_t rc_max_rate;
2377 
2378  /**
2379  * minimum bitrate
2380  * - encoding: Set by user.
2381  * - decoding: unused
2382  */
2383  int64_t rc_min_rate;
2384 
2385  /**
2386  * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2387  * - encoding: Set by user.
2388  * - decoding: unused.
2389  */
2391 
2392  /**
2393  * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2394  * - encoding: Set by user.
2395  * - decoding: unused.
2396  */
2398 
2399  /**
2400  * Number of bits which should be loaded into the rc buffer before decoding starts.
2401  * - encoding: Set by user.
2402  * - decoding: unused
2403  */
2405 
2406 #if FF_API_CODER_TYPE
2407 #define FF_CODER_TYPE_VLC 0
2408 #define FF_CODER_TYPE_AC 1
2409 #define FF_CODER_TYPE_RAW 2
2410 #define FF_CODER_TYPE_RLE 3
2411  /**
2412  * @deprecated use encoder private options instead
2413  */
2416 #endif /* FF_API_CODER_TYPE */
2417 
2418 #if FF_API_PRIVATE_OPT
2419  /** @deprecated use encoder private options instead */
2422 #endif
2423 
2424 #if FF_API_PRIVATE_OPT
2425  /** @deprecated use encoder private options instead */
2428 
2429  /** @deprecated use encoder private options instead */
2432 
2433  /** @deprecated use encoder private options instead */
2436 
2437  /** @deprecated use encoder private options instead */
2440 #endif /* FF_API_PRIVATE_OPT */
2441 
2442  /**
2443  * trellis RD quantization
2444  * - encoding: Set by user.
2445  * - decoding: unused
2446  */
2447  int trellis;
2448 
2449 #if FF_API_PRIVATE_OPT
2450  /** @deprecated use encoder private options instead */
2453 
2454  /** @deprecated use encoder private options instead */
2457 
2458  /** @deprecated use encoder private options instead */
2461 #endif
2462 
2463 #if FF_API_RTP_CALLBACK
2464  /**
2465  * @deprecated unused
2466  */
2467  /* The RTP callback: This function is called */
2468  /* every time the encoder has a packet to send. */
2469  /* It depends on the encoder if the data starts */
2470  /* with a Start Code (it should). H.263 does. */
2471  /* mb_nb contains the number of macroblocks */
2472  /* encoded in the RTP payload. */
2474  void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2475 #endif
2476 
2477 #if FF_API_PRIVATE_OPT
2478  /** @deprecated use encoder private options instead */
2480  int rtp_payload_size; /* The size of the RTP payload: the coder will */
2481  /* do its best to deliver a chunk with size */
2482  /* below rtp_payload_size, the chunk will start */
2483  /* with a start code on some codecs like H.263. */
2484  /* This doesn't take account of any particular */
2485  /* headers inside the transmitted RTP payload. */
2486 #endif
2487 
2488 #if FF_API_STAT_BITS
2489  /* statistics, used for 2-pass encoding */
2491  int mv_bits;
2499  int i_count;
2501  int p_count;
2506 
2507  /** @deprecated this field is unused */
2510 #endif
2511 
2512  /**
2513  * pass1 encoding statistics output buffer
2514  * - encoding: Set by libavcodec.
2515  * - decoding: unused
2516  */
2517  char *stats_out;
2518 
2519  /**
2520  * pass2 encoding statistics input buffer
2521  * Concatenated stuff from stats_out of pass1 should be placed here.
2522  * - encoding: Allocated/set/freed by user.
2523  * - decoding: unused
2524  */
2525  char *stats_in;
2526 
2527  /**
2528  * Work around bugs in encoders which sometimes cannot be detected automatically.
2529  * - encoding: Set by user
2530  * - decoding: Set by user
2531  */
2533 #define FF_BUG_AUTODETECT 1 ///< autodetection
2534 #define FF_BUG_XVID_ILACE 4
2535 #define FF_BUG_UMP4 8
2536 #define FF_BUG_NO_PADDING 16
2537 #define FF_BUG_AMV 32
2538 #define FF_BUG_QPEL_CHROMA 64
2539 #define FF_BUG_STD_QPEL 128
2540 #define FF_BUG_QPEL_CHROMA2 256
2541 #define FF_BUG_DIRECT_BLOCKSIZE 512
2542 #define FF_BUG_EDGE 1024
2543 #define FF_BUG_HPEL_CHROMA 2048
2544 #define FF_BUG_DC_CLIP 4096
2545 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2546 #define FF_BUG_TRUNCATED 16384
2547 #define FF_BUG_IEDGE 32768
2548 
2549  /**
2550  * strictly follow the standard (MPEG-4, ...).
2551  * - encoding: Set by user.
2552  * - decoding: Set by user.
2553  * Setting this to STRICT or higher means the encoder and decoder will
2554  * generally do stupid things, whereas setting it to unofficial or lower
2555  * will mean the encoder might produce output that is not supported by all
2556  * spec-compliant decoders. Decoders don't differentiate between normal,
2557  * unofficial and experimental (that is, they always try to decode things
2558  * when they can) unless they are explicitly asked to behave stupidly
2559  * (=strictly conform to the specs)
2560  */
2562 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2563 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2564 #define FF_COMPLIANCE_NORMAL 0
2565 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2566 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2567 
2568  /**
2569  * error concealment flags
2570  * - encoding: unused
2571  * - decoding: Set by user.
2572  */
2574 #define FF_EC_GUESS_MVS 1
2575 #define FF_EC_DEBLOCK 2
2576 #define FF_EC_FAVOR_INTER 256
2577 
2578  /**
2579  * debug
2580  * - encoding: Set by user.
2581  * - decoding: Set by user.
2582  */
2583  int debug;
2584 #define FF_DEBUG_PICT_INFO 1
2585 #define FF_DEBUG_RC 2
2586 #define FF_DEBUG_BITSTREAM 4
2587 #define FF_DEBUG_MB_TYPE 8
2588 #define FF_DEBUG_QP 16
2589 #if FF_API_DEBUG_MV
2590 /**
2591  * @deprecated this option does nothing
2592  */
2593 #define FF_DEBUG_MV 32
2594 #endif
2595 #define FF_DEBUG_DCT_COEFF 0x00000040
2596 #define FF_DEBUG_SKIP 0x00000080
2597 #define FF_DEBUG_STARTCODE 0x00000100
2598 #define FF_DEBUG_ER 0x00000400
2599 #define FF_DEBUG_MMCO 0x00000800
2600 #define FF_DEBUG_BUGS 0x00001000
2601 #if FF_API_DEBUG_MV
2602 #define FF_DEBUG_VIS_QP 0x00002000
2603 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2604 #endif
2605 #define FF_DEBUG_BUFFERS 0x00008000
2606 #define FF_DEBUG_THREADS 0x00010000
2607 #define FF_DEBUG_GREEN_MD 0x00800000
2608 #define FF_DEBUG_NOMC 0x01000000
2609 
2610 #if FF_API_DEBUG_MV
2611  /**
2612  * debug
2613  * - encoding: Set by user.
2614  * - decoding: Set by user.
2615  */
2616  int debug_mv;
2617 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2618 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2619 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2620 #endif
2621 
2622  /**
2623  * Error recognition; may misdetect some more or less valid parts as errors.
2624  * - encoding: unused
2625  * - decoding: Set by user.
2626  */
2628 
2629 /**
2630  * Verify checksums embedded in the bitstream (could be of either encoded or
2631  * decoded data, depending on the codec) and print an error message on mismatch.
2632  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2633  * decoder returning an error.
2634  */
2635 #define AV_EF_CRCCHECK (1<<0)
2636 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2637 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2638 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2639 
2640 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2641 #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
2642 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2643 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2644 
2645 
2646  /**
2647  * opaque 64-bit number (generally a PTS) that will be reordered and
2648  * output in AVFrame.reordered_opaque
2649  * - encoding: unused
2650  * - decoding: Set by user.
2651  */
2653 
2654  /**
2655  * Hardware accelerator in use
2656  * - encoding: unused.
2657  * - decoding: Set by libavcodec
2658  */
2659  const struct AVHWAccel *hwaccel;
2660 
2661  /**
2662  * Hardware accelerator context.
2663  * For some hardware accelerators, a global context needs to be
2664  * provided by the user. In that case, this holds display-dependent
2665  * data FFmpeg cannot instantiate itself. Please refer to the
2666  * FFmpeg HW accelerator documentation to know how to fill this
2667  * is. e.g. for VA API, this is a struct vaapi_context.
2668  * - encoding: unused
2669  * - decoding: Set by user
2670  */
2672 
2673  /**
2674  * error
2675  * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2676  * - decoding: unused
2677  */
2679 
2680  /**
2681  * DCT algorithm, see FF_DCT_* below
2682  * - encoding: Set by user.
2683  * - decoding: unused
2684  */
2686 #define FF_DCT_AUTO 0
2687 #define FF_DCT_FASTINT 1
2688 #define FF_DCT_INT 2
2689 #define FF_DCT_MMX 3
2690 #define FF_DCT_ALTIVEC 5
2691 #define FF_DCT_FAAN 6
2692 
2693  /**
2694  * IDCT algorithm, see FF_IDCT_* below.
2695  * - encoding: Set by user.
2696  * - decoding: Set by user.
2697  */
2699 #define FF_IDCT_AUTO 0
2700 #define FF_IDCT_INT 1
2701 #define FF_IDCT_SIMPLE 2
2702 #define FF_IDCT_SIMPLEMMX 3
2703 #define FF_IDCT_ARM 7
2704 #define FF_IDCT_ALTIVEC 8
2705 #define FF_IDCT_SIMPLEARM 10
2706 #define FF_IDCT_XVID 14
2707 #define FF_IDCT_SIMPLEARMV5TE 16
2708 #define FF_IDCT_SIMPLEARMV6 17
2709 #define FF_IDCT_FAAN 20
2710 #define FF_IDCT_SIMPLENEON 22
2711 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2712 #define FF_IDCT_SIMPLEAUTO 128
2713 
2714  /**
2715  * bits per sample/pixel from the demuxer (needed for huffyuv).
2716  * - encoding: Set by libavcodec.
2717  * - decoding: Set by user.
2718  */
2720 
2721  /**
2722  * Bits per sample/pixel of internal libavcodec pixel/sample format.
2723  * - encoding: set by user.
2724  * - decoding: set by libavcodec.
2725  */
2727 
2728 #if FF_API_LOWRES
2729  /**
2730  * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2731  * - encoding: unused
2732  * - decoding: Set by user.
2733  */
2734  int lowres;
2735 #endif
2736 
2737 #if FF_API_CODED_FRAME
2738  /**
2739  * the picture in the bitstream
2740  * - encoding: Set by libavcodec.
2741  * - decoding: unused
2742  *
2743  * @deprecated use the quality factor packet side data instead
2744  */
2746 #endif
2747 
2748  /**
2749  * thread count
2750  * is used to decide how many independent tasks should be passed to execute()
2751  * - encoding: Set by user.
2752  * - decoding: Set by user.
2753  */
2755 
2756  /**
2757  * Which multithreading methods to use.
2758  * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2759  * so clients which cannot provide future frames should not use it.
2760  *
2761  * - encoding: Set by user, otherwise the default is used.
2762  * - decoding: Set by user, otherwise the default is used.
2763  */
2765 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2766 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2767 
2768  /**
2769  * Which multithreading methods are in use by the codec.
2770  * - encoding: Set by libavcodec.
2771  * - decoding: Set by libavcodec.
2772  */
2774 
2775  /**
2776  * Set by the client if its custom get_buffer() callback can be called
2777  * synchronously from another thread, which allows faster multithreaded decoding.
2778  * draw_horiz_band() will be called from other threads regardless of this setting.
2779  * Ignored if the default get_buffer() is used.
2780  * - encoding: Set by user.
2781  * - decoding: Set by user.
2782  */
2784 
2785  /**
2786  * The codec may call this to execute several independent things.
2787  * It will return only after finishing all tasks.
2788  * The user may replace this with some multithreaded implementation,
2789  * the default implementation will execute the parts serially.
2790  * @param count the number of things to execute
2791  * - encoding: Set by libavcodec, user can override.
2792  * - decoding: Set by libavcodec, user can override.
2793  */
2794  int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2795 
2796  /**
2797  * The codec may call this to execute several independent things.
2798  * It will return only after finishing all tasks.
2799  * The user may replace this with some multithreaded implementation,
2800  * the default implementation will execute the parts serially.
2801  * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2802  * @param c context passed also to func
2803  * @param count the number of things to execute
2804  * @param arg2 argument passed unchanged to func
2805  * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2806  * @param func function that will be called count times, with jobnr from 0 to count-1.
2807  * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2808  * two instances of func executing at the same time will have the same threadnr.
2809  * @return always 0 currently, but code should handle a future improvement where when any call to func
2810  * returns < 0 no further calls to func may be done and < 0 is returned.
2811  * - encoding: Set by libavcodec, user can override.
2812  * - decoding: Set by libavcodec, user can override.
2813  */
2814  int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2815 
2816  /**
2817  * noise vs. sse weight for the nsse comparison function
2818  * - encoding: Set by user.
2819  * - decoding: unused
2820  */
2822 
2823  /**
2824  * profile
2825  * - encoding: Set by user.
2826  * - decoding: Set by libavcodec.
2827  */
2828  int profile;
2829 #define FF_PROFILE_UNKNOWN -99
2830 #define FF_PROFILE_RESERVED -100
2831 
2832 #define FF_PROFILE_AAC_MAIN 0
2833 #define FF_PROFILE_AAC_LOW 1
2834 #define FF_PROFILE_AAC_SSR 2
2835 #define FF_PROFILE_AAC_LTP 3
2836 #define FF_PROFILE_AAC_HE 4
2837 #define FF_PROFILE_AAC_HE_V2 28
2838 #define FF_PROFILE_AAC_LD 22
2839 #define FF_PROFILE_AAC_ELD 38
2840 #define FF_PROFILE_MPEG2_AAC_LOW 128
2841 #define FF_PROFILE_MPEG2_AAC_HE 131
2842 
2843 #define FF_PROFILE_DNXHD 0
2844 #define FF_PROFILE_DNXHR_LB 1
2845 #define FF_PROFILE_DNXHR_SQ 2
2846 #define FF_PROFILE_DNXHR_HQ 3
2847 #define FF_PROFILE_DNXHR_HQX 4
2848 #define FF_PROFILE_DNXHR_444 5
2849 
2850 #define FF_PROFILE_DTS 20
2851 #define FF_PROFILE_DTS_ES 30
2852 #define FF_PROFILE_DTS_96_24 40
2853 #define FF_PROFILE_DTS_HD_HRA 50
2854 #define FF_PROFILE_DTS_HD_MA 60
2855 #define FF_PROFILE_DTS_EXPRESS 70
2856 
2857 #define FF_PROFILE_MPEG2_422 0
2858 #define FF_PROFILE_MPEG2_HIGH 1
2859 #define FF_PROFILE_MPEG2_SS 2
2860 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2861 #define FF_PROFILE_MPEG2_MAIN 4
2862 #define FF_PROFILE_MPEG2_SIMPLE 5
2863 
2864 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2865 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2866 
2867 #define FF_PROFILE_H264_BASELINE 66
2868 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2869 #define FF_PROFILE_H264_MAIN 77
2870 #define FF_PROFILE_H264_EXTENDED 88
2871 #define FF_PROFILE_H264_HIGH 100
2872 #define FF_PROFILE_H264_HIGH_10 110
2873 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2874 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2875 #define FF_PROFILE_H264_HIGH_422 122
2876 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2877 #define FF_PROFILE_H264_STEREO_HIGH 128
2878 #define FF_PROFILE_H264_HIGH_444 144
2879 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2880 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2881 #define FF_PROFILE_H264_CAVLC_444 44
2882 
2883 #define FF_PROFILE_VC1_SIMPLE 0
2884 #define FF_PROFILE_VC1_MAIN 1
2885 #define FF_PROFILE_VC1_COMPLEX 2
2886 #define FF_PROFILE_VC1_ADVANCED 3
2887 
2888 #define FF_PROFILE_MPEG4_SIMPLE 0
2889 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2890 #define FF_PROFILE_MPEG4_CORE 2
2891 #define FF_PROFILE_MPEG4_MAIN 3
2892 #define FF_PROFILE_MPEG4_N_BIT 4
2893 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2894 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2895 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2896 #define FF_PROFILE_MPEG4_HYBRID 8
2897 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2898 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2899 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2900 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2901 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2902 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2903 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2904 
2905 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2906 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2907 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2908 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2909 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2910 
2911 #define FF_PROFILE_VP9_0 0
2912 #define FF_PROFILE_VP9_1 1
2913 #define FF_PROFILE_VP9_2 2
2914 #define FF_PROFILE_VP9_3 3
2915 
2916 #define FF_PROFILE_HEVC_MAIN 1
2917 #define FF_PROFILE_HEVC_MAIN_10 2
2918 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2919 #define FF_PROFILE_HEVC_REXT 4
2920 
2921 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2922 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2923 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2924 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2925 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2926 
2927  /**
2928  * level
2929  * - encoding: Set by user.
2930  * - decoding: Set by libavcodec.
2931  */
2932  int level;
2933 #define FF_LEVEL_UNKNOWN -99
2934 
2935  /**
2936  * Skip loop filtering for selected frames.
2937  * - encoding: unused
2938  * - decoding: Set by user.
2939  */
2941 
2942  /**
2943  * Skip IDCT/dequantization for selected frames.
2944  * - encoding: unused
2945  * - decoding: Set by user.
2946  */
2948 
2949  /**
2950  * Skip decoding for selected frames.
2951  * - encoding: unused
2952  * - decoding: Set by user.
2953  */
2955 
2956  /**
2957  * Header containing style information for text subtitles.
2958  * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2959  * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2960  * the Format line following. It shouldn't include any Dialogue line.
2961  * - encoding: Set/allocated/freed by user (before avcodec_open2())
2962  * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2963  */
2966 
2967 #if FF_API_VBV_DELAY
2968  /**
2969  * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2970  * Used for compliant TS muxing.
2971  * - encoding: Set by libavcodec.
2972  * - decoding: unused.
2973  * @deprecated this value is now exported as a part of
2974  * AV_PKT_DATA_CPB_PROPERTIES packet side data
2975  */
2977  uint64_t vbv_delay;
2978 #endif
2979 
2980 #if FF_API_SIDEDATA_ONLY_PKT
2981  /**
2982  * Encoding only and set by default. Allow encoders to output packets
2983  * that do not contain any encoded data, only side data.
2984  *
2985  * Some encoders need to output such packets, e.g. to update some stream
2986  * parameters at the end of encoding.
2987  *
2988  * @deprecated this field disables the default behaviour and
2989  * it is kept only for compatibility.
2990  */
2993 #endif
2994 
2995  /**
2996  * Audio only. The number of "priming" samples (padding) inserted by the
2997  * encoder at the beginning of the audio. I.e. this number of leading
2998  * decoded samples must be discarded by the caller to get the original audio
2999  * without leading padding.
3000  *
3001  * - decoding: unused
3002  * - encoding: Set by libavcodec. The timestamps on the output packets are
3003  * adjusted by the encoder so that they always refer to the
3004  * first sample of the data actually contained in the packet,
3005  * including any added padding. E.g. if the timebase is
3006  * 1/samplerate and the timestamp of the first input sample is
3007  * 0, the timestamp of the first output packet will be
3008  * -initial_padding.
3009  */
3011 
3012  /**
3013  * - decoding: For codecs that store a framerate value in the compressed
3014  * bitstream, the decoder may export it here. { 0, 1} when
3015  * unknown.
3016  * - encoding: May be used to signal the framerate of CFR content to an
3017  * encoder.
3018  */
3020 
3021  /**
3022  * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3023  * - encoding: unused.
3024  * - decoding: Set by libavcodec before calling get_format()
3025  */
3027 
3028  /**
3029  * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3030  * - encoding unused.
3031  * - decoding set by user.
3032  */
3034 
3035  /**
3036  * AVCodecDescriptor
3037  * - encoding: unused.
3038  * - decoding: set by libavcodec.
3039  */
3041 
3042 #if !FF_API_LOWRES
3043  /**
3044  * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3045  * - encoding: unused
3046  * - decoding: Set by user.
3047  */
3048  int lowres;
3049 #endif
3050 
3051  /**
3052  * Current statistics for PTS correction.
3053  * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3054  * - encoding: unused
3055  */
3056  int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3057  int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3058  int64_t pts_correction_last_pts; /// PTS of the last frame
3059  int64_t pts_correction_last_dts; /// DTS of the last frame
3060 
3061  /**
3062  * Character encoding of the input subtitles file.
3063  * - decoding: set by user
3064  * - encoding: unused
3065  */
3067 
3068  /**
3069  * Subtitles character encoding mode. Formats or codecs might be adjusting
3070  * this setting (if they are doing the conversion themselves for instance).
3071  * - decoding: set by libavcodec
3072  * - encoding: unused
3073  */
3075 #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)
3076 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3077 #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
3078 
3079  /**
3080  * Skip processing alpha if supported by codec.
3081  * Note that if the format uses pre-multiplied alpha (common with VP6,
3082  * and recommended due to better video quality/compression)
3083  * the image will look as if alpha-blended onto a black background.
3084  * However for formats that do not use pre-multiplied alpha
3085  * there might be serious artefacts (though e.g. libswscale currently
3086  * assumes pre-multiplied alpha anyway).
3087  *
3088  * - decoding: set by user
3089  * - encoding: unused
3090  */
3092 
3093  /**
3094  * Number of samples to skip after a discontinuity
3095  * - decoding: unused
3096  * - encoding: set by libavcodec
3097  */
3099 
3100 #if !FF_API_DEBUG_MV
3101  /**
3102  * debug motion vectors
3103  * - encoding: Set by user.
3104  * - decoding: Set by user.
3105  */
3107 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3108 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3109 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3110 #endif
3111 
3112  /**
3113  * custom intra quantization matrix
3114  * - encoding: Set by user, can be NULL.
3115  * - decoding: unused.
3116  */
3118 
3119  /**
3120  * dump format separator.
3121  * can be ", " or "\n " or anything else
3122  * - encoding: Set by user.
3123  * - decoding: Set by user.
3124  */
3126 
3127  /**
3128  * ',' separated list of allowed decoders.
3129  * If NULL then all are allowed
3130  * - encoding: unused
3131  * - decoding: set by user
3132  */
3134 
3135  /**
3136  * Properties of the stream that gets decoded
3137  * - encoding: unused
3138  * - decoding: set by libavcodec
3139  */
3140  unsigned properties;
3141 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3142 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3143 
3144  /**
3145  * Additional data associated with the entire coded stream.
3146  *
3147  * - decoding: unused
3148  * - encoding: may be set by libavcodec after avcodec_open2().
3149  */
3152 
3153  /**
3154  * A reference to the AVHWFramesContext describing the input (for encoding)
3155  * or output (decoding) frames. The reference is set by the caller and
3156  * afterwards owned (and freed) by libavcodec - it should never be read by
3157  * the caller after being set.
3158  *
3159  * - decoding: This field should be set by the caller from the get_format()
3160  * callback. The previous reference (if any) will always be
3161  * unreffed by libavcodec before the get_format() call.
3162  *
3163  * If the default get_buffer2() is used with a hwaccel pixel
3164  * format, then this AVHWFramesContext will be used for
3165  * allocating the frame buffers.
3166  *
3167  * - encoding: For hardware encoders configured to use a hwaccel pixel
3168  * format, this field should be set by the caller to a reference
3169  * to the AVHWFramesContext describing input frames.
3170  * AVHWFramesContext.format must be equal to
3171  * AVCodecContext.pix_fmt.
3172  *
3173  * This field should be set before avcodec_open2() is called.
3174  */
3176 
3177  /**
3178  * Control the form of AVSubtitle.rects[N]->ass
3179  * - decoding: set by user
3180  * - encoding: unused
3181  */
3183 #define FF_SUB_TEXT_FMT_ASS 0
3184 #if FF_API_ASS_TIMING
3185 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3186 #endif
3187 
3188  /**
3189  * Audio only. The amount of padding (in samples) appended by the encoder to
3190  * the end of the audio. I.e. this number of decoded samples must be
3191  * discarded by the caller from the end of the stream to get the original
3192  * audio without any trailing padding.
3193  *
3194  * - decoding: unused
3195  * - encoding: unused
3196  */
3198 
3199  /**
3200  * The number of pixels per image to maximally accept.
3201  *
3202  * - decoding: set by user
3203  * - encoding: set by user
3204  */
3205  int64_t max_pixels;
3206 
3207  /**
3208  * A reference to the AVHWDeviceContext describing the device which will
3209  * be used by a hardware encoder/decoder. The reference is set by the
3210  * caller and afterwards owned (and freed) by libavcodec.
3211  *
3212  * This should be used if either the codec device does not require
3213  * hardware frames or any that are used are to be allocated internally by
3214  * libavcodec. If the user wishes to supply any of the frames used as
3215  * encoder input or decoder output then hw_frames_ctx should be used
3216  * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3217  * field will be ignored while decoding the associated stream segment, but
3218  * may again be used on a following one after another get_format() call.
3219  *
3220  * For both encoders and decoders this field should be set before
3221  * avcodec_open2() is called and must not be written to thereafter.
3222  *
3223  * Note that some decoders may require this field to be set initially in
3224  * order to support hw_frames_ctx at all - in that case, all frames
3225  * contexts used must be created on the same device.
3226  */
3228 
3229  /**
3230  * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3231  * decoding (if active).
3232  * - encoding: unused
3233  * - decoding: Set by user (either before avcodec_open2(), or in the
3234  * AVCodecContext.get_format callback)
3235  */
3237 
3238  /**
3239  * Video decoding only. Certain video codecs support cropping, meaning that
3240  * only a sub-rectangle of the decoded frame is intended for display. This
3241  * option controls how cropping is handled by libavcodec.
3242  *
3243  * When set to 1 (the default), libavcodec will apply cropping internally.
3244  * I.e. it will modify the output frame width/height fields and offset the
3245  * data pointers (only by as much as possible while preserving alignment, or
3246  * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3247  * the frames output by the decoder refer only to the cropped area. The
3248  * crop_* fields of the output frames will be zero.
3249  *
3250  * When set to 0, the width/height fields of the output frames will be set
3251  * to the coded dimensions and the crop_* fields will describe the cropping
3252  * rectangle. Applying the cropping is left to the caller.
3253  *
3254  * @warning When hardware acceleration with opaque output frames is used,
3255  * libavcodec is unable to apply cropping from the top/left border.
3256  *
3257  * @note when this option is set to zero, the width/height fields of the
3258  * AVCodecContext and output AVFrames have different meanings. The codec
3259  * context fields store display dimensions (with the coded dimensions in
3260  * coded_width/height), while the frame fields store the coded dimensions
3261  * (with the display dimensions being determined by the crop_* fields).
3262  */
3264 
3265  /*
3266  * Video decoding only. Sets the number of extra hardware frames which
3267  * the decoder will allocate for use by the caller. This must be set
3268  * before avcodec_open2() is called.
3269  *
3270  * Some hardware decoders require all frames that they will use for
3271  * output to be defined in advance before decoding starts. For such
3272  * decoders, the hardware frame pool must therefore be of a fixed size.
3273  * The extra frames set here are on top of any number that the decoder
3274  * needs internally in order to operate normally (for example, frames
3275  * used as reference pictures).
3276  */
3278 } AVCodecContext;
3279 
3280 #if FF_API_CODEC_GET_SET
3281 /**
3282  * Accessors for some AVCodecContext fields. These used to be provided for ABI
3283  * compatibility, and do not need to be used anymore.
3284  */
3289 
3294 
3296 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3297 
3298 #if FF_API_LOWRES
3300 int av_codec_get_lowres(const AVCodecContext *avctx);
3302 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3303 #endif
3304 
3306 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3308 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3309 
3311 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3313 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3314 #endif
3315 
3316 /**
3317  * AVProfile.
3318  */
3319 typedef struct AVProfile {
3320  int profile;
3321  const char *name; ///< short name for the profile
3322 } AVProfile;
3323 
3324 enum {
3325  /**
3326  * The codec supports this format via the hw_device_ctx interface.
3327  *
3328  * When selecting this format, AVCodecContext.hw_device_ctx should
3329  * have been set to a device of the specified type before calling
3330  * avcodec_open2().
3331  */
3333  /**
3334  * The codec supports this format via the hw_frames_ctx interface.
3335  *
3336  * When selecting this format for a decoder,
3337  * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3338  * context inside the get_format() callback. The frames context
3339  * must have been created on a device of the specified type.
3340  */
3342  /**
3343  * The codec supports this format by some internal method.
3344  *
3345  * This format can be selected without any additional configuration -
3346  * no device or frames context is required.
3347  */
3349  /**
3350  * The codec supports this format by some ad-hoc method.
3351  *
3352  * Additional settings and/or function calls are required. See the
3353  * codec-specific documentation for details. (Methods requiring
3354  * this sort of configuration are deprecated and others should be
3355  * used in preference.)
3356  */
3358 };
3359 
3360 typedef struct AVCodecHWConfig {
3361  /**
3362  * A hardware pixel format which the codec can use.
3363  */
3365  /**
3366  * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3367  * setup methods which can be used with this configuration.
3368  */
3369  int methods;
3370  /**
3371  * The device type associated with the configuration.
3372  *
3373  * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3374  * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3375  */
3377 } AVCodecHWConfig;
3378 
3379 typedef struct AVCodecDefault AVCodecDefault;
3380 
3381 struct AVSubtitle;
3382 
3383 /**
3384  * AVCodec.
3385  */
3386 typedef struct AVCodec {
3387  /**
3388  * Name of the codec implementation.
3389  * The name is globally unique among encoders and among decoders (but an
3390  * encoder and a decoder can share the same name).
3391  * This is the primary way to find a codec from the user perspective.
3392  */
3393  const char *name;
3394  /**
3395  * Descriptive name for the codec, meant to be more human readable than name.
3396  * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3397  */
3398  const char *long_name;
3401  /**
3402  * Codec capabilities.
3403  * see AV_CODEC_CAP_*
3404  */
3406  const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3407  const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3408  const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3409  const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3410  const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3411  uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3412  const AVClass *priv_class; ///< AVClass for the private context
3413  const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3414 
3415  /**
3416  * Group name of the codec implementation.
3417  * This is a short symbolic name of the wrapper backing this codec. A
3418  * wrapper uses some kind of external implementation for the codec, such
3419  * as an external library, or a codec implementation provided by the OS or
3420  * the hardware.
3421  * If this field is NULL, this is a builtin, libavcodec native codec.
3422  * If non-NULL, this will be the suffix in AVCodec.name in most cases
3423  * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3424  */
3425  const char *wrapper_name;
3426 
3427  /*****************************************************************
3428  * No fields below this line are part of the public API. They
3429  * may not be used outside of libavcodec and can be changed and
3430  * removed at will.
3431  * New public fields should be added right above.
3432  *****************************************************************
3433  */
3435  struct AVCodec *next;
3436  /**
3437  * @name Frame-level threading support functions
3438  * @{
3439  */
3440  /**
3441  * If defined, called on thread contexts when they are created.
3442  * If the codec allocates writable tables in init(), re-allocate them here.
3443  * priv_data will be set to a copy of the original.
3444  */
3446  /**
3447  * Copy necessary context variables from a previous thread context to the current one.
3448  * If not defined, the next thread will start automatically; otherwise, the codec
3449  * must call ff_thread_finish_setup().
3450  *
3451  * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3452  */
3454  /** @} */
3455 
3456  /**
3457  * Private codec-specific defaults.
3458  */
3460 
3461  /**
3462  * Initialize codec static data, called from avcodec_register().
3463  *
3464  * This is not intended for time consuming operations as it is
3465  * run for every codec regardless of that codec being used.
3466  */
3467  void (*init_static_data)(struct AVCodec *codec);
3468 
3470  int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3471  const struct AVSubtitle *sub);
3472  /**
3473  * Encode data to an AVPacket.
3474  *
3475  * @param avctx codec context
3476  * @param avpkt output AVPacket (may contain a user-provided buffer)
3477  * @param[in] frame AVFrame containing the raw data to be encoded
3478  * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3479  * non-empty packet was returned in avpkt.
3480  * @return 0 on success, negative error code on failure
3481  */
3482  int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3483  int *got_packet_ptr);
3484  int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3486  /**
3487  * Encode API with decoupled packet/frame dataflow. The API is the
3488  * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3489  * that:
3490  * - never called if the codec is closed or the wrong type,
3491  * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3492  * - only one drain frame is ever passed down,
3493  */
3496 
3497  /**
3498  * Decode API with decoupled packet/frame dataflow. This function is called
3499  * to get one output frame. It should call ff_decode_get_packet() to obtain
3500  * input data.
3501  */
3503  /**
3504  * Flush buffers.
3505  * Will be called when seeking
3506  */
3508  /**
3509  * Internal codec capabilities.
3510  * See FF_CODEC_CAP_* in internal.h
3511  */
3513 
3514  /**
3515  * Decoding only, a comma-separated list of bitstream filters to apply to
3516  * packets before decoding.
3517  */
3518  const char *bsfs;
3519 
3520  /**
3521  * Array of pointers to hardware configurations supported by the codec,
3522  * or NULL if no hardware supported. The array is terminated by a NULL
3523  * pointer.
3524  *
3525  * The user can only access this field via avcodec_get_hw_config().
3526  */
3528 } AVCodec;
3529 
3530 #if FF_API_CODEC_GET_SET
3532 int av_codec_get_max_lowres(const AVCodec *codec);
3533 #endif
3534 
3535 struct MpegEncContext;
3536 
3537 /**
3538  * Retrieve supported hardware configurations for a codec.
3539  *
3540  * Values of index from zero to some maximum return the indexed configuration
3541  * descriptor; all other values return NULL. If the codec does not support
3542  * any hardware configurations then it will always return NULL.
3543  */
3544 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3545 
3546 /**
3547  * @defgroup lavc_hwaccel AVHWAccel
3548  *
3549  * @note Nothing in this structure should be accessed by the user. At some
3550  * point in future it will not be externally visible at all.
3551  *
3552  * @{
3553  */
3554 typedef struct AVHWAccel {
3555  /**
3556  * Name of the hardware accelerated codec.
3557  * The name is globally unique among encoders and among decoders (but an
3558  * encoder and a decoder can share the same name).
3559  */
3560  const char *name;
3561 
3562  /**
3563  * Type of codec implemented by the hardware accelerator.
3564  *
3565  * See AVMEDIA_TYPE_xxx
3566  */
3568 
3569  /**
3570  * Codec implemented by the hardware accelerator.
3571  *
3572  * See AV_CODEC_ID_xxx
3573  */
3575 
3576  /**
3577  * Supported pixel format.
3578  *
3579  * Only hardware accelerated formats are supported here.
3580  */
3582 
3583  /**
3584  * Hardware accelerated codec capabilities.
3585  * see AV_HWACCEL_CODEC_CAP_*
3586  */
3588 
3589  /*****************************************************************
3590  * No fields below this line are part of the public API. They
3591  * may not be used outside of libavcodec and can be changed and
3592  * removed at will.
3593  * New public fields should be added right above.
3594  *****************************************************************
3595  */
3596 
3597  /**
3598  * Allocate a custom buffer
3599  */
3601 
3602  /**
3603  * Called at the beginning of each frame or field picture.
3604  *
3605  * Meaningful frame information (codec specific) is guaranteed to
3606  * be parsed at this point. This function is mandatory.
3607  *
3608  * Note that buf can be NULL along with buf_size set to 0.
3609  * Otherwise, this means the whole frame is available at this point.
3610  *
3611  * @param avctx the codec context
3612  * @param buf the frame data buffer base
3613  * @param buf_size the size of the frame in bytes
3614  * @return zero if successful, a negative value otherwise
3615  */
3616  int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3617 
3618  /**
3619  * Callback for parameter data (SPS/PPS/VPS etc).
3620  *
3621  * Useful for hardware decoders which keep persistent state about the
3622  * video parameters, and need to receive any changes to update that state.
3623  *
3624  * @param avctx the codec context
3625  * @param type the nal unit type
3626  * @param buf the nal unit data buffer
3627  * @param buf_size the size of the nal unit in bytes
3628  * @return zero if successful, a negative value otherwise
3629  */
3630  int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3631 
3632  /**
3633  * Callback for each slice.
3634  *
3635  * Meaningful slice information (codec specific) is guaranteed to
3636  * be parsed at this point. This function is mandatory.
3637  * The only exception is XvMC, that works on MB level.
3638  *
3639  * @param avctx the codec context
3640  * @param buf the slice data buffer base
3641  * @param buf_size the size of the slice in bytes
3642  * @return zero if successful, a negative value otherwise
3643  */
3644  int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3645 
3646  /**
3647  * Called at the end of each frame or field picture.
3648  *
3649  * The whole picture is parsed at this point and can now be sent
3650  * to the hardware accelerator. This function is mandatory.
3651  *
3652  * @param avctx the codec context
3653  * @return zero if successful, a negative value otherwise
3654  */
3656 
3657  /**
3658  * Size of per-frame hardware accelerator private data.
3659  *
3660  * Private data is allocated with av_mallocz() before
3661  * AVCodecContext.get_buffer() and deallocated after
3662  * AVCodecContext.release_buffer().
3663  */
3665 
3666  /**
3667  * Called for every Macroblock in a slice.
3668  *
3669  * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3670  * Instead of decoding to raw picture, MB parameters are
3671  * stored in an array provided by the video driver.
3672  *
3673  * @param s the mpeg context
3674  */
3676 
3677  /**
3678  * Initialize the hwaccel private data.
3679  *
3680  * This will be called from ff_get_format(), after hwaccel and
3681  * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3682  * is allocated.
3683  */
3685 
3686  /**
3687  * Uninitialize the hwaccel private data.
3688  *
3689  * This will be called from get_format() or avcodec_close(), after hwaccel
3690  * and hwaccel_context are already uninitialized.
3691  */
3693 
3694  /**
3695  * Size of the private data to allocate in
3696  * AVCodecInternal.hwaccel_priv_data.
3697  */
3699 
3700  /**
3701  * Internal hwaccel capabilities.
3702  */
3704 
3705  /**
3706  * Fill the given hw_frames context with current codec parameters. Called
3707  * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3708  * details.
3709  *
3710  * This CAN be called before AVHWAccel.init is called, and you must assume
3711  * that avctx->hwaccel_priv_data is invalid.
3712  */
3714 } AVHWAccel;
3715 
3716 /**
3717  * HWAccel is experimental and is thus avoided in favor of non experimental
3718  * codecs
3719  */
3720 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3721 
3722 /**
3723  * Hardware acceleration should be used for decoding even if the codec level
3724  * used is unknown or higher than the maximum supported level reported by the
3725  * hardware driver.
3726  *
3727  * It's generally a good idea to pass this flag unless you have a specific
3728  * reason not to, as hardware tends to under-report supported levels.
3729  */
3730 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3731 
3732 /**
3733  * Hardware acceleration can output YUV pixel formats with a different chroma
3734  * sampling than 4:2:0 and/or other than 8 bits per component.
3735  */
3736 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3737 
3738 /**
3739  * Hardware acceleration should still be attempted for decoding when the
3740  * codec profile does not match the reported capabilities of the hardware.
3741  *
3742  * For example, this can be used to try to decode baseline profile H.264
3743  * streams in hardware - it will often succeed, because many streams marked
3744  * as baseline profile actually conform to constrained baseline profile.
3745  *
3746  * @warning If the stream is actually not supported then the behaviour is
3747  * undefined, and may include returning entirely incorrect output
3748  * while indicating success.
3749  */
3750 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3751 
3752 /**
3753  * @}
3754  */
3755 
3756 #if FF_API_AVPICTURE
3757 /**
3758  * @defgroup lavc_picture AVPicture
3759  *
3760  * Functions for working with AVPicture
3761  * @{
3762  */
3763 
3764 /**
3765  * Picture data structure.
3766  *
3767  * Up to four components can be stored into it, the last component is
3768  * alpha.
3769  * @deprecated use AVFrame or imgutils functions instead
3770  */
3771 typedef struct AVPicture {
3773  uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3775  int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3776 } AVPicture;
3777 
3778 /**
3779  * @}
3780  */
3781 #endif
3782 
3785 
3786  SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3787 
3788  /**
3789  * Plain text, the text field must be set by the decoder and is
3790  * authoritative. ass and pict fields may contain approximations.
3791  */
3793 
3794  /**
3795  * Formatted text, the ass field must be set by the decoder and is
3796  * authoritative. pict and text fields may contain approximations.
3797  */
3799 };
3800 
3801 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3802 
3803 typedef struct AVSubtitleRect {
3804  int x; ///< top left corner of pict, undefined when pict is not set
3805  int y; ///< top left corner of pict, undefined when pict is not set
3806  int w; ///< width of pict, undefined when pict is not set
3807  int h; ///< height of pict, undefined when pict is not set
3808  int nb_colors; ///< number of colors in pict, undefined when pict is not set
3809 
3810 #if FF_API_AVPICTURE
3811  /**
3812  * @deprecated unused
3813  */
3816 #endif
3817  /**
3818  * data+linesize for the bitmap of this subtitle.
3819  * Can be set for text/ass as well once they are rendered.
3820  */
3822  int linesize[4];
3823 
3825 
3826  char *text; ///< 0 terminated plain UTF-8 text
3827 
3828  /**
3829  * 0 terminated ASS/SSA compatible event line.
3830  * The presentation of this is unaffected by the other values in this
3831  * struct.
3832  */
3833  char *ass;
3834 
3835  int flags;
3836 } AVSubtitleRect;
3837 
3838 typedef struct AVSubtitle {
3839  uint16_t format; /* 0 = graphics */
3840  uint32_t start_display_time; /* relative to packet pts, in ms */
3841  uint32_t end_display_time; /* relative to packet pts, in ms */
3842  unsigned num_rects;
3844  int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3845 } AVSubtitle;
3846 
3847 /**
3848  * This struct describes the properties of an encoded stream.
3849  *
3850  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3851  * be allocated with avcodec_parameters_alloc() and freed with
3852  * avcodec_parameters_free().
3853  */
3854 typedef struct AVCodecParameters {
3855  /**
3856  * General type of the encoded data.
3857  */
3859  /**
3860  * Specific type of the encoded data (the codec used).
3861  */
3863  /**
3864  * Additional information about the codec (corresponds to the AVI FOURCC).
3865  */
3866  uint32_t codec_tag;
3867 
3868  /**
3869  * Extra binary data needed for initializing the decoder, codec-dependent.
3870  *
3871  * Must be allocated with av_malloc() and will be freed by
3872  * avcodec_parameters_free(). The allocated size of extradata must be at
3873  * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3874  * bytes zeroed.
3875  */
3877  /**
3878  * Size of the extradata content in bytes.
3879  */
3881 
3882  /**
3883  * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3884  * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3885  */
3886  int format;
3887 
3888  /**
3889  * The average bitrate of the encoded data (in bits per second).
3890  */
3891  int64_t bit_rate;
3892 
3893  /**
3894  * The number of bits per sample in the codedwords.
3895  *
3896  * This is basically the bitrate per sample. It is mandatory for a bunch of
3897  * formats to actually decode them. It's the number of bits for one sample in
3898  * the actual coded bitstream.
3899  *
3900  * This could be for example 4 for ADPCM
3901  * For PCM formats this matches bits_per_raw_sample
3902  * Can be 0
3903  */
3905 
3906  /**
3907  * This is the number of valid bits in each output sample. If the
3908  * sample format has more bits, the least significant bits are additional
3909  * padding bits, which are always 0. Use right shifts to reduce the sample
3910  * to its actual size. For example, audio formats with 24 bit samples will
3911  * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3912  * To get the original sample use "(int32_t)sample >> 8"."
3913  *
3914  * For ADPCM this might be 12 or 16 or similar
3915  * Can be 0
3916  */
3918 
3919  /**
3920  * Codec-specific bitstream restrictions that the stream conforms to.
3921  */
3922  int profile;
3923  int level;
3924 
3925  /**
3926  * Video only. The dimensions of the video frame in pixels.
3927  */
3928  int width;
3929  int height;
3930 
3931  /**
3932  * Video only. The aspect ratio (width / height) which a single pixel
3933  * should have when displayed.
3934  *
3935  * When the aspect ratio is unknown / undefined, the numerator should be
3936  * set to 0 (the denominator may have any value).
3937  */
3939 
3940  /**
3941  * Video only. The order of the fields in interlaced video.
3942  */
3944 
3945  /**
3946  * Video only. Additional colorspace characteristics.
3947  */
3953 
3954  /**
3955  * Video only. Number of delayed frames.
3956  */
3958 
3959  /**
3960  * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3961  * unknown or unspecified, otherwise the number of bits set must be equal to
3962  * the channels field.
3963  */
3964  uint64_t channel_layout;
3965  /**
3966  * Audio only. The number of audio channels.
3967  */
3969  /**
3970  * Audio only. The number of audio samples per second.
3971  */
3973  /**
3974  * Audio only. The number of bytes per coded audio frame, required by some
3975  * formats.
3976  *
3977  * Corresponds to nBlockAlign in WAVEFORMATEX.
3978  */
3980  /**
3981  * Audio only. Audio frame size, if known. Required by some formats to be static.
3982  */
3984 
3985  /**
3986  * Audio only. The amount of padding (in samples) inserted by the encoder at
3987  * the beginning of the audio. I.e. this number of leading decoded samples
3988  * must be discarded by the caller to get the original audio without leading
3989  * padding.
3990  */
3992  /**
3993  * Audio only. The amount of padding (in samples) appended by the encoder to
3994  * the end of the audio. I.e. this number of decoded samples must be
3995  * discarded by the caller from the end of the stream to get the original
3996  * audio without any trailing padding.
3997  */
3999  /**
4000  * Audio only. Number of samples to skip after a discontinuity.
4001  */
4004 
4005 /**
4006  * Iterate over all registered codecs.
4007  *
4008  * @param opaque a pointer where libavcodec will store the iteration state. Must
4009  * point to NULL to start the iteration.
4010  *
4011  * @return the next registered codec or NULL when the iteration is
4012  * finished
4013  */
4014 const AVCodec *av_codec_iterate(void **opaque);
4015 
4016 #if FF_API_NEXT
4017 /**
4018  * If c is NULL, returns the first registered codec,
4019  * if c is non-NULL, returns the next registered codec after c,
4020  * or NULL if c is the last one.
4021  */
4023 AVCodec *av_codec_next(const AVCodec *c);
4024 #endif
4025 
4026 /**
4027  * Return the LIBAVCODEC_VERSION_INT constant.
4028  */
4029 unsigned avcodec_version(void);
4030 
4031 /**
4032  * Return the libavcodec build-time configuration.
4033  */
4034 const char *avcodec_configuration(void);
4035 
4036 /**
4037  * Return the libavcodec license.
4038  */
4039 const char *avcodec_license(void);
4040 
4041 #if FF_API_NEXT
4042 /**
4043  * Register the codec codec and initialize libavcodec.
4044  *
4045  * @warning either this function or avcodec_register_all() must be called
4046  * before any other libavcodec functions.
4047  *
4048  * @see avcodec_register_all()
4049  */
4051 void avcodec_register(AVCodec *codec);
4052 
4053 /**
4054  * Register all the codecs, parsers and bitstream filters which were enabled at
4055  * configuration time. If you do not call this function you can select exactly
4056  * which formats you want to support, by using the individual registration
4057  * functions.
4058  *
4059  * @see avcodec_register
4060  * @see av_register_codec_parser
4061  * @see av_register_bitstream_filter
4062  */
4064 void avcodec_register_all(void);
4065 #endif
4066 
4067 /**
4068  * Allocate an AVCodecContext and set its fields to default values. The
4069  * resulting struct should be freed with avcodec_free_context().
4070  *
4071  * @param codec if non-NULL, allocate private data and initialize defaults
4072  * for the given codec. It is illegal to then call avcodec_open2()
4073  * with a different codec.
4074  * If NULL, then the codec-specific defaults won't be initialized,
4075  * which may result in suboptimal default settings (this is
4076  * important mainly for encoders, e.g. libx264).
4077  *
4078  * @return An AVCodecContext filled with default values or NULL on failure.
4079  */
4081 
4082 /**
4083  * Free the codec context and everything associated with it and write NULL to
4084  * the provided pointer.
4085  */
4086 void avcodec_free_context(AVCodecContext **avctx);
4087 
4088 #if FF_API_GET_CONTEXT_DEFAULTS
4089 /**
4090  * @deprecated This function should not be used, as closing and opening a codec
4091  * context multiple time is not supported. A new codec context should be
4092  * allocated for each new use.
4093  */
4095 #endif
4096 
4097 /**
4098  * Get the AVClass for AVCodecContext. It can be used in combination with
4099  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4100  *
4101  * @see av_opt_find().
4102  */
4103 const AVClass *avcodec_get_class(void);
4104 
4105 #if FF_API_COPY_CONTEXT
4106 /**
4107  * Get the AVClass for AVFrame. It can be used in combination with
4108  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4109  *
4110  * @see av_opt_find().
4111  */
4112 const AVClass *avcodec_get_frame_class(void);
4113 
4114 /**
4115  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4116  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4117  *
4118  * @see av_opt_find().
4119  */
4121 
4122 /**
4123  * Copy the settings of the source AVCodecContext into the destination
4124  * AVCodecContext. The resulting destination codec context will be
4125  * unopened, i.e. you are required to call avcodec_open2() before you
4126  * can use this AVCodecContext to decode/encode video/audio data.
4127  *
4128  * @param dest target codec context, should be initialized with
4129  * avcodec_alloc_context3(NULL), but otherwise uninitialized
4130  * @param src source codec context
4131  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4132  *
4133  * @deprecated The semantics of this function are ill-defined and it should not
4134  * be used. If you need to transfer the stream parameters from one codec context
4135  * to another, use an intermediate AVCodecParameters instance and the
4136  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4137  * functions.
4138  */
4141 #endif
4142 
4143 /**
4144  * Allocate a new AVCodecParameters and set its fields to default values
4145  * (unknown/invalid/0). The returned struct must be freed with
4146  * avcodec_parameters_free().
4147  */
4149 
4150 /**
4151  * Free an AVCodecParameters instance and everything associated with it and
4152  * write NULL to the supplied pointer.
4153  */
4155 
4156 /**
4157  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4158  * replaced with newly allocated duplicates of the corresponding fields in src.
4159  *
4160  * @return >= 0 on success, a negative AVERROR code on failure.
4161  */
4163 
4164 /**
4165  * Fill the parameters struct based on the values from the supplied codec
4166  * context. Any allocated fields in par are freed and replaced with duplicates
4167  * of the corresponding fields in codec.
4168  *
4169  * @return >= 0 on success, a negative AVERROR code on failure
4170  */
4172  const AVCodecContext *codec);
4173 
4174 /**
4175  * Fill the codec context based on the values from the supplied codec
4176  * parameters. Any allocated fields in codec that have a corresponding field in
4177  * par are freed and replaced with duplicates of the corresponding field in par.
4178  * Fields in codec that do not have a counterpart in par are not touched.
4179  *
4180  * @return >= 0 on success, a negative AVERROR code on failure.
4181  */
4183  const AVCodecParameters *par);
4184 
4185 /**
4186  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4187  * function the context has to be allocated with avcodec_alloc_context3().
4188  *
4189  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4190  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4191  * retrieving a codec.
4192  *
4193  * @warning This function is not thread safe!
4194  *
4195  * @note Always call this function before using decoding routines (such as
4196  * @ref avcodec_receive_frame()).
4197  *
4198  * @code
4199  * avcodec_register_all();
4200  * av_dict_set(&opts, "b", "2.5M", 0);
4201  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4202  * if (!codec)
4203  * exit(1);
4204  *
4205  * context = avcodec_alloc_context3(codec);
4206  *
4207  * if (avcodec_open2(context, codec, opts) < 0)
4208  * exit(1);
4209  * @endcode
4210  *
4211  * @param avctx The context to initialize.
4212  * @param codec The codec to open this context for. If a non-NULL codec has been
4213  * previously passed to avcodec_alloc_context3() or
4214  * for this context, then this parameter MUST be either NULL or
4215  * equal to the previously passed codec.
4216  * @param options A dictionary filled with AVCodecContext and codec-private options.
4217  * On return this object will be filled with options that were not found.
4218  *
4219  * @return zero on success, a negative value on error
4220  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4221  * av_dict_set(), av_opt_find().
4222  */
4223 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4224 
4225 /**
4226  * Close a given AVCodecContext and free all the data associated with it
4227  * (but not the AVCodecContext itself).
4228  *
4229  * Calling this function on an AVCodecContext that hasn't been opened will free
4230  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4231  * codec. Subsequent calls will do nothing.
4232  *
4233  * @note Do not use this function. Use avcodec_free_context() to destroy a
4234  * codec context (either open or closed). Opening and closing a codec context
4235  * multiple times is not supported anymore -- use multiple codec contexts
4236  * instead.
4237  */
4238 int avcodec_close(AVCodecContext *avctx);
4239 
4240 /**
4241  * Free all allocated data in the given subtitle struct.
4242  *
4243  * @param sub AVSubtitle to free.
4244  */
4245 void avsubtitle_free(AVSubtitle *sub);
4246 
4247 /**
4248  * @}
4249  */
4250 
4251 /**
4252  * @addtogroup lavc_packet
4253  * @{
4254  */
4255 
4256 /**
4257  * Allocate an AVPacket and set its fields to default values. The resulting
4258  * struct must be freed using av_packet_free().
4259  *
4260  * @return An AVPacket filled with default values or NULL on failure.
4261  *
4262  * @note this only allocates the AVPacket itself, not the data buffers. Those
4263  * must be allocated through other means such as av_new_packet.
4264  *
4265  * @see av_new_packet
4266  */
4267 AVPacket *av_packet_alloc(void);
4268 
4269 /**
4270  * Create a new packet that references the same data as src.
4271  *
4272  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4273  *
4274  * @return newly created AVPacket on success, NULL on error.
4275  *
4276  * @see av_packet_alloc
4277  * @see av_packet_ref
4278  */
4280 
4281 /**
4282  * Free the packet, if the packet is reference counted, it will be
4283  * unreferenced first.
4284  *
4285  * @param pkt packet to be freed. The pointer will be set to NULL.
4286  * @note passing NULL is a no-op.
4287  */
4288 void av_packet_free(AVPacket **pkt);
4289 
4290 /**
4291  * Initialize optional fields of a packet with default values.
4292  *
4293  * Note, this does not touch the data and size members, which have to be
4294  * initialized separately.
4295  *
4296  * @param pkt packet
4297  */
4298 void av_init_packet(AVPacket *pkt);
4299 
4300 /**
4301  * Allocate the payload of a packet and initialize its fields with
4302  * default values.
4303  *
4304  * @param pkt packet
4305  * @param size wanted payload size
4306  * @return 0 if OK, AVERROR_xxx otherwise
4307  */
4308 int av_new_packet(AVPacket *pkt, int size);
4309 
4310 /**
4311  * Reduce packet size, correctly zeroing padding
4312  *
4313  * @param pkt packet
4314  * @param size new size
4315  */
4316 void av_shrink_packet(AVPacket *pkt, int size);
4317 
4318 /**
4319  * Increase packet size, correctly zeroing padding
4320  *
4321  * @param pkt packet
4322  * @param grow_by number of bytes by which to increase the size of the packet
4323  */
4324 int av_grow_packet(AVPacket *pkt, int grow_by);
4325 
4326 /**
4327  * Initialize a reference-counted packet from av_malloc()ed data.
4328  *
4329  * @param pkt packet to be initialized. This function will set the data, size,
4330  * buf and destruct fields, all others are left untouched.
4331  * @param data Data allocated by av_malloc() to be used as packet data. If this
4332  * function returns successfully, the data is owned by the underlying AVBuffer.
4333  * The caller may not access the data through other means.
4334  * @param size size of data in bytes, without the padding. I.e. the full buffer
4335  * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4336  *
4337  * @return 0 on success, a negative AVERROR on error
4338  */
4340 
4341 #if FF_API_AVPACKET_OLD_API
4342 /**
4343  * @warning This is a hack - the packet memory allocation stuff is broken. The
4344  * packet is allocated if it was not really allocated.
4345  *
4346  * @deprecated Use av_packet_ref
4347  */
4349 int av_dup_packet(AVPacket *pkt);
4350 /**
4351  * Copy packet, including contents
4352  *
4353  * @return 0 on success, negative AVERROR on fail
4354  *
4355  * @deprecated Use av_packet_ref
4356  */
4358 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4359 
4360 /**
4361  * Copy packet side data
4362  *
4363  * @return 0 on success, negative AVERROR on fail
4364  *
4365  * @deprecated Use av_packet_copy_props
4366  */
4368 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4369 
4370 /**
4371  * Free a packet.
4372  *
4373  * @deprecated Use av_packet_unref
4374  *
4375  * @param pkt packet to free
4376  */
4378 void av_free_packet(AVPacket *pkt);
4379 #endif
4380 /**
4381  * Allocate new information of a packet.
4382  *
4383  * @param pkt packet
4384  * @param type side information type
4385  * @param size side information size
4386  * @return pointer to fresh allocated data or NULL otherwise
4387  */
4389  int size);
4390 
4391 /**
4392  * Wrap an existing array as a packet side data.
4393  *
4394  * @param pkt packet
4395  * @param type side information type
4396  * @param data the side data array. It must be allocated with the av_malloc()
4397  * family of functions. The ownership of the data is transferred to
4398  * pkt.
4399  * @param size side information size
4400  * @return a non-negative number on success, a negative AVERROR code on
4401  * failure. On failure, the packet is unchanged and the data remains
4402  * owned by the caller.
4403  */
4405  uint8_t *data, size_t size);
4406 
4407 /**
4408  * Shrink the already allocated side data buffer
4409  *
4410  * @param pkt packet
4411  * @param type side information type
4412  * @param size new side information size
4413  * @return 0 on success, < 0 on failure
4414  */
4416  int size);
4417 
4418 /**
4419  * Get side information from packet.
4420  *
4421  * @param pkt packet
4422  * @param type desired side information type
4423  * @param size pointer for side information size to store (optional)
4424  * @return pointer to data if present or NULL otherwise
4425  */
4427  int *size);
4428 
4429 #if FF_API_MERGE_SD_API
4432 
4435 #endif
4436 
4438 
4439 /**
4440  * Pack a dictionary for use in side_data.
4441  *
4442  * @param dict The dictionary to pack.
4443  * @param size pointer to store the size of the returned data
4444  * @return pointer to data if successful, NULL otherwise
4445  */
4447 /**
4448  * Unpack a dictionary from side_data.
4449  *
4450  * @param data data from side_data
4451  * @param size size of the data
4452  * @param dict the metadata storage dictionary
4453  * @return 0 on success, < 0 on failure
4454  */
4455 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4456 
4457 
4458 /**
4459  * Convenience function to free all the side data stored.
4460  * All the other fields stay untouched.
4461  *
4462  * @param pkt packet
4463  */
4465 
4466 /**
4467  * Setup a new reference to the data described by a given packet
4468  *
4469  * If src is reference-counted, setup dst as a new reference to the
4470  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4471  * data from src into it.
4472  *
4473  * All the other fields are copied from src.
4474  *
4475  * @see av_packet_unref
4476  *
4477  * @param dst Destination packet
4478  * @param src Source packet
4479  *
4480  * @return 0 on success, a negative AVERROR on error.
4481  */
4482 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4483 
4484 /**
4485  * Wipe the packet.
4486  *
4487  * Unreference the buffer referenced by the packet and reset the
4488  * remaining packet fields to their default values.
4489  *
4490  * @param pkt The packet to be unreferenced.
4491  */
4493 
4494 /**
4495  * Move every field in src to dst and reset src.
4496  *
4497  * @see av_packet_unref
4498  *
4499  * @param src Source packet, will be reset
4500  * @param dst Destination packet
4501  */
4503 
4504 /**
4505  * Copy only "properties" fields from src to dst.
4506  *
4507  * Properties for the purpose of this function are all the fields
4508  * beside those related to the packet data (buf, data, size)
4509  *
4510  * @param dst Destination packet
4511  * @param src Source packet
4512  *
4513  * @return 0 on success AVERROR on failure.
4514  */
4515 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4516 
4517 /**
4518  * Convert valid timing fields (timestamps / durations) in a packet from one
4519  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4520  * ignored.
4521  *
4522  * @param pkt packet on which the conversion will be performed
4523  * @param tb_src source timebase, in which the timing fields in pkt are
4524  * expressed
4525  * @param tb_dst destination timebase, to which the timing fields will be
4526  * converted
4527  */
4528 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4529 
4530 /**
4531  * @}
4532  */
4533 
4534 /**
4535  * @addtogroup lavc_decoding
4536  * @{
4537  */
4538 
4539 /**
4540  * Find a registered decoder with a matching codec ID.
4541  *
4542  * @param id AVCodecID of the requested decoder
4543  * @return A decoder if one was found, NULL otherwise.
4544  */
4546 
4547 /**
4548  * Find a registered decoder with the specified name.
4549  *
4550  * @param name name of the requested decoder
4551  * @return A decoder if one was found, NULL otherwise.
4552  */
4554 
4555 /**
4556  * The default callback for AVCodecContext.get_buffer2(). It is made public so
4557  * it can be called by custom get_buffer2() implementations for decoders without
4558  * AV_CODEC_CAP_DR1 set.
4559  */
4561 
4562 /**
4563  * Modify width and height values so that they will result in a memory
4564  * buffer that is acceptable for the codec if you do not use any horizontal
4565  * padding.
4566  *
4567  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4568  */
4570 
4571 /**
4572  * Modify width and height values so that they will result in a memory
4573  * buffer that is acceptable for the codec if you also ensure that all
4574  * line sizes are a multiple of the respective linesize_align[i].
4575  *
4576  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4577  */
4579  int linesize_align[AV_NUM_DATA_POINTERS]);
4580 
4581 /**
4582  * Converts AVChromaLocation to swscale x/y chroma position.
4583  *
4584  * The positions represent the chroma (0,0) position in a coordinates system
4585  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4586  *
4587  * @param xpos horizontal chroma sample position
4588  * @param ypos vertical chroma sample position
4589  */
4590 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4591 
4592 /**
4593  * Converts swscale x/y chroma position to AVChromaLocation.
4594  *
4595  * The positions represent the chroma (0,0) position in a coordinates system
4596  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4597  *
4598  * @param xpos horizontal chroma sample position
4599  * @param ypos vertical chroma sample position
4600  */
4601 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4602 
4603 /**
4604  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4605  *
4606  * Some decoders may support multiple frames in a single AVPacket. Such
4607  * decoders would then just decode the first frame and the return value would be
4608  * less than the packet size. In this case, avcodec_decode_audio4 has to be
4609  * called again with an AVPacket containing the remaining data in order to
4610  * decode the second frame, etc... Even if no frames are returned, the packet
4611  * needs to be fed to the decoder with remaining data until it is completely
4612  * consumed or an error occurs.
4613  *
4614  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4615  * and output. This means that for some packets they will not immediately
4616  * produce decoded output and need to be flushed at the end of decoding to get
4617  * all the decoded data. Flushing is done by calling this function with packets
4618  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4619  * returning samples. It is safe to flush even those decoders that are not
4620  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4621  *
4622  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4623  * larger than the actual read bytes because some optimized bitstream
4624  * readers read 32 or 64 bits at once and could read over the end.
4625  *
4626  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4627  * before packets may be fed to the decoder.
4628  *
4629  * @param avctx the codec context
4630  * @param[out] frame The AVFrame in which to store decoded audio samples.
4631  * The decoder will allocate a buffer for the decoded frame by
4632  * calling the AVCodecContext.get_buffer2() callback.
4633  * When AVCodecContext.refcounted_frames is set to 1, the frame is
4634  * reference counted and the returned reference belongs to the
4635  * caller. The caller must release the frame using av_frame_unref()
4636  * when the frame is no longer needed. The caller may safely write
4637  * to the frame if av_frame_is_writable() returns 1.
4638  * When AVCodecContext.refcounted_frames is set to 0, the returned
4639  * reference belongs to the decoder and is valid only until the
4640  * next call to this function or until closing or flushing the
4641  * decoder. The caller may not write to it.
4642  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4643  * non-zero. Note that this field being set to zero
4644  * does not mean that an error has occurred. For
4645  * decoders with AV_CODEC_CAP_DELAY set, no given decode
4646  * call is guaranteed to produce a frame.
4647  * @param[in] avpkt The input AVPacket containing the input buffer.
4648  * At least avpkt->data and avpkt->size should be set. Some
4649  * decoders might also require additional fields to be set.
4650  * @return A negative error code is returned if an error occurred during
4651  * decoding, otherwise the number of bytes consumed from the input
4652  * AVPacket is returned.
4653  *
4654 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4655  */
4658  int *got_frame_ptr, const AVPacket *avpkt);
4659 
4660 /**
4661  * Decode the video frame of size avpkt->size from avpkt->data into picture.
4662  * Some decoders may support multiple frames in a single AVPacket, such
4663  * decoders would then just decode the first frame.
4664  *
4665  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4666  * the actual read bytes because some optimized bitstream readers read 32 or 64
4667  * bits at once and could read over the end.
4668  *
4669  * @warning The end of the input buffer buf should be set to 0 to ensure that
4670  * no overreading happens for damaged MPEG streams.
4671  *
4672  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4673  * between input and output, these need to be fed with avpkt->data=NULL,
4674  * avpkt->size=0 at the end to return the remaining frames.
4675  *
4676  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4677  * before packets may be fed to the decoder.
4678  *
4679  * @param avctx the codec context
4680  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4681  * Use av_frame_alloc() to get an AVFrame. The codec will
4682  * allocate memory for the actual bitmap by calling the
4683  * AVCodecContext.get_buffer2() callback.
4684  * When AVCodecContext.refcounted_frames is set to 1, the frame is
4685  * reference counted and the returned reference belongs to the
4686  * caller. The caller must release the frame using av_frame_unref()
4687  * when the frame is no longer needed. The caller may safely write
4688  * to the frame if av_frame_is_writable() returns 1.
4689  * When AVCodecContext.refcounted_frames is set to 0, the returned
4690  * reference belongs to the decoder and is valid only until the
4691  * next call to this function or until closing or flushing the
4692  * decoder. The caller may not write to it.
4693  *
4694  * @param[in] avpkt The input AVPacket containing the input buffer.
4695  * You can create such packet with av_init_packet() and by then setting
4696  * data and size, some decoders might in addition need other fields like
4697  * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4698  * fields possible.
4699  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4700  * @return On error a negative value is returned, otherwise the number of bytes
4701  * used or zero if no frame could be decompressed.
4702  *
4703  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4704  */
4706 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4707  int *got_picture_ptr,
4708  const AVPacket *avpkt);
4709 
4710 /**
4711  * Decode a subtitle message.
4712  * Return a negative value on error, otherwise return the number of bytes used.
4713  * If no subtitle could be decompressed, got_sub_ptr is zero.
4714  * Otherwise, the subtitle is stored in *sub.
4715  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4716  * simplicity, because the performance difference is expect to be negligible
4717  * and reusing a get_buffer written for video codecs would probably perform badly
4718  * due to a potentially very different allocation pattern.
4719  *
4720  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4721  * and output. This means that for some packets they will not immediately
4722  * produce decoded output and need to be flushed at the end of decoding to get
4723  * all the decoded data. Flushing is done by calling this function with packets
4724  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4725  * returning subtitles. It is safe to flush even those decoders that are not
4726  * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4727  *
4728  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4729  * before packets may be fed to the decoder.
4730  *
4731  * @param avctx the codec context
4732  * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4733  * must be freed with avsubtitle_free if *got_sub_ptr is set.
4734  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4735  * @param[in] avpkt The input AVPacket containing the input buffer.
4736  */
4738  int *got_sub_ptr,
4739  AVPacket *avpkt);
4740 
4741 /**
4742  * Supply raw packet data as input to a decoder.
4743  *
4744  * Internally, this call will copy relevant AVCodecContext fields, which can
4745  * influence decoding per-packet, and apply them when the packet is actually
4746  * decoded. (For example AVCodecContext.skip_frame, which might direct the
4747  * decoder to drop the frame contained by the packet sent with this function.)
4748  *
4749  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4750  * larger than the actual read bytes because some optimized bitstream
4751  * readers read 32 or 64 bits at once and could read over the end.
4752  *
4753  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4754  * on the same AVCodecContext. It will return unexpected results now
4755  * or in future libavcodec versions.
4756  *
4757  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4758  * before packets may be fed to the decoder.
4759  *
4760  * @param avctx codec context
4761  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4762  * frame, or several complete audio frames.
4763  * Ownership of the packet remains with the caller, and the
4764  * decoder will not write to the packet. The decoder may create
4765  * a reference to the packet data (or copy it if the packet is
4766  * not reference-counted).
4767  * Unlike with older APIs, the packet is always fully consumed,
4768  * and if it contains multiple frames (e.g. some audio codecs),
4769  * will require you to call avcodec_receive_frame() multiple
4770  * times afterwards before you can send a new packet.
4771  * It can be NULL (or an AVPacket with data set to NULL and
4772  * size set to 0); in this case, it is considered a flush
4773  * packet, which signals the end of the stream. Sending the
4774  * first flush packet will return success. Subsequent ones are
4775  * unnecessary and will return AVERROR_EOF. If the decoder
4776  * still has frames buffered, it will return them after sending
4777  * a flush packet.
4778  *
4779  * @return 0 on success, otherwise negative error code:
4780  * AVERROR(EAGAIN): input is not accepted in the current state - user
4781  * must read output with avcodec_receive_frame() (once
4782  * all output is read, the packet should be resent, and
4783  * the call will not fail with EAGAIN).
4784  * AVERROR_EOF: the decoder has been flushed, and no new packets can
4785  * be sent to it (also returned if more than 1 flush
4786  * packet is sent)
4787  * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4788  * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4789  * other errors: legitimate decoding errors
4790  */
4791 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4792 
4793 /**
4794  * Return decoded output data from a decoder.
4795  *
4796  * @param avctx codec context
4797  * @param frame This will be set to a reference-counted video or audio
4798  * frame (depending on the decoder type) allocated by the
4799  * decoder. Note that the function will always call
4800  * av_frame_unref(frame) before doing anything else.
4801  *
4802  * @return
4803  * 0: success, a frame was returned
4804  * AVERROR(EAGAIN): output is not available in this state - user must try
4805  * to send new input
4806  * AVERROR_EOF: the decoder has been fully flushed, and there will be
4807  * no more output frames
4808  * AVERROR(EINVAL): codec not opened, or it is an encoder
4809  * other negative values: legitimate decoding errors
4810  */
4812 
4813 /**
4814  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4815  * to retrieve buffered output packets.
4816  *
4817  * @param avctx codec context
4818  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4819  * Ownership of the frame remains with the caller, and the
4820  * encoder will not write to the frame. The encoder may create
4821  * a reference to the frame data (or copy it if the frame is
4822  * not reference-counted).
4823  * It can be NULL, in which case it is considered a flush
4824  * packet. This signals the end of the stream. If the encoder
4825  * still has packets buffered, it will return them after this
4826  * call. Once flushing mode has been entered, additional flush
4827  * packets are ignored, and sending frames will return
4828  * AVERROR_EOF.
4829  *
4830  * For audio:
4831  * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4832  * can have any number of samples.
4833  * If it is not set, frame->nb_samples must be equal to
4834  * avctx->frame_size for all frames except the last.
4835  * The final frame may be smaller than avctx->frame_size.
4836  * @return 0 on success, otherwise negative error code:
4837  * AVERROR(EAGAIN): input is not accepted in the current state - user
4838  * must read output with avcodec_receive_packet() (once
4839  * all output is read, the packet should be resent, and
4840  * the call will not fail with EAGAIN).
4841  * AVERROR_EOF: the encoder has been flushed, and no new frames can
4842  * be sent to it
4843  * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4844  * decoder, or requires flush
4845  * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4846  * other errors: legitimate decoding errors
4847  */
4848 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4849 
4850 /**
4851  * Read encoded data from the encoder.
4852  *
4853  * @param avctx codec context
4854  * @param avpkt This will be set to a reference-counted packet allocated by the
4855  * encoder. Note that the function will always call
4856  * av_frame_unref(frame) before doing anything else.
4857  * @return 0 on success, otherwise negative error code:
4858  * AVERROR(EAGAIN): output is not available in the current state - user
4859  * must try to send input
4860  * AVERROR_EOF: the encoder has been fully flushed, and there will be
4861  * no more output packets
4862  * AVERROR(EINVAL): codec not opened, or it is an encoder
4863  * other errors: legitimate decoding errors
4864  */
4865 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4866 
4867 /**
4868  * Create and return a AVHWFramesContext with values adequate for hardware
4869  * decoding. This is meant to get called from the get_format callback, and is
4870  * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4871  * This API is for decoding with certain hardware acceleration modes/APIs only.
4872  *
4873  * The returned AVHWFramesContext is not initialized. The caller must do this
4874  * with av_hwframe_ctx_init().
4875  *
4876  * Calling this function is not a requirement, but makes it simpler to avoid
4877  * codec or hardware API specific details when manually allocating frames.
4878  *
4879  * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4880  * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4881  * it unnecessary to call this function or having to care about
4882  * AVHWFramesContext initialization at all.
4883  *
4884  * There are a number of requirements for calling this function:
4885  *
4886  * - It must be called from get_format with the same avctx parameter that was
4887  * passed to get_format. Calling it outside of get_format is not allowed, and
4888  * can trigger undefined behavior.
4889  * - The function is not always supported (see description of return values).
4890  * Even if this function returns successfully, hwaccel initialization could
4891  * fail later. (The degree to which implementations check whether the stream
4892  * is actually supported varies. Some do this check only after the user's
4893  * get_format callback returns.)
4894  * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4895  * user decides to use a AVHWFramesContext prepared with this API function,
4896  * the user must return the same hw_pix_fmt from get_format.
4897  * - The device_ref passed to this function must support the given hw_pix_fmt.
4898  * - After calling this API function, it is the user's responsibility to
4899  * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4900  * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4901  * before returning from get_format (this is implied by the normal
4902  * AVCodecContext.hw_frames_ctx API rules).
4903  * - The AVHWFramesContext parameters may change every time time get_format is
4904  * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4905  * you are inherently required to go through this process again on every
4906  * get_format call.
4907  * - It is perfectly possible to call this function without actually using
4908  * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4909  * previously initialized AVHWFramesContext, and calling this API function
4910  * only to test whether the required frame parameters have changed.
4911  * - Fields that use dynamically allocated values of any kind must not be set
4912  * by the user unless setting them is explicitly allowed by the documentation.
4913  * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4914  * the new free callback must call the potentially set previous free callback.
4915  * This API call may set any dynamically allocated fields, including the free
4916  * callback.
4917  *
4918  * The function will set at least the following fields on AVHWFramesContext
4919  * (potentially more, depending on hwaccel API):
4920  *
4921  * - All fields set by av_hwframe_ctx_alloc().
4922  * - Set the format field to hw_pix_fmt.
4923  * - Set the sw_format field to the most suited and most versatile format. (An
4924  * implication is that this will prefer generic formats over opaque formats
4925  * with arbitrary restrictions, if possible.)
4926  * - Set the width/height fields to the coded frame size, rounded up to the
4927  * API-specific minimum alignment.
4928  * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4929  * field to the number of maximum reference surfaces possible with the codec,
4930  * plus 1 surface for the user to work (meaning the user can safely reference
4931  * at most 1 decoded surface at a time), plus additional buffering introduced
4932  * by frame threading. If the hwaccel does not require pre-allocation, the
4933  * field is left to 0, and the decoder will allocate new surfaces on demand
4934  * during decoding.
4935  * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4936  * hardware API.
4937  *
4938  * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4939  * with basic frame parameters set.
4940  *
4941  * The function is stateless, and does not change the AVCodecContext or the
4942  * device_ref AVHWDeviceContext.
4943  *
4944  * @param avctx The context which is currently calling get_format, and which
4945  * implicitly contains all state needed for filling the returned
4946  * AVHWFramesContext properly.
4947  * @param device_ref A reference to the AVHWDeviceContext describing the device
4948  * which will be used by the hardware decoder.
4949  * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
4950  * @param out_frames_ref On success, set to a reference to an _uninitialized_
4951  * AVHWFramesContext, created from the given device_ref.
4952  * Fields will be set to values required for decoding.
4953  * Not changed if an error is returned.
4954  * @return zero on success, a negative value on error. The following error codes
4955  * have special semantics:
4956  * AVERROR(ENOENT): the decoder does not support this functionality. Setup
4957  * is always manual, or it is a decoder which does not
4958  * support setting AVCodecContext.hw_frames_ctx at all,
4959  * or it is a software format.
4960  * AVERROR(EINVAL): it is known that hardware decoding is not supported for
4961  * this configuration, or the device_ref is not supported
4962  * for the hwaccel referenced by hw_pix_fmt.
4963  */
4965  AVBufferRef *device_ref,
4967  AVBufferRef **out_frames_ref);
4968 
4969 
4970 
4971 /**
4972  * @defgroup lavc_parsing Frame parsing
4973  * @{
4974  */
4975 
4978  AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4979  AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4980  AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4981 };
4982 
4983 typedef struct AVCodecParserContext {
4984  void *priv_data;
4986  int64_t frame_offset; /* offset of the current frame */
4987  int64_t cur_offset; /* current offset
4988  (incremented by each av_parser_parse()) */
4989  int64_t next_frame_offset; /* offset of the next frame */
4990  /* video info */
4991  int pict_type; /* XXX: Put it back in AVCodecContext. */
4992  /**
4993  * This field is used for proper frame duration computation in lavf.
4994  * It signals, how much longer the frame duration of the current frame
4995  * is compared to normal frame duration.
4996  *
4997  * frame_duration = (1 + repeat_pict) * time_base
4998  *
4999  * It is used by codecs like H.264 to display telecined material.
5000  */
5001  int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5002  int64_t pts; /* pts of the current frame */
5003  int64_t dts; /* dts of the current frame */
5004 
5005  /* private data */
5006  int64_t last_pts;
5007  int64_t last_dts;
5009 
5010 #define AV_PARSER_PTS_NB 4
5015 
5016  int flags;
5017 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5018 #define PARSER_FLAG_ONCE 0x0002
5019 /// Set if the parser has a valid file offset
5020 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5021 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5022 
5023  int64_t offset; ///< byte offset from starting packet start
5025 
5026  /**
5027  * Set by parser to 1 for key frames and 0 for non-key frames.
5028  * It is initialized to -1, so if the parser doesn't set this flag,
5029  * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5030  * will be used.
5031  */
5033 
5034 #if FF_API_CONVERGENCE_DURATION
5035  /**
5036  * @deprecated unused
5037  */
5040 #endif
5041 
5042  // Timestamp generation support:
5043  /**
5044  * Synchronization point for start of timestamp generation.
5045  *
5046  * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5047  * (default).
5048  *
5049  * For example, this corresponds to presence of H.264 buffering period
5050  * SEI message.
5051  */
5053 
5054  /**
5055  * Offset of the current timestamp against last timestamp sync point in
5056  * units of AVCodecContext.time_base.
5057  *
5058  * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5059  * contain a valid timestamp offset.
5060  *
5061  * Note that the timestamp of sync point has usually a nonzero
5062  * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5063  * the next frame after timestamp sync point will be usually 1.
5064  *
5065  * For example, this corresponds to H.264 cpb_removal_delay.
5066  */
5068 
5069  /**
5070  * Presentation delay of current frame in units of AVCodecContext.time_base.
5071  *
5072  * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5073  * contain valid non-negative timestamp delta (presentation time of a frame
5074  * must not lie in the past).
5075  *
5076  * This delay represents the difference between decoding and presentation
5077  * time of the frame.
5078  *
5079  * For example, this corresponds to H.264 dpb_output_delay.
5080  */
5082 
5083  /**
5084  * Position of the packet in file.
5085  *
5086  * Analogous to cur_frame_pts/dts
5087  */
5089 
5090  /**
5091  * Byte position of currently parsed frame in stream.
5092  */
5093  int64_t pos;
5094 
5095  /**
5096  * Previous frame byte position.
5097  */
5098  int64_t last_pos;
5099 
5100  /**
5101  * Duration of the current frame.
5102  * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5103  * For all other types, this is in units of AVCodecContext.time_base.
5104  */
5106 
5108 
5109  /**
5110  * Indicate whether a picture is coded as a frame, top field or bottom field.
5111  *
5112  * For example, H.264 field_pic_flag equal to 0 corresponds to
5113  * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5114  * equal to 1 and bottom_field_flag equal to 0 corresponds to
5115  * AV_PICTURE_STRUCTURE_TOP_FIELD.
5116  */
5118 
5119  /**
5120  * Picture number incremented in presentation or output order.
5121  * This field may be reinitialized at the first picture of a new sequence.
5122  *
5123  * For example, this corresponds to H.264 PicOrderCnt.
5124  */
5126 
5127  /**
5128  * Dimensions of the decoded video intended for presentation.
5129  */
5130  int width;
5131  int height;
5132 
5133  /**
5134  * Dimensions of the coded video.
5135  */
5138 
5139  /**
5140  * The format of the coded data, corresponds to enum AVPixelFormat for video
5141  * and for enum AVSampleFormat for audio.
5142  *
5143  * Note that a decoder can have considerable freedom in how exactly it
5144  * decodes the data, so the format reported here might be different from the
5145  * one returned by a decoder.
5146  */
5147  int format;
5149 
5150 typedef struct AVCodecParser {
5151  int codec_ids[5]; /* several codec IDs are permitted */
5154  /* This callback never returns an error, a negative value means that
5155  * the frame start was in a previous packet. */
5157  AVCodecContext *avctx,
5158  const uint8_t **poutbuf, int *poutbuf_size,
5159  const uint8_t *buf, int buf_size);
5161  int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5163 } AVCodecParser;
5164 
5165 /**
5166  * Iterate over all registered codec parsers.
5167  *
5168  * @param opaque a pointer where libavcodec will store the iteration state. Must
5169  * point to NULL to start the iteration.
5170  *
5171  * @return the next registered codec parser or NULL when the iteration is
5172  * finished
5173  */
5174 const AVCodecParser *av_parser_iterate(void **opaque);
5175 
5178 
5182 
5183 /**
5184  * Parse a packet.
5185  *
5186  * @param s parser context.
5187  * @param avctx codec context.
5188  * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5189  * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5190  * @param buf input buffer.
5191  * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5192  size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5193  To signal EOF, this should be 0 (so that the last frame
5194  can be output).
5195  * @param pts input presentation timestamp.
5196  * @param dts input decoding timestamp.
5197  * @param pos input byte position in stream.
5198  * @return the number of bytes of the input bitstream used.
5199  *
5200  * Example:
5201  * @code
5202  * while(in_len){
5203  * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5204  * in_data, in_len,
5205  * pts, dts, pos);
5206  * in_data += len;
5207  * in_len -= len;
5208  *
5209  * if(size)
5210  * decode_frame(data, size);
5211  * }
5212  * @endcode
5213  */
5215  AVCodecContext *avctx,
5216  uint8_t **poutbuf, int *poutbuf_size,
5217  const uint8_t *buf, int buf_size,
5218  int64_t pts, int64_t dts,
5219  int64_t pos);
5220 
5221 /**
5222  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5223  * @deprecated use AVBitStreamFilter
5224  */
5226  AVCodecContext *avctx,
5227  uint8_t **poutbuf, int *poutbuf_size,
5228  const uint8_t *buf, int buf_size, int keyframe);
5230 
5231 /**
5232  * @}
5233  * @}
5234  */
5235 
5236 /**
5237  * @addtogroup lavc_encoding
5238  * @{
5239  */
5240 
5241 /**
5242  * Find a registered encoder with a matching codec ID.
5243  *
5244  * @param id AVCodecID of the requested encoder
5245  * @return An encoder if one was found, NULL otherwise.
5246  */
5248 
5249 /**
5250  * Find a registered encoder with the specified name.
5251  *
5252  * @param name name of the requested encoder
5253  * @return An encoder if one was found, NULL otherwise.
5254  */
5256 
5257 /**
5258  * Encode a frame of audio.
5259  *
5260  * Takes input samples from frame and writes the next output packet, if
5261  * available, to avpkt. The output packet does not necessarily contain data for
5262  * the most recent frame, as encoders can delay, split, and combine input frames
5263  * internally as needed.
5264  *
5265  * @param avctx codec context
5266  * @param avpkt output AVPacket.
5267  * The user can supply an output buffer by setting
5268  * avpkt->data and avpkt->size prior to calling the
5269  * function, but if the size of the user-provided data is not
5270  * large enough, encoding will fail. If avpkt->data and
5271  * avpkt->size are set, avpkt->destruct must also be set. All
5272  * other AVPacket fields will be reset by the encoder using
5273  * av_init_packet(). If avpkt->data is NULL, the encoder will
5274  * allocate it. The encoder will set avpkt->size to the size
5275  * of the output packet.
5276  *
5277  * If this function fails or produces no output, avpkt will be
5278  * freed using av_packet_unref().
5279  * @param[in] frame AVFrame containing the raw audio data to be encoded.
5280  * May be NULL when flushing an encoder that has the
5281  * AV_CODEC_CAP_DELAY capability set.
5282  * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5283  * can have any number of samples.
5284  * If it is not set, frame->nb_samples must be equal to
5285  * avctx->frame_size for all frames except the last.
5286  * The final frame may be smaller than avctx->frame_size.
5287  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5288  * output packet is non-empty, and to 0 if it is
5289  * empty. If the function returns an error, the
5290  * packet can be assumed to be invalid, and the
5291  * value of got_packet_ptr is undefined and should
5292  * not be used.
5293  * @return 0 on success, negative error code on failure
5294  *
5295  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5296  */
5298 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5299  const AVFrame *frame, int *got_packet_ptr);
5300 
5301 /**
5302  * Encode a frame of video.
5303  *
5304  * Takes input raw video data from frame and writes the next output packet, if
5305  * available, to avpkt. The output packet does not necessarily contain data for
5306  * the most recent frame, as encoders can delay and reorder input frames
5307  * internally as needed.
5308  *
5309  * @param avctx codec context
5310  * @param avpkt output AVPacket.
5311  * The user can supply an output buffer by setting
5312  * avpkt->data and avpkt->size prior to calling the
5313  * function, but if the size of the user-provided data is not
5314  * large enough, encoding will fail. All other AVPacket fields
5315  * will be reset by the encoder using av_init_packet(). If
5316  * avpkt->data is NULL, the encoder will allocate it.
5317  * The encoder will set avpkt->size to the size of the
5318  * output packet. The returned data (if any) belongs to the
5319  * caller, he is responsible for freeing it.
5320  *
5321  * If this function fails or produces no output, avpkt will be
5322  * freed using av_packet_unref().
5323  * @param[in] frame AVFrame containing the raw video data to be encoded.
5324  * May be NULL when flushing an encoder that has the
5325  * AV_CODEC_CAP_DELAY capability set.
5326  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5327  * output packet is non-empty, and to 0 if it is
5328  * empty. If the function returns an error, the
5329  * packet can be assumed to be invalid, and the
5330  * value of got_packet_ptr is undefined and should
5331  * not be used.
5332  * @return 0 on success, negative error code on failure
5333  *
5334  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5335  */
5337 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5338  const AVFrame *frame, int *got_packet_ptr);
5339