3 * This file is part of Libav.
5 * Libav 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 * Libav 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 Libav; 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"
33 enum AVFrameSideDataType {
35 * The data is the AVPanScan struct defined in libavcodec.
37 AV_FRAME_DATA_PANSCAN,
39 * ATSC A53 Part 4 Closed Captions.
40 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
41 * The number of bytes of CC data is AVFrameSideData.size.
45 * Stereoscopic 3d metadata.
46 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
48 AV_FRAME_DATA_STEREO3D,
51 typedef struct AVFrameSideData {
52 enum AVFrameSideDataType type;
55 AVDictionary *metadata;
59 * This structure describes decoded (raw) audio or video data.
61 * AVFrame must be allocated using av_frame_alloc(). Note that this only
62 * allocates the AVFrame itself, the buffers for the data must be managed
63 * through other means (see below).
64 * AVFrame must be freed with av_frame_free().
66 * AVFrame is typically allocated once and then reused multiple times to hold
67 * different data (e.g. a single AVFrame to hold frames received from a
68 * decoder). In such a case, av_frame_unref() will free any references held by
69 * the frame and reset it to its original clean state before it
72 * The data described by an AVFrame is usually reference counted through the
73 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
74 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
75 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
76 * every single data plane must be contained in one of the buffers in
77 * AVFrame.buf or AVFrame.extended_buf.
78 * There may be a single buffer for all the data, or one separate buffer for
79 * each plane, or anything in between.
81 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
82 * to the end with a minor bump.
84 typedef struct AVFrame {
85 #define AV_NUM_DATA_POINTERS 8
87 * pointer to the picture/channel planes.
88 * This might be different from the first allocated byte
90 uint8_t *data[AV_NUM_DATA_POINTERS];
93 * For video, size in bytes of each picture line.
94 * For audio, size in bytes of each plane.
96 * For audio, only linesize[0] may be set. For planar audio, each channel
97 * plane must be the same size.
99 * @note The linesize may be larger than the size of usable data -- there
100 * may be extra padding present for performance reasons.
102 int linesize[AV_NUM_DATA_POINTERS];
105 * pointers to the data planes/channels.
107 * For video, this should simply point to data[].
109 * For planar audio, each channel has a separate data pointer, and
110 * linesize[0] contains the size of each channel buffer.
111 * For packed audio, there is just one data pointer, and linesize[0]
112 * contains the total size of the buffer for all channels.
114 * Note: Both data and extended_data should always be set in a valid frame,
115 * but for planar audio with more channels that can fit in data,
116 * extended_data must be used in order to access all channels.
118 uint8_t **extended_data;
121 * width and height of the video frame
126 * number of audio samples (per channel) described by this frame
131 * format of the frame, -1 if unknown or unset
132 * Values correspond to enum AVPixelFormat for video frames,
133 * enum AVSampleFormat for audio)
138 * 1 -> keyframe, 0-> not
143 * Picture type of the frame.
145 enum AVPictureType pict_type;
147 #if FF_API_AVFRAME_LAVC
149 uint8_t *base[AV_NUM_DATA_POINTERS];
153 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
155 AVRational sample_aspect_ratio;
158 * Presentation timestamp in time_base units (time when frame should be shown to user).
163 * PTS copied from the AVPacket that was decoded to produce this frame.
168 * DTS copied from the AVPacket that triggered returning this frame.
173 * picture number in bitstream order
175 int coded_picture_number;
177 * picture number in display order
179 int display_picture_number;
182 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
186 #if FF_API_AVFRAME_LAVC
194 int8_t *qscale_table;
205 * mbskip_table[mb]>=1 if MB didn't change
206 * stride= mb_width = (width+15)>>4
209 uint8_t *mbskip_table;
212 * motion vector table
215 * int mv_sample_log2= 4 - motion_subsample_log2;
216 * int mb_width= (width+15)>>4;
217 * int mv_stride= (mb_width << mv_sample_log2) + 1;
218 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
222 int16_t (*motion_val[2])[2];
225 * macroblock type table
226 * mb_type_base + mb_width + 2
238 * motion reference frame index
239 * the order in which these are stored can depend on the codec.
242 int8_t *ref_index[2];
246 * for some private data of the user
253 uint64_t error[AV_NUM_DATA_POINTERS];
255 #if FF_API_AVFRAME_LAVC
261 * When decoding, this signals how much the picture must be delayed.
262 * extra_delay = repeat_pict / (2*fps)
267 * The content of the picture is interlaced.
269 int interlaced_frame;
272 * If the content is interlaced, is top field displayed first.
277 * Tell user application that palette has changed from previous frame.
279 int palette_has_changed;
281 #if FF_API_AVFRAME_LAVC
289 struct AVPanScan *pan_scan;
293 * reordered opaque 64bit (generally an integer or a double precision float
294 * PTS but can be anything).
295 * The user sets AVCodecContext.reordered_opaque to represent the input at
297 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
298 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
299 * @deprecated in favor of pkt_pts
301 int64_t reordered_opaque;
303 #if FF_API_AVFRAME_LAVC
305 * @deprecated this field is unused
307 attribute_deprecated void *hwaccel_picture_private;
310 struct AVCodecContext *owner;
315 * log2 of the size of the block which a single vector in motion_val represents:
316 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
319 uint8_t motion_subsample_log2;
323 * Sample rate of the audio data.
328 * Channel layout of the audio data.
330 uint64_t channel_layout;
333 * AVBuffer references backing the data for this frame. If all elements of
334 * this array are NULL, then this frame is not reference counted.
336 * There may be at most one AVBuffer per data plane, so for video this array
337 * always contains all the references. For planar audio with more than
338 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
339 * this array. Then the extra AVBufferRef pointers are stored in the
340 * extended_buf array.
342 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
345 * For planar audio which requires more than AV_NUM_DATA_POINTERS
346 * AVBufferRef pointers, this array will hold all the references which
347 * cannot fit into AVFrame.buf.
349 * Note that this is different from AVFrame.extended_data, which always
350 * contains all the pointers. This array only contains the extra pointers,
351 * which cannot fit into AVFrame.buf.
353 * This array is always allocated using av_malloc() by whoever constructs
354 * the frame. It is freed in av_frame_unref().
356 AVBufferRef **extended_buf;
358 * Number of elements in extended_buf.
362 AVFrameSideData **side_data;
366 * The frame data may be corrupted, e.g. due to decoding errors.
368 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
371 * Frame flags, a combination of AV_FRAME_FLAG_*
377 * Allocate an AVFrame and set its fields to default values. The resulting
378 * struct must be freed using av_frame_free().
380 * @return An AVFrame filled with default values or NULL on failure.
382 * @note this only allocates the AVFrame itself, not the data buffers. Those
383 * must be allocated through other means, e.g. with av_frame_get_buffer() or
386 AVFrame *av_frame_alloc(void);
389 * Free the frame and any dynamically allocated objects in it,
390 * e.g. extended_data. If the frame is reference counted, it will be
391 * unreferenced first.
393 * @param frame frame to be freed. The pointer will be set to NULL.
395 void av_frame_free(AVFrame **frame);
398 * Setup a new reference to the data described by an given frame.
400 * Copy frame properties from src to dst and create a new reference for each
401 * AVBufferRef from src.
403 * If src is not reference counted, new buffers are allocated and the data is
406 * @return 0 on success, a negative AVERROR on error
408 int av_frame_ref(AVFrame *dst, const AVFrame *src);
411 * Create a new frame that references the same data as src.
413 * This is a shortcut for av_frame_alloc()+av_frame_ref().
415 * @return newly created AVFrame on success, NULL on error.
417 AVFrame *av_frame_clone(const AVFrame *src);
420 * Unreference all the buffers referenced by frame and reset the frame fields.
422 void av_frame_unref(AVFrame *frame);
425 * Move everythnig contained in src to dst and reset src.
427 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
430 * Allocate new buffer(s) for audio or video data.
432 * The following fields must be set on frame before calling this function:
433 * - format (pixel format for video, sample format for audio)
434 * - width and height for video
435 * - nb_samples and channel_layout for audio
437 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
438 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
439 * For planar formats, one buffer will be allocated for each plane.
441 * @param frame frame in which to store the new buffers.
442 * @param align required buffer size alignment
444 * @return 0 on success, a negative AVERROR on error.
446 int av_frame_get_buffer(AVFrame *frame, int align);
449 * Check if the frame data is writable.
451 * @return A positive value if the frame data is writable (which is true if and
452 * only if each of the underlying buffers has only one reference, namely the one
453 * stored in this frame). Return 0 otherwise.
455 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
456 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
458 * @see av_frame_make_writable(), av_buffer_is_writable()
460 int av_frame_is_writable(AVFrame *frame);
463 * Ensure that the frame data is writable, avoiding data copy if possible.
465 * Do nothing if the frame is writable, allocate new buffers and copy the data
468 * @return 0 on success, a negative AVERROR on error.
470 * @see av_frame_is_writable(), av_buffer_is_writable(),
471 * av_buffer_make_writable()
473 int av_frame_make_writable(AVFrame *frame);
476 * Copy only "metadata" fields from src to dst.
478 * Metadata for the purpose of this function are those fields that do not affect
479 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
480 * aspect ratio (for video), but not width/height or channel layout.
481 * Side data is also copied.
483 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
486 * Get the buffer reference a given data plane is stored in.
488 * @param plane index of the data plane of interest in frame->extended_data.
490 * @return the buffer reference that contains the plane or NULL if the input
491 * frame is not valid.
493 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
496 * Add a new side data to a frame.
498 * @param frame a frame to which the side data should be added
499 * @param type type of the added side data
500 * @param size size of the side data
502 * @return newly added side data on success, NULL on error
504 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
505 enum AVFrameSideDataType type,
509 * @return a pointer to the side data of a given type on success, NULL if there
510 * is no side data with such type in this frame.
512 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
513 enum AVFrameSideDataType type);
515 #endif /* AVUTIL_FRAME_H */