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