3 * This file is part of FFmpeg.
5 * FFmpeg is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * FFmpeg is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with FFmpeg; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * reference-counted frame API
26 #ifndef AVUTIL_FRAME_H
27 #define AVUTIL_FRAME_H
35 #include "samplefmt.h"
41 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
42 AVCOL_SPC_UNSPECIFIED = 2,
44 AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
45 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
46 AVCOL_SPC_SMPTE240M = 7,
47 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
48 AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system
49 AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system
50 AVCOL_SPC_NB , ///< Not part of ABI
52 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
55 AVCOL_RANGE_UNSPECIFIED = 0,
56 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
57 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
58 AVCOL_RANGE_NB , ///< Not part of ABI
63 * @defgroup lavu_frame AVFrame
67 * AVFrame is an abstraction for reference-counted raw multimedia data.
70 enum AVFrameSideDataType {
72 * The data is the AVPanScan struct defined in libavcodec.
74 AV_FRAME_DATA_PANSCAN,
76 * ATSC A53 Part 4 Closed Captions.
77 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
78 * The number of bytes of CC data is AVFrameSideData.size.
82 * Stereoscopic 3d metadata.
83 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
85 AV_FRAME_DATA_STEREO3D,
87 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
89 AV_FRAME_DATA_MATRIXENCODING,
91 * Metadata relevant to a downmix procedure.
92 * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
94 AV_FRAME_DATA_DOWNMIX_INFO,
96 * ReplayGain information in the form of the AVReplayGain struct.
98 AV_FRAME_DATA_REPLAYGAIN,
101 typedef struct AVFrameSideData {
102 enum AVFrameSideDataType type;
105 AVDictionary *metadata;
109 * This structure describes decoded (raw) audio or video data.
111 * AVFrame must be allocated using av_frame_alloc(). Note that this only
112 * allocates the AVFrame itself, the buffers for the data must be managed
113 * through other means (see below).
114 * AVFrame must be freed with av_frame_free().
116 * AVFrame is typically allocated once and then reused multiple times to hold
117 * different data (e.g. a single AVFrame to hold frames received from a
118 * decoder). In such a case, av_frame_unref() will free any references held by
119 * the frame and reset it to its original clean state before it
122 * The data described by an AVFrame is usually reference counted through the
123 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
124 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
125 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
126 * every single data plane must be contained in one of the buffers in
127 * AVFrame.buf or AVFrame.extended_buf.
128 * There may be a single buffer for all the data, or one separate buffer for
129 * each plane, or anything in between.
131 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
132 * to the end with a minor bump.
133 * Similarly fields that are marked as to be only accessed by
134 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
135 * without breaking compatibility with each other.
137 typedef struct AVFrame {
138 #define AV_NUM_DATA_POINTERS 8
140 * pointer to the picture/channel planes.
141 * This might be different from the first allocated byte
143 * Some decoders access areas outside 0,0 - width,height, please
144 * see avcodec_align_dimensions2(). Some filters and swscale can read
145 * up to 16 bytes beyond the planes, if these filters are to be used,
146 * then 16 extra bytes must be allocated.
148 uint8_t *data[AV_NUM_DATA_POINTERS];
151 * For video, size in bytes of each picture line.
152 * For audio, size in bytes of each plane.
154 * For audio, only linesize[0] may be set. For planar audio, each channel
155 * plane must be the same size.
157 * For video the linesizes should be multiplies of the CPUs alignment
158 * preference, this is 16 or 32 for modern desktop CPUs.
159 * Some code requires such alignment other code can be slower without
160 * correct alignment, for yet other it makes no difference.
162 * @note The linesize may be larger than the size of usable data -- there
163 * may be extra padding present for performance reasons.
165 int linesize[AV_NUM_DATA_POINTERS];
168 * pointers to the data planes/channels.
170 * For video, this should simply point to data[].
172 * For planar audio, each channel has a separate data pointer, and
173 * linesize[0] contains the size of each channel buffer.
174 * For packed audio, there is just one data pointer, and linesize[0]
175 * contains the total size of the buffer for all channels.
177 * Note: Both data and extended_data should always be set in a valid frame,
178 * but for planar audio with more channels that can fit in data,
179 * extended_data must be used in order to access all channels.
181 uint8_t **extended_data;
184 * width and height of the video frame
189 * number of audio samples (per channel) described by this frame
194 * format of the frame, -1 if unknown or unset
195 * Values correspond to enum AVPixelFormat for video frames,
196 * enum AVSampleFormat for audio)
201 * 1 -> keyframe, 0-> not
206 * Picture type of the frame.
208 enum AVPictureType pict_type;
210 #if FF_API_AVFRAME_LAVC
212 uint8_t *base[AV_NUM_DATA_POINTERS];
216 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
218 AVRational sample_aspect_ratio;
221 * Presentation timestamp in time_base units (time when frame should be shown to user).
226 * PTS copied from the AVPacket that was decoded to produce this frame.
231 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isnt used)
232 * This is also the Presentation time of this AVFrame calculated from
233 * only AVPacket.dts values without pts values.
238 * picture number in bitstream order
240 int coded_picture_number;
242 * picture number in display order
244 int display_picture_number;
247 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
251 #if FF_API_AVFRAME_LAVC
259 int8_t *qscale_table;
270 * mbskip_table[mb]>=1 if MB didn't change
271 * stride= mb_width = (width+15)>>4
274 uint8_t *mbskip_table;
277 * motion vector table
280 * int mv_sample_log2= 4 - motion_subsample_log2;
281 * int mb_width= (width+15)>>4;
282 * int mv_stride= (mb_width << mv_sample_log2) + 1;
283 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
286 int16_t (*motion_val[2])[2];
289 * macroblock type table
290 * mb_type_base + mb_width + 2
302 * motion reference frame index
303 * the order in which these are stored can depend on the codec.
306 int8_t *ref_index[2];
310 * for some private data of the user
317 uint64_t error[AV_NUM_DATA_POINTERS];
319 #if FF_API_AVFRAME_LAVC
325 * When decoding, this signals how much the picture must be delayed.
326 * extra_delay = repeat_pict / (2*fps)
331 * The content of the picture is interlaced.
333 int interlaced_frame;
336 * If the content is interlaced, is top field displayed first.
341 * Tell user application that palette has changed from previous frame.
343 int palette_has_changed;
345 #if FF_API_AVFRAME_LAVC
353 struct AVPanScan *pan_scan;
357 * reordered opaque 64bit (generally an integer or a double precision float
358 * PTS but can be anything).
359 * The user sets AVCodecContext.reordered_opaque to represent the input at
361 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
362 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
363 * @deprecated in favor of pkt_pts
365 int64_t reordered_opaque;
367 #if FF_API_AVFRAME_LAVC
369 * @deprecated this field is unused
371 attribute_deprecated void *hwaccel_picture_private;
374 struct AVCodecContext *owner;
379 * log2 of the size of the block which a single vector in motion_val represents:
380 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
382 uint8_t motion_subsample_log2;
386 * Sample rate of the audio data.
391 * Channel layout of the audio data.
393 uint64_t channel_layout;
396 * AVBuffer references backing the data for this frame. If all elements of
397 * this array are NULL, then this frame is not reference counted.
399 * There may be at most one AVBuffer per data plane, so for video this array
400 * always contains all the references. For planar audio with more than
401 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
402 * this array. Then the extra AVBufferRef pointers are stored in the
403 * extended_buf array.
405 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
408 * For planar audio which requires more than AV_NUM_DATA_POINTERS
409 * AVBufferRef pointers, this array will hold all the references which
410 * cannot fit into AVFrame.buf.
412 * Note that this is different from AVFrame.extended_data, which always
413 * contains all the pointers. This array only contains the extra pointers,
414 * which cannot fit into AVFrame.buf.
416 * This array is always allocated using av_malloc() by whoever constructs
417 * the frame. It is freed in av_frame_unref().
419 AVBufferRef **extended_buf;
421 * Number of elements in extended_buf.
425 AVFrameSideData **side_data;
429 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
430 * Flags describing additional frame properties.
436 * The frame data may be corrupted, e.g. due to decoding errors.
438 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
444 * Frame flags, a combination of @ref lavu_frame_flags
449 * frame timestamp estimated using various heuristics, in stream time base
450 * Code outside libavcodec should access this field using:
451 * av_frame_get_best_effort_timestamp(frame)
453 * - decoding: set by libavcodec, read by user.
455 int64_t best_effort_timestamp;
458 * reordered pos from the last AVPacket that has been input into the decoder
459 * Code outside libavcodec should access this field using:
460 * av_frame_get_pkt_pos(frame)
462 * - decoding: Read by user.
467 * duration of the corresponding packet, expressed in
468 * AVStream->time_base units, 0 if unknown.
469 * Code outside libavcodec should access this field using:
470 * av_frame_get_pkt_duration(frame)
472 * - decoding: Read by user.
474 int64_t pkt_duration;
478 * Code outside libavcodec should access this field using:
479 * av_frame_get_metadata(frame)
480 * - encoding: Set by user.
481 * - decoding: Set by libavcodec.
483 AVDictionary *metadata;
486 * decode error flags of the frame, set to a combination of
487 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
488 * were errors during the decoding.
489 * Code outside libavcodec should access this field using:
490 * av_frame_get_decode_error_flags(frame)
492 * - decoding: set by libavcodec, read by user.
494 int decode_error_flags;
495 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
496 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
499 * number of audio channels, only used for audio.
500 * Code outside libavcodec should access this field using:
501 * av_frame_get_channels(frame)
503 * - decoding: Read by user.
508 * size of the corresponding packet containing the compressed
509 * frame. It must be accessed using av_frame_get_pkt_size() and
510 * av_frame_set_pkt_size().
511 * It is set to a negative value if unknown.
513 * - decoding: set by libavcodec, read by user.
518 * YUV colorspace type.
519 * It must be accessed using av_frame_get_colorspace() and
520 * av_frame_set_colorspace().
521 * - encoding: Set by user
522 * - decoding: Set by libavcodec
524 enum AVColorSpace colorspace;
527 * MPEG vs JPEG YUV range.
528 * It must be accessed using av_frame_get_color_range() and
529 * av_frame_set_color_range().
530 * - encoding: Set by user
531 * - decoding: Set by libavcodec
533 enum AVColorRange color_range;
537 * Not to be accessed directly from outside libavutil
539 AVBufferRef *qp_table_buf;
543 * Accessors for some AVFrame fields.
544 * The position of these field in the structure is not part of the ABI,
545 * they should not be accessed directly outside libavcodec.
547 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
548 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
549 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
550 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
551 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
552 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
553 int64_t av_frame_get_channel_layout (const AVFrame *frame);
554 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
555 int av_frame_get_channels (const AVFrame *frame);
556 void av_frame_set_channels (AVFrame *frame, int val);
557 int av_frame_get_sample_rate (const AVFrame *frame);
558 void av_frame_set_sample_rate (AVFrame *frame, int val);
559 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
560 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
561 int av_frame_get_decode_error_flags (const AVFrame *frame);
562 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
563 int av_frame_get_pkt_size(const AVFrame *frame);
564 void av_frame_set_pkt_size(AVFrame *frame, int val);
565 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
566 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
567 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
568 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
569 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
570 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
571 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
574 * Get the name of a colorspace.
575 * @return a static string identifying the colorspace; can be NULL.
577 const char *av_get_colorspace_name(enum AVColorSpace val);
580 * Allocate an AVFrame and set its fields to default values. The resulting
581 * struct must be freed using av_frame_free().
583 * @return An AVFrame filled with default values or NULL on failure.
585 * @note this only allocates the AVFrame itself, not the data buffers. Those
586 * must be allocated through other means, e.g. with av_frame_get_buffer() or
589 AVFrame *av_frame_alloc(void);
592 * Free the frame and any dynamically allocated objects in it,
593 * e.g. extended_data. If the frame is reference counted, it will be
594 * unreferenced first.
596 * @param frame frame to be freed. The pointer will be set to NULL.
598 void av_frame_free(AVFrame **frame);
601 * Set up a new reference to the data described by the source frame.
603 * Copy frame properties from src to dst and create a new reference for each
604 * AVBufferRef from src.
606 * If src is not reference counted, new buffers are allocated and the data is
609 * @return 0 on success, a negative AVERROR on error
611 int av_frame_ref(AVFrame *dst, const AVFrame *src);
614 * Create a new frame that references the same data as src.
616 * This is a shortcut for av_frame_alloc()+av_frame_ref().
618 * @return newly created AVFrame on success, NULL on error.
620 AVFrame *av_frame_clone(const AVFrame *src);
623 * Unreference all the buffers referenced by frame and reset the frame fields.
625 void av_frame_unref(AVFrame *frame);
628 * Move everythnig contained in src to dst and reset src.
630 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
633 * Allocate new buffer(s) for audio or video data.
635 * The following fields must be set on frame before calling this function:
636 * - format (pixel format for video, sample format for audio)
637 * - width and height for video
638 * - nb_samples and channel_layout for audio
640 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
641 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
642 * For planar formats, one buffer will be allocated for each plane.
644 * @param frame frame in which to store the new buffers.
645 * @param align required buffer size alignment
647 * @return 0 on success, a negative AVERROR on error.
649 int av_frame_get_buffer(AVFrame *frame, int align);
652 * Check if the frame data is writable.
654 * @return A positive value if the frame data is writable (which is true if and
655 * only if each of the underlying buffers has only one reference, namely the one
656 * stored in this frame). Return 0 otherwise.
658 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
659 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
661 * @see av_frame_make_writable(), av_buffer_is_writable()
663 int av_frame_is_writable(AVFrame *frame);
666 * Ensure that the frame data is writable, avoiding data copy if possible.
668 * Do nothing if the frame is writable, allocate new buffers and copy the data
671 * @return 0 on success, a negative AVERROR on error.
673 * @see av_frame_is_writable(), av_buffer_is_writable(),
674 * av_buffer_make_writable()
676 int av_frame_make_writable(AVFrame *frame);
679 * Copy the frame data from src to dst.
681 * This function does not allocate anything, dst must be already initialized and
682 * allocated with the same parameters as src.
684 * This function only copies the frame data (i.e. the contents of the data /
685 * extended data arrays), not any other properties.
687 * @return >= 0 on success, a negative AVERROR on error.
689 int av_frame_copy(AVFrame *dst, const AVFrame *src);
692 * Copy only "metadata" fields from src to dst.
694 * Metadata for the purpose of this function are those fields that do not affect
695 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
696 * aspect ratio (for video), but not width/height or channel layout.
697 * Side data is also copied.
699 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
702 * Get the buffer reference a given data plane is stored in.
704 * @param plane index of the data plane of interest in frame->extended_data.
706 * @return the buffer reference that contains the plane or NULL if the input
707 * frame is not valid.
709 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
712 * Add a new side data to a frame.
714 * @param frame a frame to which the side data should be added
715 * @param type type of the added side data
716 * @param size size of the side data
718 * @return newly added side data on success, NULL on error
720 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
721 enum AVFrameSideDataType type,
725 * @return a pointer to the side data of a given type on success, NULL if there
726 * is no side data with such type in this frame.
728 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
729 enum AVFrameSideDataType type);
732 * If side data of the supplied type exists in the frame, free it and remove it
735 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
741 #endif /* AVUTIL_FRAME_H */