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  *
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 
20 /**
21  * @file
22  * @ingroup lavu_frame
23  * reference-counted frame API
24  */
25 
26 #ifndef AVUTIL_FRAME_H
27 #define AVUTIL_FRAME_H
28 
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 
135 };
136 
137 
138 /**
139  * Structure to hold side data for an AVFrame.
140  *
141  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
142  * to the end with a minor bump.
143  */
144 typedef struct AVFrameSideData {
147  int size;
151 
152 /**
153  * This structure describes decoded (raw) audio or video data.
154  *
155  * AVFrame must be allocated using av_frame_alloc(). Note that this only
156  * allocates the AVFrame itself, the buffers for the data must be managed
157  * through other means (see below).
158  * AVFrame must be freed with av_frame_free().
159  *
160  * AVFrame is typically allocated once and then reused multiple times to hold
161  * different data (e.g. a single AVFrame to hold frames received from a
162  * decoder). In such a case, av_frame_unref() will free any references held by
163  * the frame and reset it to its original clean state before it
164  * is reused again.
165  *
166  * The data described by an AVFrame is usually reference counted through the
167  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
168  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
169  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
170  * every single data plane must be contained in one of the buffers in
171  * AVFrame.buf or AVFrame.extended_buf.
172  * There may be a single buffer for all the data, or one separate buffer for
173  * each plane, or anything in between.
174  *
175  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
176  * to the end with a minor bump.
177  * Similarly fields that are marked as to be only accessed by
178  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
179  * without breaking compatibility with each other.
180  */
181 typedef struct AVFrame {
182 #define AV_NUM_DATA_POINTERS 8
183  /**
184  * pointer to the picture/channel planes.
185  * This might be different from the first allocated byte
186  *
187  * Some decoders access areas outside 0,0 - width,height, please
188  * see avcodec_align_dimensions2(). Some filters and swscale can read
189  * up to 16 bytes beyond the planes, if these filters are to be used,
190  * then 16 extra bytes must be allocated.
191  */
193 
194  /**
195  * For video, size in bytes of each picture line.
196  * For audio, size in bytes of each plane.
197  *
198  * For audio, only linesize[0] may be set. For planar audio, each channel
199  * plane must be the same size.
200  *
201  * For video the linesizes should be multiples of the CPUs alignment
202  * preference, this is 16 or 32 for modern desktop CPUs.
203  * Some code requires such alignment other code can be slower without
204  * correct alignment, for yet other it makes no difference.
205  *
206  * @note The linesize may be larger than the size of usable data -- there
207  * may be extra padding present for performance reasons.
208  */
210 
211  /**
212  * pointers to the data planes/channels.
213  *
214  * For video, this should simply point to data[].
215  *
216  * For planar audio, each channel has a separate data pointer, and
217  * linesize[0] contains the size of each channel buffer.
218  * For packed audio, there is just one data pointer, and linesize[0]
219  * contains the total size of the buffer for all channels.
220  *
221  * Note: Both data and extended_data should always be set in a valid frame,
222  * but for planar audio with more channels that can fit in data,
223  * extended_data must be used in order to access all channels.
224  */
226 
227  /**
228  * width and height of the video frame
229  */
230  int width, height;
231 
232  /**
233  * number of audio samples (per channel) described by this frame
234  */
236 
237  /**
238  * format of the frame, -1 if unknown or unset
239  * Values correspond to enum AVPixelFormat for video frames,
240  * enum AVSampleFormat for audio)
241  */
242  int format;
243 
244  /**
245  * 1 -> keyframe, 0-> not
246  */
248 
249  /**
250  * Picture type of the frame.
251  */
253 
254  /**
255  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
256  */
258 
259  /**
260  * Presentation timestamp in time_base units (time when frame should be shown to user).
261  */
262  int64_t pts;
263 
264  /**
265  * PTS copied from the AVPacket that was decoded to produce this frame.
266  */
267  int64_t pkt_pts;
268 
269  /**
270  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
271  * This is also the Presentation time of this AVFrame calculated from
272  * only AVPacket.dts values without pts values.
273  */
274  int64_t pkt_dts;
275 
276  /**
277  * picture number in bitstream order
278  */
280  /**
281  * picture number in display order
282  */
284 
285  /**
286  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
287  */
288  int quality;
289 
290  /**
291  * for some private data of the user
292  */
293  void *opaque;
294 
295 #if FF_API_ERROR_FRAME
296  /**
297  * @deprecated unused
298  */
301 #endif
302 
303  /**
304  * When decoding, this signals how much the picture must be delayed.
305  * extra_delay = repeat_pict / (2*fps)
306  */
308 
309  /**
310  * The content of the picture is interlaced.
311  */
313 
314  /**
315  * If the content is interlaced, is top field displayed first.
316  */
318 
319  /**
320  * Tell user application that palette has changed from previous frame.
321  */
323 
324  /**
325  * reordered opaque 64bit (generally an integer or a double precision float
326  * PTS but can be anything).
327  * The user sets AVCodecContext.reordered_opaque to represent the input at
328  * that time,
329  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
330  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
331  * @deprecated in favor of pkt_pts
332  */
334 
335  /**
336  * Sample rate of the audio data.
337  */
339 
340  /**
341  * Channel layout of the audio data.
342  */
343  uint64_t channel_layout;
344 
345  /**
346  * AVBuffer references backing the data for this frame. If all elements of
347  * this array are NULL, then this frame is not reference counted. This array
348  * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
349  * also be non-NULL for all j < i.
350  *
351  * There may be at most one AVBuffer per data plane, so for video this array
352  * always contains all the references. For planar audio with more than
353  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
354  * this array. Then the extra AVBufferRef pointers are stored in the
355  * extended_buf array.
356  */
358 
359  /**
360  * For planar audio which requires more than AV_NUM_DATA_POINTERS
361  * AVBufferRef pointers, this array will hold all the references which
362  * cannot fit into AVFrame.buf.
363  *
364  * Note that this is different from AVFrame.extended_data, which always
365  * contains all the pointers. This array only contains the extra pointers,
366  * which cannot fit into AVFrame.buf.
367  *
368  * This array is always allocated using av_malloc() by whoever constructs
369  * the frame. It is freed in av_frame_unref().
370  */
372  /**
373  * Number of elements in extended_buf.
374  */
376 
379 
380 /**
381  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
382  * Flags describing additional frame properties.
383  *
384  * @{
385  */
386 
387 /**
388  * The frame data may be corrupted, e.g. due to decoding errors.
389  */
390 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
391 /**
392  * @}
393  */
394 
395  /**
396  * Frame flags, a combination of @ref lavu_frame_flags
397  */
398  int flags;
399 
400  /**
401  * MPEG vs JPEG YUV range.
402  * It must be accessed using av_frame_get_color_range() and
403  * av_frame_set_color_range().
404  * - encoding: Set by user
405  * - decoding: Set by libavcodec
406  */
408 
410 
412 
413  /**
414  * YUV colorspace type.
415  * It must be accessed using av_frame_get_colorspace() and
416  * av_frame_set_colorspace().
417  * - encoding: Set by user
418  * - decoding: Set by libavcodec
419  */
421 
423 
424  /**
425  * frame timestamp estimated using various heuristics, in stream time base
426  * Code outside libavutil should access this field using:
427  * av_frame_get_best_effort_timestamp(frame)
428  * - encoding: unused
429  * - decoding: set by libavcodec, read by user.
430  */
432 
433  /**
434  * reordered pos from the last AVPacket that has been input into the decoder
435  * Code outside libavutil should access this field using:
436  * av_frame_get_pkt_pos(frame)
437  * - encoding: unused
438  * - decoding: Read by user.
439  */
440  int64_t pkt_pos;
441 
442  /**
443  * duration of the corresponding packet, expressed in
444  * AVStream->time_base units, 0 if unknown.
445  * Code outside libavutil should access this field using:
446  * av_frame_get_pkt_duration(frame)
447  * - encoding: unused
448  * - decoding: Read by user.
449  */
450  int64_t pkt_duration;
451 
452  /**
453  * metadata.
454  * Code outside libavutil should access this field using:
455  * av_frame_get_metadata(frame)
456  * - encoding: Set by user.
457  * - decoding: Set by libavcodec.
458  */
460 
461  /**
462  * decode error flags of the frame, set to a combination of
463  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
464  * were errors during the decoding.
465  * Code outside libavutil should access this field using:
466  * av_frame_get_decode_error_flags(frame)
467  * - encoding: unused
468  * - decoding: set by libavcodec, read by user.
469  */
471 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
472 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
473 
474  /**
475  * number of audio channels, only used for audio.
476  * Code outside libavutil should access this field using:
477  * av_frame_get_channels(frame)
478  * - encoding: unused
479  * - decoding: Read by user.
480  */
481  int channels;
482 
483  /**
484  * size of the corresponding packet containing the compressed
485  * frame. It must be accessed using av_frame_get_pkt_size() and
486  * av_frame_set_pkt_size().
487  * It is set to a negative value if unknown.
488  * - encoding: unused
489  * - decoding: set by libavcodec, read by user.
490  */
491  int pkt_size;
492 
493 #if FF_API_FRAME_QP
494  /**
495  * QP table
496  * Not to be accessed directly from outside libavutil
497  */
499  int8_t *qscale_table;
500  /**
501  * QP store stride
502  * Not to be accessed directly from outside libavutil
503  */
505  int qstride;
506 
509 
510  /**
511  * Not to be accessed directly from outside libavutil
512  */
514 #endif
515 } AVFrame;
516 
517 /**
518  * Accessors for some AVFrame fields.
519  * The position of these field in the structure is not part of the ABI,
520  * they should not be accessed directly outside libavutil.
521  */
524 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
525 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
526 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
527 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
528 int64_t av_frame_get_channel_layout (const AVFrame *frame);
530 int av_frame_get_channels (const AVFrame *frame);
541 #if FF_API_FRAME_QP
542 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
544 #endif
549 
550 /**
551  * Get the name of a colorspace.
552  * @return a static string identifying the colorspace; can be NULL.
553  */
554 const char *av_get_colorspace_name(enum AVColorSpace val);
555 
556 /**
557  * Allocate an AVFrame and set its fields to default values. The resulting
558  * struct must be freed using av_frame_free().
559  *
560  * @return An AVFrame filled with default values or NULL on failure.
561  *
562  * @note this only allocates the AVFrame itself, not the data buffers. Those
563  * must be allocated through other means, e.g. with av_frame_get_buffer() or
564  * manually.
565  */
566 AVFrame *av_frame_alloc(void);
567 
568 /**
569  * Free the frame and any dynamically allocated objects in it,
570  * e.g. extended_data. If the frame is reference counted, it will be
571  * unreferenced first.
572  *
573  * @param frame frame to be freed. The pointer will be set to NULL.
574  */
575 void av_frame_free(AVFrame **frame);
576 
577 /**
578  * Set up a new reference to the data described by the source frame.
579  *
580  * Copy frame properties from src to dst and create a new reference for each
581  * AVBufferRef from src.
582  *
583  * If src is not reference counted, new buffers are allocated and the data is
584  * copied.
585  *
586  * @return 0 on success, a negative AVERROR on error
587  */
588 int av_frame_ref(AVFrame *dst, const AVFrame *src);
589 
590 /**
591  * Create a new frame that references the same data as src.
592  *
593  * This is a shortcut for av_frame_alloc()+av_frame_ref().
594  *
595  * @return newly created AVFrame on success, NULL on error.
596  */
598 
599 /**
600  * Unreference all the buffers referenced by frame and reset the frame fields.
601  */
603 
604 /**
605  * Move everything contained in src to dst and reset src.
606  */
607 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
608 
609 /**
610  * Allocate new buffer(s) for audio or video data.
611  *
612  * The following fields must be set on frame before calling this function:
613  * - format (pixel format for video, sample format for audio)
614  * - width and height for video
615  * - nb_samples and channel_layout for audio
616  *
617  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
618  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
619  * For planar formats, one buffer will be allocated for each plane.
620  *
621  * @param frame frame in which to store the new buffers.
622  * @param align required buffer size alignment
623  *
624  * @return 0 on success, a negative AVERROR on error.
625  */
627 
628 /**
629  * Check if the frame data is writable.
630  *
631  * @return A positive value if the frame data is writable (which is true if and
632  * only if each of the underlying buffers has only one reference, namely the one
633  * stored in this frame). Return 0 otherwise.
634  *
635  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
636  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
637  *
638  * @see av_frame_make_writable(), av_buffer_is_writable()
639  */
641 
642 /**
643  * Ensure that the frame data is writable, avoiding data copy if possible.
644  *
645  * Do nothing if the frame is writable, allocate new buffers and copy the data
646  * if it is not.
647  *
648  * @return 0 on success, a negative AVERROR on error.
649  *
650  * @see av_frame_is_writable(), av_buffer_is_writable(),
651  * av_buffer_make_writable()
652  */
654 
655 /**
656  * Copy the frame data from src to dst.
657  *
658  * This function does not allocate anything, dst must be already initialized and
659  * allocated with the same parameters as src.
660  *
661  * This function only copies the frame data (i.e. the contents of the data /
662  * extended data arrays), not any other properties.
663  *
664  * @return >= 0 on success, a negative AVERROR on error.
665  */
666 int av_frame_copy(AVFrame *dst, const AVFrame *src);
667 
668 /**
669  * Copy only "metadata" fields from src to dst.
670  *
671  * Metadata for the purpose of this function are those fields that do not affect
672  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
673  * aspect ratio (for video), but not width/height or channel layout.
674  * Side data is also copied.
675  */
676 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
677 
678 /**
679  * Get the buffer reference a given data plane is stored in.
680  *
681  * @param plane index of the data plane of interest in frame->extended_data.
682  *
683  * @return the buffer reference that contains the plane or NULL if the input
684  * frame is not valid.
685  */
687 
688 /**
689  * Add a new side data to a frame.
690  *
691  * @param frame a frame to which the side data should be added
692  * @param type type of the added side data
693  * @param size size of the side data
694  *
695  * @return newly added side data on success, NULL on error
696  */
699  int size);
700 
701 /**
702  * @return a pointer to the side data of a given type on success, NULL if there
703  * is no side data with such type in this frame.
704  */
707 
708 /**
709  * If side data of the supplied type exists in the frame, free it and remove it
710  * from the frame.
711  */
713 
714 /**
715  * @return a string identifying the side data type
716  */
718 
719 /**
720  * @}
721  */
722 
723 #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:182
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:181
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:113
attribute_deprecated int qscale_type
Definition: frame.h:508
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder Code outside libavutil shou...
Definition: frame.h:440
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:357
AVDictionary * metadata
Definition: frame.h:148
void * opaque
for some private data of the user
Definition: frame.h:293
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:375
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:307
int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
Definition: frame.c:50
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:119
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:495
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:65
attribute_deprecated int8_t * qscale_table
QP table Not to be accessed directly from outside libavutil.
Definition: frame.h:499
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:395
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:636
Public dictionary API.
uint8_t
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:141
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:420
attribute_deprecated int qstride
QP store stride Not to be accessed directly from outside libavutil.
Definition: frame.h:505
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:262
AVBufferRef * buf
Definition: frame.h:149
The data is the AVPanScan struct defined in libavcodec.
Definition: frame.h:52
static AVFrame * frame
Structure to hold side data for an AVFrame.
Definition: frame.h:144
void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
AVDictionary * metadata
metadata.
Definition: frame.h:459
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:312
void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:440
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:376
Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVAc...
Definition: frame.h:89
Metadata relevant to a downmix procedure.
Definition: frame.h:72
int nb_side_data
Definition: frame.h:378
attribute_deprecated uint64_t error[AV_NUM_DATA_POINTERS]
Definition: frame.h:300
AVFrameSideData ** side_data
Definition: frame.h:377
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:230
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:154
void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:407
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:58
int av_frame_get_decode_error_flags(const AVFrame *frame)
enum AVColorSpace colorspace
YUV colorspace type.
Definition: frame.h:420
Libavutil version macros.
The GOP timecode in 25 bit timecode format.
Definition: frame.h:124
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:694
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:343
int channels
number of audio channels, only used for audio.
Definition: frame.h:481
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:252
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:398
int display_picture_number
picture number in display order
Definition: frame.h:283
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:371
Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec A...
Definition: frame.h:96
AVBufferRef * av_frame_get_plane_buffer(AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
Definition: frame.c:569
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:513
AVFrameSideDataType
Definition: frame.h:48
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:288
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
Definition: frame.c:79
#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:460
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:242
int coded_picture_number
picture number in bitstream order
Definition: frame.h:279
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown...
Definition: frame.h:450
AVDictionary ** avpriv_frame_get_metadatap(AVFrame *frame)
Definition: frame.c:47
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
Definition: frame.h:84
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:504
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:209
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:257
uint8_t * data
Definition: frame.h:146
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:707
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:333
enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
int sample_rate
Sample rate of the audio data.
Definition: frame.h:338
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:600
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:322
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:422
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base Code outside libavutil should...
Definition: frame.h:431
AVActiveFormatDescription
Definition: frame.h:127
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:470
int64_t av_frame_get_channel_layout(const AVFrame *frame)
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:721
int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
Definition: frame.h:267
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:271
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:473
enum AVFrameSideDataType type
Definition: frame.h:145
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:521
#define attribute_deprecated
Definition: attributes.h:94
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:274
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:317
int64_t av_frame_get_pkt_pos(const AVFrame *frame)
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:247
void av_frame_set_sample_rate(AVFrame *frame, int val)
enum AVColorPrimaries color_primaries
Definition: frame.h:409
int height
Definition: frame.h:230
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:462
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:411
Recommmends skipping the specified number of samples.
Definition: frame.h:108
ReplayGain information in the form of the AVReplayGain struct.
Definition: frame.h:76
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:225
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:491
Stereoscopic 3d metadata.
Definition: frame.h:63
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:235
The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
Definition: frame.h:67
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:564