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