FFmpeg coverage

Line	Branch	Exec	Source
1			/*
2			* This file is part of FFmpeg.
3			*
4			* FFmpeg is free software; you can redistribute it and/or
5			* modify it under the terms of the GNU Lesser General Public
6			* License as published by the Free Software Foundation; either
7			* version 2.1 of the License, or (at your option) any later version.
8			*
9			* FFmpeg is distributed in the hope that it will be useful,
10			* but WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12			* Lesser General Public License for more details.
13			*
14			* You should have received a copy of the GNU Lesser General Public
15			* License along with FFmpeg; if not, write to the Free Software
16			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17			*/
18
19			/**
20			* @file
21			* @ingroup lavu_frame
22			* reference-counted frame API
23			*/
24
25			#ifndef AVUTIL_FRAME_H
26			#define AVUTIL_FRAME_H
27
28			#include <stddef.h>
29			#include <stdint.h>
30
31			#include "avutil.h"
32			#include "buffer.h"
33			#include "channel_layout.h"
34			#include "dict.h"
35			#include "rational.h"
36			#include "samplefmt.h"
37			#include "pixfmt.h"
38			#include "version.h"
39
40
41			/**
42			* @defgroup lavu_frame AVFrame
43			* @ingroup lavu_data
44			*
45			* @{
46			* AVFrame is an abstraction for reference-counted raw multimedia data.
47			*/
48
49			enum AVFrameSideDataType {
50			/**
51			* The data is the AVPanScan struct defined in libavcodec.
52			*/
53			AV_FRAME_DATA_PANSCAN,
54			/**
55			* ATSC A53 Part 4 Closed Captions.
56			* A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
57			* The number of bytes of CC data is AVFrameSideData.size.
58			*/
59			AV_FRAME_DATA_A53_CC,
60			/**
61			* Stereoscopic 3d metadata.
62			* The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
63			*/
64			AV_FRAME_DATA_STEREO3D,
65			/**
66			* The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
67			*/
68			AV_FRAME_DATA_MATRIXENCODING,
69			/**
70			* Metadata relevant to a downmix procedure.
71			* The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
72			*/
73			AV_FRAME_DATA_DOWNMIX_INFO,
74			/**
75			* ReplayGain information in the form of the AVReplayGain struct.
76			*/
77			AV_FRAME_DATA_REPLAYGAIN,
78			/**
79			* This side data contains a 3x3 transformation matrix describing an affine
80			* transformation that needs to be applied to the frame for correct
81			* presentation.
82			*
83			* See libavutil/display.h for a detailed description of the data.
84			*/
85			AV_FRAME_DATA_DISPLAYMATRIX,
86			/**
87			* Active Format Description data consisting of a single byte as specified
88			* in ETSI TS 101 154 using AVActiveFormatDescription enum.
89			*/
90			AV_FRAME_DATA_AFD,
91			/**
92			* Motion vectors exported by some codecs (on demand through the export_mvs
93			* flag set in the libavcodec AVCodecContext flags2 option).
94			* The data is the AVMotionVector struct defined in
95			* libavutil/motion_vector.h.
96			*/
97			AV_FRAME_DATA_MOTION_VECTORS,
98			/**
99			* Recommmends skipping the specified number of samples. This is exported
100			* only if the "skip_manual" AVOption is set in libavcodec.
101			* This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
102			* @code
103			* u32le number of samples to skip from start of this packet
104			* u32le number of samples to skip from end of this packet
105			* u8 reason for start skip
106			* u8 reason for end skip (0=padding silence, 1=convergence)
107			* @endcode
108			*/
109			AV_FRAME_DATA_SKIP_SAMPLES,
110			/**
111			* This side data must be associated with an audio frame and corresponds to
112			* enum AVAudioServiceType defined in avcodec.h.
113			*/
114			AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
115			/**
116			* Mastering display metadata associated with a video frame. The payload is
117			* an AVMasteringDisplayMetadata type and contains information about the
118			* mastering display color volume.
119			*/
120			AV_FRAME_DATA_MASTERING_DISPLAY_METADATA,
121			/**
122			* The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
123			* This is set on the first frame of a GOP that has a temporal reference of 0.
124			*/
125			AV_FRAME_DATA_GOP_TIMECODE,
126
127			/**
128			* The data represents the AVSphericalMapping structure defined in
129			* libavutil/spherical.h.
130			*/
131			AV_FRAME_DATA_SPHERICAL,
132
133			/**
134			* Content light level (based on CTA-861.3). This payload contains data in
135			* the form of the AVContentLightMetadata struct.
136			*/
137			AV_FRAME_DATA_CONTENT_LIGHT_LEVEL,
138
139			/**
140			* The data contains an ICC profile as an opaque octet buffer following the
141			* format described by ISO 15076-1 with an optional name defined in the
142			* metadata key entry "name".
143			*/
144			AV_FRAME_DATA_ICC_PROFILE,
145
146			/**
147			* Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t
148			* where the first uint32_t describes how many (1-3) of the other timecodes are used.
149			* The timecode format is described in the documentation of av_timecode_get_smpte_from_framenum()
150			* function in libavutil/timecode.h.
151			*/
152			AV_FRAME_DATA_S12M_TIMECODE,
153
154			/**
155			* HDR dynamic metadata associated with a video frame. The payload is
156			* an AVDynamicHDRPlus type and contains information for color
157			* volume transform - application 4 of SMPTE 2094-40:2016 standard.
158			*/
159			AV_FRAME_DATA_DYNAMIC_HDR_PLUS,
160
161			/**
162			* Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of
163			* array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.
164			*/
165			AV_FRAME_DATA_REGIONS_OF_INTEREST,
166
167			/**
168			* Encoding parameters for a video frame, as described by AVVideoEncParams.
169			*/
170			AV_FRAME_DATA_VIDEO_ENC_PARAMS,
171
172			/**
173			* User data unregistered metadata associated with a video frame.
174			* This is the H.26[45] UDU SEI message, and shouldn't be used for any other purpose
175			* The data is stored as uint8_t in AVFrameSideData.data which is 16 bytes of
176			* uuid_iso_iec_11578 followed by AVFrameSideData.size - 16 bytes of user_data_payload_byte.
177			*/
178			AV_FRAME_DATA_SEI_UNREGISTERED,
179
180			/**
181			* Film grain parameters for a frame, described by AVFilmGrainParams.
182			* Must be present for every frame which should have film grain applied.
183			*
184			* May be present multiple times, for example when there are multiple
185			* alternative parameter sets for different video signal characteristics.
186			* The user should select the most appropriate set for the application.
187			*/
188			AV_FRAME_DATA_FILM_GRAIN_PARAMS,
189
190			/**
191			* Bounding boxes for object detection and classification,
192			* as described by AVDetectionBBoxHeader.
193			*/
194			AV_FRAME_DATA_DETECTION_BBOXES,
195
196			/**
197			* Dolby Vision RPU raw data, suitable for passing to x265
198			* or other libraries. Array of uint8_t, with NAL emulation
199			* bytes intact.
200			*/
201			AV_FRAME_DATA_DOVI_RPU_BUFFER,
202
203			/**
204			* Parsed Dolby Vision metadata, suitable for passing to a software
205			* implementation. The payload is the AVDOVIMetadata struct defined in
206			* libavutil/dovi_meta.h.
207			*/
208			AV_FRAME_DATA_DOVI_METADATA,
209
210			/**
211			* HDR Vivid dynamic metadata associated with a video frame. The payload is
212			* an AVDynamicHDRVivid type and contains information for color
213			* volume transform - CUVA 005.1-2021.
214			*/
215			AV_FRAME_DATA_DYNAMIC_HDR_VIVID,
216
217			/**
218			* Ambient viewing environment metadata, as defined by H.274.
219			*/
220			AV_FRAME_DATA_AMBIENT_VIEWING_ENVIRONMENT,
221
222			/**
223			* Provide encoder-specific hinting information about changed/unchanged
224			* portions of a frame. It can be used to pass information about which
225			* macroblocks can be skipped because they didn't change from the
226			* corresponding ones in the previous frame. This could be useful for
227			* applications which know this information in advance to speed up
228			* encoding.
229			*/
230			AV_FRAME_DATA_VIDEO_HINT,
231			};
232
233			enum AVActiveFormatDescription {
234			AV_AFD_SAME = 8,
235			AV_AFD_4_3 = 9,
236			AV_AFD_16_9 = 10,
237			AV_AFD_14_9 = 11,
238			AV_AFD_4_3_SP_14_9 = 13,
239			AV_AFD_16_9_SP_14_9 = 14,
240			AV_AFD_SP_4_3 = 15,
241			};
242
243
244			/**
245			* Structure to hold side data for an AVFrame.
246			*
247			* sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
248			* to the end with a minor bump.
249			*/
250			typedef struct AVFrameSideData {
251			enum AVFrameSideDataType type;
252			uint8_t *data;
253			size_t size;
254			AVDictionary *metadata;
255			AVBufferRef *buf;
256			} AVFrameSideData;
257
258			enum AVSideDataProps {
259			/**
260			* The side data type can be used in stream-global structures.
261			* Side data types without this property are only meaningful on per-frame
262			* basis.
263			*/
264			AV_SIDE_DATA_PROP_GLOBAL = (1 << 0),
265
266			/**
267			* Multiple instances of this side data type can be meaningfully present in
268			* a single side data array.
269			*/
270			AV_SIDE_DATA_PROP_MULTI = (1 << 1),
271			};
272
273			/**
274			* This struct describes the properties of a side data type. Its instance
275			* corresponding to a given type can be obtained from av_frame_side_data_desc().
276			*/
277			typedef struct AVSideDataDescriptor {
278			/**
279			* Human-readable side data description.
280			*/
281			const char *name;
282
283			/**
284			* Side data property flags, a combination of AVSideDataProps values.
285			*/
286			unsigned props;
287			} AVSideDataDescriptor;
288
289			/**
290			* Structure describing a single Region Of Interest.
291			*
292			* When multiple regions are defined in a single side-data block, they
293			* should be ordered from most to least important - some encoders are only
294			* capable of supporting a limited number of distinct regions, so will have
295			* to truncate the list.
296			*
297			* When overlapping regions are defined, the first region containing a given
298			* area of the frame applies.
299			*/
300			typedef struct AVRegionOfInterest {
301			/**
302			* Must be set to the size of this data structure (that is,
303			* sizeof(AVRegionOfInterest)).
304			*/
305			uint32_t self_size;
306			/**
307			* Distance in pixels from the top edge of the frame to the top and
308			* bottom edges and from the left edge of the frame to the left and
309			* right edges of the rectangle defining this region of interest.
310			*
311			* The constraints on a region are encoder dependent, so the region
312			* actually affected may be slightly larger for alignment or other
313			* reasons.
314			*/
315			int top;
316			int bottom;
317			int left;
318			int right;
319			/**
320			* Quantisation offset.
321			*
322			* Must be in the range -1 to +1. A value of zero indicates no quality
323			* change. A negative value asks for better quality (less quantisation),
324			* while a positive value asks for worse quality (greater quantisation).
325			*
326			* The range is calibrated so that the extreme values indicate the
327			* largest possible offset - if the rest of the frame is encoded with the
328			* worst possible quality, an offset of -1 indicates that this region
329			* should be encoded with the best possible quality anyway. Intermediate
330			* values are then interpolated in some codec-dependent way.
331			*
332			* For example, in 10-bit H.264 the quantisation parameter varies between
333			* -12 and 51. A typical qoffset value of -1/10 therefore indicates that
334			* this region should be encoded with a QP around one-tenth of the full
335			* range better than the rest of the frame. So, if most of the frame
336			* were to be encoded with a QP of around 30, this region would get a QP
337			* of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
338			* An extreme value of -1 would indicate that this region should be
339			* encoded with the best possible quality regardless of the treatment of
340			* the rest of the frame - that is, should be encoded at a QP of -12.
341			*/
342			AVRational qoffset;
343			} AVRegionOfInterest;
344
345			/**
346			* This structure describes decoded (raw) audio or video data.
347			*
348			* AVFrame must be allocated using av_frame_alloc(). Note that this only
349			* allocates the AVFrame itself, the buffers for the data must be managed
350			* through other means (see below).
351			* AVFrame must be freed with av_frame_free().
352			*
353			* AVFrame is typically allocated once and then reused multiple times to hold
354			* different data (e.g. a single AVFrame to hold frames received from a
355			* decoder). In such a case, av_frame_unref() will free any references held by
356			* the frame and reset it to its original clean state before it
357			* is reused again.
358			*
359			* The data described by an AVFrame is usually reference counted through the
360			* AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
361			* AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
362			* least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
363			* every single data plane must be contained in one of the buffers in
364			* AVFrame.buf or AVFrame.extended_buf.
365			* There may be a single buffer for all the data, or one separate buffer for
366			* each plane, or anything in between.
367			*
368			* sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
369			* to the end with a minor bump.
370			*
371			* Fields can be accessed through AVOptions, the name string used, matches the
372			* C structure field name for fields accessible through AVOptions.
373			*/
374			typedef struct AVFrame {
375			#define AV_NUM_DATA_POINTERS 8
376			/**
377			* pointer to the picture/channel planes.
378			* This might be different from the first allocated byte. For video,
379			* it could even point to the end of the image data.
380			*
381			* All pointers in data and extended_data must point into one of the
382			* AVBufferRef in buf or extended_buf.
383			*
384			* Some decoders access areas outside 0,0 - width,height, please
385			* see avcodec_align_dimensions2(). Some filters and swscale can read
386			* up to 16 bytes beyond the planes, if these filters are to be used,
387			* then 16 extra bytes must be allocated.
388			*
389			* NOTE: Pointers not needed by the format MUST be set to NULL.
390			*
391			* @attention In case of video, the data[] pointers can point to the
392			* end of image data in order to reverse line order, when used in
393			* combination with negative values in the linesize[] array.
394			*/
395			uint8_t *data[AV_NUM_DATA_POINTERS];
396
397			/**
398			* For video, a positive or negative value, which is typically indicating
399			* the size in bytes of each picture line, but it can also be:
400			* - the negative byte size of lines for vertical flipping
401			* (with data[n] pointing to the end of the data
402			* - a positive or negative multiple of the byte size as for accessing
403			* even and odd fields of a frame (possibly flipped)
404			*
405			* For audio, only linesize[0] may be set. For planar audio, each channel
406			* plane must be the same size.
407			*
408			* For video the linesizes should be multiples of the CPUs alignment
409			* preference, this is 16 or 32 for modern desktop CPUs.
410			* Some code requires such alignment other code can be slower without
411			* correct alignment, for yet other it makes no difference.
412			*
413			* @note The linesize may be larger than the size of usable data -- there
414			* may be extra padding present for performance reasons.
415			*
416			* @attention In case of video, line size values can be negative to achieve
417			* a vertically inverted iteration over image lines.
418			*/
419			int linesize[AV_NUM_DATA_POINTERS];
420
421			/**
422			* pointers to the data planes/channels.
423			*
424			* For video, this should simply point to data[].
425			*
426			* For planar audio, each channel has a separate data pointer, and
427			* linesize[0] contains the size of each channel buffer.
428			* For packed audio, there is just one data pointer, and linesize[0]
429			* contains the total size of the buffer for all channels.
430			*
431			* Note: Both data and extended_data should always be set in a valid frame,
432			* but for planar audio with more channels that can fit in data,
433			* extended_data must be used in order to access all channels.
434			*/
435			uint8_t **extended_data;
436
437			/**
438			* @name Video dimensions
439			* Video frames only. The coded dimensions (in pixels) of the video frame,
440			* i.e. the size of the rectangle that contains some well-defined values.
441			*
442			* @note The part of the frame intended for display/presentation is further
443			* restricted by the @ref cropping "Cropping rectangle".
444			* @{
445			*/
446			int width, height;
447			/**
448			* @}
449			*/
450
451			/**
452			* number of audio samples (per channel) described by this frame
453			*/
454			int nb_samples;
455
456			/**
457			* format of the frame, -1 if unknown or unset
458			* Values correspond to enum AVPixelFormat for video frames,
459			* enum AVSampleFormat for audio)
460			*/
461			int format;
462
463			#if FF_API_FRAME_KEY
464			/**
465			* 1 -> keyframe, 0-> not
466			*
467			* @deprecated Use AV_FRAME_FLAG_KEY instead
468			*/
469			attribute_deprecated
470			int key_frame;
471			#endif
472
473			/**
474			* Picture type of the frame.
475			*/
476			enum AVPictureType pict_type;
477
478			/**
479			* Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
480			*/
481			AVRational sample_aspect_ratio;
482
483			/**
484			* Presentation timestamp in time_base units (time when frame should be shown to user).
485			*/
486			int64_t pts;
487
488			/**
489			* DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
490			* This is also the Presentation time of this AVFrame calculated from
491			* only AVPacket.dts values without pts values.
492			*/
493			int64_t pkt_dts;
494
495			/**
496			* Time base for the timestamps in this frame.
497			* In the future, this field may be set on frames output by decoders or
498			* filters, but its value will be by default ignored on input to encoders
499			* or filters.
500			*/
501			AVRational time_base;
502
503			/**
504			* quality (between 1 (good) and FF_LAMBDA_MAX (bad))
505			*/
506			int quality;
507
508			/**
509			* Frame owner's private data.
510			*
511			* This field may be set by the code that allocates/owns the frame data.
512			* It is then not touched by any library functions, except:
513			* - it is copied to other references by av_frame_copy_props() (and hence by
514			* av_frame_ref());
515			* - it is set to NULL when the frame is cleared by av_frame_unref()
516			* - on the caller's explicit request. E.g. libavcodec encoders/decoders
517			* will copy this field to/from @ref AVPacket "AVPackets" if the caller sets
518			* @ref AV_CODEC_FLAG_COPY_OPAQUE.
519			*
520			* @see opaque_ref the reference-counted analogue
521			*/
522			void *opaque;
523
524			/**
525			* Number of fields in this frame which should be repeated, i.e. the total
526			* duration of this frame should be repeat_pict + 2 normal field durations.
527			*
528			* For interlaced frames this field may be set to 1, which signals that this
529			* frame should be presented as 3 fields: beginning with the first field (as
530			* determined by AV_FRAME_FLAG_TOP_FIELD_FIRST being set or not), followed
531			* by the second field, and then the first field again.
532			*
533			* For progressive frames this field may be set to a multiple of 2, which
534			* signals that this frame's duration should be (repeat_pict + 2) / 2
535			* normal frame durations.
536			*
537			* @note This field is computed from MPEG2 repeat_first_field flag and its
538			* associated flags, H.264 pic_struct from picture timing SEI, and
539			* their analogues in other codecs. Typically it should only be used when
540			* higher-layer timing information is not available.
541			*/
542			int repeat_pict;
543
544			#if FF_API_INTERLACED_FRAME
545			/**
546			* The content of the picture is interlaced.
547			*
548			* @deprecated Use AV_FRAME_FLAG_INTERLACED instead
549			*/
550			attribute_deprecated
551			int interlaced_frame;
552
553			/**
554			* If the content is interlaced, is top field displayed first.
555			*
556			* @deprecated Use AV_FRAME_FLAG_TOP_FIELD_FIRST instead
557			*/
558			attribute_deprecated
559			int top_field_first;
560			#endif
561
562			#if FF_API_PALETTE_HAS_CHANGED
563			/**
564			* Tell user application that palette has changed from previous frame.
565			*/
566			attribute_deprecated
567			int palette_has_changed;
568			#endif
569
570			/**
571			* Sample rate of the audio data.
572			*/
573			int sample_rate;
574
575			/**
576			* AVBuffer references backing the data for this frame. All the pointers in
577			* data and extended_data must point inside one of the buffers in buf or
578			* extended_buf. This array must be filled contiguously -- if buf[i] is
579			* non-NULL then buf[j] must also be non-NULL for all j < i.
580			*
581			* There may be at most one AVBuffer per data plane, so for video this array
582			* always contains all the references. For planar audio with more than
583			* AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
584			* this array. Then the extra AVBufferRef pointers are stored in the
585			* extended_buf array.
586			*/
587			AVBufferRef *buf[AV_NUM_DATA_POINTERS];
588
589			/**
590			* For planar audio which requires more than AV_NUM_DATA_POINTERS
591			* AVBufferRef pointers, this array will hold all the references which
592			* cannot fit into AVFrame.buf.
593			*
594			* Note that this is different from AVFrame.extended_data, which always
595			* contains all the pointers. This array only contains the extra pointers,
596			* which cannot fit into AVFrame.buf.
597			*
598			* This array is always allocated using av_malloc() by whoever constructs
599			* the frame. It is freed in av_frame_unref().
600			*/
601			AVBufferRef **extended_buf;
602			/**
603			* Number of elements in extended_buf.
604			*/
605			int nb_extended_buf;
606
607			AVFrameSideData **side_data;
608			int nb_side_data;
609
610			/**
611			* @defgroup lavu_frame_flags AV_FRAME_FLAGS
612			* @ingroup lavu_frame
613			* Flags describing additional frame properties.
614			*
615			* @{
616			*/
617
618			/**
619			* The frame data may be corrupted, e.g. due to decoding errors.
620			*/
621			#define AV_FRAME_FLAG_CORRUPT (1 << 0)
622			/**
623			* A flag to mark frames that are keyframes.
624			*/
625			#define AV_FRAME_FLAG_KEY (1 << 1)
626			/**
627			* A flag to mark the frames which need to be decoded, but shouldn't be output.
628			*/
629			#define AV_FRAME_FLAG_DISCARD (1 << 2)
630			/**
631			* A flag to mark frames whose content is interlaced.
632			*/
633			#define AV_FRAME_FLAG_INTERLACED (1 << 3)
634			/**
635			* A flag to mark frames where the top field is displayed first if the content
636			* is interlaced.
637			*/
638			#define AV_FRAME_FLAG_TOP_FIELD_FIRST (1 << 4)
639			/**
640			* @}
641			*/
642
643			/**
644			* Frame flags, a combination of @ref lavu_frame_flags
645			*/
646			int flags;
647
648			/**
649			* MPEG vs JPEG YUV range.
650			* - encoding: Set by user
651			* - decoding: Set by libavcodec
652			*/
653			enum AVColorRange color_range;
654
655			enum AVColorPrimaries color_primaries;
656
657			enum AVColorTransferCharacteristic color_trc;
658
659			/**
660			* YUV colorspace type.
661			* - encoding: Set by user
662			* - decoding: Set by libavcodec
663			*/
664			enum AVColorSpace colorspace;
665
666			enum AVChromaLocation chroma_location;
667
668			/**
669			* frame timestamp estimated using various heuristics, in stream time base
670			* - encoding: unused
671			* - decoding: set by libavcodec, read by user.
672			*/
673			int64_t best_effort_timestamp;
674
675			#if FF_API_FRAME_PKT
676			/**
677			* reordered pos from the last AVPacket that has been input into the decoder
678			* - encoding: unused
679			* - decoding: Read by user.
680			* @deprecated use AV_CODEC_FLAG_COPY_OPAQUE to pass through arbitrary user
681			* data from packets to frames
682			*/
683			attribute_deprecated
684			int64_t pkt_pos;
685			#endif
686
687			/**
688			* metadata.
689			* - encoding: Set by user.
690			* - decoding: Set by libavcodec.
691			*/
692			AVDictionary *metadata;
693
694			/**
695			* decode error flags of the frame, set to a combination of
696			* FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
697			* were errors during the decoding.
698			* - encoding: unused
699			* - decoding: set by libavcodec, read by user.
700			*/
701			int decode_error_flags;
702			#define FF_DECODE_ERROR_INVALID_BITSTREAM 1
703			#define FF_DECODE_ERROR_MISSING_REFERENCE 2
704			#define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
705			#define FF_DECODE_ERROR_DECODE_SLICES 8
706
707			#if FF_API_FRAME_PKT
708			/**
709			* size of the corresponding packet containing the compressed
710			* frame.
711			* It is set to a negative value if unknown.
712			* - encoding: unused
713			* - decoding: set by libavcodec, read by user.
714			* @deprecated use AV_CODEC_FLAG_COPY_OPAQUE to pass through arbitrary user
715			* data from packets to frames
716			*/
717			attribute_deprecated
718			int pkt_size;
719			#endif
720
721			/**
722			* For hwaccel-format frames, this should be a reference to the
723			* AVHWFramesContext describing the frame.
724			*/
725			AVBufferRef *hw_frames_ctx;
726
727			/**
728			* Frame owner's private data.
729			*
730			* This field may be set by the code that allocates/owns the frame data.
731			* It is then not touched by any library functions, except:
732			* - a new reference to the underlying buffer is propagated by
733			* av_frame_copy_props() (and hence by av_frame_ref());
734			* - it is unreferenced in av_frame_unref();
735			* - on the caller's explicit request. E.g. libavcodec encoders/decoders
736			* will propagate a new reference to/from @ref AVPacket "AVPackets" if the
737			* caller sets @ref AV_CODEC_FLAG_COPY_OPAQUE.
738			*
739			* @see opaque the plain pointer analogue
740			*/
741			AVBufferRef *opaque_ref;
742
743			/**
744			* @anchor cropping
745			* @name Cropping
746			* Video frames only. The number of pixels to discard from the the
747			* top/bottom/left/right border of the frame to obtain the sub-rectangle of
748			* the frame intended for presentation.
749			* @{
750			*/
751			size_t crop_top;
752			size_t crop_bottom;
753			size_t crop_left;
754			size_t crop_right;
755			/**
756			* @}
757			*/
758
759			/**
760			* AVBufferRef for internal use by a single libav* library.
761			* Must not be used to transfer data between libraries.
762			* Has to be NULL when ownership of the frame leaves the respective library.
763			*
764			* Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
765			*
766			* FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
767			* av_frame_copy_props() calls create a new reference with av_buffer_ref()
768			* for the target frame's private_ref field.
769			*/
770			AVBufferRef *private_ref;
771
772			/**
773			* Channel layout of the audio data.
774			*/
775			AVChannelLayout ch_layout;
776
777			/**
778			* Duration of the frame, in the same units as pts. 0 if unknown.
779			*/
780			int64_t duration;
781			} AVFrame;
782
783
784			/**
785			* Allocate an AVFrame and set its fields to default values. The resulting
786			* struct must be freed using av_frame_free().
787			*
788			* @return An AVFrame filled with default values or NULL on failure.
789			*
790			* @note this only allocates the AVFrame itself, not the data buffers. Those
791			* must be allocated through other means, e.g. with av_frame_get_buffer() or
792			* manually.
793			*/
794			AVFrame *av_frame_alloc(void);
795
796			/**
797			* Free the frame and any dynamically allocated objects in it,
798			* e.g. extended_data. If the frame is reference counted, it will be
799			* unreferenced first.
800			*
801			* @param frame frame to be freed. The pointer will be set to NULL.
802			*/
803			void av_frame_free(AVFrame **frame);
804
805			/**
806			* Set up a new reference to the data described by the source frame.
807			*
808			* Copy frame properties from src to dst and create a new reference for each
809			* AVBufferRef from src.
810			*
811			* If src is not reference counted, new buffers are allocated and the data is
812			* copied.
813			*
814			* @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
815			* or newly allocated with av_frame_alloc() before calling this
816			* function, or undefined behavior will occur.
817			*
818			* @return 0 on success, a negative AVERROR on error
819			*/
820			int av_frame_ref(AVFrame *dst, const AVFrame *src);
821
822			/**
823			* Ensure the destination frame refers to the same data described by the source
824			* frame, either by creating a new reference for each AVBufferRef from src if
825			* they differ from those in dst, by allocating new buffers and copying data if
826			* src is not reference counted, or by unrefencing it if src is empty.
827			*
828			* Frame properties on dst will be replaced by those from src.
829			*
830			* @return 0 on success, a negative AVERROR on error. On error, dst is
831			* unreferenced.
832			*/
833			int av_frame_replace(AVFrame *dst, const AVFrame *src);
834
835			/**
836			* Create a new frame that references the same data as src.
837			*
838			* This is a shortcut for av_frame_alloc()+av_frame_ref().
839			*
840			* @return newly created AVFrame on success, NULL on error.
841			*/
842			AVFrame *av_frame_clone(const AVFrame *src);
843
844			/**
845			* Unreference all the buffers referenced by frame and reset the frame fields.
846			*/
847			void av_frame_unref(AVFrame *frame);
848
849			/**
850			* Move everything contained in src to dst and reset src.
851			*
852			* @warning: dst is not unreferenced, but directly overwritten without reading
853			* or deallocating its contents. Call av_frame_unref(dst) manually
854			* before calling this function to ensure that no memory is leaked.
855			*/
856			void av_frame_move_ref(AVFrame *dst, AVFrame *src);
857
858			/**
859			* Allocate new buffer(s) for audio or video data.
860			*
861			* The following fields must be set on frame before calling this function:
862			* - format (pixel format for video, sample format for audio)
863			* - width and height for video
864			* - nb_samples and ch_layout for audio
865			*
866			* This function will fill AVFrame.data and AVFrame.buf arrays and, if
867			* necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
868			* For planar formats, one buffer will be allocated for each plane.
869			*
870			* @warning: if frame already has been allocated, calling this function will
871			* leak memory. In addition, undefined behavior can occur in certain
872			* cases.
873			*
874			* @param frame frame in which to store the new buffers.
875			* @param align Required buffer size alignment. If equal to 0, alignment will be
876			* chosen automatically for the current CPU. It is highly
877			* recommended to pass 0 here unless you know what you are doing.
878			*
879			* @return 0 on success, a negative AVERROR on error.
880			*/
881			int av_frame_get_buffer(AVFrame *frame, int align);
882
883			/**
884			* Check if the frame data is writable.
885			*
886			* @return A positive value if the frame data is writable (which is true if and
887			* only if each of the underlying buffers has only one reference, namely the one
888			* stored in this frame). Return 0 otherwise.
889			*
890			* If 1 is returned the answer is valid until av_buffer_ref() is called on any
891			* of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
892			*
893			* @see av_frame_make_writable(), av_buffer_is_writable()
894			*/
895			int av_frame_is_writable(AVFrame *frame);
896
897			/**
898			* Ensure that the frame data is writable, avoiding data copy if possible.
899			*
900			* Do nothing if the frame is writable, allocate new buffers and copy the data
901			* if it is not. Non-refcounted frames behave as non-writable, i.e. a copy
902			* is always made.
903			*
904			* @return 0 on success, a negative AVERROR on error.
905			*
906			* @see av_frame_is_writable(), av_buffer_is_writable(),
907			* av_buffer_make_writable()
908			*/
909			int av_frame_make_writable(AVFrame *frame);
910
911			/**
912			* Copy the frame data from src to dst.
913			*
914			* This function does not allocate anything, dst must be already initialized and
915			* allocated with the same parameters as src.
916			*
917			* This function only copies the frame data (i.e. the contents of the data /
918			* extended data arrays), not any other properties.
919			*
920			* @return >= 0 on success, a negative AVERROR on error.
921			*/
922			int av_frame_copy(AVFrame *dst, const AVFrame *src);
923
924			/**
925			* Copy only "metadata" fields from src to dst.
926			*
927			* Metadata for the purpose of this function are those fields that do not affect
928			* the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
929			* aspect ratio (for video), but not width/height or channel layout.
930			* Side data is also copied.
931			*/
932			int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
933
934			/**
935			* Get the buffer reference a given data plane is stored in.
936			*
937			* @param frame the frame to get the plane's buffer from
938			* @param plane index of the data plane of interest in frame->extended_data.
939			*
940			* @return the buffer reference that contains the plane or NULL if the input
941			* frame is not valid.
942			*/
943			AVBufferRef *av_frame_get_plane_buffer(const AVFrame *frame, int plane);
944
945			/**
946			* Add a new side data to a frame.
947			*
948			* @param frame a frame to which the side data should be added
949			* @param type type of the added side data
950			* @param size size of the side data
951			*
952			* @return newly added side data on success, NULL on error
953			*/
954			AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
955			enum AVFrameSideDataType type,
956			size_t size);
957
958			/**
959			* Add a new side data to a frame from an existing AVBufferRef
960			*
961			* @param frame a frame to which the side data should be added
962			* @param type the type of the added side data
963			* @param buf an AVBufferRef to add as side data. The ownership of
964			* the reference is transferred to the frame.
965			*
966			* @return newly added side data on success, NULL on error. On failure
967			* the frame is unchanged and the AVBufferRef remains owned by
968			* the caller.
969			*/
970			AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame,
971			enum AVFrameSideDataType type,
972			AVBufferRef *buf);
973
974			/**
975			* @return a pointer to the side data of a given type on success, NULL if there
976			* is no side data with such type in this frame.
977			*/
978			AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
979			enum AVFrameSideDataType type);
980
981			/**
982			* Remove and free all side data instances of the given type.
983			*/
984			void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
985
986
987			/**
988			* Flags for frame cropping.
989			*/
990			enum {
991			/**
992			* Apply the maximum possible cropping, even if it requires setting the
993			* AVFrame.data[] entries to unaligned pointers. Passing unaligned data
994			* to FFmpeg API is generally not allowed, and causes undefined behavior
995			* (such as crashes). You can pass unaligned data only to FFmpeg APIs that
996			* are explicitly documented to accept it. Use this flag only if you
997			* absolutely know what you are doing.
998			*/
999			AV_FRAME_CROP_UNALIGNED = 1 << 0,
1000			};
1001
1002			/**
1003			* Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
1004			* crop_bottom fields. If cropping is successful, the function will adjust the
1005			* data pointers and the width/height fields, and set the crop fields to 0.
1006			*
1007			* In all cases, the cropping boundaries will be rounded to the inherent
1008			* alignment of the pixel format. In some cases, such as for opaque hwaccel
1009			* formats, the left/top cropping is ignored. The crop fields are set to 0 even
1010			* if the cropping was rounded or ignored.
1011			*
1012			* @param frame the frame which should be cropped
1013			* @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
1014			*
1015			* @return >= 0 on success, a negative AVERROR on error. If the cropping fields
1016			* were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
1017			*/
1018			int av_frame_apply_cropping(AVFrame *frame, int flags);
1019
1020			/**
1021			* @return a string identifying the side data type
1022			*/
1023			const char *av_frame_side_data_name(enum AVFrameSideDataType type);
1024
1025			/**
1026			* @return side data descriptor corresponding to a given side data type, NULL
1027			* when not available.
1028			*/
1029			const AVSideDataDescriptor *av_frame_side_data_desc(enum AVFrameSideDataType type);
1030
1031			/**
1032			* Free all side data entries and their contents, then zeroes out the
1033			* values which the pointers are pointing to.
1034			*
1035			* @param sd pointer to array of side data to free. Will be set to NULL
1036			* upon return.
1037			* @param nb_sd pointer to an integer containing the number of entries in
1038			* the array. Will be set to 0 upon return.
1039			*/
1040			void av_frame_side_data_free(AVFrameSideData ***sd, int *nb_sd);
1041
1042			/**
1043			* Remove existing entries before adding new ones.
1044			*/
1045			#define AV_FRAME_SIDE_DATA_FLAG_UNIQUE (1 << 0)
1046			/**
1047			* Don't add a new entry if another of the same type exists.
1048			* Applies only for side data types without the AV_SIDE_DATA_PROP_MULTI prop.
1049			*/
1050			#define AV_FRAME_SIDE_DATA_FLAG_REPLACE (1 << 1)
1051
1052			/**
1053			* Add new side data entry to an array.
1054			*
1055			* @param sd pointer to array of side data to which to add another entry,
1056			* or to NULL in order to start a new array.
1057			* @param nb_sd pointer to an integer containing the number of entries in
1058			* the array.
1059			* @param type type of the added side data
1060			* @param size size of the side data
1061			* @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1062			*
1063			* @return newly added side data on success, NULL on error.
1064			* @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1065			* matching AVFrameSideDataType will be removed before the addition
1066			* is attempted.
1067			* @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1068			* entry of the same type already exists, it will be replaced instead.
1069			*/
1070			AVFrameSideData *av_frame_side_data_new(AVFrameSideData ***sd, int *nb_sd,
1071			enum AVFrameSideDataType type,
1072			size_t size, unsigned int flags);
1073
1074			/**
1075			* Add a new side data entry to an array from an existing AVBufferRef.
1076			*
1077			* @param sd pointer to array of side data to which to add another entry,
1078			* or to NULL in order to start a new array.
1079			* @param nb_sd pointer to an integer containing the number of entries in
1080			* the array.
1081			* @param type type of the added side data
1082			* @param buf Pointer to AVBufferRef to add to the array. On success,
1083			* the function takes ownership of the AVBufferRef and *buf is
1084			* set to NULL, unless AV_FRAME_SIDE_DATA_FLAG_NEW_REF is set
1085			* in which case the ownership will remain with the caller.
1086			* @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1087			*
1088			* @return newly added side data on success, NULL on error.
1089			* @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1090			* matching AVFrameSideDataType will be removed before the addition
1091			* is attempted.
1092			* @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1093			* entry of the same type already exists, it will be replaced instead.
1094			*
1095			*/
1096			AVFrameSideData *av_frame_side_data_add(AVFrameSideData ***sd, int *nb_sd,
1097			enum AVFrameSideDataType type,
1098			AVBufferRef **buf, unsigned int flags);
1099
1100			/**
1101			* Add a new side data entry to an array based on existing side data, taking
1102			* a reference towards the contained AVBufferRef.
1103			*
1104			* @param sd pointer to array of side data to which to add another entry,
1105			* or to NULL in order to start a new array.
1106			* @param nb_sd pointer to an integer containing the number of entries in
1107			* the array.
1108			* @param src side data to be cloned, with a new reference utilized
1109			* for the buffer.
1110			* @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1111			*
1112			* @return negative error code on failure, >=0 on success.
1113			* @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1114			* matching AVFrameSideDataType will be removed before the addition
1115			* is attempted.
1116			* @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1117			* entry of the same type already exists, it will be replaced instead.
1118			*/
1119			int av_frame_side_data_clone(AVFrameSideData ***sd, int *nb_sd,
1120			const AVFrameSideData *src, unsigned int flags);
1121
1122			/**
1123			* Get a side data entry of a specific type from an array.
1124			*
1125			* @param sd array of side data.
1126			* @param nb_sd integer containing the number of entries in the array.
1127			* @param type type of side data to be queried
1128			*
1129			* @return a pointer to the side data of a given type on success, NULL if there
1130			* is no side data with such type in this set.
1131			*/
1132			const AVFrameSideData *av_frame_side_data_get_c(const AVFrameSideData * const *sd,
1133			const int nb_sd,
1134			enum AVFrameSideDataType type);
1135
1136			/**
1137			* Wrapper around av_frame_side_data_get_c() to workaround the limitation
1138			* that for any type T the conversion from T * const * to const T * const *
1139			* is not performed automatically in C.
1140			* @see av_frame_side_data_get_c()
1141			*/
1142			static inline
1143		1123046	const AVFrameSideData *av_frame_side_data_get(AVFrameSideData * const *sd,
1144			const int nb_sd,
1145			enum AVFrameSideDataType type)
1146			{
1147		1123046	return av_frame_side_data_get_c((const AVFrameSideData * const *)sd,
1148			nb_sd, type);
1149			}
1150
1151			/**
1152			* Remove and free all side data instances of the given type from an array.
1153			*/
1154			void av_frame_side_data_remove(AVFrameSideData ***sd, int *nb_sd,
1155			enum AVFrameSideDataType type);
1156			/**
1157			* @}
1158			*/
1159
1160			#endif /* AVUTIL_FRAME_H */
1161