FFmpeg 4.2.2
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 /**
171 * HDR dynamic metadata associated with a video frame. The payload is
172 * an AVDynamicHDRPlus type and contains information for color
173 * volume transform - application 4 of SMPTE 2094-40:2016 standard.
174 */
176
177 /**
178 * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of
179 * array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.
180 */
182};
183
192};
193
194
195/**
196 * Structure to hold side data for an AVFrame.
197 *
198 * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
199 * to the end with a minor bump.
200 */
201typedef struct AVFrameSideData {
203 uint8_t *data;
204 int size;
208
209/**
210 * Structure describing a single Region Of Interest.
211 *
212 * When multiple regions are defined in a single side-data block, they
213 * should be ordered from most to least important - some encoders are only
214 * capable of supporting a limited number of distinct regions, so will have
215 * to truncate the list.
216 *
217 * When overlapping regions are defined, the first region containing a given
218 * area of the frame applies.
219 */
220typedef struct AVRegionOfInterest {
221 /**
222 * Must be set to the size of this data structure (that is,
223 * sizeof(AVRegionOfInterest)).
224 */
225 uint32_t self_size;
226 /**
227 * Distance in pixels from the top edge of the frame to the top and
228 * bottom edges and from the left edge of the frame to the left and
229 * right edges of the rectangle defining this region of interest.
230 *
231 * The constraints on a region are encoder dependent, so the region
232 * actually affected may be slightly larger for alignment or other
233 * reasons.
234 */
235 int top;
237 int left;
238 int right;
239 /**
240 * Quantisation offset.
241 *
242 * Must be in the range -1 to +1. A value of zero indicates no quality
243 * change. A negative value asks for better quality (less quantisation),
244 * while a positive value asks for worse quality (greater quantisation).
245 *
246 * The range is calibrated so that the extreme values indicate the
247 * largest possible offset - if the rest of the frame is encoded with the
248 * worst possible quality, an offset of -1 indicates that this region
249 * should be encoded with the best possible quality anyway. Intermediate
250 * values are then interpolated in some codec-dependent way.
251 *
252 * For example, in 10-bit H.264 the quantisation parameter varies between
253 * -12 and 51. A typical qoffset value of -1/10 therefore indicates that
254 * this region should be encoded with a QP around one-tenth of the full
255 * range better than the rest of the frame. So, if most of the frame
256 * were to be encoded with a QP of around 30, this region would get a QP
257 * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
258 * An extreme value of -1 would indicate that this region should be
259 * encoded with the best possible quality regardless of the treatment of
260 * the rest of the frame - that is, should be encoded at a QP of -12.
261 */
264
265/**
266 * This structure describes decoded (raw) audio or video data.
267 *
268 * AVFrame must be allocated using av_frame_alloc(). Note that this only
269 * allocates the AVFrame itself, the buffers for the data must be managed
270 * through other means (see below).
271 * AVFrame must be freed with av_frame_free().
272 *
273 * AVFrame is typically allocated once and then reused multiple times to hold
274 * different data (e.g. a single AVFrame to hold frames received from a
275 * decoder). In such a case, av_frame_unref() will free any references held by
276 * the frame and reset it to its original clean state before it
277 * is reused again.
278 *
279 * The data described by an AVFrame is usually reference counted through the
280 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
281 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
282 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
283 * every single data plane must be contained in one of the buffers in
284 * AVFrame.buf or AVFrame.extended_buf.
285 * There may be a single buffer for all the data, or one separate buffer for
286 * each plane, or anything in between.
287 *
288 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
289 * to the end with a minor bump.
290 *
291 * Fields can be accessed through AVOptions, the name string used, matches the
292 * C structure field name for fields accessible through AVOptions. The AVClass
293 * for AVFrame can be obtained from avcodec_get_frame_class()
294 */
295typedef struct AVFrame {
296#define AV_NUM_DATA_POINTERS 8
297 /**
298 * pointer to the picture/channel planes.
299 * This might be different from the first allocated byte
300 *
301 * Some decoders access areas outside 0,0 - width,height, please
302 * see avcodec_align_dimensions2(). Some filters and swscale can read
303 * up to 16 bytes beyond the planes, if these filters are to be used,
304 * then 16 extra bytes must be allocated.
305 *
306 * NOTE: Except for hwaccel formats, pointers not needed by the format
307 * MUST be set to NULL.
308 */
310
311 /**
312 * For video, size in bytes of each picture line.
313 * For audio, size in bytes of each plane.
314 *
315 * For audio, only linesize[0] may be set. For planar audio, each channel
316 * plane must be the same size.
317 *
318 * For video the linesizes should be multiples of the CPUs alignment
319 * preference, this is 16 or 32 for modern desktop CPUs.
320 * Some code requires such alignment other code can be slower without
321 * correct alignment, for yet other it makes no difference.
322 *
323 * @note The linesize may be larger than the size of usable data -- there
324 * may be extra padding present for performance reasons.
325 */
327
328 /**
329 * pointers to the data planes/channels.
330 *
331 * For video, this should simply point to data[].
332 *
333 * For planar audio, each channel has a separate data pointer, and
334 * linesize[0] contains the size of each channel buffer.
335 * For packed audio, there is just one data pointer, and linesize[0]
336 * contains the total size of the buffer for all channels.
337 *
338 * Note: Both data and extended_data should always be set in a valid frame,
339 * but for planar audio with more channels that can fit in data,
340 * extended_data must be used in order to access all channels.
341 */
342 uint8_t **extended_data;
343
344 /**
345 * @name Video dimensions
346 * Video frames only. The coded dimensions (in pixels) of the video frame,
347 * i.e. the size of the rectangle that contains some well-defined values.
348 *
349 * @note The part of the frame intended for display/presentation is further
350 * restricted by the @ref cropping "Cropping rectangle".
351 * @{
352 */
354 /**
355 * @}
356 */
357
358 /**
359 * number of audio samples (per channel) described by this frame
360 */
362
363 /**
364 * format of the frame, -1 if unknown or unset
365 * Values correspond to enum AVPixelFormat for video frames,
366 * enum AVSampleFormat for audio)
367 */
369
370 /**
371 * 1 -> keyframe, 0-> not
372 */
374
375 /**
376 * Picture type of the frame.
377 */
379
380 /**
381 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
382 */
384
385 /**
386 * Presentation timestamp in time_base units (time when frame should be shown to user).
387 */
388 int64_t pts;
389
390#if FF_API_PKT_PTS
391 /**
392 * PTS copied from the AVPacket that was decoded to produce this frame.
393 * @deprecated use the pts field instead
394 */
396 int64_t pkt_pts;
397#endif
398
399 /**
400 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
401 * This is also the Presentation time of this AVFrame calculated from
402 * only AVPacket.dts values without pts values.
403 */
404 int64_t pkt_dts;
405
406 /**
407 * picture number in bitstream order
408 */
410 /**
411 * picture number in display order
412 */
414
415 /**
416 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
417 */
419
420 /**
421 * for some private data of the user
422 */
423 void *opaque;
424
425#if FF_API_ERROR_FRAME
426 /**
427 * @deprecated unused
428 */
431#endif
432
433 /**
434 * When decoding, this signals how much the picture must be delayed.
435 * extra_delay = repeat_pict / (2*fps)
436 */
438
439 /**
440 * The content of the picture is interlaced.
441 */
443
444 /**
445 * If the content is interlaced, is top field displayed first.
446 */
448
449 /**
450 * Tell user application that palette has changed from previous frame.
451 */
453
454 /**
455 * reordered opaque 64 bits (generally an integer or a double precision float
456 * PTS but can be anything).
457 * The user sets AVCodecContext.reordered_opaque to represent the input at
458 * that time,
459 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
460 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
461 */
463
464 /**
465 * Sample rate of the audio data.
466 */
468
469 /**
470 * Channel layout of the audio data.
471 */
473
474 /**
475 * AVBuffer references backing the data for this frame. If all elements of
476 * this array are NULL, then this frame is not reference counted. This array
477 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
478 * also be non-NULL for all j < i.
479 *
480 * There may be at most one AVBuffer per data plane, so for video this array
481 * always contains all the references. For planar audio with more than
482 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
483 * this array. Then the extra AVBufferRef pointers are stored in the
484 * extended_buf array.
485 */
487
488 /**
489 * For planar audio which requires more than AV_NUM_DATA_POINTERS
490 * AVBufferRef pointers, this array will hold all the references which
491 * cannot fit into AVFrame.buf.
492 *
493 * Note that this is different from AVFrame.extended_data, which always
494 * contains all the pointers. This array only contains the extra pointers,
495 * which cannot fit into AVFrame.buf.
496 *
497 * This array is always allocated using av_malloc() by whoever constructs
498 * the frame. It is freed in av_frame_unref().
499 */
501 /**
502 * Number of elements in extended_buf.
503 */
505
508
509/**
510 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
511 * @ingroup lavu_frame
512 * Flags describing additional frame properties.
513 *
514 * @{
515 */
516
517/**
518 * The frame data may be corrupted, e.g. due to decoding errors.
519 */
520#define AV_FRAME_FLAG_CORRUPT (1 << 0)
521/**
522 * A flag to mark the frames which need to be decoded, but shouldn't be output.
523 */
524#define AV_FRAME_FLAG_DISCARD (1 << 2)
525/**
526 * @}
527 */
528
529 /**
530 * Frame flags, a combination of @ref lavu_frame_flags
531 */
532 int flags;
533
534 /**
535 * MPEG vs JPEG YUV range.
536 * - encoding: Set by user
537 * - decoding: Set by libavcodec
538 */
540
542
544
545 /**
546 * YUV colorspace type.
547 * - encoding: Set by user
548 * - decoding: Set by libavcodec
549 */
551
553
554 /**
555 * frame timestamp estimated using various heuristics, in stream time base
556 * - encoding: unused
557 * - decoding: set by libavcodec, read by user.
558 */
560
561 /**
562 * reordered pos from the last AVPacket that has been input into the decoder
563 * - encoding: unused
564 * - decoding: Read by user.
565 */
566 int64_t pkt_pos;
567
568 /**
569 * duration of the corresponding packet, expressed in
570 * AVStream->time_base units, 0 if unknown.
571 * - encoding: unused
572 * - decoding: Read by user.
573 */
575
576 /**
577 * metadata.
578 * - encoding: Set by user.
579 * - decoding: Set by libavcodec.
580 */
582
583 /**
584 * decode error flags of the frame, set to a combination of
585 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
586 * were errors during the decoding.
587 * - encoding: unused
588 * - decoding: set by libavcodec, read by user.
589 */
591#define FF_DECODE_ERROR_INVALID_BITSTREAM 1
592#define FF_DECODE_ERROR_MISSING_REFERENCE 2
593#define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
594#define FF_DECODE_ERROR_DECODE_SLICES 8
595
596 /**
597 * number of audio channels, only used for audio.
598 * - encoding: unused
599 * - decoding: Read by user.
600 */
602
603 /**
604 * size of the corresponding packet containing the compressed
605 * frame.
606 * It is set to a negative value if unknown.
607 * - encoding: unused
608 * - decoding: set by libavcodec, read by user.
609 */
611
612#if FF_API_FRAME_QP
613 /**
614 * QP table
615 */
618 /**
619 * QP store stride
620 */
623
626
629#endif
630 /**
631 * For hwaccel-format frames, this should be a reference to the
632 * AVHWFramesContext describing the frame.
633 */
635
636 /**
637 * AVBufferRef for free use by the API user. FFmpeg will never check the
638 * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
639 * the frame is unreferenced. av_frame_copy_props() calls create a new
640 * reference with av_buffer_ref() for the target frame's opaque_ref field.
641 *
642 * This is unrelated to the opaque field, although it serves a similar
643 * purpose.
644 */
646
647 /**
648 * @anchor cropping
649 * @name Cropping
650 * Video frames only. The number of pixels to discard from the the
651 * top/bottom/left/right border of the frame to obtain the sub-rectangle of
652 * the frame intended for presentation.
653 * @{
654 */
655 size_t crop_top;
657 size_t crop_left;
659 /**
660 * @}
661 */
662
663 /**
664 * AVBufferRef for internal use by a single libav* library.
665 * Must not be used to transfer data between libraries.
666 * Has to be NULL when ownership of the frame leaves the respective library.
667 *
668 * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
669 *
670 * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
671 * av_frame_copy_props() calls create a new reference with av_buffer_ref()
672 * for the target frame's private_ref field.
673 */
675} AVFrame;
676
677#if FF_API_FRAME_GET_SET
678/**
679 * Accessors for some AVFrame fields. These used to be provided for ABI
680 * compatibility, and do not need to be used anymore.
681 */
693void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
718#if FF_API_FRAME_QP
720int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
722int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
723#endif
732#endif
733
734/**
735 * Get the name of a colorspace.
736 * @return a static string identifying the colorspace; can be NULL.
737 */
739
740/**
741 * Allocate an AVFrame and set its fields to default values. The resulting
742 * struct must be freed using av_frame_free().
743 *
744 * @return An AVFrame filled with default values or NULL on failure.
745 *
746 * @note this only allocates the AVFrame itself, not the data buffers. Those
747 * must be allocated through other means, e.g. with av_frame_get_buffer() or
748 * manually.
749 */
751
752/**
753 * Free the frame and any dynamically allocated objects in it,
754 * e.g. extended_data. If the frame is reference counted, it will be
755 * unreferenced first.
756 *
757 * @param frame frame to be freed. The pointer will be set to NULL.
758 */
760
761/**
762 * Set up a new reference to the data described by the source frame.
763 *
764 * Copy frame properties from src to dst and create a new reference for each
765 * AVBufferRef from src.
766 *
767 * If src is not reference counted, new buffers are allocated and the data is
768 * copied.
769 *
770 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
771 * or newly allocated with av_frame_alloc() before calling this
772 * function, or undefined behavior will occur.
773 *
774 * @return 0 on success, a negative AVERROR on error
775 */
776int av_frame_ref(AVFrame *dst, const AVFrame *src);
777
778/**
779 * Create a new frame that references the same data as src.
780 *
781 * This is a shortcut for av_frame_alloc()+av_frame_ref().
782 *
783 * @return newly created AVFrame on success, NULL on error.
784 */
786
787/**
788 * Unreference all the buffers referenced by frame and reset the frame fields.
789 */
791
792/**
793 * Move everything contained in src to dst and reset src.
794 *
795 * @warning: dst is not unreferenced, but directly overwritten without reading
796 * or deallocating its contents. Call av_frame_unref(dst) manually
797 * before calling this function to ensure that no memory is leaked.
798 */
800
801/**
802 * Allocate new buffer(s) for audio or video data.
803 *
804 * The following fields must be set on frame before calling this function:
805 * - format (pixel format for video, sample format for audio)
806 * - width and height for video
807 * - nb_samples and channel_layout for audio
808 *
809 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
810 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
811 * For planar formats, one buffer will be allocated for each plane.
812 *
813 * @warning: if frame already has been allocated, calling this function will
814 * leak memory. In addition, undefined behavior can occur in certain
815 * cases.
816 *
817 * @param frame frame in which to store the new buffers.
818 * @param align Required buffer size alignment. If equal to 0, alignment will be
819 * chosen automatically for the current CPU. It is highly
820 * recommended to pass 0 here unless you know what you are doing.
821 *
822 * @return 0 on success, a negative AVERROR on error.
823 */
825
826/**
827 * Check if the frame data is writable.
828 *
829 * @return A positive value if the frame data is writable (which is true if and
830 * only if each of the underlying buffers has only one reference, namely the one
831 * stored in this frame). Return 0 otherwise.
832 *
833 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
834 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
835 *
836 * @see av_frame_make_writable(), av_buffer_is_writable()
837 */
839
840/**
841 * Ensure that the frame data is writable, avoiding data copy if possible.
842 *
843 * Do nothing if the frame is writable, allocate new buffers and copy the data
844 * if it is not.
845 *
846 * @return 0 on success, a negative AVERROR on error.
847 *
848 * @see av_frame_is_writable(), av_buffer_is_writable(),
849 * av_buffer_make_writable()
850 */
852
853/**
854 * Copy the frame data from src to dst.
855 *
856 * This function does not allocate anything, dst must be already initialized and
857 * allocated with the same parameters as src.
858 *
859 * This function only copies the frame data (i.e. the contents of the data /
860 * extended data arrays), not any other properties.
861 *
862 * @return >= 0 on success, a negative AVERROR on error.
863 */
864int av_frame_copy(AVFrame *dst, const AVFrame *src);
865
866/**
867 * Copy only "metadata" fields from src to dst.
868 *
869 * Metadata for the purpose of this function are those fields that do not affect
870 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
871 * aspect ratio (for video), but not width/height or channel layout.
872 * Side data is also copied.
873 */
874int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
875
876/**
877 * Get the buffer reference a given data plane is stored in.
878 *
879 * @param plane index of the data plane of interest in frame->extended_data.
880 *
881 * @return the buffer reference that contains the plane or NULL if the input
882 * frame is not valid.
883 */
885
886/**
887 * Add a new side data to a frame.
888 *
889 * @param frame a frame to which the side data should be added
890 * @param type type of the added side data
891 * @param size size of the side data
892 *
893 * @return newly added side data on success, NULL on error
894 */
896 enum AVFrameSideDataType type,
897 int size);
898
899/**
900 * Add a new side data to a frame from an existing AVBufferRef
901 *
902 * @param frame a frame to which the side data should be added
903 * @param type the type of the added side data
904 * @param buf an AVBufferRef to add as side data. The ownership of
905 * the reference is transferred to the frame.
906 *
907 * @return newly added side data on success, NULL on error. On failure
908 * the frame is unchanged and the AVBufferRef remains owned by
909 * the caller.
910 */
912 enum AVFrameSideDataType type,
913 AVBufferRef *buf);
914
915/**
916 * @return a pointer to the side data of a given type on success, NULL if there
917 * is no side data with such type in this frame.
918 */
920 enum AVFrameSideDataType type);
921
922/**
923 * If side data of the supplied type exists in the frame, free it and remove it
924 * from the frame.
925 */
927
928
929/**
930 * Flags for frame cropping.
931 */
932enum {
933 /**
934 * Apply the maximum possible cropping, even if it requires setting the
935 * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
936 * to FFmpeg API is generally not allowed, and causes undefined behavior
937 * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
938 * are explicitly documented to accept it. Use this flag only if you
939 * absolutely know what you are doing.
940 */
942};
943
944/**
945 * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
946 * crop_bottom fields. If cropping is successful, the function will adjust the
947 * data pointers and the width/height fields, and set the crop fields to 0.
948 *
949 * In all cases, the cropping boundaries will be rounded to the inherent
950 * alignment of the pixel format. In some cases, such as for opaque hwaccel
951 * formats, the left/top cropping is ignored. The crop fields are set to 0 even
952 * if the cropping was rounded or ignored.
953 *
954 * @param frame the frame which should be cropped
955 * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
956 *
957 * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
958 * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
959 */
961
962/**
963 * @return a string identifying the side data type
964 */
966
967/**
968 * @}
969 */
970
971#endif /* AVUTIL_FRAME_H */
#define attribute_deprecated
Definition: attributes.h:94
Convenience header that includes libavutil's core.
refcounted data buffer API
static AVFrame * frame
Public dictionary API.
#define AV_NUM_DATA_POINTERS
Definition: frame.h:296
struct AVDictionary AVDictionary
Definition: dict.h:86
attribute_deprecated enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
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.
attribute_deprecated void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
attribute_deprecated void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val)
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
attribute_deprecated void av_frame_set_pkt_size(AVFrame *frame, int val)
attribute_deprecated int64_t av_frame_get_pkt_duration(const AVFrame *frame)
attribute_deprecated void av_frame_set_channels(AVFrame *frame, int val)
attribute_deprecated int8_t * av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
attribute_deprecated void av_frame_set_pkt_duration(AVFrame *frame, int64_t val)
attribute_deprecated int av_frame_get_channels(const AVFrame *frame)
AVActiveFormatDescription
Definition: frame.h:184
attribute_deprecated void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
attribute_deprecated int64_t av_frame_get_pkt_pos(const AVFrame *frame)
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
attribute_deprecated int av_frame_get_pkt_size(const AVFrame *frame)
attribute_deprecated void av_frame_set_sample_rate(AVFrame *frame, int val)
attribute_deprecated enum AVColorRange av_frame_get_color_range(const AVFrame *frame)
attribute_deprecated void av_frame_set_channel_layout(AVFrame *frame, int64_t val)
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
attribute_deprecated int64_t av_frame_get_channel_layout(const AVFrame *frame)
AVBufferRef * av_frame_get_plane_buffer(AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
attribute_deprecated int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame)
Accessors for some AVFrame fields.
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
attribute_deprecated void av_frame_set_decode_error_flags(AVFrame *frame, int val)
attribute_deprecated int av_frame_get_sample_rate(const AVFrame *frame)
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.
attribute_deprecated int av_frame_get_decode_error_flags(const AVFrame *frame)
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, int size)
Add a new side data to a frame.
attribute_deprecated AVDictionary * av_frame_get_metadata(const AVFrame *frame)
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
attribute_deprecated int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
attribute_deprecated void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
AVFrameSideDataType
Definition: frame.h:48
attribute_deprecated void av_frame_set_pkt_pos(AVFrame *frame, int64_t val)
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.
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
@ AV_AFD_14_9
Definition: frame.h:188
@ AV_AFD_SAME
Definition: frame.h:185
@ AV_AFD_16_9_SP_14_9
Definition: frame.h:190
@ AV_AFD_4_3_SP_14_9
Definition: frame.h:189
@ AV_AFD_SP_4_3
Definition: frame.h:191
@ AV_AFD_4_3
Definition: frame.h:186
@ AV_AFD_16_9
Definition: frame.h:187
@ AV_FRAME_CROP_UNALIGNED
Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unalig...
Definition: frame.h:941
@ AV_FRAME_DATA_GOP_TIMECODE
The GOP timecode in 25 bit timecode format.
Definition: frame.h:124
@ AV_FRAME_DATA_SPHERICAL
The data represents the AVSphericalMapping structure defined in libavutil/spherical....
Definition: frame.h:130
@ AV_FRAME_DATA_CONTENT_LIGHT_LEVEL
Content light level (based on CTA-861.3).
Definition: frame.h:136
@ AV_FRAME_DATA_PANSCAN
The data is the AVPanScan struct defined in libavcodec.
Definition: frame.h:52
@ AV_FRAME_DATA_DISPLAYMATRIX
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
Definition: frame.h:84
@ AV_FRAME_DATA_A53_CC
ATSC A53 Part 4 Closed Captions.
Definition: frame.h:58
@ AV_FRAME_DATA_AUDIO_SERVICE_TYPE
This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defi...
Definition: frame.h:113
@ AV_FRAME_DATA_DYNAMIC_HDR_PLUS
HDR dynamic metadata associated with a video frame.
Definition: frame.h:175
@ AV_FRAME_DATA_REPLAYGAIN
ReplayGain information in the form of the AVReplayGain struct.
Definition: frame.h:76
@ AV_FRAME_DATA_SKIP_SAMPLES
Recommmends skipping the specified number of samples.
Definition: frame.h:108
@ AV_FRAME_DATA_MASTERING_DISPLAY_METADATA
Mastering display metadata associated with a video frame.
Definition: frame.h:119
@ AV_FRAME_DATA_QP_TABLE_PROPERTIES
Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
Definition: frame.h:152
@ AV_FRAME_DATA_DOWNMIX_INFO
Metadata relevant to a downmix procedure.
Definition: frame.h:72
@ AV_FRAME_DATA_QP_TABLE_DATA
Raw QP table data.
Definition: frame.h:159
@ AV_FRAME_DATA_ICC_PROFILE
The data contains an ICC profile as an opaque octet buffer following the format described by ISO 1507...
Definition: frame.h:143
@ AV_FRAME_DATA_AFD
Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVAc...
Definition: frame.h:89
@ AV_FRAME_DATA_S12M_TIMECODE
Timecode which conforms to SMPTE ST 12-1.
Definition: frame.h:168
@ AV_FRAME_DATA_MATRIXENCODING
The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
Definition: frame.h:67
@ AV_FRAME_DATA_STEREO3D
Stereoscopic 3d metadata.
Definition: frame.h:63
@ AV_FRAME_DATA_MOTION_VECTORS
Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec A...
Definition: frame.h:96
@ AV_FRAME_DATA_REGIONS_OF_INTEREST
Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is ...
Definition: frame.h:181
AVPictureType
Definition: avutil.h:272
swscale version macros
pixel format definitions
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:541
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:519
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:443
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:467
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:496
Utilties for rational number calculation.
A reference to a data buffer.
Definition: buffer.h:81
Structure to hold side data for an AVFrame.
Definition: frame.h:201
enum AVFrameSideDataType type
Definition: frame.h:202
AVDictionary * metadata
Definition: frame.h:205
uint8_t * data
Definition: frame.h:203
AVBufferRef * buf
Definition: frame.h:206
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
int coded_picture_number
picture number in bitstream order
Definition: frame.h:409
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:361
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:388
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:559
int display_picture_number
picture number in display order
Definition: frame.h:413
size_t crop_right
Definition: frame.h:658
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:309
enum AVChromaLocation chroma_location
Definition: frame.h:552
int width
Definition: frame.h:353
AVBufferRef ** extended_buf
For planar audio which requires more than AV_NUM_DATA_POINTERS AVBufferRef pointers,...
Definition: frame.h:500
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame.
Definition: frame.h:634
attribute_deprecated uint64_t error[AV_NUM_DATA_POINTERS]
Definition: frame.h:430
attribute_deprecated int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
Definition: frame.h:396
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:373
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown.
Definition: frame.h:574
void * opaque
for some private data of the user
Definition: frame.h:423
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
Definition: frame.h:566
int pkt_size
size of the corresponding packet containing the compressed frame.
Definition: frame.h:610
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:590
int height
Definition: frame.h:353
AVFrameSideData ** side_data
Definition: frame.h:506
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:532
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:486
int channels
number of audio channels, only used for audio.
Definition: frame.h:601
enum AVColorPrimaries color_primaries
Definition: frame.h:541
AVDictionary * metadata
metadata.
Definition: frame.h:581
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:472
int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:452
attribute_deprecated AVBufferRef * qp_table_buf
Definition: frame.h:628
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:383
AVBufferRef * private_ref
AVBufferRef for internal use by a single libav* library.
Definition: frame.h:674
attribute_deprecated int8_t * qscale_table
QP table.
Definition: frame.h:617
int top_field_first
If the content is interlaced, is top field displayed first.
Definition: frame.h:447
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
Definition: frame.h:418
int interlaced_frame
The content of the picture is interlaced.
Definition: frame.h:442
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
Definition: frame.h:645
size_t crop_top
Definition: frame.h:655
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: frame.h:539
int nb_side_data
Definition: frame.h:507
enum AVColorSpace colorspace
YUV colorspace type.
Definition: frame.h:550
int nb_extended_buf
Number of elements in extended_buf.
Definition: frame.h:504
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
Definition: frame.h:404
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:326
size_t crop_left
Definition: frame.h:657
enum AVColorTransferCharacteristic color_trc
Definition: frame.h:543
int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything).
Definition: frame.h:462
attribute_deprecated int qstride
QP store stride.
Definition: frame.h:622
int sample_rate
Sample rate of the audio data.
Definition: frame.h:467
size_t crop_bottom
Definition: frame.h:656
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:368
int repeat_pict
When decoding, this signals how much the picture must be delayed.
Definition: frame.h:437
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:378
attribute_deprecated int qscale_type
Definition: frame.h:625
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:342
Rational number (pair of numerator and denominator).
Definition: rational.h:58
Structure describing a single Region Of Interest.
Definition: frame.h:220
uint32_t self_size
Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
Definition: frame.h:225
AVRational qoffset
Quantisation offset.
Definition: frame.h:262
int top
Distance in pixels from the top edge of the frame to the top and bottom edges and from the left edge ...
Definition: frame.h:235