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