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
29 #include "samplefmt.h"
34 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
35 AVCOL_SPC_UNSPECIFIED = 2,
37 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
38 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
39 AVCOL_SPC_SMPTE240M = 7,
40 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
41 AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system
42 AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system
43 AVCOL_SPC_NB , ///< Not part of ABI
45 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
48 AVCOL_RANGE_UNSPECIFIED = 0,
49 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
50 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
51 AVCOL_RANGE_NB , ///< Not part of ABI
55 enum AVFrameSideDataType {
57 * The data is the AVPanScan struct defined in libavcodec.
59 AV_FRAME_DATA_PANSCAN,
61 * ATSC A53 Part 4 Closed Captions.
62 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
63 * The number of bytes of CC data is AVFrameSideData.size.
67 * Stereoscopic 3d metadata.
68 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
70 AV_FRAME_DATA_STEREO3D,
72 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
74 AV_FRAME_DATA_MATRIXENCODING,
77 typedef struct AVFrameSideData {
78 enum AVFrameSideDataType type;
81 AVDictionary *metadata;
85 * This structure describes decoded (raw) audio or video data.
87 * AVFrame must be allocated using av_frame_alloc(). Note that this only
88 * allocates the AVFrame itself, the buffers for the data must be managed
89 * through other means (see below).
90 * AVFrame must be freed with av_frame_free().
92 * AVFrame is typically allocated once and then reused multiple times to hold
93 * different data (e.g. a single AVFrame to hold frames received from a
94 * decoder). In such a case, av_frame_unref() will free any references held by
95 * the frame and reset it to its original clean state before it
98 * The data described by an AVFrame is usually reference counted through the
99 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
100 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
101 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
102 * every single data plane must be contained in one of the buffers in
103 * AVFrame.buf or AVFrame.extended_buf.
104 * There may be a single buffer for all the data, or one separate buffer for
105 * each plane, or anything in between.
107 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
108 * to the end with a minor bump.
109 * Similarly fields that are marked as to be only accessed by
110 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
111 * without breaking compatibility with each other.
113 typedef struct AVFrame {
114 #define AV_NUM_DATA_POINTERS 8
116 * pointer to the picture/channel planes.
117 * This might be different from the first allocated byte
119 * Some decoders access areas outside 0,0 - width,height, please
120 * see avcodec_align_dimensions2(). Some filters and swscale can read
121 * up to 16 bytes beyond the planes, if these filters are to be used,
122 * then 16 extra bytes must be allocated.
124 uint8_t *data[AV_NUM_DATA_POINTERS];
127 * For video, size in bytes of each picture line.
128 * For audio, size in bytes of each plane.
130 * For audio, only linesize[0] may be set. For planar audio, each channel
131 * plane must be the same size.
133 * For video the linesizes should be multiplies of the CPUs alignment
134 * preference, this is 16 or 32 for modern desktop CPUs.
135 * Some code requires such alignment other code can be slower without
136 * correct alignment, for yet other it makes no difference.
138 * @note The linesize may be larger than the size of usable data -- there
139 * may be extra padding present for performance reasons.
141 int linesize[AV_NUM_DATA_POINTERS];
144 * pointers to the data planes/channels.
146 * For video, this should simply point to data[].
148 * For planar audio, each channel has a separate data pointer, and
149 * linesize[0] contains the size of each channel buffer.
150 * For packed audio, there is just one data pointer, and linesize[0]
151 * contains the total size of the buffer for all channels.
153 * Note: Both data and extended_data should always be set in a valid frame,
154 * but for planar audio with more channels that can fit in data,
155 * extended_data must be used in order to access all channels.
157 uint8_t **extended_data;
160 * width and height of the video frame
165 * number of audio samples (per channel) described by this frame
170 * format of the frame, -1 if unknown or unset
171 * Values correspond to enum AVPixelFormat for video frames,
172 * enum AVSampleFormat for audio)
177 * 1 -> keyframe, 0-> not
182 * Picture type of the frame.
184 enum AVPictureType pict_type;
186 #if FF_API_AVFRAME_LAVC
188 uint8_t *base[AV_NUM_DATA_POINTERS];
192 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
194 AVRational sample_aspect_ratio;
197 * Presentation timestamp in time_base units (time when frame should be shown to user).
202 * PTS copied from the AVPacket that was decoded to produce this frame.
207 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isnt used)
208 * This is also the Presentation time of this AVFrame calculated from
209 * only AVPacket.dts values without pts values.
214 * picture number in bitstream order
216 int coded_picture_number;
218 * picture number in display order
220 int display_picture_number;
223 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
227 #if FF_API_AVFRAME_LAVC
235 int8_t *qscale_table;
246 * mbskip_table[mb]>=1 if MB didn't change
247 * stride= mb_width = (width+15)>>4
250 uint8_t *mbskip_table;
253 * motion vector table
256 * int mv_sample_log2= 4 - motion_subsample_log2;
257 * int mb_width= (width+15)>>4;
258 * int mv_stride= (mb_width << mv_sample_log2) + 1;
259 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
263 int16_t (*motion_val[2])[2];
266 * macroblock type table
267 * mb_type_base + mb_width + 2
279 * motion reference frame index
280 * the order in which these are stored can depend on the codec.
283 int8_t *ref_index[2];
287 * for some private data of the user
294 uint64_t error[AV_NUM_DATA_POINTERS];
296 #if FF_API_AVFRAME_LAVC
302 * When decoding, this signals how much the picture must be delayed.
303 * extra_delay = repeat_pict / (2*fps)
308 * The content of the picture is interlaced.
310 int interlaced_frame;
313 * If the content is interlaced, is top field displayed first.
318 * Tell user application that palette has changed from previous frame.
320 int palette_has_changed;
322 #if FF_API_AVFRAME_LAVC
330 struct AVPanScan *pan_scan;
334 * reordered opaque 64bit (generally an integer or a double precision float
335 * PTS but can be anything).
336 * The user sets AVCodecContext.reordered_opaque to represent the input at
338 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
339 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
340 * @deprecated in favor of pkt_pts
342 int64_t reordered_opaque;
344 #if FF_API_AVFRAME_LAVC
346 * @deprecated this field is unused
348 attribute_deprecated void *hwaccel_picture_private;
351 struct AVCodecContext *owner;
356 * log2 of the size of the block which a single vector in motion_val represents:
357 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
360 uint8_t motion_subsample_log2;
364 * Sample rate of the audio data.
369 * Channel layout of the audio data.
371 uint64_t channel_layout;
374 * AVBuffer references backing the data for this frame. If all elements of
375 * this array are NULL, then this frame is not reference counted.
377 * There may be at most one AVBuffer per data plane, so for video this array
378 * always contains all the references. For planar audio with more than
379 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
380 * this array. Then the extra AVBufferRef pointers are stored in the
381 * extended_buf array.
383 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
386 * For planar audio which requires more than AV_NUM_DATA_POINTERS
387 * AVBufferRef pointers, this array will hold all the references which
388 * cannot fit into AVFrame.buf.
390 * Note that this is different from AVFrame.extended_data, which always
391 * contains all the pointers. This array only contains the extra pointers,
392 * which cannot fit into AVFrame.buf.
394 * This array is always allocated using av_malloc() by whoever constructs
395 * the frame. It is freed in av_frame_unref().
397 AVBufferRef **extended_buf;
399 * Number of elements in extended_buf.
403 AVFrameSideData **side_data;
407 * The frame data may be corrupted, e.g. due to decoding errors.
409 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
412 * Frame flags, a combination of AV_FRAME_FLAG_*
417 * frame timestamp estimated using various heuristics, in stream time base
418 * Code outside libavcodec should access this field using:
419 * av_frame_get_best_effort_timestamp(frame)
421 * - decoding: set by libavcodec, read by user.
423 int64_t best_effort_timestamp;
426 * reordered pos from the last AVPacket that has been input into the decoder
427 * Code outside libavcodec should access this field using:
428 * av_frame_get_pkt_pos(frame)
430 * - decoding: Read by user.
435 * duration of the corresponding packet, expressed in
436 * AVStream->time_base units, 0 if unknown.
437 * Code outside libavcodec should access this field using:
438 * av_frame_get_pkt_duration(frame)
440 * - decoding: Read by user.
442 int64_t pkt_duration;
446 * Code outside libavcodec should access this field using:
447 * av_frame_get_metadata(frame)
448 * - encoding: Set by user.
449 * - decoding: Set by libavcodec.
451 AVDictionary *metadata;
454 * decode error flags of the frame, set to a combination of
455 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
456 * were errors during the decoding.
457 * Code outside libavcodec should access this field using:
458 * av_frame_get_decode_error_flags(frame)
460 * - decoding: set by libavcodec, read by user.
462 int decode_error_flags;
463 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
464 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
467 * number of audio channels, only used for audio.
468 * Code outside libavcodec should access this field using:
469 * av_frame_get_channels(frame)
471 * - decoding: Read by user.
476 * size of the corresponding packet containing the compressed
477 * frame. It must be accessed using av_frame_get_pkt_size() and
478 * av_frame_set_pkt_size().
479 * It is set to a negative value if unknown.
481 * - decoding: set by libavcodec, read by user.
486 * YUV colorspace type.
487 * It must be accessed using av_frame_get_colorspace() and
488 * av_frame_set_colorspace().
489 * - encoding: Set by user
490 * - decoding: Set by libavcodec
492 enum AVColorSpace colorspace;
495 * MPEG vs JPEG YUV range.
496 * It must be accessed using av_frame_get_color_range() and
497 * av_frame_set_color_range().
498 * - encoding: Set by user
499 * - decoding: Set by libavcodec
501 enum AVColorRange color_range;
505 * Not to be accessed directly from outside libavutil
507 AVBufferRef *qp_table_buf;
511 * Accessors for some AVFrame fields.
512 * The position of these field in the structure is not part of the ABI,
513 * they should not be accessed directly outside libavcodec.
515 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
516 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
517 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
518 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
519 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
520 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
521 int64_t av_frame_get_channel_layout (const AVFrame *frame);
522 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
523 int av_frame_get_channels (const AVFrame *frame);
524 void av_frame_set_channels (AVFrame *frame, int val);
525 int av_frame_get_sample_rate (const AVFrame *frame);
526 void av_frame_set_sample_rate (AVFrame *frame, int val);
527 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
528 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
529 int av_frame_get_decode_error_flags (const AVFrame *frame);
530 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
531 int av_frame_get_pkt_size(const AVFrame *frame);
532 void av_frame_set_pkt_size(AVFrame *frame, int val);
533 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
534 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
535 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
536 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
537 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
538 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
539 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
542 * Get the name of a colorspace.
543 * @return a static string identifying the colorspace; can be NULL.
545 const char *av_get_colorspace_name(enum AVColorSpace val);
548 * Allocate an AVFrame and set its fields to default values. The resulting
549 * struct must be freed using av_frame_free().
551 * @return An AVFrame filled with default values or NULL on failure.
553 * @note this only allocates the AVFrame itself, not the data buffers. Those
554 * must be allocated through other means, e.g. with av_frame_get_buffer() or
557 AVFrame *av_frame_alloc(void);
560 * Free the frame and any dynamically allocated objects in it,
561 * e.g. extended_data. If the frame is reference counted, it will be
562 * unreferenced first.
564 * @param frame frame to be freed. The pointer will be set to NULL.
566 void av_frame_free(AVFrame **frame);
569 * Setup a new reference to the data described by a given frame.
571 * Copy frame properties from src to dst and create a new reference for each
572 * AVBufferRef from src.
574 * If src is not reference counted, new buffers are allocated and the data is
577 * @return 0 on success, a negative AVERROR on error
579 int av_frame_ref(AVFrame *dst, const AVFrame *src);
582 * Create a new frame that references the same data as src.
584 * This is a shortcut for av_frame_alloc()+av_frame_ref().
586 * @return newly created AVFrame on success, NULL on error.
588 AVFrame *av_frame_clone(const AVFrame *src);
591 * Unreference all the buffers referenced by frame and reset the frame fields.
593 void av_frame_unref(AVFrame *frame);
596 * Move everythnig contained in src to dst and reset src.
598 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
601 * Allocate new buffer(s) for audio or video data.
603 * The following fields must be set on frame before calling this function:
604 * - format (pixel format for video, sample format for audio)
605 * - width and height for video
606 * - nb_samples and channel_layout for audio
608 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
609 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
610 * For planar formats, one buffer will be allocated for each plane.
612 * @param frame frame in which to store the new buffers.
613 * @param align required buffer size alignment
615 * @return 0 on success, a negative AVERROR on error.
617 int av_frame_get_buffer(AVFrame *frame, int align);
620 * Check if the frame data is writable.
622 * @return A positive value if the frame data is writable (which is true if and
623 * only if each of the underlying buffers has only one reference, namely the one
624 * stored in this frame). Return 0 otherwise.
626 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
627 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
629 * @see av_frame_make_writable(), av_buffer_is_writable()
631 int av_frame_is_writable(AVFrame *frame);
634 * Ensure that the frame data is writable, avoiding data copy if possible.
636 * Do nothing if the frame is writable, allocate new buffers and copy the data
639 * @return 0 on success, a negative AVERROR on error.
641 * @see av_frame_is_writable(), av_buffer_is_writable(),
642 * av_buffer_make_writable()
644 int av_frame_make_writable(AVFrame *frame);
647 * Copy only "metadata" fields from src to dst.
649 * Metadata for the purpose of this function are those fields that do not affect
650 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
651 * aspect ratio (for video), but not width/height or channel layout.
652 * Side data is also copied.
654 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
657 * Get the buffer reference a given data plane is stored in.
659 * @param plane index of the data plane of interest in frame->extended_data.
661 * @return the buffer reference that contains the plane or NULL if the input
662 * frame is not valid.
664 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
667 * Add a new side data to a frame.
669 * @param frame a frame to which the side data should be added
670 * @param type type of the added side data
671 * @param size size of the side data
673 * @return newly added side data on success, NULL on error
675 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
676 enum AVFrameSideDataType type,
680 * @return a pointer to the side data of a given type on success, NULL if there
681 * is no side data with such type in this frame.
683 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
684 enum AVFrameSideDataType type);
686 #endif /* AVUTIL_FRAME_H */