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"
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(). Note 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.
72 * Similarly fields that are marked as to be only accessed by
73 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
74 * without breaking compatibility with each other.
76 typedef struct AVFrame {
77 #define AV_NUM_DATA_POINTERS 8
79 * pointer to the picture/channel planes.
80 * This might be different from the first allocated byte
82 uint8_t *data[AV_NUM_DATA_POINTERS];
85 * For video, size in bytes of each picture line.
86 * For audio, size in bytes of each plane.
88 * For audio, only linesize[0] may be set. For planar audio, each channel
89 * plane must be the same size.
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 uint8_t *base[AV_NUM_DATA_POINTERS];
139 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
141 AVRational sample_aspect_ratio;
144 * Presentation timestamp in time_base units (time when frame should be shown to user).
149 * PTS copied from the AVPacket that was decoded to produce this frame.
154 * DTS copied from the AVPacket that triggered returning this frame.
159 * picture number in bitstream order
161 int coded_picture_number;
163 * picture number in display order
165 int display_picture_number;
168 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
177 int8_t *qscale_table;
186 * mbskip_table[mb]>=1 if MB didn't change
187 * stride= mb_width = (width+15)>>4
189 uint8_t *mbskip_table;
192 * motion vector table
195 * int mv_sample_log2= 4 - motion_subsample_log2;
196 * int mb_width= (width+15)>>4;
197 * int mv_stride= (mb_width << mv_sample_log2) + 1;
198 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
201 int16_t (*motion_val[2])[2];
204 * macroblock type table
205 * mb_type_base + mb_width + 2
215 * motion reference frame index
216 * the order in which these are stored can depend on the codec.
218 int8_t *ref_index[2];
221 * for some private data of the user
228 uint64_t error[AV_NUM_DATA_POINTERS];
233 * When decoding, this signals how much the picture must be delayed.
234 * extra_delay = repeat_pict / (2*fps)
239 * The content of the picture is interlaced.
241 int interlaced_frame;
244 * If the content is interlaced, is top field displayed first.
249 * Tell user application that palette has changed from previous frame.
251 int palette_has_changed;
258 struct AVPanScan *pan_scan;
261 * reordered opaque 64bit (generally an integer or a double precision float
262 * PTS but can be anything).
263 * The user sets AVCodecContext.reordered_opaque to represent the input at
265 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
266 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
267 * @deprecated in favor of pkt_pts
269 int64_t reordered_opaque;
271 #if FF_API_AVFRAME_LAVC
273 * @deprecated this field is unused
275 attribute_deprecated void *hwaccel_picture_private;
278 struct AVCodecContext *owner;
282 * log2 of the size of the block which a single vector in motion_val represents:
283 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
285 uint8_t motion_subsample_log2;
288 * Sample rate of the audio data.
293 * Channel layout of the audio data.
295 uint64_t channel_layout;
298 * AVBuffer references backing the data for this frame. If all elements of
299 * this array are NULL, then this frame is not reference counted.
301 * There may be at most one AVBuffer per data plane, so for video this array
302 * always contains all the references. For planar audio with more than
303 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
304 * this array. Then the extra AVBufferRef pointers are stored in the
305 * extended_buf array.
307 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
310 * For planar audio which requires more than AV_NUM_DATA_POINTERS
311 * AVBufferRef pointers, this array will hold all the references which
312 * cannot fit into AVFrame.buf.
314 * Note that this is different from AVFrame.extended_data, which always
315 * contains all the pointers. This array only contains the extra pointers,
316 * which cannot fit into AVFrame.buf.
318 * This array is always allocated using av_malloc() by whoever constructs
319 * the frame. It is freed in av_frame_unref().
321 AVBufferRef **extended_buf;
323 * Number of elements in extended_buf.
327 AVFrameSideData **side_data;
331 * frame timestamp estimated using various heuristics, in stream time base
332 * Code outside libavcodec should access this field using:
333 * av_frame_get_best_effort_timestamp(frame)
335 * - decoding: set by libavcodec, read by user.
337 int64_t best_effort_timestamp;
340 * reordered pos from the last AVPacket that has been input into the decoder
341 * Code outside libavcodec should access this field using:
342 * av_frame_get_pkt_pos(frame)
344 * - decoding: Read by user.
349 * duration of the corresponding packet, expressed in
350 * AVStream->time_base units, 0 if unknown.
351 * Code outside libavcodec should access this field using:
352 * av_frame_get_pkt_duration(frame)
354 * - decoding: Read by user.
356 int64_t pkt_duration;
360 * Code outside libavcodec should access this field using:
361 * av_frame_get_metadata(frame)
362 * - encoding: Set by user.
363 * - decoding: Set by libavcodec.
365 AVDictionary *metadata;
368 * decode error flags of the frame, set to a combination of
369 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
370 * were errors during the decoding.
371 * Code outside libavcodec should access this field using:
372 * av_frame_get_decode_error_flags(frame)
374 * - decoding: set by libavcodec, read by user.
376 int decode_error_flags;
377 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
378 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
381 * number of audio channels, only used for audio.
382 * Code outside libavcodec should access this field using:
383 * av_frame_get_channels(frame)
385 * - decoding: Read by user.
390 * size of the corresponding packet containing the compressed
391 * frame. It must be accessed using av_frame_get_pkt_size() and
392 * av_frame_set_pkt_size().
393 * It is set to a negative value if unknown.
395 * - decoding: set by libavcodec, read by user.
401 * Accessors for some AVFrame fields.
402 * The position of these field in the structure is not part of the ABI,
403 * they should not be accessed directly outside libavcodec.
405 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
406 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
407 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
408 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
409 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
410 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
411 int64_t av_frame_get_channel_layout (const AVFrame *frame);
412 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
413 int av_frame_get_channels (const AVFrame *frame);
414 void av_frame_set_channels (AVFrame *frame, int val);
415 int av_frame_get_sample_rate (const AVFrame *frame);
416 void av_frame_set_sample_rate (AVFrame *frame, int val);
417 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
418 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
419 int av_frame_get_decode_error_flags (const AVFrame *frame);
420 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
421 int av_frame_get_pkt_size(const AVFrame *frame);
422 void av_frame_set_pkt_size(AVFrame *frame, int val);
423 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
426 * Allocate an AVFrame and set its fields to default values. The resulting
427 * struct must be freed using av_frame_free().
429 * @return An AVFrame filled with default values or NULL on failure.
431 * @note this only allocates the AVFrame itself, not the data buffers. Those
432 * must be allocated through other means, e.g. with av_frame_get_buffer() or
435 AVFrame *av_frame_alloc(void);
438 * Free the frame and any dynamically allocated objects in it,
439 * e.g. extended_data. If the frame is reference counted, it will be
440 * unreferenced first.
442 * @param frame frame to be freed. The pointer will be set to NULL.
444 void av_frame_free(AVFrame **frame);
447 * Setup a new reference to the data described by an given frame.
449 * Copy frame properties from src to dst and create a new reference for each
450 * AVBufferRef from src.
452 * If src is not reference counted, new buffers are allocated and the data is
455 * @return 0 on success, a negative AVERROR on error
457 int av_frame_ref(AVFrame *dst, AVFrame *src);
460 * Create a new frame that references the same data as src.
462 * This is a shortcut for av_frame_alloc()+av_frame_ref().
464 * @return newly created AVFrame on success, NULL on error.
466 AVFrame *av_frame_clone(AVFrame *src);
469 * Unreference all the buffers referenced by frame and reset the frame fields.
471 void av_frame_unref(AVFrame *frame);
474 * Move everythnig contained in src to dst and reset src.
476 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
479 * Allocate new buffer(s) for audio or video data.
481 * The following fields must be set on frame before calling this function:
482 * - format (pixel format for video, sample format for audio)
483 * - width and height for video
484 * - nb_samples and channel_layout for audio
486 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
487 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
488 * For planar formats, one buffer will be allocated for each plane.
490 * @param frame frame in which to store the new buffers.
491 * @param align required buffer size alignment
493 * @return 0 on success, a negative AVERROR on error.
495 int av_frame_get_buffer(AVFrame *frame, int align);
498 * Check if the frame data is writable.
500 * @return A positive value if the frame data is writable (which is true if and
501 * only if each of the underlying buffers has only one reference, namely the one
502 * stored in this frame). Return 0 otherwise.
504 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
505 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
507 * @see av_frame_make_writable(), av_buffer_is_writable()
509 int av_frame_is_writable(AVFrame *frame);
512 * Ensure that the frame data is writable, avoiding data copy if possible.
514 * Do nothing if the frame is writable, allocate new buffers and copy the data
517 * @return 0 on success, a negative AVERROR on error.
519 * @see av_frame_is_writable(), av_buffer_is_writable(),
520 * av_buffer_make_writable()
522 int av_frame_make_writable(AVFrame *frame);
525 * Copy only "metadata" fields from src to dst.
527 * Metadata for the purpose of this function are those fields that do not affect
528 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
529 * aspect ratio (for video), but not width/height or channel layout.
530 * Side data is also copied.
532 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
535 * Get the buffer reference a given data plane is stored in.
537 * @param plane index of the data plane of interest in frame->extended_data.
539 * @return the buffer reference that contains the plane or NULL if the input
540 * frame is not valid.
542 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
545 * Add a new side data to a frame.
547 * @param frame a frame to which the side data should be added
548 * @param type type of the added side data
549 * @param size size of the side data
551 * @return newly added side data on success, NULL on error
553 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
554 enum AVFrameSideDataType type,
558 * @return a pointer to the side data of a given type on success, NULL if there
559 * is no side data with such type in this frame.
561 AVFrameSideData *av_frame_get_side_data(AVFrame *frame,
562 enum AVFrameSideDataType type);
564 #endif /* AVUTIL_FRAME_H */