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
20 #ifndef AVUTIL_FRAME_H
21 #define AVUTIL_FRAME_H
25 #include "libavcodec/version.h"
31 #include "samplefmt.h"
35 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
36 AVCOL_SPC_UNSPECIFIED = 2,
38 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
39 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
40 AVCOL_SPC_SMPTE240M = 7,
41 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
42 AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system
43 AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system
44 AVCOL_SPC_NB , ///< Not part of ABI
46 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
49 AVCOL_RANGE_UNSPECIFIED = 0,
50 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
51 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
52 AVCOL_RANGE_NB , ///< Not part of ABI
56 enum AVFrameSideDataType {
58 * The data is the AVPanScan struct defined in libavcodec.
60 AV_FRAME_DATA_PANSCAN,
62 * ATSC A53 Part 4 Closed Captions.
63 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
64 * The number of bytes of CC data is AVFrameSideData.size.
68 * Stereoscopic 3d metadata.
69 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
71 AV_FRAME_DATA_STEREO3D,
74 typedef struct AVFrameSideData {
75 enum AVFrameSideDataType type;
78 AVDictionary *metadata;
82 * This structure describes decoded (raw) audio or video data.
84 * AVFrame must be allocated using av_frame_alloc(). Note that this only
85 * allocates the AVFrame itself, the buffers for the data must be managed
86 * through other means (see below).
87 * AVFrame must be freed with av_frame_free().
89 * AVFrame is typically allocated once and then reused multiple times to hold
90 * different data (e.g. a single AVFrame to hold frames received from a
91 * decoder). In such a case, av_frame_unref() will free any references held by
92 * the frame and reset it to its original clean state before it
95 * The data described by an AVFrame is usually reference counted through the
96 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
97 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
98 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
99 * every single data plane must be contained in one of the buffers in
100 * AVFrame.buf or AVFrame.extended_buf.
101 * There may be a single buffer for all the data, or one separate buffer for
102 * each plane, or anything in between.
104 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
105 * to the end with a minor bump.
106 * Similarly fields that are marked as to be only accessed by
107 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
108 * without breaking compatibility with each other.
110 typedef struct AVFrame {
111 #define AV_NUM_DATA_POINTERS 8
113 * pointer to the picture/channel planes.
114 * This might be different from the first allocated byte
116 * Some decoders access areas outside 0,0 - width,height, please
117 * see avcodec_align_dimensions2(). Some filters and swscale can read
118 * up to 16 bytes beyond the planes, if these filters are to be used,
119 * then 16 extra bytes must be allocated.
121 uint8_t *data[AV_NUM_DATA_POINTERS];
124 * For video, size in bytes of each picture line.
125 * For audio, size in bytes of each plane.
127 * For audio, only linesize[0] may be set. For planar audio, each channel
128 * plane must be the same size.
130 * For video the linesizes should be multiplies of the CPUs alignment
131 * preference, this is 16 or 32 for modern desktop CPUs.
132 * Some code requires such alignment other code can be slower without
133 * correct alignment, for yet other it makes no difference.
135 * @note The linesize may be larger than the size of usable data -- there
136 * may be extra padding present for performance reasons.
138 int linesize[AV_NUM_DATA_POINTERS];
141 * pointers to the data planes/channels.
143 * For video, this should simply point to data[].
145 * For planar audio, each channel has a separate data pointer, and
146 * linesize[0] contains the size of each channel buffer.
147 * For packed audio, there is just one data pointer, and linesize[0]
148 * contains the total size of the buffer for all channels.
150 * Note: Both data and extended_data should always be set in a valid frame,
151 * but for planar audio with more channels that can fit in data,
152 * extended_data must be used in order to access all channels.
154 uint8_t **extended_data;
157 * width and height of the video frame
162 * number of audio samples (per channel) described by this frame
167 * format of the frame, -1 if unknown or unset
168 * Values correspond to enum AVPixelFormat for video frames,
169 * enum AVSampleFormat for audio)
174 * 1 -> keyframe, 0-> not
179 * Picture type of the frame.
181 enum AVPictureType pict_type;
183 #if FF_API_AVFRAME_LAVC
185 uint8_t *base[AV_NUM_DATA_POINTERS];
189 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
191 AVRational sample_aspect_ratio;
194 * Presentation timestamp in time_base units (time when frame should be shown to user).
199 * PTS copied from the AVPacket that was decoded to produce this frame.
204 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isnt used)
205 * This is also the Presentation time of this AVFrame calculated from
206 * only AVPacket.dts values without pts values.
211 * picture number in bitstream order
213 int coded_picture_number;
215 * picture number in display order
217 int display_picture_number;
220 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
224 #if FF_API_AVFRAME_LAVC
232 int8_t *qscale_table;
243 * mbskip_table[mb]>=1 if MB didn't change
244 * stride= mb_width = (width+15)>>4
247 uint8_t *mbskip_table;
250 * motion vector table
253 * int mv_sample_log2= 4 - motion_subsample_log2;
254 * int mb_width= (width+15)>>4;
255 * int mv_stride= (mb_width << mv_sample_log2) + 1;
256 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
260 int16_t (*motion_val[2])[2];
263 * macroblock type table
264 * mb_type_base + mb_width + 2
276 * motion reference frame index
277 * the order in which these are stored can depend on the codec.
280 int8_t *ref_index[2];
284 * for some private data of the user
291 uint64_t error[AV_NUM_DATA_POINTERS];
293 #if FF_API_AVFRAME_LAVC
299 * When decoding, this signals how much the picture must be delayed.
300 * extra_delay = repeat_pict / (2*fps)
305 * The content of the picture is interlaced.
307 int interlaced_frame;
310 * If the content is interlaced, is top field displayed first.
315 * Tell user application that palette has changed from previous frame.
317 int palette_has_changed;
319 #if FF_API_AVFRAME_LAVC
327 struct AVPanScan *pan_scan;
331 * reordered opaque 64bit (generally an integer or a double precision float
332 * PTS but can be anything).
333 * The user sets AVCodecContext.reordered_opaque to represent the input at
335 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
336 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
337 * @deprecated in favor of pkt_pts
339 int64_t reordered_opaque;
341 #if FF_API_AVFRAME_LAVC
343 * @deprecated this field is unused
345 attribute_deprecated void *hwaccel_picture_private;
348 struct AVCodecContext *owner;
353 * log2 of the size of the block which a single vector in motion_val represents:
354 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
357 uint8_t motion_subsample_log2;
361 * Sample rate of the audio data.
366 * Channel layout of the audio data.
368 uint64_t channel_layout;
371 * AVBuffer references backing the data for this frame. If all elements of
372 * this array are NULL, then this frame is not reference counted.
374 * There may be at most one AVBuffer per data plane, so for video this array
375 * always contains all the references. For planar audio with more than
376 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
377 * this array. Then the extra AVBufferRef pointers are stored in the
378 * extended_buf array.
380 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
383 * For planar audio which requires more than AV_NUM_DATA_POINTERS
384 * AVBufferRef pointers, this array will hold all the references which
385 * cannot fit into AVFrame.buf.
387 * Note that this is different from AVFrame.extended_data, which always
388 * contains all the pointers. This array only contains the extra pointers,
389 * which cannot fit into AVFrame.buf.
391 * This array is always allocated using av_malloc() by whoever constructs
392 * the frame. It is freed in av_frame_unref().
394 AVBufferRef **extended_buf;
396 * Number of elements in extended_buf.
400 AVFrameSideData **side_data;
404 * The frame data may be corrupted, e.g. due to decoding errors.
406 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
409 * Frame flags, a combination of AV_FRAME_FLAG_*
414 * frame timestamp estimated using various heuristics, in stream time base
415 * Code outside libavcodec should access this field using:
416 * av_frame_get_best_effort_timestamp(frame)
418 * - decoding: set by libavcodec, read by user.
420 int64_t best_effort_timestamp;
423 * reordered pos from the last AVPacket that has been input into the decoder
424 * Code outside libavcodec should access this field using:
425 * av_frame_get_pkt_pos(frame)
427 * - decoding: Read by user.
432 * duration of the corresponding packet, expressed in
433 * AVStream->time_base units, 0 if unknown.
434 * Code outside libavcodec should access this field using:
435 * av_frame_get_pkt_duration(frame)
437 * - decoding: Read by user.
439 int64_t pkt_duration;
443 * Code outside libavcodec should access this field using:
444 * av_frame_get_metadata(frame)
445 * - encoding: Set by user.
446 * - decoding: Set by libavcodec.
448 AVDictionary *metadata;
451 * decode error flags of the frame, set to a combination of
452 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
453 * were errors during the decoding.
454 * Code outside libavcodec should access this field using:
455 * av_frame_get_decode_error_flags(frame)
457 * - decoding: set by libavcodec, read by user.
459 int decode_error_flags;
460 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
461 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
464 * number of audio channels, only used for audio.
465 * Code outside libavcodec should access this field using:
466 * av_frame_get_channels(frame)
468 * - decoding: Read by user.
473 * size of the corresponding packet containing the compressed
474 * frame. It must be accessed using av_frame_get_pkt_size() and
475 * av_frame_set_pkt_size().
476 * It is set to a negative value if unknown.
478 * - decoding: set by libavcodec, read by user.
483 * YUV colorspace type.
484 * It must be accessed using av_frame_get_colorspace() and
485 * av_frame_set_colorspace().
486 * - encoding: Set by user
487 * - decoding: Set by libavcodec
489 enum AVColorSpace colorspace;
492 * MPEG vs JPEG YUV range.
493 * It must be accessed using av_frame_get_color_range() and
494 * av_frame_set_color_range().
495 * - encoding: Set by user
496 * - decoding: Set by libavcodec
498 enum AVColorRange color_range;
502 * Not to be accessed directly from outside libavutil
504 AVBufferRef *qp_table_buf;
508 * Accessors for some AVFrame fields.
509 * The position of these field in the structure is not part of the ABI,
510 * they should not be accessed directly outside libavcodec.
512 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
513 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
514 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
515 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
516 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
517 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
518 int64_t av_frame_get_channel_layout (const AVFrame *frame);
519 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
520 int av_frame_get_channels (const AVFrame *frame);
521 void av_frame_set_channels (AVFrame *frame, int val);
522 int av_frame_get_sample_rate (const AVFrame *frame);
523 void av_frame_set_sample_rate (AVFrame *frame, int val);
524 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
525 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
526 int av_frame_get_decode_error_flags (const AVFrame *frame);
527 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
528 int av_frame_get_pkt_size(const AVFrame *frame);
529 void av_frame_set_pkt_size(AVFrame *frame, int val);
530 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
531 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
532 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
533 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
534 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
535 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
536 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
539 * Get the name of a colorspace.
540 * @return a static string identifying the colorspace; can be NULL.
542 const char *av_get_colorspace_name(enum AVColorSpace val);
545 * Allocate an AVFrame and set its fields to default values. The resulting
546 * struct must be freed using av_frame_free().
548 * @return An AVFrame filled with default values or NULL on failure.
550 * @note this only allocates the AVFrame itself, not the data buffers. Those
551 * must be allocated through other means, e.g. with av_frame_get_buffer() or
554 AVFrame *av_frame_alloc(void);
557 * Free the frame and any dynamically allocated objects in it,
558 * e.g. extended_data. If the frame is reference counted, it will be
559 * unreferenced first.
561 * @param frame frame to be freed. The pointer will be set to NULL.
563 void av_frame_free(AVFrame **frame);
566 * Setup a new reference to the data described by a given frame.
568 * Copy frame properties from src to dst and create a new reference for each
569 * AVBufferRef from src.
571 * If src is not reference counted, new buffers are allocated and the data is
574 * @return 0 on success, a negative AVERROR on error
576 int av_frame_ref(AVFrame *dst, const AVFrame *src);
579 * Create a new frame that references the same data as src.
581 * This is a shortcut for av_frame_alloc()+av_frame_ref().
583 * @return newly created AVFrame on success, NULL on error.
585 AVFrame *av_frame_clone(const AVFrame *src);
588 * Unreference all the buffers referenced by frame and reset the frame fields.
590 void av_frame_unref(AVFrame *frame);
593 * Move everythnig contained in src to dst and reset src.
595 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
598 * Allocate new buffer(s) for audio or video data.
600 * The following fields must be set on frame before calling this function:
601 * - format (pixel format for video, sample format for audio)
602 * - width and height for video
603 * - nb_samples and channel_layout for audio
605 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
606 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
607 * For planar formats, one buffer will be allocated for each plane.
609 * @param frame frame in which to store the new buffers.
610 * @param align required buffer size alignment
612 * @return 0 on success, a negative AVERROR on error.
614 int av_frame_get_buffer(AVFrame *frame, int align);
617 * Check if the frame data is writable.
619 * @return A positive value if the frame data is writable (which is true if and
620 * only if each of the underlying buffers has only one reference, namely the one
621 * stored in this frame). Return 0 otherwise.
623 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
624 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
626 * @see av_frame_make_writable(), av_buffer_is_writable()
628 int av_frame_is_writable(AVFrame *frame);
631 * Ensure that the frame data is writable, avoiding data copy if possible.
633 * Do nothing if the frame is writable, allocate new buffers and copy the data
636 * @return 0 on success, a negative AVERROR on error.
638 * @see av_frame_is_writable(), av_buffer_is_writable(),
639 * av_buffer_make_writable()
641 int av_frame_make_writable(AVFrame *frame);
644 * Copy only "metadata" fields from src to dst.
646 * Metadata for the purpose of this function are those fields that do not affect
647 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
648 * aspect ratio (for video), but not width/height or channel layout.
649 * Side data is also copied.
651 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
654 * Get the buffer reference a given data plane is stored in.
656 * @param plane index of the data plane of interest in frame->extended_data.
658 * @return the buffer reference that contains the plane or NULL if the input
659 * frame is not valid.
661 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
664 * Add a new side data to a frame.
666 * @param frame a frame to which the side data should be added
667 * @param type type of the added side data
668 * @param size size of the side data
670 * @return newly added side data on success, NULL on error
672 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
673 enum AVFrameSideDataType type,
677 * @return a pointer to the side data of a given type on success, NULL if there
678 * is no side data with such type in this frame.
680 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
681 enum AVFrameSideDataType type);
683 #endif /* AVUTIL_FRAME_H */