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,
40 typedef struct AVFrameSideData {
41 enum AVFrameSideDataType type;
44 AVDictionary *metadata;
48 * This structure describes decoded (raw) audio or video data.
50 * AVFrame must be allocated using av_frame_alloc(). Not that this only
51 * allocates the AVFrame itself, the buffers for the data must be managed
52 * through other means (see below).
53 * AVFrame must be freed with av_frame_free().
55 * AVFrame is typically allocated once and then reused multiple times to hold
56 * different data (e.g. a single AVFrame to hold frames received from a
57 * decoder). In such a case, av_frame_unref() will free any references held by
58 * the frame and reset it to its original clean state before it
61 * The data described by an AVFrame is usually reference counted through the
62 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
63 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
64 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
65 * every single data plane must be contained in one of the buffers in
66 * AVFrame.buf or AVFrame.extended_buf.
67 * There may be a single buffer for all the data, or one separate buffer for
68 * each plane, or anything in between.
70 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
71 * to the end with a minor bump.
73 typedef struct AVFrame {
74 #define AV_NUM_DATA_POINTERS 8
76 * pointer to the picture/channel planes.
77 * This might be different from the first allocated byte
79 uint8_t *data[AV_NUM_DATA_POINTERS];
82 * For video, size in bytes of each picture line.
83 * For audio, size in bytes of each plane.
85 * For audio, only linesize[0] may be set. For planar audio, each channel
86 * plane must be the same size.
88 * @note The linesize may be larger than the size of usable data -- there
89 * may be extra padding present for performance reasons.
91 int linesize[AV_NUM_DATA_POINTERS];
94 * pointers to the data planes/channels.
96 * For video, this should simply point to data[].
98 * For planar audio, each channel has a separate data pointer, and
99 * linesize[0] contains the size of each channel buffer.
100 * For packed audio, there is just one data pointer, and linesize[0]
101 * contains the total size of the buffer for all channels.
103 * Note: Both data and extended_data should always be set in a valid frame,
104 * but for planar audio with more channels that can fit in data,
105 * extended_data must be used in order to access all channels.
107 uint8_t **extended_data;
110 * width and height of the video frame
115 * number of audio samples (per channel) described by this frame
120 * format of the frame, -1 if unknown or unset
121 * Values correspond to enum AVPixelFormat for video frames,
122 * enum AVSampleFormat for audio)
127 * 1 -> keyframe, 0-> not
132 * Picture type of the frame.
134 enum AVPictureType pict_type;
136 #if FF_API_AVFRAME_LAVC
138 uint8_t *base[AV_NUM_DATA_POINTERS];
142 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
144 AVRational sample_aspect_ratio;
147 * Presentation timestamp in time_base units (time when frame should be shown to user).
152 * PTS copied from the AVPacket that was decoded to produce this frame.
157 * DTS copied from the AVPacket that triggered returning this frame.
162 * picture number in bitstream order
164 int coded_picture_number;
166 * picture number in display order
168 int display_picture_number;
171 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
175 #if FF_API_AVFRAME_LAVC
183 int8_t *qscale_table;
194 * mbskip_table[mb]>=1 if MB didn't change
195 * stride= mb_width = (width+15)>>4
198 uint8_t *mbskip_table;
201 * motion vector table
204 * int mv_sample_log2= 4 - motion_subsample_log2;
205 * int mb_width= (width+15)>>4;
206 * int mv_stride= (mb_width << mv_sample_log2) + 1;
207 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
211 int16_t (*motion_val[2])[2];
214 * macroblock type table
215 * mb_type_base + mb_width + 2
227 * motion reference frame index
228 * the order in which these are stored can depend on the codec.
231 int8_t *ref_index[2];
235 * for some private data of the user
242 uint64_t error[AV_NUM_DATA_POINTERS];
244 #if FF_API_AVFRAME_LAVC
250 * When decoding, this signals how much the picture must be delayed.
251 * extra_delay = repeat_pict / (2*fps)
256 * The content of the picture is interlaced.
258 int interlaced_frame;
261 * If the content is interlaced, is top field displayed first.
266 * Tell user application that palette has changed from previous frame.
268 int palette_has_changed;
270 #if FF_API_AVFRAME_LAVC
278 struct AVPanScan *pan_scan;
282 * reordered opaque 64bit (generally an integer or a double precision float
283 * PTS but can be anything).
284 * The user sets AVCodecContext.reordered_opaque to represent the input at
286 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
287 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
288 * @deprecated in favor of pkt_pts
290 int64_t reordered_opaque;
292 #if FF_API_AVFRAME_LAVC
294 * @deprecated this field is unused
296 attribute_deprecated void *hwaccel_picture_private;
299 struct AVCodecContext *owner;
304 * log2 of the size of the block which a single vector in motion_val represents:
305 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
308 uint8_t motion_subsample_log2;
312 * Sample rate of the audio data.
317 * Channel layout of the audio data.
319 uint64_t channel_layout;
322 * AVBuffer references backing the data for this frame. If all elements of
323 * this array are NULL, then this frame is not reference counted.
325 * There may be at most one AVBuffer per data plane, so for video this array
326 * always contains all the references. For planar audio with more than
327 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
328 * this array. Then the extra AVBufferRef pointers are stored in the
329 * extended_buf array.
331 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
334 * For planar audio which requires more than AV_NUM_DATA_POINTERS
335 * AVBufferRef pointers, this array will hold all the references which
336 * cannot fit into AVFrame.buf.
338 * Note that this is different from AVFrame.extended_data, which always
339 * contains all the pointers. This array only contains the extra pointers,
340 * which cannot fit into AVFrame.buf.
342 * This array is always allocated using av_malloc() by whoever constructs
343 * the frame. It is freed in av_frame_unref().
345 AVBufferRef **extended_buf;
347 * Number of elements in extended_buf.
351 AVFrameSideData **side_data;
355 * The frame data may be corrupted, e.g. due to decoding errors.
357 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
360 * Frame flags, a combination of AV_FRAME_FLAG_*
366 * Allocate an AVFrame and set its fields to default values. The resulting
367 * struct must be freed using av_frame_free().
369 * @return An AVFrame filled with default values or NULL on failure.
371 * @note this only allocates the AVFrame itself, not the data buffers. Those
372 * must be allocated through other means, e.g. with av_frame_get_buffer() or
375 AVFrame *av_frame_alloc(void);
378 * Free the frame and any dynamically allocated objects in it,
379 * e.g. extended_data. If the frame is reference counted, it will be
380 * unreferenced first.
382 * @param frame frame to be freed. The pointer will be set to NULL.
384 void av_frame_free(AVFrame **frame);
387 * Setup a new reference to the data described by an given frame.
389 * Copy frame properties from src to dst and create a new reference for each
390 * AVBufferRef from src.
392 * If src is not reference counted, new buffers are allocated and the data is
395 * @return 0 on success, a negative AVERROR on error
397 int av_frame_ref(AVFrame *dst, const AVFrame *src);
400 * Create a new frame that references the same data as src.
402 * This is a shortcut for av_frame_alloc()+av_frame_ref().
404 * @return newly created AVFrame on success, NULL on error.
406 AVFrame *av_frame_clone(const AVFrame *src);
409 * Unreference all the buffers referenced by frame and reset the frame fields.
411 void av_frame_unref(AVFrame *frame);
414 * Move everythnig contained in src to dst and reset src.
416 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
419 * Allocate new buffer(s) for audio or video data.
421 * The following fields must be set on frame before calling this function:
422 * - format (pixel format for video, sample format for audio)
423 * - width and height for video
424 * - nb_samples and channel_layout for audio
426 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
427 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
428 * For planar formats, one buffer will be allocated for each plane.
430 * @param frame frame in which to store the new buffers.
431 * @param align required buffer size alignment
433 * @return 0 on success, a negative AVERROR on error.
435 int av_frame_get_buffer(AVFrame *frame, int align);
438 * Check if the frame data is writable.
440 * @return A positive value if the frame data is writable (which is true if and
441 * only if each of the underlying buffers has only one reference, namely the one
442 * stored in this frame). Return 0 otherwise.
444 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
445 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
447 * @see av_frame_make_writable(), av_buffer_is_writable()
449 int av_frame_is_writable(AVFrame *frame);
452 * Ensure that the frame data is writable, avoiding data copy if possible.
454 * Do nothing if the frame is writable, allocate new buffers and copy the data
457 * @return 0 on success, a negative AVERROR on error.
459 * @see av_frame_is_writable(), av_buffer_is_writable(),
460 * av_buffer_make_writable()
462 int av_frame_make_writable(AVFrame *frame);
465 * Copy only "metadata" fields from src to dst.
467 * Metadata for the purpose of this function are those fields that do not affect
468 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
469 * aspect ratio (for video), but not width/height or channel layout.
470 * Side data is also copied.
472 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
475 * Get the buffer reference a given data plane is stored in.
477 * @param plane index of the data plane of interest in frame->extended_data.
479 * @return the buffer reference that contains the plane or NULL if the input
480 * frame is not valid.
482 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
485 * Add a new side data to a frame.
487 * @param frame a frame to which the side data should be added
488 * @param type type of the added side data
489 * @param size size of the side data
491 * @return newly added side data on success, NULL on error
493 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
494 enum AVFrameSideDataType type,
498 * @return a pointer to the side data of a given type on success, NULL if there
499 * is no side data with such type in this frame.
501 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
502 enum AVFrameSideDataType type);
504 #endif /* AVUTIL_FRAME_H */