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,
50 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
52 AV_FRAME_DATA_MATRIXENCODING,
55 typedef struct AVFrameSideData {
56 enum AVFrameSideDataType type;
59 AVDictionary *metadata;
63 * This structure describes decoded (raw) audio or video data.
65 * AVFrame must be allocated using av_frame_alloc(). Note that this only
66 * allocates the AVFrame itself, the buffers for the data must be managed
67 * through other means (see below).
68 * AVFrame must be freed with av_frame_free().
70 * AVFrame is typically allocated once and then reused multiple times to hold
71 * different data (e.g. a single AVFrame to hold frames received from a
72 * decoder). In such a case, av_frame_unref() will free any references held by
73 * the frame and reset it to its original clean state before it
76 * The data described by an AVFrame is usually reference counted through the
77 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
78 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
79 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
80 * every single data plane must be contained in one of the buffers in
81 * AVFrame.buf or AVFrame.extended_buf.
82 * There may be a single buffer for all the data, or one separate buffer for
83 * each plane, or anything in between.
85 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
86 * to the end with a minor bump.
88 typedef struct AVFrame {
89 #define AV_NUM_DATA_POINTERS 8
91 * pointer to the picture/channel planes.
92 * This might be different from the first allocated byte
94 uint8_t *data[AV_NUM_DATA_POINTERS];
97 * For video, size in bytes of each picture line.
98 * For audio, size in bytes of each plane.
100 * For audio, only linesize[0] may be set. For planar audio, each channel
101 * plane must be the same size.
103 * @note The linesize may be larger than the size of usable data -- there
104 * may be extra padding present for performance reasons.
106 int linesize[AV_NUM_DATA_POINTERS];
109 * pointers to the data planes/channels.
111 * For video, this should simply point to data[].
113 * For planar audio, each channel has a separate data pointer, and
114 * linesize[0] contains the size of each channel buffer.
115 * For packed audio, there is just one data pointer, and linesize[0]
116 * contains the total size of the buffer for all channels.
118 * Note: Both data and extended_data should always be set in a valid frame,
119 * but for planar audio with more channels that can fit in data,
120 * extended_data must be used in order to access all channels.
122 uint8_t **extended_data;
125 * width and height of the video frame
130 * number of audio samples (per channel) described by this frame
135 * format of the frame, -1 if unknown or unset
136 * Values correspond to enum AVPixelFormat for video frames,
137 * enum AVSampleFormat for audio)
142 * 1 -> keyframe, 0-> not
147 * Picture type of the frame.
149 enum AVPictureType pict_type;
151 #if FF_API_AVFRAME_LAVC
153 uint8_t *base[AV_NUM_DATA_POINTERS];
157 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
159 AVRational sample_aspect_ratio;
162 * Presentation timestamp in time_base units (time when frame should be shown to user).
167 * PTS copied from the AVPacket that was decoded to produce this frame.
172 * DTS copied from the AVPacket that triggered returning this frame.
177 * picture number in bitstream order
179 int coded_picture_number;
181 * picture number in display order
183 int display_picture_number;
186 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
190 #if FF_API_AVFRAME_LAVC
198 int8_t *qscale_table;
209 * mbskip_table[mb]>=1 if MB didn't change
210 * stride= mb_width = (width+15)>>4
213 uint8_t *mbskip_table;
216 * motion vector table
219 * int mv_sample_log2= 4 - motion_subsample_log2;
220 * int mb_width= (width+15)>>4;
221 * int mv_stride= (mb_width << mv_sample_log2) + 1;
222 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
226 int16_t (*motion_val[2])[2];
229 * macroblock type table
230 * mb_type_base + mb_width + 2
242 * motion reference frame index
243 * the order in which these are stored can depend on the codec.
246 int8_t *ref_index[2];
250 * for some private data of the user
257 uint64_t error[AV_NUM_DATA_POINTERS];
259 #if FF_API_AVFRAME_LAVC
265 * When decoding, this signals how much the picture must be delayed.
266 * extra_delay = repeat_pict / (2*fps)
271 * The content of the picture is interlaced.
273 int interlaced_frame;
276 * If the content is interlaced, is top field displayed first.
281 * Tell user application that palette has changed from previous frame.
283 int palette_has_changed;
285 #if FF_API_AVFRAME_LAVC
293 struct AVPanScan *pan_scan;
297 * reordered opaque 64bit (generally an integer or a double precision float
298 * PTS but can be anything).
299 * The user sets AVCodecContext.reordered_opaque to represent the input at
301 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
302 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
303 * @deprecated in favor of pkt_pts
305 int64_t reordered_opaque;
307 #if FF_API_AVFRAME_LAVC
309 * @deprecated this field is unused
311 attribute_deprecated void *hwaccel_picture_private;
314 struct AVCodecContext *owner;
319 * log2 of the size of the block which a single vector in motion_val represents:
320 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
323 uint8_t motion_subsample_log2;
327 * Sample rate of the audio data.
332 * Channel layout of the audio data.
334 uint64_t channel_layout;
337 * AVBuffer references backing the data for this frame. If all elements of
338 * this array are NULL, then this frame is not reference counted.
340 * There may be at most one AVBuffer per data plane, so for video this array
341 * always contains all the references. For planar audio with more than
342 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
343 * this array. Then the extra AVBufferRef pointers are stored in the
344 * extended_buf array.
346 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
349 * For planar audio which requires more than AV_NUM_DATA_POINTERS
350 * AVBufferRef pointers, this array will hold all the references which
351 * cannot fit into AVFrame.buf.
353 * Note that this is different from AVFrame.extended_data, which always
354 * contains all the pointers. This array only contains the extra pointers,
355 * which cannot fit into AVFrame.buf.
357 * This array is always allocated using av_malloc() by whoever constructs
358 * the frame. It is freed in av_frame_unref().
360 AVBufferRef **extended_buf;
362 * Number of elements in extended_buf.
366 AVFrameSideData **side_data;
370 * The frame data may be corrupted, e.g. due to decoding errors.
372 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
375 * Frame flags, a combination of AV_FRAME_FLAG_*
381 * Allocate an AVFrame and set its fields to default values. The resulting
382 * struct must be freed using av_frame_free().
384 * @return An AVFrame filled with default values or NULL on failure.
386 * @note this only allocates the AVFrame itself, not the data buffers. Those
387 * must be allocated through other means, e.g. with av_frame_get_buffer() or
390 AVFrame *av_frame_alloc(void);
393 * Free the frame and any dynamically allocated objects in it,
394 * e.g. extended_data. If the frame is reference counted, it will be
395 * unreferenced first.
397 * @param frame frame to be freed. The pointer will be set to NULL.
399 void av_frame_free(AVFrame **frame);
402 * Setup a new reference to the data described by an given frame.
404 * Copy frame properties from src to dst and create a new reference for each
405 * AVBufferRef from src.
407 * If src is not reference counted, new buffers are allocated and the data is
410 * @return 0 on success, a negative AVERROR on error
412 int av_frame_ref(AVFrame *dst, const AVFrame *src);
415 * Create a new frame that references the same data as src.
417 * This is a shortcut for av_frame_alloc()+av_frame_ref().
419 * @return newly created AVFrame on success, NULL on error.
421 AVFrame *av_frame_clone(const AVFrame *src);
424 * Unreference all the buffers referenced by frame and reset the frame fields.
426 void av_frame_unref(AVFrame *frame);
429 * Move everythnig contained in src to dst and reset src.
431 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
434 * Allocate new buffer(s) for audio or video data.
436 * The following fields must be set on frame before calling this function:
437 * - format (pixel format for video, sample format for audio)
438 * - width and height for video
439 * - nb_samples and channel_layout for audio
441 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
442 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
443 * For planar formats, one buffer will be allocated for each plane.
445 * @param frame frame in which to store the new buffers.
446 * @param align required buffer size alignment
448 * @return 0 on success, a negative AVERROR on error.
450 int av_frame_get_buffer(AVFrame *frame, int align);
453 * Check if the frame data is writable.
455 * @return A positive value if the frame data is writable (which is true if and
456 * only if each of the underlying buffers has only one reference, namely the one
457 * stored in this frame). Return 0 otherwise.
459 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
460 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
462 * @see av_frame_make_writable(), av_buffer_is_writable()
464 int av_frame_is_writable(AVFrame *frame);
467 * Ensure that the frame data is writable, avoiding data copy if possible.
469 * Do nothing if the frame is writable, allocate new buffers and copy the data
472 * @return 0 on success, a negative AVERROR on error.
474 * @see av_frame_is_writable(), av_buffer_is_writable(),
475 * av_buffer_make_writable()
477 int av_frame_make_writable(AVFrame *frame);
480 * Copy only "metadata" fields from src to dst.
482 * Metadata for the purpose of this function are those fields that do not affect
483 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
484 * aspect ratio (for video), but not width/height or channel layout.
485 * Side data is also copied.
487 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
490 * Get the buffer reference a given data plane is stored in.
492 * @param plane index of the data plane of interest in frame->extended_data.
494 * @return the buffer reference that contains the plane or NULL if the input
495 * frame is not valid.
497 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
500 * Add a new side data to a frame.
502 * @param frame a frame to which the side data should be added
503 * @param type type of the added side data
504 * @param size size of the side data
506 * @return newly added side data on success, NULL on error
508 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
509 enum AVFrameSideDataType type,
513 * @return a pointer to the side data of a given type on success, NULL if there
514 * is no side data with such type in this frame.
516 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
517 enum AVFrameSideDataType type);
519 #endif /* AVUTIL_FRAME_H */