FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 <stdint.h>
29 
30 #include "avutil.h"
31 #include "buffer.h"
32 #include "dict.h"
33 #include "rational.h"
34 #include "samplefmt.h"
35 #include "pixfmt.h"
36 #include "version.h"
37 
38 
39 /**
40  * @defgroup lavu_frame AVFrame
41  * @ingroup lavu_data
42  *
43  * @{
44  * AVFrame is an abstraction for reference-counted raw multimedia data.
45  */
46 
48  /**
49  * The data is the AVPanScan struct defined in libavcodec.
50  */
52  /**
53  * ATSC A53 Part 4 Closed Captions.
54  * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
55  * The number of bytes of CC data is AVFrameSideData.size.
56  */
58  /**
59  * Stereoscopic 3d metadata.
60  * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
61  */
63  /**
64  * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
65  */
67  /**
68  * Metadata relevant to a downmix procedure.
69  * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
70  */
72  /**
73  * ReplayGain information in the form of the AVReplayGain struct.
74  */
76  /**
77  * This side data contains a 3x3 transformation matrix describing an affine
78  * transformation that needs to be applied to the frame for correct
79  * presentation.
80  *
81  * See libavutil/display.h for a detailed description of the data.
82  */
84  /**
85  * Active Format Description data consisting of a single byte as specified
86  * in ETSI TS 101 154 using AVActiveFormatDescription enum.
87  */
89  /**
90  * Motion vectors exported by some codecs (on demand through the export_mvs
91  * flag set in the libavcodec AVCodecContext flags2 option).
92  * The data is the AVMotionVector struct defined in
93  * libavutil/motion_vector.h.
94  */
96  /**
97  * Recommmends skipping the specified number of samples. This is exported
98  * only if the "skip_manual" AVOption is set in libavcodec.
99  * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
100  * @code
101  * u32le number of samples to skip from start of this packet
102  * u32le number of samples to skip from end of this packet
103  * u8 reason for start skip
104  * u8 reason for end skip (0=padding silence, 1=convergence)
105  * @endcode
106  */
108  /**
109  * This side data must be associated with an audio frame and corresponds to
110  * enum AVAudioServiceType defined in avcodec.h.
111  */
113  /**
114  * Mastering display metadata associated with a video frame. The payload is
115  * an AVMasteringDisplayMetadata type and contains information about the
116  * mastering display color volume.
117  */
119  /**
120  * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
121  * This is set on the first frame of a GOP that has a temporal reference of 0.
122  */
124 };
125 
134 };
135 
136 
137 /**
138  * Structure to hold side data for an AVFrame.
139  *
140  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
141  * to the end with a minor bump.
142  */
143 typedef struct AVFrameSideData {
146  int size;
150 
151 /**
152  * This structure describes decoded (raw) audio or video data.
153  *
154  * AVFrame must be allocated using av_frame_alloc(). Note that this only
155  * allocates the AVFrame itself, the buffers for the data must be managed
156  * through other means (see below).
157  * AVFrame must be freed with av_frame_free().
158  *
159  * AVFrame is typically allocated once and then reused multiple times to hold
160  * different data (e.g. a single AVFrame to hold frames received from a
161  * decoder). In such a case, av_frame_unref() will free any references held by
162  * the frame and reset it to its original clean state before it
163  * is reused again.
164  *
165  * The data described by an AVFrame is usually reference counted through the
166  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
167  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
168  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
169  * every single data plane must be contained in one of the buffers in
170  * AVFrame.buf or AVFrame.extended_buf.
171  * There may be a single buffer for all the data, or one separate buffer for
172  * each plane, or anything in between.
173  *
174  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
175  * to the end with a minor bump.
176  * Similarly fields that are marked as to be only accessed by
177  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
178  * without breaking compatibility with each other.
179  */
180 typedef struct AVFrame {
181 #define AV_NUM_DATA_POINTERS 8
182  /**
183  * pointer to the picture/channel planes.
184  * This might be different from the first allocated byte
185  *
186  * Some decoders access areas outside 0,0 - width,height, please
187  * see avcodec_align_dimensions2(). Some filters and swscale can read
188  * up to 16 bytes beyond the planes, if these filters are to be used,
189  * then 16 extra bytes must be allocated.
190  *
191  * NOTE: Except for hwaccel formats, pointers not needed by the format
192  * MUST be set to NULL.
193  */
195 
196  /**
197  * For video, size in bytes of each picture line.
198  * For audio, size in bytes of each plane.
199  *
200  * For audio, only linesize[0] may be set. For planar audio, each channel
201  * plane must be the same size.
202  *
203  * For video the linesizes should be multiples of the CPUs alignment
204  * preference, this is 16 or 32 for modern desktop CPUs.
205  * Some code requires such alignment other code can be slower without
206  * correct alignment, for yet other it makes no difference.
207  *
208  * @note The linesize may be larger than the size of usable data -- there
209  * may be extra padding present for performance reasons.
210  */
212 
213  /**
214  * pointers to the data planes/channels.
215  *
216  * For video, this should simply point to data[].
217  *
218  * For planar audio, each channel has a separate data pointer, and
219  * linesize[0] contains the size of each channel buffer.
220  * For packed audio, there is just one data pointer, and linesize[0]
221  * contains the total size of the buffer for all channels.
222  *
223  * Note: Both data and extended_data should always be set in a valid frame,
224  * but for planar audio with more channels that can fit in data,
225  * extended_data must be used in order to access all channels.
226  */
228 
229  /**
230  * width and height of the video frame
231  */
232  int width, height;
233 
234  /**
235  * number of audio samples (per channel) described by this frame
236  */
238 
239  /**
240  * format of the frame, -1 if unknown or unset
241  * Values correspond to enum AVPixelFormat for video frames,
242  * enum AVSampleFormat for audio)
243  */
244  int format;
245 
246  /**
247  * 1 -> keyframe, 0-> not
248  */
250 
251  /**
252  * Picture type of the frame.
253  */
255 
256  /**
257  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
258  */
260 
261  /**
262  * Presentation timestamp in time_base units (time when frame should be shown to user).
263  */
264  int64_t pts;
265 
266  /**
267  * PTS copied from the AVPacket that was decoded to produce this frame.
268  */
269  int64_t pkt_pts;
270 
271  /**
272  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
273  * This is also the Presentation time of this AVFrame calculated from
274  * only AVPacket.dts values without pts values.
275  */
276  int64_t pkt_dts;
277 
278  /**
279  * picture number in bitstream order
280  */
282  /**
283  * picture number in display order
284  */
286 
287  /**
288  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
289  */
290  int quality;
291 
292  /**
293  * for some private data of the user
294  */
295  void *opaque;
296 
297 #if FF_API_ERROR_FRAME
298  /**
299  * @deprecated unused
300  */
303 #endif
304 
305  /**
306  * When decoding, this signals how much the picture must be delayed.
307  * extra_delay = repeat_pict / (2*fps)
308  */
310 
311  /**
312  * The content of the picture is interlaced.
313  */
315 
316  /**
317  * If the content is interlaced, is top field displayed first.
318  */
320 
321  /**
322  * Tell user application that palette has changed from previous frame.
323  */
325 
326  /**
327  * reordered opaque 64bit (generally an integer or a double precision float
328  * PTS but can be anything).
329  * The user sets AVCodecContext.reordered_opaque to represent the input at
330  * that time,
331  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
332  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
333  * @deprecated in favor of pkt_pts
334  */
336 
337  /**
338  * Sample rate of the audio data.
339  */
341 
342  /**
343  * Channel layout of the audio data.
344  */
345  uint64_t channel_layout;
346 
347  /**
348  * AVBuffer references backing the data for this frame. If all elements of
349  * this array are NULL, then this frame is not reference counted. This array
350  * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
351  * also be non-NULL for all j < i.
352  *
353  * There may be at most one AVBuffer per data plane, so for video this array
354  * always contains all the references. For planar audio with more than
355  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
356  * this array. Then the extra AVBufferRef pointers are stored in the
357  * extended_buf array.
358  */
360 
361  /**
362  * For planar audio which requires more than AV_NUM_DATA_POINTERS
363  * AVBufferRef pointers, this array will hold all the references which
364  * cannot fit into AVFrame.buf.
365  *
366  * Note that this is different from AVFrame.extended_data, which always
367  * contains all the pointers. This array only contains the extra pointers,
368  * which cannot fit into AVFrame.buf.
369  *
370  * This array is always allocated using av_malloc() by whoever constructs
371  * the frame. It is freed in av_frame_unref().
372  */
374  /**
375  * Number of elements in extended_buf.
376  */
378 
381 
382 /**
383  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
384  * Flags describing additional frame properties.
385  *
386  * @{
387  */
388 
389 /**
390  * The frame data may be corrupted, e.g. due to decoding errors.
391  */
392 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
393 /**
394  * @}
395  */
396 
397  /**
398  * Frame flags, a combination of @ref lavu_frame_flags
399  */
400  int flags;
401 
402  /**
403  * MPEG vs JPEG YUV range.
404  * It must be accessed using av_frame_get_color_range() and
405  * av_frame_set_color_range().
406  * - encoding: Set by user
407  * - decoding: Set by libavcodec
408  */
410 
412 
414 
415  /**
416  * YUV colorspace type.
417  * It must be accessed using av_frame_get_colorspace() and
418  * av_frame_set_colorspace().
419  * - encoding: Set by user
420  * - decoding: Set by libavcodec
421  */
423 
425 
426  /**
427  * For hwaccel-format frames, this should be a reference to the
428  * AVHWFramesContext describing the frame.
429  */
431 
432  /**
433  * frame timestamp estimated using various heuristics, in stream time base
434  * Code outside libavutil should access this field using:
435  * av_frame_get_best_effort_timestamp(frame)
436  * - encoding: unused
437  * - decoding: set by libavcodec, read by user.
438  */
440 
441  /**
442  * reordered pos from the last AVPacket that has been input into the decoder
443  * Code outside libavutil should access this field using:
444  * av_frame_get_pkt_pos(frame)
445  * - encoding: unused
446  * - decoding: Read by user.
447  */
448  int64_t pkt_pos;
449 
450  /**
451  * duration of the corresponding packet, expressed in
452  * AVStream->time_base units, 0 if unknown.
453  * Code outside libavutil should access this field using:
454  * av_frame_get_pkt_duration(frame)
455  * - encoding: unused
456  * - decoding: Read by user.
457  */
458  int64_t pkt_duration;
459 
460  /**
461  * metadata.
462  * Code outside libavutil should access this field using:
463  * av_frame_get_metadata(frame)
464  * - encoding: Set by user.
465  * - decoding: Set by libavcodec.
466  */
468 
469  /**
470  * decode error flags of the frame, set to a combination of
471  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
472  * were errors during the decoding.
473  * Code outside libavutil should access this field using:
474  * av_frame_get_decode_error_flags(frame)
475  * - encoding: unused
476  * - decoding: set by libavcodec, read by user.
477  */
479 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
480 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
481 
482  /**
483  * number of audio channels, only used for audio.
484  * Code outside libavutil should access this field using:
485  * av_frame_get_channels(frame)
486  * - encoding: unused
487  * - decoding: Read by user.
488  */
489  int channels;
490 
491  /**
492  * size of the corresponding packet containing the compressed
493  * frame. It must be accessed using av_frame_get_pkt_size() and
494  * av_frame_set_pkt_size().
495  * It is set to a negative value if unknown.
496  * - encoding: unused
497  * - decoding: set by libavcodec, read by user.
498  */
499  int pkt_size;
500 
501 #if FF_API_FRAME_QP
502  /**
503  * QP table
504  * Not to be accessed directly from outside libavutil
505  */
507  int8_t *qscale_table;
508  /**
509  * QP store stride
510  * Not to be accessed directly from outside libavutil
511  */
513  int qstride;
514 
517 
518  /**
519  * Not to be accessed directly from outside libavutil
520  */
522 #endif
523 } AVFrame;
524 
525 /**
526  * Accessors for some AVFrame fields.
527  * The position of these field in the structure is not part of the ABI,
528  * they should not be accessed directly outside libavutil.
529  */
532 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
533 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
534 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
535 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
536 int64_t av_frame_get_channel_layout (const AVFrame *frame);
538 int av_frame_get_channels (const AVFrame *frame);
549 #if FF_API_FRAME_QP
550 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
552 #endif
557 
558 /**
559  * Get the name of a colorspace.
560  * @return a static string identifying the colorspace; can be NULL.
561  */
562 const char *av_get_colorspace_name(enum AVColorSpace val);
563 
564 /**
565  * Allocate an AVFrame and set its fields to default values. The resulting
566  * struct must be freed using av_frame_free().
567  *
568  * @return An AVFrame filled with default values or NULL on failure.
569  *
570  * @note this only allocates the AVFrame itself, not the data buffers. Those
571  * must be allocated through other means, e.g. with av_frame_get_buffer() or
572  * manually.
573  */
574 AVFrame *av_frame_alloc(void);
575 
576 /**
577  * Free the frame and any dynamically allocated objects in it,
578  * e.g. extended_data. If the frame is reference counted, it will be
579  * unreferenced first.
580  *
581  * @param frame frame to be freed. The pointer will be set to NULL.
582  */
583 void av_frame_free(AVFrame **frame);
584 
585 /**
586  * Set up a new reference to the data described by the source frame.
587  *
588  * Copy frame properties from src to dst and create a new reference for each
589  * AVBufferRef from src.
590  *
591  * If src is not reference counted, new buffers are allocated and the data is
592  * copied.
593  *
594  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
595  * or newly allocated with av_frame_alloc() before calling this
596  * function, or undefined behavior will occur.
597  *
598  * @return 0 on success, a negative AVERROR on error
599  */
600 int av_frame_ref(AVFrame *dst, const AVFrame *src);
601 
602 /**
603  * Create a new frame that references the same data as src.
604  *
605  * This is a shortcut for av_frame_alloc()+av_frame_ref().
606  *
607  * @return newly created AVFrame on success, NULL on error.
608  */
610 
611 /**
612  * Unreference all the buffers referenced by frame and reset the frame fields.
613  */
615 
616 /**
617  * Move everything contained in src to dst and reset src.
618  *
619  * @warning: dst is not unreferenced, but directly overwritten without reading
620  * or deallocating its contents. Call av_frame_unref(dst) manually
621  * before calling this function to ensure that no memory is leaked.
622  */
623 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
624 
625 /**
626  * Allocate new buffer(s) for audio or video data.
627  *
628  * The following fields must be set on frame before calling this function:
629  * - format (pixel format for video, sample format for audio)
630  * - width and height for video
631  * - nb_samples and channel_layout for audio
632  *
633  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
634  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
635  * For planar formats, one buffer will be allocated for each plane.
636  *
637  * @warning: if frame already has been allocated, calling this function will
638  * leak memory. In addition, undefined behavior can occur in certain
639  * cases.
640  *
641  * @param frame frame in which to store the new buffers.
642  * @param align required buffer size alignment
643  *
644  * @return 0 on success, a negative AVERROR on error.
645  */
647 
648 /**
649  * Check if the frame data is writable.
650  *
651  * @return A positive value if the frame data is writable (which is true if and
652  * only if each of the underlying buffers has only one reference, namely the one
653  * stored in this frame). Return 0 otherwise.
654  *
655  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
656  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
657  *
658  * @see av_frame_make_writable(), av_buffer_is_writable()
659  */
661 
662 /**
663  * Ensure that the frame data is writable, avoiding data copy if possible.
664  *
665  * Do nothing if the frame is writable, allocate new buffers and copy the data
666  * if it is not.
667  *
668  * @return 0 on success, a negative AVERROR on error.
669  *
670  * @see av_frame_is_writable(), av_buffer_is_writable(),
671  * av_buffer_make_writable()
672  */
674 
675 /**
676  * Copy the frame data from src to dst.
677  *
678  * This function does not allocate anything, dst must be already initialized and
679  * allocated with the same parameters as src.
680  *
681  * This function only copies the frame data (i.e. the contents of the data /
682  * extended data arrays), not any other properties.
683  *
684  * @return >= 0 on success, a negative AVERROR on error.
685  */
686 int av_frame_copy(AVFrame *dst, const AVFrame *src);
687 
688 /**
689  * Copy only "metadata" fields from src to dst.
690  *
691  * Metadata for the purpose of this function are those fields that do not affect
692  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
693  * aspect ratio (for video), but not width/height or channel layout.
694  * Side data is also copied.
695  */
696 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
697 
698 /**
699  * Get the buffer reference a given data plane is stored in.
700  *
701  * @param plane index of the data plane of interest in frame->extended_data.
702  *
703  * @return the buffer reference that contains the plane or NULL if the input
704  * frame is not valid.
705  */
707 
708 /**
709  * Add a new side data to a frame.
710  *
711  * @param frame a frame to which the side data should be added
712  * @param type type of the added side data
713  * @param size size of the side data
714  *
715  * @return newly added side data on success, NULL on error
716  */
719  int size);
720 
721 /**
722  * @return a pointer to the side data of a given type on success, NULL if there
723  * is no side data with such type in this frame.
724  */
727 
728 /**
729  * If side data of the supplied type exists in the frame, free it and remove it
730  * from the frame.
731  */
733 
734 /**
735  * @return a string identifying the side data type
736  */
738 
739 /**
740  * @}
741  */
742 
743 #endif /* AVUTIL_FRAME_H */
int plane
Definition: avisynth_c.h:291
void av_frame_set_channels(AVFrame *frame, int val)
const char const char void * val
Definition: avisynth_c.h:634
int av_frame_get_sample_rate(const AVFrame *frame)
#define AV_NUM_DATA_POINTERS
Definition: frame.h:181
int64_t av_frame_get_pkt_duration(const AVFrame *frame)
int av_frame_get_pkt_size(const AVFrame *frame)
This structure describes decoded (raw) audio or video data.
Definition: frame.h:180
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defi...
Definition: frame.h:112
attribute_deprecated int qscale_type
Definition: frame.h:516
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder Code outside libavutil shou...
Definition: frame.h:448
enum AVColorRange av_frame_get_color_range(const AVFrame *frame)
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:359
AVDictionary * metadata
Definition: frame.h:147
void * opaque
for some private data of the user
Definition: frame.h:295
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:377
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:309
int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
Definition: frame.c:49
external API header
void av_frame_set_pkt_duration(AVFrame *frame, int64_t val)
Mastering display metadata associated with a video frame.
Definition: frame.h:118
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:505
void av_frame_set_pkt_size(AVFrame *frame, int val)
int8_t * av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
Definition: frame.c:64
attribute_deprecated int8_t * qscale_table
QP table Not to be accessed directly from outside libavutil.
Definition: frame.h:507
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:404
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:646
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:430
Public dictionary API.
uint8_t
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:140
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:429
attribute_deprecated int qstride
QP store stride Not to be accessed directly from outside libavutil.
Definition: frame.h:513
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:374
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:264
AVBufferRef * buf
Definition: frame.h:148
The data is the AVPanScan struct defined in libavcodec.
Definition: frame.h:51
static AVFrame * frame
Structure to hold side data for an AVFrame.
Definition: frame.h:143
void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
AVDictionary * metadata
metadata.
Definition: frame.h:467
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:314
void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:449
ptrdiff_t size
Definition: opengl_enc.c:101
int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame)
Accessors for some AVFrame fields.
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:385
Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVAc...
Definition: frame.h:88
Metadata relevant to a downmix procedure.
Definition: frame.h:71
int nb_side_data
Definition: frame.h:380
attribute_deprecated uint64_t error[AV_NUM_DATA_POINTERS]
Definition: frame.h:302
AVFrameSideData ** side_data
Definition: frame.h:379
void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val)
void av_frame_set_channel_layout(AVFrame *frame, int64_t val)
int width
width and height of the video frame
Definition: frame.h:232
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:153
void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:409
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:57
int av_frame_get_decode_error_flags(const AVFrame *frame)
enum AVColorSpace colorspace
YUV colorspace type.
Definition: frame.h:422
Libavutil version macros.
The GOP timecode in 25 bit timecode format.
Definition: frame.h:123
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:704
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:345
int channels
number of audio channels, only used for audio.
Definition: frame.h:489
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:254
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:400
int display_picture_number
picture number in display order
Definition: frame.h:285
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:373
Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec A...
Definition: frame.h:95
AVBufferRef * av_frame_get_plane_buffer(AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
Definition: frame.c:579
void av_frame_set_pkt_pos(AVFrame *frame, int64_t val)
AVBufferRef * qp_table_buf
Not to be accessed directly from outside libavutil.
Definition: frame.h:521
AVFrameSideDataType
Definition: frame.h:47
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:290
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
Definition: frame.c:78
#define src
Definition: vp9dsp.c:530
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:468
const AVS_VideoInfo int align
Definition: avisynth_c.h:658
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:244
int coded_picture_number
picture number in bitstream order
Definition: frame.h:281
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown...
Definition: frame.h:458
AVDictionary ** avpriv_frame_get_metadatap(AVFrame *frame)
Definition: frame.c:46
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
Definition: frame.h:83
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:514
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:211
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:259
uint8_t * data
Definition: frame.h:145
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...
Definition: frame.c:717
void * buf
Definition: avisynth_c.h:553
GLint GLenum type
Definition: opengl_enc.c:105
AVDictionary * av_frame_get_metadata(const AVFrame *frame)
int64_t reordered_opaque
reordered opaque 64bit (generally an integer or a double precision float PTS but can be anything)...
Definition: frame.h:335
enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
int sample_rate
Sample rate of the audio data.
Definition: frame.h:340
int av_frame_get_channels(const AVFrame *frame)
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, int size)
Add a new side data to a frame.
Definition: frame.c:610
rational number numerator/denominator
Definition: rational.h:43
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:324
refcounted data buffer API
void av_frame_set_decode_error_flags(AVFrame *frame, int val)
AVPictureType
Definition: avutil.h:264
enum AVChromaLocation chroma_location
Definition: frame.h:424
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base Code outside libavutil should...
Definition: frame.h:439
AVActiveFormatDescription
Definition: frame.h:126
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:478
int64_t av_frame_get_channel_layout(const AVFrame *frame)
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:731
int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
Definition: frame.h:269
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:270
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:481
enum AVFrameSideDataType type
Definition: frame.h:144
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:531
#define attribute_deprecated
Definition: attributes.h:94
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:276
A reference to a data buffer.
Definition: buffer.h:81
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:105
rational numbers
pixel format definitions
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:319
int64_t av_frame_get_pkt_pos(const AVFrame *frame)
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:249
void av_frame_set_sample_rate(AVFrame *frame, int val)
enum AVColorPrimaries color_primaries
Definition: frame.h:411
int height
Definition: frame.h:232
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:471
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:413
Recommmends skipping the specified number of samples.
Definition: frame.h:107
ReplayGain information in the form of the AVReplayGain struct.
Definition: frame.h:75
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:227
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:499
Stereoscopic 3d metadata.
Definition: frame.h:62
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:237
The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
Definition: frame.h:66
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:574