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  */
185 
186  /**
187  * Bounding boxes for object detection and classification,
188  * as described by AVDetectionBBoxHeader.
189  */
191 
192  /**
193  * Dolby Vision RPU raw data, suitable for passing to x265
194  * or other libraries. Array of uint8_t, with NAL emulation
195  * bytes intact.
196  */
198 
199  /**
200  * Parsed Dolby Vision metadata, suitable for passing to a software
201  * implementation. The payload is the AVDOVIMetadata struct defined in
202  * libavutil/dovi_meta.h.
203  */
205 
206  /**
207  * HDR Vivid dynamic metadata associated with a video frame. The payload is
208  * an AVDynamicHDRVivid type and contains information for color
209  * volume transform - CUVA 005.1-2021.
210  */
212 };
213 
222 };
223 
224 
225 /**
226  * Structure to hold side data for an AVFrame.
227  *
228  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
229  * to the end with a minor bump.
230  */
231 typedef struct AVFrameSideData {
233  uint8_t *data;
234  size_t size;
238 
239 /**
240  * Structure describing a single Region Of Interest.
241  *
242  * When multiple regions are defined in a single side-data block, they
243  * should be ordered from most to least important - some encoders are only
244  * capable of supporting a limited number of distinct regions, so will have
245  * to truncate the list.
246  *
247  * When overlapping regions are defined, the first region containing a given
248  * area of the frame applies.
249  */
250 typedef struct AVRegionOfInterest {
251  /**
252  * Must be set to the size of this data structure (that is,
253  * sizeof(AVRegionOfInterest)).
254  */
255  uint32_t self_size;
256  /**
257  * Distance in pixels from the top edge of the frame to the top and
258  * bottom edges and from the left edge of the frame to the left and
259  * right edges of the rectangle defining this region of interest.
260  *
261  * The constraints on a region are encoder dependent, so the region
262  * actually affected may be slightly larger for alignment or other
263  * reasons.
264  */
265  int top;
266  int bottom;
267  int left;
268  int right;
269  /**
270  * Quantisation offset.
271  *
272  * Must be in the range -1 to +1. A value of zero indicates no quality
273  * change. A negative value asks for better quality (less quantisation),
274  * while a positive value asks for worse quality (greater quantisation).
275  *
276  * The range is calibrated so that the extreme values indicate the
277  * largest possible offset - if the rest of the frame is encoded with the
278  * worst possible quality, an offset of -1 indicates that this region
279  * should be encoded with the best possible quality anyway. Intermediate
280  * values are then interpolated in some codec-dependent way.
281  *
282  * For example, in 10-bit H.264 the quantisation parameter varies between
283  * -12 and 51. A typical qoffset value of -1/10 therefore indicates that
284  * this region should be encoded with a QP around one-tenth of the full
285  * range better than the rest of the frame. So, if most of the frame
286  * were to be encoded with a QP of around 30, this region would get a QP
287  * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
288  * An extreme value of -1 would indicate that this region should be
289  * encoded with the best possible quality regardless of the treatment of
290  * the rest of the frame - that is, should be encoded at a QP of -12.
291  */
294 
295 /**
296  * This structure describes decoded (raw) audio or video data.
297  *
298  * AVFrame must be allocated using av_frame_alloc(). Note that this only
299  * allocates the AVFrame itself, the buffers for the data must be managed
300  * through other means (see below).
301  * AVFrame must be freed with av_frame_free().
302  *
303  * AVFrame is typically allocated once and then reused multiple times to hold
304  * different data (e.g. a single AVFrame to hold frames received from a
305  * decoder). In such a case, av_frame_unref() will free any references held by
306  * the frame and reset it to its original clean state before it
307  * is reused again.
308  *
309  * The data described by an AVFrame is usually reference counted through the
310  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
311  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
312  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
313  * every single data plane must be contained in one of the buffers in
314  * AVFrame.buf or AVFrame.extended_buf.
315  * There may be a single buffer for all the data, or one separate buffer for
316  * each plane, or anything in between.
317  *
318  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
319  * to the end with a minor bump.
320  *
321  * Fields can be accessed through AVOptions, the name string used, matches the
322  * C structure field name for fields accessible through AVOptions. The AVClass
323  * for AVFrame can be obtained from avcodec_get_frame_class()
324  */
325 typedef struct AVFrame {
326 #define AV_NUM_DATA_POINTERS 8
327  /**
328  * pointer to the picture/channel planes.
329  * This might be different from the first allocated byte. For video,
330  * it could even point to the end of the image data.
331  *
332  * All pointers in data and extended_data must point into one of the
333  * AVBufferRef in buf or extended_buf.
334  *
335  * Some decoders access areas outside 0,0 - width,height, please
336  * see avcodec_align_dimensions2(). Some filters and swscale can read
337  * up to 16 bytes beyond the planes, if these filters are to be used,
338  * then 16 extra bytes must be allocated.
339  *
340  * NOTE: Pointers not needed by the format MUST be set to NULL.
341  *
342  * @attention In case of video, the data[] pointers can point to the
343  * end of image data in order to reverse line order, when used in
344  * combination with negative values in the linesize[] array.
345  */
347 
348  /**
349  * For video, a positive or negative value, which is typically indicating
350  * the size in bytes of each picture line, but it can also be:
351  * - the negative byte size of lines for vertical flipping
352  * (with data[n] pointing to the end of the data
353  * - a positive or negative multiple of the byte size as for accessing
354  * even and odd fields of a frame (possibly flipped)
355  *
356  * For audio, only linesize[0] may be set. For planar audio, each channel
357  * plane must be the same size.
358  *
359  * For video the linesizes should be multiples of the CPUs alignment
360  * preference, this is 16 or 32 for modern desktop CPUs.
361  * Some code requires such alignment other code can be slower without
362  * correct alignment, for yet other it makes no difference.
363  *
364  * @note The linesize may be larger than the size of usable data -- there
365  * may be extra padding present for performance reasons.
366  *
367  * @attention In case of video, line size values can be negative to achieve
368  * a vertically inverted iteration over image lines.
369  */
371 
372  /**
373  * pointers to the data planes/channels.
374  *
375  * For video, this should simply point to data[].
376  *
377  * For planar audio, each channel has a separate data pointer, and
378  * linesize[0] contains the size of each channel buffer.
379  * For packed audio, there is just one data pointer, and linesize[0]
380  * contains the total size of the buffer for all channels.
381  *
382  * Note: Both data and extended_data should always be set in a valid frame,
383  * but for planar audio with more channels that can fit in data,
384  * extended_data must be used in order to access all channels.
385  */
386  uint8_t **extended_data;
387 
388  /**
389  * @name Video dimensions
390  * Video frames only. The coded dimensions (in pixels) of the video frame,
391  * i.e. the size of the rectangle that contains some well-defined values.
392  *
393  * @note The part of the frame intended for display/presentation is further
394  * restricted by the @ref cropping "Cropping rectangle".
395  * @{
396  */
397  int width, height;
398  /**
399  * @}
400  */
401 
402  /**
403  * number of audio samples (per channel) described by this frame
404  */
406 
407  /**
408  * format of the frame, -1 if unknown or unset
409  * Values correspond to enum AVPixelFormat for video frames,
410  * enum AVSampleFormat for audio)
411  */
412  int format;
413 
414  /**
415  * 1 -> keyframe, 0-> not
416  */
418 
419  /**
420  * Picture type of the frame.
421  */
423 
424  /**
425  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
426  */
428 
429  /**
430  * Presentation timestamp in time_base units (time when frame should be shown to user).
431  */
432  int64_t pts;
433 
434  /**
435  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
436  * This is also the Presentation time of this AVFrame calculated from
437  * only AVPacket.dts values without pts values.
438  */
439  int64_t pkt_dts;
440 
441  /**
442  * Time base for the timestamps in this frame.
443  * In the future, this field may be set on frames output by decoders or
444  * filters, but its value will be by default ignored on input to encoders
445  * or filters.
446  */
448 
449  /**
450  * picture number in bitstream order
451  */
453  /**
454  * picture number in display order
455  */
457 
458  /**
459  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
460  */
461  int quality;
462 
463  /**
464  * for some private data of the user
465  */
466  void *opaque;
467 
468  /**
469  * When decoding, this signals how much the picture must be delayed.
470  * extra_delay = repeat_pict / (2*fps)
471  */
473 
474  /**
475  * The content of the picture is interlaced.
476  */
478 
479  /**
480  * If the content is interlaced, is top field displayed first.
481  */
483 
484  /**
485  * Tell user application that palette has changed from previous frame.
486  */
488 
489  /**
490  * reordered opaque 64 bits (generally an integer or a double precision float
491  * PTS but can be anything).
492  * The user sets AVCodecContext.reordered_opaque to represent the input at
493  * that time,
494  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
495  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
496  */
498 
499  /**
500  * Sample rate of the audio data.
501  */
503 
504 #if FF_API_OLD_CHANNEL_LAYOUT
505  /**
506  * Channel layout of the audio data.
507  * @deprecated use ch_layout instead
508  */
510  uint64_t channel_layout;
511 #endif
512 
513  /**
514  * AVBuffer references backing the data for this frame. All the pointers in
515  * data and extended_data must point inside one of the buffers in buf or
516  * extended_buf. This array must be filled contiguously -- if buf[i] is
517  * non-NULL then buf[j] must also be non-NULL for all j < i.
518  *
519  * There may be at most one AVBuffer per data plane, so for video this array
520  * always contains all the references. For planar audio with more than
521  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
522  * this array. Then the extra AVBufferRef pointers are stored in the
523  * extended_buf array.
524  */
526 
527  /**
528  * For planar audio which requires more than AV_NUM_DATA_POINTERS
529  * AVBufferRef pointers, this array will hold all the references which
530  * cannot fit into AVFrame.buf.
531  *
532  * Note that this is different from AVFrame.extended_data, which always
533  * contains all the pointers. This array only contains the extra pointers,
534  * which cannot fit into AVFrame.buf.
535  *
536  * This array is always allocated using av_malloc() by whoever constructs
537  * the frame. It is freed in av_frame_unref().
538  */
540  /**
541  * Number of elements in extended_buf.
542  */
544 
547 
548 /**
549  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
550  * @ingroup lavu_frame
551  * Flags describing additional frame properties.
552  *
553  * @{
554  */
555 
556 /**
557  * The frame data may be corrupted, e.g. due to decoding errors.
558  */
559 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
560 /**
561  * A flag to mark the frames which need to be decoded, but shouldn't be output.
562  */
563 #define AV_FRAME_FLAG_DISCARD (1 << 2)
564 /**
565  * @}
566  */
567 
568  /**
569  * Frame flags, a combination of @ref lavu_frame_flags
570  */
571  int flags;
572 
573  /**
574  * MPEG vs JPEG YUV range.
575  * - encoding: Set by user
576  * - decoding: Set by libavcodec
577  */
579 
581 
583 
584  /**
585  * YUV colorspace type.
586  * - encoding: Set by user
587  * - decoding: Set by libavcodec
588  */
590 
592 
593  /**
594  * frame timestamp estimated using various heuristics, in stream time base
595  * - encoding: unused
596  * - decoding: set by libavcodec, read by user.
597  */
599 
600  /**
601  * reordered pos from the last AVPacket that has been input into the decoder
602  * - encoding: unused
603  * - decoding: Read by user.
604  */
605  int64_t pkt_pos;
606 
607 #if FF_API_PKT_DURATION
608  /**
609  * duration of the corresponding packet, expressed in
610  * AVStream->time_base units, 0 if unknown.
611  * - encoding: unused
612  * - decoding: Read by user.
613  *
614  * @deprecated use duration instead
615  */
617  int64_t pkt_duration;
618 #endif
619 
620  /**
621  * metadata.
622  * - encoding: Set by user.
623  * - decoding: Set by libavcodec.
624  */
626 
627  /**
628  * decode error flags of the frame, set to a combination of
629  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
630  * were errors during the decoding.
631  * - encoding: unused
632  * - decoding: set by libavcodec, read by user.
633  */
635 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
636 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
637 #define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
638 #define FF_DECODE_ERROR_DECODE_SLICES 8
639 
640 #if FF_API_OLD_CHANNEL_LAYOUT
641  /**
642  * number of audio channels, only used for audio.
643  * - encoding: unused
644  * - decoding: Read by user.
645  * @deprecated use ch_layout instead
646  */
648  int channels;
649 #endif
650 
651  /**
652  * size of the corresponding packet containing the compressed
653  * frame.
654  * It is set to a negative value if unknown.
655  * - encoding: unused
656  * - decoding: set by libavcodec, read by user.
657  */
658  int pkt_size;
659 
660  /**
661  * For hwaccel-format frames, this should be a reference to the
662  * AVHWFramesContext describing the frame.
663  */
665 
666  /**
667  * AVBufferRef for free use by the API user. FFmpeg will never check the
668  * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
669  * the frame is unreferenced. av_frame_copy_props() calls create a new
670  * reference with av_buffer_ref() for the target frame's opaque_ref field.
671  *
672  * This is unrelated to the opaque field, although it serves a similar
673  * purpose.
674  */
676 
677  /**
678  * @anchor cropping
679  * @name Cropping
680  * Video frames only. The number of pixels to discard from the the
681  * top/bottom/left/right border of the frame to obtain the sub-rectangle of
682  * the frame intended for presentation.
683  * @{
684  */
685  size_t crop_top;
686  size_t crop_bottom;
687  size_t crop_left;
688  size_t crop_right;
689  /**
690  * @}
691  */
692 
693  /**
694  * AVBufferRef for internal use by a single libav* library.
695  * Must not be used to transfer data between libraries.
696  * Has to be NULL when ownership of the frame leaves the respective library.
697  *
698  * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
699  *
700  * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
701  * av_frame_copy_props() calls create a new reference with av_buffer_ref()
702  * for the target frame's private_ref field.
703  */
705 
706  /**
707  * Channel layout of the audio data.
708  */
710 
711  /**
712  * Duration of the frame, in the same units as pts. 0 if unknown.
713  */
714  int64_t duration;
715 } AVFrame;
716 
717 
718 #if FF_API_COLORSPACE_NAME
719 /**
720  * Get the name of a colorspace.
721  * @return a static string identifying the colorspace; can be NULL.
722  * @deprecated use av_color_space_name()
723  */
725 const char *av_get_colorspace_name(enum AVColorSpace val);
726 #endif
727 /**
728  * Allocate an AVFrame and set its fields to default values. The resulting
729  * struct must be freed using av_frame_free().
730  *
731  * @return An AVFrame filled with default values or NULL on failure.
732  *
733  * @note this only allocates the AVFrame itself, not the data buffers. Those
734  * must be allocated through other means, e.g. with av_frame_get_buffer() or
735  * manually.
736  */
737 AVFrame *av_frame_alloc(void);
738 
739 /**
740  * Free the frame and any dynamically allocated objects in it,
741  * e.g. extended_data. If the frame is reference counted, it will be
742  * unreferenced first.
743  *
744  * @param frame frame to be freed. The pointer will be set to NULL.
745  */
746 void av_frame_free(AVFrame **frame);
747 
748 /**
749  * Set up a new reference to the data described by the source frame.
750  *
751  * Copy frame properties from src to dst and create a new reference for each
752  * AVBufferRef from src.
753  *
754  * If src is not reference counted, new buffers are allocated and the data is
755  * copied.
756  *
757  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
758  * or newly allocated with av_frame_alloc() before calling this
759  * function, or undefined behavior will occur.
760  *
761  * @return 0 on success, a negative AVERROR on error
762  */
763 int av_frame_ref(AVFrame *dst, const AVFrame *src);
764 
765 /**
766  * Create a new frame that references the same data as src.
767  *
768  * This is a shortcut for av_frame_alloc()+av_frame_ref().
769  *
770  * @return newly created AVFrame on success, NULL on error.
771  */
773 
774 /**
775  * Unreference all the buffers referenced by frame and reset the frame fields.
776  */
778 
779 /**
780  * Move everything contained in src to dst and reset src.
781  *
782  * @warning: dst is not unreferenced, but directly overwritten without reading
783  * or deallocating its contents. Call av_frame_unref(dst) manually
784  * before calling this function to ensure that no memory is leaked.
785  */
786 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
787 
788 /**
789  * Allocate new buffer(s) for audio or video data.
790  *
791  * The following fields must be set on frame before calling this function:
792  * - format (pixel format for video, sample format for audio)
793  * - width and height for video
794  * - nb_samples and ch_layout for audio
795  *
796  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
797  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
798  * For planar formats, one buffer will be allocated for each plane.
799  *
800  * @warning: if frame already has been allocated, calling this function will
801  * leak memory. In addition, undefined behavior can occur in certain
802  * cases.
803  *
804  * @param frame frame in which to store the new buffers.
805  * @param align Required buffer size alignment. If equal to 0, alignment will be
806  * chosen automatically for the current CPU. It is highly
807  * recommended to pass 0 here unless you know what you are doing.
808  *
809  * @return 0 on success, a negative AVERROR on error.
810  */
811 int av_frame_get_buffer(AVFrame *frame, int align);
812 
813 /**
814  * Check if the frame data is writable.
815  *
816  * @return A positive value if the frame data is writable (which is true if and
817  * only if each of the underlying buffers has only one reference, namely the one
818  * stored in this frame). Return 0 otherwise.
819  *
820  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
821  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
822  *
823  * @see av_frame_make_writable(), av_buffer_is_writable()
824  */
826 
827 /**
828  * Ensure that the frame data is writable, avoiding data copy if possible.
829  *
830  * Do nothing if the frame is writable, allocate new buffers and copy the data
831  * if it is not. Non-refcounted frames behave as non-writable, i.e. a copy
832  * is always made.
833  *
834  * @return 0 on success, a negative AVERROR on error.
835  *
836  * @see av_frame_is_writable(), av_buffer_is_writable(),
837  * av_buffer_make_writable()
838  */
840 
841 /**
842  * Copy the frame data from src to dst.
843  *
844  * This function does not allocate anything, dst must be already initialized and
845  * allocated with the same parameters as src.
846  *
847  * This function only copies the frame data (i.e. the contents of the data /
848  * extended data arrays), not any other properties.
849  *
850  * @return >= 0 on success, a negative AVERROR on error.
851  */
852 int av_frame_copy(AVFrame *dst, const AVFrame *src);
853 
854 /**
855  * Copy only "metadata" fields from src to dst.
856  *
857  * Metadata for the purpose of this function are those fields that do not affect
858  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
859  * aspect ratio (for video), but not width/height or channel layout.
860  * Side data is also copied.
861  */
862 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
863 
864 /**
865  * Get the buffer reference a given data plane is stored in.
866  *
867  * @param frame the frame to get the plane's buffer from
868  * @param plane index of the data plane of interest in frame->extended_data.
869  *
870  * @return the buffer reference that contains the plane or NULL if the input
871  * frame is not valid.
872  */
874 
875 /**
876  * Add a new side data to a frame.
877  *
878  * @param frame a frame to which the side data should be added
879  * @param type type of the added side data
880  * @param size size of the side data
881  *
882  * @return newly added side data on success, NULL on error
883  */
886  size_t size);
887 
888 /**
889  * Add a new side data to a frame from an existing AVBufferRef
890  *
891  * @param frame a frame to which the side data should be added
892  * @param type the type of the added side data
893  * @param buf an AVBufferRef to add as side data. The ownership of
894  * the reference is transferred to the frame.
895  *
896  * @return newly added side data on success, NULL on error. On failure
897  * the frame is unchanged and the AVBufferRef remains owned by
898  * the caller.
899  */
902  AVBufferRef *buf);
903 
904 /**
905  * @return a pointer to the side data of a given type on success, NULL if there
906  * is no side data with such type in this frame.
907  */
910 
911 /**
912  * Remove and free all side data instances of the given type.
913  */
915 
916 
917 /**
918  * Flags for frame cropping.
919  */
920 enum {
921  /**
922  * Apply the maximum possible cropping, even if it requires setting the
923  * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
924  * to FFmpeg API is generally not allowed, and causes undefined behavior
925  * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
926  * are explicitly documented to accept it. Use this flag only if you
927  * absolutely know what you are doing.
928  */
930 };
931 
932 /**
933  * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
934  * crop_bottom fields. If cropping is successful, the function will adjust the
935  * data pointers and the width/height fields, and set the crop fields to 0.
936  *
937  * In all cases, the cropping boundaries will be rounded to the inherent
938  * alignment of the pixel format. In some cases, such as for opaque hwaccel
939  * formats, the left/top cropping is ignored. The crop fields are set to 0 even
940  * if the cropping was rounded or ignored.
941  *
942  * @param frame the frame which should be cropped
943  * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
944  *
945  * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
946  * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
947  */
949 
950 /**
951  * @return a string identifying the side data type
952  */
954 
955 /**
956  * @}
957  */
958 
959 #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:539
AVFrame::color_trc
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:582
AV_AFD_14_9
@ AV_AFD_14_9
Definition: frame.h:218
AVFrame::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:578
AVColorTransferCharacteristic
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:558
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:259
av_frame_get_side_data
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:691
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:679
AVFrame::duration
int64_t duration
Duration of the frame, in the same units as pts.
Definition: frame.h:714
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:546
AVPictureType
AVPictureType
Definition: avutil.h:272
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:204
AVFrame::coded_picture_number
int coded_picture_number
picture number in bitstream order
Definition: frame.h:452
AV_FRAME_DATA_FILM_GRAIN_PARAMS
@ AV_FRAME_DATA_FILM_GRAIN_PARAMS
Film grain parameters for a frame, described by AVFilmGrainParams.
Definition: frame.h:184
AVFrame::color_primaries
enum AVColorPrimaries color_primaries
Definition: frame.h:580
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:116
AVFrame::opaque
void * opaque
for some private data of the user
Definition: frame.h:466
AVFrame::colorspace
enum AVColorSpace colorspace
YUV colorspace type.
Definition: frame.h:589
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
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:550
AVFrameSideData::buf
AVBufferRef * buf
Definition: frame.h:236
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:432
AVFrame::width
int width
Definition: frame.h:397
AVFrame::top_field_first
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:482
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:197
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:217
AVDictionary
Definition: dict.c:32
AVFrame::flags
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:571
AVColorPrimaries
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:533
AVFrame::buf
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:525
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:870
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:346
AVFrame::opaque_ref
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
Definition: frame.h:675
AVFrame::chroma_location
enum AVChromaLocation chroma_location
Definition: frame.h:591
AV_AFD_SAME
@ AV_AFD_SAME
Definition: frame.h:215
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::key_frame
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:417
val
static double val(void *priv, double ch)
Definition: aeval.c:77
AVFrame::ch_layout
AVChannelLayout ch_layout
Channel layout of the audio data.
Definition: frame.h:709
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
AVFrame::channels
attribute_deprecated int channels
number of audio channels, only used for audio.
Definition: frame.h:648
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:104
AVFrameSideData::size
size_t size
Definition: frame.h:234
AVFrame::channel_layout
attribute_deprecated uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:510
AVRegionOfInterest
Structure describing a single Region Of Interest.
Definition: frame.h:250
AVRegionOfInterest::bottom
int bottom
Definition: frame.h:266
AVFrame::pkt_pos
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
Definition: frame.h:605
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:221
av_frame_clone
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:474
AVFrame::crop_right
size_t crop_right
Definition: frame.h:688
AV_FRAME_DATA_DYNAMIC_HDR_VIVID
@ AV_FRAME_DATA_DYNAMIC_HDR_VIVID
HDR Vivid dynamic metadata associated with a video frame.
Definition: frame.h:211
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:603
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVRegionOfInterest::self_size
uint32_t self_size
Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
Definition: frame.h:255
AVActiveFormatDescription
AVActiveFormatDescription
Definition: frame.h:214
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:647
AVFrame::pkt_dts
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:439
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:219
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:686
AVFrame::best_effort_timestamp
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:598
AVFrame::crop_left
size_t crop_left
Definition: frame.h:687
AVFrame::pict_type
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:422
AV_FRAME_DATA_REPLAYGAIN
@ AV_FRAME_DATA_REPLAYGAIN
ReplayGain information in the form of the AVReplayGain struct.
Definition: frame.h:77
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:353
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:301
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:771
AVFrame::quality
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:461
AVFrame::sample_rate
int sample_rate
Sample rate of the audio data.
Definition: frame.h:502
size
int size
Definition: twinvq_data.h:10344
AV_NUM_DATA_POINTERS
#define AV_NUM_DATA_POINTERS
Definition: frame.h:326
av_get_colorspace_name
const attribute_deprecated char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
Definition: frame.c:39
AVFrame::time_base
AVRational time_base
Time base for the timestamps in this frame.
Definition: frame.h:447
AVFrameSideData::data
uint8_t * data
Definition: frame.h:233
av_frame_is_writable
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:533
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:412
buffer.h
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:791
AVRegionOfInterest::right
int right
Definition: frame.h:268
AVFrame::private_ref
AVBufferRef * private_ref
AVBufferRef for internal use by a single libav* library.
Definition: frame.h:704
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:680
AVFrame::interlaced_frame
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:477
AVRegionOfInterest::left
int left
Definition: frame.h:267
AVFrame::nb_samples
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:405
AV_FRAME_DATA_CONTENT_LIGHT_LEVEL
@ AV_FRAME_DATA_CONTENT_LIGHT_LEVEL
Content light level (based on CTA-861.3).
Definition: frame.h:137
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:265
AVFrame::extended_data
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:386
AVColorSpace
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:587
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:516
av_frame_unref
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:487
AVFrame::pkt_duration
attribute_deprecated int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown.
Definition: frame.h:617
AVFrame::side_data
AVFrameSideData ** side_data
Definition: frame.h:545
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:634
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
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:427
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:664
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:397
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:929
channel_layout.h
AVFrame::palette_has_changed
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:487
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:625
AVFrameSideData::type
enum AVFrameSideDataType type
Definition: frame.h:232
AVFrame::pkt_size
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:658
AVFrame::reordered_opaque
int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything).
Definition: frame.h:497
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:231
AVFrame::crop_top
size_t crop_top
Definition: frame.h:685
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
av_frame_side_data_name
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:805
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:561
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:370
AVFrameSideData::metadata
AVDictionary * metadata
Definition: frame.h:235
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_get_plane_buffer
AVBufferRef * av_frame_get_plane_buffer(AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
Definition: frame.c:608
AV_AFD_4_3
@ AV_AFD_4_3
Definition: frame.h:216
AVColorRange
AVColorRange
Visual content value range.
Definition: pixfmt.h:626
AVFrame::display_picture_number
int display_picture_number
picture number in display order
Definition: frame.h:456
AVRegionOfInterest::qoffset
AVRational qoffset
Quantisation offset.
Definition: frame.h:292
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
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:472
AV_FRAME_DATA_DETECTION_BBOXES
@ AV_FRAME_DATA_DETECTION_BBOXES
Bounding boxes for object detection and classification, as described by AVDetectionBBoxHeader.
Definition: frame.h:190
AVFrame::nb_extended_buf
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:543
AV_AFD_16_9_SP_14_9
@ AV_AFD_16_9_SP_14_9
Definition: frame.h:220