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 * @defgroup lavu_frame AVFrame
45 * AVFrame is an abstraction for reference-counted raw multimedia data.
48 enum AVFrameSideDataType {
50 * The data is the AVPanScan struct defined in libavcodec.
52 AV_FRAME_DATA_PANSCAN,
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.
60 * Stereoscopic 3d metadata.
61 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
63 AV_FRAME_DATA_STEREO3D,
65 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
67 AV_FRAME_DATA_MATRIXENCODING,
69 * Metadata relevant to a downmix procedure.
70 * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
72 AV_FRAME_DATA_DOWNMIX_INFO,
74 * ReplayGain information in the form of the AVReplayGain struct.
76 AV_FRAME_DATA_REPLAYGAIN,
78 * This side data contains a 3x3 transformation matrix describing an affine
79 * transformation that needs to be applied to the frame for correct
82 * See libavutil/display.h for a detailed description of the data.
84 AV_FRAME_DATA_DISPLAYMATRIX,
86 * Active Format Description data consisting of a single byte as specified
87 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
92 enum AVActiveFormatDescription {
97 AV_AFD_4_3_SP_14_9 = 13,
98 AV_AFD_16_9_SP_14_9 = 14,
102 typedef struct AVFrameSideData {
103 enum AVFrameSideDataType type;
106 AVDictionary *metadata;
110 * This structure describes decoded (raw) audio or video data.
112 * AVFrame must be allocated using av_frame_alloc(). Note that this only
113 * allocates the AVFrame itself, the buffers for the data must be managed
114 * through other means (see below).
115 * AVFrame must be freed with av_frame_free().
117 * AVFrame is typically allocated once and then reused multiple times to hold
118 * different data (e.g. a single AVFrame to hold frames received from a
119 * decoder). In such a case, av_frame_unref() will free any references held by
120 * the frame and reset it to its original clean state before it
123 * The data described by an AVFrame is usually reference counted through the
124 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
125 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
126 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
127 * every single data plane must be contained in one of the buffers in
128 * AVFrame.buf or AVFrame.extended_buf.
129 * There may be a single buffer for all the data, or one separate buffer for
130 * each plane, or anything in between.
132 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
133 * to the end with a minor bump.
134 * Similarly fields that are marked as to be only accessed by
135 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
136 * without breaking compatibility with each other.
138 typedef struct AVFrame {
139 #define AV_NUM_DATA_POINTERS 8
141 * pointer to the picture/channel planes.
142 * This might be different from the first allocated byte
144 * Some decoders access areas outside 0,0 - width,height, please
145 * see avcodec_align_dimensions2(). Some filters and swscale can read
146 * up to 16 bytes beyond the planes, if these filters are to be used,
147 * then 16 extra bytes must be allocated.
149 uint8_t *data[AV_NUM_DATA_POINTERS];
152 * For video, size in bytes of each picture line.
153 * For audio, size in bytes of each plane.
155 * For audio, only linesize[0] may be set. For planar audio, each channel
156 * plane must be the same size.
158 * For video the linesizes should be multiplies of the CPUs alignment
159 * preference, this is 16 or 32 for modern desktop CPUs.
160 * Some code requires such alignment other code can be slower without
161 * correct alignment, for yet other it makes no difference.
163 * @note The linesize may be larger than the size of usable data -- there
164 * may be extra padding present for performance reasons.
166 int linesize[AV_NUM_DATA_POINTERS];
169 * pointers to the data planes/channels.
171 * For video, this should simply point to data[].
173 * For planar audio, each channel has a separate data pointer, and
174 * linesize[0] contains the size of each channel buffer.
175 * For packed audio, there is just one data pointer, and linesize[0]
176 * contains the total size of the buffer for all channels.
178 * Note: Both data and extended_data should always be set in a valid frame,
179 * but for planar audio with more channels that can fit in data,
180 * extended_data must be used in order to access all channels.
182 uint8_t **extended_data;
185 * width and height of the video frame
190 * number of audio samples (per channel) described by this frame
195 * format of the frame, -1 if unknown or unset
196 * Values correspond to enum AVPixelFormat for video frames,
197 * enum AVSampleFormat for audio)
202 * 1 -> keyframe, 0-> not
207 * Picture type of the frame.
209 enum AVPictureType pict_type;
211 #if FF_API_AVFRAME_LAVC
213 uint8_t *base[AV_NUM_DATA_POINTERS];
217 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
219 AVRational sample_aspect_ratio;
222 * Presentation timestamp in time_base units (time when frame should be shown to user).
227 * PTS copied from the AVPacket that was decoded to produce this frame.
232 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
233 * This is also the Presentation time of this AVFrame calculated from
234 * only AVPacket.dts values without pts values.
239 * picture number in bitstream order
241 int coded_picture_number;
243 * picture number in display order
245 int display_picture_number;
248 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
252 #if FF_API_AVFRAME_LAVC
260 int8_t *qscale_table;
271 * mbskip_table[mb]>=1 if MB didn't change
272 * stride= mb_width = (width+15)>>4
275 uint8_t *mbskip_table;
278 * motion vector table
281 * int mv_sample_log2= 4 - motion_subsample_log2;
282 * int mb_width= (width+15)>>4;
283 * int mv_stride= (mb_width << mv_sample_log2) + 1;
284 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
287 int16_t (*motion_val[2])[2];
290 * macroblock type table
291 * mb_type_base + mb_width + 2
303 * motion reference frame index
304 * the order in which these are stored can depend on the codec.
307 int8_t *ref_index[2];
311 * for some private data of the user
318 uint64_t error[AV_NUM_DATA_POINTERS];
320 #if FF_API_AVFRAME_LAVC
326 * When decoding, this signals how much the picture must be delayed.
327 * extra_delay = repeat_pict / (2*fps)
332 * The content of the picture is interlaced.
334 int interlaced_frame;
337 * If the content is interlaced, is top field displayed first.
342 * Tell user application that palette has changed from previous frame.
344 int palette_has_changed;
346 #if FF_API_AVFRAME_LAVC
354 struct AVPanScan *pan_scan;
358 * reordered opaque 64bit (generally an integer or a double precision float
359 * PTS but can be anything).
360 * The user sets AVCodecContext.reordered_opaque to represent the input at
362 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
363 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
364 * @deprecated in favor of pkt_pts
366 int64_t reordered_opaque;
368 #if FF_API_AVFRAME_LAVC
370 * @deprecated this field is unused
372 attribute_deprecated void *hwaccel_picture_private;
375 struct AVCodecContext *owner;
380 * log2 of the size of the block which a single vector in motion_val represents:
381 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
383 uint8_t motion_subsample_log2;
387 * Sample rate of the audio data.
392 * Channel layout of the audio data.
394 uint64_t channel_layout;
397 * AVBuffer references backing the data for this frame. If all elements of
398 * this array are NULL, then this frame is not reference counted.
400 * There may be at most one AVBuffer per data plane, so for video this array
401 * always contains all the references. For planar audio with more than
402 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
403 * this array. Then the extra AVBufferRef pointers are stored in the
404 * extended_buf array.
406 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
409 * For planar audio which requires more than AV_NUM_DATA_POINTERS
410 * AVBufferRef pointers, this array will hold all the references which
411 * cannot fit into AVFrame.buf.
413 * Note that this is different from AVFrame.extended_data, which always
414 * contains all the pointers. This array only contains the extra pointers,
415 * which cannot fit into AVFrame.buf.
417 * This array is always allocated using av_malloc() by whoever constructs
418 * the frame. It is freed in av_frame_unref().
420 AVBufferRef **extended_buf;
422 * Number of elements in extended_buf.
426 AVFrameSideData **side_data;
430 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
431 * Flags describing additional frame properties.
437 * The frame data may be corrupted, e.g. due to decoding errors.
439 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
445 * Frame flags, a combination of @ref lavu_frame_flags
449 #if FF_API_AVFRAME_COLORSPACE
451 * MPEG vs JPEG YUV range.
452 * It must be accessed using av_frame_get_color_range() and
453 * av_frame_set_color_range().
454 * - encoding: Set by user
455 * - decoding: Set by libavcodec
457 enum AVColorRange color_range;
459 enum AVColorPrimaries color_primaries;
461 enum AVColorTransferCharacteristic color_trc;
464 * YUV colorspace type.
465 * It must be accessed using av_frame_get_colorspace() and
466 * av_frame_set_colorspace().
467 * - encoding: Set by user
468 * - decoding: Set by libavcodec
470 enum AVColorSpace colorspace;
472 enum AVChromaLocation chroma_location;
476 * frame timestamp estimated using various heuristics, in stream time base
477 * Code outside libavcodec should access this field using:
478 * av_frame_get_best_effort_timestamp(frame)
480 * - decoding: set by libavcodec, read by user.
482 int64_t best_effort_timestamp;
485 * reordered pos from the last AVPacket that has been input into the decoder
486 * Code outside libavcodec should access this field using:
487 * av_frame_get_pkt_pos(frame)
489 * - decoding: Read by user.
494 * duration of the corresponding packet, expressed in
495 * AVStream->time_base units, 0 if unknown.
496 * Code outside libavcodec should access this field using:
497 * av_frame_get_pkt_duration(frame)
499 * - decoding: Read by user.
501 int64_t pkt_duration;
505 * Code outside libavcodec should access this field using:
506 * av_frame_get_metadata(frame)
507 * - encoding: Set by user.
508 * - decoding: Set by libavcodec.
510 AVDictionary *metadata;
513 * decode error flags of the frame, set to a combination of
514 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
515 * were errors during the decoding.
516 * Code outside libavcodec should access this field using:
517 * av_frame_get_decode_error_flags(frame)
519 * - decoding: set by libavcodec, read by user.
521 int decode_error_flags;
522 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
523 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
526 * number of audio channels, only used for audio.
527 * Code outside libavcodec should access this field using:
528 * av_frame_get_channels(frame)
530 * - decoding: Read by user.
535 * size of the corresponding packet containing the compressed
536 * frame. It must be accessed using av_frame_get_pkt_size() and
537 * av_frame_set_pkt_size().
538 * It is set to a negative value if unknown.
540 * - decoding: set by libavcodec, read by user.
545 * Not to be accessed directly from outside libavutil
547 AVBufferRef *qp_table_buf;
551 * Accessors for some AVFrame fields.
552 * The position of these field in the structure is not part of the ABI,
553 * they should not be accessed directly outside libavcodec.
555 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
556 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
557 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
558 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
559 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
560 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
561 int64_t av_frame_get_channel_layout (const AVFrame *frame);
562 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
563 int av_frame_get_channels (const AVFrame *frame);
564 void av_frame_set_channels (AVFrame *frame, int val);
565 int av_frame_get_sample_rate (const AVFrame *frame);
566 void av_frame_set_sample_rate (AVFrame *frame, int val);
567 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
568 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
569 int av_frame_get_decode_error_flags (const AVFrame *frame);
570 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
571 int av_frame_get_pkt_size(const AVFrame *frame);
572 void av_frame_set_pkt_size(AVFrame *frame, int val);
573 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
574 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
575 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
576 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
577 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
578 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
579 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
582 * Get the name of a colorspace.
583 * @return a static string identifying the colorspace; can be NULL.
585 const char *av_get_colorspace_name(enum AVColorSpace val);
588 * Allocate an AVFrame and set its fields to default values. The resulting
589 * struct must be freed using av_frame_free().
591 * @return An AVFrame filled with default values or NULL on failure.
593 * @note this only allocates the AVFrame itself, not the data buffers. Those
594 * must be allocated through other means, e.g. with av_frame_get_buffer() or
597 AVFrame *av_frame_alloc(void);
600 * Free the frame and any dynamically allocated objects in it,
601 * e.g. extended_data. If the frame is reference counted, it will be
602 * unreferenced first.
604 * @param frame frame to be freed. The pointer will be set to NULL.
606 void av_frame_free(AVFrame **frame);
609 * Set up a new reference to the data described by the source frame.
611 * Copy frame properties from src to dst and create a new reference for each
612 * AVBufferRef from src.
614 * If src is not reference counted, new buffers are allocated and the data is
617 * @return 0 on success, a negative AVERROR on error
619 int av_frame_ref(AVFrame *dst, const AVFrame *src);
622 * Create a new frame that references the same data as src.
624 * This is a shortcut for av_frame_alloc()+av_frame_ref().
626 * @return newly created AVFrame on success, NULL on error.
628 AVFrame *av_frame_clone(const AVFrame *src);
631 * Unreference all the buffers referenced by frame and reset the frame fields.
633 void av_frame_unref(AVFrame *frame);
636 * Move everythnig contained in src to dst and reset src.
638 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
641 * Allocate new buffer(s) for audio or video data.
643 * The following fields must be set on frame before calling this function:
644 * - format (pixel format for video, sample format for audio)
645 * - width and height for video
646 * - nb_samples and channel_layout for audio
648 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
649 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
650 * For planar formats, one buffer will be allocated for each plane.
652 * @param frame frame in which to store the new buffers.
653 * @param align required buffer size alignment
655 * @return 0 on success, a negative AVERROR on error.
657 int av_frame_get_buffer(AVFrame *frame, int align);
660 * Check if the frame data is writable.
662 * @return A positive value if the frame data is writable (which is true if and
663 * only if each of the underlying buffers has only one reference, namely the one
664 * stored in this frame). Return 0 otherwise.
666 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
667 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
669 * @see av_frame_make_writable(), av_buffer_is_writable()
671 int av_frame_is_writable(AVFrame *frame);
674 * Ensure that the frame data is writable, avoiding data copy if possible.
676 * Do nothing if the frame is writable, allocate new buffers and copy the data
679 * @return 0 on success, a negative AVERROR on error.
681 * @see av_frame_is_writable(), av_buffer_is_writable(),
682 * av_buffer_make_writable()
684 int av_frame_make_writable(AVFrame *frame);
687 * Copy the frame data from src to dst.
689 * This function does not allocate anything, dst must be already initialized and
690 * allocated with the same parameters as src.
692 * This function only copies the frame data (i.e. the contents of the data /
693 * extended data arrays), not any other properties.
695 * @return >= 0 on success, a negative AVERROR on error.
697 int av_frame_copy(AVFrame *dst, const AVFrame *src);
700 * Copy only "metadata" fields from src to dst.
702 * Metadata for the purpose of this function are those fields that do not affect
703 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
704 * aspect ratio (for video), but not width/height or channel layout.
705 * Side data is also copied.
707 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
710 * Get the buffer reference a given data plane is stored in.
712 * @param plane index of the data plane of interest in frame->extended_data.
714 * @return the buffer reference that contains the plane or NULL if the input
715 * frame is not valid.
717 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
720 * Add a new side data to a frame.
722 * @param frame a frame to which the side data should be added
723 * @param type type of the added side data
724 * @param size size of the side data
726 * @return newly added side data on success, NULL on error
728 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
729 enum AVFrameSideDataType type,
733 * @return a pointer to the side data of a given type on success, NULL if there
734 * is no side data with such type in this frame.
736 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
737 enum AVFrameSideDataType type);
740 * If side data of the supplied type exists in the frame, free it and remove it
743 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
746 * @return a string identifying the side data type
748 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
754 #endif /* AVUTIL_FRAME_H */