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