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