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  /**
126  * The data represents the AVSphericalMapping structure defined in
127  * libavutil/spherical.h.
128  */
130 };
131 
140 };
141 
142 
143 /**
144  * Structure to hold side data for an AVFrame.
145  *
146  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
147  * to the end with a minor bump.
148  */
149 typedef struct AVFrameSideData {
152  int size;
156 
157 /**
158  * This structure describes decoded (raw) audio or video data.
159  *
160  * AVFrame must be allocated using av_frame_alloc(). Note that this only
161  * allocates the AVFrame itself, the buffers for the data must be managed
162  * through other means (see below).
163  * AVFrame must be freed with av_frame_free().
164  *
165  * AVFrame is typically allocated once and then reused multiple times to hold
166  * different data (e.g. a single AVFrame to hold frames received from a
167  * decoder). In such a case, av_frame_unref() will free any references held by
168  * the frame and reset it to its original clean state before it
169  * is reused again.
170  *
171  * The data described by an AVFrame is usually reference counted through the
172  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
173  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
174  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
175  * every single data plane must be contained in one of the buffers in
176  * AVFrame.buf or AVFrame.extended_buf.
177  * There may be a single buffer for all the data, or one separate buffer for
178  * each plane, or anything in between.
179  *
180  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
181  * to the end with a minor bump.
182  * Similarly fields that are marked as to be only accessed by
183  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
184  * without breaking compatibility with each other.
185  *
186  * Fields can be accessed through AVOptions, the name string used, matches the
187  * C structure field name for fields accessible through AVOptions. The AVClass
188  * for AVFrame can be obtained from avcodec_get_frame_class()
189  */
190 typedef struct AVFrame {
191 #define AV_NUM_DATA_POINTERS 8
192  /**
193  * pointer to the picture/channel planes.
194  * This might be different from the first allocated byte
195  *
196  * Some decoders access areas outside 0,0 - width,height, please
197  * see avcodec_align_dimensions2(). Some filters and swscale can read
198  * up to 16 bytes beyond the planes, if these filters are to be used,
199  * then 16 extra bytes must be allocated.
200  *
201  * NOTE: Except for hwaccel formats, pointers not needed by the format
202  * MUST be set to NULL.
203  */
205 
206  /**
207  * For video, size in bytes of each picture line.
208  * For audio, size in bytes of each plane.
209  *
210  * For audio, only linesize[0] may be set. For planar audio, each channel
211  * plane must be the same size.
212  *
213  * For video the linesizes should be multiples of the CPUs alignment
214  * preference, this is 16 or 32 for modern desktop CPUs.
215  * Some code requires such alignment other code can be slower without
216  * correct alignment, for yet other it makes no difference.
217  *
218  * @note The linesize may be larger than the size of usable data -- there
219  * may be extra padding present for performance reasons.
220  */
222 
223  /**
224  * pointers to the data planes/channels.
225  *
226  * For video, this should simply point to data[].
227  *
228  * For planar audio, each channel has a separate data pointer, and
229  * linesize[0] contains the size of each channel buffer.
230  * For packed audio, there is just one data pointer, and linesize[0]
231  * contains the total size of the buffer for all channels.
232  *
233  * Note: Both data and extended_data should always be set in a valid frame,
234  * but for planar audio with more channels that can fit in data,
235  * extended_data must be used in order to access all channels.
236  */
238 
239  /**
240  * width and height of the video frame
241  */
242  int width, height;
243 
244  /**
245  * number of audio samples (per channel) described by this frame
246  */
248 
249  /**
250  * format of the frame, -1 if unknown or unset
251  * Values correspond to enum AVPixelFormat for video frames,
252  * enum AVSampleFormat for audio)
253  */
254  int format;
255 
256  /**
257  * 1 -> keyframe, 0-> not
258  */
260 
261  /**
262  * Picture type of the frame.
263  */
265 
266  /**
267  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
268  */
270 
271  /**
272  * Presentation timestamp in time_base units (time when frame should be shown to user).
273  */
274  int64_t pts;
275 
276 #if FF_API_PKT_PTS
277  /**
278  * PTS copied from the AVPacket that was decoded to produce this frame.
279  * @deprecated use the pts field instead
280  */
282  int64_t pkt_pts;
283 #endif
284 
285  /**
286  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
287  * This is also the Presentation time of this AVFrame calculated from
288  * only AVPacket.dts values without pts values.
289  */
290  int64_t pkt_dts;
291 
292  /**
293  * picture number in bitstream order
294  */
296  /**
297  * picture number in display order
298  */
300 
301  /**
302  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
303  */
304  int quality;
305 
306  /**
307  * for some private data of the user
308  */
309  void *opaque;
310 
311 #if FF_API_ERROR_FRAME
312  /**
313  * @deprecated unused
314  */
317 #endif
318 
319  /**
320  * When decoding, this signals how much the picture must be delayed.
321  * extra_delay = repeat_pict / (2*fps)
322  */
324 
325  /**
326  * The content of the picture is interlaced.
327  */
329 
330  /**
331  * If the content is interlaced, is top field displayed first.
332  */
334 
335  /**
336  * Tell user application that palette has changed from previous frame.
337  */
339 
340  /**
341  * reordered opaque 64 bits (generally an integer or a double precision float
342  * PTS but can be anything).
343  * The user sets AVCodecContext.reordered_opaque to represent the input at
344  * that time,
345  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
346  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
347  * @deprecated in favor of pkt_pts
348  */
350 
351  /**
352  * Sample rate of the audio data.
353  */
355 
356  /**
357  * Channel layout of the audio data.
358  */
359  uint64_t channel_layout;
360 
361  /**
362  * AVBuffer references backing the data for this frame. If all elements of
363  * this array are NULL, then this frame is not reference counted. This array
364  * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
365  * also be non-NULL for all j < i.
366  *
367  * There may be at most one AVBuffer per data plane, so for video this array
368  * always contains all the references. For planar audio with more than
369  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
370  * this array. Then the extra AVBufferRef pointers are stored in the
371  * extended_buf array.
372  */
374 
375  /**
376  * For planar audio which requires more than AV_NUM_DATA_POINTERS
377  * AVBufferRef pointers, this array will hold all the references which
378  * cannot fit into AVFrame.buf.
379  *
380  * Note that this is different from AVFrame.extended_data, which always
381  * contains all the pointers. This array only contains the extra pointers,
382  * which cannot fit into AVFrame.buf.
383  *
384  * This array is always allocated using av_malloc() by whoever constructs
385  * the frame. It is freed in av_frame_unref().
386  */
388  /**
389  * Number of elements in extended_buf.
390  */
392 
395 
396 /**
397  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
398  * @ingroup lavu_frame
399  * Flags describing additional frame properties.
400  *
401  * @{
402  */
403 
404 /**
405  * The frame data may be corrupted, e.g. due to decoding errors.
406  */
407 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
408 /**
409  * A flag to mark the frames which need to be decoded, but shouldn't be output.
410  */
411 #define AV_FRAME_FLAG_DISCARD (1 << 2)
412 /**
413  * @}
414  */
415 
416  /**
417  * Frame flags, a combination of @ref lavu_frame_flags
418  */
419  int flags;
420 
421  /**
422  * MPEG vs JPEG YUV range.
423  * It must be accessed using av_frame_get_color_range() and
424  * av_frame_set_color_range().
425  * - encoding: Set by user
426  * - decoding: Set by libavcodec
427  */
429 
431 
433 
434  /**
435  * YUV colorspace type.
436  * It must be accessed using av_frame_get_colorspace() and
437  * av_frame_set_colorspace().
438  * - encoding: Set by user
439  * - decoding: Set by libavcodec
440  */
442 
444 
445  /**
446  * frame timestamp estimated using various heuristics, in stream time base
447  * Code outside libavutil should access this field using:
448  * av_frame_get_best_effort_timestamp(frame)
449  * - encoding: unused
450  * - decoding: set by libavcodec, read by user.
451  */
453 
454  /**
455  * reordered pos from the last AVPacket that has been input into the decoder
456  * Code outside libavutil should access this field using:
457  * av_frame_get_pkt_pos(frame)
458  * - encoding: unused
459  * - decoding: Read by user.
460  */
461  int64_t pkt_pos;
462 
463  /**
464  * duration of the corresponding packet, expressed in
465  * AVStream->time_base units, 0 if unknown.
466  * Code outside libavutil should access this field using:
467  * av_frame_get_pkt_duration(frame)
468  * - encoding: unused
469  * - decoding: Read by user.
470  */
471  int64_t pkt_duration;
472 
473  /**
474  * metadata.
475  * Code outside libavutil should access this field using:
476  * av_frame_get_metadata(frame)
477  * - encoding: Set by user.
478  * - decoding: Set by libavcodec.
479  */
481 
482  /**
483  * decode error flags of the frame, set to a combination of
484  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
485  * were errors during the decoding.
486  * Code outside libavutil should access this field using:
487  * av_frame_get_decode_error_flags(frame)
488  * - encoding: unused
489  * - decoding: set by libavcodec, read by user.
490  */
492 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
493 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
494 
495  /**
496  * number of audio channels, only used for audio.
497  * Code outside libavutil should access this field using:
498  * av_frame_get_channels(frame)
499  * - encoding: unused
500  * - decoding: Read by user.
501  */
502  int channels;
503 
504  /**
505  * size of the corresponding packet containing the compressed
506  * frame. It must be accessed using av_frame_get_pkt_size() and
507  * av_frame_set_pkt_size().
508  * It is set to a negative value if unknown.
509  * - encoding: unused
510  * - decoding: set by libavcodec, read by user.
511  */
512  int pkt_size;
513 
514 #if FF_API_FRAME_QP
515  /**
516  * QP table
517  * Not to be accessed directly from outside libavutil
518  */
520  int8_t *qscale_table;
521  /**
522  * QP store stride
523  * Not to be accessed directly from outside libavutil
524  */
526  int qstride;
527 
530 
531  /**
532  * Not to be accessed directly from outside libavutil
533  */
535 #endif
536  /**
537  * For hwaccel-format frames, this should be a reference to the
538  * AVHWFramesContext describing the frame.
539  */
541 } AVFrame;
542 
543 /**
544  * Accessors for some AVFrame fields.
545  * The position of these field in the structure is not part of the ABI,
546  * they should not be accessed directly outside libavutil.
547  */
550 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
551 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
552 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
553 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
554 int64_t av_frame_get_channel_layout (const AVFrame *frame);
556 int av_frame_get_channels (const AVFrame *frame);
567 #if FF_API_FRAME_QP
568 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
570 #endif
575 
576 /**
577  * Get the name of a colorspace.
578  * @return a static string identifying the colorspace; can be NULL.
579  */
580 const char *av_get_colorspace_name(enum AVColorSpace val);
581 
582 /**
583  * Allocate an AVFrame and set its fields to default values. The resulting
584  * struct must be freed using av_frame_free().
585  *
586  * @return An AVFrame filled with default values or NULL on failure.
587  *
588  * @note this only allocates the AVFrame itself, not the data buffers. Those
589  * must be allocated through other means, e.g. with av_frame_get_buffer() or
590  * manually.
591  */
592 AVFrame *av_frame_alloc(void);
593 
594 /**
595  * Free the frame and any dynamically allocated objects in it,
596  * e.g. extended_data. If the frame is reference counted, it will be
597  * unreferenced first.
598  *
599  * @param frame frame to be freed. The pointer will be set to NULL.
600  */
601 void av_frame_free(AVFrame **frame);
602 
603 /**
604  * Set up a new reference to the data described by the source frame.
605  *
606  * Copy frame properties from src to dst and create a new reference for each
607  * AVBufferRef from src.
608  *
609  * If src is not reference counted, new buffers are allocated and the data is
610  * copied.
611  *
612  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
613  * or newly allocated with av_frame_alloc() before calling this
614  * function, or undefined behavior will occur.
615  *
616  * @return 0 on success, a negative AVERROR on error
617  */
618 int av_frame_ref(AVFrame *dst, const AVFrame *src);
619 
620 /**
621  * Create a new frame that references the same data as src.
622  *
623  * This is a shortcut for av_frame_alloc()+av_frame_ref().
624  *
625  * @return newly created AVFrame on success, NULL on error.
626  */
628 
629 /**
630  * Unreference all the buffers referenced by frame and reset the frame fields.
631  */
633 
634 /**
635  * Move everything contained in src to dst and reset src.
636  *
637  * @warning: dst is not unreferenced, but directly overwritten without reading
638  * or deallocating its contents. Call av_frame_unref(dst) manually
639  * before calling this function to ensure that no memory is leaked.
640  */
641 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
642 
643 /**
644  * Allocate new buffer(s) for audio or video data.
645  *
646  * The following fields must be set on frame before calling this function:
647  * - format (pixel format for video, sample format for audio)
648  * - width and height for video
649  * - nb_samples and channel_layout for audio
650  *
651  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
652  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
653  * For planar formats, one buffer will be allocated for each plane.
654  *
655  * @warning: if frame already has been allocated, calling this function will
656  * leak memory. In addition, undefined behavior can occur in certain
657  * cases.
658  *
659  * @param frame frame in which to store the new buffers.
660  * @param align required buffer size alignment
661  *
662  * @return 0 on success, a negative AVERROR on error.
663  */
665 
666 /**
667  * Check if the frame data is writable.
668  *
669  * @return A positive value if the frame data is writable (which is true if and
670  * only if each of the underlying buffers has only one reference, namely the one
671  * stored in this frame). Return 0 otherwise.
672  *
673  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
674  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
675  *
676  * @see av_frame_make_writable(), av_buffer_is_writable()
677  */
679 
680 /**
681  * Ensure that the frame data is writable, avoiding data copy if possible.
682  *
683  * Do nothing if the frame is writable, allocate new buffers and copy the data
684  * if it is not.
685  *
686  * @return 0 on success, a negative AVERROR on error.
687  *
688  * @see av_frame_is_writable(), av_buffer_is_writable(),
689  * av_buffer_make_writable()
690  */
692 
693 /**
694  * Copy the frame data from src to dst.
695  *
696  * This function does not allocate anything, dst must be already initialized and
697  * allocated with the same parameters as src.
698  *
699  * This function only copies the frame data (i.e. the contents of the data /
700  * extended data arrays), not any other properties.
701  *
702  * @return >= 0 on success, a negative AVERROR on error.
703  */
704 int av_frame_copy(AVFrame *dst, const AVFrame *src);
705 
706 /**
707  * Copy only "metadata" fields from src to dst.
708  *
709  * Metadata for the purpose of this function are those fields that do not affect
710  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
711  * aspect ratio (for video), but not width/height or channel layout.
712  * Side data is also copied.
713  */
714 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
715 
716 /**
717  * Get the buffer reference a given data plane is stored in.
718  *
719  * @param plane index of the data plane of interest in frame->extended_data.
720  *
721  * @return the buffer reference that contains the plane or NULL if the input
722  * frame is not valid.
723  */
725 
726 /**
727  * Add a new side data to a frame.
728  *
729  * @param frame a frame to which the side data should be added
730  * @param type type of the added side data
731  * @param size size of the side data
732  *
733  * @return newly added side data on success, NULL on error
734  */
737  int size);
738 
739 /**
740  * @return a pointer to the side data of a given type on success, NULL if there
741  * is no side data with such type in this frame.
742  */
745 
746 /**
747  * If side data of the supplied type exists in the frame, free it and remove it
748  * from the frame.
749  */
751 
752 /**
753  * @return a string identifying the side data type
754  */
756 
757 /**
758  * @}
759  */
760 
761 #endif /* AVUTIL_FRAME_H */
int plane
Definition: avisynth_c.h:422
void av_frame_set_channels(AVFrame *frame, int val)
const char const char void * val
Definition: avisynth_c.h:771
int av_frame_get_sample_rate(const AVFrame *frame)
#define AV_NUM_DATA_POINTERS
Definition: frame.h:191
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:190
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:529
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder Code outside libavutil shou...
Definition: frame.h:461
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:373
AVDictionary * metadata
Definition: frame.h:153
void * opaque
for some private data of the user
Definition: frame.h:309
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:391
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:323
int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
Definition: frame.c:49
Convenience header that includes libavutil's core.
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:519
#define src
Definition: vp8dsp.c:254
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:520
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:422
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:663
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:540
Public dictionary API.
uint8_t
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:145
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:450
attribute_deprecated int qstride
QP store stride Not to be accessed directly from outside libavutil.
Definition: frame.h:526
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:385
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:274
AVBufferRef * buf
Definition: frame.h:154
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:149
void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
AVDictionary * metadata
metadata.
Definition: frame.h:480
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:328
void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:471
ptrdiff_t size
Definition: opengl_enc.c:101
int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame)
Accessors for some AVFrame fields.
The data represents the AVSphericalMapping structure defined in libavutil/spherical.h.
Definition: frame.h:129
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:400
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:394
attribute_deprecated uint64_t error[AV_NUM_DATA_POINTERS]
Definition: frame.h:316
AVFrameSideData ** side_data
Definition: frame.h:393
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:242
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:158
void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:428
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:441
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:721
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:359
int channels
number of audio channels, only used for audio.
Definition: frame.h:502
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:264
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:419
int display_picture_number
picture number in display order
Definition: frame.h:299
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:387
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:596
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:534
AVFrameSideDataType
Definition: frame.h:47
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:304
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
Definition: frame.c:78
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:482
const AVS_VideoInfo int align
Definition: avisynth_c.h:795
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:254
int coded_picture_number
picture number in bitstream order
Definition: frame.h:295
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown...
Definition: frame.h:471
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:531
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:221
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:269
uint8_t * data
Definition: frame.h:151
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:734
void * buf
Definition: avisynth_c.h:690
GLint GLenum type
Definition: opengl_enc.c:105
AVDictionary * av_frame_get_metadata(const AVFrame *frame)
int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything)...
Definition: frame.h:349
enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
int sample_rate
Sample rate of the audio data.
Definition: frame.h:354
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:627
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:338
refcounted data buffer API
void av_frame_set_decode_error_flags(AVFrame *frame, int val)
AVPictureType
Definition: avutil.h:272
enum AVChromaLocation chroma_location
Definition: frame.h:443
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base Code outside libavutil should...
Definition: frame.h:452
AVActiveFormatDescription
Definition: frame.h:132
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:491
int64_t av_frame_get_channel_layout(const AVFrame *frame)
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:748
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:275
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:495
enum AVFrameSideDataType type
Definition: frame.h:150
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:548
#define attribute_deprecated
Definition: attributes.h:94
attribute_deprecated int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
Definition: frame.h:282
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:290
A reference to a data buffer.
Definition: buffer.h:81
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:105
Utilties for rational number calculation.
pixel format definitions
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:333
int64_t av_frame_get_pkt_pos(const AVFrame *frame)
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:259
void av_frame_set_sample_rate(AVFrame *frame, int val)
enum AVColorPrimaries color_primaries
Definition: frame.h:430
int height
Definition: frame.h:242
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:493
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:432
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:237
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:512
Stereoscopic 3d metadata.
Definition: frame.h:62
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:247
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:591