FFmpeg coverage

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