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