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