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 "dict.h"
34 #include "rational.h"
35 #include "samplefmt.h"
36 #include "pixfmt.h"
37 #include "version.h"
38 
39 
40 /**
41  * @defgroup lavu_frame AVFrame
42  * @ingroup lavu_data
43  *
44  * @{
45  * AVFrame is an abstraction for reference-counted raw multimedia data.
46  */
47 
49  /**
50  * The data is the AVPanScan struct defined in libavcodec.
51  */
53  /**
54  * ATSC A53 Part 4 Closed Captions.
55  * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
56  * The number of bytes of CC data is AVFrameSideData.size.
57  */
59  /**
60  * Stereoscopic 3d metadata.
61  * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
62  */
64  /**
65  * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
66  */
68  /**
69  * Metadata relevant to a downmix procedure.
70  * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
71  */
73  /**
74  * ReplayGain information in the form of the AVReplayGain struct.
75  */
77  /**
78  * This side data contains a 3x3 transformation matrix describing an affine
79  * transformation that needs to be applied to the frame for correct
80  * presentation.
81  *
82  * See libavutil/display.h for a detailed description of the data.
83  */
85  /**
86  * Active Format Description data consisting of a single byte as specified
87  * in ETSI TS 101 154 using AVActiveFormatDescription enum.
88  */
90  /**
91  * Motion vectors exported by some codecs (on demand through the export_mvs
92  * flag set in the libavcodec AVCodecContext flags2 option).
93  * The data is the AVMotionVector struct defined in
94  * libavutil/motion_vector.h.
95  */
97  /**
98  * Recommmends skipping the specified number of samples. This is exported
99  * only if the "skip_manual" AVOption is set in libavcodec.
100  * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
101  * @code
102  * u32le number of samples to skip from start of this packet
103  * u32le number of samples to skip from end of this packet
104  * u8 reason for start skip
105  * u8 reason for end skip (0=padding silence, 1=convergence)
106  * @endcode
107  */
109  /**
110  * This side data must be associated with an audio frame and corresponds to
111  * enum AVAudioServiceType defined in avcodec.h.
112  */
114  /**
115  * Mastering display metadata associated with a video frame. The payload is
116  * an AVMasteringDisplayMetadata type and contains information about the
117  * mastering display color volume.
118  */
120  /**
121  * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
122  * This is set on the first frame of a GOP that has a temporal reference of 0.
123  */
125 
126  /**
127  * The data represents the AVSphericalMapping structure defined in
128  * libavutil/spherical.h.
129  */
131 
132  /**
133  * Content light level (based on CTA-861.3). This payload contains data in
134  * the form of the AVContentLightMetadata struct.
135  */
137 
138  /**
139  * The data contains an ICC profile as an opaque octet buffer following the
140  * format described by ISO 15076-1 with an optional name defined in the
141  * metadata key entry "name".
142  */
144 
145 #if FF_API_FRAME_QP
146  /**
147  * Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
148  * The contents of this side data are undocumented and internal; use
149  * av_frame_set_qp_table() and av_frame_get_qp_table() to access this in a
150  * meaningful way instead.
151  */
153 
154  /**
155  * Raw QP table data. Its format is described by
156  * AV_FRAME_DATA_QP_TABLE_PROPERTIES. Use av_frame_set_qp_table() and
157  * av_frame_get_qp_table() to access this instead.
158  */
160 #endif
161 
162  /**
163  * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t
164  * where the first uint32_t describes how many (1-3) of the other timecodes are used.
165  * The timecode format is described in the documentation of av_timecode_get_smpte_from_framenum()
166  * function in libavutil/timecode.h.
167  */
169 
170  /**
171  * HDR dynamic metadata associated with a video frame. The payload is
172  * an AVDynamicHDRPlus type and contains information for color
173  * volume transform - application 4 of SMPTE 2094-40:2016 standard.
174  */
176 
177  /**
178  * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of
179  * array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.
180  */
182 
183  /**
184  * Encoding parameters for a video frame, as described by AVVideoEncParams.
185  */
187 
188  /**
189  * User data unregistered metadata associated with a video frame.
190  * This is the H.26[45] UDU SEI message, and shouldn't be used for any other purpose
191  * The data is stored as uint8_t in AVFrameSideData.data which is 16 bytes of
192  * uuid_iso_iec_11578 followed by AVFrameSideData.size - 16 bytes of user_data_payload_byte.
193  */
195 
196  /**
197  * Film grain parameters for a frame, described by AVFilmGrainParameters.
198  * Must be present for every frame which should have film grain applied.
199  */
201 };
202 
211 };
212 
213 
214 /**
215  * Structure to hold side data for an AVFrame.
216  *
217  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
218  * to the end with a minor bump.
219  */
220 typedef struct AVFrameSideData {
223  int size;
227 
228 /**
229  * Structure describing a single Region Of Interest.
230  *
231  * When multiple regions are defined in a single side-data block, they
232  * should be ordered from most to least important - some encoders are only
233  * capable of supporting a limited number of distinct regions, so will have
234  * to truncate the list.
235  *
236  * When overlapping regions are defined, the first region containing a given
237  * area of the frame applies.
238  */
239 typedef struct AVRegionOfInterest {
240  /**
241  * Must be set to the size of this data structure (that is,
242  * sizeof(AVRegionOfInterest)).
243  */
244  uint32_t self_size;
245  /**
246  * Distance in pixels from the top edge of the frame to the top and
247  * bottom edges and from the left edge of the frame to the left and
248  * right edges of the rectangle defining this region of interest.
249  *
250  * The constraints on a region are encoder dependent, so the region
251  * actually affected may be slightly larger for alignment or other
252  * reasons.
253  */
254  int top;
255  int bottom;
256  int left;
257  int right;
258  /**
259  * Quantisation offset.
260  *
261  * Must be in the range -1 to +1. A value of zero indicates no quality
262  * change. A negative value asks for better quality (less quantisation),
263  * while a positive value asks for worse quality (greater quantisation).
264  *
265  * The range is calibrated so that the extreme values indicate the
266  * largest possible offset - if the rest of the frame is encoded with the
267  * worst possible quality, an offset of -1 indicates that this region
268  * should be encoded with the best possible quality anyway. Intermediate
269  * values are then interpolated in some codec-dependent way.
270  *
271  * For example, in 10-bit H.264 the quantisation parameter varies between
272  * -12 and 51. A typical qoffset value of -1/10 therefore indicates that
273  * this region should be encoded with a QP around one-tenth of the full
274  * range better than the rest of the frame. So, if most of the frame
275  * were to be encoded with a QP of around 30, this region would get a QP
276  * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
277  * An extreme value of -1 would indicate that this region should be
278  * encoded with the best possible quality regardless of the treatment of
279  * the rest of the frame - that is, should be encoded at a QP of -12.
280  */
283 
284 /**
285  * This structure describes decoded (raw) audio or video data.
286  *
287  * AVFrame must be allocated using av_frame_alloc(). Note that this only
288  * allocates the AVFrame itself, the buffers for the data must be managed
289  * through other means (see below).
290  * AVFrame must be freed with av_frame_free().
291  *
292  * AVFrame is typically allocated once and then reused multiple times to hold
293  * different data (e.g. a single AVFrame to hold frames received from a
294  * decoder). In such a case, av_frame_unref() will free any references held by
295  * the frame and reset it to its original clean state before it
296  * is reused again.
297  *
298  * The data described by an AVFrame is usually reference counted through the
299  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
300  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
301  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
302  * every single data plane must be contained in one of the buffers in
303  * AVFrame.buf or AVFrame.extended_buf.
304  * There may be a single buffer for all the data, or one separate buffer for
305  * each plane, or anything in between.
306  *
307  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
308  * to the end with a minor bump.
309  *
310  * Fields can be accessed through AVOptions, the name string used, matches the
311  * C structure field name for fields accessible through AVOptions. The AVClass
312  * for AVFrame can be obtained from avcodec_get_frame_class()
313  */
314 typedef struct AVFrame {
315 #define AV_NUM_DATA_POINTERS 8
316  /**
317  * pointer to the picture/channel planes.
318  * This might be different from the first allocated byte
319  *
320  * Some decoders access areas outside 0,0 - width,height, please
321  * see avcodec_align_dimensions2(). Some filters and swscale can read
322  * up to 16 bytes beyond the planes, if these filters are to be used,
323  * then 16 extra bytes must be allocated.
324  *
325  * NOTE: Except for hwaccel formats, pointers not needed by the format
326  * MUST be set to NULL.
327  */
329 
330  /**
331  * For video, size in bytes of each picture line.
332  * For audio, size in bytes of each plane.
333  *
334  * For audio, only linesize[0] may be set. For planar audio, each channel
335  * plane must be the same size.
336  *
337  * For video the linesizes should be multiples of the CPUs alignment
338  * preference, this is 16 or 32 for modern desktop CPUs.
339  * Some code requires such alignment other code can be slower without
340  * correct alignment, for yet other it makes no difference.
341  *
342  * @note The linesize may be larger than the size of usable data -- there
343  * may be extra padding present for performance reasons.
344  */
345  int linesize[AV_NUM_DATA_POINTERS];
346 
347  /**
348  * pointers to the data planes/channels.
349  *
350  * For video, this should simply point to data[].
351  *
352  * For planar audio, each channel has a separate data pointer, and
353  * linesize[0] contains the size of each channel buffer.
354  * For packed audio, there is just one data pointer, and linesize[0]
355  * contains the total size of the buffer for all channels.
356  *
357  * Note: Both data and extended_data should always be set in a valid frame,
358  * but for planar audio with more channels that can fit in data,
359  * extended_data must be used in order to access all channels.
360  */
362 
363  /**
364  * @name Video dimensions
365  * Video frames only. The coded dimensions (in pixels) of the video frame,
366  * i.e. the size of the rectangle that contains some well-defined values.
367  *
368  * @note The part of the frame intended for display/presentation is further
369  * restricted by the @ref cropping "Cropping rectangle".
370  * @{
371  */
372  int width, height;
373  /**
374  * @}
375  */
376 
377  /**
378  * number of audio samples (per channel) described by this frame
379  */
381 
382  /**
383  * format of the frame, -1 if unknown or unset
384  * Values correspond to enum AVPixelFormat for video frames,
385  * enum AVSampleFormat for audio)
386  */
387  int format;
388 
389  /**
390  * 1 -> keyframe, 0-> not
391  */
393 
394  /**
395  * Picture type of the frame.
396  */
397  enum AVPictureType pict_type;
398 
399  /**
400  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
401  */
403 
404  /**
405  * Presentation timestamp in time_base units (time when frame should be shown to user).
406  */
407  int64_t pts;
408 
409 #if FF_API_PKT_PTS
410  /**
411  * PTS copied from the AVPacket that was decoded to produce this frame.
412  * @deprecated use the pts field instead
413  */
415  int64_t pkt_pts;
416 #endif
417 
418  /**
419  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
420  * This is also the Presentation time of this AVFrame calculated from
421  * only AVPacket.dts values without pts values.
422  */
423  int64_t pkt_dts;
424 
425  /**
426  * picture number in bitstream order
427  */
429  /**
430  * picture number in display order
431  */
433 
434  /**
435  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
436  */
437  int quality;
438 
439  /**
440  * for some private data of the user
441  */
442  void *opaque;
443 
444 #if FF_API_ERROR_FRAME
445  /**
446  * @deprecated unused
447  */
450 #endif
451 
452  /**
453  * When decoding, this signals how much the picture must be delayed.
454  * extra_delay = repeat_pict / (2*fps)
455  */
457 
458  /**
459  * The content of the picture is interlaced.
460  */
462 
463  /**
464  * If the content is interlaced, is top field displayed first.
465  */
467 
468  /**
469  * Tell user application that palette has changed from previous frame.
470  */
472 
473  /**
474  * reordered opaque 64 bits (generally an integer or a double precision float
475  * PTS but can be anything).
476  * The user sets AVCodecContext.reordered_opaque to represent the input at
477  * that time,
478  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
479  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
480  */
482 
483  /**
484  * Sample rate of the audio data.
485  */
487 
488  /**
489  * Channel layout of the audio data.
490  */
491  uint64_t channel_layout;
492 
493  /**
494  * AVBuffer references backing the data for this frame. If all elements of
495  * this array are NULL, then this frame is not reference counted. This array
496  * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
497  * also be non-NULL for all j < i.
498  *
499  * There may be at most one AVBuffer per data plane, so for video this array
500  * always contains all the references. For planar audio with more than
501  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
502  * this array. Then the extra AVBufferRef pointers are stored in the
503  * extended_buf array.
504  */
506 
507  /**
508  * For planar audio which requires more than AV_NUM_DATA_POINTERS
509  * AVBufferRef pointers, this array will hold all the references which
510  * cannot fit into AVFrame.buf.
511  *
512  * Note that this is different from AVFrame.extended_data, which always
513  * contains all the pointers. This array only contains the extra pointers,
514  * which cannot fit into AVFrame.buf.
515  *
516  * This array is always allocated using av_malloc() by whoever constructs
517  * the frame. It is freed in av_frame_unref().
518  */
520  /**
521  * Number of elements in extended_buf.
522  */
524 
527 
528 /**
529  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
530  * @ingroup lavu_frame
531  * Flags describing additional frame properties.
532  *
533  * @{
534  */
535 
536 /**
537  * The frame data may be corrupted, e.g. due to decoding errors.
538  */
539 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
540 /**
541  * A flag to mark the frames which need to be decoded, but shouldn't be output.
542  */
543 #define AV_FRAME_FLAG_DISCARD (1 << 2)
544 /**
545  * @}
546  */
547 
548  /**
549  * Frame flags, a combination of @ref lavu_frame_flags
550  */
551  int flags;
552 
553  /**
554  * MPEG vs JPEG YUV range.
555  * - encoding: Set by user
556  * - decoding: Set by libavcodec
557  */
559 
561 
563 
564  /**
565  * YUV colorspace type.
566  * - encoding: Set by user
567  * - decoding: Set by libavcodec
568  */
569  enum AVColorSpace colorspace;
570 
571  enum AVChromaLocation chroma_location;
572 
573  /**
574  * frame timestamp estimated using various heuristics, in stream time base
575  * - encoding: unused
576  * - decoding: set by libavcodec, read by user.
577  */
579 
580  /**
581  * reordered pos from the last AVPacket that has been input into the decoder
582  * - encoding: unused
583  * - decoding: Read by user.
584  */
585  int64_t pkt_pos;
586 
587  /**
588  * duration of the corresponding packet, expressed in
589  * AVStream->time_base units, 0 if unknown.
590  * - encoding: unused
591  * - decoding: Read by user.
592  */
593  int64_t pkt_duration;
594 
595  /**
596  * metadata.
597  * - encoding: Set by user.
598  * - decoding: Set by libavcodec.
599  */
601 
602  /**
603  * decode error flags of the frame, set to a combination of
604  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
605  * were errors during the decoding.
606  * - encoding: unused
607  * - decoding: set by libavcodec, read by user.
608  */
610 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
611 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
612 #define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
613 #define FF_DECODE_ERROR_DECODE_SLICES 8
614 
615  /**
616  * number of audio channels, only used for audio.
617  * - encoding: unused
618  * - decoding: Read by user.
619  */
620  int channels;
621 
622  /**
623  * size of the corresponding packet containing the compressed
624  * frame.
625  * It is set to a negative value if unknown.
626  * - encoding: unused
627  * - decoding: set by libavcodec, read by user.
628  */
629  int pkt_size;
630 
631 #if FF_API_FRAME_QP
632  /**
633  * QP table
634  */
636  int8_t *qscale_table;
637  /**
638  * QP store stride
639  */
641  int qstride;
642 
645 
648 #endif
649  /**
650  * For hwaccel-format frames, this should be a reference to the
651  * AVHWFramesContext describing the frame.
652  */
654 
655  /**
656  * AVBufferRef for free use by the API user. FFmpeg will never check the
657  * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
658  * the frame is unreferenced. av_frame_copy_props() calls create a new
659  * reference with av_buffer_ref() for the target frame's opaque_ref field.
660  *
661  * This is unrelated to the opaque field, although it serves a similar
662  * purpose.
663  */
665 
666  /**
667  * @anchor cropping
668  * @name Cropping
669  * Video frames only. The number of pixels to discard from the the
670  * top/bottom/left/right border of the frame to obtain the sub-rectangle of
671  * the frame intended for presentation.
672  * @{
673  */
674  size_t crop_top;
675  size_t crop_bottom;
676  size_t crop_left;
677  size_t crop_right;
678  /**
679  * @}
680  */
681 
682  /**
683  * AVBufferRef for internal use by a single libav* library.
684  * Must not be used to transfer data between libraries.
685  * Has to be NULL when ownership of the frame leaves the respective library.
686  *
687  * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
688  *
689  * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
690  * av_frame_copy_props() calls create a new reference with av_buffer_ref()
691  * for the target frame's private_ref field.
692  */
694 } AVFrame;
695 
696 #if FF_API_FRAME_GET_SET
697 /**
698  * Accessors for some AVFrame fields. These used to be provided for ABI
699  * compatibility, and do not need to be used anymore.
700  */
706 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
708 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
710 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
712 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
714 int64_t av_frame_get_channel_layout (const AVFrame *frame);
718 int av_frame_get_channels (const AVFrame *frame);
737 #if FF_API_FRAME_QP
739 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
742 #endif
751 #endif
752 
753 /**
754  * Get the name of a colorspace.
755  * @return a static string identifying the colorspace; can be NULL.
756  */
757 const char *av_get_colorspace_name(enum AVColorSpace val);
758 
759 /**
760  * Allocate an AVFrame and set its fields to default values. The resulting
761  * struct must be freed using av_frame_free().
762  *
763  * @return An AVFrame filled with default values or NULL on failure.
764  *
765  * @note this only allocates the AVFrame itself, not the data buffers. Those
766  * must be allocated through other means, e.g. with av_frame_get_buffer() or
767  * manually.
768  */
769 AVFrame *av_frame_alloc(void);
770 
771 /**
772  * Free the frame and any dynamically allocated objects in it,
773  * e.g. extended_data. If the frame is reference counted, it will be
774  * unreferenced first.
775  *
776  * @param frame frame to be freed. The pointer will be set to NULL.
777  */
778 void av_frame_free(AVFrame **frame);
779 
780 /**
781  * Set up a new reference to the data described by the source frame.
782  *
783  * Copy frame properties from src to dst and create a new reference for each
784  * AVBufferRef from src.
785  *
786  * If src is not reference counted, new buffers are allocated and the data is
787  * copied.
788  *
789  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
790  * or newly allocated with av_frame_alloc() before calling this
791  * function, or undefined behavior will occur.
792  *
793  * @return 0 on success, a negative AVERROR on error
794  */
795 int av_frame_ref(AVFrame *dst, const AVFrame *src);
796 
797 /**
798  * Create a new frame that references the same data as src.
799  *
800  * This is a shortcut for av_frame_alloc()+av_frame_ref().
801  *
802  * @return newly created AVFrame on success, NULL on error.
803  */
805 
806 /**
807  * Unreference all the buffers referenced by frame and reset the frame fields.
808  */
810 
811 /**
812  * Move everything contained in src to dst and reset src.
813  *
814  * @warning: dst is not unreferenced, but directly overwritten without reading
815  * or deallocating its contents. Call av_frame_unref(dst) manually
816  * before calling this function to ensure that no memory is leaked.
817  */
818 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
819 
820 /**
821  * Allocate new buffer(s) for audio or video data.
822  *
823  * The following fields must be set on frame before calling this function:
824  * - format (pixel format for video, sample format for audio)
825  * - width and height for video
826  * - nb_samples and channel_layout for audio
827  *
828  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
829  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
830  * For planar formats, one buffer will be allocated for each plane.
831  *
832  * @warning: if frame already has been allocated, calling this function will
833  * leak memory. In addition, undefined behavior can occur in certain
834  * cases.
835  *
836  * @param frame frame in which to store the new buffers.
837  * @param align Required buffer size alignment. If equal to 0, alignment will be
838  * chosen automatically for the current CPU. It is highly
839  * recommended to pass 0 here unless you know what you are doing.
840  *
841  * @return 0 on success, a negative AVERROR on error.
842  */
843 int av_frame_get_buffer(AVFrame *frame, int align);
844 
845 /**
846  * Check if the frame data is writable.
847  *
848  * @return A positive value if the frame data is writable (which is true if and
849  * only if each of the underlying buffers has only one reference, namely the one
850  * stored in this frame). Return 0 otherwise.
851  *
852  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
853  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
854  *
855  * @see av_frame_make_writable(), av_buffer_is_writable()
856  */
858 
859 /**
860  * Ensure that the frame data is writable, avoiding data copy if possible.
861  *
862  * Do nothing if the frame is writable, allocate new buffers and copy the data
863  * if it is not.
864  *
865  * @return 0 on success, a negative AVERROR on error.
866  *
867  * @see av_frame_is_writable(), av_buffer_is_writable(),
868  * av_buffer_make_writable()
869  */
871 
872 /**
873  * Copy the frame data from src to dst.
874  *
875  * This function does not allocate anything, dst must be already initialized and
876  * allocated with the same parameters as src.
877  *
878  * This function only copies the frame data (i.e. the contents of the data /
879  * extended data arrays), not any other properties.
880  *
881  * @return >= 0 on success, a negative AVERROR on error.
882  */
883 int av_frame_copy(AVFrame *dst, const AVFrame *src);
884 
885 /**
886  * Copy only "metadata" fields from src to dst.
887  *
888  * Metadata for the purpose of this function are those fields that do not affect
889  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
890  * aspect ratio (for video), but not width/height or channel layout.
891  * Side data is also copied.
892  */
893 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
894 
895 /**
896  * Get the buffer reference a given data plane is stored in.
897  *
898  * @param plane index of the data plane of interest in frame->extended_data.
899  *
900  * @return the buffer reference that contains the plane or NULL if the input
901  * frame is not valid.
902  */
904 
905 /**
906  * Add a new side data to a frame.
907  *
908  * @param frame a frame to which the side data should be added
909  * @param type type of the added side data
910  * @param size size of the side data
911  *
912  * @return newly added side data on success, NULL on error
913  */
916  int size);
917 
918 /**
919  * Add a new side data to a frame from an existing AVBufferRef
920  *
921  * @param frame a frame to which the side data should be added
922  * @param type the type of the added side data
923  * @param buf an AVBufferRef to add as side data. The ownership of
924  * the reference is transferred to the frame.
925  *
926  * @return newly added side data on success, NULL on error. On failure
927  * the frame is unchanged and the AVBufferRef remains owned by
928  * the caller.
929  */
932  AVBufferRef *buf);
933 
934 /**
935  * @return a pointer to the side data of a given type on success, NULL if there
936  * is no side data with such type in this frame.
937  */
940 
941 /**
942  * Remove and free all side data instances of the given type.
943  */
945 
946 
947 /**
948  * Flags for frame cropping.
949  */
950 enum {
951  /**
952  * Apply the maximum possible cropping, even if it requires setting the
953  * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
954  * to FFmpeg API is generally not allowed, and causes undefined behavior
955  * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
956  * are explicitly documented to accept it. Use this flag only if you
957  * absolutely know what you are doing.
958  */
960 };
961 
962 /**
963  * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
964  * crop_bottom fields. If cropping is successful, the function will adjust the
965  * data pointers and the width/height fields, and set the crop fields to 0.
966  *
967  * In all cases, the cropping boundaries will be rounded to the inherent
968  * alignment of the pixel format. In some cases, such as for opaque hwaccel
969  * formats, the left/top cropping is ignored. The crop fields are set to 0 even
970  * if the cropping was rounded or ignored.
971  *
972  * @param frame the frame which should be cropped
973  * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
974  *
975  * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
976  * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
977  */
979 
980 /**
981  * @return a string identifying the side data type
982  */
984 
985 /**
986  * @}
987  */
988 
989 #endif /* AVUTIL_FRAME_H */
attribute_deprecated int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
Definition: frame.c:55
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:254
#define AV_NUM_DATA_POINTERS
Definition: frame.h:315
This structure describes decoded (raw) audio or video data.
Definition: frame.h:314
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defi...
Definition: frame.h:113
attribute_deprecated int qscale_type
Definition: frame.h:644
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
Definition: frame.h:585
attribute_deprecated void av_frame_set_pkt_pos(AVFrame *frame, int64_t val)
AVDictionary * metadata
Definition: frame.h:224
void * opaque
for some private data of the user
Definition: frame.h:442
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:523
Content light level (based on CTA-861.3).
Definition: frame.h:136
Timecode which conforms to SMPTE ST 12-1.
Definition: frame.h:168
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:456
Convenience header that includes libavutil&#39;s core.
GLint GLenum type
Definition: opengl_enc.c:104
Mastering display metadata associated with a video frame.
Definition: frame.h:119
attribute_deprecated AVBufferRef * qp_table_buf
Definition: frame.h:647
color_range
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:582
size_t crop_bottom
Definition: frame.h:675
attribute_deprecated enum AVColorRange av_frame_get_color_range(const AVFrame *frame)
static void error(const char *err)
attribute_deprecated int8_t * qscale_table
QP table.
Definition: frame.h:636
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:483
AVRational qoffset
Quantisation offset.
Definition: frame.h:281
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:738
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:653
Public dictionary API.
uint8_t
attribute_deprecated void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:190
Film grain parameters for a frame, described by AVFilmGrainParameters.
Definition: frame.h:200
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:512
size_t crop_left
Definition: frame.h:676
#define f(width, name)
Definition: cbs_vp9.c:255
attribute_deprecated int qstride
QP store stride.
Definition: frame.h:641
attribute_deprecated void av_frame_set_pkt_size(AVFrame *frame, int val)
AVBufferRef * private_ref
AVBufferRef for internal use by a single libav* library.
Definition: frame.h:693
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:443
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:407
AVBufferRef * buf
Definition: frame.h:225
The data is the AVPanScan struct defined in libavcodec.
Definition: frame.h:52
HDR dynamic metadata associated with a video frame.
Definition: frame.h:175
attribute_deprecated void av_frame_set_pkt_duration(AVFrame *frame, int64_t val)
Structure to hold side data for an AVFrame.
Definition: frame.h:220
#define height
AVDictionary * metadata
metadata.
Definition: frame.h:600
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:461
AVColorRange
Visual content value range.
Definition: pixfmt.h:551
ptrdiff_t size
Definition: opengl_enc.c:100
attribute_deprecated int64_t av_frame_get_channel_layout(const AVFrame *frame)
uint32_t self_size
Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
Definition: frame.h:244
attribute_deprecated int av_frame_get_sample_rate(const AVFrame *frame)
The data represents the AVSphericalMapping structure defined in libavutil/spherical.h.
Definition: frame.h:130
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:458
Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVAc...
Definition: frame.h:89
Metadata relevant to a downmix procedure.
Definition: frame.h:72
int nb_side_data
Definition: frame.h:526
AVFrameSideData ** side_data
Definition: frame.h:525
attribute_deprecated int av_frame_get_pkt_size(const AVFrame *frame)
Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
Definition: frame.h:152
#define src
Definition: vp8dsp.c:254
int width
Definition: frame.h:372
attribute_deprecated void av_frame_set_decode_error_flags(AVFrame *frame, int val)
attribute_deprecated int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame)
Accessors for some AVFrame fields.
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:891
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
attribute_deprecated void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val)
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:58
Libavutil version macros.
The GOP timecode in 25 bit timecode format.
Definition: frame.h:124
attribute_deprecated void av_frame_set_channels(AVFrame *frame, int val)
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:799
attribute_deprecated AVDictionary * av_frame_get_metadata(const AVFrame *frame)
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:491
size_t crop_top
Definition: frame.h:674
int channels
number of audio channels, only used for audio.
Definition: frame.h:620
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:551
int display_picture_number
picture number in display order
Definition: frame.h:432
AVBufferRef ** extended_buf
For planar audio which requires more than AV_NUM_DATA_POINTERS AVBufferRef pointers, this array will hold all the references which cannot fit into AVFrame.buf.
Definition: frame.h:519
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:694
static const struct ColorPrimaries color_primaries[AVCOL_PRI_NB]
Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec A...
Definition: frame.h:96
AVBufferRef * av_frame_get_plane_buffer(AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
Definition: frame.c:663
AVFrameSideDataType
Definition: frame.h:48
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
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:437
The data contains an ICC profile as an opaque octet buffer following the format described by ISO 1507...
Definition: frame.h:143
Structure describing a single Region Of Interest.
Definition: frame.h:239
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
Definition: frame.c:123
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:540
attribute_deprecated int64_t av_frame_get_pkt_pos(const AVFrame *frame)
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:387
int coded_picture_number
picture number in bitstream order
Definition: frame.h:428
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown...
Definition: frame.h:593
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
Definition: frame.h:84
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:594
attribute_deprecated int64_t av_frame_get_pkt_duration(const AVFrame *frame)
User data unregistered metadata associated with a video frame.
Definition: frame.h:194
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:402
uint8_t * data
Definition: frame.h:222
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:812
size_t crop_right
Definition: frame.h:677
attribute_deprecated void av_frame_set_channel_layout(AVFrame *frame, int64_t val)
int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything)...
Definition: frame.h:481
attribute_deprecated enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
int sample_rate
Sample rate of the audio data.
Definition: frame.h:486
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, int size)
Add a new side data to a frame.
Definition: frame.c:726
Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unalig...
Definition: frame.h:959
Rational number (pair of numerator and denominator).
Definition: rational.h:58
Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is ...
Definition: frame.h:181
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:471
attribute_deprecated void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
refcounted data buffer API
AVPictureType
Definition: avutil.h:272
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:578
AVActiveFormatDescription
Definition: frame.h:203
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:609
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:826
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:337
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:553
enum AVFrameSideDataType type
Definition: frame.h:221
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:611
#define flags(name, subs,...)
Definition: cbs_av1.c:560
#define attribute_deprecated
Definition: attributes.h:100
attribute_deprecated int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
Definition: frame.h:415
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:423
A reference to a data buffer.
Definition: buffer.h:81
attribute_deprecated int av_frame_get_channels(const AVFrame *frame)
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:104
Utilties for rational number calculation.
pixel format definitions
attribute_deprecated void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:466
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
Definition: frame.h:664
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:392
attribute_deprecated void av_frame_set_sample_rate(AVFrame *frame, int val)
Encoding parameters for a video frame, as described by AVVideoEncParams.
Definition: frame.h:186
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:605
Recommmends skipping the specified number of samples.
Definition: frame.h:108
ReplayGain information in the form of the AVReplayGain struct.
Definition: frame.h:76
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:361
attribute_deprecated int8_t * av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
Definition: frame.c:91
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:629
attribute_deprecated int av_frame_get_decode_error_flags(const AVFrame *frame)
Stereoscopic 3d metadata.
Definition: frame.h:63
static double val(void *priv, double ch)
Definition: aeval.c:76
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:380
The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
Definition: frame.h:67
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:658
Raw QP table data.
Definition: frame.h:159