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 <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  /**
163  * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t
164  * where the first uint32_t describes how many (1-3) of the other timecodes are used.
165  * The timecode format is described in the av_timecode_get_smpte_from_framenum()
166  * function in libavutil/timecode.c.
167  */
169 };
170 
179 };
180 
181 
182 /**
183  * Structure to hold side data for an AVFrame.
184  *
185  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
186  * to the end with a minor bump.
187  */
188 typedef struct AVFrameSideData {
191  int size;
195 
196 /**
197  * This structure describes decoded (raw) audio or video data.
198  *
199  * AVFrame must be allocated using av_frame_alloc(). Note that this only
200  * allocates the AVFrame itself, the buffers for the data must be managed
201  * through other means (see below).
202  * AVFrame must be freed with av_frame_free().
203  *
204  * AVFrame is typically allocated once and then reused multiple times to hold
205  * different data (e.g. a single AVFrame to hold frames received from a
206  * decoder). In such a case, av_frame_unref() will free any references held by
207  * the frame and reset it to its original clean state before it
208  * is reused again.
209  *
210  * The data described by an AVFrame is usually reference counted through the
211  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
212  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
213  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
214  * every single data plane must be contained in one of the buffers in
215  * AVFrame.buf or AVFrame.extended_buf.
216  * There may be a single buffer for all the data, or one separate buffer for
217  * each plane, or anything in between.
218  *
219  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
220  * to the end with a minor bump.
221  *
222  * Fields can be accessed through AVOptions, the name string used, matches the
223  * C structure field name for fields accessible through AVOptions. The AVClass
224  * for AVFrame can be obtained from avcodec_get_frame_class()
225  */
226 typedef struct AVFrame {
227 #define AV_NUM_DATA_POINTERS 8
228  /**
229  * pointer to the picture/channel planes.
230  * This might be different from the first allocated byte
231  *
232  * Some decoders access areas outside 0,0 - width,height, please
233  * see avcodec_align_dimensions2(). Some filters and swscale can read
234  * up to 16 bytes beyond the planes, if these filters are to be used,
235  * then 16 extra bytes must be allocated.
236  *
237  * NOTE: Except for hwaccel formats, pointers not needed by the format
238  * MUST be set to NULL.
239  */
241 
242  /**
243  * For video, size in bytes of each picture line.
244  * For audio, size in bytes of each plane.
245  *
246  * For audio, only linesize[0] may be set. For planar audio, each channel
247  * plane must be the same size.
248  *
249  * For video the linesizes should be multiples of the CPUs alignment
250  * preference, this is 16 or 32 for modern desktop CPUs.
251  * Some code requires such alignment other code can be slower without
252  * correct alignment, for yet other it makes no difference.
253  *
254  * @note The linesize may be larger than the size of usable data -- there
255  * may be extra padding present for performance reasons.
256  */
258 
259  /**
260  * pointers to the data planes/channels.
261  *
262  * For video, this should simply point to data[].
263  *
264  * For planar audio, each channel has a separate data pointer, and
265  * linesize[0] contains the size of each channel buffer.
266  * For packed audio, there is just one data pointer, and linesize[0]
267  * contains the total size of the buffer for all channels.
268  *
269  * Note: Both data and extended_data should always be set in a valid frame,
270  * but for planar audio with more channels that can fit in data,
271  * extended_data must be used in order to access all channels.
272  */
274 
275  /**
276  * @name Video dimensions
277  * Video frames only. The coded dimensions (in pixels) of the video frame,
278  * i.e. the size of the rectangle that contains some well-defined values.
279  *
280  * @note The part of the frame intended for display/presentation is further
281  * restricted by the @ref cropping "Cropping rectangle".
282  * @{
283  */
284  int width, height;
285  /**
286  * @}
287  */
288 
289  /**
290  * number of audio samples (per channel) described by this frame
291  */
293 
294  /**
295  * format of the frame, -1 if unknown or unset
296  * Values correspond to enum AVPixelFormat for video frames,
297  * enum AVSampleFormat for audio)
298  */
299  int format;
300 
301  /**
302  * 1 -> keyframe, 0-> not
303  */
305 
306  /**
307  * Picture type of the frame.
308  */
310 
311  /**
312  * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
313  */
315 
316  /**
317  * Presentation timestamp in time_base units (time when frame should be shown to user).
318  */
319  int64_t pts;
320 
321 #if FF_API_PKT_PTS
322  /**
323  * PTS copied from the AVPacket that was decoded to produce this frame.
324  * @deprecated use the pts field instead
325  */
327  int64_t pkt_pts;
328 #endif
329 
330  /**
331  * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
332  * This is also the Presentation time of this AVFrame calculated from
333  * only AVPacket.dts values without pts values.
334  */
335  int64_t pkt_dts;
336 
337  /**
338  * picture number in bitstream order
339  */
341  /**
342  * picture number in display order
343  */
345 
346  /**
347  * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
348  */
349  int quality;
350 
351  /**
352  * for some private data of the user
353  */
354  void *opaque;
355 
356 #if FF_API_ERROR_FRAME
357  /**
358  * @deprecated unused
359  */
362 #endif
363 
364  /**
365  * When decoding, this signals how much the picture must be delayed.
366  * extra_delay = repeat_pict / (2*fps)
367  */
369 
370  /**
371  * The content of the picture is interlaced.
372  */
374 
375  /**
376  * If the content is interlaced, is top field displayed first.
377  */
379 
380  /**
381  * Tell user application that palette has changed from previous frame.
382  */
384 
385  /**
386  * reordered opaque 64 bits (generally an integer or a double precision float
387  * PTS but can be anything).
388  * The user sets AVCodecContext.reordered_opaque to represent the input at
389  * that time,
390  * the decoder reorders values as needed and sets AVFrame.reordered_opaque
391  * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
392  * @deprecated in favor of pkt_pts
393  */
395 
396  /**
397  * Sample rate of the audio data.
398  */
400 
401  /**
402  * Channel layout of the audio data.
403  */
404  uint64_t channel_layout;
405 
406  /**
407  * AVBuffer references backing the data for this frame. If all elements of
408  * this array are NULL, then this frame is not reference counted. This array
409  * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
410  * also be non-NULL for all j < i.
411  *
412  * There may be at most one AVBuffer per data plane, so for video this array
413  * always contains all the references. For planar audio with more than
414  * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
415  * this array. Then the extra AVBufferRef pointers are stored in the
416  * extended_buf array.
417  */
419 
420  /**
421  * For planar audio which requires more than AV_NUM_DATA_POINTERS
422  * AVBufferRef pointers, this array will hold all the references which
423  * cannot fit into AVFrame.buf.
424  *
425  * Note that this is different from AVFrame.extended_data, which always
426  * contains all the pointers. This array only contains the extra pointers,
427  * which cannot fit into AVFrame.buf.
428  *
429  * This array is always allocated using av_malloc() by whoever constructs
430  * the frame. It is freed in av_frame_unref().
431  */
433  /**
434  * Number of elements in extended_buf.
435  */
437 
440 
441 /**
442  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
443  * @ingroup lavu_frame
444  * Flags describing additional frame properties.
445  *
446  * @{
447  */
448 
449 /**
450  * The frame data may be corrupted, e.g. due to decoding errors.
451  */
452 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
453 /**
454  * A flag to mark the frames which need to be decoded, but shouldn't be output.
455  */
456 #define AV_FRAME_FLAG_DISCARD (1 << 2)
457 /**
458  * @}
459  */
460 
461  /**
462  * Frame flags, a combination of @ref lavu_frame_flags
463  */
464  int flags;
465 
466  /**
467  * MPEG vs JPEG YUV range.
468  * - encoding: Set by user
469  * - decoding: Set by libavcodec
470  */
472 
474 
476 
477  /**
478  * YUV colorspace type.
479  * - encoding: Set by user
480  * - decoding: Set by libavcodec
481  */
483 
485 
486  /**
487  * frame timestamp estimated using various heuristics, in stream time base
488  * - encoding: unused
489  * - decoding: set by libavcodec, read by user.
490  */
492 
493  /**
494  * reordered pos from the last AVPacket that has been input into the decoder
495  * - encoding: unused
496  * - decoding: Read by user.
497  */
498  int64_t pkt_pos;
499 
500  /**
501  * duration of the corresponding packet, expressed in
502  * AVStream->time_base units, 0 if unknown.
503  * - encoding: unused
504  * - decoding: Read by user.
505  */
506  int64_t pkt_duration;
507 
508  /**
509  * metadata.
510  * - encoding: Set by user.
511  * - decoding: Set by libavcodec.
512  */
514 
515  /**
516  * decode error flags of the frame, set to a combination of
517  * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
518  * were errors during the decoding.
519  * - encoding: unused
520  * - decoding: set by libavcodec, read by user.
521  */
523 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
524 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
525 
526  /**
527  * number of audio channels, only used for audio.
528  * - encoding: unused
529  * - decoding: Read by user.
530  */
531  int channels;
532 
533  /**
534  * size of the corresponding packet containing the compressed
535  * frame.
536  * It is set to a negative value if unknown.
537  * - encoding: unused
538  * - decoding: set by libavcodec, read by user.
539  */
540  int pkt_size;
541 
542 #if FF_API_FRAME_QP
543  /**
544  * QP table
545  */
547  int8_t *qscale_table;
548  /**
549  * QP store stride
550  */
552  int qstride;
553 
556 
559 #endif
560  /**
561  * For hwaccel-format frames, this should be a reference to the
562  * AVHWFramesContext describing the frame.
563  */
565 
566  /**
567  * AVBufferRef for free use by the API user. FFmpeg will never check the
568  * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
569  * the frame is unreferenced. av_frame_copy_props() calls create a new
570  * reference with av_buffer_ref() for the target frame's opaque_ref field.
571  *
572  * This is unrelated to the opaque field, although it serves a similar
573  * purpose.
574  */
576 
577  /**
578  * @anchor cropping
579  * @name Cropping
580  * Video frames only. The number of pixels to discard from the the
581  * top/bottom/left/right border of the frame to obtain the sub-rectangle of
582  * the frame intended for presentation.
583  * @{
584  */
585  size_t crop_top;
586  size_t crop_bottom;
587  size_t crop_left;
588  size_t crop_right;
589  /**
590  * @}
591  */
592 
593  /**
594  * AVBufferRef for internal use by a single libav* library.
595  * Must not be used to transfer data between libraries.
596  * Has to be NULL when ownership of the frame leaves the respective library.
597  *
598  * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
599  *
600  * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
601  * av_frame_copy_props() calls create a new reference with av_buffer_ref()
602  * for the target frame's private_ref field.
603  */
605 } AVFrame;
606 
607 #if FF_API_FRAME_GET_SET
608 /**
609  * Accessors for some AVFrame fields. These used to be provided for ABI
610  * compatibility, and do not need to be used anymore.
611  */
617 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
619 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
621 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
623 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
625 int64_t av_frame_get_channel_layout (const AVFrame *frame);
629 int av_frame_get_channels (const AVFrame *frame);
648 #if FF_API_FRAME_QP
650 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
653 #endif
662 #endif
663 
664 /**
665  * Get the name of a colorspace.
666  * @return a static string identifying the colorspace; can be NULL.
667  */
668 const char *av_get_colorspace_name(enum AVColorSpace val);
669 
670 /**
671  * Allocate an AVFrame and set its fields to default values. The resulting
672  * struct must be freed using av_frame_free().
673  *
674  * @return An AVFrame filled with default values or NULL on failure.
675  *
676  * @note this only allocates the AVFrame itself, not the data buffers. Those
677  * must be allocated through other means, e.g. with av_frame_get_buffer() or
678  * manually.
679  */
680 AVFrame *av_frame_alloc(void);
681 
682 /**
683  * Free the frame and any dynamically allocated objects in it,
684  * e.g. extended_data. If the frame is reference counted, it will be
685  * unreferenced first.
686  *
687  * @param frame frame to be freed. The pointer will be set to NULL.
688  */
689 void av_frame_free(AVFrame **frame);
690 
691 /**
692  * Set up a new reference to the data described by the source frame.
693  *
694  * Copy frame properties from src to dst and create a new reference for each
695  * AVBufferRef from src.
696  *
697  * If src is not reference counted, new buffers are allocated and the data is
698  * copied.
699  *
700  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
701  * or newly allocated with av_frame_alloc() before calling this
702  * function, or undefined behavior will occur.
703  *
704  * @return 0 on success, a negative AVERROR on error
705  */
706 int av_frame_ref(AVFrame *dst, const AVFrame *src);
707 
708 /**
709  * Create a new frame that references the same data as src.
710  *
711  * This is a shortcut for av_frame_alloc()+av_frame_ref().
712  *
713  * @return newly created AVFrame on success, NULL on error.
714  */
716 
717 /**
718  * Unreference all the buffers referenced by frame and reset the frame fields.
719  */
721 
722 /**
723  * Move everything contained in src to dst and reset src.
724  *
725  * @warning: dst is not unreferenced, but directly overwritten without reading
726  * or deallocating its contents. Call av_frame_unref(dst) manually
727  * before calling this function to ensure that no memory is leaked.
728  */
729 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
730 
731 /**
732  * Allocate new buffer(s) for audio or video data.
733  *
734  * The following fields must be set on frame before calling this function:
735  * - format (pixel format for video, sample format for audio)
736  * - width and height for video
737  * - nb_samples and channel_layout for audio
738  *
739  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
740  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
741  * For planar formats, one buffer will be allocated for each plane.
742  *
743  * @warning: if frame already has been allocated, calling this function will
744  * leak memory. In addition, undefined behavior can occur in certain
745  * cases.
746  *
747  * @param frame frame in which to store the new buffers.
748  * @param align Required buffer size alignment. If equal to 0, alignment will be
749  * chosen automatically for the current CPU. It is highly
750  * recommended to pass 0 here unless you know what you are doing.
751  *
752  * @return 0 on success, a negative AVERROR on error.
753  */
755 
756 /**
757  * Check if the frame data is writable.
758  *
759  * @return A positive value if the frame data is writable (which is true if and
760  * only if each of the underlying buffers has only one reference, namely the one
761  * stored in this frame). Return 0 otherwise.
762  *
763  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
764  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
765  *
766  * @see av_frame_make_writable(), av_buffer_is_writable()
767  */
769 
770 /**
771  * Ensure that the frame data is writable, avoiding data copy if possible.
772  *
773  * Do nothing if the frame is writable, allocate new buffers and copy the data
774  * if it is not.
775  *
776  * @return 0 on success, a negative AVERROR on error.
777  *
778  * @see av_frame_is_writable(), av_buffer_is_writable(),
779  * av_buffer_make_writable()
780  */
782 
783 /**
784  * Copy the frame data from src to dst.
785  *
786  * This function does not allocate anything, dst must be already initialized and
787  * allocated with the same parameters as src.
788  *
789  * This function only copies the frame data (i.e. the contents of the data /
790  * extended data arrays), not any other properties.
791  *
792  * @return >= 0 on success, a negative AVERROR on error.
793  */
794 int av_frame_copy(AVFrame *dst, const AVFrame *src);
795 
796 /**
797  * Copy only "metadata" fields from src to dst.
798  *
799  * Metadata for the purpose of this function are those fields that do not affect
800  * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
801  * aspect ratio (for video), but not width/height or channel layout.
802  * Side data is also copied.
803  */
804 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
805 
806 /**
807  * Get the buffer reference a given data plane is stored in.
808  *
809  * @param plane index of the data plane of interest in frame->extended_data.
810  *
811  * @return the buffer reference that contains the plane or NULL if the input
812  * frame is not valid.
813  */
815 
816 /**
817  * Add a new side data to a frame.
818  *
819  * @param frame a frame to which the side data should be added
820  * @param type type of the added side data
821  * @param size size of the side data
822  *
823  * @return newly added side data on success, NULL on error
824  */
827  int size);
828 
829 /**
830  * Add a new side data to a frame from an existing AVBufferRef
831  *
832  * @param frame a frame to which the side data should be added
833  * @param type the type of the added side data
834  * @param buf an AVBufferRef to add as side data. The ownership of
835  * the reference is transferred to the frame.
836  *
837  * @return newly added side data on success, NULL on error. On failure
838  * the frame is unchanged and the AVBufferRef remains owned by
839  * the caller.
840  */
843  AVBufferRef *buf);
844 
845 /**
846  * @return a pointer to the side data of a given type on success, NULL if there
847  * is no side data with such type in this frame.
848  */
851 
852 /**
853  * If side data of the supplied type exists in the frame, free it and remove it
854  * from the frame.
855  */
857 
858 
859 /**
860  * Flags for frame cropping.
861  */
862 enum {
863  /**
864  * Apply the maximum possible cropping, even if it requires setting the
865  * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
866  * to FFmpeg API is generally not allowed, and causes undefined behavior
867  * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
868  * are explicitly documented to accept it. Use this flag only if you
869  * absolutely know what you are doing.
870  */
872 };
873 
874 /**
875  * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
876  * crop_bottom fields. If cropping is successful, the function will adjust the
877  * data pointers and the width/height fields, and set the crop fields to 0.
878  *
879  * In all cases, the cropping boundaries will be rounded to the inherent
880  * alignment of the pixel format. In some cases, such as for opaque hwaccel
881  * formats, the left/top cropping is ignored. The crop fields are set to 0 even
882  * if the cropping was rounded or ignored.
883  *
884  * @param frame the frame which should be cropped
885  * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
886  *
887  * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
888  * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
889  */
891 
892 /**
893  * @return a string identifying the side data type
894  */
896 
897 /**
898  * @}
899  */
900 
901 #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:227
This structure describes decoded (raw) audio or video data.
Definition: frame.h:226
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defi...
Definition: frame.h:113
attribute_deprecated int qscale_type
Definition: frame.h:555
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
Definition: frame.h:498
attribute_deprecated void av_frame_set_pkt_pos(AVFrame *frame, int64_t val)
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:418
AVDictionary * metadata
Definition: frame.h:192
void * opaque
for some private data of the user
Definition: frame.h:354
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:436
Content light level (based on CTA-861.3).
Definition: frame.h:136
Timecode which conforms to SMPTE ST 12-1.
Definition: frame.h:168
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:368
Convenience header that includes libavutil's core.
Mastering display metadata associated with a video frame.
Definition: frame.h:119
attribute_deprecated AVBufferRef * qp_table_buf
Definition: frame.h:558
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
Definition: frame.c:582
size_t crop_bottom
Definition: frame.h:586
attribute_deprecated enum AVColorRange av_frame_get_color_range(const AVFrame *frame)
#define src
Definition: vp8dsp.c:254
attribute_deprecated int8_t * qscale_table
QP table.
Definition: frame.h:547
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:457
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
Definition: frame.c:734
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:564
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:486
size_t crop_left
Definition: frame.h:587
#define f(width, name)
Definition: cbs_vp9.c:255
attribute_deprecated int qstride
QP store stride.
Definition: frame.h:552
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:604
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:443
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:319
AVBufferRef * buf
Definition: frame.h:193
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:188
AVDictionary * metadata
metadata.
Definition: frame.h:513
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:373
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:509
ptrdiff_t size
Definition: opengl_enc.c:101
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:433
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:439
attribute_deprecated uint64_t error[AV_NUM_DATA_POINTERS]
Definition: frame.h:361
AVFrameSideData ** side_data
Definition: frame.h:438
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:284
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:879
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)
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:471
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:58
enum AVColorSpace colorspace
YUV colorspace type.
Definition: frame.h:482
Libavutil version macros.
Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unalig...
Definition: frame.h:871
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:792
attribute_deprecated AVDictionary * av_frame_get_metadata(const AVFrame *frame)
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:404
size_t crop_top
Definition: frame.h:585
int channels
number of audio channels, only used for audio.
Definition: frame.h:531
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:309
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:464
int display_picture_number
picture number in display order
Definition: frame.h:344
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:432
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:690
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:659
AVFrameSideDataType
Definition: frame.h:48
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:349
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
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:540
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:299
int coded_picture_number
picture number in bitstream order
Definition: frame.h:340
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown...
Definition: frame.h:506
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:594
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:257
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:314
uint8_t * data
Definition: frame.h:190
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:805
void * buf
Definition: avisynth_c.h:690
size_t crop_right
Definition: frame.h:588
GLint GLenum type
Definition: opengl_enc.c:105
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:394
attribute_deprecated enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
int sample_rate
Sample rate of the audio data.
Definition: frame.h:399
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, int size)
Add a new side data to a frame.
Definition: frame.c:722
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:383
attribute_deprecated void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
refcounted data buffer API
AVPictureType
Definition: avutil.h:272
enum AVChromaLocation chroma_location
Definition: frame.h:484
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:491
AVActiveFormatDescription
Definition: frame.h:171
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:522
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
Definition: frame.c:819
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:324
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:553
enum AVFrameSideDataType type
Definition: frame.h:189
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:611
#define flags(name, subs,...)
Definition: cbs_av1.c:596
#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:327
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:335
A reference to a data buffer.
Definition: buffer.h:81
attribute_deprecated int av_frame_get_channels(const AVFrame *frame)
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:105
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:378
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
Definition: frame.h:575
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:304
attribute_deprecated void av_frame_set_sample_rate(AVFrame *frame, int val)
enum AVColorPrimaries color_primaries
Definition: frame.h:473
int height
Definition: frame.h:284
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:531
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:475
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:273
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:540
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:292
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:654
Raw QP table data.
Definition: frame.h:159