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
20 #ifndef AVUTIL_FRAME_H
21 #define AVUTIL_FRAME_H
25 #include "libavcodec/version.h"
30 #include "samplefmt.h"
34 * This structure describes decoded (raw) audio or video data.
36 * AVFrame must be allocated using av_frame_alloc(). Not that this only
37 * allocates the AVFrame itself, the buffers for the data must be managed
38 * through other means (see below).
39 * AVFrame must be freed with av_frame_free().
41 * AVFrame is typically allocated once and then reused multiple times to hold
42 * different data (e.g. a single AVFrame to hold frames received from a
43 * decoder). In such a case, av_frame_unref() will free any references held by
44 * the frame and reset it to its original clean state before it
47 * The data described by an AVFrame is usually reference counted through the
48 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
49 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
50 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
51 * every single data plane must be contained in one of the buffers in
52 * AVFrame.buf or AVFrame.extended_buf.
53 * There may be a single buffer for all the data, or one separate buffer for
54 * each plane, or anything in between.
56 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
57 * to the end with a minor bump.
58 * Similarly fields that are marked as to be only accessed by
59 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
60 * without breaking compatibility with each other.
62 typedef struct AVFrame {
63 #define AV_NUM_DATA_POINTERS 8
65 * pointer to the picture/channel planes.
66 * This might be different from the first allocated byte
68 uint8_t *data[AV_NUM_DATA_POINTERS];
71 * For video, size in bytes of each picture line.
72 * For audio, size in bytes of each plane.
74 * For audio, only linesize[0] may be set. For planar audio, each channel
75 * plane must be the same size.
77 int linesize[AV_NUM_DATA_POINTERS];
80 * pointers to the data planes/channels.
82 * For video, this should simply point to data[].
84 * For planar audio, each channel has a separate data pointer, and
85 * linesize[0] contains the size of each channel buffer.
86 * For packed audio, there is just one data pointer, and linesize[0]
87 * contains the total size of the buffer for all channels.
89 * Note: Both data and extended_data should always be set in a valid frame,
90 * but for planar audio with more channels that can fit in data,
91 * extended_data must be used in order to access all channels.
93 uint8_t **extended_data;
96 * width and height of the video frame
101 * number of audio samples (per channel) described by this frame
106 * format of the frame, -1 if unknown or unset
107 * Values correspond to enum AVPixelFormat for video frames,
108 * enum AVSampleFormat for audio)
113 * 1 -> keyframe, 0-> not
118 * Picture type of the frame.
120 enum AVPictureType pict_type;
122 uint8_t *base[AV_NUM_DATA_POINTERS];
125 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
127 AVRational sample_aspect_ratio;
130 * Presentation timestamp in time_base units (time when frame should be shown to user).
135 * PTS copied from the AVPacket that was decoded to produce this frame.
140 * DTS copied from the AVPacket that triggered returning this frame.
145 * picture number in bitstream order
147 int coded_picture_number;
149 * picture number in display order
151 int display_picture_number;
154 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
163 int8_t *qscale_table;
172 * mbskip_table[mb]>=1 if MB didn't change
173 * stride= mb_width = (width+15)>>4
175 uint8_t *mbskip_table;
178 * motion vector table
181 * int mv_sample_log2= 4 - motion_subsample_log2;
182 * int mb_width= (width+15)>>4;
183 * int mv_stride= (mb_width << mv_sample_log2) + 1;
184 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
187 int16_t (*motion_val[2])[2];
190 * macroblock type table
191 * mb_type_base + mb_width + 2
201 * motion reference frame index
202 * the order in which these are stored can depend on the codec.
204 int8_t *ref_index[2];
207 * for some private data of the user
214 uint64_t error[AV_NUM_DATA_POINTERS];
219 * When decoding, this signals how much the picture must be delayed.
220 * extra_delay = repeat_pict / (2*fps)
225 * The content of the picture is interlaced.
227 int interlaced_frame;
230 * If the content is interlaced, is top field displayed first.
235 * Tell user application that palette has changed from previous frame.
237 int palette_has_changed;
244 struct AVPanScan *pan_scan;
247 * reordered opaque 64bit (generally an integer or a double precision float
248 * PTS but can be anything).
249 * The user sets AVCodecContext.reordered_opaque to represent the input at
251 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
252 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
253 * @deprecated in favor of pkt_pts
255 int64_t reordered_opaque;
257 #if FF_API_AVFRAME_LAVC
259 * @deprecated this field is unused
261 attribute_deprecated void *hwaccel_picture_private;
264 struct AVCodecContext *owner;
268 * log2 of the size of the block which a single vector in motion_val represents:
269 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
271 uint8_t motion_subsample_log2;
274 * Sample rate of the audio data.
279 * Channel layout of the audio data.
281 uint64_t channel_layout;
284 * AVBuffer references backing the data for this frame. If all elements of
285 * this array are NULL, then this frame is not reference counted.
287 * There may be at most one AVBuffer per data plane, so for video this array
288 * always contains all the references. For planar audio with more than
289 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
290 * this array. Then the extra AVBufferRef pointers are stored in the
291 * extended_buf array.
293 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
296 * For planar audio which requires more than AV_NUM_DATA_POINTERS
297 * AVBufferRef pointers, this array will hold all the references which
298 * cannot fit into AVFrame.buf.
300 * Note that this is different from AVFrame.extended_data, which always
301 * contains all the pointers. This array only contains the extra pointers,
302 * which cannot fit into AVFrame.buf.
304 * This array is always allocated using av_malloc() by whoever constructs
305 * the frame. It is freed in av_frame_unref().
307 AVBufferRef **extended_buf;
309 * Number of elements in extended_buf.
314 * frame timestamp estimated using various heuristics, in stream time base
315 * Code outside libavcodec should access this field using:
316 * av_frame_get_best_effort_timestamp(frame)
318 * - decoding: set by libavcodec, read by user.
320 int64_t best_effort_timestamp;
323 * reordered pos from the last AVPacket that has been input into the decoder
324 * Code outside libavcodec should access this field using:
325 * av_frame_get_pkt_pos(frame)
327 * - decoding: Read by user.
332 * duration of the corresponding packet, expressed in
333 * AVStream->time_base units, 0 if unknown.
334 * Code outside libavcodec should access this field using:
335 * av_frame_get_pkt_duration(frame)
337 * - decoding: Read by user.
339 int64_t pkt_duration;
343 * Code outside libavcodec should access this field using:
344 * av_frame_get_metadata(frame)
345 * - encoding: Set by user.
346 * - decoding: Set by libavcodec.
348 AVDictionary *metadata;
351 * decode error flags of the frame, set to a combination of
352 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
353 * were errors during the decoding.
354 * Code outside libavcodec should access this field using:
355 * av_frame_get_decode_error_flags(frame)
357 * - decoding: set by libavcodec, read by user.
359 int decode_error_flags;
360 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
361 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
364 * number of audio channels, only used for audio.
365 * Code outside libavcodec should access this field using:
366 * av_frame_get_channels(frame)
368 * - decoding: Read by user.
373 * size of the corresponding packet containing the compressed
374 * frame. It must be accessed using av_frame_get_pkt_size() and
375 * av_frame_set_pkt_size().
376 * It is set to a negative value if unknown.
378 * - decoding: set by libavcodec, read by user.
384 * Accessors for some AVFrame fields.
385 * The position of these field in the structure is not part of the ABI,
386 * they should not be accessed directly outside libavcodec.
388 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
389 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
390 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
391 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
392 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
393 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
394 int64_t av_frame_get_channel_layout (const AVFrame *frame);
395 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
396 int av_frame_get_channels (const AVFrame *frame);
397 void av_frame_set_channels (AVFrame *frame, int val);
398 int av_frame_get_sample_rate (const AVFrame *frame);
399 void av_frame_set_sample_rate (AVFrame *frame, int val);
400 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
401 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
402 int av_frame_get_decode_error_flags (const AVFrame *frame);
403 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
404 int av_frame_get_pkt_size(const AVFrame *frame);
405 void av_frame_set_pkt_size(AVFrame *frame, int val);
406 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
409 * Allocate an AVFrame and set its fields to default values. The resulting
410 * struct must be freed using av_frame_free().
412 * @return An AVFrame filled with default values or NULL on failure.
414 * @note this only allocates the AVFrame itself, not the data buffers. Those
415 * must be allocated through other means, e.g. with av_frame_get_buffer() or
418 AVFrame *av_frame_alloc(void);
421 * Free the frame and any dynamically allocated objects in it,
422 * e.g. extended_data. If the frame is reference counted, it will be
423 * unreferenced first.
425 * @param frame frame to be freed. The pointer will be set to NULL.
427 void av_frame_free(AVFrame **frame);
430 * Setup a new reference to the data described by an given frame.
432 * Copy frame properties from src to dst and create a new reference for each
433 * AVBufferRef from src.
435 * If src is not reference counted, new buffers are allocated and the data is
438 * @return 0 on success, a negative AVERROR on error
440 int av_frame_ref(AVFrame *dst, AVFrame *src);
443 * Create a new frame that references the same data as src.
445 * This is a shortcut for av_frame_alloc()+av_frame_ref().
447 * @return newly created AVFrame on success, NULL on error.
449 AVFrame *av_frame_clone(AVFrame *src);
452 * Unreference all the buffers referenced by frame and reset the frame fields.
454 void av_frame_unref(AVFrame *frame);
457 * Move everythnig contained in src to dst and reset src.
459 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
462 * Allocate new buffer(s) for audio or video data.
464 * The following fields must be set on frame before calling this function:
465 * - format (pixel format for video, sample format for audio)
466 * - width and height for video
467 * - nb_samples and channel_layout for audio
469 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
470 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
471 * For planar formats, one buffer will be allocated for each plane.
473 * @param frame frame in which to store the new buffers.
474 * @param align required buffer size alignment
476 * @return 0 on success, a negative AVERROR on error.
478 int av_frame_get_buffer(AVFrame *frame, int align);
481 * Check if the frame data is writable.
483 * @return A positive value if the frame data is writable (which is true if and
484 * only if each of the underlying buffers has only one reference, namely the one
485 * stored in this frame). Return 0 otherwise.
487 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
488 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
490 * @see av_frame_make_writable(), av_buffer_is_writable()
492 int av_frame_is_writable(AVFrame *frame);
495 * Ensure that the frame data is writable, avoiding data copy if possible.
497 * Do nothing if the frame is writable, allocate new buffers and copy the data
500 * @return 0 on success, a negative AVERROR on error.
502 * @see av_frame_is_writable(), av_buffer_is_writable(),
503 * av_buffer_make_writable()
505 int av_frame_make_writable(AVFrame *frame);
508 * Copy only "metadata" fields from src to dst.
510 * Metadata for the purpose of this function are those fields that do not affect
511 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
512 * aspect ratio (for video), but not width/height or channel layout.
514 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
517 * Get the buffer reference a given data plane is stored in.
519 * @param plane index of the data plane of interest in frame->extended_data.
521 * @return the buffer reference that contains the plane or NULL if the input
522 * frame is not valid.
524 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
526 #endif /* AVUTIL_FRAME_H */