FFmpeg  3.2.10
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  * The number of side data elements (in fact a bit more than it).
1543  * This is not part of the public API/ABI in the sense that it may
1544  * change when new side data types are added.
1545  * This must stay the last enum value.
1546  * If its value becomes huge, some code using it
1547  * needs to be updated as it assumes it to be smaller than other limits.
1548  */
1550 };
1551 
1552 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1553 
1554 typedef struct AVPacketSideData {
1555  uint8_t *data;
1556  int size;
1559 
1560 /**
1561  * This structure stores compressed data. It is typically exported by demuxers
1562  * and then passed as input to decoders, or received as output from encoders and
1563  * then passed to muxers.
1564  *
1565  * For video, it should typically contain one compressed frame. For audio it may
1566  * contain several compressed frames. Encoders are allowed to output empty
1567  * packets, with no compressed data, containing only side data
1568  * (e.g. to update some stream parameters at the end of encoding).
1569  *
1570  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1571  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1572  * without libavcodec and libavformat major bump.
1573  *
1574  * The semantics of data ownership depends on the buf field.
1575  * If it is set, the packet data is dynamically allocated and is
1576  * valid indefinitely until a call to av_packet_unref() reduces the
1577  * reference count to 0.
1578  *
1579  * If the buf field is not set av_packet_ref() would make a copy instead
1580  * of increasing the reference count.
1581  *
1582  * The side data is always allocated with av_malloc(), copied by
1583  * av_packet_ref() and freed by av_packet_unref().
1584  *
1585  * @see av_packet_ref
1586  * @see av_packet_unref
1587  */
1588 typedef struct AVPacket {
1589  /**
1590  * A reference to the reference-counted buffer where the packet data is
1591  * stored.
1592  * May be NULL, then the packet data is not reference-counted.
1593  */
1595  /**
1596  * Presentation timestamp in AVStream->time_base units; the time at which
1597  * the decompressed packet will be presented to the user.
1598  * Can be AV_NOPTS_VALUE if it is not stored in the file.
1599  * pts MUST be larger or equal to dts as presentation cannot happen before
1600  * decompression, unless one wants to view hex dumps. Some formats misuse
1601  * the terms dts and pts/cts to mean something different. Such timestamps
1602  * must be converted to true pts/dts before they are stored in AVPacket.
1603  */
1604  int64_t pts;
1605  /**
1606  * Decompression timestamp in AVStream->time_base units; the time at which
1607  * the packet is decompressed.
1608  * Can be AV_NOPTS_VALUE if it is not stored in the file.
1609  */
1610  int64_t dts;
1611  uint8_t *data;
1612  int size;
1614  /**
1615  * A combination of AV_PKT_FLAG values
1616  */
1617  int flags;
1618  /**
1619  * Additional packet data that can be provided by the container.
1620  * Packet can contain several types of side information.
1621  */
1624 
1625  /**
1626  * Duration of this packet in AVStream->time_base units, 0 if unknown.
1627  * Equals next_pts - this_pts in presentation order.
1628  */
1629  int64_t duration;
1630 
1631  int64_t pos; ///< byte position in stream, -1 if unknown
1632 
1633 #if FF_API_CONVERGENCE_DURATION
1634  /**
1635  * @deprecated Same as the duration field, but as int64_t. This was required
1636  * for Matroska subtitles, whose duration values could overflow when the
1637  * duration field was still an int.
1638  */
1641 #endif
1642 } AVPacket;
1643 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1644 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1645 /**
1646  * Flag is used to discard packets which are required to maintain valid
1647  * decoder state but are not required for output and should be dropped
1648  * after decoding.
1649  **/
1650 #define AV_PKT_FLAG_DISCARD 0x0004
1651 
1657 };
1658 /**
1659  * @}
1660  */
1661 
1662 struct AVCodecInternal;
1663 
1667  AV_FIELD_TT, //< Top coded_first, top displayed first
1668  AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1669  AV_FIELD_TB, //< Top coded first, bottom displayed first
1670  AV_FIELD_BT, //< Bottom coded first, top displayed first
1671 };
1672 
1673 /**
1674  * main external API structure.
1675  * New fields can be added to the end with minor version bumps.
1676  * Removal, reordering and changes to existing fields require a major
1677  * version bump.
1678  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1679  * applications.
1680  * The name string for AVOptions options matches the associated command line
1681  * parameter name and can be found in libavcodec/options_table.h
1682  * The AVOption/command line parameter names differ in some cases from the C
1683  * structure field names for historic reasons or brevity.
1684  * sizeof(AVCodecContext) must not be used outside libav*.
1685  */
1686 typedef struct AVCodecContext {
1687  /**
1688  * information on struct for av_log
1689  * - set by avcodec_alloc_context3
1690  */
1693 
1694  enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1695  const struct AVCodec *codec;
1696 #if FF_API_CODEC_NAME
1697  /**
1698  * @deprecated this field is not used for anything in libavcodec
1699  */
1701  char codec_name[32];
1702 #endif
1703  enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1704 
1705  /**
1706  * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1707  * This is used to work around some encoder bugs.
1708  * A demuxer should set this to what is stored in the field used to identify the codec.
1709  * If there are multiple such fields in a container then the demuxer should choose the one
1710  * which maximizes the information about the used codec.
1711  * If the codec tag field in a container is larger than 32 bits then the demuxer should
1712  * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1713  * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1714  * first.
1715  * - encoding: Set by user, if not then the default based on codec_id will be used.
1716  * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1717  */
1718  unsigned int codec_tag;
1719 
1720 #if FF_API_STREAM_CODEC_TAG
1721  /**
1722  * @deprecated this field is unused
1723  */
1725  unsigned int stream_codec_tag;
1726 #endif
1727 
1728  void *priv_data;
1729 
1730  /**
1731  * Private context used for internal data.
1732  *
1733  * Unlike priv_data, this is not codec-specific. It is used in general
1734  * libavcodec functions.
1735  */
1736  struct AVCodecInternal *internal;
1737 
1738  /**
1739  * Private data of the user, can be used to carry app specific stuff.
1740  * - encoding: Set by user.
1741  * - decoding: Set by user.
1742  */
1743  void *opaque;
1744 
1745  /**
1746  * the average bitrate
1747  * - encoding: Set by user; unused for constant quantizer encoding.
1748  * - decoding: Set by user, may be overwritten by libavcodec
1749  * if this info is available in the stream
1750  */
1751  int64_t bit_rate;
1752 
1753  /**
1754  * number of bits the bitstream is allowed to diverge from the reference.
1755  * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1756  * - encoding: Set by user; unused for constant quantizer encoding.
1757  * - decoding: unused
1758  */
1760 
1761  /**
1762  * Global quality for codecs which cannot change it per frame.
1763  * This should be proportional to MPEG-1/2/4 qscale.
1764  * - encoding: Set by user.
1765  * - decoding: unused
1766  */
1768 
1769  /**
1770  * - encoding: Set by user.
1771  * - decoding: unused
1772  */
1774 #define FF_COMPRESSION_DEFAULT -1
1775 
1776  /**
1777  * AV_CODEC_FLAG_*.
1778  * - encoding: Set by user.
1779  * - decoding: Set by user.
1780  */
1781  int flags;
1782 
1783  /**
1784  * AV_CODEC_FLAG2_*
1785  * - encoding: Set by user.
1786  * - decoding: Set by user.
1787  */
1788  int flags2;
1789 
1790  /**
1791  * some codecs need / can use extradata like Huffman tables.
1792  * MJPEG: Huffman tables
1793  * rv10: additional flags
1794  * MPEG-4: global headers (they can be in the bitstream or here)
1795  * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1796  * than extradata_size to avoid problems if it is read with the bitstream reader.
1797  * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1798  * - encoding: Set/allocated/freed by libavcodec.
1799  * - decoding: Set/allocated/freed by user.
1800  */
1801  uint8_t *extradata;
1803 
1804  /**
1805  * This is the fundamental unit of time (in seconds) in terms
1806  * of which frame timestamps are represented. For fixed-fps content,
1807  * timebase should be 1/framerate and timestamp increments should be
1808  * identically 1.
1809  * This often, but not always is the inverse of the frame rate or field rate
1810  * for video. 1/time_base is not the average frame rate if the frame rate is not
1811  * constant.
1812  *
1813  * Like containers, elementary streams also can store timestamps, 1/time_base
1814  * is the unit in which these timestamps are specified.
1815  * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1816  * vop_time_increment_resolution and fixed_vop_rate
1817  * (fixed_vop_rate == 0 implies that it is different from the framerate)
1818  *
1819  * - encoding: MUST be set by user.
1820  * - decoding: the use of this field for decoding is deprecated.
1821  * Use framerate instead.
1822  */
1824 
1825  /**
1826  * For some codecs, the time base is closer to the field rate than the frame rate.
1827  * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1828  * if no telecine is used ...
1829  *
1830  * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1831  */
1833 
1834  /**
1835  * Codec delay.
1836  *
1837  * Encoding: Number of frames delay there will be from the encoder input to
1838  * the decoder output. (we assume the decoder matches the spec)
1839  * Decoding: Number of frames delay in addition to what a standard decoder
1840  * as specified in the spec would produce.
1841  *
1842  * Video:
1843  * Number of frames the decoded output will be delayed relative to the
1844  * encoded input.
1845  *
1846  * Audio:
1847  * For encoding, this field is unused (see initial_padding).
1848  *
1849  * For decoding, this is the number of samples the decoder needs to
1850  * output before the decoder's output is valid. When seeking, you should
1851  * start decoding this many samples prior to your desired seek point.
1852  *
1853  * - encoding: Set by libavcodec.
1854  * - decoding: Set by libavcodec.
1855  */
1856  int delay;
1857 
1858 
1859  /* video only */
1860  /**
1861  * picture width / height.
1862  *
1863  * @note Those fields may not match the values of the last
1864  * AVFrame output by avcodec_decode_video2 due frame
1865  * reordering.
1866  *
1867  * - encoding: MUST be set by user.
1868  * - decoding: May be set by the user before opening the decoder if known e.g.
1869  * from the container. Some decoders will require the dimensions
1870  * to be set by the caller. During decoding, the decoder may
1871  * overwrite those values as required while parsing the data.
1872  */
1874 
1875  /**
1876  * Bitstream width / height, may be different from width/height e.g. when
1877  * the decoded frame is cropped before being output or lowres is enabled.
1878  *
1879  * @note Those field may not match the value of the last
1880  * AVFrame output by avcodec_receive_frame() due frame
1881  * reordering.
1882  *
1883  * - encoding: unused
1884  * - decoding: May be set by the user before opening the decoder if known
1885  * e.g. from the container. During decoding, the decoder may
1886  * overwrite those values as required while parsing the data.
1887  */
1888  int coded_width, coded_height;
1889 
1890 #if FF_API_ASPECT_EXTENDED
1891 #define FF_ASPECT_EXTENDED 15
1892 #endif
1893 
1894  /**
1895  * the number of pictures in a group of pictures, or 0 for intra_only
1896  * - encoding: Set by user.
1897  * - decoding: unused
1898  */
1900 
1901  /**
1902  * Pixel format, see AV_PIX_FMT_xxx.
1903  * May be set by the demuxer if known from headers.
1904  * May be overridden by the decoder if it knows better.
1905  *
1906  * @note This field may not match the value of the last
1907  * AVFrame output by avcodec_receive_frame() due frame
1908  * reordering.
1909  *
1910  * - encoding: Set by user.
1911  * - decoding: Set by user if known, overridden by libavcodec while
1912  * parsing the data.
1913  */
1915 
1916 #if FF_API_MOTION_EST
1917  /**
1918  * This option does nothing
1919  * @deprecated use codec private options instead
1920  */
1922 #endif
1923 
1924  /**
1925  * If non NULL, 'draw_horiz_band' is called by the libavcodec
1926  * decoder to draw a horizontal band. It improves cache usage. Not
1927  * all codecs can do that. You must check the codec capabilities
1928  * beforehand.
1929  * When multithreading is used, it may be called from multiple threads
1930  * at the same time; threads might draw different parts of the same AVFrame,
1931  * or multiple AVFrames, and there is no guarantee that slices will be drawn
1932  * in order.
1933  * The function is also used by hardware acceleration APIs.
1934  * It is called at least once during frame decoding to pass
1935  * the data needed for hardware render.
1936  * In that mode instead of pixel data, AVFrame points to
1937  * a structure specific to the acceleration API. The application
1938  * reads the structure and can change some fields to indicate progress
1939  * or mark state.
1940  * - encoding: unused
1941  * - decoding: Set by user.
1942  * @param height the height of the slice
1943  * @param y the y position of the slice
1944  * @param type 1->top field, 2->bottom field, 3->frame
1945  * @param offset offset into the AVFrame.data from which the slice should be read
1946  */
1947  void (*draw_horiz_band)(struct AVCodecContext *s,
1948  const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1949  int y, int type, int height);
1950 
1951  /**
1952  * callback to negotiate the pixelFormat
1953  * @param fmt is the list of formats which are supported by the codec,
1954  * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1955  * The first is always the native one.
1956  * @note The callback may be called again immediately if initialization for
1957  * the selected (hardware-accelerated) pixel format failed.
1958  * @warning Behavior is undefined if the callback returns a value not
1959  * in the fmt list of formats.
1960  * @return the chosen format
1961  * - encoding: unused
1962  * - decoding: Set by user, if not set the native format will be chosen.
1963  */
1964  enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1965 
1966  /**
1967  * maximum number of B-frames between non-B-frames
1968  * Note: The output will be delayed by max_b_frames+1 relative to the input.
1969  * - encoding: Set by user.
1970  * - decoding: unused
1971  */
1973 
1974  /**
1975  * qscale factor between IP and B-frames
1976  * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1977  * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1978  * - encoding: Set by user.
1979  * - decoding: unused
1980  */
1982 
1983 #if FF_API_RC_STRATEGY
1984  /** @deprecated use codec private option instead */
1986 #define FF_RC_STRATEGY_XVID 1
1987 #endif
1988 
1989 #if FF_API_PRIVATE_OPT
1990  /** @deprecated use encoder private options instead */
1993 #endif
1994 
1995  /**
1996  * qscale offset between IP and B-frames
1997  * - encoding: Set by user.
1998  * - decoding: unused
1999  */
2001 
2002  /**
2003  * Size of the frame reordering buffer in the decoder.
2004  * For MPEG-2 it is 1 IPB or 0 low delay IP.
2005  * - encoding: Set by libavcodec.
2006  * - decoding: Set by libavcodec.
2007  */
2009 
2010 #if FF_API_PRIVATE_OPT
2011  /** @deprecated use encoder private options instead */
2014 #endif
2015 
2016  /**
2017  * qscale factor between P- and I-frames
2018  * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2019  * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2020  * - encoding: Set by user.
2021  * - decoding: unused
2022  */
2024 
2025  /**
2026  * qscale offset between P and I-frames
2027  * - encoding: Set by user.
2028  * - decoding: unused
2029  */
2031 
2032  /**
2033  * luminance masking (0-> disabled)
2034  * - encoding: Set by user.
2035  * - decoding: unused
2036  */
2038 
2039  /**
2040  * temporary complexity masking (0-> disabled)
2041  * - encoding: Set by user.
2042  * - decoding: unused
2043  */
2045 
2046  /**
2047  * spatial complexity masking (0-> disabled)
2048  * - encoding: Set by user.
2049  * - decoding: unused
2050  */
2052 
2053  /**
2054  * p block masking (0-> disabled)
2055  * - encoding: Set by user.
2056  * - decoding: unused
2057  */
2058  float p_masking;
2059 
2060  /**
2061  * darkness masking (0-> disabled)
2062  * - encoding: Set by user.
2063  * - decoding: unused
2064  */
2066 
2067  /**
2068  * slice count
2069  * - encoding: Set by libavcodec.
2070  * - decoding: Set by user (or 0).
2071  */
2073 
2074 #if FF_API_PRIVATE_OPT
2075  /** @deprecated use encoder private options instead */
2078 #define FF_PRED_LEFT 0
2079 #define FF_PRED_PLANE 1
2080 #define FF_PRED_MEDIAN 2
2081 #endif
2082 
2083  /**
2084  * slice offsets in the frame in bytes
2085  * - encoding: Set/allocated by libavcodec.
2086  * - decoding: Set/allocated by user (or NULL).
2087  */
2089 
2090  /**
2091  * sample aspect ratio (0 if unknown)
2092  * That is the width of a pixel divided by the height of the pixel.
2093  * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2094  * - encoding: Set by user.
2095  * - decoding: Set by libavcodec.
2096  */
2098 
2099  /**
2100  * motion estimation comparison function
2101  * - encoding: Set by user.
2102  * - decoding: unused
2103  */
2104  int me_cmp;
2105  /**
2106  * subpixel motion estimation comparison function
2107  * - encoding: Set by user.
2108  * - decoding: unused
2109  */
2111  /**
2112  * macroblock comparison function (not supported yet)
2113  * - encoding: Set by user.
2114  * - decoding: unused
2115  */
2116  int mb_cmp;
2117  /**
2118  * interlaced DCT comparison function
2119  * - encoding: Set by user.
2120  * - decoding: unused
2121  */
2123 #define FF_CMP_SAD 0
2124 #define FF_CMP_SSE 1
2125 #define FF_CMP_SATD 2
2126 #define FF_CMP_DCT 3
2127 #define FF_CMP_PSNR 4
2128 #define FF_CMP_BIT 5
2129 #define FF_CMP_RD 6
2130 #define FF_CMP_ZERO 7
2131 #define FF_CMP_VSAD 8
2132 #define FF_CMP_VSSE 9
2133 #define FF_CMP_NSSE 10
2134 #define FF_CMP_W53 11
2135 #define FF_CMP_W97 12
2136 #define FF_CMP_DCTMAX 13
2137 #define FF_CMP_DCT264 14
2138 #define FF_CMP_MEDIAN_SAD 15
2139 #define FF_CMP_CHROMA 256
2140 
2141  /**
2142  * ME diamond size & shape
2143  * - encoding: Set by user.
2144  * - decoding: unused
2145  */
2147 
2148  /**
2149  * amount of previous MV predictors (2a+1 x 2a+1 square)
2150  * - encoding: Set by user.
2151  * - decoding: unused
2152  */
2154 
2155 #if FF_API_PRIVATE_OPT
2156  /** @deprecated use encoder private options instead */
2158  int pre_me;
2159 #endif
2160 
2161  /**
2162  * motion estimation prepass comparison function
2163  * - encoding: Set by user.
2164  * - decoding: unused
2165  */
2167 
2168  /**
2169  * ME prepass diamond size & shape
2170  * - encoding: Set by user.
2171  * - decoding: unused
2172  */
2174 
2175  /**
2176  * subpel ME quality
2177  * - encoding: Set by user.
2178  * - decoding: unused
2179  */
2181 
2182 #if FF_API_AFD
2183  /**
2184  * DTG active format information (additional aspect ratio
2185  * information only used in DVB MPEG-2 transport streams)
2186  * 0 if not set.
2187  *
2188  * - encoding: unused
2189  * - decoding: Set by decoder.
2190  * @deprecated Deprecated in favor of AVSideData
2191  */
2193 #define FF_DTG_AFD_SAME 8
2194 #define FF_DTG_AFD_4_3 9
2195 #define FF_DTG_AFD_16_9 10
2196 #define FF_DTG_AFD_14_9 11
2197 #define FF_DTG_AFD_4_3_SP_14_9 13
2198 #define FF_DTG_AFD_16_9_SP_14_9 14
2199 #define FF_DTG_AFD_SP_4_3 15
2200 #endif /* FF_API_AFD */
2201 
2202  /**
2203  * maximum motion estimation search range in subpel units
2204  * If 0 then no limit.
2205  *
2206  * - encoding: Set by user.
2207  * - decoding: unused
2208  */
2210 
2211 #if FF_API_QUANT_BIAS
2212  /**
2213  * @deprecated use encoder private option instead
2214  */
2216 #define FF_DEFAULT_QUANT_BIAS 999999
2217 
2218  /**
2219  * @deprecated use encoder private option instead
2220  */
2222 #endif
2223 
2224  /**
2225  * slice flags
2226  * - encoding: unused
2227  * - decoding: Set by user.
2228  */
2230 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2231 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2232 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2233 
2234 #if FF_API_XVMC
2235  /**
2236  * XVideo Motion Acceleration
2237  * - encoding: forbidden
2238  * - decoding: set by decoder
2239  * @deprecated XvMC doesn't need it anymore.
2240  */
2241  attribute_deprecated int xvmc_acceleration;
2242 #endif /* FF_API_XVMC */
2243 
2244  /**
2245  * macroblock decision mode
2246  * - encoding: Set by user.
2247  * - decoding: unused
2248  */
2250 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2251 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2252 #define FF_MB_DECISION_RD 2 ///< rate distortion
2253 
2254  /**
2255  * custom intra quantization matrix
2256  * - encoding: Set by user, can be NULL.
2257  * - decoding: Set by libavcodec.
2258  */
2259  uint16_t *intra_matrix;
2260 
2261  /**
2262  * custom inter quantization matrix
2263  * - encoding: Set by user, can be NULL.
2264  * - decoding: Set by libavcodec.
2265  */
2266  uint16_t *inter_matrix;
2267 
2268 #if FF_API_PRIVATE_OPT
2269  /** @deprecated use encoder private options instead */
2272 
2273  /** @deprecated use encoder private options instead */
2276 #endif
2277 
2278 #if FF_API_MPV_OPT
2279  /**
2280  * @deprecated this field is unused
2281  */
2284 
2285  /**
2286  * @deprecated this field is unused
2287  */
2290 #endif
2291 
2292  /**
2293  * precision of the intra DC coefficient - 8
2294  * - encoding: Set by user.
2295  * - decoding: Set by libavcodec
2296  */
2298 
2299  /**
2300  * Number of macroblock rows at the top which are skipped.
2301  * - encoding: unused
2302  * - decoding: Set by user.
2303  */
2305 
2306  /**
2307  * Number of macroblock rows at the bottom which are skipped.
2308  * - encoding: unused
2309  * - decoding: Set by user.
2310  */
2312 
2313 #if FF_API_MPV_OPT
2314  /**
2315  * @deprecated use encoder private options instead
2316  */
2319 #endif
2320 
2321  /**
2322  * minimum MB Lagrange multiplier
2323  * - encoding: Set by user.
2324  * - decoding: unused
2325  */
2326  int mb_lmin;
2327 
2328  /**
2329  * maximum MB Lagrange multiplier
2330  * - encoding: Set by user.
2331  * - decoding: unused
2332  */
2333  int mb_lmax;
2334 
2335 #if FF_API_PRIVATE_OPT
2336  /**
2337  * @deprecated use encoder private options instead
2338  */
2341 #endif
2342 
2343  /**
2344  * - encoding: Set by user.
2345  * - decoding: unused
2346  */
2348 
2349 #if FF_API_PRIVATE_OPT
2350  /** @deprecated use encoder private options instead */
2353 #endif
2354 
2355  /**
2356  * minimum GOP size
2357  * - encoding: Set by user.
2358  * - decoding: unused
2359  */
2361 
2362  /**
2363  * number of reference frames
2364  * - encoding: Set by user.
2365  * - decoding: Set by lavc.
2366  */
2367  int refs;
2368 
2369 #if FF_API_PRIVATE_OPT
2370  /** @deprecated use encoder private options instead */
2373 #endif
2374 
2375 #if FF_API_UNUSED_MEMBERS
2376  /**
2377  * Multiplied by qscale for each frame and added to scene_change_score.
2378  * - encoding: Set by user.
2379  * - decoding: unused
2380  */
2382 #endif
2383 
2384  /**
2385  * Note: Value depends upon the compare function used for fullpel ME.
2386  * - encoding: Set by user.
2387  * - decoding: unused
2388  */
2390 
2391 #if FF_API_PRIVATE_OPT
2392  /** @deprecated use encoder private options instead */
2395 #endif
2396 
2397  /**
2398  * Chromaticity coordinates of the source primaries.
2399  * - encoding: Set by user
2400  * - decoding: Set by libavcodec
2401  */
2403 
2404  /**
2405  * Color Transfer Characteristic.
2406  * - encoding: Set by user
2407  * - decoding: Set by libavcodec
2408  */
2410 
2411  /**
2412  * YUV colorspace type.
2413  * - encoding: Set by user
2414  * - decoding: Set by libavcodec
2415  */
2417 
2418  /**
2419  * MPEG vs JPEG YUV range.
2420  * - encoding: Set by user
2421  * - decoding: Set by libavcodec
2422  */
2424 
2425  /**
2426  * This defines the location of chroma samples.
2427  * - encoding: Set by user
2428  * - decoding: Set by libavcodec
2429  */
2431 
2432  /**
2433  * Number of slices.
2434  * Indicates number of picture subdivisions. Used for parallelized
2435  * decoding.
2436  * - encoding: Set by user
2437  * - decoding: unused
2438  */
2439  int slices;
2440 
2441  /** Field order
2442  * - encoding: set by libavcodec
2443  * - decoding: Set by user.
2444  */
2446 
2447  /* audio only */
2448  int sample_rate; ///< samples per second
2449  int channels; ///< number of audio channels
2450 
2451  /**
2452  * audio sample format
2453  * - encoding: Set by user.
2454  * - decoding: Set by libavcodec.
2455  */
2456  enum AVSampleFormat sample_fmt; ///< sample format
2457 
2458  /* The following data should not be initialized. */
2459  /**
2460  * Number of samples per channel in an audio frame.
2461  *
2462  * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2463  * except the last must contain exactly frame_size samples per channel.
2464  * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2465  * frame size is not restricted.
2466  * - decoding: may be set by some decoders to indicate constant frame size
2467  */
2469 
2470  /**
2471  * Frame counter, set by libavcodec.
2472  *
2473  * - decoding: total number of frames returned from the decoder so far.
2474  * - encoding: total number of frames passed to the encoder so far.
2475  *
2476  * @note the counter is not incremented if encoding/decoding resulted in
2477  * an error.
2478  */
2480 
2481  /**
2482  * number of bytes per packet if constant and known or 0
2483  * Used by some WAV based audio codecs.
2484  */
2486 
2487  /**
2488  * Audio cutoff bandwidth (0 means "automatic")
2489  * - encoding: Set by user.
2490  * - decoding: unused
2491  */
2492  int cutoff;
2493 
2494  /**
2495  * Audio channel layout.
2496  * - encoding: set by user.
2497  * - decoding: set by user, may be overwritten by libavcodec.
2498  */
2499  uint64_t channel_layout;
2500 
2501  /**
2502  * Request decoder to use this channel layout if it can (0 for default)
2503  * - encoding: unused
2504  * - decoding: Set by user.
2505  */
2507 
2508  /**
2509  * Type of service that the audio stream conveys.
2510  * - encoding: Set by user.
2511  * - decoding: Set by libavcodec.
2512  */
2514 
2515  /**
2516  * desired sample format
2517  * - encoding: Not used.
2518  * - decoding: Set by user.
2519  * Decoder will decode to this format if it can.
2520  */
2522 
2523  /**
2524  * This callback is called at the beginning of each frame to get data
2525  * buffer(s) for it. There may be one contiguous buffer for all the data or
2526  * there may be a buffer per each data plane or anything in between. What
2527  * this means is, you may set however many entries in buf[] you feel necessary.
2528  * Each buffer must be reference-counted using the AVBuffer API (see description
2529  * of buf[] below).
2530  *
2531  * The following fields will be set in the frame before this callback is
2532  * called:
2533  * - format
2534  * - width, height (video only)
2535  * - sample_rate, channel_layout, nb_samples (audio only)
2536  * Their values may differ from the corresponding values in
2537  * AVCodecContext. This callback must use the frame values, not the codec
2538  * context values, to calculate the required buffer size.
2539  *
2540  * This callback must fill the following fields in the frame:
2541  * - data[]
2542  * - linesize[]
2543  * - extended_data:
2544  * * if the data is planar audio with more than 8 channels, then this
2545  * callback must allocate and fill extended_data to contain all pointers
2546  * to all data planes. data[] must hold as many pointers as it can.
2547  * extended_data must be allocated with av_malloc() and will be freed in
2548  * av_frame_unref().
2549  * * otherwise extended_data must point to data
2550  * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2551  * the frame's data and extended_data pointers must be contained in these. That
2552  * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2553  * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2554  * and av_buffer_ref().
2555  * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2556  * this callback and filled with the extra buffers if there are more
2557  * buffers than buf[] can hold. extended_buf will be freed in
2558  * av_frame_unref().
2559  *
2560  * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2561  * avcodec_default_get_buffer2() instead of providing buffers allocated by
2562  * some other means.
2563  *
2564  * Each data plane must be aligned to the maximum required by the target
2565  * CPU.
2566  *
2567  * @see avcodec_default_get_buffer2()
2568  *
2569  * Video:
2570  *
2571  * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2572  * (read and/or written to if it is writable) later by libavcodec.
2573  *
2574  * avcodec_align_dimensions2() should be used to find the required width and
2575  * height, as they normally need to be rounded up to the next multiple of 16.
2576  *
2577  * Some decoders do not support linesizes changing between frames.
2578  *
2579  * If frame multithreading is used and thread_safe_callbacks is set,
2580  * this callback may be called from a different thread, but not from more
2581  * than one at once. Does not need to be reentrant.
2582  *
2583  * @see avcodec_align_dimensions2()
2584  *
2585  * Audio:
2586  *
2587  * Decoders request a buffer of a particular size by setting
2588  * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2589  * however, utilize only part of the buffer by setting AVFrame.nb_samples
2590  * to a smaller value in the output frame.
2591  *
2592  * As a convenience, av_samples_get_buffer_size() and
2593  * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2594  * functions to find the required data size and to fill data pointers and
2595  * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2596  * since all planes must be the same size.
2597  *
2598  * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2599  *
2600  * - encoding: unused
2601  * - decoding: Set by libavcodec, user can override.
2602  */
2603  int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2604 
2605  /**
2606  * If non-zero, the decoded audio and video frames returned from
2607  * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2608  * and are valid indefinitely. The caller must free them with
2609  * av_frame_unref() when they are not needed anymore.
2610  * Otherwise, the decoded frames must not be freed by the caller and are
2611  * only valid until the next decode call.
2612  *
2613  * This is always automatically enabled if avcodec_receive_frame() is used.
2614  *
2615  * - encoding: unused
2616  * - decoding: set by the caller before avcodec_open2().
2617  */
2619 
2620  /* - encoding parameters */
2621  float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2622  float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2623 
2624  /**
2625  * minimum quantizer
2626  * - encoding: Set by user.
2627  * - decoding: unused
2628  */
2629  int qmin;
2630 
2631  /**
2632  * maximum quantizer
2633  * - encoding: Set by user.
2634  * - decoding: unused
2635  */
2636  int qmax;
2637 
2638  /**
2639  * maximum quantizer difference between frames
2640  * - encoding: Set by user.
2641  * - decoding: unused
2642  */
2644 
2645 #if FF_API_MPV_OPT
2646  /**
2647  * @deprecated use encoder private options instead
2648  */
2650  float rc_qsquish;
2651 
2656 #endif
2657 
2658  /**
2659  * decoder bitstream buffer size
2660  * - encoding: Set by user.
2661  * - decoding: unused
2662  */
2664 
2665  /**
2666  * ratecontrol override, see RcOverride
2667  * - encoding: Allocated/set/freed by user.
2668  * - decoding: unused
2669  */
2672 
2673 #if FF_API_MPV_OPT
2674  /**
2675  * @deprecated use encoder private options instead
2676  */
2678  const char *rc_eq;
2679 #endif
2680 
2681  /**
2682  * maximum bitrate
2683  * - encoding: Set by user.
2684  * - decoding: Set by user, may be overwritten by libavcodec.
2685  */
2686  int64_t rc_max_rate;
2687 
2688  /**
2689  * minimum bitrate
2690  * - encoding: Set by user.
2691  * - decoding: unused
2692  */
2693  int64_t rc_min_rate;
2694 
2695 #if FF_API_MPV_OPT
2696  /**
2697  * @deprecated use encoder private options instead
2698  */
2701 
2704 #endif
2705 
2706  /**
2707  * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2708  * - encoding: Set by user.
2709  * - decoding: unused.
2710  */
2712 
2713  /**
2714  * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2715  * - encoding: Set by user.
2716  * - decoding: unused.
2717  */
2719 
2720  /**
2721  * Number of bits which should be loaded into the rc buffer before decoding starts.
2722  * - encoding: Set by user.
2723  * - decoding: unused
2724  */
2726 
2727 #if FF_API_CODER_TYPE
2728 #define FF_CODER_TYPE_VLC 0
2729 #define FF_CODER_TYPE_AC 1
2730 #define FF_CODER_TYPE_RAW 2
2731 #define FF_CODER_TYPE_RLE 3
2732 #if FF_API_UNUSED_MEMBERS
2733 #define FF_CODER_TYPE_DEFLATE 4
2734 #endif /* FF_API_UNUSED_MEMBERS */
2735  /**
2736  * @deprecated use encoder private options instead
2737  */
2740 #endif /* FF_API_CODER_TYPE */
2741 
2742 #if FF_API_PRIVATE_OPT
2743  /** @deprecated use encoder private options instead */
2746 #endif
2747 
2748 #if FF_API_MPV_OPT
2749  /**
2750  * @deprecated use encoder private options instead
2751  */
2753  int lmin;
2754 
2755  /**
2756  * @deprecated use encoder private options instead
2757  */
2759  int lmax;
2760 #endif
2761 
2762 #if FF_API_PRIVATE_OPT
2763  /** @deprecated use encoder private options instead */
2766 
2767  /** @deprecated use encoder private options instead */
2770 
2771  /** @deprecated use encoder private options instead */
2774 
2775  /** @deprecated use encoder private options instead */
2778 #endif /* FF_API_PRIVATE_OPT */
2779 
2780  /**
2781  * trellis RD quantization
2782  * - encoding: Set by user.
2783  * - decoding: unused
2784  */
2785  int trellis;
2786 
2787 #if FF_API_PRIVATE_OPT
2788  /** @deprecated use encoder private options instead */
2791 
2792  /** @deprecated use encoder private options instead */
2795 
2796  /** @deprecated use encoder private options instead */
2799 #endif
2800 
2801 #if FF_API_RTP_CALLBACK
2802  /**
2803  * @deprecated unused
2804  */
2805  /* The RTP callback: This function is called */
2806  /* every time the encoder has a packet to send. */
2807  /* It depends on the encoder if the data starts */
2808  /* with a Start Code (it should). H.263 does. */
2809  /* mb_nb contains the number of macroblocks */
2810  /* encoded in the RTP payload. */
2812  void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2813 #endif
2814 
2815 #if FF_API_PRIVATE_OPT
2816  /** @deprecated use encoder private options instead */
2818  int rtp_payload_size; /* The size of the RTP payload: the coder will */
2819  /* do its best to deliver a chunk with size */
2820  /* below rtp_payload_size, the chunk will start */
2821  /* with a start code on some codecs like H.263. */
2822  /* This doesn't take account of any particular */
2823  /* headers inside the transmitted RTP payload. */
2824 #endif
2825 
2826 #if FF_API_STAT_BITS
2827  /* statistics, used for 2-pass encoding */
2829  int mv_bits;
2837  int i_count;
2839  int p_count;
2844 
2845  /** @deprecated this field is unused */
2848 #endif
2849 
2850  /**
2851  * pass1 encoding statistics output buffer
2852  * - encoding: Set by libavcodec.
2853  * - decoding: unused
2854  */
2855  char *stats_out;
2856 
2857  /**
2858  * pass2 encoding statistics input buffer
2859  * Concatenated stuff from stats_out of pass1 should be placed here.
2860  * - encoding: Allocated/set/freed by user.
2861  * - decoding: unused
2862  */
2863  char *stats_in;
2864 
2865  /**
2866  * Work around bugs in encoders which sometimes cannot be detected automatically.
2867  * - encoding: Set by user
2868  * - decoding: Set by user
2869  */
2871 #define FF_BUG_AUTODETECT 1 ///< autodetection
2872 #if FF_API_OLD_MSMPEG4
2873 #define FF_BUG_OLD_MSMPEG4 2
2874 #endif
2875 #define FF_BUG_XVID_ILACE 4
2876 #define FF_BUG_UMP4 8
2877 #define FF_BUG_NO_PADDING 16
2878 #define FF_BUG_AMV 32
2879 #if FF_API_AC_VLC
2880 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2881 #endif
2882 #define FF_BUG_QPEL_CHROMA 64
2883 #define FF_BUG_STD_QPEL 128
2884 #define FF_BUG_QPEL_CHROMA2 256
2885 #define FF_BUG_DIRECT_BLOCKSIZE 512
2886 #define FF_BUG_EDGE 1024
2887 #define FF_BUG_HPEL_CHROMA 2048
2888 #define FF_BUG_DC_CLIP 4096
2889 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2890 #define FF_BUG_TRUNCATED 16384
2891 #define FF_BUG_IEDGE 32768
2892 
2893  /**
2894  * strictly follow the standard (MPEG-4, ...).
2895  * - encoding: Set by user.
2896  * - decoding: Set by user.
2897  * Setting this to STRICT or higher means the encoder and decoder will
2898  * generally do stupid things, whereas setting it to unofficial or lower
2899  * will mean the encoder might produce output that is not supported by all
2900  * spec-compliant decoders. Decoders don't differentiate between normal,
2901  * unofficial and experimental (that is, they always try to decode things
2902  * when they can) unless they are explicitly asked to behave stupidly
2903  * (=strictly conform to the specs)
2904  */
2906 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2907 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2908 #define FF_COMPLIANCE_NORMAL 0
2909 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2910 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2911 
2912  /**
2913  * error concealment flags
2914  * - encoding: unused
2915  * - decoding: Set by user.
2916  */
2918 #define FF_EC_GUESS_MVS 1
2919 #define FF_EC_DEBLOCK 2
2920 #define FF_EC_FAVOR_INTER 256
2921 
2922  /**
2923  * debug
2924  * - encoding: Set by user.
2925  * - decoding: Set by user.
2926  */
2927  int debug;
2928 #define FF_DEBUG_PICT_INFO 1
2929 #define FF_DEBUG_RC 2
2930 #define FF_DEBUG_BITSTREAM 4
2931 #define FF_DEBUG_MB_TYPE 8
2932 #define FF_DEBUG_QP 16
2933 #if FF_API_DEBUG_MV
2934 /**
2935  * @deprecated this option does nothing
2936  */
2937 #define FF_DEBUG_MV 32
2938 #endif
2939 #define FF_DEBUG_DCT_COEFF 0x00000040
2940 #define FF_DEBUG_SKIP 0x00000080
2941 #define FF_DEBUG_STARTCODE 0x00000100
2942 #if FF_API_UNUSED_MEMBERS
2943 #define FF_DEBUG_PTS 0x00000200
2944 #endif /* FF_API_UNUSED_MEMBERS */
2945 #define FF_DEBUG_ER 0x00000400
2946 #define FF_DEBUG_MMCO 0x00000800
2947 #define FF_DEBUG_BUGS 0x00001000
2948 #if FF_API_DEBUG_MV
2949 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2950 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2951 #endif
2952 #define FF_DEBUG_BUFFERS 0x00008000
2953 #define FF_DEBUG_THREADS 0x00010000
2954 #define FF_DEBUG_GREEN_MD 0x00800000
2955 #define FF_DEBUG_NOMC 0x01000000
2956 
2957 #if FF_API_DEBUG_MV
2958  /**
2959  * debug
2960  * Code outside libavcodec should access this field using AVOptions
2961  * - encoding: Set by user.
2962  * - decoding: Set by user.
2963  */
2965 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2966 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2967 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2968 #endif
2969 
2970  /**
2971  * Error recognition; may misdetect some more or less valid parts as errors.
2972  * - encoding: unused
2973  * - decoding: Set by user.
2974  */
2976 
2977 /**
2978  * Verify checksums embedded in the bitstream (could be of either encoded or
2979  * decoded data, depending on the codec) and print an error message on mismatch.
2980  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2981  * decoder returning an error.
2982  */
2983 #define AV_EF_CRCCHECK (1<<0)
2984 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2985 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2986 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2987 
2988 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2989 #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
2990 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2991 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2992 
2993 
2994  /**
2995  * opaque 64-bit number (generally a PTS) that will be reordered and
2996  * output in AVFrame.reordered_opaque
2997  * - encoding: unused
2998  * - decoding: Set by user.
2999  */
3001 
3002  /**
3003  * Hardware accelerator in use
3004  * - encoding: unused.
3005  * - decoding: Set by libavcodec
3006  */
3008 
3009  /**
3010  * Hardware accelerator context.
3011  * For some hardware accelerators, a global context needs to be
3012  * provided by the user. In that case, this holds display-dependent
3013  * data FFmpeg cannot instantiate itself. Please refer to the
3014  * FFmpeg HW accelerator documentation to know how to fill this
3015  * is. e.g. for VA API, this is a struct vaapi_context.
3016  * - encoding: unused
3017  * - decoding: Set by user
3018  */
3020 
3021  /**
3022  * error
3023  * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3024  * - decoding: unused
3025  */
3026  uint64_t error[AV_NUM_DATA_POINTERS];
3027 
3028  /**
3029  * DCT algorithm, see FF_DCT_* below
3030  * - encoding: Set by user.
3031  * - decoding: unused
3032  */
3034 #define FF_DCT_AUTO 0
3035 #define FF_DCT_FASTINT 1
3036 #define FF_DCT_INT 2
3037 #define FF_DCT_MMX 3
3038 #define FF_DCT_ALTIVEC 5
3039 #define FF_DCT_FAAN 6
3040 
3041  /**
3042  * IDCT algorithm, see FF_IDCT_* below.
3043  * - encoding: Set by user.
3044  * - decoding: Set by user.
3045  */
3047 #define FF_IDCT_AUTO 0
3048 #define FF_IDCT_INT 1
3049 #define FF_IDCT_SIMPLE 2
3050 #define FF_IDCT_SIMPLEMMX 3
3051 #define FF_IDCT_ARM 7
3052 #define FF_IDCT_ALTIVEC 8
3053 #if FF_API_ARCH_SH4
3054 #define FF_IDCT_SH4 9
3055 #endif
3056 #define FF_IDCT_SIMPLEARM 10
3057 #if FF_API_UNUSED_MEMBERS
3058 #define FF_IDCT_IPP 13
3059 #endif /* FF_API_UNUSED_MEMBERS */
3060 #define FF_IDCT_XVID 14
3061 #if FF_API_IDCT_XVIDMMX
3062 #define FF_IDCT_XVIDMMX 14
3063 #endif /* FF_API_IDCT_XVIDMMX */
3064 #define FF_IDCT_SIMPLEARMV5TE 16
3065 #define FF_IDCT_SIMPLEARMV6 17
3066 #if FF_API_ARCH_SPARC
3067 #define FF_IDCT_SIMPLEVIS 18
3068 #endif
3069 #define FF_IDCT_FAAN 20
3070 #define FF_IDCT_SIMPLENEON 22
3071 #if FF_API_ARCH_ALPHA
3072 #define FF_IDCT_SIMPLEALPHA 23
3073 #endif
3074 #define FF_IDCT_SIMPLEAUTO 128
3075 
3076  /**
3077  * bits per sample/pixel from the demuxer (needed for huffyuv).
3078  * - encoding: Set by libavcodec.
3079  * - decoding: Set by user.
3080  */
3082 
3083  /**
3084  * Bits per sample/pixel of internal libavcodec pixel/sample format.
3085  * - encoding: set by user.
3086  * - decoding: set by libavcodec.
3087  */
3089 
3090 #if FF_API_LOWRES
3091  /**
3092  * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3093  * - encoding: unused
3094  * - decoding: Set by user.
3095  * Code outside libavcodec should access this field using:
3096  * av_codec_{get,set}_lowres(avctx)
3097  */
3098  int lowres;
3099 #endif
3100 
3101 #if FF_API_CODED_FRAME
3102  /**
3103  * the picture in the bitstream
3104  * - encoding: Set by libavcodec.
3105  * - decoding: unused
3106  *
3107  * @deprecated use the quality factor packet side data instead
3108  */
3110 #endif
3111 
3112  /**
3113  * thread count
3114  * is used to decide how many independent tasks should be passed to execute()
3115  * - encoding: Set by user.
3116  * - decoding: Set by user.
3117  */
3119 
3120  /**
3121  * Which multithreading methods to use.
3122  * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3123  * so clients which cannot provide future frames should not use it.
3124  *
3125  * - encoding: Set by user, otherwise the default is used.
3126  * - decoding: Set by user, otherwise the default is used.
3127  */
3129 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3130 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3131 
3132  /**
3133  * Which multithreading methods are in use by the codec.
3134  * - encoding: Set by libavcodec.
3135  * - decoding: Set by libavcodec.
3136  */
3138 
3139  /**
3140  * Set by the client if its custom get_buffer() callback can be called
3141  * synchronously from another thread, which allows faster multithreaded decoding.
3142  * draw_horiz_band() will be called from other threads regardless of this setting.
3143  * Ignored if the default get_buffer() is used.
3144  * - encoding: Set by user.
3145  * - decoding: Set by user.
3146  */
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  * @param count the number of things to execute
3155  * - encoding: Set by libavcodec, user can override.
3156  * - decoding: Set by libavcodec, user can override.
3157  */
3158  int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3159 
3160  /**
3161  * The codec may call this to execute several independent things.
3162  * It will return only after finishing all tasks.
3163  * The user may replace this with some multithreaded implementation,
3164  * the default implementation will execute the parts serially.
3165  * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3166  * @param c context passed also to func
3167  * @param count the number of things to execute
3168  * @param arg2 argument passed unchanged to func
3169  * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3170  * @param func function that will be called count times, with jobnr from 0 to count-1.
3171  * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3172  * two instances of func executing at the same time will have the same threadnr.
3173  * @return always 0 currently, but code should handle a future improvement where when any call to func
3174  * returns < 0 no further calls to func may be done and < 0 is returned.
3175  * - encoding: Set by libavcodec, user can override.
3176  * - decoding: Set by libavcodec, user can override.
3177  */
3178  int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3179 
3180  /**
3181  * noise vs. sse weight for the nsse comparison function
3182  * - encoding: Set by user.
3183  * - decoding: unused
3184  */
3186 
3187  /**
3188  * profile
3189  * - encoding: Set by user.
3190  * - decoding: Set by libavcodec.
3191  */
3192  int profile;
3193 #define FF_PROFILE_UNKNOWN -99
3194 #define FF_PROFILE_RESERVED -100
3195 
3196 #define FF_PROFILE_AAC_MAIN 0
3197 #define FF_PROFILE_AAC_LOW 1
3198 #define FF_PROFILE_AAC_SSR 2
3199 #define FF_PROFILE_AAC_LTP 3
3200 #define FF_PROFILE_AAC_HE 4
3201 #define FF_PROFILE_AAC_HE_V2 28
3202 #define FF_PROFILE_AAC_LD 22
3203 #define FF_PROFILE_AAC_ELD 38
3204 #define FF_PROFILE_MPEG2_AAC_LOW 128
3205 #define FF_PROFILE_MPEG2_AAC_HE 131
3206 
3207 #define FF_PROFILE_DNXHD 0
3208 #define FF_PROFILE_DNXHR_LB 1
3209 #define FF_PROFILE_DNXHR_SQ 2
3210 #define FF_PROFILE_DNXHR_HQ 3
3211 #define FF_PROFILE_DNXHR_HQX 4
3212 #define FF_PROFILE_DNXHR_444 5
3213 
3214 #define FF_PROFILE_DTS 20
3215 #define FF_PROFILE_DTS_ES 30
3216 #define FF_PROFILE_DTS_96_24 40
3217 #define FF_PROFILE_DTS_HD_HRA 50
3218 #define FF_PROFILE_DTS_HD_MA 60
3219 #define FF_PROFILE_DTS_EXPRESS 70
3220 
3221 #define FF_PROFILE_MPEG2_422 0
3222 #define FF_PROFILE_MPEG2_HIGH 1
3223 #define FF_PROFILE_MPEG2_SS 2
3224 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3225 #define FF_PROFILE_MPEG2_MAIN 4
3226 #define FF_PROFILE_MPEG2_SIMPLE 5
3227 
3228 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3229 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3230 
3231 #define FF_PROFILE_H264_BASELINE 66
3232 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3233 #define FF_PROFILE_H264_MAIN 77
3234 #define FF_PROFILE_H264_EXTENDED 88
3235 #define FF_PROFILE_H264_HIGH 100
3236 #define FF_PROFILE_H264_HIGH_10 110
3237 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3238 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3239 #define FF_PROFILE_H264_HIGH_422 122
3240 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3241 #define FF_PROFILE_H264_STEREO_HIGH 128
3242 #define FF_PROFILE_H264_HIGH_444 144
3243 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3244 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3245 #define FF_PROFILE_H264_CAVLC_444 44
3246 
3247 #define FF_PROFILE_VC1_SIMPLE 0
3248 #define FF_PROFILE_VC1_MAIN 1
3249 #define FF_PROFILE_VC1_COMPLEX 2
3250 #define FF_PROFILE_VC1_ADVANCED 3
3251 
3252 #define FF_PROFILE_MPEG4_SIMPLE 0
3253 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3254 #define FF_PROFILE_MPEG4_CORE 2
3255 #define FF_PROFILE_MPEG4_MAIN 3
3256 #define FF_PROFILE_MPEG4_N_BIT 4
3257 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3258 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3259 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3260 #define FF_PROFILE_MPEG4_HYBRID 8
3261 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3262 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3263 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3264 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3265 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3266 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3267 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3268 
3269 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3270 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3271 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3272 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3273 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3274 
3275 #define FF_PROFILE_VP9_0 0
3276 #define FF_PROFILE_VP9_1 1
3277 #define FF_PROFILE_VP9_2 2
3278 #define FF_PROFILE_VP9_3 3
3279 
3280 #define FF_PROFILE_HEVC_MAIN 1
3281 #define FF_PROFILE_HEVC_MAIN_10 2
3282 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3283 #define FF_PROFILE_HEVC_REXT 4
3284 
3285  /**
3286  * level
3287  * - encoding: Set by user.
3288  * - decoding: Set by libavcodec.
3289  */
3290  int level;
3291 #define FF_LEVEL_UNKNOWN -99
3292 
3293  /**
3294  * Skip loop filtering for selected frames.
3295  * - encoding: unused
3296  * - decoding: Set by user.
3297  */
3299 
3300  /**
3301  * Skip IDCT/dequantization for selected frames.
3302  * - encoding: unused
3303  * - decoding: Set by user.
3304  */
3306 
3307  /**
3308  * Skip decoding for selected frames.
3309  * - encoding: unused
3310  * - decoding: Set by user.
3311  */
3313 
3314  /**
3315  * Header containing style information for text subtitles.
3316  * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3317  * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3318  * the Format line following. It shouldn't include any Dialogue line.
3319  * - encoding: Set/allocated/freed by user (before avcodec_open2())
3320  * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3321  */
3324 
3325 #if FF_API_ERROR_RATE
3326  /**
3327  * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3328  * encoders
3329  */
3332 #endif
3333 
3334 #if FF_API_VBV_DELAY
3335  /**
3336  * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3337  * Used for compliant TS muxing.
3338  * - encoding: Set by libavcodec.
3339  * - decoding: unused.
3340  * @deprecated this value is now exported as a part of
3341  * AV_PKT_DATA_CPB_PROPERTIES packet side data
3342  */
3344  uint64_t vbv_delay;
3345 #endif
3346 
3347 #if FF_API_SIDEDATA_ONLY_PKT
3348  /**
3349  * Encoding only and set by default. Allow encoders to output packets
3350  * that do not contain any encoded data, only side data.
3351  *
3352  * Some encoders need to output such packets, e.g. to update some stream
3353  * parameters at the end of encoding.
3354  *
3355  * @deprecated this field disables the default behaviour and
3356  * it is kept only for compatibility.
3357  */
3360 #endif
3361 
3362  /**
3363  * Audio only. The number of "priming" samples (padding) inserted by the
3364  * encoder at the beginning of the audio. I.e. this number of leading
3365  * decoded samples must be discarded by the caller to get the original audio
3366  * without leading padding.
3367  *
3368  * - decoding: unused
3369  * - encoding: Set by libavcodec. The timestamps on the output packets are
3370  * adjusted by the encoder so that they always refer to the
3371  * first sample of the data actually contained in the packet,
3372  * including any added padding. E.g. if the timebase is
3373  * 1/samplerate and the timestamp of the first input sample is
3374  * 0, the timestamp of the first output packet will be
3375  * -initial_padding.
3376  */
3378 
3379  /**
3380  * - decoding: For codecs that store a framerate value in the compressed
3381  * bitstream, the decoder may export it here. { 0, 1} when
3382  * unknown.
3383  * - encoding: May be used to signal the framerate of CFR content to an
3384  * encoder.
3385  */
3387 
3388  /**
3389  * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3390  * - encoding: unused.
3391  * - decoding: Set by libavcodec before calling get_format()
3392  */
3394 
3395  /**
3396  * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3397  * Code outside libavcodec should access this field using:
3398  * av_codec_{get,set}_pkt_timebase(avctx)
3399  * - encoding unused.
3400  * - decoding set by user.
3401  */
3403 
3404  /**
3405  * AVCodecDescriptor
3406  * Code outside libavcodec should access this field using:
3407  * av_codec_{get,set}_codec_descriptor(avctx)
3408  * - encoding: unused.
3409  * - decoding: set by libavcodec.
3410  */
3412 
3413 #if !FF_API_LOWRES
3414  /**
3415  * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3416  * - encoding: unused
3417  * - decoding: Set by user.
3418  * Code outside libavcodec should access this field using:
3419  * av_codec_{get,set}_lowres(avctx)
3420  */
3421  int lowres;
3422 #endif
3423 
3424  /**
3425  * Current statistics for PTS correction.
3426  * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3427  * - encoding: unused
3428  */
3429  int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3430  int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3431  int64_t pts_correction_last_pts; /// PTS of the last frame
3432  int64_t pts_correction_last_dts; /// DTS of the last frame
3433 
3434  /**
3435  * Character encoding of the input subtitles file.
3436  * - decoding: set by user
3437  * - encoding: unused
3438  */
3440 
3441  /**
3442  * Subtitles character encoding mode. Formats or codecs might be adjusting
3443  * this setting (if they are doing the conversion themselves for instance).
3444  * - decoding: set by libavcodec
3445  * - encoding: unused
3446  */
3448 #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)
3449 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3450 #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
3451 
3452  /**
3453  * Skip processing alpha if supported by codec.
3454  * Note that if the format uses pre-multiplied alpha (common with VP6,
3455  * and recommended due to better video quality/compression)
3456  * the image will look as if alpha-blended onto a black background.
3457  * However for formats that do not use pre-multiplied alpha
3458  * there might be serious artefacts (though e.g. libswscale currently
3459  * assumes pre-multiplied alpha anyway).
3460  * Code outside libavcodec should access this field using AVOptions
3461  *
3462  * - decoding: set by user
3463  * - encoding: unused
3464  */
3466 
3467  /**
3468  * Number of samples to skip after a discontinuity
3469  * - decoding: unused
3470  * - encoding: set by libavcodec
3471  */
3473 
3474 #if !FF_API_DEBUG_MV
3475  /**
3476  * debug motion vectors
3477  * Code outside libavcodec should access this field using AVOptions
3478  * - encoding: Set by user.
3479  * - decoding: Set by user.
3480  */
3481  int debug_mv;
3482 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3483 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3484 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3485 #endif
3486 
3487  /**
3488  * custom intra quantization matrix
3489  * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3490  * - encoding: Set by user, can be NULL.
3491  * - decoding: unused.
3492  */
3494 
3495  /**
3496  * dump format separator.
3497  * can be ", " or "\n " or anything else
3498  * Code outside libavcodec should access this field using AVOptions
3499  * (NO direct access).
3500  * - encoding: Set by user.
3501  * - decoding: Set by user.
3502  */
3503  uint8_t *dump_separator;
3504 
3505  /**
3506  * ',' separated list of allowed decoders.
3507  * If NULL then all are allowed
3508  * - encoding: unused
3509  * - decoding: set by user through AVOPtions (NO direct access)
3510  */
3512 
3513  /*
3514  * Properties of the stream that gets decoded
3515  * To be accessed through av_codec_get_properties() (NO direct access)
3516  * - encoding: unused
3517  * - decoding: set by libavcodec
3518  */
3519  unsigned properties;
3520 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3521 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3522 
3523  /**
3524  * Additional data associated with the entire coded stream.
3525  *
3526  * - decoding: unused
3527  * - encoding: may be set by libavcodec after avcodec_open2().
3528  */
3531 
3532  /**
3533  * A reference to the AVHWFramesContext describing the input (for encoding)
3534  * or output (decoding) frames. The reference is set by the caller and
3535  * afterwards owned (and freed) by libavcodec.
3536  *
3537  * - decoding: This field should be set by the caller from the get_format()
3538  * callback. The previous reference (if any) will always be
3539  * unreffed by libavcodec before the get_format() call.
3540  *
3541  * If the default get_buffer2() is used with a hwaccel pixel
3542  * format, then this AVHWFramesContext will be used for
3543  * allocating the frame buffers.
3544  *
3545  * - encoding: For hardware encoders configured to use a hwaccel pixel
3546  * format, this field should be set by the caller to a reference
3547  * to the AVHWFramesContext describing input frames.
3548  * AVHWFramesContext.format must be equal to
3549  * AVCodecContext.pix_fmt.
3550  *
3551  * This field should be set before avcodec_open2() is called.
3552  */
3554 
3555  /**
3556  * Control the form of AVSubtitle.rects[N]->ass
3557  * - decoding: set by user
3558  * - encoding: unused
3559  */
3561 #define FF_SUB_TEXT_FMT_ASS 0
3562 #if FF_API_ASS_TIMING
3563 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3564 #endif
3565 
3566  /**
3567  * Audio only. The amount of padding (in samples) appended by the encoder to
3568  * the end of the audio. I.e. this number of decoded samples must be
3569  * discarded by the caller from the end of the stream to get the original
3570  * audio without any trailing padding.
3571  *
3572  * - decoding: unused
3573  * - encoding: unused
3574  */
3576 
3577 } AVCodecContext;
3578 
3581 
3584 
3585 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3586 
3587 int av_codec_get_lowres(const AVCodecContext *avctx);
3588 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3589 
3590 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3591 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3592 
3593 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3594 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3595 
3596 /**
3597  * AVProfile.
3598  */
3599 typedef struct AVProfile {
3600  int profile;
3601  const char *name; ///< short name for the profile
3602 } AVProfile;
3603 
3605 
3606 struct AVSubtitle;
3607 
3608 /**
3609  * AVCodec.
3610  */
3611 typedef struct AVCodec {
3612  /**
3613  * Name of the codec implementation.
3614  * The name is globally unique among encoders and among decoders (but an
3615  * encoder and a decoder can share the same name).
3616  * This is the primary way to find a codec from the user perspective.
3617  */
3618  const char *name;
3619  /**
3620  * Descriptive name for the codec, meant to be more human readable than name.
3621  * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3622  */
3623  const char *long_name;
3626  /**
3627  * Codec capabilities.
3628  * see AV_CODEC_CAP_*
3629  */
3631  const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3632  const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3633  const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3634  const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3635  const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3636  uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3637  const AVClass *priv_class; ///< AVClass for the private context
3638  const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3639 
3640  /*****************************************************************
3641  * No fields below this line are part of the public API. They
3642  * may not be used outside of libavcodec and can be changed and
3643  * removed at will.
3644  * New public fields should be added right above.
3645  *****************************************************************
3646  */
3648  struct AVCodec *next;
3649  /**
3650  * @name Frame-level threading support functions
3651  * @{
3652  */
3653  /**
3654  * If defined, called on thread contexts when they are created.
3655  * If the codec allocates writable tables in init(), re-allocate them here.
3656  * priv_data will be set to a copy of the original.
3657  */
3659  /**
3660  * Copy necessary context variables from a previous thread context to the current one.
3661  * If not defined, the next thread will start automatically; otherwise, the codec
3662  * must call ff_thread_finish_setup().
3663  *
3664  * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3665  */
3667  /** @} */
3668 
3669  /**
3670  * Private codec-specific defaults.
3671  */
3673 
3674  /**
3675  * Initialize codec static data, called from avcodec_register().
3676  */
3677  void (*init_static_data)(struct AVCodec *codec);
3678 
3680  int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3681  const struct AVSubtitle *sub);
3682  /**
3683  * Encode data to an AVPacket.
3684  *
3685  * @param avctx codec context
3686  * @param avpkt output AVPacket (may contain a user-provided buffer)
3687  * @param[in] frame AVFrame containing the raw data to be encoded
3688  * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3689  * non-empty packet was returned in avpkt.
3690  * @return 0 on success, negative error code on failure
3691  */
3692  int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3693  int *got_packet_ptr);
3694  int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3695  int (*close)(AVCodecContext *);
3696  /**
3697  * Decode/encode API with decoupled packet/frame dataflow. The API is the
3698  * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3699  * that:
3700  * - never called if the codec is closed or the wrong type,
3701  * - AVPacket parameter change side data is applied right before calling
3702  * AVCodec->send_packet,
3703  * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3704  * - only one drain packet is ever passed down (until the next flush()),
3705  * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3706  */
3707  int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3708  int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3709  int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3710  int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3711  /**
3712  * Flush buffers.
3713  * Will be called when seeking
3714  */
3715  void (*flush)(AVCodecContext *);
3716  /**
3717  * Internal codec capabilities.
3718  * See FF_CODEC_CAP_* in internal.h
3719  */
3721 } AVCodec;
3722 
3723 int av_codec_get_max_lowres(const AVCodec *codec);
3724 
3725 struct MpegEncContext;
3726 
3727 /**
3728  * @defgroup lavc_hwaccel AVHWAccel
3729  * @{
3730  */
3731 typedef struct AVHWAccel {
3732  /**
3733  * Name of the hardware accelerated codec.
3734  * The name is globally unique among encoders and among decoders (but an
3735  * encoder and a decoder can share the same name).
3736  */
3737  const char *name;
3738 
3739  /**
3740  * Type of codec implemented by the hardware accelerator.
3741  *
3742  * See AVMEDIA_TYPE_xxx
3743  */
3745 
3746  /**
3747  * Codec implemented by the hardware accelerator.
3748  *
3749  * See AV_CODEC_ID_xxx
3750  */
3752 
3753  /**
3754  * Supported pixel format.
3755  *
3756  * Only hardware accelerated formats are supported here.
3757  */
3759 
3760  /**
3761  * Hardware accelerated codec capabilities.
3762  * see HWACCEL_CODEC_CAP_*
3763  */
3765 
3766  /*****************************************************************
3767  * No fields below this line are part of the public API. They
3768  * may not be used outside of libavcodec and can be changed and
3769  * removed at will.
3770  * New public fields should be added right above.
3771  *****************************************************************
3772  */
3773  struct AVHWAccel *next;
3774 
3775  /**
3776  * Allocate a custom buffer
3777  */
3779 
3780  /**
3781  * Called at the beginning of each frame or field picture.
3782  *
3783  * Meaningful frame information (codec specific) is guaranteed to
3784  * be parsed at this point. This function is mandatory.
3785  *
3786  * Note that buf can be NULL along with buf_size set to 0.
3787  * Otherwise, this means the whole frame is available at this point.
3788  *
3789  * @param avctx the codec context
3790  * @param buf the frame data buffer base
3791  * @param buf_size the size of the frame in bytes
3792  * @return zero if successful, a negative value otherwise
3793  */
3794  int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3795 
3796  /**
3797  * Callback for each slice.
3798  *
3799  * Meaningful slice information (codec specific) is guaranteed to
3800  * be parsed at this point. This function is mandatory.
3801  * The only exception is XvMC, that works on MB level.
3802  *
3803  * @param avctx the codec context
3804  * @param buf the slice data buffer base
3805  * @param buf_size the size of the slice in bytes
3806  * @return zero if successful, a negative value otherwise
3807  */
3808  int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3809 
3810  /**
3811  * Called at the end of each frame or field picture.
3812  *
3813  * The whole picture is parsed at this point and can now be sent
3814  * to the hardware accelerator. This function is mandatory.
3815  *
3816  * @param avctx the codec context
3817  * @return zero if successful, a negative value otherwise
3818  */
3819  int (*end_frame)(AVCodecContext *avctx);
3820 
3821  /**
3822  * Size of per-frame hardware accelerator private data.
3823  *
3824  * Private data is allocated with av_mallocz() before
3825  * AVCodecContext.get_buffer() and deallocated after
3826  * AVCodecContext.release_buffer().
3827  */
3829 
3830  /**
3831  * Called for every Macroblock in a slice.
3832  *
3833  * XvMC uses it to replace the ff_mpv_decode_mb().
3834  * Instead of decoding to raw picture, MB parameters are
3835  * stored in an array provided by the video driver.
3836  *
3837  * @param s the mpeg context
3838  */
3839  void (*decode_mb)(struct MpegEncContext *s);
3840 
3841  /**
3842  * Initialize the hwaccel private data.
3843  *
3844  * This will be called from ff_get_format(), after hwaccel and
3845  * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3846  * is allocated.
3847  */
3848  int (*init)(AVCodecContext *avctx);
3849 
3850  /**
3851  * Uninitialize the hwaccel private data.
3852  *
3853  * This will be called from get_format() or avcodec_close(), after hwaccel
3854  * and hwaccel_context are already uninitialized.
3855  */
3856  int (*uninit)(AVCodecContext *avctx);
3857 
3858  /**
3859  * Size of the private data to allocate in
3860  * AVCodecInternal.hwaccel_priv_data.
3861  */
3863 } AVHWAccel;
3864 
3865 /**
3866  * Hardware acceleration should be used for decoding even if the codec level
3867  * used is unknown or higher than the maximum supported level reported by the
3868  * hardware driver.
3869  *
3870  * It's generally a good idea to pass this flag unless you have a specific
3871  * reason not to, as hardware tends to under-report supported levels.
3872  */
3873 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3874 
3875 /**
3876  * Hardware acceleration can output YUV pixel formats with a different chroma
3877  * sampling than 4:2:0 and/or other than 8 bits per component.
3878  */
3879 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3880 
3881 /**
3882  * @}
3883  */
3884 
3885 #if FF_API_AVPICTURE
3886 /**
3887  * @defgroup lavc_picture AVPicture
3888  *
3889  * Functions for working with AVPicture
3890  * @{
3891  */
3892 
3893 /**
3894  * Picture data structure.
3895  *
3896  * Up to four components can be stored into it, the last component is
3897  * alpha.
3898  * @deprecated use AVFrame or imgutils functions instead
3899  */
3900 typedef struct AVPicture {
3902  uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3904  int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3905 } AVPicture;
3906 
3907 /**
3908  * @}
3909  */
3910 #endif
3911 
3914 
3915  SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3916 
3917  /**
3918  * Plain text, the text field must be set by the decoder and is
3919  * authoritative. ass and pict fields may contain approximations.
3920  */
3922 
3923  /**
3924  * Formatted text, the ass field must be set by the decoder and is
3925  * authoritative. pict and text fields may contain approximations.
3926  */
3928 };
3929 
3930 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3931 
3932 typedef struct AVSubtitleRect {
3933  int x; ///< top left corner of pict, undefined when pict is not set
3934  int y; ///< top left corner of pict, undefined when pict is not set
3935  int w; ///< width of pict, undefined when pict is not set
3936  int h; ///< height of pict, undefined when pict is not set
3937  int nb_colors; ///< number of colors in pict, undefined when pict is not set
3938 
3939 #if FF_API_AVPICTURE
3940  /**
3941  * @deprecated unused
3942  */
3945 #endif
3946  /**
3947  * data+linesize for the bitmap of this subtitle.
3948  * Can be set for text/ass as well once they are rendered.
3949  */
3950  uint8_t *data[4];
3951  int linesize[4];
3952 
3954 
3955  char *text; ///< 0 terminated plain UTF-8 text
3956 
3957  /**
3958  * 0 terminated ASS/SSA compatible event line.
3959  * The presentation of this is unaffected by the other values in this
3960  * struct.
3961  */
3962  char *ass;
3963 
3964  int flags;
3965 } AVSubtitleRect;
3966 
3967 typedef struct AVSubtitle {
3968  uint16_t format; /* 0 = graphics */
3969  uint32_t start_display_time; /* relative to packet pts, in ms */
3970  uint32_t end_display_time; /* relative to packet pts, in ms */
3971  unsigned num_rects;
3973  int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3974 } AVSubtitle;
3975 
3976 /**
3977  * This struct describes the properties of an encoded stream.
3978  *
3979  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3980  * be allocated with avcodec_parameters_alloc() and freed with
3981  * avcodec_parameters_free().
3982  */
3983 typedef struct AVCodecParameters {
3984  /**
3985  * General type of the encoded data.
3986  */
3987  enum AVMediaType codec_type;
3988  /**
3989  * Specific type of the encoded data (the codec used).
3990  */
3991  enum AVCodecID codec_id;
3992  /**
3993  * Additional information about the codec (corresponds to the AVI FOURCC).
3994  */
3995  uint32_t codec_tag;
3996 
3997  /**
3998  * Extra binary data needed for initializing the decoder, codec-dependent.
3999  *
4000  * Must be allocated with av_malloc() and will be freed by
4001  * avcodec_parameters_free(). The allocated size of extradata must be at
4002  * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4003  * bytes zeroed.
4004  */
4005  uint8_t *extradata;
4006  /**
4007  * Size of the extradata content in bytes.
4008  */
4010 
4011  /**
4012  * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4013  * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4014  */
4015  int format;
4016 
4017  /**
4018  * The average bitrate of the encoded data (in bits per second).
4019  */
4020  int64_t bit_rate;
4021 
4022  /**
4023  * The number of bits per sample in the codedwords.
4024  *
4025  * This is basically the bitrate per sample. It is mandatory for a bunch of
4026  * formats to actually decode them. It's the number of bits for one sample in
4027  * the actual coded bitstream.
4028  *
4029  * This could be for example 4 for ADPCM
4030  * For PCM formats this matches bits_per_raw_sample
4031  * Can be 0
4032  */
4034 
4035  /**
4036  * This is the number of valid bits in each output sample. If the
4037  * sample format has more bits, the least significant bits are additional
4038  * padding bits, which are always 0. Use right shifts to reduce the sample
4039  * to its actual size. For example, audio formats with 24 bit samples will
4040  * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4041  * To get the original sample use "(int32_t)sample >> 8"."
4042  *
4043  * For ADPCM this might be 12 or 16 or similar
4044  * Can be 0
4045  */
4047 
4048  /**
4049  * Codec-specific bitstream restrictions that the stream conforms to.
4050  */
4051  int profile;
4052  int level;
4053 
4054  /**
4055  * Video only. The dimensions of the video frame in pixels.
4056  */
4057  int width;
4058  int height;
4059 
4060  /**
4061  * Video only. The aspect ratio (width / height) which a single pixel
4062  * should have when displayed.
4063  *
4064  * When the aspect ratio is unknown / undefined, the numerator should be
4065  * set to 0 (the denominator may have any value).
4066  */
4068 
4069  /**
4070  * Video only. The order of the fields in interlaced video.
4071  */
4072  enum AVFieldOrder field_order;
4073 
4074  /**
4075  * Video only. Additional colorspace characteristics.
4076  */
4077  enum AVColorRange color_range;
4078  enum AVColorPrimaries color_primaries;
4080  enum AVColorSpace color_space;
4081  enum AVChromaLocation chroma_location;
4082 
4083  /**
4084  * Video only. Number of delayed frames.
4085  */
4087 
4088  /**
4089  * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4090  * unknown or unspecified, otherwise the number of bits set must be equal to
4091  * the channels field.
4092  */
4093  uint64_t channel_layout;
4094  /**
4095  * Audio only. The number of audio channels.
4096  */
4098  /**
4099  * Audio only. The number of audio samples per second.
4100  */
4102  /**
4103  * Audio only. The number of bytes per coded audio frame, required by some
4104  * formats.
4105  *
4106  * Corresponds to nBlockAlign in WAVEFORMATEX.
4107  */
4109  /**
4110  * Audio only. Audio frame size, if known. Required by some formats to be static.
4111  */
4113 
4114  /**
4115  * Audio only. The amount of padding (in samples) inserted by the encoder at
4116  * the beginning of the audio. I.e. this number of leading decoded samples
4117  * must be discarded by the caller to get the original audio without leading
4118  * padding.
4119  */
4121  /**
4122  * Audio only. The amount of padding (in samples) appended by the encoder to
4123  * the end of the audio. I.e. this number of decoded samples must be
4124  * discarded by the caller from the end of the stream to get the original
4125  * audio without any trailing padding.
4126  */
4128  /**
4129  * Audio only. Number of samples to skip after a discontinuity.
4130  */
4133 
4134 /**
4135  * If c is NULL, returns the first registered codec,
4136  * if c is non-NULL, returns the next registered codec after c,
4137  * or NULL if c is the last one.
4138  */
4139 AVCodec *av_codec_next(const AVCodec *c);
4140 
4141 /**
4142  * Return the LIBAVCODEC_VERSION_INT constant.
4143  */
4144 unsigned avcodec_version(void);
4145 
4146 /**
4147  * Return the libavcodec build-time configuration.
4148  */
4149 const char *avcodec_configuration(void);
4150 
4151 /**
4152  * Return the libavcodec license.
4153  */
4154 const char *avcodec_license(void);
4155 
4156 /**
4157  * Register the codec codec and initialize libavcodec.
4158  *
4159  * @warning either this function or avcodec_register_all() must be called
4160  * before any other libavcodec functions.
4161  *
4162  * @see avcodec_register_all()
4163  */
4164 void avcodec_register(AVCodec *codec);
4165 
4166 /**
4167  * Register all the codecs, parsers and bitstream filters which were enabled at
4168  * configuration time. If you do not call this function you can select exactly
4169  * which formats you want to support, by using the individual registration
4170  * functions.
4171  *
4172  * @see avcodec_register
4173  * @see av_register_codec_parser
4174  * @see av_register_bitstream_filter
4175  */
4176 void avcodec_register_all(void);
4177 
4178 /**
4179  * Allocate an AVCodecContext and set its fields to default values. The
4180  * resulting struct should be freed with avcodec_free_context().
4181  *
4182  * @param codec if non-NULL, allocate private data and initialize defaults
4183  * for the given codec. It is illegal to then call avcodec_open2()
4184  * with a different codec.
4185  * If NULL, then the codec-specific defaults won't be initialized,
4186  * which may result in suboptimal default settings (this is
4187  * important mainly for encoders, e.g. libx264).
4188  *
4189  * @return An AVCodecContext filled with default values or NULL on failure.
4190  */
4192 
4193 /**
4194  * Free the codec context and everything associated with it and write NULL to
4195  * the provided pointer.
4196  */
4197 void avcodec_free_context(AVCodecContext **avctx);
4198 
4199 #if FF_API_GET_CONTEXT_DEFAULTS
4200 /**
4201  * @deprecated This function should not be used, as closing and opening a codec
4202  * context multiple time is not supported. A new codec context should be
4203  * allocated for each new use.
4204  */
4206 #endif
4207 
4208 /**
4209  * Get the AVClass for AVCodecContext. It can be used in combination with
4210  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4211  *
4212  * @see av_opt_find().
4213  */
4214 const AVClass *avcodec_get_class(void);
4215 
4216 #if FF_API_COPY_CONTEXT
4217 /**
4218  * Get the AVClass for AVFrame. It can be used in combination with
4219  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4220  *
4221  * @see av_opt_find().
4222  */
4223 const AVClass *avcodec_get_frame_class(void);
4224 
4225 /**
4226  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4227  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4228  *
4229  * @see av_opt_find().
4230  */
4232 
4233 /**
4234  * Copy the settings of the source AVCodecContext into the destination
4235  * AVCodecContext. The resulting destination codec context will be
4236  * unopened, i.e. you are required to call avcodec_open2() before you
4237  * can use this AVCodecContext to decode/encode video/audio data.
4238  *
4239  * @param dest target codec context, should be initialized with
4240  * avcodec_alloc_context3(NULL), but otherwise uninitialized
4241  * @param src source codec context
4242  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4243  *
4244  * @deprecated The semantics of this function are ill-defined and it should not
4245  * be used. If you need to transfer the stream parameters from one codec context
4246  * to another, use an intermediate AVCodecParameters instance and the
4247  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4248  * functions.
4249  */
4251 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4252 #endif
4253 
4254 /**
4255  * Allocate a new AVCodecParameters and set its fields to default values
4256  * (unknown/invalid/0). The returned struct must be freed with
4257  * avcodec_parameters_free().
4258  */
4260 
4261 /**
4262  * Free an AVCodecParameters instance and everything associated with it and
4263  * write NULL to the supplied pointer.
4264  */
4266 
4267 /**
4268  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4269  * replaced with newly allocated duplicates of the corresponding fields in src.
4270  *
4271  * @return >= 0 on success, a negative AVERROR code on failure.
4272  */
4274 
4275 /**
4276  * Fill the parameters struct based on the values from the supplied codec
4277  * context. Any allocated fields in par are freed and replaced with duplicates
4278  * of the corresponding fields in codec.
4279  *
4280  * @return >= 0 on success, a negative AVERROR code on failure
4281  */
4283  const AVCodecContext *codec);
4284 
4285 /**
4286  * Fill the codec context based on the values from the supplied codec
4287  * parameters. Any allocated fields in codec that have a corresponding field in
4288  * par are freed and replaced with duplicates of the corresponding field in par.
4289  * Fields in codec that do not have a counterpart in par are not touched.
4290  *
4291  * @return >= 0 on success, a negative AVERROR code on failure.
4292  */
4294  const AVCodecParameters *par);
4295 
4296 /**
4297  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4298  * function the context has to be allocated with avcodec_alloc_context3().
4299  *
4300  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4301  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4302  * retrieving a codec.
4303  *
4304  * @warning This function is not thread safe!
4305  *
4306  * @note Always call this function before using decoding routines (such as
4307  * @ref avcodec_receive_frame()).
4308  *
4309  * @code
4310  * avcodec_register_all();
4311  * av_dict_set(&opts, "b", "2.5M", 0);
4312  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4313  * if (!codec)
4314  * exit(1);
4315  *
4316  * context = avcodec_alloc_context3(codec);
4317  *
4318  * if (avcodec_open2(context, codec, opts) < 0)
4319  * exit(1);
4320  * @endcode
4321  *
4322  * @param avctx The context to initialize.
4323  * @param codec The codec to open this context for. If a non-NULL codec has been
4324  * previously passed to avcodec_alloc_context3() or
4325  * for this context, then this parameter MUST be either NULL or
4326  * equal to the previously passed codec.
4327  * @param options A dictionary filled with AVCodecContext and codec-private options.
4328  * On return this object will be filled with options that were not found.
4329  *
4330  * @return zero on success, a negative value on error
4331  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4332  * av_dict_set(), av_opt_find().
4333  */
4334 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4335 
4336 /**
4337  * Close a given AVCodecContext and free all the data associated with it
4338  * (but not the AVCodecContext itself).
4339  *
4340  * Calling this function on an AVCodecContext that hasn't been opened will free
4341  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4342  * codec. Subsequent calls will do nothing.
4343  *
4344  * @note Do not use this function. Use avcodec_free_context() to destroy a
4345  * codec context (either open or closed). Opening and closing a codec context
4346  * multiple times is not supported anymore -- use multiple codec contexts
4347  * instead.
4348  */
4349 int avcodec_close(AVCodecContext *avctx);
4350 
4351 /**
4352  * Free all allocated data in the given subtitle struct.
4353  *
4354  * @param sub AVSubtitle to free.
4355  */
4356 void avsubtitle_free(AVSubtitle *sub);
4357 
4358 /**
4359  * @}
4360  */
4361 
4362 /**
4363  * @addtogroup lavc_packet
4364  * @{
4365  */
4366 
4367 /**
4368  * Allocate an AVPacket and set its fields to default values. The resulting
4369  * struct must be freed using av_packet_free().
4370  *
4371  * @return An AVPacket filled with default values or NULL on failure.
4372  *
4373  * @note this only allocates the AVPacket itself, not the data buffers. Those
4374  * must be allocated through other means such as av_new_packet.
4375  *
4376  * @see av_new_packet
4377  */
4378 AVPacket *av_packet_alloc(void);
4379 
4380 /**
4381  * Create a new packet that references the same data as src.
4382  *
4383  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4384  *
4385  * @return newly created AVPacket on success, NULL on error.
4386  *
4387  * @see av_packet_alloc
4388  * @see av_packet_ref
4389  */
4391 
4392 /**
4393  * Free the packet, if the packet is reference counted, it will be
4394  * unreferenced first.
4395  *
4396  * @param packet packet to be freed. The pointer will be set to NULL.
4397  * @note passing NULL is a no-op.
4398  */
4399 void av_packet_free(AVPacket **pkt);
4400 
4401 /**
4402  * Initialize optional fields of a packet with default values.
4403  *
4404  * Note, this does not touch the data and size members, which have to be
4405  * initialized separately.
4406  *
4407  * @param pkt packet
4408  */
4409 void av_init_packet(AVPacket *pkt);
4410 
4411 /**
4412  * Allocate the payload of a packet and initialize its fields with
4413  * default values.
4414  *
4415  * @param pkt packet
4416  * @param size wanted payload size
4417  * @return 0 if OK, AVERROR_xxx otherwise
4418  */
4419 int av_new_packet(AVPacket *pkt, int size);
4420 
4421 /**
4422  * Reduce packet size, correctly zeroing padding
4423  *
4424  * @param pkt packet
4425  * @param size new size
4426  */
4427 void av_shrink_packet(AVPacket *pkt, int size);
4428 
4429 /**
4430  * Increase packet size, correctly zeroing padding
4431  *
4432  * @param pkt packet
4433  * @param grow_by number of bytes by which to increase the size of the packet
4434  */
4435 int av_grow_packet(AVPacket *pkt, int grow_by);
4436 
4437 /**
4438  * Initialize a reference-counted packet from av_malloc()ed data.
4439  *
4440  * @param pkt packet to be initialized. This function will set the data, size,
4441  * buf and destruct fields, all others are left untouched.
4442  * @param data Data allocated by av_malloc() to be used as packet data. If this
4443  * function returns successfully, the data is owned by the underlying AVBuffer.
4444  * The caller may not access the data through other means.
4445  * @param size size of data in bytes, without the padding. I.e. the full buffer
4446  * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4447  *
4448  * @return 0 on success, a negative AVERROR on error
4449  */
4450 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4451 
4452 #if FF_API_AVPACKET_OLD_API
4453 /**
4454  * @warning This is a hack - the packet memory allocation stuff is broken. The
4455  * packet is allocated if it was not really allocated.
4456  *
4457  * @deprecated Use av_packet_ref
4458  */
4460 int av_dup_packet(AVPacket *pkt);
4461 /**
4462  * Copy packet, including contents
4463  *
4464  * @return 0 on success, negative AVERROR on fail
4465  */
4466 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4467 
4468 /**
4469  * Copy packet side data
4470  *
4471  * @return 0 on success, negative AVERROR on fail
4472  */
4473 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4474 
4475 /**
4476  * Free a packet.
4477  *
4478  * @deprecated Use av_packet_unref
4479  *
4480  * @param pkt packet to free
4481  */
4483 void av_free_packet(AVPacket *pkt);
4484 #endif
4485 /**
4486  * Allocate new information of a packet.
4487  *
4488  * @param pkt packet
4489  * @param type side information type
4490  * @param size side information size
4491  * @return pointer to fresh allocated data or NULL otherwise
4492  */
4494  int size);
4495 
4496 /**
4497  * Wrap an existing array as a packet side data.
4498  *
4499  * @param pkt packet
4500  * @param type side information type
4501  * @param data the side data array. It must be allocated with the av_malloc()
4502  * family of functions. The ownership of the data is transferred to
4503  * pkt.
4504  * @param size side information size
4505  * @return a non-negative number on success, a negative AVERROR code on
4506  * failure. On failure, the packet is unchanged and the data remains
4507  * owned by the caller.
4508  */
4510  uint8_t *data, size_t size);
4511 
4512 /**
4513  * Shrink the already allocated side data buffer
4514  *
4515  * @param pkt packet
4516  * @param type side information type
4517  * @param size new side information size
4518  * @return 0 on success, < 0 on failure
4519  */
4521  int size);
4522 
4523 /**
4524  * Get side information from packet.
4525  *
4526  * @param pkt packet
4527  * @param type desired side information type
4528  * @param size pointer for side information size to store (optional)
4529  * @return pointer to data if present or NULL otherwise
4530  */
4532  int *size);
4533 
4535 
4537 
4539 
4540 /**
4541  * Pack a dictionary for use in side_data.
4542  *
4543  * @param dict The dictionary to pack.
4544  * @param size pointer to store the size of the returned data
4545  * @return pointer to data if successful, NULL otherwise
4546  */
4547 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4548 /**
4549  * Unpack a dictionary from side_data.
4550  *
4551  * @param data data from side_data
4552  * @param size size of the data
4553  * @param dict the metadata storage dictionary
4554  * @return 0 on success, < 0 on failure
4555  */
4556 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4557 
4558 
4559 /**
4560  * Convenience function to free all the side data stored.
4561  * All the other fields stay untouched.
4562  *
4563  * @param pkt packet
4564  */
4566 
4567 /**
4568  * Setup a new reference to the data described by a given packet
4569  *
4570  * If src is reference-counted, setup dst as a new reference to the
4571  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4572  * data from src into it.
4573  *
4574  * All the other fields are copied from src.
4575  *
4576  * @see av_packet_unref
4577  *
4578  * @param dst Destination packet
4579  * @param src Source packet
4580  *
4581  * @return 0 on success, a negative AVERROR on error.
4582  */
4583 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4584 
4585 /**
4586  * Wipe the packet.
4587  *
4588  * Unreference the buffer referenced by the packet and reset the
4589  * remaining packet fields to their default values.
4590  *
4591  * @param pkt The packet to be unreferenced.
4592  */
4594 
4595 /**
4596  * Move every field in src to dst and reset src.
4597  *
4598  * @see av_packet_unref
4599  *
4600  * @param src Source packet, will be reset
4601  * @param dst Destination packet
4602  */
4603 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4604 
4605 /**
4606  * Copy only "properties" fields from src to dst.
4607  *
4608  * Properties for the purpose of this function are all the fields
4609  * beside those related to the packet data (buf, data, size)
4610  *
4611  * @param dst Destination packet
4612  * @param src Source packet
4613  *
4614  * @return 0 on success AVERROR on failure.
4615  */
4616 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4617 
4618 /**
4619  * Convert valid timing fields (timestamps / durations) in a packet from one
4620  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4621  * ignored.
4622  *
4623  * @param pkt packet on which the conversion will be performed
4624  * @param tb_src source timebase, in which the timing fields in pkt are
4625  * expressed
4626  * @param tb_dst destination timebase, to which the timing fields will be
4627  * converted
4628  */
4629 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4630 
4631 /**
4632  * @}
4633  */
4634 
4635 /**
4636  * @addtogroup lavc_decoding
4637  * @{
4638  */
4639 
4640 /**
4641  * Find a registered decoder with a matching codec ID.
4642  *
4643  * @param id AVCodecID of the requested decoder
4644  * @return A decoder if one was found, NULL otherwise.
4645  */
4647 
4648 /**
4649  * Find a registered decoder with the specified name.
4650  *
4651  * @param name name of the requested decoder
4652  * @return A decoder if one was found, NULL otherwise.
4653  */
4655 
4656 /**
4657  * The default callback for AVCodecContext.get_buffer2(). It is made public so
4658  * it can be called by custom get_buffer2() implementations for decoders without
4659  * AV_CODEC_CAP_DR1 set.
4660  */
4662 
4663 #if FF_API_EMU_EDGE
4664 /**
4665  * Return the amount of padding in pixels which the get_buffer callback must
4666  * provide around the edge of the image for codecs which do not have the
4667  * CODEC_FLAG_EMU_EDGE flag.
4668  *
4669  * @return Required padding in pixels.
4670  *
4671  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4672  * needed
4673  */
4675 unsigned avcodec_get_edge_width(void);
4676 #endif
4677 
4678 /**
4679  * Modify width and height values so that they will result in a memory
4680  * buffer that is acceptable for the codec if you do not use any horizontal
4681  * padding.
4682  *
4683  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4684  */
4686 
4687 /**
4688  * Modify width and height values so that they will result in a memory
4689  * buffer that is acceptable for the codec if you also ensure that all
4690  * line sizes are a multiple of the respective linesize_align[i].
4691  *
4692  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4693  */
4695  int linesize_align[AV_NUM_DATA_POINTERS]);
4696 
4697 /**
4698  * Converts AVChromaLocation to swscale x/y chroma position.
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 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4707 
4708 /**
4709  * Converts swscale x/y chroma position to AVChromaLocation.
4710  *
4711  * The positions represent the chroma (0,0) position in a coordinates system
4712  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4713  *
4714  * @param xpos horizontal chroma sample position
4715  * @param ypos vertical chroma sample position
4716  */
4717 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4718 
4719 /**
4720  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4721  *
4722  * Some decoders may support multiple frames in a single AVPacket. Such
4723  * decoders would then just decode the first frame and the return value would be
4724  * less than the packet size. In this case, avcodec_decode_audio4 has to be
4725  * called again with an AVPacket containing the remaining data in order to
4726  * decode the second frame, etc... Even if no frames are returned, the packet
4727  * needs to be fed to the decoder with remaining data until it is completely
4728  * consumed or an error occurs.
4729  *
4730  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4731  * and output. This means that for some packets they will not immediately
4732  * produce decoded output and need to be flushed at the end of decoding to get
4733  * all the decoded data. Flushing is done by calling this function with packets
4734  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4735  * returning samples. It is safe to flush even those decoders that are not
4736  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4737  *
4738  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4739  * larger than the actual read bytes because some optimized bitstream
4740  * readers read 32 or 64 bits at once and could read over the end.
4741  *
4742  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4743  * before packets may be fed to the decoder.
4744  *
4745  * @param avctx the codec context
4746  * @param[out] frame The AVFrame in which to store decoded audio samples.
4747  * The decoder will allocate a buffer for the decoded frame by
4748  * calling the AVCodecContext.get_buffer2() callback.
4749  * When AVCodecContext.refcounted_frames is set to 1, the frame is
4750  * reference counted and the returned reference belongs to the
4751  * caller. The caller must release the frame using av_frame_unref()
4752  * when the frame is no longer needed. The caller may safely write
4753  * to the frame if av_frame_is_writable() returns 1.
4754  * When AVCodecContext.refcounted_frames is set to 0, the returned
4755  * reference belongs to the decoder and is valid only until the
4756  * next call to this function or until closing or flushing the
4757  * decoder. The caller may not write to it.
4758  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4759  * non-zero. Note that this field being set to zero
4760  * does not mean that an error has occurred. For
4761  * decoders with AV_CODEC_CAP_DELAY set, no given decode
4762  * call is guaranteed to produce a frame.
4763  * @param[in] avpkt The input AVPacket containing the input buffer.
4764  * At least avpkt->data and avpkt->size should be set. Some
4765  * decoders might also require additional fields to be set.
4766  * @return A negative error code is returned if an error occurred during
4767  * decoding, otherwise the number of bytes consumed from the input
4768  * AVPacket is returned.
4769  *
4770 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4771  */
4774  int *got_frame_ptr, const AVPacket *avpkt);
4775 
4776 /**
4777  * Decode the video frame of size avpkt->size from avpkt->data into picture.
4778  * Some decoders may support multiple frames in a single AVPacket, such
4779  * decoders would then just decode the first frame.
4780  *
4781  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4782  * the actual read bytes because some optimized bitstream readers read 32 or 64
4783  * bits at once and could read over the end.
4784  *
4785  * @warning The end of the input buffer buf should be set to 0 to ensure that
4786  * no overreading happens for damaged MPEG streams.
4787  *
4788  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4789  * between input and output, these need to be fed with avpkt->data=NULL,
4790  * avpkt->size=0 at the end to return the remaining frames.
4791  *
4792  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4793  * before packets may be fed to the decoder.
4794  *
4795  * @param avctx the codec context
4796  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4797  * Use av_frame_alloc() to get an AVFrame. The codec will
4798  * allocate memory for the actual bitmap by calling the
4799  * AVCodecContext.get_buffer2() callback.
4800  * When AVCodecContext.refcounted_frames is set to 1, the frame is
4801  * reference counted and the returned reference belongs to the
4802  * caller. The caller must release the frame using av_frame_unref()
4803  * when the frame is no longer needed. The caller may safely write
4804  * to the frame if av_frame_is_writable() returns 1.
4805  * When AVCodecContext.refcounted_frames is set to 0, the returned
4806  * reference belongs to the decoder and is valid only until the
4807  * next call to this function or until closing or flushing the
4808  * decoder. The caller may not write to it.
4809  *
4810  * @param[in] avpkt The input AVPacket containing the input buffer.
4811  * You can create such packet with av_init_packet() and by then setting
4812  * data and size, some decoders might in addition need other fields like
4813  * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4814  * fields possible.
4815  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4816  * @return On error a negative value is returned, otherwise the number of bytes
4817  * used or zero if no frame could be decompressed.
4818  *
4819  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4820  */
4822 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4823  int *got_picture_ptr,
4824  const AVPacket *avpkt);
4825 
4826 /**
4827  * Decode a subtitle message.
4828  * Return a negative value on error, otherwise return the number of bytes used.
4829  * If no subtitle could be decompressed, got_sub_ptr is zero.
4830  * Otherwise, the subtitle is stored in *sub.
4831  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4832  * simplicity, because the performance difference is expect to be negligible
4833  * and reusing a get_buffer written for video codecs would probably perform badly
4834  * due to a potentially very different allocation pattern.
4835  *
4836  * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4837  * and output. This means that for some packets they will not immediately
4838  * produce decoded output and need to be flushed at the end of decoding to get
4839  * all the decoded data. Flushing is done by calling this function with packets
4840  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4841  * returning subtitles. It is safe to flush even those decoders that are not
4842  * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4843  *
4844  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4845  * before packets may be fed to the decoder.
4846  *
4847  * @param avctx the codec context
4848  * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4849  * must be freed with avsubtitle_free if *got_sub_ptr is set.
4850  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4851  * @param[in] avpkt The input AVPacket containing the input buffer.
4852  */
4854  int *got_sub_ptr,
4855  AVPacket *avpkt);
4856 
4857 /**
4858  * Supply raw packet data as input to a decoder.
4859  *
4860  * Internally, this call will copy relevant AVCodecContext fields, which can
4861  * influence decoding per-packet, and apply them when the packet is actually
4862  * decoded. (For example AVCodecContext.skip_frame, which might direct the
4863  * decoder to drop the frame contained by the packet sent with this function.)
4864  *
4865  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4866  * larger than the actual read bytes because some optimized bitstream
4867  * readers read 32 or 64 bits at once and could read over the end.
4868  *
4869  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4870  * on the same AVCodecContext. It will return unexpected results now
4871  * or in future libavcodec versions.
4872  *
4873  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4874  * before packets may be fed to the decoder.
4875  *
4876  * @param avctx codec context
4877  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4878  * frame, or several complete audio frames.
4879  * Ownership of the packet remains with the caller, and the
4880  * decoder will not write to the packet. The decoder may create
4881  * a reference to the packet data (or copy it if the packet is
4882  * not reference-counted).
4883  * Unlike with older APIs, the packet is always fully consumed,
4884  * and if it contains multiple frames (e.g. some audio codecs),
4885  * will require you to call avcodec_receive_frame() multiple
4886  * times afterwards before you can send a new packet.
4887  * It can be NULL (or an AVPacket with data set to NULL and
4888  * size set to 0); in this case, it is considered a flush
4889  * packet, which signals the end of the stream. Sending the
4890  * first flush packet will return success. Subsequent ones are
4891  * unnecessary and will return AVERROR_EOF. If the decoder
4892  * still has frames buffered, it will return them after sending
4893  * a flush packet.
4894  *
4895  * @return 0 on success, otherwise negative error code:
4896  * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4897  * resent after trying to read output
4898  * AVERROR_EOF: the decoder has been flushed, and no new packets can
4899  * be sent to it (also returned if more than 1 flush
4900  * packet is sent)
4901  * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4902  * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4903  * other errors: legitimate decoding errors
4904  */
4905 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4906 
4907 /**
4908  * Return decoded output data from a decoder.
4909  *
4910  * @param avctx codec context
4911  * @param frame This will be set to a reference-counted video or audio
4912  * frame (depending on the decoder type) allocated by the
4913  * decoder. Note that the function will always call
4914  * av_frame_unref(frame) before doing anything else.
4915  *
4916  * @return
4917  * 0: success, a frame was returned
4918  * AVERROR(EAGAIN): output is not available right now - user must try
4919  * to send new input
4920  * AVERROR_EOF: the decoder has been fully flushed, and there will be
4921  * no more output frames
4922  * AVERROR(EINVAL): codec not opened, or it is an encoder
4923  * other negative values: legitimate decoding errors
4924  */
4926 
4927 /**
4928  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4929  * to retrieve buffered output packets.
4930  *
4931  * @param avctx codec context
4932  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4933  * Ownership of the frame remains with the caller, and the
4934  * encoder will not write to the frame. The encoder may create
4935  * a reference to the frame data (or copy it if the frame is
4936  * not reference-counted).
4937  * It can be NULL, in which case it is considered a flush
4938  * packet. This signals the end of the stream. If the encoder
4939  * still has packets buffered, it will return them after this
4940  * call. Once flushing mode has been entered, additional flush
4941  * packets are ignored, and sending frames will return
4942  * AVERROR_EOF.
4943  *
4944  * For audio:
4945  * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4946  * can have any number of samples.
4947  * If it is not set, frame->nb_samples must be equal to
4948  * avctx->frame_size for all frames except the last.
4949  * The final frame may be smaller than avctx->frame_size.
4950  * @return 0 on success, otherwise negative error code:
4951  * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4952  * resent after trying to read output packets
4953  * AVERROR_EOF: the encoder has been flushed, and no new frames can
4954  * be sent to it
4955  * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4956  * decoder, or requires flush
4957  * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4958  * other errors: legitimate decoding errors
4959  */
4960 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4961 
4962 /**
4963  * Read encoded data from the encoder.
4964  *
4965  * @param avctx codec context
4966  * @param avpkt This will be set to a reference-counted packet allocated by the
4967  * encoder. Note that the function will always call
4968  * av_frame_unref(frame) before doing anything else.
4969  * @return 0 on success, otherwise negative error code:
4970  * AVERROR(EAGAIN): output is not available right now - user must try
4971  * to send input
4972  * AVERROR_EOF: the encoder has been fully flushed, and there will be
4973  * no more output packets
4974  * AVERROR(EINVAL): codec not opened, or it is an encoder
4975  * other errors: legitimate decoding errors
4976  */
4977 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4978 
4979 
4980 /**
4981  * @defgroup lavc_parsing Frame parsing
4982  * @{
4983  */
4984 
4987  AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4988  AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4989  AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4990 };
4991 
4992 typedef struct AVCodecParserContext {
4993  void *priv_data;
4995  int64_t frame_offset; /* offset of the current frame */
4996  int64_t cur_offset; /* current offset
4997  (incremented by each av_parser_parse()) */
4998  int64_t next_frame_offset; /* offset of the next frame */
4999  /* video info */
5000  int pict_type; /* XXX: Put it back in AVCodecContext. */
5001  /**
5002  * This field is used for proper frame duration computation in lavf.
5003  * It signals, how much longer the frame duration of the current frame
5004  * is compared to normal frame duration.
5005  *
5006  * frame_duration = (1 + repeat_pict) * time_base
5007  *
5008  * It is used by codecs like H.264 to display telecined material.
5009  */
5010  int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5011  int64_t pts; /* pts of the current frame */
5012  int64_t dts; /* dts of the current frame */
5013 
5014  /* private data */
5015  int64_t last_pts;
5016  int64_t last_dts;
5018 
5019 #define AV_PARSER_PTS_NB 4
5021  int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5022  int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5023  int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5024 
5025  int flags;
5026 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5027 #define PARSER_FLAG_ONCE 0x0002
5028 /// Set if the parser has a valid file offset
5029 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5030 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5031 
5032  int64_t offset; ///< byte offset from starting packet start
5033  int64_t cur_frame_end[AV_PARSER_PTS_NB];
5034 
5035  /**
5036  * Set by parser to 1 for key frames and 0 for non-key frames.
5037  * It is initialized to -1, so if the parser doesn't set this flag,
5038  * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5039  * will be used.
5040  */
5042 
5043 #if FF_API_CONVERGENCE_DURATION
5044  /**
5045  * @deprecated unused
5046  */
5049 #endif
5050 
5051  // Timestamp generation support:
5052  /**
5053  * Synchronization point for start of timestamp generation.
5054  *
5055  * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5056  * (default).
5057  *
5058  * For example, this corresponds to presence of H.264 buffering period
5059  * SEI message.
5060  */
5062 
5063  /**
5064  * Offset of the current timestamp against last timestamp sync point in
5065  * units of AVCodecContext.time_base.
5066  *
5067  * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5068  * contain a valid timestamp offset.
5069  *
5070  * Note that the timestamp of sync point has usually a nonzero
5071  * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5072  * the next frame after timestamp sync point will be usually 1.
5073  *
5074  * For example, this corresponds to H.264 cpb_removal_delay.
5075  */
5077 
5078  /**
5079  * Presentation delay of current frame in units of AVCodecContext.time_base.
5080  *
5081  * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5082  * contain valid non-negative timestamp delta (presentation time of a frame
5083  * must not lie in the past).
5084  *
5085  * This delay represents the difference between decoding and presentation
5086  * time of the frame.
5087  *
5088  * For example, this corresponds to H.264 dpb_output_delay.
5089  */
5091 
5092  /**
5093  * Position of the packet in file.
5094  *
5095  * Analogous to cur_frame_pts/dts
5096  */
5097  int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5098 
5099  /**
5100  * Byte position of currently parsed frame in stream.
5101  */
5102  int64_t pos;
5103 
5104  /**
5105  * Previous frame byte position.
5106  */
5107  int64_t last_pos;
5108 
5109  /**
5110  * Duration of the current frame.
5111  * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5112  * For all other types, this is in units of AVCodecContext.time_base.
5113  */
5115 
5116  enum AVFieldOrder field_order;
5117 
5118  /**
5119  * Indicate whether a picture is coded as a frame, top field or bottom field.
5120  *
5121  * For example, H.264 field_pic_flag equal to 0 corresponds to
5122  * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5123  * equal to 1 and bottom_field_flag equal to 0 corresponds to
5124  * AV_PICTURE_STRUCTURE_TOP_FIELD.
5125  */
5126  enum AVPictureStructure picture_structure;
5127 
5128  /**
5129  * Picture number incremented in presentation or output order.
5130  * This field may be reinitialized at the first picture of a new sequence.
5131  *
5132  * For example, this corresponds to H.264 PicOrderCnt.
5133  */
5135 
5136  /**
5137  * Dimensions of the decoded video intended for presentation.
5138  */
5139  int width;
5140  int height;
5141 
5142  /**
5143  * Dimensions of the coded video.
5144  */
5147 
5148  /**
5149  * The format of the coded data, corresponds to enum AVPixelFormat for video
5150  * and for enum AVSampleFormat for audio.
5151  *
5152  * Note that a decoder can have considerable freedom in how exactly it
5153  * decodes the data, so the format reported here might be different from the
5154  * one returned by a decoder.
5155  */
5156  int format;
5158 
5159 typedef struct AVCodecParser {
5160  int codec_ids[5]; /* several codec IDs are permitted */
5162  int (*parser_init)(AVCodecParserContext *s);
5163  /* This callback never returns an error, a negative value means that
5164  * the frame start was in a previous packet. */
5165  int (*parser_parse)(AVCodecParserContext *s,
5166  AVCodecContext *avctx,
5167  const uint8_t **poutbuf, int *poutbuf_size,
5168  const uint8_t *buf, int buf_size);
5169  void (*parser_close)(AVCodecParserContext *s);
5170  int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5172 } AVCodecParser;
5173 
5175 
5177 AVCodecParserContext *av_parser_init(int codec_id);
5178 
5179 /**
5180  * Parse a packet.
5181  *
5182  * @param s parser context.
5183  * @param avctx codec context.
5184  * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5185  * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5186  * @param buf input buffer.
5187  * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5188  size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5189  To signal EOF, this should be 0 (so that the last frame
5190  can be output).
5191  * @param pts input presentation timestamp.
5192  * @param dts input decoding timestamp.
5193  * @param pos input byte position in stream.
5194  * @return the number of bytes of the input bitstream used.
5195  *
5196  * Example:
5197  * @code
5198  * while(in_len){
5199  * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5200  * in_data, in_len,
5201  * pts, dts, pos);
5202  * in_data += len;
5203  * in_len -= len;
5204  *
5205  * if(size)
5206  * decode_frame(data, size);
5207  * }
5208  * @endcode
5209  */
5211  AVCodecContext *avctx,
5212  uint8_t **poutbuf, int *poutbuf_size,
5213  const uint8_t *buf, int buf_size,
5214  int64_t pts, int64_t dts,
5215  int64_t pos);
5216 
5217 /**
5218  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5219  * @deprecated use AVBitStreamFilter
5220  */
5222  AVCodecContext *avctx,
5223  uint8_t **poutbuf, int *poutbuf_size,
5224  const uint8_t *buf, int buf_size, int keyframe);
5226 
5227 /**
5228  * @}
5229  * @}
5230  */
5231 
5232 /**
5233  * @addtogroup lavc_encoding
5234  * @{
5235  */
5236 
5237 /**
5238  * Find a registered encoder with a matching codec ID.
5239  *
5240  * @param id AVCodecID of the requested encoder
5241  * @return An encoder if one was found, NULL otherwise.
5242  */
5244 
5245 /**
5246  * Find a registered encoder with the specified name.
5247  *
5248  * @param name name of the requested encoder
5249  * @return An encoder if one was found, NULL otherwise.
5250  */
5252 
5253 /**
5254  * Encode a frame of audio.
5255  *
5256  * Takes input samples from frame and writes the next output packet, if
5257  * available, to avpkt. The output packet does not necessarily contain data for
5258  * the most recent frame, as encoders can delay, split, and combine input frames
5259  * internally as needed.
5260  *
5261  * @param avctx codec context
5262  * @param avpkt output AVPacket.
5263  * The user can supply an output buffer by setting
5264  * avpkt->data and avpkt->size prior to calling the
5265  * function, but if the size of the user-provided data is not
5266  * large enough, encoding will fail. If avpkt->data and
5267  * avpkt->size are set, avpkt->destruct must also be set. All
5268  * other AVPacket fields will be reset by the encoder using
5269  * av_init_packet(). If avpkt->data is NULL, the encoder will
5270  * allocate it. The encoder will set avpkt->size to the size
5271  * of the output packet.
5272  *
5273  * If this function fails or produces no output, avpkt will be
5274  * freed using av_packet_unref().
5275  * @param[in] frame AVFrame containing the raw audio data to be encoded.
5276  * May be NULL when flushing an encoder that has the
5277  * AV_CODEC_CAP_DELAY capability set.
5278  * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5279  * can have any number of samples.
5280  * If it is not set, frame->nb_samples must be equal to
5281  * avctx->frame_size for all frames except the last.
5282  * The final frame may be smaller than avctx->frame_size.
5283  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5284  * output packet is non-empty, and to 0 if it is
5285  * empty. If the function returns an error, the
5286  * packet can be assumed to be invalid, and the
5287  * value of got_packet_ptr is undefined and should
5288  * not be used.
5289  * @return 0 on success, negative error code on failure
5290  *
5291  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5292  */
5294 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5295  const AVFrame *frame, int *got_packet_ptr);
5296 
5297 /**
5298  * Encode a frame of video.
5299  *
5300  * Takes input raw video data from frame and writes the next output packet, if
5301  * available, to avpkt. The output packet does not necessarily contain data for
5302  * the most recent frame, as encoders can delay and reorder input frames
5303  * internally as needed.
5304  *
5305  * @param avctx codec context
5306  * @param avpkt output AVPacket.
5307  * The user can supply an output buffer by setting
5308  * avpkt->data and avpkt->size prior to calling the
5309  * function, but if the size of the user-provided data is not
5310  * large enough, encoding will fail. All other AVPacket fields
5311  * will be reset by the encoder using av_init_packet(). If
5312  * avpkt->data is NULL, the encoder will allocate it.
5313  * The encoder will set avpkt->size to the size of the
5314  * output packet. The returned data (if any) belongs to the
5315  * caller, he is responsible for freeing it.
5316  *
5317  * If this function fails or produces no output, avpkt will be
5318  * freed using av_packet_unref().
5319  * @param[in] frame AVFrame containing the raw video data to be encoded.
5320  * May be NULL when flushing an encoder that has the
5321  * AV_CODEC_CAP_DELAY capability set.
5322  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5323  * output packet is non-empty, and to 0 if it is
5324  * empty. If the function returns an error, the
5325  * packet can be assumed to be invalid, and the
5326  * value of got_packet_ptr is undefined and should
5327  * not be used.
5328  * @return 0 on success, negative error code on failure
5329  *
5330  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5331  */
5333 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5334  const AVFrame *frame, int *got_packet_ptr);
5335 
5336 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5337  const AVSubtitle *sub);
5338 
5339 
5340 /**
5341  * @}
5342  */
5343 
5344 #if FF_API_AVCODEC_RESAMPLE
5345 /**
5346  * @defgroup lavc_resample Audio resampling
5347  * @ingroup libavc
5348  * @deprecated use libswresample instead
5349  *
5350  * @{
5351  */
5352 struct ReSampleContext;
5353 struct AVResampleContext;
5354 
5356 
5357 /**
5358  * Initialize audio resampling context.
5359  *
5360  * @param output_channels number of output channels
5361  * @param input_channels number of input channels
5362  * @param output_rate output sample rate
5363  * @param input_rate input sample rate
5364  * @param sample_fmt_out requested output sample format
5365  * @param sample_fmt_in input sample format
5366  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5367  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5368  * @param linear if 1 then the used FIR filter will be linearly interpolated
5369  between the 2 closest, if 0 the closest will be used
5370  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5371  * @return allocated ReSampleContext, NULL if error occurred
5372  */
5374 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5375  int output_rate, int input_rate,
5376  enum AVSampleFormat sample_fmt_out,
5377  enum AVSampleFormat sample_fmt_in,
5378  int filter_length, int log2_phase_count,
5379  int linear, double cutoff);
5380 
5382 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5383 
5384 /**
5385  * Free resample context.
5386  *
5387  * @param s a non-NULL pointer to a resample context previously
5388  * created with av_audio_resample_init()
5389  */
5392 
5393 
5394 /**
5395  * Initialize an audio resampler.
5396  * Note, if either rate is not an integer then simply scale both rates up so they are.
5397  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5398  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5399  * @param linear If 1 then the used FIR filter will be linearly interpolated
5400  between the 2 closest, if 0 the closest will be used
5401  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5402  */
5404 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5405 
5406 /**
5407  * Resample an array of samples using a previously configured context.
5408  * @param src an array of unconsumed samples
5409  * @param consumed the number of samples of src which have been consumed are returned here
5410  * @param src_size the number of unconsumed samples available
5411  * @param dst_size the amount of space in samples available in dst
5412  * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
5413  * @return the number of samples written in dst or -1 if an error occurred
5414  */
5416 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5417 
5418 
5419 /**
5420  * Compensate samplerate/timestamp drift. The compensation is done by changing
5421  * the resampler parameters, so no audible clicks or similar distortions occur
5422  * @param compensation_distance distance in output samples over which the compensation should be performed
5423  * @param sample_delta number of output samples which should be output less
5424  *
5425  * example: av_resample_compensate(c, 10, 500)
5426  * here instead of 510 samples only 500 samples would be output
5427  *
5428  * note, due to rounding the actual compensation might be slightly different,
5429  * especially if the compensation_distance is large and the in_rate used during init is small
5430  */
5432 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5434 void av_resample_close(struct AVResampleContext *c);
5435 
5436 /**
5437  * @}
5438  */
5439 #endif
5440 
5441 #if FF_API_AVPICTURE
5442 /**
5443  * @addtogroup lavc_picture
5444  * @{
5445  */
5446 
5447 /**
5448  * @deprecated unused
5449  */
5451 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5452 
5453 /**
5454  * @deprecated unused
5455  */
5457 void avpicture_free(AVPicture *picture);
5458 
5459 /**
5460  * @deprecated use av_image_fill_arrays() instead.
5461  */
5463 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5464  enum AVPixelFormat pix_fmt, int width, int height);
5465 
5466 /**
5467  * @deprecated use av_image_copy_to_buffer() instead.
5468  */
5470 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5471  int width, int height,
5472  unsigned char *dest, int dest_size);
5473 
5474 /**
5475  * @deprecated use av_image_get_buffer_size() instead.
5476  */
5479 
5480 /**
5481  * @deprecated av_image_copy() instead.
5482  */
5484 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5485  enum AVPixelFormat pix_fmt, int width, int height);
5486 
5487 /**
5488  * @deprecated unused
5489  */
5491 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5492  enum AVPixelFormat pix_fmt, int top_band, int left_band);
5493 
5494 /**
5495  * @deprecated unused
5496  */
5498 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5499  int padtop, int padbottom, int padleft, int padright, int *color);
5500 
5501 /**
5502  * @}
5503  */
5504 #endif
5505 
5506 /**
5507  * @defgroup lavc_misc Utility functions
5508  * @ingroup libavc
5509  *
5510  * Miscellaneous utility functions related to both encoding and decoding
5511  * (or neither).
5512  * @{
5513  */
5514 
5515 /**
5516  * @defgroup lavc_misc_pixfmt Pixel formats
5517  *
5518  * Functions for working with pixel formats.
5519  * @{
5520  */
5521 
5522 /**
5523  * Utility function to access log2_chroma_w log2_chroma_h from
5524  * the pixel format AVPixFmtDescriptor.
5525  *
5526  * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5527  * for one that returns a failure code and continues in case of invalid
5528  * pix_fmts.
5529  *
5530  * @param[in] pix_fmt the pixel format
5531  * @param[out] h_shift store log2_chroma_w
5532  * @param[out] v_shift store log2_chroma_h
5533  *
5534  * @see av_pix_fmt_get_chroma_sub_sample
5535  */
5536 
5537 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5538 
5539 /**
5540  * Return a value representing the fourCC code associated to the
5541  * pixel format pix_fmt, or 0 if no associated fourCC code can be
5542  * found.
5543  */
5545 
5546 /**
5547  * @deprecated see av_get_pix_fmt_loss()
5548  */
5549 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5550  int has_alpha);
5551 
5552 /**
5553  * Find the best pixel format to convert to given a certain source pixel
5554  * format. When converting from one pixel format to another, information loss
5555  * may occur. For example, when converting from RGB24 to GRAY, the color
5556  * information will be lost. Similarly, other losses occur when converting from
5557  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5558  * the given pixel formats should be used to suffer the least amount of loss.
5559  * The pixel formats from which it chooses one, are determined by the
5560  * pix_fmt_list parameter.
5561  *
5562  *
5563  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5564  * @param[in] src_pix_fmt source pixel format
5565  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5566  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5567  * @return The best pixel format to convert to or -1 if none was found.
5568  */
5569 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5570  enum AVPixelFormat src_pix_fmt,
5571  int has_alpha, int *loss_ptr);
5572 
5573 /**
5574  * @deprecated see av_find_best_pix_fmt_of_2()
5575  */
5576 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5577  enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5578 
5580 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5581  enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5582 
5583 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5584 
5585 /**
5586  * @}
5587  */
5588 
5589 #if FF_API_SET_DIMENSIONS
5590 /**
5591  * @deprecated this function is not supposed to be used from outside of lavc
5592  */
5595 #endif
5596 
5597 /**
5598  * Put a string representing the codec tag codec_tag in buf.
5599  *
5600  * @param buf buffer to place codec tag in
5601  * @param buf_size size in bytes of buf
5602  * @param codec_tag codec tag to assign
5603  * @return the length of the string that would have been generated if
5604  * enough space had been available, excluding the trailing null
5605  */
5606 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5607 
5608 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5609 
5610 /**
5611  * Return a name for the specified profile, if available.
5612  *
5613  * @param codec the codec that is searched for the given profile
5614  * @param profile the profile value for which a name is requested
5615  * @return A name for the profile if found, NULL otherwise.
5616  */
5617 const char *av_get_profile_name(const AVCodec *codec, int profile);
5618 
5619 /**
5620  * Return a name for the specified profile, if available.
5621  *
5622  * @param codec_id the ID of the codec to which the requested profile belongs
5623  * @param profile the profile value for which a name is requested
5624  * @return A name for the profile if found, NULL otherwise.
5625  *
5626  * @note unlike av_get_profile_name(), which searches a list of profiles
5627  * supported by a specific decoder or encoder implementation, this
5628  * function searches the list of profiles from the AVCodecDescriptor
5629  */
5630 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5631 
5632 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5633 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5634 //FIXME func typedef
5635 
5636 /**
5637  * Fill AVFrame audio data and linesize pointers.
5638  *
5639  * The buffer buf must be a preallocated buffer with a size big enough
5640  * to contain the specified samples amount. The filled AVFrame data
5641  * pointers will point to this buffer.
5642  *
5643  * AVFrame extended_data channel pointers are allocated if necessary for
5644  * planar audio.
5645  *
5646  * @param frame the AVFrame
5647  * frame->nb_samples must be set prior to calling the
5648  * function. This function fills in frame->data,
5649  * frame->extended_data, frame->linesize[0].
5650  * @param nb_channels channel count
5651  * @param sample_fmt sample format
5652  * @param buf buffer to use for frame data
5653  * @param buf_size size of buffer
5654  * @param align plane size sample alignment (0 = default)
5655  * @return >=0 on success, negative error code on failure
5656  * @todo return the size in bytes required to store the samples in
5657  * case of success, at the next libavutil bump
5658  */
5659 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5660  enum AVSampleFormat sample_fmt, const uint8_t *buf,
5661  int buf_size, int align);
5662 
5663 /**
5664  * Reset the internal decoder state / flush internal buffers. Should be called
5665  * e.g. when seeking or when switching to a different stream.
5666  *
5667  * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5668  * this invalidates the frames previously returned from the decoder. When
5669  * refcounted frames are used, the decoder just releases any references it might
5670  * keep internally, but the caller's reference remains valid.
5671  */
5673 
5674 /**
5675  * Return codec bits per sample.
5676  *
5677  * @param[in] codec_id the codec
5678  * @return Number of bits per sample or zero if unknown for the given codec.
5679  */
5680 int av_get_bits_per_sample(enum AVCodecID codec_id);
5681 
5682 /**
5683  * Return the PCM codec associated with a sample format.
5684  * @param be endianness, 0 for little, 1 for big,
5685  * -1 (or anything else) for native
5686  * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5687  */
5688 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5689 
5690 /**
5691  * Return codec bits per sample.
5692  * Only return non-zero if the bits per sample is exactly correct, not an
5693  * approximation.
5694  *
5695  * @param[in] codec_id the codec
5696  * @return Number of bits per sample or zero if unknown for the given codec.
5697  */
5698 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5699 
5700 /**
5701  * Return audio frame duration.
5702  *
5703  * @param avctx codec context
5704  * @param frame_bytes size of the frame, or 0 if unknown
5705  * @return frame duration, in samples, if known. 0 if not able to
5706  * determine.
5707  */
5708 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5709 
5710 /**
5711  * This function is the same as av_get_audio_frame_duration(), except it works
5712  * with AVCodecParameters instead of an AVCodecContext.
5713  */
5714 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5715 
5716 #if FF_API_OLD_BSF
5718  void *priv_data;
5722  /**
5723  * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5724  * Not for access by library users.
5725  */
5726  char *args;
5728 #endif
5729 
5731 
5732 /**
5733  * The bitstream filter state.
5734  *
5735  * This struct must be allocated with av_bsf_alloc() and freed with
5736  * av_bsf_free().
5737  *
5738  * The fields in the struct will only be changed (by the caller or by the
5739  * filter) as described in their documentation, and are to be considered
5740  * immutable otherwise.
5741  */
5742 typedef struct AVBSFContext {
5743  /**
5744  * A class for logging and AVOptions
5745  */
5747 
5748  /**
5749  * The bitstream filter this context is an instance of.
5750  */
5751  const struct AVBitStreamFilter *filter;
5752 
5753  /**
5754  * Opaque libavcodec internal data. Must not be touched by the caller in any
5755  * way.
5756  */
5757  AVBSFInternal *internal;
5758 
5759  /**
5760  * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5761  * this is an AVOptions-enabled struct.
5762  */
5763  void *priv_data;
5764 
5765  /**
5766  * Parameters of the input stream. Set by the caller before av_bsf_init().
5767  */
5769 
5770  /**
5771  * Parameters of the output stream. Set by the filter in av_bsf_init().
5772  */
5774 
5775  /**
5776  * The timebase used for the timestamps of the input packets. Set by the
5777  * caller before av_bsf_init().
5778  */
5780 
5781  /**
5782  * The timebase used for the timestamps of the output packets. Set by the
5783  * filter in av_bsf_init().
5784  */
5786 } AVBSFContext;
5787 
5788 typedef struct AVBitStreamFilter {
5789  const char *name;
5790 
5791  /**
5792  * A list of codec ids supported by the filter, terminated by
5793  * AV_CODEC_ID_NONE.
5794  * May be NULL, in that case the bitstream filter works with any codec id.
5795  */
5796  const enum AVCodecID *codec_ids;
5797 
5798  /**
5799  * A class for the private data, used to declare bitstream filter private
5800  * AVOptions. This field is NULL for bitstream filters that do not declare
5801  * any options.
5802  *
5803  * If this field is non-NULL, the first member of the filter private data
5804  * must be a pointer to AVClass, which will be set by libavcodec generic
5805  * code to this class.
5806  */
5808 
5809  /*****************************************************************
5810  * No fields below this line are part of the public API. They
5811  * may not be used outside of libavcodec and can be changed and
5812  * removed at will.
5813  * New public fields should be added right above.
5814  *****************************************************************
5815  */
5816 
5818  int (*init)(AVBSFContext *ctx);
5819  int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5820  void (*close)(AVBSFContext *ctx);
5822 
5823 #if FF_API_OLD_BSF
5824 /**
5825  * Register a bitstream filter.
5826  *
5827  * The filter will be accessible to the application code through
5828  * av_bitstream_filter_next() or can be directly initialized with
5829  * av_bitstream_filter_init().
5830  *
5831  * @see avcodec_register_all()
5832  */
5835 
5836 /**
5837  * Create and initialize a bitstream filter context given a bitstream
5838  * filter name.
5839  *
5840  * The returned context must be freed with av_bitstream_filter_close().
5841  *
5842  * @param name the name of the bitstream filter
5843  * @return a bitstream filter context if a matching filter was found
5844  * and successfully initialized, NULL otherwise
5845  */
5848 
5849 /**
5850  * Filter bitstream.
5851  *
5852  * This function filters the buffer buf with size buf_size, and places the
5853  * filtered buffer in the buffer pointed to by poutbuf.
5854  *
5855  * The output buffer must be freed by the caller.
5856  *
5857  * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5858  * @param avctx AVCodecContext accessed by the filter, may be NULL.
5859  * If specified, this must point to the encoder context of the
5860  * output stream the packet is sent to.
5861  * @param args arguments which specify the filter configuration, may be NULL
5862  * @param poutbuf pointer which is updated to point to the filtered buffer
5863  * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5864  * @param buf buffer containing the data to filter
5865  * @param buf_size size in bytes of buf
5866  * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5867  * @return >= 0 in case of success, or a negative error code in case of failure
5868  *
5869  * If the return value is positive, an output buffer is allocated and
5870  * is available in *poutbuf, and is distinct from the input buffer.
5871  *
5872  * If the return value is 0, the output buffer is not allocated and
5873  * should be considered identical to the input buffer, or in case
5874  * *poutbuf was set it points to the input buffer (not necessarily to
5875  * its starting address). A special case is if *poutbuf was set to NULL and
5876  * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5877  */
5880  AVCodecContext *avctx, const char *args,
5881  uint8_t **poutbuf, int *poutbuf_size,
5882  const uint8_t *buf, int buf_size, int keyframe);
5883 
5884 /**
5885  * Release bitstream filter context.
5886  *
5887  * @param bsf the bitstream filter context created with
5888  * av_bitstream_filter_init(), can be NULL
5889  */
5892 
5893 /**
5894  * If f is NULL, return the first registered bitstream filter,
5895  * if f is non-NULL, return the next registered bitstream filter
5896  * after f, or NULL if f is the last one.
5897  *
5898  * This function can be used to iterate over all registered bitstream
5899  * filters.
5900  */
5903 #endif
5904 
5905 /**
5906  * @return a bitstream filter with the specified name or NULL if no such
5907  * bitstream filter exists.
5908  */
5909 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5910 
5911 /**
5912  * Iterate over all registered bitstream filters.
5913  *
5914  * @param opaque a pointer where libavcodec will store the iteration state. Must
5915  * point to NULL to start the iteration.
5916  *
5917  * @return the next registered bitstream filter or NULL when the iteration is
5918  * finished
5919  */
5920 const AVBitStreamFilter *av_bsf_next(void **opaque);
5921 
5922 /**
5923  * Allocate a context for a given bitstream filter. The caller must fill in the
5924  * context parameters as described in the documentation and then call
5925  * av_bsf_init() before sending any data to the filter.
5926  *
5927  * @param filter the filter for which to allocate an instance.
5928  * @param ctx a pointer into which the pointer to the newly-allocated context
5929  * will be written. It must be freed with av_bsf_free() after the
5930  * filtering is done.
5931  *
5932  * @return 0 on success, a negative AVERROR code on failure
5933  */
5934 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5935 
5936 /**
5937  * Prepare the filter for use, after all the parameters and options have been
5938  * set.
5939  */
5940 int av_bsf_init(AVBSFContext *ctx);
5941 
5942 /**
5943  * Submit a packet for filtering.
5944  *
5945  * After sending each packet, the filter must be completely drained by calling
5946  * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5947  * AVERROR_EOF.
5948  *
5949  * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5950  * side data must be present in pkt). The bitstream filter will take ownership of
5951  * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5952  * This parameter may be NULL, which signals the end of the stream (i.e. no more
5953  * packets will be sent). That will cause the filter to output any packets it
5954  * may have buffered internally.
5955  *
5956  * @return 0 on success, a negative AVERROR on error.
5957  */
5959 
5960 /**
5961  * Retrieve a filtered packet.
5962  *
5963  * @param[out] pkt this struct will be filled with the contents of the filtered
5964  * packet. It is owned by the caller and must be freed using
5965  * av_packet_unref() when it is no longer needed.
5966  * This parameter should be "clean" (i.e. freshly allocated
5967  * with av_packet_alloc() or unreffed with av_packet_unref())
5968  * when this function is called. If this function returns
5969  * successfully, the contents of pkt will be completely
5970  * overwritten by the returned data. On failure, pkt is not
5971  * touched.
5972  *
5973  * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5974  * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5975  * will be no further output from the filter. Another negative AVERROR value if
5976  * an error occurs.
5977  *
5978  * @note one input packet may result in several output packets, so after sending
5979  * a packet with av_bsf_send_packet(), this function needs to be called
5980  * repeatedly until it stops returning 0. It is also possible for a filter to
5981  * output fewer packets than were sent to it, so this function may return
5982  * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5983  */
5985 
5986 /**
5987  * Free a bitstream filter context and everything associated with it; write NULL
5988  * into the supplied pointer.
5989  */
5990 void av_bsf_free(AVBSFContext **ctx);
5991 
5992 /**
5993  * Get the AVClass for AVBSFContext. It can be used in combination with
5994  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5995  *
5996  * @see av_opt_find().
5997  */
5998 const AVClass *av_bsf_get_class(void);
5999 
6000 /**
6001  * Structure for chain/list of bitstream filters.
6002  * Empty list can be allocated by av_bsf_list_alloc().
6003  */
6004 typedef struct AVBSFList AVBSFList;
6005 
6006 /**
6007  * Allocate empty list of bitstream filters.
6008  * The list must be later freed by av_bsf_list_free()
6009  * or finalized by av_bsf_list_finalize().
6010  *
6011  * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6012  */
6014 
6015 /**
6016  * Free list of bitstream filters.
6017  *
6018  * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6019  */
6020 void av_bsf_list_free(AVBSFList **lst);
6021 
6022 /**
6023  * Append bitstream filter to the list of bitstream filters.
6024  *
6025  * @param lst List to append to
6026  * @param bsf Filter context to be appended
6027  *
6028  * @return >=0 on success, negative AVERROR in case of failure
6029  */
6030 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6031 
6032 /**
6033  * Construct new bitstream filter context given it's name and options
6034  * and append it to the list of bitstream filters.
6035  *
6036  * @param lst List to append to
6037  * @param bsf_name Name of the bitstream filter
6038  * @param options Options for the bitstream filter, can be set to NULL
6039  *
6040  * @return >=0 on success, negative AVERROR in case of failure
6041  */
6042 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6043 /**
6044  * Finalize list of bitstream filters.
6045  *
6046  * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6047  * so the whole chain of bitstream filters can be treated as single filter
6048  * freshly allocated by av_bsf_alloc().
6049  * If the call is successful, @ref AVBSFList structure is freed and lst
6050  * will be set to NULL. In case of failure, caller is responsible for
6051  * freeing the structure by av_bsf_list_free()
6052  *
6053  * @param lst Filter list structure to be transformed
6054  * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6055  * representing the chain of bitstream filters
6056  *
6057  * @return >=0 on success, negative AVERROR in case of failure
6058  */
6059 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6060 
6061 /**
6062  * Parse string describing list of bitstream filters and create single
6063  * @ref AVBSFContext describing the whole chain of bitstream filters.
6064  * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6065  * allocated by av_bsf_alloc().
6066  *
6067  * @param str String describing chain of bitstream filters in format
6068  * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6069  * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6070  * representing the chain of bitstream filters
6071  *
6072  * @return >=0 on success, negative AVERROR in case of failure
6073  */
6074 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6075 
6076 /**
6077  * Get null/pass-through bitstream filter.
6078  *
6079  * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6080  *
6081  * @return
6082  */
6084 
6085 /* memory */
6086 
6087 /**
6088  * Same behaviour av_fast_malloc but the buffer has additional
6089  * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6090  *
6091  * In addition the whole buffer will initially and after resizes
6092  * be 0-initialized so that no uninitialized data will ever appear.
6093  */
6094 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6095 
6096 /**
6097  * Same behaviour av_fast_padded_malloc except that buffer will always
6098  * be 0-initialized after call.
6099  */
6100 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6101 
6102 /**
6103  * Encode extradata length to a buffer. Used by xiph codecs.
6104  *
6105  * @param s buffer to write to; must be at least (v/255+1) bytes long
6106  * @param v size of extradata in bytes
6107  * @return number of bytes written to the buffer.
6108  */
6109 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6110 
6111 #if FF_API_MISSING_SAMPLE
6112 /**
6113  * Log a generic warning message about a missing feature. This function is
6114  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6115  * only, and would normally not be used by applications.
6116  * @param[in] avc a pointer to an arbitrary struct of which the first field is
6117  * a pointer to an AVClass struct
6118  * @param[in] feature string containing the name of the missing feature
6119  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6120  * If want_sample is non-zero, additional verbiage will be added to the log
6121  * message which tells the user how to report samples to the development
6122  * mailing list.
6123  * @deprecated Use avpriv_report_missing_feature() instead.
6124  */
6126 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6127 
6128 /**
6129  * Log a generic warning message asking for a sample. This function is
6130  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6131  * only, and would normally not be used by applications.
6132  * @param[in] avc a pointer to an arbitrary struct of which the first field is
6133  * a pointer to an AVClass struct
6134  * @param[in] msg string containing an optional message, or NULL if no message
6135  * @deprecated Use avpriv_request_sample() instead.
6136  */
6138 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6139 #endif /* FF_API_MISSING_SAMPLE */
6140 
6141 /**
6142  * Register the hardware accelerator hwaccel.
6143  */
6144 void av_register_hwaccel(AVHWAccel *hwaccel);
6145 
6146 /**
6147  * If hwaccel is NULL, returns the first registered hardware accelerator,
6148  * if hwaccel is non-NULL, returns the next registered hardware accelerator
6149  * after hwaccel, or NULL if hwaccel is the last one.
6150  */
6151 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6152 
6153 
6154 /**
6155  * Lock operation used by lockmgr
6156  */
6157 enum AVLockOp {
6158  AV_LOCK_CREATE, ///< Create a mutex
6159  AV_LOCK_OBTAIN, ///< Lock the mutex
6160  AV_LOCK_RELEASE, ///< Unlock the mutex
6161  AV_LOCK_DESTROY, ///< Free mutex resources
6162 };
6163 
6164 /**
6165  * Register a user provided lock manager supporting the operations
6166  * specified by AVLockOp. The "mutex" argument to the function points
6167  * to a (void *) where the lockmgr should store/get a pointer to a user
6168  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6169  * value left by the last call for all other ops. If the lock manager is
6170  * unable to perform the op then it should leave the mutex in the same
6171  * state as when it was called and return a non-zero value. However,
6172  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6173  * have been successfully destroyed. If av_lockmgr_register succeeds
6174  * it will return a non-negative value, if it fails it will return a
6175  * negative value and destroy all mutex and unregister all callbacks.
6176  * av_lockmgr_register is not thread-safe, it must be called from a
6177  * single thread before any calls which make use of locking are used.
6178  *
6179  * @param cb User defined callback. av_lockmgr_register invokes calls
6180  * to this callback and the previously registered callback.
6181  * The callback will be used to create more than one mutex
6182  * each of which must be backed by its own underlying locking
6183  * mechanism (i.e. do not use a single static object to
6184  * implement your lock manager). If cb is set to NULL the
6185  * lockmgr will be unregistered.
6186  */
6187 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6188 
6189 /**
6190  * Get the type of the given codec.
6191  */
6192 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6193 
6194 /**
6195  * Get the name of a codec.
6196  * @return a static string identifying the codec; never NULL
6197  */
6198 const char *avcodec_get_name(enum AVCodecID id);
6199 
6200 /**
6201  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6202  * with no corresponding avcodec_close()), 0 otherwise.
6203  */
6205 
6206 /**
6207  * @return a non-zero number if codec is an encoder, zero otherwise
6208  */
6209 int av_codec_is_encoder(const AVCodec *codec);
6210 
6211 /**
6212  * @return a non-zero number if codec is a decoder, zero otherwise
6213  */
6214 int av_codec_is_decoder(const AVCodec *codec);
6215 
6216 /**
6217  * @return descriptor for given codec ID or NULL if no descriptor exists.
6218  */
6220 
6221 /**
6222  * Iterate over all codec descriptors known to libavcodec.
6223  *
6224  * @param prev previous descriptor. NULL to get the first descriptor.
6225  *
6226  * @return next descriptor or NULL after the last descriptor
6227  */
6229 
6230 /**
6231  * @return codec descriptor with the given name or NULL if no such descriptor
6232  * exists.
6233  */
6235 
6236 /**
6237  * Allocate a CPB properties structure and initialize its fields to default
6238  * values.
6239  *
6240  * @param size if non-NULL, the size of the allocated struct will be written
6241  * here. This is useful for embedding it in side data.
6242  *
6243  * @return the newly allocated struct or NULL on failure
6244  */
6246 
6247 /**
6248  * @}
6249  */
6250 
6251 #endif /* AVCODEC_AVCODEC_H */
enum AVPixelFormat(* get_format)(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
callback to negotiate the pixelFormat
Definition: avcodec.h:1964
codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it ...
Definition: avcodec.h:645
void av_bsf_free(AVBSFContext **ctx)
Free a bitstream filter context and everything associated with it; write NULL into the supplied point...
const struct AVCodec * codec
Definition: avcodec.h:1695
AVRational framerate
Definition: avcodec.h:3386
discard all frames except keyframes
Definition: avcodec.h:786
AVSideDataParamChangeFlags
Definition: avcodec.h:1652
const AVCodecDescriptor * codec_descriptor
AVCodecDescriptor Code outside libavcodec should access this field using: av_codec_{get,set}_codec_descriptor(avctx)
Definition: avcodec.h:3411
attribute_deprecated int intra_quant_bias
Definition: avcodec.h:2215
const AVClass * priv_class
A class for the private data, used to declare bitstream filter private AVOptions. ...
Definition: avcodec.h:5807
static enum AVPixelFormat pix_fmt
AVCodecParameters * par_out
Parameters of the output stream.
Definition: avcodec.h:5773
#define AV_NUM_DATA_POINTERS
Definition: frame.h:185
AVPacketSideDataType
Definition: avcodec.h:1362
int64_t pts_correction_num_faulty_dts
Number of incorrect PTS values so far.
Definition: avcodec.h:3430
A list of zero terminated key/value strings.
Definition: avcodec.h:1526
This structure describes decoded (raw) audio or video data.
Definition: frame.h:184
The optional first identifier line of a WebVTT cue.
Definition: avcodec.h:1513
int avcodec_default_execute2(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2, int, int), void *arg, int *ret, int count)
AVCodec * avcodec_find_encoder(enum AVCodecID id)
Find a registered encoder with a matching codec ID.
int x
top left corner of pict, undefined when pict is not set
Definition: avcodec.h:3933
int dct_algo
DCT algorithm, see FF_DCT_* below.
Definition: avcodec.h:3033
A dummy id pointing at the start of audio codecs.
Definition: avcodec.h:416
int coded_width
Bitstream width / height, may be different from width/height e.g.
Definition: avcodec.h:1888
int capabilities
Hardware accelerated codec capabilities.
Definition: avcodec.h:3764
int av_lockmgr_register(int(*cb)(void **mutex, enum AVLockOp op))
Register a user provided lock manager supporting the operations specified by AVLockOp.
float qblur
amount of qscale smoothing over time (0.0-1.0)
Definition: avcodec.h:2622
Unlock the mutex.
Definition: avcodec.h:6160
attribute_deprecated int rc_qmod_freq
Definition: avcodec.h:2655
int64_t bit_rate
the average bitrate
Definition: avcodec.h:1751
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1631
void av_shrink_packet(AVPacket *pkt, int size)
Reduce packet size, correctly zeroing padding.
Subtitle event position.
Definition: avcodec.h:1500
int64_t next_frame_offset
Definition: avcodec.h:4998
int id
id
Definition: avcodec.h:1288
int max_bitrate
Maximum bitrate of the stream, in bits per second.
Definition: avcodec.h:1316
int max_b_frames
maximum number of B-frames between non-B-frames Note: The output will be delayed by max_b_frames+1 re...
Definition: avcodec.h:1972
AVRational sample_aspect_ratio
Video only.
Definition: avcodec.h:4067
int rc_initial_buffer_occupancy
Number of bits which should be loaded into the rc buffer before decoding starts.
Definition: avcodec.h:2725
Dummy codec for streams containing only metadata information.
Definition: avcodec.h:651
int height
Definition: avcodec.h:1296
int width
Dimensions of the decoded video intended for presentation.
Definition: avcodec.h:5139
int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt)
Read encoded data from the encoder.
attribute_deprecated int frame_skip_cmp
Definition: avcodec.h:2777
attribute_deprecated int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples)
This side data should be associated with a video stream and contains Stereoscopic 3D information in f...
Definition: avcodec.h:1431
const char * avcodec_configuration(void)
Return the libavcodec build-time configuration.
attribute_deprecated int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc, AVCodecContext *avctx, const char *args, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int keyframe)
Filter bitstream.
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:2423
attribute_deprecated unsigned int stream_codec_tag
Definition: avcodec.h:1725
const struct AVBitStreamFilter * filter
The bitstream filter this context is an instance of.
Definition: avcodec.h:5751
int qscale
Definition: avcodec.h:809
attribute_deprecated int av_picture_crop(AVPicture *dst, const AVPicture *src, enum AVPixelFormat pix_fmt, int top_band, int left_band)
void av_codec_set_pkt_timebase(AVCodecContext *avctx, AVRational val)
The bitstream filter state.
Definition: avcodec.h:5742
int nb_colors
number of colors in pict, undefined when pict is not set
Definition: avcodec.h:3937
int size
Definition: avcodec.h:1612
attribute_deprecated int lmax
Definition: avcodec.h:2759
int mb_lmin
minimum MB Lagrange multiplier
Definition: avcodec.h:2326
const char * avcodec_license(void)
Return the libavcodec license.
enhanced predictive zonal search
Definition: avcodec.h:766
const AVBitStreamFilter * av_bsf_get_by_name(const char *name)
int coded_width
Dimensions of the coded video.
Definition: avcodec.h:5145
This side data contains an integer value representing the stream index of a "fallback" track...
Definition: avcodec.h:1457
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel...
Definition: avcodec.h:2097
attribute_deprecated int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Encode a frame of audio.
Convenience header that includes libavutil&#39;s core.
attribute_deprecated int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame, int *got_frame_ptr, const AVPacket *avpkt)
Decode the audio frame of size avpkt->size from avpkt->data into frame.
Contain timestamp estimated through PCR of program stream.
Definition: avcodec.h:634
unsigned num_rects
Definition: avcodec.h:3971
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
A dummy ID pointing at the start of various fake codecs.
Definition: avcodec.h:631
char * stats_in
pass2 encoding statistics input buffer Concatenated stuff from stats_out of pass1 should be placed he...
Definition: avcodec.h:2863
int ildct_cmp
interlaced DCT comparison function
Definition: avcodec.h:2122
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag)
Put a string representing the codec tag codec_tag in buf.
discard all non intra frames
Definition: avcodec.h:785
int duration
Duration of the current frame.
Definition: avcodec.h:5114
discard all
Definition: avcodec.h:787
static AVPacket pkt
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition: avcodec.h:3088
int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos)
Converts AVChromaLocation to swscale x/y chroma position.
void avcodec_register_all(void)
Register all the codecs, parsers and bitstream filters which were enabled at configuration time...
int dts_ref_dts_delta
Offset of the current timestamp against last timestamp sync point in units of AVCodecContext.time_base.
Definition: avcodec.h:5076
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub, int *got_sub_ptr, AVPacket *avpkt)
Decode a subtitle message.
int av_bsf_get_null_filter(AVBSFContext **bsf)
Get null/pass-through bitstream filter.
int trailing_padding
Audio only.
Definition: avcodec.h:4127
void * priv_data
Opaque filter-specific private data.
Definition: avcodec.h:5763
Picture data structure.
Definition: avcodec.h:3900
int(* alloc_frame)(AVCodecContext *avctx, AVFrame *frame)
Allocate a custom buffer.
Definition: avcodec.h:3778
int profile
profile
Definition: avcodec.h:3192
An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of structures with info about macroblo...
Definition: avcodec.h:1410
AVCodec.
Definition: avcodec.h:3611
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:2485
attribute_deprecated int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt, int padtop, int padbottom, int padleft, int padright, int *color)
float i_quant_offset
qscale offset between P and I-frames
Definition: avcodec.h:2030
This struct describes the properties of an encoded stream.
Definition: avcodec.h:3983
int av_bsf_init(AVBSFContext *ctx)
Prepare the filter for use, after all the parameters and options have been set.
AVLockOp
Lock operation used by lockmgr.
Definition: avcodec.h:6157
attribute_deprecated AVPicture pict
Definition: avcodec.h:3944
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:410
int min_bitrate
Minimum bitrate of the stream, in bits per second.
Definition: avcodec.h:1321
char * text
0 terminated plain UTF-8 text
Definition: avcodec.h:3955
attribute_deprecated unsigned avcodec_get_edge_width(void)
Return the amount of padding in pixels which the get_buffer callback must provide around the edge of ...
attribute_deprecated int frame_skip_exp
Definition: avcodec.h:2773
attribute_deprecated int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height)
attribute_deprecated int me_method
This option does nothing.
Definition: avcodec.h:1921
Macro definitions for various function/variable attributes.
attribute_deprecated void av_log_missing_feature(void *avc, const char *feature, int want_sample)
Log a generic warning message about a missing feature.
int frame_size
Audio only.
Definition: avcodec.h:4112
Mastering display metadata (based on SMPTE-2086:2014).
Definition: avcodec.h:1539
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1823
int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt, int has_alpha)
attribute_deprecated int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx)
Resample an array of samples using a previously configured context.
int av_codec_is_decoder(const AVCodec *codec)
AVSubtitleRect ** rects
Definition: avcodec.h:3972
enum AVAudioServiceType audio_service_type
Type of service that the audio stream conveys.
Definition: avcodec.h:2513
const AVCodecDescriptor * avcodec_descriptor_next(const AVCodecDescriptor *prev)
Iterate over all codec descriptors known to libavcodec.
void av_bsf_list_free(AVBSFList **lst)
Free list of bitstream filters.
int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, enum AVSampleFormat sample_fmt, const uint8_t *buf, int buf_size, int align)
Fill AVFrame audio data and linesize pointers.
enum AVDiscard skip_frame
Skip decoding for selected frames.
Definition: avcodec.h:3312
const AVClass * avcodec_get_class(void)
Get the AVClass for AVCodecContext.
int av_codec_is_encoder(const AVCodec *codec)
uint64_t vbv_delay
The delay between the time the packet this structure is associated with is received and the time when...
Definition: avcodec.h:1341
int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx)
Allocate a context for a given bitstream filter.
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height)
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
int w
width of pict, undefined when pict is not set
Definition: avcodec.h:3935
attribute_deprecated int mv_bits
Definition: avcodec.h:2829
struct AVHWAccel * hwaccel
Hardware accelerator in use.
Definition: avcodec.h:3007
float p_masking
p block masking (0-> disabled)
Definition: avcodec.h:2058
void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val)
AVCodecParserContext * parser
Definition: avcodec.h:5720
attribute_deprecated int rc_strategy
Definition: avcodec.h:1985
Public dictionary API.
int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt)
Retrieve a filtered packet.
attribute_deprecated int side_data_only_packets
Encoding only and set by default.
Definition: avcodec.h:3359
int bit_rate_tolerance
number of bits the bitstream is allowed to diverge from the reference.
Definition: avcodec.h:1759
int mb_lmax
maximum MB Lagrange multiplier
Definition: avcodec.h:2333
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
attribute_deprecated float rc_buffer_aggressivity
Definition: avcodec.h:2700
attribute_deprecated const char * rc_eq
Definition: avcodec.h:2678
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:2456
Lock the mutex.
Definition: avcodec.h:6159
void * hwaccel_context
Hardware accelerator context.
Definition: avcodec.h:3019
int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
Unpack a dictionary from side_data.
int width
Video only.
Definition: avcodec.h:4057
int av_parser_change(AVCodecParserContext *s, AVCodecContext *avctx, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int keyframe)
int subtitle_header_size
Definition: avcodec.h:3323
AVCodecParameters * avcodec_parameters_alloc(void)
Allocate a new AVCodecParameters and set its fields to default values (unknown/invalid/0).
int me_range
maximum motion estimation search range in subpel units If 0 then no limit.
Definition: avcodec.h:2209
attribute_deprecated int i_count
Definition: avcodec.h:2837
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:436
unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt)
Return a value representing the fourCC code associated to the pixel format pix_fmt, or 0 if no associated fourCC code can be found.
struct AVCodecDefault AVCodecDefault
Definition: avcodec.h:3604
uint16_t * chroma_intra_matrix
custom intra quantization matrix Code outside libavcodec should access this field using av_codec_g/se...
Definition: avcodec.h:3493
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1629
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
Definition: avcodec.h:1425
float b_quant_factor
qscale factor between IP and B-frames If > 0 then the last P-frame quantizer will be used (q= lastp_q...
Definition: avcodec.h:1981
int trailing_padding
Audio only.
Definition: avcodec.h:3575
int pre_dia_size
ME prepass diamond size & shape.
Definition: avcodec.h:2173
int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
Initialize a reference-counted packet from av_malloc()ed data.
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1801
const AVClass * av_class
information on struct for av_log
Definition: avcodec.h:1691
int me_cmp
motion estimation comparison function
Definition: avcodec.h:2104
int avcodec_parameters_to_context(AVCodecContext *codec, const AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
static AVFrame * frame
struct AVCodecParser * next
Definition: avcodec.h:5171
int initial_padding
Audio only.
Definition: avcodec.h:4120
void av_codec_set_lowres(AVCodecContext *avctx, int val)
const char * name
Definition: avcodec.h:5789
attribute_deprecated void av_resample_close(struct AVResampleContext *c)
uint8_t * data
Definition: avcodec.h:1611
attribute_deprecated int context_model
Definition: avcodec.h:2745
void av_packet_move_ref(AVPacket *dst, AVPacket *src)
Move every field in src to dst and reset src.
Motion_Est_ID
motion estimation type.
Definition: avcodec.h:761
uint8_t * data
Definition: avcodec.h:1555
int lowres
low resolution decoding, 1-> 1/2 size, 2->1/4 size
Definition: avcodec.h:3098
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:457
const AVCodecDescriptor * av_codec_get_codec_descriptor(const AVCodecContext *avctx)
const AVClass * avcodec_get_frame_class(void)
Get the AVClass for AVFrame.
int buffer_size
The size of the buffer to which the ratecontrol is applied, in bits.
Definition: avcodec.h:1332
int h
height of pict, undefined when pict is not set
Definition: avcodec.h:3936
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:3081
float lumi_masking
luminance masking (0-> disabled)
Definition: avcodec.h:2037
char * stats_out
pass1 encoding statistics output buffer
Definition: avcodec.h:2855
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:389
AVCPBProperties * av_cpb_properties_alloc(size_t *size)
Allocate a CPB properties structure and initialize its fields to default values.
struct AVBitStreamFilterContext * next
Definition: avcodec.h:5721
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition: avcodec.h:2430
attribute_deprecated int frame_skip_threshold
Definition: avcodec.h:2765
uint64_t channel_layout
Audio only.
Definition: avcodec.h:4093
float quality_factor
Definition: avcodec.h:810
int av_packet_ref(AVPacket *dst, const AVPacket *src)
Setup a new reference to the data described by a given packet.
hexagon based search
Definition: avcodec.h:768
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:4020
AVCodec * avcodec_find_encoder_by_name(const char *name)
Find a registered encoder with the specified name.
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, int linesize_align[AV_NUM_DATA_POINTERS])
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
attribute_deprecated int avpicture_fill(AVPicture *picture, const uint8_t *ptr, enum AVPixelFormat pix_fmt, int width, int height)
attribute_deprecated int skip_count
Definition: avcodec.h:2841
MPEGTS stream ID, this is required to pass the stream ID information from the demuxer to the correspo...
Definition: avcodec.h:1532
int slice_count
slice count
Definition: avcodec.h:2072
uint16_t * av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx)
attribute_deprecated void avcodec_set_dimensions(AVCodecContext *s, int width, int height)
Libavcodec version macros.
int avcodec_close(AVCodecContext *avctx)
Close a given AVCodecContext and free all the data associated with it (but not the AVCodecContext its...
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
AVRational pkt_timebase
Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
Definition: avcodec.h:3402
no search, that is use 0,0 vector whenever one is needed
Definition: avcodec.h:762
const uint64_t * channel_layouts
array of support channel layouts, or NULL if unknown. array is terminated by 0
Definition: avcodec.h:3635
reserved for experiments
Definition: avcodec.h:767
const AVCodecDefault * defaults
Private codec-specific defaults.
Definition: avcodec.h:3672
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:191
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
int av_get_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition: avcodec.h:2008
const AVBitStreamFilter * av_bsf_next(void **opaque)
Iterate over all registered bitstream filters.
int64_t pos
Byte position of currently parsed frame in stream.
Definition: avcodec.h:5102
attribute_deprecated float rc_initial_cplx
Definition: avcodec.h:2703
Create a mutex.
Definition: avcodec.h:6158
void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst)
Convert valid timing fields (timestamps / durations) in a packet from one timebase to another...
int priv_data_size
Definition: avcodec.h:5161
struct AVCodecParser * parser
Definition: avcodec.h:4994
AVAudioServiceType
Definition: avcodec.h:790
int y
top left corner of pict, undefined when pict is not set
Definition: avcodec.h:3934
discard all bidirectional frames
Definition: avcodec.h:784
An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
Definition: avcodec.h:1389
enum AVCodecID * codec_ids
A list of codec ids supported by the filter, terminated by AV_CODEC_ID_NONE.
Definition: avcodec.h:5796
int me_sub_cmp
subpixel motion estimation comparison function
Definition: avcodec.h:2110
void av_packet_free_side_data(AVPacket *pkt)
Convenience function to free all the side data stored.
attribute_deprecated uint64_t vbv_delay
VBV delay coded in the last frame (in periods of a 27 MHz clock).
Definition: avcodec.h:3344
int qmax
maximum quantizer
Definition: avcodec.h:2636
AVCodec * av_codec_next(const AVCodec *c)
If c is NULL, returns the first registered codec, if c is non-NULL, returns the next registered codec...
enum AVSampleFormat request_sample_fmt
desired sample format
Definition: avcodec.h:2521
int skip_alpha
Skip processing alpha if supported by codec.
Definition: avcodec.h:3465
int64_t pts_correction_last_pts
Number of incorrect DTS values so far.
Definition: avcodec.h:3431
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:3137
attribute_deprecated int av_dup_packet(AVPacket *pkt)
int avcodec_is_open(AVCodecContext *s)
int error_concealment
error concealment flags
Definition: avcodec.h:2917
int video_delay
Video only.
Definition: avcodec.h:4086
int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder.
int capabilities
Codec capabilities.
Definition: avcodec.h:3630
int initial_padding
Audio only.
Definition: avcodec.h:3377
struct AVDictionary AVDictionary
Definition: dict.h:90
preferred ID for decoding MPEG audio layer 1, 2 or 3
Definition: avcodec.h:517
attribute_deprecated AVBitStreamFilterContext * av_bitstream_filter_init(const char *name)
Create and initialize a bitstream filter context given a bitstream filter name.
AVBufferRef * buf
A reference to the reference-counted buffer where the packet data is stored.
Definition: avcodec.h:1594
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:1781
enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
Find the best pixel format to convert to given a certain source pixel format.
AVRational time_base_in
The timebase used for the timestamps of the input packets.
Definition: avcodec.h:5779
int log_level_offset
Definition: avcodec.h:1692
enum AVMediaType avcodec_get_type(enum AVCodecID codec_id)
Get the type of the given codec.
attribute_deprecated int inter_quant_bias
Definition: avcodec.h:2221
const char * name
Name of the codec implementation.
Definition: avcodec.h:3618
float i_quant_factor
qscale factor between P- and I-frames If > 0 then the last P-frame quantizer will be used (q = lastp_...
Definition: avcodec.h:2023
int side_data_elems
Definition: avcodec.h:1623
int width
width and height in 1/16 pel
Definition: avcodec.h:1295
int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Shrink the already allocated side data buffer.
const struct AVProfile * profiles
If non-NULL, an array of profiles recognized for this codec.
Definition: avcodec.h:687
const char * long_name
A more descriptive name for this codec.
Definition: avcodec.h:672
AVCodecParser * av_parser_next(const AVCodecParser *c)
transformed exhaustive search algorithm
Definition: avcodec.h:770
void avcodec_parameters_free(AVCodecParameters **par)
Free an AVCodecParameters instance and everything associated with it and write NULL to the supplied p...
int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes)
This function is the same as av_get_audio_frame_duration(), except it works with AVCodecParameters in...
attribute_deprecated int64_t timecode_frame_start
Definition: avcodec.h:2798
#define av_printf_format(fmtpos, attrpos)
Definition: attributes.h:156
attribute_deprecated int b_sensitivity
Definition: avcodec.h:2394
int priv_data_size
Size of the private data to allocate in AVCodecInternal.hwaccel_priv_data.
Definition: avcodec.h:3862
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1617
int av_codec_get_lowres(const AVCodecContext *avctx)
reference-counted frame API
const AVCodecDescriptor * avcodec_descriptor_get(enum AVCodecID id)
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:2499
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:4009
uint32_t end_display_time
Definition: avcodec.h:3970
int64_t pts
Same as packet pts, in AV_TIME_BASE.
Definition: avcodec.h:3973
int rc_buffer_size
decoder bitstream buffer size
Definition: avcodec.h:2663
int av_packet_merge_side_data(AVPacket *pkt)
int props
Codec properties, a combination of AV_CODEC_PROP_* flags.
Definition: avcodec.h:676
int intra_dc_precision
precision of the intra DC coefficient - 8
Definition: avcodec.h:2297
int64_t rc_min_rate
minimum bitrate
Definition: avcodec.h:2693
Not part of ABI.
Definition: avcodec.h:800
int refs
number of reference frames
Definition: avcodec.h:2367
attribute_deprecated int scenechange_factor
Multiplied by qscale for each frame and added to scene_change_score.
Definition: avcodec.h:2381
int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf)
Append bitstream filter to the list of bitstream filters.
int block_align
Audio only.
Definition: avcodec.h:4108
A bitmap, pict will be set.
Definition: avcodec.h:3915
int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
Copy only "properties" fields from src to dst.
int rc_override_count
ratecontrol override, see RcOverride
Definition: avcodec.h:2670
const AVClass * av_bsf_get_class(void)
Get the AVClass for AVBSFContext.
audio channel layout utility functions
enum AVPixelFormat * pix_fmts
array of supported pixel formats, or NULL if unknown, array is terminated by -1
Definition: avcodec.h:3632
int err_recognition
Error recognition; may misdetect some more or less valid parts as errors.
Definition: avcodec.h:2975
const char * name
Name of the hardware accelerated codec.
Definition: avcodec.h:3737
AVPacketSideData * coded_side_data
Additional data associated with the entire coded stream.
Definition: avcodec.h:3529
attribute_deprecated int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt, int width, int height, unsigned char *dest, int dest_size)
iterative search
Definition: avcodec.h:771
int av_get_exact_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
attribute_deprecated int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
Copy the settings of the source AVCodecContext into the destination AVCodecContext.
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
int av_parser_parse2(AVCodecParserContext *s, AVCodecContext *avctx, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int64_t pts, int64_t dts, int64_t pos)
Parse a packet.
This side data contains quality related information from the encoder.
Definition: avcodec.h:1449
int av_bsf_list_append2(AVBSFList *lst, const char *bsf_name, AVDictionary **options)
Construct new bitstream filter context given it&#39;s name and options and append it to the list of bitst...
attribute_deprecated void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance)
Compensate samplerate/timestamp drift.
int width
picture width / height.
Definition: avcodec.h:1873
int idct_algo
IDCT algorithm, see FF_IDCT_* below.
Definition: avcodec.h:3046
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames...
Definition: avcodec.h:3553
int64_t offset
byte offset from starting packet start
Definition: avcodec.h:5032
attribute_deprecated void av_bitstream_filter_close(AVBitStreamFilterContext *bsf)
Release bitstream filter context.
AVRational time_base_out
The timebase used for the timestamps of the output packets.
Definition: avcodec.h:5785
int priv_data_size
Definition: avcodec.h:3647
int profile
Definition: avcodec.h:3600
attribute_deprecated int noise_reduction
Definition: avcodec.h:2275
int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt)
Submit a packet for filtering.
float rc_max_available_vbv_use
Ratecontrol attempt to use, at maximum, of what can be used without an underflow. ...
Definition: avcodec.h:2711
float rc_min_vbv_overflow_use
Ratecontrol attempt to use, at least, times the amount needed to prevent a vbv overflow.
Definition: avcodec.h:2718
void av_parser_close(AVCodecParserContext *s)
attribute_deprecated int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height)
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition: avcodec.h:2402
int start_frame
Definition: avcodec.h:807
attribute_deprecated int frame_skip_factor
Definition: avcodec.h:2769
uint16_t format
Definition: avcodec.h:3968
const AVClass * avcodec_get_subtitle_rect_class(void)
Get the AVClass for AVSubtitleRect.
int level
level
Definition: avcodec.h:3290
const AVClass * av_class
A class for logging and AVOptions.
Definition: avcodec.h:5746
const AVProfile * profiles
array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN} ...
Definition: avcodec.h:3638
struct AVBSFInternal AVBSFInternal
Definition: avcodec.h:5730
int64_t reordered_opaque
opaque 64-bit number (generally a PTS) that will be reordered and output in AVFrame.reordered_opaque
Definition: avcodec.h:3000
int refcounted_frames
If non-zero, the decoded audio and video frames returned from avcodec_decode_video2() and avcodec_dec...
Definition: avcodec.h:2618
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:1832
int skip_top
Number of macroblock rows at the top which are skipped.
Definition: avcodec.h:2304
int mb_decision
macroblock decision mode
Definition: avcodec.h:2249
int last_predictor_count
amount of previous MV predictors (2a+1 x 2a+1 square)
Definition: avcodec.h:2153
int max_qdiff
maximum quantizer difference between frames
Definition: avcodec.h:2643
attribute_deprecated int mb_threshold
Definition: avcodec.h:2289
attribute_deprecated float rc_qsquish
Definition: avcodec.h:2650
Passthrough codec, AVFrames wrapped in AVPacket.
Definition: avcodec.h:652
void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift)
Utility function to access log2_chroma_w log2_chroma_h from the pixel format AVPixFmtDescriptor.
char * sub_charenc
DTS of the last frame.
Definition: avcodec.h:3439
attribute_deprecated int coder_type
Definition: avcodec.h:2739
preferred ID for MPEG-1/2 video decoding
Definition: avcodec.h:196
const AVCodecDescriptor * avcodec_descriptor_get_by_name(const char *name)
RcOverride * rc_override
Definition: avcodec.h:2671
int64_t last_pos
Previous frame byte position.
Definition: avcodec.h:5107
const char * avcodec_get_name(enum AVCodecID id)
Get the name of a codec.
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:3118
int sub_charenc_mode
Subtitles character encoding mode.
Definition: avcodec.h:3447
int av_packet_split_side_data(AVPacket *pkt)
attribute_deprecated int max_prediction_order
Definition: avcodec.h:2794
int av_codec_get_max_lowres(const AVCodec *codec)
void avcodec_flush_buffers(AVCodecContext *avctx)
Reset the internal decoder state / flush internal buffers.
AVPacket * av_packet_clone(AVPacket *src)
Create a new packet that references the same data as src.
FAKE codec to indicate a MPEG-4 Systems stream (only used by libavformat)
Definition: avcodec.h:649
attribute_deprecated int i_tex_bits
Definition: avcodec.h:2833
enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
struct AVBSFList AVBSFList
Structure for chain/list of bitstream filters.
Definition: avcodec.h:6004
attribute_deprecated enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
int(* update_thread_context)(AVCodecContext *dst, const AVCodecContext *src)
Copy necessary context variables from a previous thread context to the current one.
Definition: avcodec.h:3666
const char * av_get_profile_name(const AVCodec *codec, int profile)
Return a name for the specified profile, if available.
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:2468
int pts_dts_delta
Presentation delay of current frame in units of AVCodecContext.time_base.
Definition: avcodec.h:5090
attribute_deprecated int misc_bits
Definition: avcodec.h:2843
int(* execute2)(struct AVCodecContext *c, int(*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count)
The codec may call this to execute several independent things.
Definition: avcodec.h:3178
const char * long_name
Descriptive name for the codec, meant to be more human readable than name.
Definition: avcodec.h:3623
This structure describes the bitrate properties of an encoded bitstream.
Definition: avcodec.h:1311
AVBSFList * av_bsf_list_alloc(void)
Allocate empty list of bitstream filters.
The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format that the extradata buffer was...
Definition: avcodec.h:1372
int bidir_refine
Definition: avcodec.h:2347
attribute_deprecated void av_log_ask_for_sample(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message asking for a sample.
AVCodecParserContext * av_parser_init(int codec_id)
int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags)
The default callback for AVCodecContext.get_buffer2().
attribute_deprecated int mpeg_quant
Definition: avcodec.h:2013
const AVRational * supported_framerates
array of supported framerates, or NULL if any, array is terminated by {0,0}
Definition: avcodec.h:3631
A list of zero terminated key/value strings.
Definition: avcodec.h:1489
attribute_deprecated int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture, int *got_picture_ptr, const AVPacket *avpkt)
Decode the video frame of size avpkt->size from avpkt->data into picture.
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
attribute_deprecated int scenechange_threshold
Definition: avcodec.h:2271
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer...
int(* end_frame)(AVCodecContext *avctx)
Called at the end of each frame or field picture.
Definition: avcodec.h:3819
enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be)
Return the PCM codec associated with a sample format.
int compression_level
Definition: avcodec.h:1773
int seek_preroll
Number of samples to skip after a discontinuity.
Definition: avcodec.h:3472
attribute_deprecated int prediction_method
Definition: avcodec.h:2077
int sample_rate
samples per second
Definition: avcodec.h:2448
enum AVDiscard skip_idct
Skip IDCT/dequantization for selected frames.
Definition: avcodec.h:3305
attribute_deprecated int b_frame_strategy
Definition: avcodec.h:1992
Plain text, the text field must be set by the decoder and is authoritative.
Definition: avcodec.h:3921
int debug
debug
Definition: avcodec.h:2927
main external API structure.
Definition: avcodec.h:1686
AVCodec * avcodec_find_decoder(enum AVCodecID id)
Find a registered decoder with a matching codec ID.
uint8_t * av_packet_pack_dictionary(AVDictionary *dict, int *size)
Pack a dictionary for use in side_data.
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
int av_copy_packet(AVPacket *dst, const AVPacket *src)
Copy packet, including contents.
int qmin
minimum quantizer
Definition: avcodec.h:2629
attribute_deprecated ReSampleContext * av_audio_resample_init(int output_channels, int input_channels, int output_rate, int input_rate, enum AVSampleFormat sample_fmt_out, enum AVSampleFormat sample_fmt_in, int filter_length, int log2_phase_count, int linear, double cutoff)
Initialize audio resampling context.
void avsubtitle_free(AVSubtitle *sub)
Free all allocated data in the given subtitle struct.
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> (&#39;D&#39;<<24) + (&#39;C&#39;<<16) + (&#39;B&#39;<<8) + &#39;A&#39;).
Definition: avcodec.h:1718
int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame)
Supply a raw video or audio frame to the encoder.
float spatial_cplx_masking
spatial complexity masking (0-> disabled)
Definition: avcodec.h:2051
Data found in BlockAdditional element of matroska container.
Definition: avcodec.h:1508
attribute_deprecated int header_bits
Definition: avcodec.h:2831
int extradata_size
Definition: avcodec.h:1802
unsigned int av_xiphlacing(unsigned char *s, unsigned int v)
Encode extradata length to a buffer.
struct AVCodec * next
Definition: avcodec.h:3648
struct AVBitStreamFilter * filter
Definition: avcodec.h:5719
uint16_t * intra_matrix
custom intra quantization matrix
Definition: avcodec.h:2259
int nb_coded_side_data
Definition: avcodec.h:3530
int slice_flags
slice flags
Definition: avcodec.h:2229
Describe the class of an AVClass context structure.
Definition: log.h:67
int(* get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags)
This callback is called at the beginning of each frame to get data buffer(s) for it.
Definition: avcodec.h:2603
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:2416
Rational number (pair of numerator and denominator).
Definition: rational.h:58
attribute_deprecated int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Encode a frame of video.
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:2409
const char * name
short name for the profile
Definition: avcodec.h:3601
int avcodec_parameters_from_context(AVCodecParameters *par, const AVCodecContext *codec)
Fill the parameters struct based on the values from the supplied codec context.
void av_register_codec_parser(AVCodecParser *parser)
AVFieldOrder
Definition: avcodec.h:1664
Recommmends skipping the specified number of samples.
Definition: avcodec.h:1473
int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type, uint8_t *data, size_t size)
Wrap an existing array as a packet side data.
int sub_text_format
Control the form of AVSubtitle.rects[N]->ass.
Definition: avcodec.h:3560
int(* init_thread_copy)(AVCodecContext *)
If defined, called on thread contexts when they are created.
Definition: avcodec.h:3658
attribute_deprecated void audio_resample_close(ReSampleContext *s)
Free resample context.
AVMediaType
Definition: avutil.h:193
discard useless packets like 0 size packets in avi
Definition: avcodec.h:782
refcounted data buffer API
attribute_deprecated int brd_scale
Definition: avcodec.h:2352
char * codec_whitelist
&#39;,&#39; separated list of allowed decoders.
Definition: avcodec.h:3511
const char * name
Name of the codec described by this descriptor.
Definition: avcodec.h:668
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
attribute_deprecated int chromaoffset
Definition: avcodec.h:2372
float b_quant_offset
qscale offset between IP and B-frames
Definition: avcodec.h:2000
attribute_deprecated int dtg_active_format
DTG active format information (additional aspect ratio information only used in DVB MPEG-2 transport ...
Definition: avcodec.h:2192
#define AV_PARSER_PTS_NB
Definition: avcodec.h:5019
int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes)
Return audio frame duration.
float qcompress
amount of qscale change between easy & hard scenes (0.0-1.0)
Definition: avcodec.h:2621
attribute_deprecated int me_threshold
Definition: avcodec.h:2283
attribute_deprecated int p_tex_bits
Definition: avcodec.h:2835
uint16_t * inter_matrix
custom inter quantization matrix
Definition: avcodec.h:2266
int end_frame
Definition: avcodec.h:808
AVHWAccel * av_hwaccel_next(const AVHWAccel *hwaccel)
If hwaccel is NULL, returns the first registered hardware accelerator, if hwaccel is non-NULL...
attribute_deprecated int64_t convergence_duration
Definition: avcodec.h:5048
int seek_preroll
Audio only.
Definition: avcodec.h:4131
This struct describes the properties of a single codec described by an AVCodecID. ...
Definition: avcodec.h:660
float dark_masking
darkness masking (0-> disabled)
Definition: avcodec.h:2065
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:1767
static int64_t pts
Global timestamp for the audio frames.
int skip_bottom
Number of macroblock rows at the bottom which are skipped.
Definition: avcodec.h:2311
AVCodec * avcodec_find_decoder_by_name(const char *name)
Find a registered decoder with the specified name.
This side data should be associated with an audio stream and contains ReplayGain information in form ...
Definition: avcodec.h:1416
int output_picture_number
Picture number incremented in presentation or output order.
Definition: avcodec.h:5134
float temporal_cplx_masking
temporary complexity masking (0-> disabled)
Definition: avcodec.h:2044
int(* decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size)
Callback for each slice.
Definition: avcodec.h:3808
int bits_per_raw_sample
This is the number of valid bits in each output sample.
Definition: avcodec.h:4046
Pan Scan area.
Definition: avcodec.h:1282
const AVClass * priv_class
AVClass for the private context.
Definition: avcodec.h:3637
#define attribute_deprecated
Definition: attributes.h:94
int(* start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size)
Called at the beginning of each frame or field picture.
Definition: avcodec.h:3794
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition: avcodec.h:1899
int sample_rate
Audio only.
Definition: avcodec.h:4101
enum AVMediaType type
Definition: avcodec.h:662
uint8_t max_lowres
maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres() ...
Definition: avcodec.h:3636
A reference to a data buffer.
Definition: buffer.h:81
discard all non reference
Definition: avcodec.h:783
attribute_deprecated struct AVResampleContext * av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff)
Initialize an audio resampler.
An AV_PKT_DATA_JP_DUALMONO side data packet indicates that the packet may contain "dual mono" audio s...
Definition: avcodec.h:1483
AVPacketSideData * side_data
Additional packet data that can be provided by the container.
Definition: avcodec.h:1622
attribute_deprecated int64_t convergence_duration
Definition: avcodec.h:1640
int mb_cmp
macroblock comparison function (not supported yet)
Definition: avcodec.h:2116
int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf)
Parse string describing list of bitstream filters and create single AVBSFContext describing the whole...
enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos)
Converts swscale x/y chroma position to AVChromaLocation.
AVRational av_codec_get_pkt_timebase(const AVCodecContext *avctx)
Free mutex resources.
Definition: avcodec.h:6161
Utilties for rational number calculation.
attribute_deprecated void void av_register_hwaccel(AVHWAccel *hwaccel)
Register the hardware accelerator hwaccel.
attribute_deprecated void avpicture_free(AVPicture *picture)
raw UTF-8 text
Definition: avcodec.h:606
struct AVHWAccel * next
Definition: avcodec.h:3773
attribute_deprecated int rtp_payload_size
Definition: avcodec.h:2818
int nsse_weight
noise vs.
Definition: avcodec.h:3185
int(* init)(AVCodecContext *)
Definition: avcodec.h:3679
int profile
Codec-specific bitstream restrictions that the stream conforms to.
Definition: avcodec.h:4051
attribute_deprecated float border_masking
Definition: avcodec.h:2318
uint32_t start_display_time
Definition: avcodec.h:3969
int av_codec_get_seek_preroll(const AVCodecContext *avctx)
void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_padded_malloc except that buffer will always be 0-initialized after call...
int(* encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size, const struct AVSubtitle *sub)
Definition: avcodec.h:3680
void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc)
AVProfile.
Definition: avcodec.h:3599
attribute_deprecated AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:3109
int workaround_bugs
Work around bugs in encoders which sometimes cannot be detected automatically.
Definition: avcodec.h:2870
attribute_deprecated AVBitStreamFilter * av_bitstream_filter_next(const AVBitStreamFilter *f)
If f is NULL, return the first registered bitstream filter, if f is non-NULL, return the next registe...
int av_grow_packet(AVPacket *pkt, int grow_by)
Increase packet size, correctly zeroing padding.
int caps_internal
Internal codec capabilities.
Definition: avcodec.h:3720
unsigned properties
Definition: avcodec.h:3519
void av_init_packet(AVPacket *pkt)
Initialize optional fields of a packet with default values.
enum AVDiscard skip_loop_filter
Skip loop filtering for selected frames.
Definition: avcodec.h:3298
int thread_safe_callbacks
Set by the client if its custom get_buffer() callback can be called synchronously from another thread...
Definition: avcodec.h:3147
int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
attribute_deprecated float rc_qmod_amp
Definition: avcodec.h:2653
AVPictureStructure
Definition: avcodec.h:4985
attribute_deprecated void av_picture_copy(AVPicture *dst, const AVPicture *src, enum AVPixelFormat pix_fmt, int width, int height)
int trellis
trellis RD quantization
Definition: avcodec.h:2785
The optional settings (rendering instructions) that immediately follow the timestamp specifier of a W...
Definition: avcodec.h:1519
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode)
int slices
Number of slices.
Definition: avcodec.h:2439
void * priv_data
Definition: avcodec.h:1728
int cutoff
Audio cutoff bandwidth (0 means "automatic")
Definition: avcodec.h:2492
void av_codec_set_seek_preroll(AVCodecContext *avctx, int val)
FAKE codec to indicate a raw MPEG-2 TS stream (only used by libavformat)
Definition: avcodec.h:647
Formatted text, the ass field must be set by the decoder and is authoritative.
Definition: avcodec.h:3927
int64_t frame_offset
Definition: avcodec.h:4995
enum AVCodecID id
Definition: avcodec.h:661
pixel format definitions
int dia_size
ME diamond size & shape.
Definition: avcodec.h:2146
uint8_t * dump_separator
dump format separator.
Definition: avcodec.h:3503
attribute_deprecated int frame_bits
Definition: avcodec.h:2847
uneven multi-hexagon search
Definition: avcodec.h:769
attribute_deprecated int me_penalty_compensation
Definition: avcodec.h:2340
attribute_deprecated int min_prediction_order
Definition: avcodec.h:2790
as in Berlin toast format
Definition: avcodec.h:534
int avg_bitrate
Average bitrate of the stream, in bits per second.
Definition: avcodec.h:1326
char * args
Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
Definition: avcodec.h:5726
int channels
number of audio channels
Definition: avcodec.h:2449
int frame_priv_data_size
Size of per-frame hardware accelerator private data.
Definition: avcodec.h:3828
const int * supported_samplerates
array of supported audio samplerates, or NULL if unknown, array is terminated by 0 ...
Definition: avcodec.h:3633
int format
The format of the coded data, corresponds to enum AVPixelFormat for video and for enum AVSampleFormat...
Definition: avcodec.h:5156
unsigned avcodec_version(void)
Return the LIBAVCODEC_VERSION_INT constant.
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
char * ass
0 terminated ASS/SSA compatible event line.
Definition: avcodec.h:3962
This side data corresponds to the AVCPBProperties struct.
Definition: avcodec.h:1462
attribute_deprecated int p_count
Definition: avcodec.h:2839
attribute_deprecated int error_rate
Definition: avcodec.h:3331
unsigned av_codec_get_codec_properties(const AVCodecContext *avctx)
attribute_deprecated void(* rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb)
Definition: avcodec.h:2812
int mv0_threshold
Note: Value depends upon the compare function used for fullpel ME.
Definition: avcodec.h:2389
int flags2
AV_CODEC_FLAG2_*.
Definition: avcodec.h:1788
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:4033
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:4005
AVDiscard
Definition: avcodec.h:778
attribute_deprecated void av_register_bitstream_filter(AVBitStreamFilter *bsf)
Register a bitstream filter.
int channels
Audio only.
Definition: avcodec.h:4097
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: avcodec.h:1610
void avcodec_register(AVCodec *codec)
Register the codec codec and initialize libavcodec.
int64_t pts_correction_last_dts
PTS of the last frame.
Definition: avcodec.h:3432
const char * av_packet_side_data_name(enum AVPacketSideDataType type)
int * slice_offset
slice offsets in the frame in bytes
Definition: avcodec.h:2088
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:2479
attribute_deprecated void av_free_packet(AVPacket *pkt)
Free a packet.
int repeat_pict
This field is used for proper frame duration computation in lavf.
Definition: avcodec.h:5010
int64_t pts_correction_num_faulty_pts
Current statistics for PTS correction.
Definition: avcodec.h:3429
enum AVFieldOrder field_order
Field order.
Definition: avcodec.h:2445
void(* decode_mb)(struct MpegEncContext *s)
Called for every Macroblock in a slice.
Definition: avcodec.h:3839
void(* init_static_data)(struct AVCodec *codec)
Initialize codec static data, called from avcodec_register().
Definition: avcodec.h:3677
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:479
uint8_t * av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int *size)
Get side information from packet.
enum AVSampleFormat * sample_fmts
array of supported sample formats, or NULL if unknown, array is terminated by -1
Definition: avcodec.h:3634
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3995
static int height
attribute_deprecated int lmin
Definition: avcodec.h:2753
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
int debug_mv
debug Code outside libavcodec should access this field using AVOptions
Definition: avcodec.h:2964
int stream_index
Definition: avcodec.h:1613
const char *const * mime_types
MIME type(s) associated with the codec.
Definition: avcodec.h:682
int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src)
Copy packet side data.
uint64_t request_channel_layout
Request decoder to use this channel layout if it can (0 for default)
Definition: avcodec.h:2506
int me_pre_cmp
motion estimation prepass comparison function
Definition: avcodec.h:2166
The number of side data elements (in fact a bit more than it).
Definition: avcodec.h:1549
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1588
const char * avcodec_profile_name(enum AVCodecID codec_id, int profile)
Return a name for the specified profile, if available.
AVCodecParameters * par_in
Parameters of the input stream.
Definition: avcodec.h:5768
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, const AVSubtitle *sub)
int key_frame
Set by parser to 1 for key frames and 0 for non-key frames.
Definition: avcodec.h:5041
int delay
Codec delay.
Definition: avcodec.h:1856
int me_subpel_quality
subpel ME quality
Definition: avcodec.h:2180
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition: avcodec.h:2905
int dts_sync_point
Synchronization point for start of timestamp generation.
Definition: avcodec.h:5061
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1604
struct ReSampleContext ReSampleContext
Definition: avcodec.h:5355
enum AVPixelFormat sw_pix_fmt
Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:3393
A dummy ID pointing at the start of subtitle codecs.
Definition: avcodec.h:603
void * opaque
Private data of the user, can be used to carry app specific stuff.
Definition: avcodec.h:1743
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:3128
AVSubtitleType
Definition: avcodec.h:3912
int avcodec_default_execute(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2), void *arg, int *ret, int count, int size)
int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf)
Finalize list of bitstream filters.
discard nothing
Definition: avcodec.h:781
int64_t rc_max_rate
maximum bitrate
Definition: avcodec.h:2686
attribute_deprecated int pre_me
Definition: avcodec.h:2158
This side data should be associated with an audio stream and corresponds to enum AVAudioServiceType.
Definition: avcodec.h:1437
uint8_t * subtitle_header
Header containing style information for text subtitles.
Definition: avcodec.h:3322
int keyint_min
minimum GOP size
Definition: avcodec.h:2360
static int width