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.
46 typedef struct AVFrameSideData {
47 enum AVFrameSideDataType type;
50 AVDictionary *metadata;
54 * This structure describes decoded (raw) audio or video data.
56 * AVFrame must be allocated using av_frame_alloc(). Not that this only
57 * allocates the AVFrame itself, the buffers for the data must be managed
58 * through other means (see below).
59 * AVFrame must be freed with av_frame_free().
61 * AVFrame is typically allocated once and then reused multiple times to hold
62 * different data (e.g. a single AVFrame to hold frames received from a
63 * decoder). In such a case, av_frame_unref() will free any references held by
64 * the frame and reset it to its original clean state before it
67 * The data described by an AVFrame is usually reference counted through the
68 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
69 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
70 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
71 * every single data plane must be contained in one of the buffers in
72 * AVFrame.buf or AVFrame.extended_buf.
73 * There may be a single buffer for all the data, or one separate buffer for
74 * each plane, or anything in between.
76 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
77 * to the end with a minor bump.
79 typedef struct AVFrame {
80 #define AV_NUM_DATA_POINTERS 8
82 * pointer to the picture/channel planes.
83 * This might be different from the first allocated byte
85 uint8_t *data[AV_NUM_DATA_POINTERS];
88 * For video, size in bytes of each picture line.
89 * For audio, size in bytes of each plane.
91 * For audio, only linesize[0] may be set. For planar audio, each channel
92 * plane must be the same size.
94 * @note The linesize may be larger than the size of usable data -- there
95 * may be extra padding present for performance reasons.
97 int linesize[AV_NUM_DATA_POINTERS];
100 * pointers to the data planes/channels.
102 * For video, this should simply point to data[].
104 * For planar audio, each channel has a separate data pointer, and
105 * linesize[0] contains the size of each channel buffer.
106 * For packed audio, there is just one data pointer, and linesize[0]
107 * contains the total size of the buffer for all channels.
109 * Note: Both data and extended_data should always be set in a valid frame,
110 * but for planar audio with more channels that can fit in data,
111 * extended_data must be used in order to access all channels.
113 uint8_t **extended_data;
116 * width and height of the video frame
121 * number of audio samples (per channel) described by this frame
126 * format of the frame, -1 if unknown or unset
127 * Values correspond to enum AVPixelFormat for video frames,
128 * enum AVSampleFormat for audio)
133 * 1 -> keyframe, 0-> not
138 * Picture type of the frame.
140 enum AVPictureType pict_type;
142 #if FF_API_AVFRAME_LAVC
144 uint8_t *base[AV_NUM_DATA_POINTERS];
148 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
150 AVRational sample_aspect_ratio;
153 * Presentation timestamp in time_base units (time when frame should be shown to user).
158 * PTS copied from the AVPacket that was decoded to produce this frame.
163 * DTS copied from the AVPacket that triggered returning this frame.
168 * picture number in bitstream order
170 int coded_picture_number;
172 * picture number in display order
174 int display_picture_number;
177 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
181 #if FF_API_AVFRAME_LAVC
189 int8_t *qscale_table;
200 * mbskip_table[mb]>=1 if MB didn't change
201 * stride= mb_width = (width+15)>>4
204 uint8_t *mbskip_table;
207 * motion vector table
210 * int mv_sample_log2= 4 - motion_subsample_log2;
211 * int mb_width= (width+15)>>4;
212 * int mv_stride= (mb_width << mv_sample_log2) + 1;
213 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
217 int16_t (*motion_val[2])[2];
220 * macroblock type table
221 * mb_type_base + mb_width + 2
233 * motion reference frame index
234 * the order in which these are stored can depend on the codec.
237 int8_t *ref_index[2];
241 * for some private data of the user
248 uint64_t error[AV_NUM_DATA_POINTERS];
250 #if FF_API_AVFRAME_LAVC
256 * When decoding, this signals how much the picture must be delayed.
257 * extra_delay = repeat_pict / (2*fps)
262 * The content of the picture is interlaced.
264 int interlaced_frame;
267 * If the content is interlaced, is top field displayed first.
272 * Tell user application that palette has changed from previous frame.
274 int palette_has_changed;
276 #if FF_API_AVFRAME_LAVC
284 struct AVPanScan *pan_scan;
288 * reordered opaque 64bit (generally an integer or a double precision float
289 * PTS but can be anything).
290 * The user sets AVCodecContext.reordered_opaque to represent the input at
292 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
293 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
294 * @deprecated in favor of pkt_pts
296 int64_t reordered_opaque;
298 #if FF_API_AVFRAME_LAVC
300 * @deprecated this field is unused
302 attribute_deprecated void *hwaccel_picture_private;
305 struct AVCodecContext *owner;
310 * log2 of the size of the block which a single vector in motion_val represents:
311 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
314 uint8_t motion_subsample_log2;
318 * Sample rate of the audio data.
323 * Channel layout of the audio data.
325 uint64_t channel_layout;
328 * AVBuffer references backing the data for this frame. If all elements of
329 * this array are NULL, then this frame is not reference counted.
331 * There may be at most one AVBuffer per data plane, so for video this array
332 * always contains all the references. For planar audio with more than
333 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
334 * this array. Then the extra AVBufferRef pointers are stored in the
335 * extended_buf array.
337 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
340 * For planar audio which requires more than AV_NUM_DATA_POINTERS
341 * AVBufferRef pointers, this array will hold all the references which
342 * cannot fit into AVFrame.buf.
344 * Note that this is different from AVFrame.extended_data, which always
345 * contains all the pointers. This array only contains the extra pointers,
346 * which cannot fit into AVFrame.buf.
348 * This array is always allocated using av_malloc() by whoever constructs
349 * the frame. It is freed in av_frame_unref().
351 AVBufferRef **extended_buf;
353 * Number of elements in extended_buf.
357 AVFrameSideData **side_data;
361 * The frame data may be corrupted, e.g. due to decoding errors.
363 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
366 * Frame flags, a combination of AV_FRAME_FLAG_*
372 * Allocate an AVFrame and set its fields to default values. The resulting
373 * struct must be freed using av_frame_free().
375 * @return An AVFrame filled with default values or NULL on failure.
377 * @note this only allocates the AVFrame itself, not the data buffers. Those
378 * must be allocated through other means, e.g. with av_frame_get_buffer() or
381 AVFrame *av_frame_alloc(void);
384 * Free the frame and any dynamically allocated objects in it,
385 * e.g. extended_data. If the frame is reference counted, it will be
386 * unreferenced first.
388 * @param frame frame to be freed. The pointer will be set to NULL.
390 void av_frame_free(AVFrame **frame);
393 * Setup a new reference to the data described by an given frame.
395 * Copy frame properties from src to dst and create a new reference for each
396 * AVBufferRef from src.
398 * If src is not reference counted, new buffers are allocated and the data is
401 * @return 0 on success, a negative AVERROR on error
403 int av_frame_ref(AVFrame *dst, const AVFrame *src);
406 * Create a new frame that references the same data as src.
408 * This is a shortcut for av_frame_alloc()+av_frame_ref().
410 * @return newly created AVFrame on success, NULL on error.
412 AVFrame *av_frame_clone(const AVFrame *src);
415 * Unreference all the buffers referenced by frame and reset the frame fields.
417 void av_frame_unref(AVFrame *frame);
420 * Move everythnig contained in src to dst and reset src.
422 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
425 * Allocate new buffer(s) for audio or video data.
427 * The following fields must be set on frame before calling this function:
428 * - format (pixel format for video, sample format for audio)
429 * - width and height for video
430 * - nb_samples and channel_layout for audio
432 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
433 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
434 * For planar formats, one buffer will be allocated for each plane.
436 * @param frame frame in which to store the new buffers.
437 * @param align required buffer size alignment
439 * @return 0 on success, a negative AVERROR on error.
441 int av_frame_get_buffer(AVFrame *frame, int align);
444 * Check if the frame data is writable.
446 * @return A positive value if the frame data is writable (which is true if and
447 * only if each of the underlying buffers has only one reference, namely the one
448 * stored in this frame). Return 0 otherwise.
450 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
451 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
453 * @see av_frame_make_writable(), av_buffer_is_writable()
455 int av_frame_is_writable(AVFrame *frame);
458 * Ensure that the frame data is writable, avoiding data copy if possible.
460 * Do nothing if the frame is writable, allocate new buffers and copy the data
463 * @return 0 on success, a negative AVERROR on error.
465 * @see av_frame_is_writable(), av_buffer_is_writable(),
466 * av_buffer_make_writable()
468 int av_frame_make_writable(AVFrame *frame);
471 * Copy only "metadata" fields from src to dst.
473 * Metadata for the purpose of this function are those fields that do not affect
474 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
475 * aspect ratio (for video), but not width/height or channel layout.
476 * Side data is also copied.
478 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
481 * Get the buffer reference a given data plane is stored in.
483 * @param plane index of the data plane of interest in frame->extended_data.
485 * @return the buffer reference that contains the plane or NULL if the input
486 * frame is not valid.
488 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
491 * Add a new side data to a frame.
493 * @param frame a frame to which the side data should be added
494 * @param type type of the added side data
495 * @param size size of the side data
497 * @return newly added side data on success, NULL on error
499 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
500 enum AVFrameSideDataType type,
504 * @return a pointer to the side data of a given type on success, NULL if there
505 * is no side data with such type in this frame.
507 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
508 enum AVFrameSideDataType type);
510 #endif /* AVUTIL_FRAME_H */