FFmpeg
frame.h
Go to the documentation of this file.
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 
50  /**
51  * The data is the AVPanScan struct defined in libavcodec.
52  */
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  */
60  /**
61  * Stereoscopic 3d metadata.
62  * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
63  */
65  /**
66  * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
67  */
69  /**
70  * Metadata relevant to a downmix procedure.
71  * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
72  */
74  /**
75  * ReplayGain information in the form of the AVReplayGain struct.
76  */
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  */
86  /**
87  * Active Format Description data consisting of a single byte as specified
88  * in ETSI TS 101 154 using AVActiveFormatDescription enum.
89  */
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  */
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  */
110  /**
111  * This side data must be associated with an audio frame and corresponds to
112  * enum AVAudioServiceType defined in avcodec.h.
113  */
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  */
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  */
126 
127  /**
128  * The data represents the AVSphericalMapping structure defined in
129  * libavutil/spherical.h.
130  */
132 
133  /**
134  * Content light level (based on CTA-861.3). This payload contains data in
135  * the form of the AVContentLightMetadata struct.
136  */
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  */
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  */
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  */
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  */
166 
167  /**
168  * Encoding parameters for a video frame, as described by AVVideoEncParams.
169  */
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  */
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  */
189 
190  /**
191  * Bounding boxes for object detection and classification,
192  * as described by AVDetectionBBoxHeader.
193  */
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  */
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  */
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  */
216 
217  /**
218  * Ambient viewing environment metadata, as defined by H.274.
219  */
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  */
231 
232  /**
233  * Raw LCEVC payload data, as a uint8_t array, with NAL emulation
234  * bytes intact.
235  */
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  */
246 };
247 
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 {
267  uint8_t *data;
268  size_t size;
272 
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  */
280 
281  /**
282  * Multiple instances of this side data type can be meaningfully present in
283  * a single side data array.
284  */
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;
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  */
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  */
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  */
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  */
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  */
486 #endif
487 
488  /**
489  * Picture type of the frame.
490  */
492 
493  /**
494  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
495  */
497 
498  /**
499  * Presentation timestamp in time_base units (time when frame should be shown to user).
500  */
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  */
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  */
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  */
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  */
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  */
575 #endif
576 
577 #if FF_API_PALETTE_HAS_CHANGED
578  /**
579  * Tell user application that palette has changed from previous frame.
580  */
583 #endif
584 
585  /**
586  * Sample rate of the audio data.
587  */
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  */
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  */
617  /**
618  * Number of elements in extended_buf.
619  */
621 
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  */
669 
671 
673 
674  /**
675  * YUV colorspace type.
676  * - encoding: Set by user
677  * - decoding: Set by libavcodec
678  */
680 
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  */
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  */
700 #endif
701 
702  /**
703  * metadata.
704  * - encoding: Set by user.
705  * - decoding: Set by libavcodec.
706  */
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  */
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  */
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  */
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  */
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  */
786 
787  /**
788  * Channel layout of the audio data.
789  */
791 
792  /**
793  * Duration of the frame, in the same units as pts. 0 if unknown.
794  */
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  */
858 
859 /**
860  * Unreference all the buffers referenced by frame and reset the frame fields.
861  */
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  */
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 and data pointer alignment. If equal to 0,
891  * alignment will be chosen automatically for the current CPU.
892  * It is highly recommended to pass 0 here unless you know what
893  * you are doing.
894  *
895  * @return 0 on success, a negative AVERROR on error.
896  */
898 
899 /**
900  * Check if the frame data is writable.
901  *
902  * @return A positive value if the frame data is writable (which is true if and
903  * only if each of the underlying buffers has only one reference, namely the one
904  * stored in this frame). Return 0 otherwise.
905  *
906  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
907  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
908  *
909  * @see av_frame_make_writable(), av_buffer_is_writable()
910  */
912 
913 /**
914  * Ensure that the frame data is writable, avoiding data copy if possible.
915  *
916  * Do nothing if the frame is writable, allocate new buffers and copy the data
917  * if it is not. Non-refcounted frames behave as non-writable, i.e. a copy
918  * is always made.
919  *
920  * @return 0 on success, a negative AVERROR on error.
921  *
922  * @see av_frame_is_writable(), av_buffer_is_writable(),
923  * av_buffer_make_writable()
924  */
926 
927 /**
928  * Copy the frame data from src to dst.
929  *
930  * This function does not allocate anything, dst must be already initialized and
931  * allocated with the same parameters as src.
932  *
933  * This function only copies the frame data (i.e. the contents of the data /
934  * extended data arrays), not any other properties.
935  *
936  * @return >= 0 on success, a negative AVERROR on error.
937  */
938 int av_frame_copy(AVFrame *dst, const AVFrame *src);
939 
940 /**
941  * Copy only "metadata" fields from src to dst.
942  *
943  * Metadata for the purpose of this function are those fields that do not affect
944  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
945  * aspect ratio (for video), but not width/height or channel layout.
946  * Side data is also copied.
947  */
949 
950 /**
951  * Get the buffer reference a given data plane is stored in.
952  *
953  * @param frame the frame to get the plane's buffer from
954  * @param plane index of the data plane of interest in frame->extended_data.
955  *
956  * @return the buffer reference that contains the plane or NULL if the input
957  * frame is not valid.
958  */
960 
961 /**
962  * Add a new side data to a frame.
963  *
964  * @param frame a frame to which the side data should be added
965  * @param type type of the added side data
966  * @param size size of the side data
967  *
968  * @return newly added side data on success, NULL on error
969  */
972  size_t size);
973 
974 /**
975  * Add a new side data to a frame from an existing AVBufferRef
976  *
977  * @param frame a frame to which the side data should be added
978  * @param type the type of the added side data
979  * @param buf an AVBufferRef to add as side data. The ownership of
980  * the reference is transferred to the frame.
981  *
982  * @return newly added side data on success, NULL on error. On failure
983  * the frame is unchanged and the AVBufferRef remains owned by
984  * the caller.
985  */
988  AVBufferRef *buf);
989 
990 /**
991  * @return a pointer to the side data of a given type on success, NULL if there
992  * is no side data with such type in this frame.
993  */
996 
997 /**
998  * Remove and free all side data instances of the given type.
999  */
1001 
1002 
1003 /**
1004  * Flags for frame cropping.
1005  */
1006 enum {
1007  /**
1008  * Apply the maximum possible cropping, even if it requires setting the
1009  * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
1010  * to FFmpeg API is generally not allowed, and causes undefined behavior
1011  * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
1012  * are explicitly documented to accept it. Use this flag only if you
1013  * absolutely know what you are doing.
1014  */
1016 };
1017 
1018 /**
1019  * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
1020  * crop_bottom fields. If cropping is successful, the function will adjust the
1021  * data pointers and the width/height fields, and set the crop fields to 0.
1022  *
1023  * In all cases, the cropping boundaries will be rounded to the inherent
1024  * alignment of the pixel format. In some cases, such as for opaque hwaccel
1025  * formats, the left/top cropping is ignored. The crop fields are set to 0 even
1026  * if the cropping was rounded or ignored.
1027  *
1028  * @param frame the frame which should be cropped
1029  * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
1030  *
1031  * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
1032  * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
1033  */
1035 
1036 /**
1037  * @return a string identifying the side data type
1038  */
1040 
1041 /**
1042  * @return side data descriptor corresponding to a given side data type, NULL
1043  * when not available.
1044  */
1046 
1047 /**
1048  * Free all side data entries and their contents, then zeroes out the
1049  * values which the pointers are pointing to.
1050  *
1051  * @param sd pointer to array of side data to free. Will be set to NULL
1052  * upon return.
1053  * @param nb_sd pointer to an integer containing the number of entries in
1054  * the array. Will be set to 0 upon return.
1055  */
1056 void av_frame_side_data_free(AVFrameSideData ***sd, int *nb_sd);
1057 
1058 /**
1059  * Remove existing entries before adding new ones.
1060  */
1061 #define AV_FRAME_SIDE_DATA_FLAG_UNIQUE (1 << 0)
1062 /**
1063  * Don't add a new entry if another of the same type exists.
1064  * Applies only for side data types without the AV_SIDE_DATA_PROP_MULTI prop.
1065  */
1066 #define AV_FRAME_SIDE_DATA_FLAG_REPLACE (1 << 1)
1067 
1068 /**
1069  * Add new side data entry to an array.
1070  *
1071  * @param sd pointer to array of side data to which to add another entry,
1072  * or to NULL in order to start a new array.
1073  * @param nb_sd pointer to an integer containing the number of entries in
1074  * the array.
1075  * @param type type of the added side data
1076  * @param size size of the side data
1077  * @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1078  *
1079  * @return newly added side data on success, NULL on error.
1080  * @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1081  * matching AVFrameSideDataType will be removed before the addition
1082  * is attempted.
1083  * @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1084  * entry of the same type already exists, it will be replaced instead.
1085  */
1088  size_t size, unsigned int flags);
1089 
1090 /**
1091  * Add a new side data entry to an array from an existing AVBufferRef.
1092  *
1093  * @param sd pointer to array of side data to which to add another entry,
1094  * or to NULL in order to start a new array.
1095  * @param nb_sd pointer to an integer containing the number of entries in
1096  * the array.
1097  * @param type type of the added side data
1098  * @param buf Pointer to AVBufferRef to add to the array. On success,
1099  * the function takes ownership of the AVBufferRef and *buf is
1100  * set to NULL, unless AV_FRAME_SIDE_DATA_FLAG_NEW_REF is set
1101  * in which case the ownership will remain with the caller.
1102  * @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1103  *
1104  * @return newly added side data on success, NULL on error.
1105  * @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1106  * matching AVFrameSideDataType will be removed before the addition
1107  * is attempted.
1108  * @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1109  * entry of the same type already exists, it will be replaced instead.
1110  *
1111  */
1114  AVBufferRef **buf, unsigned int flags);
1115 
1116 /**
1117  * Add a new side data entry to an array based on existing side data, taking
1118  * a reference towards the contained AVBufferRef.
1119  *
1120  * @param sd pointer to array of side data to which to add another entry,
1121  * or to NULL in order to start a new array.
1122  * @param nb_sd pointer to an integer containing the number of entries in
1123  * the array.
1124  * @param src side data to be cloned, with a new reference utilized
1125  * for the buffer.
1126  * @param flags Some combination of AV_FRAME_SIDE_DATA_FLAG_* flags, or 0.
1127  *
1128  * @return negative error code on failure, >=0 on success.
1129  * @note In case of AV_FRAME_SIDE_DATA_FLAG_UNIQUE being set, entries of
1130  * matching AVFrameSideDataType will be removed before the addition
1131  * is attempted.
1132  * @note In case of AV_FRAME_SIDE_DATA_FLAG_REPLACE being set, if an
1133  * entry of the same type already exists, it will be replaced instead.
1134  */
1135 int av_frame_side_data_clone(AVFrameSideData ***sd, int *nb_sd,
1136  const AVFrameSideData *src, unsigned int flags);
1137 
1138 /**
1139  * Get a side data entry of a specific type from an array.
1140  *
1141  * @param sd array of side data.
1142  * @param nb_sd integer containing the number of entries in the array.
1143  * @param type type of side data to be queried
1144  *
1145  * @return a pointer to the side data of a given type on success, NULL if there
1146  * is no side data with such type in this set.
1147  */
1149  const int nb_sd,
1150  enum AVFrameSideDataType type);
1151 
1152 /**
1153  * Wrapper around av_frame_side_data_get_c() to workaround the limitation
1154  * that for any type T the conversion from T * const * to const T * const *
1155  * is not performed automatically in C.
1156  * @see av_frame_side_data_get_c()
1157  */
1158 static inline
1160  const int nb_sd,
1162 {
1163  return av_frame_side_data_get_c((const AVFrameSideData * const *)sd,
1164  nb_sd, type);
1165 }
1166 
1167 /**
1168  * Remove and free all side data instances of the given type from an array.
1169  */
1170 void av_frame_side_data_remove(AVFrameSideData ***sd, int *nb_sd,
1171  enum AVFrameSideDataType type);
1172 /**
1173  * @}
1174  */
1175 
1176 #endif /* AVUTIL_FRAME_H */
AVFrame::extended_buf
AVBufferRef ** extended_buf
For planar audio which requires more than AV_NUM_DATA_POINTERS AVBufferRef pointers,...
Definition: frame.h:616
AVFrame::color_trc
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:672
AV_AFD_14_9
@ AV_AFD_14_9
Definition: frame.h:252
AVFrame::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:668
AVFrame::palette_has_changed
attribute_deprecated int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:582
AVColorTransferCharacteristic
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:611
av_frame_get_buffer
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:304
av_frame_get_side_data
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:963
av_frame_new_side_data
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, size_t size)
Add a new side data to a frame.
Definition: frame.c:811
AVFrame::duration
int64_t duration
Duration of the frame, in the same units as pts.
Definition: frame.h:795
AV_FRAME_DATA_A53_CC
@ AV_FRAME_DATA_A53_CC
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:59
AVFrame::nb_side_data
int nb_side_data
Definition: frame.h:623
AVPictureType
AVPictureType
Definition: avutil.h:277
rational.h
AV_FRAME_DATA_DOVI_METADATA
@ AV_FRAME_DATA_DOVI_METADATA
Parsed Dolby Vision metadata, suitable for passing to a software implementation.
Definition: frame.h:208
int64_t
long long int64_t
Definition: coverity.c:34
AV_FRAME_DATA_FILM_GRAIN_PARAMS
@ AV_FRAME_DATA_FILM_GRAIN_PARAMS
Film grain parameters for a frame, described by AVFilmGrainParams.
Definition: frame.h:188
AVFrame::color_primaries
enum AVColorPrimaries color_primaries
Definition: frame.h:670
AV_FRAME_DATA_S12M_TIMECODE
@ AV_FRAME_DATA_S12M_TIMECODE
Timecode which conforms to SMPTE ST 12-1.
Definition: frame.h:152
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:162
AVFrame::opaque
void * opaque
Frame owner's private data.
Definition: frame.h:537
AVFrame::colorspace
enum AVColorSpace colorspace
YUV colorspace type.
Definition: frame.h:679
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
av_frame_make_writable
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:678
AVFrameSideData::buf
AVBufferRef * buf
Definition: frame.h:270
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:501
AVFrame::width
int width
Definition: frame.h:461
AV_FRAME_DATA_DOVI_RPU_BUFFER
@ AV_FRAME_DATA_DOVI_RPU_BUFFER
Dolby Vision RPU raw data, suitable for passing to x265 or other libraries.
Definition: frame.h:201
AV_FRAME_DATA_DISPLAYMATRIX
@ AV_FRAME_DATA_DISPLAYMATRIX
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
Definition: frame.h:85
AV_AFD_16_9
@ AV_AFD_16_9
Definition: frame.h:251
AVDictionary
Definition: dict.c:34
AVFrame::flags
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:661
AVColorPrimaries
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:586
av_frame_side_data_clone
int av_frame_side_data_clone(AVFrameSideData ***sd, int *nb_sd, const AVFrameSideData *src, unsigned int flags)
Add a new side data entry to an array based on existing side data, taking a reference towards the con...
Definition: frame.c:888
AVFrame::buf
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:602
av_frame_apply_cropping
int av_frame_apply_cropping(AVFrame *frame, int flags)
Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields.
Definition: frame.c:1078
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:410
AVFrame::opaque_ref
AVBufferRef * opaque_ref
Frame owner's private data.
Definition: frame.h:756
AVFrame::chroma_location
enum AVChromaLocation chroma_location
Definition: frame.h:681
AV_AFD_SAME
@ AV_AFD_SAME
Definition: frame.h:249
AV_FRAME_DATA_MATRIXENCODING
@ AV_FRAME_DATA_MATRIXENCODING
The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
Definition: frame.h:68
samplefmt.h
AVFrame::ch_layout
AVChannelLayout ch_layout
Channel layout of the audio data.
Definition: frame.h:790
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
AVFrameSideDataType
AVFrameSideDataType
Definition: frame.h:49
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:150
AVFrame::interlaced_frame
attribute_deprecated int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:566
AVFrameSideData::size
size_t size
Definition: frame.h:268
AVRegionOfInterest
Structure describing a single Region Of Interest.
Definition: frame.h:315
AVRegionOfInterest::bottom
int bottom
Definition: frame.h:331
AV_FRAME_DATA_AUDIO_SERVICE_TYPE
@ AV_FRAME_DATA_AUDIO_SERVICE_TYPE
This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defi...
Definition: frame.h:114
AV_AFD_SP_4_3
@ AV_AFD_SP_4_3
Definition: frame.h:255
AV_SIDE_DATA_PROP_MULTI
@ AV_SIDE_DATA_PROP_MULTI
Multiple instances of this side data type can be meaningfully present in a single side data array.
Definition: frame.h:285
av_frame_clone
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:609
AVFrame::pkt_size
attribute_deprecated int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:733
AVFrame::crop_right
size_t crop_right
Definition: frame.h:769
AV_SIDE_DATA_PROP_GLOBAL
@ AV_SIDE_DATA_PROP_GLOBAL
The side data type can be used in stream-global structures.
Definition: frame.h:279
AVFrame::key_frame
attribute_deprecated int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:485
AV_FRAME_DATA_DYNAMIC_HDR_VIVID
@ AV_FRAME_DATA_DYNAMIC_HDR_VIVID
HDR Vivid dynamic metadata associated with a video frame.
Definition: frame.h:215
AV_FRAME_DATA_SPHERICAL
@ AV_FRAME_DATA_SPHERICAL
The data represents the AVSphericalMapping structure defined in libavutil/spherical....
Definition: frame.h:131
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:725
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
av_frame_side_data_remove
void av_frame_side_data_remove(AVFrameSideData ***sd, int *nb_sd, enum AVFrameSideDataType type)
Remove and free all side data instances of the given type from an array.
Definition: frame.c:957
AVRegionOfInterest::self_size
uint32_t self_size
Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
Definition: frame.h:320
AVActiveFormatDescription
AVActiveFormatDescription
Definition: frame.h:248
AV_FRAME_DATA_ICC_PROFILE
@ AV_FRAME_DATA_ICC_PROFILE
The data contains an ICC profile as an opaque octet buffer following the format described by ISO 1507...
Definition: frame.h:144
AV_FRAME_DATA_MASTERING_DISPLAY_METADATA
@ AV_FRAME_DATA_MASTERING_DISPLAY_METADATA
Mastering display metadata associated with a video frame.
Definition: frame.h:120
av_frame_new_side_data_from_buf
AVFrameSideData * av_frame_new_side_data_from_buf(AVFrame *frame, enum AVFrameSideDataType type, AVBufferRef *buf)
Add a new side data to a frame from an existing AVBufferRef.
Definition: frame.c:802
AVFrame::pkt_dts
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:508
AVSideDataDescriptor::props
unsigned props
Side data property flags, a combination of AVSideDataProps values.
Definition: frame.h:301
AV_FRAME_DATA_AFD
@ AV_FRAME_DATA_AFD
Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVAc...
Definition: frame.h:90
AV_AFD_4_3_SP_14_9
@ AV_AFD_4_3_SP_14_9
Definition: frame.h:253
av_frame_get_plane_buffer
AVBufferRef * av_frame_get_plane_buffer(const AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
Definition: frame.c:730
AV_FRAME_DATA_SEI_UNREGISTERED
@ AV_FRAME_DATA_SEI_UNREGISTERED
User data unregistered metadata associated with a video frame.
Definition: frame.h:178
AVFrame::crop_bottom
size_t crop_bottom
Definition: frame.h:767
AVFrame::best_effort_timestamp
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:688
AVFrame::crop_left
size_t crop_left
Definition: frame.h:768
AVFrame::pict_type
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:491
AV_FRAME_DATA_REPLAYGAIN
@ AV_FRAME_DATA_REPLAYGAIN
ReplayGain information in the form of the AVReplayGain struct.
Definition: frame.h:77
AV_FRAME_DATA_AMBIENT_VIEWING_ENVIRONMENT
@ AV_FRAME_DATA_AMBIENT_VIEWING_ENVIRONMENT
Ambient viewing environment metadata, as defined by H.274.
Definition: frame.h:220
AV_FRAME_DATA_PANSCAN
@ AV_FRAME_DATA_PANSCAN
The data is the AVPanScan struct defined in libavcodec.
Definition: frame.h:53
av_frame_ref
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:400
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:317
dst
uint8_t ptrdiff_t const uint8_t ptrdiff_t int intptr_t intptr_t int int16_t * dst
Definition: dsp.h:83
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:1015
AVFrame::quality
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:521
AVFrame::sample_rate
int sample_rate
Sample rate of the audio data.
Definition: frame.h:588
AV_FRAME_DATA_LCEVC
@ AV_FRAME_DATA_LCEVC
Raw LCEVC payload data, as a uint8_t array, with NAL emulation bytes intact.
Definition: frame.h:236
size
int size
Definition: twinvq_data.h:10344
AV_NUM_DATA_POINTERS
#define AV_NUM_DATA_POINTERS
Definition: frame.h:390
AVFrame::time_base
AVRational time_base
Time base for the timestamps in this frame.
Definition: frame.h:516
AVFrameSideData::data
uint8_t * data
Definition: frame.h:267
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:661
AVFrame::pkt_pos
attribute_deprecated int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
Definition: frame.h:699
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:476
buffer.h
align
static const uint8_t *BS_FUNC() align(BSCTX *bc)
Skip bits to a byte boundary.
Definition: bitstream_template.h:411
attribute_deprecated
#define attribute_deprecated
Definition: attributes.h:104
av_frame_remove_side_data
void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
Remove and free all side data instances of the given type.
Definition: frame.c:1029
AVSideDataDescriptor::name
const char * name
Human-readable side data description.
Definition: frame.h:296
AVRegionOfInterest::right
int right
Definition: frame.h:333
AV_FRAME_DATA_VIEW_ID
@ AV_FRAME_DATA_VIEW_ID
This side data must be associated with a video frame.
Definition: frame.h:245
AVFrame::private_ref
AVBufferRef * private_ref
AVBufferRef for internal use by a single libav* library.
Definition: frame.h:785
AV_FRAME_DATA_SKIP_SAMPLES
@ AV_FRAME_DATA_SKIP_SAMPLES
Recommmends skipping the specified number of samples.
Definition: frame.h:109
AVChromaLocation
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:736
AVRegionOfInterest::left
int left
Definition: frame.h:332
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:469
AV_FRAME_DATA_CONTENT_LIGHT_LEVEL
@ AV_FRAME_DATA_CONTENT_LIGHT_LEVEL
Content light level (based on CTA-861.3).
Definition: frame.h:137
AVSideDataProps
AVSideDataProps
Definition: frame.h:273
av_frame_side_data_free
void av_frame_side_data_free(AVFrameSideData ***sd, int *nb_sd)
Free all side data entries and their contents, then zeroes out the values which the pointers are poin...
Definition: frame.c:113
AVFrame::top_field_first
attribute_deprecated int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:574
AVRegionOfInterest::top
int top
Distance in pixels from the top edge of the frame to the top and bottom edges and from the left edge ...
Definition: frame.h:330
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:450
AVColorSpace
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:640
AV_FRAME_DATA_STEREO3D
@ AV_FRAME_DATA_STEREO3D
Stereoscopic 3d metadata.
Definition: frame.h:64
av_frame_move_ref
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:649
av_frame_unref
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:622
AVFrame::side_data
AVFrameSideData ** side_data
Definition: frame.h:622
version.h
AVFrame::decode_error_flags
int decode_error_flags
decode error flags of the frame, set to a combination of FF_DECODE_ERROR_xxx flags if the decoder pro...
Definition: frame.h:716
AV_FRAME_DATA_GOP_TIMECODE
@ AV_FRAME_DATA_GOP_TIMECODE
The GOP timecode in 25 bit timecode format.
Definition: frame.h:125
pixfmt.h
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AV_FRAME_DATA_VIDEO_HINT
@ AV_FRAME_DATA_VIDEO_HINT
Provide encoder-specific hinting information about changed/unchanged portions of a frame.
Definition: frame.h:230
dict.h
AVFrame::sample_aspect_ratio
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:496
AVFrame::hw_frames_ctx
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame.
Definition: frame.h:740
av_frame_replace
int av_frame_replace(AVFrame *dst, const AVFrame *src)
Ensure the destination frame refers to the same data described by the source frame,...
Definition: frame.c:499
AV_FRAME_DATA_DYNAMIC_HDR_PLUS
@ AV_FRAME_DATA_DYNAMIC_HDR_PLUS
HDR dynamic metadata associated with a video frame.
Definition: frame.h:159
AVFrame::height
int height
Definition: frame.h:461
channel_layout.h
av_frame_side_data_new
AVFrameSideData * av_frame_side_data_new(AVFrameSideData ***sd, int *nb_sd, enum AVFrameSideDataType type, size_t size, unsigned int flags)
Add new side data entry to an array.
Definition: frame.c:837
AV_FRAME_DATA_VIDEO_ENC_PARAMS
@ AV_FRAME_DATA_VIDEO_ENC_PARAMS
Encoding parameters for a video frame, as described by AVVideoEncParams.
Definition: frame.h:170
AVFrame::metadata
AVDictionary * metadata
metadata.
Definition: frame.h:707
AVFrameSideData::type
enum AVFrameSideDataType type
Definition: frame.h:266
AVSideDataDescriptor
This struct describes the properties of a side data type.
Definition: frame.h:292
avutil.h
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
AVFrameSideData
Structure to hold side data for an AVFrame.
Definition: frame.h:265
av_frame_side_data_desc
const AVSideDataDescriptor * av_frame_side_data_desc(enum AVFrameSideDataType type)
Definition: frame.c:1034
AVFrame::crop_top
size_t crop_top
Definition: frame.h:766
av_frame_side_data_name
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:1042
av_frame_side_data_get
static const AVFrameSideData * av_frame_side_data_get(AVFrameSideData *const *sd, const int nb_sd, enum AVFrameSideDataType type)
Wrapper around av_frame_side_data_get_c() to workaround the limitation that for any type T the conver...
Definition: frame.h:1159
AV_FRAME_DATA_REGIONS_OF_INTEREST
@ AV_FRAME_DATA_REGIONS_OF_INTEREST
Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is ...
Definition: frame.h:165
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:482
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:434
AVFrameSideData::metadata
AVDictionary * metadata
Definition: frame.h:269
av_frame_side_data_get_c
const AVFrameSideData * av_frame_side_data_get_c(const AVFrameSideData *const *sd, const int nb_sd, enum AVFrameSideDataType type)
Get a side data entry of a specific type from an array.
Definition: frame.c:946
AV_FRAME_DATA_MOTION_VECTORS
@ AV_FRAME_DATA_MOTION_VECTORS
Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec A...
Definition: frame.h:97
AV_FRAME_CROP_UNALIGNED
@ AV_FRAME_CROP_UNALIGNED
Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unalig...
Definition: frame.h:1015
AV_AFD_4_3
@ AV_AFD_4_3
Definition: frame.h:250
AVColorRange
AVColorRange
Visual content value range.
Definition: pixfmt.h:682
AVRegionOfInterest::qoffset
AVRational qoffset
Quantisation offset.
Definition: frame.h:357
AV_FRAME_DATA_DOWNMIX_INFO
@ AV_FRAME_DATA_DOWNMIX_INFO
Metadata relevant to a downmix procedure.
Definition: frame.h:73
AVFrame::repeat_pict
int repeat_pict
Number of fields in this frame which should be repeated, i.e.
Definition: frame.h:557
av_frame_side_data_add
AVFrameSideData * av_frame_side_data_add(AVFrameSideData ***sd, int *nb_sd, enum AVFrameSideDataType type, AVBufferRef **buf, unsigned int flags)
Add a new side data entry to an array from an existing AVBufferRef.
Definition: frame.c:862
src
#define src
Definition: vp8dsp.c:248
AV_FRAME_DATA_DETECTION_BBOXES
@ AV_FRAME_DATA_DETECTION_BBOXES
Bounding boxes for object detection and classification, as described by AVDetectionBBoxHeader.
Definition: frame.h:194
AVFrame::nb_extended_buf
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:620
AV_AFD_16_9_SP_14_9
@ AV_AFD_16_9_SP_14_9
Definition: frame.h:254