FFmpeg  4.0
frame.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 /**
20  * @file
21  * @ingroup lavu_frame
22  * reference-counted frame API
23  */
24 
25 #ifndef AVUTIL_FRAME_H
26 #define AVUTIL_FRAME_H
27 
28 #include <stddef.h>
29 #include <stdint.h>
30 
31 #include "avutil.h"
32 #include "buffer.h"
33 #include "dict.h"
34 #include "rational.h"
35 #include "samplefmt.h"
36 #include "pixfmt.h"
37 #include "version.h"
38 
39 
40 /**
41  * @defgroup lavu_frame AVFrame
42  * @ingroup lavu_data
43  *
44  * @{
45  * AVFrame is an abstraction for reference-counted raw multimedia data.
46  */
47 
49  /**
50  * The data is the AVPanScan struct defined in libavcodec.
51  */
53  /**
54  * ATSC A53 Part 4 Closed Captions.
55  * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
56  * The number of bytes of CC data is AVFrameSideData.size.
57  */
59  /**
60  * Stereoscopic 3d metadata.
61  * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
62  */
64  /**
65  * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
66  */
68  /**
69  * Metadata relevant to a downmix procedure.
70  * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
71  */
73  /**
74  * ReplayGain information in the form of the AVReplayGain struct.
75  */
77  /**
78  * This side data contains a 3x3 transformation matrix describing an affine
79  * transformation that needs to be applied to the frame for correct
80  * presentation.
81  *
82  * See libavutil/display.h for a detailed description of the data.
83  */
85  /**
86  * Active Format Description data consisting of a single byte as specified
87  * in ETSI TS 101 154 using AVActiveFormatDescription enum.
88  */
90  /**
91  * Motion vectors exported by some codecs (on demand through the export_mvs
92  * flag set in the libavcodec AVCodecContext flags2 option).
93  * The data is the AVMotionVector struct defined in
94  * libavutil/motion_vector.h.
95  */
97  /**
98  * Recommmends skipping the specified number of samples. This is exported
99  * only if the "skip_manual" AVOption is set in libavcodec.
100  * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
101  * @code
102  * u32le number of samples to skip from start of this packet
103  * u32le number of samples to skip from end of this packet
104  * u8 reason for start skip
105  * u8 reason for end skip (0=padding silence, 1=convergence)
106  * @endcode
107  */
109  /**
110  * This side data must be associated with an audio frame and corresponds to
111  * enum AVAudioServiceType defined in avcodec.h.
112  */
114  /**
115  * Mastering display metadata associated with a video frame. The payload is
116  * an AVMasteringDisplayMetadata type and contains information about the
117  * mastering display color volume.
118  */
120  /**
121  * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
122  * This is set on the first frame of a GOP that has a temporal reference of 0.
123  */
125 
126  /**
127  * The data represents the AVSphericalMapping structure defined in
128  * libavutil/spherical.h.
129  */
131 
132  /**
133  * Content light level (based on CTA-861.3). This payload contains data in
134  * the form of the AVContentLightMetadata struct.
135  */
137 
138  /**
139  * The data contains an ICC profile as an opaque octet buffer following the
140  * format described by ISO 15076-1 with an optional name defined in the
141  * metadata key entry "name".
142  */
144 
145 #if FF_API_FRAME_QP
146  /**
147  * Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
148  * The contents of this side data are undocumented and internal; use
149  * av_frame_set_qp_table() and av_frame_get_qp_table() to access this in a
150  * meaningful way instead.
151  */
153 
154  /**
155  * Raw QP table data. Its format is described by
156  * AV_FRAME_DATA_QP_TABLE_PROPERTIES. Use av_frame_set_qp_table() and
157  * av_frame_get_qp_table() to access this instead.
158  */
160 #endif
161 };
162 
171 };
172 
173 
174 /**
175  * Structure to hold side data for an AVFrame.
176  *
177  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
178  * to the end with a minor bump.
179  */
180 typedef struct AVFrameSideData {
183  int size;
187 
188 /**
189  * This structure describes decoded (raw) audio or video data.
190  *
191  * AVFrame must be allocated using av_frame_alloc(). Note that this only
192  * allocates the AVFrame itself, the buffers for the data must be managed
193  * through other means (see below).
194  * AVFrame must be freed with av_frame_free().
195  *
196  * AVFrame is typically allocated once and then reused multiple times to hold
197  * different data (e.g. a single AVFrame to hold frames received from a
198  * decoder). In such a case, av_frame_unref() will free any references held by
199  * the frame and reset it to its original clean state before it
200  * is reused again.
201  *
202  * The data described by an AVFrame is usually reference counted through the
203  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
204  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
205  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
206  * every single data plane must be contained in one of the buffers in
207  * AVFrame.buf or AVFrame.extended_buf.
208  * There may be a single buffer for all the data, or one separate buffer for
209  * each plane, or anything in between.
210  *
211  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
212  * to the end with a minor bump.
213  *
214  * Fields can be accessed through AVOptions, the name string used, matches the
215  * C structure field name for fields accessible through AVOptions. The AVClass
216  * for AVFrame can be obtained from avcodec_get_frame_class()
217  */
218 typedef struct AVFrame {
219 #define AV_NUM_DATA_POINTERS 8
220  /**
221  * pointer to the picture/channel planes.
222  * This might be different from the first allocated byte
223  *
224  * Some decoders access areas outside 0,0 - width,height, please
225  * see avcodec_align_dimensions2(). Some filters and swscale can read
226  * up to 16 bytes beyond the planes, if these filters are to be used,
227  * then 16 extra bytes must be allocated.
228  *
229  * NOTE: Except for hwaccel formats, pointers not needed by the format
230  * MUST be set to NULL.
231  */
233 
234  /**
235  * For video, size in bytes of each picture line.
236  * For audio, size in bytes of each plane.
237  *
238  * For audio, only linesize[0] may be set. For planar audio, each channel
239  * plane must be the same size.
240  *
241  * For video the linesizes should be multiples of the CPUs alignment
242  * preference, this is 16 or 32 for modern desktop CPUs.
243  * Some code requires such alignment other code can be slower without
244  * correct alignment, for yet other it makes no difference.
245  *
246  * @note The linesize may be larger than the size of usable data -- there
247  * may be extra padding present for performance reasons.
248  */
249  int linesize[AV_NUM_DATA_POINTERS];
250 
251  /**
252  * pointers to the data planes/channels.
253  *
254  * For video, this should simply point to data[].
255  *
256  * For planar audio, each channel has a separate data pointer, and
257  * linesize[0] contains the size of each channel buffer.
258  * For packed audio, there is just one data pointer, and linesize[0]
259  * contains the total size of the buffer for all channels.
260  *
261  * Note: Both data and extended_data should always be set in a valid frame,
262  * but for planar audio with more channels that can fit in data,
263  * extended_data must be used in order to access all channels.
264  */
266 
267  /**
268  * @name Video dimensions
269  * Video frames only. The coded dimensions (in pixels) of the video frame,
270  * i.e. the size of the rectangle that contains some well-defined values.
271  *
272  * @note The part of the frame intended for display/presentation is further
273  * restricted by the @ref cropping "Cropping rectangle".
274  * @{
275  */
276  int width, height;
277  /**
278  * @}
279  */
280 
281  /**
282  * number of audio samples (per channel) described by this frame
283  */
285 
286  /**
287  * format of the frame, -1 if unknown or unset
288  * Values correspond to enum AVPixelFormat for video frames,
289  * enum AVSampleFormat for audio)
290  */
291  int format;
292 
293  /**
294  * 1 -> keyframe, 0-> not
295  */
297 
298  /**
299  * Picture type of the frame.
300  */
301  enum AVPictureType pict_type;
302 
303  /**
304  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
305  */
307 
308  /**
309  * Presentation timestamp in time_base units (time when frame should be shown to user).
310  */
311  int64_t pts;
312 
313 #if FF_API_PKT_PTS
314  /**
315  * PTS copied from the AVPacket that was decoded to produce this frame.
316  * @deprecated use the pts field instead
317  */
319  int64_t pkt_pts;
320 #endif
321 
322  /**
323  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
324  * This is also the Presentation time of this AVFrame calculated from
325  * only AVPacket.dts values without pts values.
326  */
327  int64_t pkt_dts;
328 
329  /**
330  * picture number in bitstream order
331  */
333  /**
334  * picture number in display order
335  */
337 
338  /**
339  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
340  */
341  int quality;
342 
343  /**
344  * for some private data of the user
345  */
346  void *opaque;
347 
348 #if FF_API_ERROR_FRAME
349  /**
350  * @deprecated unused
351  */
354 #endif
355 
356  /**
357  * When decoding, this signals how much the picture must be delayed.
358  * extra_delay = repeat_pict / (2*fps)
359  */
361 
362  /**
363  * The content of the picture is interlaced.
364  */
366 
367  /**
368  * If the content is interlaced, is top field displayed first.
369  */
371 
372  /**
373  * Tell user application that palette has changed from previous frame.
374  */
376 
377  /**
378  * reordered opaque 64 bits (generally an integer or a double precision float
379  * PTS but can be anything).
380  * The user sets AVCodecContext.reordered_opaque to represent the input at
381  * that time,
382  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
383  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
384  * @deprecated in favor of pkt_pts
385  */
387 
388  /**
389  * Sample rate of the audio data.
390  */
392 
393  /**
394  * Channel layout of the audio data.
395  */
396  uint64_t channel_layout;
397 
398  /**
399  * AVBuffer references backing the data for this frame. If all elements of
400  * this array are NULL, then this frame is not reference counted. This array
401  * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
402  * also be non-NULL for all j < i.
403  *
404  * There may be at most one AVBuffer per data plane, so for video this array
405  * always contains all the references. For planar audio with more than
406  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
407  * this array. Then the extra AVBufferRef pointers are stored in the
408  * extended_buf array.
409  */
411 
412  /**
413  * For planar audio which requires more than AV_NUM_DATA_POINTERS
414  * AVBufferRef pointers, this array will hold all the references which
415  * cannot fit into AVFrame.buf.
416  *
417  * Note that this is different from AVFrame.extended_data, which always
418  * contains all the pointers. This array only contains the extra pointers,
419  * which cannot fit into AVFrame.buf.
420  *
421  * This array is always allocated using av_malloc() by whoever constructs
422  * the frame. It is freed in av_frame_unref().
423  */
425  /**
426  * Number of elements in extended_buf.
427  */
429 
432 
433 /**
434  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
435  * @ingroup lavu_frame
436  * Flags describing additional frame properties.
437  *
438  * @{
439  */
440 
441 /**
442  * The frame data may be corrupted, e.g. due to decoding errors.
443  */
444 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
445 /**
446  * A flag to mark the frames which need to be decoded, but shouldn't be output.
447  */
448 #define AV_FRAME_FLAG_DISCARD (1 << 2)
449 /**
450  * @}
451  */
452 
453  /**
454  * Frame flags, a combination of @ref lavu_frame_flags
455  */
456  int flags;
457 
458  /**
459  * MPEG vs JPEG YUV range.
460  * - encoding: Set by user
461  * - decoding: Set by libavcodec
462  */
464 
466 
468 
469  /**
470  * YUV colorspace type.
471  * - encoding: Set by user
472  * - decoding: Set by libavcodec
473  */
474  enum AVColorSpace colorspace;
475 
476  enum AVChromaLocation chroma_location;
477 
478  /**
479  * frame timestamp estimated using various heuristics, in stream time base
480  * - encoding: unused
481  * - decoding: set by libavcodec, read by user.
482  */
484 
485  /**
486  * reordered pos from the last AVPacket that has been input into the decoder
487  * - encoding: unused
488  * - decoding: Read by user.
489  */
490  int64_t pkt_pos;
491 
492  /**
493  * duration of the corresponding packet, expressed in
494  * AVStream->time_base units, 0 if unknown.
495  * - encoding: unused
496  * - decoding: Read by user.
497  */
498  int64_t pkt_duration;
499 
500  /**
501  * metadata.
502  * - encoding: Set by user.
503  * - decoding: Set by libavcodec.
504  */
506 
507  /**
508  * decode error flags of the frame, set to a combination of
509  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
510  * were errors during the decoding.
511  * - encoding: unused
512  * - decoding: set by libavcodec, read by user.
513  */
515 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
516 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
517 
518  /**
519  * number of audio channels, only used for audio.
520  * - encoding: unused
521  * - decoding: Read by user.
522  */
523  int channels;
524 
525  /**
526  * size of the corresponding packet containing the compressed
527  * frame.
528  * It is set to a negative value if unknown.
529  * - encoding: unused
530  * - decoding: set by libavcodec, read by user.
531  */
532  int pkt_size;
533 
534 #if FF_API_FRAME_QP
535  /**
536  * QP table
537  */
539  int8_t *qscale_table;
540  /**
541  * QP store stride
542  */
544  int qstride;
545 
548 
551 #endif
552  /**
553  * For hwaccel-format frames, this should be a reference to the
554  * AVHWFramesContext describing the frame.
555  */
557 
558  /**
559  * AVBufferRef for free use by the API user. FFmpeg will never check the
560  * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
561  * the frame is unreferenced. av_frame_copy_props() calls create a new
562  * reference with av_buffer_ref() for the target frame's opaque_ref field.
563  *
564  * This is unrelated to the opaque field, although it serves a similar
565  * purpose.
566  */
568 
569  /**
570  * @anchor cropping
571  * @name Cropping
572  * Video frames only. The number of pixels to discard from the the
573  * top/bottom/left/right border of the frame to obtain the sub-rectangle of
574  * the frame intended for presentation.
575  * @{
576  */
577  size_t crop_top;
578  size_t crop_bottom;
579  size_t crop_left;
580  size_t crop_right;
581  /**
582  * @}
583  */
584 
585  /**
586  * AVBufferRef for internal use by a single libav* library.
587  * Must not be used to transfer data between libraries.
588  * Has to be NULL when ownership of the frame leaves the respective library.
589  *
590  * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
591  *
592  * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
593  * av_frame_copy_props() calls create a new reference with av_buffer_ref()
594  * for the target frame's private_ref field.
595  */
597 } AVFrame;
598 
599 #if FF_API_FRAME_GET_SET
600 /**
601  * Accessors for some AVFrame fields. These used to be provided for ABI
602  * compatibility, and do not need to be used anymore.
603  */
609 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
611 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
613 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
615 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
617 int64_t av_frame_get_channel_layout (const AVFrame *frame);
621 int av_frame_get_channels (const AVFrame *frame);
640 #if FF_API_FRAME_QP
642 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
645 #endif
654 #endif
655 
656 /**
657  * Get the name of a colorspace.
658  * @return a static string identifying the colorspace; can be NULL.
659  */
660 const char *av_get_colorspace_name(enum AVColorSpace val);
661 
662 /**
663  * Allocate an AVFrame and set its fields to default values. The resulting
664  * struct must be freed using av_frame_free().
665  *
666  * @return An AVFrame filled with default values or NULL on failure.
667  *
668  * @note this only allocates the AVFrame itself, not the data buffers. Those
669  * must be allocated through other means, e.g. with av_frame_get_buffer() or
670  * manually.
671  */
672 AVFrame *av_frame_alloc(void);
673 
674 /**
675  * Free the frame and any dynamically allocated objects in it,
676  * e.g. extended_data. If the frame is reference counted, it will be
677  * unreferenced first.
678  *
679  * @param frame frame to be freed. The pointer will be set to NULL.
680  */
681 void av_frame_free(AVFrame **frame);
682 
683 /**
684  * Set up a new reference to the data described by the source frame.
685  *
686  * Copy frame properties from src to dst and create a new reference for each
687  * AVBufferRef from src.
688  *
689  * If src is not reference counted, new buffers are allocated and the data is
690  * copied.
691  *
692  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
693  * or newly allocated with av_frame_alloc() before calling this
694  * function, or undefined behavior will occur.
695  *
696  * @return 0 on success, a negative AVERROR on error
697  */
698 int av_frame_ref(AVFrame *dst, const AVFrame *src);
699 
700 /**
701  * Create a new frame that references the same data as src.
702  *
703  * This is a shortcut for av_frame_alloc()+av_frame_ref().
704  *
705  * @return newly created AVFrame on success, NULL on error.
706  */
708 
709 /**
710  * Unreference all the buffers referenced by frame and reset the frame fields.
711  */
713 
714 /**
715  * Move everything contained in src to dst and reset src.
716  *
717  * @warning: dst is not unreferenced, but directly overwritten without reading
718  * or deallocating its contents. Call av_frame_unref(dst) manually
719  * before calling this function to ensure that no memory is leaked.
720  */
721 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
722 
723 /**
724  * Allocate new buffer(s) for audio or video data.
725  *
726  * The following fields must be set on frame before calling this function:
727  * - format (pixel format for video, sample format for audio)
728  * - width and height for video
729  * - nb_samples and channel_layout for audio
730  *
731  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
732  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
733  * For planar formats, one buffer will be allocated for each plane.
734  *
735  * @warning: if frame already has been allocated, calling this function will
736  * leak memory. In addition, undefined behavior can occur in certain
737  * cases.
738  *
739  * @param frame frame in which to store the new buffers.
740  * @param align Required buffer size alignment. If equal to 0, alignment will be
741  * chosen automatically for the current CPU. It is highly
742  * recommended to pass 0 here unless you know what you are doing.
743  *
744  * @return 0 on success, a negative AVERROR on error.
745  */
747 
748 /**
749  * Check if the frame data is writable.
750  *
751  * @return A positive value if the frame data is writable (which is true if and
752  * only if each of the underlying buffers has only one reference, namely the one
753  * stored in this frame). Return 0 otherwise.
754  *
755  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
756  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
757  *
758  * @see av_frame_make_writable(), av_buffer_is_writable()
759  */
761 
762 /**
763  * Ensure that the frame data is writable, avoiding data copy if possible.
764  *
765  * Do nothing if the frame is writable, allocate new buffers and copy the data
766  * if it is not.
767  *
768  * @return 0 on success, a negative AVERROR on error.
769  *
770  * @see av_frame_is_writable(), av_buffer_is_writable(),
771  * av_buffer_make_writable()
772  */
774 
775 /**
776  * Copy the frame data from src to dst.
777  *
778  * This function does not allocate anything, dst must be already initialized and
779  * allocated with the same parameters as src.
780  *
781  * This function only copies the frame data (i.e. the contents of the data /
782  * extended data arrays), not any other properties.
783  *
784  * @return >= 0 on success, a negative AVERROR on error.
785  */
786 int av_frame_copy(AVFrame *dst, const AVFrame *src);
787 
788 /**
789  * Copy only "metadata" fields from src to dst.
790  *
791  * Metadata for the purpose of this function are those fields that do not affect
792  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
793  * aspect ratio (for video), but not width/height or channel layout.
794  * Side data is also copied.
795  */
796 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
797 
798 /**
799  * Get the buffer reference a given data plane is stored in.
800  *
801  * @param plane index of the data plane of interest in frame->extended_data.
802  *
803  * @return the buffer reference that contains the plane or NULL if the input
804  * frame is not valid.
805  */
807 
808 /**
809  * Add a new side data to a frame.
810  *
811  * @param frame a frame to which the side data should be added
812  * @param type type of the added side data
813  * @param size size of the side data
814  *
815  * @return newly added side data on success, NULL on error
816  */
819  int size);
820 
821 /**
822  * Add a new side data to a frame from an existing AVBufferRef
823  *
824  * @param frame a frame to which the side data should be added
825  * @param type the type of the added side data
826  * @param buf an AVBufferRef to add as side data. The ownership of
827  * the reference is transferred to the frame.
828  *
829  * @return newly added side data on success, NULL on error. On failure
830  * the frame is unchanged and the AVBufferRef remains owned by
831  * the caller.
832  */
835  AVBufferRef *buf);
836 
837 /**
838  * @return a pointer to the side data of a given type on success, NULL if there
839  * is no side data with such type in this frame.
840  */
843 
844 /**
845  * If side data of the supplied type exists in the frame, free it and remove it
846  * from the frame.
847  */
849 
850 
851 /**
852  * Flags for frame cropping.
853  */
854 enum {
855  /**
856  * Apply the maximum possible cropping, even if it requires setting the
857  * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
858  * to FFmpeg API is generally not allowed, and causes undefined behavior
859  * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
860  * are explicitly documented to accept it. Use this flag only if you
861  * absolutely know what you are doing.
862  */
864 };
865 
866 /**
867  * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
868  * crop_bottom fields. If cropping is successful, the function will adjust the
869  * data pointers and the width/height fields, and set the crop fields to 0.
870  *
871  * In all cases, the cropping boundaries will be rounded to the inherent
872  * alignment of the pixel format. In some cases, such as for opaque hwaccel
873  * formats, the left/top cropping is ignored. The crop fields are set to 0 even
874  * if the cropping was rounded or ignored.
875  *
876  * @param frame the frame which should be cropped
877  * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
878  *
879  * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
880  * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
881  */
883 
884 /**
885  * @return a string identifying the side data type
886  */
888 
889 /**
890  * @}
891  */
892 
893 #endif /* AVUTIL_FRAME_H */
int plane
Definition: avisynth_c.h:422
attribute_deprecated int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
Definition: frame.c:54
const char const char void * val
Definition: avisynth_c.h:771
#define AV_NUM_DATA_POINTERS
Definition: frame.h:219
This structure describes decoded (raw) audio or video data.
Definition: frame.h:218
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:547
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
Definition: frame.h:490
attribute_deprecated void av_frame_set_pkt_pos(AVFrame *frame, int64_t val)
AVDictionary * metadata
Definition: frame.h:184
void * opaque
for some private data of the user
Definition: frame.h:346
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:428
Content light level (based on CTA-861.3).
Definition: frame.h:136
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:360
Convenience header that includes libavutil&#39;s core.
Mastering display metadata associated with a video frame.
Definition: frame.h:119
attribute_deprecated AVBufferRef * qp_table_buf
Definition: frame.h:550
color_range
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:580
size_t crop_bottom
Definition: frame.h:578
attribute_deprecated enum AVColorRange av_frame_get_color_range(const AVFrame *frame)
#define src
Definition: vp8dsp.c:254
int stride
Definition: mace.c:144
attribute_deprecated int8_t * qscale_table
QP table.
Definition: frame.h:539
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:444
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:732
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:556
Public dictionary API.
uint8_t
attribute_deprecated void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:189
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:473
size_t crop_left
Definition: frame.h:579
attribute_deprecated int qstride
QP store stride.
Definition: frame.h:544
attribute_deprecated void av_frame_set_pkt_size(AVFrame *frame, int val)
AVBufferRef * private_ref
AVBufferRef for internal use by a single libav* library.
Definition: frame.h:596
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:441
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:311
AVBufferRef * buf
Definition: frame.h:185
The data is the AVPanScan struct defined in libavcodec.
Definition: frame.h:52
static AVFrame * frame
attribute_deprecated void av_frame_set_pkt_duration(AVFrame *frame, int64_t val)
Structure to hold side data for an AVFrame.
Definition: frame.h:180
#define height
static int flags
Definition: log.c:55
AVDictionary * metadata
metadata.
Definition: frame.h:505
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:365
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:496
attribute_deprecated int64_t av_frame_get_channel_layout(const AVFrame *frame)
attribute_deprecated int av_frame_get_sample_rate(const AVFrame *frame)
The data represents the AVSphericalMapping structure defined in libavutil/spherical.h.
Definition: frame.h:130
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:420
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:431
AVFrameSideData ** side_data
Definition: frame.h:430
attribute_deprecated int av_frame_get_pkt_size(const AVFrame *frame)
Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
Definition: frame.h:152
int width
Definition: frame.h:276
attribute_deprecated void av_frame_set_decode_error_flags(AVFrame *frame, int val)
attribute_deprecated int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame)
Accessors for some AVFrame fields.
int av_frame_apply_cropping(AVFrame *frame, int flags)
Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields...
Definition: frame.c:873
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
attribute_deprecated void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val)
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:58
Libavutil version macros.
The GOP timecode in 25 bit timecode format.
Definition: frame.h:124
attribute_deprecated void av_frame_set_channels(AVFrame *frame, int val)
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:790
attribute_deprecated AVDictionary * av_frame_get_metadata(const AVFrame *frame)
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:396
size_t crop_top
Definition: frame.h:577
int channels
number of audio channels, only used for audio.
Definition: frame.h:523
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:456
int display_picture_number
picture number in display order
Definition: frame.h:336
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:424
AVFrameSideData * av_frame_new_side_data_from_buf(AVFrame *frame, enum AVFrameSideDataType type, AVBufferRef *buf)
Add a new side data to a frame from an existing AVBufferRef.
Definition: frame.c:688
static const struct ColorPrimaries color_primaries[AVCOL_PRI_NB]
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:657
AVFrameSideDataType
Definition: frame.h:48
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:341
The data contains an ICC profile as an opaque octet buffer following the format described by ISO 1507...
Definition: frame.h:143
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
Definition: frame.c:122
static void error(const char *err)
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:538
attribute_deprecated int64_t av_frame_get_pkt_pos(const AVFrame *frame)
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:291
int coded_picture_number
picture number in bitstream order
Definition: frame.h:332
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown...
Definition: frame.h:498
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:592
Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unalig...
Definition: frame.h:863
attribute_deprecated int64_t av_frame_get_pkt_duration(const AVFrame *frame)
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:306
uint8_t * data
Definition: frame.h:182
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:803
size_t crop_right
Definition: frame.h:580
attribute_deprecated void av_frame_set_channel_layout(AVFrame *frame, int64_t val)
int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything)...
Definition: frame.h:386
attribute_deprecated enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
int sample_rate
Sample rate of the audio data.
Definition: frame.h:391
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, int size)
Add a new side data to a frame.
Definition: frame.c:720
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:375
attribute_deprecated void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
refcounted data buffer API
AVPictureType
Definition: avutil.h:272
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:483
AVActiveFormatDescription
Definition: frame.h:163
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:514
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:817
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:322
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:551
enum AVFrameSideDataType type
Definition: frame.h:181
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:609
attribute_deprecated int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
Definition: frame.h:319
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:327
A reference to a data buffer.
Definition: buffer.h:81
attribute_deprecated int av_frame_get_channels(const AVFrame *frame)
Utilties for rational number calculation.
pixel format definitions
attribute_deprecated void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:370
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
Definition: frame.h:567
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:296
attribute_deprecated void av_frame_set_sample_rate(AVFrame *frame, int val)
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:518
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:265
attribute_deprecated int8_t * av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
Definition: frame.c:90
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:532
attribute_deprecated int av_frame_get_decode_error_flags(const AVFrame *frame)
Stereoscopic 3d metadata.
Definition: frame.h:63
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:284
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:652
Raw QP table data.
Definition: frame.h:159