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			* Raw LCEVC payload data, as a uint8_t array, with NAL emulation
234			* bytes intact.
235			*/
236			AV_FRAME_DATA_LCEVC,
237
238			/**
239			* This side data must be associated with a video frame.
240			* The presence of this side data indicates that the video stream is
241			* composed of multiple views (e.g. stereoscopic 3D content,
242			* cf. H.264 Annex H or H.265 Annex G).
243			* The data is an int storing the view ID.
244			*/
245			AV_FRAME_DATA_VIEW_ID,
246			};
247
248			enum AVActiveFormatDescription {
249			AV_AFD_SAME = 8,
250			AV_AFD_4_3 = 9,
251			AV_AFD_16_9 = 10,
252			AV_AFD_14_9 = 11,
253			AV_AFD_4_3_SP_14_9 = 13,
254			AV_AFD_16_9_SP_14_9 = 14,
255			AV_AFD_SP_4_3 = 15,
256			};
257
258
259			/**
260			* Structure to hold side data for an AVFrame.
261			*
262			* sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
263			* to the end with a minor bump.
264			*/
265			typedef struct AVFrameSideData {
266			enum AVFrameSideDataType type;
267			uint8_t *data;
268			size_t size;
269			AVDictionary *metadata;
270			AVBufferRef *buf;
271			} AVFrameSideData;
272
273			enum AVSideDataProps {
274			/**
275			* The side data type can be used in stream-global structures.
276			* Side data types without this property are only meaningful on per-frame
277			* basis.
278			*/
279			AV_SIDE_DATA_PROP_GLOBAL = (1 << 0),
280
281			/**
282			* Multiple instances of this side data type can be meaningfully present in
283			* a single side data array.
284			*/
285			AV_SIDE_DATA_PROP_MULTI = (1 << 1),
286
287			/**
288			* Side data depends on the video dimensions. Side data with this property
289			* loses its meaning when rescaling or cropping the image, unless
290			* either recomputed or adjusted to the new resolution.
291			*/
292			AV_SIDE_DATA_PROP_SIZE_DEPENDENT = (1 << 2),
293
294			/**
295			* Side data depends on the video color space. Side data with this property
296			* loses its meaning when changing the video color encoding, e.g. by
297			* adapting to a different set of primaries or transfer characteristics.
298			*/
299			AV_SIDE_DATA_PROP_COLOR_DEPENDENT = (1 << 3),
300			};
301
302			/**
303			* This struct describes the properties of a side data type. Its instance
304			* corresponding to a given type can be obtained from av_frame_side_data_desc().
305			*/
306			typedef struct AVSideDataDescriptor {
307			/**
308			* Human-readable side data description.
309			*/
310			const char *name;
311
312			/**
313			* Side data property flags, a combination of AVSideDataProps values.
314			*/
315			unsigned props;
316			} AVSideDataDescriptor;
317
318			/**
319			* Structure describing a single Region Of Interest.
320			*
321			* When multiple regions are defined in a single side-data block, they
322			* should be ordered from most to least important - some encoders are only
323			* capable of supporting a limited number of distinct regions, so will have
324			* to truncate the list.
325			*
326			* When overlapping regions are defined, the first region containing a given
327			* area of the frame applies.
328			*/
329			typedef struct AVRegionOfInterest {
330			/**
331			* Must be set to the size of this data structure (that is,
332			* sizeof(AVRegionOfInterest)).
333			*/
334			uint32_t self_size;
335			/**
336			* Distance in pixels from the top edge of the frame to the top and
337			* bottom edges and from the left edge of the frame to the left and
338			* right edges of the rectangle defining this region of interest.
339			*
340			* The constraints on a region are encoder dependent, so the region
341			* actually affected may be slightly larger for alignment or other
342			* reasons.
343			*/
344			int top;
345			int bottom;
346			int left;
347			int right;
348			/**
349			* Quantisation offset.
350			*
351			* Must be in the range -1 to +1. A value of zero indicates no quality
352			* change. A negative value asks for better quality (less quantisation),
353			* while a positive value asks for worse quality (greater quantisation).
354			*
355			* The range is calibrated so that the extreme values indicate the
356			* largest possible offset - if the rest of the frame is encoded with the
357			* worst possible quality, an offset of -1 indicates that this region
358			* should be encoded with the best possible quality anyway. Intermediate
359			* values are then interpolated in some codec-dependent way.
360			*
361			* For example, in 10-bit H.264 the quantisation parameter varies between
362			* -12 and 51. A typical qoffset value of -1/10 therefore indicates that
363			* this region should be encoded with a QP around one-tenth of the full
364			* range better than the rest of the frame. So, if most of the frame
365			* were to be encoded with a QP of around 30, this region would get a QP
366			* of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
367			* An extreme value of -1 would indicate that this region should be
368			* encoded with the best possible quality regardless of the treatment of
369			* the rest of the frame - that is, should be encoded at a QP of -12.
370			*/
371			AVRational qoffset;
372			} AVRegionOfInterest;
373
374			/**
375			* This structure describes decoded (raw) audio or video data.
376			*
377			* AVFrame must be allocated using av_frame_alloc(). Note that this only
378			* allocates the AVFrame itself, the buffers for the data must be managed
379			* through other means (see below).
380			* AVFrame must be freed with av_frame_free().
381			*
382			* AVFrame is typically allocated once and then reused multiple times to hold
383			* different data (e.g. a single AVFrame to hold frames received from a
384			* decoder). In such a case, av_frame_unref() will free any references held by
385			* the frame and reset it to its original clean state before it
386			* is reused again.
387			*
388			* The data described by an AVFrame is usually reference counted through the
389			* AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
390			* AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
391			* least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
392			* every single data plane must be contained in one of the buffers in
393			* AVFrame.buf or AVFrame.extended_buf.
394			* There may be a single buffer for all the data, or one separate buffer for
395			* each plane, or anything in between.
396			*
397			* sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
398			* to the end with a minor bump.
399			*
400			* Fields can be accessed through AVOptions, the name string used, matches the
401			* C structure field name for fields accessible through AVOptions.
402			*/
403			typedef struct AVFrame {
404			#define AV_NUM_DATA_POINTERS 8
405			/**
406			* pointer to the picture/channel planes.
407			* This might be different from the first allocated byte. For video,
408			* it could even point to the end of the image data.
409			*
410			* All pointers in data and extended_data must point into one of the
411			* AVBufferRef in buf or extended_buf.
412			*
413			* Some decoders access areas outside 0,0 - width,height, please
414			* see avcodec_align_dimensions2(). Some filters and swscale can read
415			* up to 16 bytes beyond the planes, if these filters are to be used,
416			* then 16 extra bytes must be allocated.
417			*
418			* NOTE: Pointers not needed by the format MUST be set to NULL.
419			*
420			* @attention In case of video, the data[] pointers can point to the
421			* end of image data in order to reverse line order, when used in
422			* combination with negative values in the linesize[] array.
423			*/
424			uint8_t *data[AV_NUM_DATA_POINTERS];
425
426			/**
427			* For video, a positive or negative value, which is typically indicating
428			* the size in bytes of each picture line, but it can also be:
429			* - the negative byte size of lines for vertical flipping
430			* (with data[n] pointing to the end of the data
431			* - a positive or negative multiple of the byte size as for accessing
432			* even and odd fields of a frame (possibly flipped)
433			*
434			* For audio, only linesize[0] may be set. For planar audio, each channel
435			* plane must be the same size.
436			*
437			* For video the linesizes should be multiples of the CPUs alignment
438			* preference, this is 16 or 32 for modern desktop CPUs.
439			* Some code requires such alignment other code can be slower without
440			* correct alignment, for yet other it makes no difference.
441			*
442			* @note The linesize may be larger than the size of usable data -- there
443			* may be extra padding present for performance reasons.
444			*
445			* @attention In case of video, line size values can be negative to achieve
446			* a vertically inverted iteration over image lines.
447			*/
448			int linesize[AV_NUM_DATA_POINTERS];
449
450			/**
451			* pointers to the data planes/channels.
452			*
453			* For video, this should simply point to data[].
454			*
455			* For planar audio, each channel has a separate data pointer, and
456			* linesize[0] contains the size of each channel buffer.
457			* For packed audio, there is just one data pointer, and linesize[0]
458			* contains the total size of the buffer for all channels.
459			*
460			* Note: Both data and extended_data should always be set in a valid frame,
461			* but for planar audio with more channels that can fit in data,
462			* extended_data must be used in order to access all channels.
463			*/
464			uint8_t **extended_data;
465
466			/**
467			* @name Video dimensions
468			* Video frames only. The coded dimensions (in pixels) of the video frame,
469			* i.e. the size of the rectangle that contains some well-defined values.
470			*
471			* @note The part of the frame intended for display/presentation is further
472			* restricted by the @ref cropping "Cropping rectangle".
473			* @{
474			*/
475			int width, height;
476			/**
477			* @}
478			*/
479
480			/**
481			* number of audio samples (per channel) described by this frame
482			*/
483			int nb_samples;
484
485			/**
486			* format of the frame, -1 if unknown or unset
487			* Values correspond to enum AVPixelFormat for video frames,
488			* enum AVSampleFormat for audio)
489			*/
490			int format;
491
492			#if FF_API_FRAME_KEY
493			/**
494			* 1 -> keyframe, 0-> not
495			*
496			* @deprecated Use AV_FRAME_FLAG_KEY instead
497			*/
498			attribute_deprecated
499			int key_frame;
500			#endif
501
502			/**
503			* Picture type of the frame.
504			*/
505			enum AVPictureType pict_type;
506
507			/**
508			* Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
509			*/
510			AVRational sample_aspect_ratio;
511
512			/**
513			* Presentation timestamp in time_base units (time when frame should be shown to user).
514			*/
515			int64_t pts;
516
517			/**
518			* DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
519			* This is also the Presentation time of this AVFrame calculated from
520			* only AVPacket.dts values without pts values.
521			*/
522			int64_t pkt_dts;
523
524			/**
525			* Time base for the timestamps in this frame.
526			* In the future, this field may be set on frames output by decoders or
527			* filters, but its value will be by default ignored on input to encoders
528			* or filters.
529			*/
530			AVRational time_base;
531
532			/**
533			* quality (between 1 (good) and FF_LAMBDA_MAX (bad))
534			*/
535			int quality;
536
537			/**
538			* Frame owner's private data.
539			*
540			* This field may be set by the code that allocates/owns the frame data.
541			* It is then not touched by any library functions, except:
542			* - it is copied to other references by av_frame_copy_props() (and hence by
543			* av_frame_ref());
544			* - it is set to NULL when the frame is cleared by av_frame_unref()
545			* - on the caller's explicit request. E.g. libavcodec encoders/decoders
546			* will copy this field to/from @ref AVPacket "AVPackets" if the caller sets
547			* @ref AV_CODEC_FLAG_COPY_OPAQUE.
548			*
549			* @see opaque_ref the reference-counted analogue
550			*/
551			void *opaque;
552
553			/**
554			* Number of fields in this frame which should be repeated, i.e. the total
555			* duration of this frame should be repeat_pict + 2 normal field durations.
556			*
557			* For interlaced frames this field may be set to 1, which signals that this
558			* frame should be presented as 3 fields: beginning with the first field (as
559			* determined by AV_FRAME_FLAG_TOP_FIELD_FIRST being set or not), followed
560			* by the second field, and then the first field again.
561			*
562			* For progressive frames this field may be set to a multiple of 2, which
563			* signals that this frame's duration should be (repeat_pict + 2) / 2
564			* normal frame durations.
565			*
566			* @note This field is computed from MPEG2 repeat_first_field flag and its
567			* associated flags, H.264 pic_struct from picture timing SEI, and
568			* their analogues in other codecs. Typically it should only be used when
569			* higher-layer timing information is not available.
570			*/
571			int repeat_pict;
572
573			#if FF_API_INTERLACED_FRAME
574			/**
575			* The content of the picture is interlaced.
576			*
577			* @deprecated Use AV_FRAME_FLAG_INTERLACED instead
578			*/
579			attribute_deprecated
580			int interlaced_frame;
581
582			/**
583			* If the content is interlaced, is top field displayed first.
584			*
585			* @deprecated Use AV_FRAME_FLAG_TOP_FIELD_FIRST instead
586			*/
587			attribute_deprecated
588			int top_field_first;
589			#endif
590
591			#if FF_API_PALETTE_HAS_CHANGED
592			/**
593			* Tell user application that palette has changed from previous frame.
594			*/
595			attribute_deprecated
596			int palette_has_changed;
597			#endif
598
599			/**
600			* Sample rate of the audio data.
601			*/
602			int sample_rate;
603
604			/**
605			* AVBuffer references backing the data for this frame. All the pointers in
606			* data and extended_data must point inside one of the buffers in buf or
607			* extended_buf. This array must be filled contiguously -- if buf[i] is
608			* non-NULL then buf[j] must also be non-NULL for all j < i.
609			*
610			* There may be at most one AVBuffer per data plane, so for video this array
611			* always contains all the references. For planar audio with more than
612			* AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
613			* this array. Then the extra AVBufferRef pointers are stored in the
614			* extended_buf array.
615			*/
616			AVBufferRef *buf[AV_NUM_DATA_POINTERS];
617
618			/**
619			* For planar audio which requires more than AV_NUM_DATA_POINTERS
620			* AVBufferRef pointers, this array will hold all the references which
621			* cannot fit into AVFrame.buf.
622			*
623			* Note that this is different from AVFrame.extended_data, which always
624			* contains all the pointers. This array only contains the extra pointers,
625			* which cannot fit into AVFrame.buf.
626			*
627			* This array is always allocated using av_malloc() by whoever constructs
628			* the frame. It is freed in av_frame_unref().
629			*/
630			AVBufferRef **extended_buf;
631			/**
632			* Number of elements in extended_buf.
633			*/
634			int nb_extended_buf;
635
636			AVFrameSideData **side_data;
637			int nb_side_data;
638
639			/**
640			* @defgroup lavu_frame_flags AV_FRAME_FLAGS
641			* @ingroup lavu_frame
642			* Flags describing additional frame properties.
643			*
644			* @{
645			*/
646
647			/**
648			* The frame data may be corrupted, e.g. due to decoding errors.
649			*/
650			#define AV_FRAME_FLAG_CORRUPT (1 << 0)
651			/**
652			* A flag to mark frames that are keyframes.
653			*/
654			#define AV_FRAME_FLAG_KEY (1 << 1)
655			/**
656			* A flag to mark the frames which need to be decoded, but shouldn't be output.
657			*/
658			#define AV_FRAME_FLAG_DISCARD (1 << 2)
659			/**
660			* A flag to mark frames whose content is interlaced.
661			*/
662			#define AV_FRAME_FLAG_INTERLACED (1 << 3)
663			/**
664			* A flag to mark frames where the top field is displayed first if the content
665			* is interlaced.
666			*/
667			#define AV_FRAME_FLAG_TOP_FIELD_FIRST (1 << 4)
668			/**
669			* A decoder can use this flag to mark frames which were originally encoded losslessly.
670			*
671			* For coding bitstream formats which support both lossless and lossy
672			* encoding, it is sometimes possible for a decoder to determine which method
673			* was used when the bitsream was encoded.
674			*/
675			#define AV_FRAME_FLAG_LOSSLESS (1 << 5)
676			/**
677			* @}
678			*/
679
680			/**
681			* Frame flags, a combination of @ref lavu_frame_flags
682			*/
683			int flags;
684
685			/**
686			* MPEG vs JPEG YUV range.
687			* - encoding: Set by user
688			* - decoding: Set by libavcodec
689			*/
690			enum AVColorRange color_range;
691
692			enum AVColorPrimaries color_primaries;
693
694			enum AVColorTransferCharacteristic color_trc;
695
696			/**
697			* YUV colorspace type.
698			* - encoding: Set by user
699			* - decoding: Set by libavcodec
700			*/
701			enum AVColorSpace colorspace;
702
703			enum AVChromaLocation chroma_location;
704
705			/**
706			* frame timestamp estimated using various heuristics, in stream time base
707			* - encoding: unused
708			* - decoding: set by libavcodec, read by user.
709			*/
710			int64_t best_effort_timestamp;
711
712			#if FF_API_FRAME_PKT
713			/**
714			* reordered pos from the last AVPacket that has been input into the decoder
715			* - encoding: unused
716			* - decoding: Read by user.
717			* @deprecated use AV_CODEC_FLAG_COPY_OPAQUE to pass through arbitrary user
718			* data from packets to frames
719			*/
720			attribute_deprecated
721			int64_t pkt_pos;
722			#endif
723
724			/**
725			* metadata.
726			* - encoding: Set by user.
727			* - decoding: Set by libavcodec.
728			*/
729			AVDictionary *metadata;
730
731			/**
732			* decode error flags of the frame, set to a combination of
733			* FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
734			* were errors during the decoding.
735			* - encoding: unused
736			* - decoding: set by libavcodec, read by user.
737			*/
738			int decode_error_flags;
739			#define FF_DECODE_ERROR_INVALID_BITSTREAM 1
740			#define FF_DECODE_ERROR_MISSING_REFERENCE 2
741			#define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
742			#define FF_DECODE_ERROR_DECODE_SLICES 8
743
744			#if FF_API_FRAME_PKT
745			/**
746			* size of the corresponding packet containing the compressed
747			* frame.
748			* It is set to a negative value if unknown.
749			* - encoding: unused
750			* - decoding: set by libavcodec, read by user.
751			* @deprecated use AV_CODEC_FLAG_COPY_OPAQUE to pass through arbitrary user
752			* data from packets to frames
753			*/
754			attribute_deprecated
755			int pkt_size;
756			#endif
757
758			/**
759			* For hwaccel-format frames, this should be a reference to the
760			* AVHWFramesContext describing the frame.
761			*/
762			AVBufferRef *hw_frames_ctx;
763
764			/**
765			* Frame owner's private data.
766			*
767			* This field may be set by the code that allocates/owns the frame data.
768			* It is then not touched by any library functions, except:
769			* - a new reference to the underlying buffer is propagated by
770			* av_frame_copy_props() (and hence by av_frame_ref());
771			* - it is unreferenced in av_frame_unref();
772			* - on the caller's explicit request. E.g. libavcodec encoders/decoders
773			* will propagate a new reference to/from @ref AVPacket "AVPackets" if the
774			* caller sets @ref AV_CODEC_FLAG_COPY_OPAQUE.
775			*
776			* @see opaque the plain pointer analogue
777			*/
778			AVBufferRef *opaque_ref;
779
780			/**
781			* @anchor cropping
782			* @name Cropping
783			* Video frames only. The number of pixels to discard from the the
784			* top/bottom/left/right border of the frame to obtain the sub-rectangle of
785			* the frame intended for presentation.
786			* @{
787			*/
788			size_t crop_top;
789			size_t crop_bottom;
790			size_t crop_left;
791			size_t crop_right;
792			/**
793			* @}
794			*/
795
796			/**
797			* AVBufferRef for internal use by a single libav* library.
798			* Must not be used to transfer data between libraries.
799			* Has to be NULL when ownership of the frame leaves the respective library.
800			*
801			* Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
802			*
803			* FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
804			* av_frame_copy_props() calls create a new reference with av_buffer_ref()
805			* for the target frame's private_ref field.
806			*/
807			AVBufferRef *private_ref;
808
809			/**
810			* Channel layout of the audio data.
811			*/
812			AVChannelLayout ch_layout;
813
814			/**
815			* Duration of the frame, in the same units as pts. 0 if unknown.
816			*/
817			int64_t duration;
818			} AVFrame;
819
820
821			/**
822			* Allocate an AVFrame and set its fields to default values. The resulting
823			* struct must be freed using av_frame_free().
824			*
825			* @return An AVFrame filled with default values or NULL on failure.
826			*
827			* @note this only allocates the AVFrame itself, not the data buffers. Those
828			* must be allocated through other means, e.g. with av_frame_get_buffer() or
829			* manually.
830			*/
831			AVFrame *av_frame_alloc(void);
832
833			/**
834			* Free the frame and any dynamically allocated objects in it,
835			* e.g. extended_data. If the frame is reference counted, it will be
836			* unreferenced first.
837			*
838			* @param frame frame to be freed. The pointer will be set to NULL.
839			*/
840			void av_frame_free(AVFrame **frame);
841
842			/**
843			* Set up a new reference to the data described by the source frame.
844			*
845			* Copy frame properties from src to dst and create a new reference for each
846			* AVBufferRef from src.
847			*
848			* If src is not reference counted, new buffers are allocated and the data is
849			* copied.
850			*
851			* @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
852			* or newly allocated with av_frame_alloc() before calling this
853			* function, or undefined behavior will occur.
854			*
855			* @return 0 on success, a negative AVERROR on error
856			*/
857			int av_frame_ref(AVFrame *dst, const AVFrame *src);
858
859			/**
860			* Ensure the destination frame refers to the same data described by the source
861			* frame, either by creating a new reference for each AVBufferRef from src if
862			* they differ from those in dst, by allocating new buffers and copying data if
863			* src is not reference counted, or by unrefencing it if src is empty.
864			*
865			* Frame properties on dst will be replaced by those from src.
866			*
867			* @return 0 on success, a negative AVERROR on error. On error, dst is
868			* unreferenced.
869			*/
870			int av_frame_replace(AVFrame *dst, const AVFrame *src);
871
872			/**
873			* Create a new frame that references the same data as src.
874			*
875			* This is a shortcut for av_frame_alloc()+av_frame_ref().
876			*
877			* @return newly created AVFrame on success, NULL on error.
878			*/
879			AVFrame *av_frame_clone(const AVFrame *src);
880
881			/**
882			* Unreference all the buffers referenced by frame and reset the frame fields.
883			*/
884			void av_frame_unref(AVFrame *frame);
885
886			/**
887			* Move everything contained in src to dst and reset src.
888			*
889			* @warning: dst is not unreferenced, but directly overwritten without reading
890			* or deallocating its contents. Call av_frame_unref(dst) manually
891			* before calling this function to ensure that no memory is leaked.
892			*/
893			void av_frame_move_ref(AVFrame *dst, AVFrame *src);
894
895			/**
896			* Allocate new buffer(s) for audio or video data.
897			*
898			* The following fields must be set on frame before calling this function:
899			* - format (pixel format for video, sample format for audio)
900			* - width and height for video
901			* - nb_samples and ch_layout for audio
902			*
903			* This function will fill AVFrame.data and AVFrame.buf arrays and, if
904			* necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
905			* For planar formats, one buffer will be allocated for each plane.
906			*
907			* @warning: if frame already has been allocated, calling this function will
908			* leak memory. In addition, undefined behavior can occur in certain
909			* cases.
910			*
911			* @param frame frame in which to store the new buffers.
912			* @param align Required buffer size and data pointer alignment. If equal to 0,
913			* alignment will be chosen automatically for the current CPU.
914			* It is highly recommended to pass 0 here unless you know what
915			* you are doing.
916			*
917			* @return 0 on success, a negative AVERROR on error.
918			*/
919			int av_frame_get_buffer(AVFrame *frame, int align);
920
921			/**
922			* Check if the frame data is writable.
923			*
924			* @return A positive value if the frame data is writable (which is true if and
925			* only if each of the underlying buffers has only one reference, namely the one
926			* stored in this frame). Return 0 otherwise.
927			*
928			* If 1 is returned the answer is valid until av_buffer_ref() is called on any
929			* of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
930			*
931			* @see av_frame_make_writable(), av_buffer_is_writable()
932			*/
933			int av_frame_is_writable(AVFrame *frame);
934
935			/**
936			* Ensure that the frame data is writable, avoiding data copy if possible.
937			*
938			* Do nothing if the frame is writable, allocate new buffers and copy the data
939			* if it is not. Non-refcounted frames behave as non-writable, i.e. a copy
940			* is always made.
941			*
942			* @return 0 on success, a negative AVERROR on error.
943			*
944			* @see av_frame_is_writable(), av_buffer_is_writable(),
945			* av_buffer_make_writable()
946			*/
947			int av_frame_make_writable(AVFrame *frame);
948
949			/**
950			* Copy the frame data from src to dst.
951			*
952			* This function does not allocate anything, dst must be already initialized and
953			* allocated with the same parameters as src.
954			*
955			* This function only copies the frame data (i.e. the contents of the data /
956			* extended data arrays), not any other properties.
957			*
958			* @return >= 0 on success, a negative AVERROR on error.
959			*/
960			int av_frame_copy(AVFrame *dst, const AVFrame *src);
961
962			/**
963			* Copy only "metadata" fields from src to dst.
964			*
965			* Metadata for the purpose of this function are those fields that do not affect
966			* the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
967			* aspect ratio (for video), but not width/height or channel layout.
968			* Side data is also copied.
969			*/
970			int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
971
972			/**
973			* Get the buffer reference a given data plane is stored in.
974			*
975			* @param frame the frame to get the plane's buffer from
976			* @param plane index of the data plane of interest in frame->extended_data.
977			*
978			* @return the buffer reference that contains the plane or NULL if the input
979			* frame is not valid.
980			*/
981			AVBufferRef *av_frame_get_plane_buffer(const AVFrame *frame, int plane);
982
983			/**
984			* Add a new side data to a frame.
985			*
986			* @param frame a frame to which the side data should be added
987			* @param type type of the added side data
988			* @param size size of the side data
989			*
990			* @return newly added side data on success, NULL on error
991			*/
992			AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
993			enum AVFrameSideDataType type,
994			size_t size);
995
996			/**
997			* Add a new side data to a frame from an existing AVBufferRef
998			*
999			* @param frame a frame to which the side data should be added
1000			* @param type the type of the added side data
1001			* @param buf an AVBufferRef to add as side data. The ownership of
1002			* the reference is transferred to the frame.
1003			*
1004			* @return newly added side data on success, NULL on error. On failure
1005			* the frame is unchanged and the AVBufferRef remains owned by
1006			* the caller.
1007			*/
1008			AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame,
1009			enum AVFrameSideDataType type,
1010			AVBufferRef *buf);
1011
1012			/**
1013			* @return a pointer to the side data of a given type on success, NULL if there
1014			* is no side data with such type in this frame.
1015			*/
1016			AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
1017			enum AVFrameSideDataType type);
1018
1019			/**
1020			* Remove and free all side data instances of the given type.
1021			*/
1022			void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
1023
1024
1025			/**
1026			* Flags for frame cropping.
1027			*/
1028			enum {
1029			/**
1030			* Apply the maximum possible cropping, even if it requires setting the
1031			* AVFrame.data[] entries to unaligned pointers. Passing unaligned data
1032			* to FFmpeg API is generally not allowed, and causes undefined behavior
1033			* (such as crashes). You can pass unaligned data only to FFmpeg APIs that
1034			* are explicitly documented to accept it. Use this flag only if you
1035			* absolutely know what you are doing.
1036			*/
1037			AV_FRAME_CROP_UNALIGNED = 1 << 0,
1038			};
1039
1040			/**
1041			* Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
1042			* crop_bottom fields. If cropping is successful, the function will adjust the
1043			* data pointers and the width/height fields, and set the crop fields to 0.
1044			*
1045			* In all cases, the cropping boundaries will be rounded to the inherent
1046			* alignment of the pixel format. In some cases, such as for opaque hwaccel
1047			* formats, the left/top cropping is ignored. The crop fields are set to 0 even
1048			* if the cropping was rounded or ignored.
1049			*
1050			* @param frame the frame which should be cropped
1051			* @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
1052			*
1053			* @return >= 0 on success, a negative AVERROR on error. If the cropping fields
1054			* were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
1055			*/
1056			int av_frame_apply_cropping(AVFrame *frame, int flags);
1057
1058			/**
1059			* @return a string identifying the side data type
1060			*/
1061			const char *av_frame_side_data_name(enum AVFrameSideDataType type);
1062
1063			/**
1064			* @return side data descriptor corresponding to a given side data type, NULL
1065			* when not available.
1066			*/
1067			const AVSideDataDescriptor *av_frame_side_data_desc(enum AVFrameSideDataType type);
1068
1069			/**
1070			* Free all side data entries and their contents, then zeroes out the
1071			* values which the pointers are pointing to.
1072			*
1073			* @param sd pointer to array of side data to free. Will be set to NULL
1074			* upon return.
1075			* @param nb_sd pointer to an integer containing the number of entries in
1076			* the array. Will be set to 0 upon return.
1077			*/
1078			void av_frame_side_data_free(AVFrameSideData ***sd, int *nb_sd);
1079
1080			/**
1081			* Remove existing entries before adding new ones.
1082			*/
1083			#define AV_FRAME_SIDE_DATA_FLAG_UNIQUE (1 << 0)
1084			/**
1085			* Don't add a new entry if another of the same type exists.
1086			* Applies only for side data types without the AV_SIDE_DATA_PROP_MULTI prop.
1087			*/
1088			#define AV_FRAME_SIDE_DATA_FLAG_REPLACE (1 << 1)
1089			/**
1090			* Create a new reference to the passed in buffer instead of taking ownership
1091			* of it.
1092			*/
1093			#define AV_FRAME_SIDE_DATA_FLAG_NEW_REF (1 << 2)
1094
1095			/**
1096			* Add new side data entry to an array.
1097			*
1098			* @param sd pointer to array of side data to which to add another entry,
1099			* or to NULL in order to start a new array.
1100			* @param nb_sd pointer to an integer containing the number of entries in
1101			* the array.
1102			* @param type type of the added side data
1103			* @param size size of the side data
1104			* @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1105			*
1106			* @return newly added side data on success, NULL on error.
1107			* @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1108			* matching AVFrameSideDataType will be removed before the addition
1109			* is attempted.
1110			* @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1111			* entry of the same type already exists, it will be replaced instead.
1112			*/
1113			AVFrameSideData *av_frame_side_data_new(AVFrameSideData ***sd, int *nb_sd,
1114			enum AVFrameSideDataType type,
1115			size_t size, unsigned int flags);
1116
1117			/**
1118			* Add a new side data entry to an array from an existing AVBufferRef.
1119			*
1120			* @param sd pointer to array of side data to which to add another entry,
1121			* or to NULL in order to start a new array.
1122			* @param nb_sd pointer to an integer containing the number of entries in
1123			* the array.
1124			* @param type type of the added side data
1125			* @param buf Pointer to AVBufferRef to add to the array. On success,
1126			* the function takes ownership of the AVBufferRef and *buf is
1127			* set to NULL, unless AV_FRAME_SIDE_DATA_FLAG_NEW_REF is set
1128			* in which case the ownership will remain with the caller.
1129			* @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1130			*
1131			* @return newly added side data on success, NULL on error.
1132			* @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1133			* matching AVFrameSideDataType will be removed before the addition
1134			* is attempted.
1135			* @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1136			* entry of the same type already exists, it will be replaced instead.
1137			*
1138			*/
1139			AVFrameSideData *av_frame_side_data_add(AVFrameSideData ***sd, int *nb_sd,
1140			enum AVFrameSideDataType type,
1141			AVBufferRef **buf, unsigned int flags);
1142
1143			/**
1144			* Add a new side data entry to an array based on existing side data, taking
1145			* a reference towards the contained AVBufferRef.
1146			*
1147			* @param sd pointer to array of side data to which to add another entry,
1148			* or to NULL in order to start a new array.
1149			* @param nb_sd pointer to an integer containing the number of entries in
1150			* the array.
1151			* @param src side data to be cloned, with a new reference utilized
1152			* for the buffer.
1153			* @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1154			*
1155			* @return negative error code on failure, >=0 on success.
1156			* @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1157			* matching AVFrameSideDataType will be removed before the addition
1158			* is attempted.
1159			* @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1160			* entry of the same type already exists, it will be replaced instead.
1161			*/
1162			int av_frame_side_data_clone(AVFrameSideData ***sd, int *nb_sd,
1163			const AVFrameSideData *src, unsigned int flags);
1164
1165			/**
1166			* Get a side data entry of a specific type from an array.
1167			*
1168			* @param sd array of side data.
1169			* @param nb_sd integer containing the number of entries in the array.
1170			* @param type type of side data to be queried
1171			*
1172			* @return a pointer to the side data of a given type on success, NULL if there
1173			* is no side data with such type in this set.
1174			*/
1175			const AVFrameSideData *av_frame_side_data_get_c(const AVFrameSideData * const *sd,
1176			const int nb_sd,
1177			enum AVFrameSideDataType type);
1178
1179			/**
1180			* Wrapper around av_frame_side_data_get_c() to workaround the limitation
1181			* that for any type T the conversion from T * const * to const T * const *
1182			* is not performed automatically in C.
1183			* @see av_frame_side_data_get_c()
1184			*/
1185			static inline
1186		1848318	const AVFrameSideData *av_frame_side_data_get(AVFrameSideData * const *sd,
1187			const int nb_sd,
1188			enum AVFrameSideDataType type)
1189			{
1190		1848318	return av_frame_side_data_get_c((const AVFrameSideData * const *)sd,
1191			nb_sd, type);
1192			}
1193
1194			/**
1195			* Remove and free all side data instances of the given type from an array.
1196			*/
1197			void av_frame_side_data_remove(AVFrameSideData ***sd, int *nb_sd,
1198			enum AVFrameSideDataType type);
1199
1200			/**
1201			* Remove and free all side data instances that match any of the given
1202			* side data properties. (See enum AVSideDataProps)
1203			*/
1204			void av_frame_side_data_remove_by_props(AVFrameSideData ***sd, int *nb_sd,
1205			int props);
1206
1207			/**
1208			* @}
1209			*/
1210
1211			#endif /* AVUTIL_FRAME_H */
1212