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,
92 typedef struct AVFrameSideData {
93 enum AVFrameSideDataType type;
96 AVDictionary *metadata;
100 * This structure describes decoded (raw) audio or video data.
102 * AVFrame must be allocated using av_frame_alloc(). Note that this only
103 * allocates the AVFrame itself, the buffers for the data must be managed
104 * through other means (see below).
105 * AVFrame must be freed with av_frame_free().
107 * AVFrame is typically allocated once and then reused multiple times to hold
108 * different data (e.g. a single AVFrame to hold frames received from a
109 * decoder). In such a case, av_frame_unref() will free any references held by
110 * the frame and reset it to its original clean state before it
113 * The data described by an AVFrame is usually reference counted through the
114 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
115 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
116 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
117 * every single data plane must be contained in one of the buffers in
118 * AVFrame.buf or AVFrame.extended_buf.
119 * There may be a single buffer for all the data, or one separate buffer for
120 * each plane, or anything in between.
122 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
123 * to the end with a minor bump.
124 * Similarly fields that are marked as to be only accessed by
125 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
126 * without breaking compatibility with each other.
128 typedef struct AVFrame {
129 #define AV_NUM_DATA_POINTERS 8
131 * pointer to the picture/channel planes.
132 * This might be different from the first allocated byte
134 * Some decoders access areas outside 0,0 - width,height, please
135 * see avcodec_align_dimensions2(). Some filters and swscale can read
136 * up to 16 bytes beyond the planes, if these filters are to be used,
137 * then 16 extra bytes must be allocated.
139 uint8_t *data[AV_NUM_DATA_POINTERS];
142 * For video, size in bytes of each picture line.
143 * For audio, size in bytes of each plane.
145 * For audio, only linesize[0] may be set. For planar audio, each channel
146 * plane must be the same size.
148 * For video the linesizes should be multiplies of the CPUs alignment
149 * preference, this is 16 or 32 for modern desktop CPUs.
150 * Some code requires such alignment other code can be slower without
151 * correct alignment, for yet other it makes no difference.
153 * @note The linesize may be larger than the size of usable data -- there
154 * may be extra padding present for performance reasons.
156 int linesize[AV_NUM_DATA_POINTERS];
159 * pointers to the data planes/channels.
161 * For video, this should simply point to data[].
163 * For planar audio, each channel has a separate data pointer, and
164 * linesize[0] contains the size of each channel buffer.
165 * For packed audio, there is just one data pointer, and linesize[0]
166 * contains the total size of the buffer for all channels.
168 * Note: Both data and extended_data should always be set in a valid frame,
169 * but for planar audio with more channels that can fit in data,
170 * extended_data must be used in order to access all channels.
172 uint8_t **extended_data;
175 * width and height of the video frame
180 * number of audio samples (per channel) described by this frame
185 * format of the frame, -1 if unknown or unset
186 * Values correspond to enum AVPixelFormat for video frames,
187 * enum AVSampleFormat for audio)
192 * 1 -> keyframe, 0-> not
197 * Picture type of the frame.
199 enum AVPictureType pict_type;
201 #if FF_API_AVFRAME_LAVC
203 uint8_t *base[AV_NUM_DATA_POINTERS];
207 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
209 AVRational sample_aspect_ratio;
212 * Presentation timestamp in time_base units (time when frame should be shown to user).
217 * PTS copied from the AVPacket that was decoded to produce this frame.
222 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isnt used)
223 * This is also the Presentation time of this AVFrame calculated from
224 * only AVPacket.dts values without pts values.
229 * picture number in bitstream order
231 int coded_picture_number;
233 * picture number in display order
235 int display_picture_number;
238 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
242 #if FF_API_AVFRAME_LAVC
250 int8_t *qscale_table;
261 * mbskip_table[mb]>=1 if MB didn't change
262 * stride= mb_width = (width+15)>>4
265 uint8_t *mbskip_table;
268 * motion vector table
271 * int mv_sample_log2= 4 - motion_subsample_log2;
272 * int mb_width= (width+15)>>4;
273 * int mv_stride= (mb_width << mv_sample_log2) + 1;
274 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
278 int16_t (*motion_val[2])[2];
281 * macroblock type table
282 * mb_type_base + mb_width + 2
294 * motion reference frame index
295 * the order in which these are stored can depend on the codec.
298 int8_t *ref_index[2];
302 * for some private data of the user
309 uint64_t error[AV_NUM_DATA_POINTERS];
311 #if FF_API_AVFRAME_LAVC
317 * When decoding, this signals how much the picture must be delayed.
318 * extra_delay = repeat_pict / (2*fps)
323 * The content of the picture is interlaced.
325 int interlaced_frame;
328 * If the content is interlaced, is top field displayed first.
333 * Tell user application that palette has changed from previous frame.
335 int palette_has_changed;
337 #if FF_API_AVFRAME_LAVC
345 struct AVPanScan *pan_scan;
349 * reordered opaque 64bit (generally an integer or a double precision float
350 * PTS but can be anything).
351 * The user sets AVCodecContext.reordered_opaque to represent the input at
353 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
354 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
355 * @deprecated in favor of pkt_pts
357 int64_t reordered_opaque;
359 #if FF_API_AVFRAME_LAVC
361 * @deprecated this field is unused
363 attribute_deprecated void *hwaccel_picture_private;
366 struct AVCodecContext *owner;
371 * log2 of the size of the block which a single vector in motion_val represents:
372 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
375 uint8_t motion_subsample_log2;
379 * Sample rate of the audio data.
384 * Channel layout of the audio data.
386 uint64_t channel_layout;
389 * AVBuffer references backing the data for this frame. If all elements of
390 * this array are NULL, then this frame is not reference counted.
392 * There may be at most one AVBuffer per data plane, so for video this array
393 * always contains all the references. For planar audio with more than
394 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
395 * this array. Then the extra AVBufferRef pointers are stored in the
396 * extended_buf array.
398 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
401 * For planar audio which requires more than AV_NUM_DATA_POINTERS
402 * AVBufferRef pointers, this array will hold all the references which
403 * cannot fit into AVFrame.buf.
405 * Note that this is different from AVFrame.extended_data, which always
406 * contains all the pointers. This array only contains the extra pointers,
407 * which cannot fit into AVFrame.buf.
409 * This array is always allocated using av_malloc() by whoever constructs
410 * the frame. It is freed in av_frame_unref().
412 AVBufferRef **extended_buf;
414 * Number of elements in extended_buf.
418 AVFrameSideData **side_data;
422 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
423 * Flags describing additional frame properties.
429 * The frame data may be corrupted, e.g. due to decoding errors.
431 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
437 * Frame flags, a combination of @ref lavu_frame_flags
442 * frame timestamp estimated using various heuristics, in stream time base
443 * Code outside libavcodec should access this field using:
444 * av_frame_get_best_effort_timestamp(frame)
446 * - decoding: set by libavcodec, read by user.
448 int64_t best_effort_timestamp;
451 * reordered pos from the last AVPacket that has been input into the decoder
452 * Code outside libavcodec should access this field using:
453 * av_frame_get_pkt_pos(frame)
455 * - decoding: Read by user.
460 * duration of the corresponding packet, expressed in
461 * AVStream->time_base units, 0 if unknown.
462 * Code outside libavcodec should access this field using:
463 * av_frame_get_pkt_duration(frame)
465 * - decoding: Read by user.
467 int64_t pkt_duration;
471 * Code outside libavcodec should access this field using:
472 * av_frame_get_metadata(frame)
473 * - encoding: Set by user.
474 * - decoding: Set by libavcodec.
476 AVDictionary *metadata;
479 * decode error flags of the frame, set to a combination of
480 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
481 * were errors during the decoding.
482 * Code outside libavcodec should access this field using:
483 * av_frame_get_decode_error_flags(frame)
485 * - decoding: set by libavcodec, read by user.
487 int decode_error_flags;
488 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
489 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
492 * number of audio channels, only used for audio.
493 * Code outside libavcodec should access this field using:
494 * av_frame_get_channels(frame)
496 * - decoding: Read by user.
501 * size of the corresponding packet containing the compressed
502 * frame. It must be accessed using av_frame_get_pkt_size() and
503 * av_frame_set_pkt_size().
504 * It is set to a negative value if unknown.
506 * - decoding: set by libavcodec, read by user.
511 * YUV colorspace type.
512 * It must be accessed using av_frame_get_colorspace() and
513 * av_frame_set_colorspace().
514 * - encoding: Set by user
515 * - decoding: Set by libavcodec
517 enum AVColorSpace colorspace;
520 * MPEG vs JPEG YUV range.
521 * It must be accessed using av_frame_get_color_range() and
522 * av_frame_set_color_range().
523 * - encoding: Set by user
524 * - decoding: Set by libavcodec
526 enum AVColorRange color_range;
530 * Not to be accessed directly from outside libavutil
532 AVBufferRef *qp_table_buf;
536 * Accessors for some AVFrame fields.
537 * The position of these field in the structure is not part of the ABI,
538 * they should not be accessed directly outside libavcodec.
540 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
541 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
542 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
543 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
544 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
545 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
546 int64_t av_frame_get_channel_layout (const AVFrame *frame);
547 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
548 int av_frame_get_channels (const AVFrame *frame);
549 void av_frame_set_channels (AVFrame *frame, int val);
550 int av_frame_get_sample_rate (const AVFrame *frame);
551 void av_frame_set_sample_rate (AVFrame *frame, int val);
552 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
553 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
554 int av_frame_get_decode_error_flags (const AVFrame *frame);
555 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
556 int av_frame_get_pkt_size(const AVFrame *frame);
557 void av_frame_set_pkt_size(AVFrame *frame, int val);
558 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
559 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
560 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
561 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
562 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
563 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
564 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
567 * Get the name of a colorspace.
568 * @return a static string identifying the colorspace; can be NULL.
570 const char *av_get_colorspace_name(enum AVColorSpace val);
573 * Allocate an AVFrame and set its fields to default values. The resulting
574 * struct must be freed using av_frame_free().
576 * @return An AVFrame filled with default values or NULL on failure.
578 * @note this only allocates the AVFrame itself, not the data buffers. Those
579 * must be allocated through other means, e.g. with av_frame_get_buffer() or
582 AVFrame *av_frame_alloc(void);
585 * Free the frame and any dynamically allocated objects in it,
586 * e.g. extended_data. If the frame is reference counted, it will be
587 * unreferenced first.
589 * @param frame frame to be freed. The pointer will be set to NULL.
591 void av_frame_free(AVFrame **frame);
594 * Setup a new reference to the data described by a given frame.
596 * Copy frame properties from src to dst and create a new reference for each
597 * AVBufferRef from src.
599 * If src is not reference counted, new buffers are allocated and the data is
602 * @return 0 on success, a negative AVERROR on error
604 int av_frame_ref(AVFrame *dst, const AVFrame *src);
607 * Create a new frame that references the same data as src.
609 * This is a shortcut for av_frame_alloc()+av_frame_ref().
611 * @return newly created AVFrame on success, NULL on error.
613 AVFrame *av_frame_clone(const AVFrame *src);
616 * Unreference all the buffers referenced by frame and reset the frame fields.
618 void av_frame_unref(AVFrame *frame);
621 * Move everythnig contained in src to dst and reset src.
623 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
626 * Allocate new buffer(s) for audio or video data.
628 * The following fields must be set on frame before calling this function:
629 * - format (pixel format for video, sample format for audio)
630 * - width and height for video
631 * - nb_samples and channel_layout for audio
633 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
634 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
635 * For planar formats, one buffer will be allocated for each plane.
637 * @param frame frame in which to store the new buffers.
638 * @param align required buffer size alignment
640 * @return 0 on success, a negative AVERROR on error.
642 int av_frame_get_buffer(AVFrame *frame, int align);
645 * Check if the frame data is writable.
647 * @return A positive value if the frame data is writable (which is true if and
648 * only if each of the underlying buffers has only one reference, namely the one
649 * stored in this frame). Return 0 otherwise.
651 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
652 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
654 * @see av_frame_make_writable(), av_buffer_is_writable()
656 int av_frame_is_writable(AVFrame *frame);
659 * Ensure that the frame data is writable, avoiding data copy if possible.
661 * Do nothing if the frame is writable, allocate new buffers and copy the data
664 * @return 0 on success, a negative AVERROR on error.
666 * @see av_frame_is_writable(), av_buffer_is_writable(),
667 * av_buffer_make_writable()
669 int av_frame_make_writable(AVFrame *frame);
672 * Copy only "metadata" fields from src to dst.
674 * Metadata for the purpose of this function are those fields that do not affect
675 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
676 * aspect ratio (for video), but not width/height or channel layout.
677 * Side data is also copied.
679 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
682 * Get the buffer reference a given data plane is stored in.
684 * @param plane index of the data plane of interest in frame->extended_data.
686 * @return the buffer reference that contains the plane or NULL if the input
687 * frame is not valid.
689 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
692 * Add a new side data to a frame.
694 * @param frame a frame to which the side data should be added
695 * @param type type of the added side data
696 * @param size size of the side data
698 * @return newly added side data on success, NULL on error
700 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
701 enum AVFrameSideDataType type,
705 * @return a pointer to the side data of a given type on success, NULL if there
706 * is no side data with such type in this frame.
708 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
709 enum AVFrameSideDataType type);
715 #endif /* AVUTIL_FRAME_H */