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