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