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