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
23 * reference-counted frame API
26 #ifndef AVUTIL_FRAME_H
27 #define AVUTIL_FRAME_H
35 #include "samplefmt.h"
40 * @defgroup lavu_frame AVFrame
44 * AVFrame is an abstraction for reference-counted raw multimedia data.
47 enum AVFrameSideDataType {
49 * The data is the AVPanScan struct defined in libavcodec.
51 AV_FRAME_DATA_PANSCAN,
53 * ATSC A53 Part 4 Closed Captions.
54 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
55 * The number of bytes of CC data is AVFrameSideData.size.
59 * Stereoscopic 3d metadata.
60 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
62 AV_FRAME_DATA_STEREO3D,
64 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
66 AV_FRAME_DATA_MATRIXENCODING,
68 * Metadata relevant to a downmix procedure.
69 * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
71 AV_FRAME_DATA_DOWNMIX_INFO,
73 * ReplayGain information in the form of the AVReplayGain struct.
75 AV_FRAME_DATA_REPLAYGAIN,
77 * This side data contains a 3x3 transformation matrix describing an affine
78 * transformation that needs to be applied to the frame for correct
81 * See libavutil/display.h for a detailed description of the data.
83 AV_FRAME_DATA_DISPLAYMATRIX,
86 typedef struct AVFrameSideData {
87 enum AVFrameSideDataType type;
90 AVDictionary *metadata;
94 * This structure describes decoded (raw) audio or video data.
96 * AVFrame must be allocated using av_frame_alloc(). Note that this only
97 * allocates the AVFrame itself, the buffers for the data must be managed
98 * through other means (see below).
99 * AVFrame must be freed with av_frame_free().
101 * AVFrame is typically allocated once and then reused multiple times to hold
102 * different data (e.g. a single AVFrame to hold frames received from a
103 * decoder). In such a case, av_frame_unref() will free any references held by
104 * the frame and reset it to its original clean state before it
107 * The data described by an AVFrame is usually reference counted through the
108 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
109 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
110 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
111 * every single data plane must be contained in one of the buffers in
112 * AVFrame.buf or AVFrame.extended_buf.
113 * There may be a single buffer for all the data, or one separate buffer for
114 * each plane, or anything in between.
116 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
117 * to the end with a minor bump.
119 typedef struct AVFrame {
120 #define AV_NUM_DATA_POINTERS 8
122 * pointer to the picture/channel planes.
123 * This might be different from the first allocated byte
125 uint8_t *data[AV_NUM_DATA_POINTERS];
128 * For video, size in bytes of each picture line.
129 * For audio, size in bytes of each plane.
131 * For audio, only linesize[0] may be set. For planar audio, each channel
132 * plane must be the same size.
134 * @note The linesize may be larger than the size of usable data -- there
135 * may be extra padding present for performance reasons.
137 int linesize[AV_NUM_DATA_POINTERS];
140 * pointers to the data planes/channels.
142 * For video, this should simply point to data[].
144 * For planar audio, each channel has a separate data pointer, and
145 * linesize[0] contains the size of each channel buffer.
146 * For packed audio, there is just one data pointer, and linesize[0]
147 * contains the total size of the buffer for all channels.
149 * Note: Both data and extended_data should always be set in a valid frame,
150 * but for planar audio with more channels that can fit in data,
151 * extended_data must be used in order to access all channels.
153 uint8_t **extended_data;
156 * width and height of the video frame
161 * number of audio samples (per channel) described by this frame
166 * format of the frame, -1 if unknown or unset
167 * Values correspond to enum AVPixelFormat for video frames,
168 * enum AVSampleFormat for audio)
173 * 1 -> keyframe, 0-> not
178 * Picture type of the frame.
180 enum AVPictureType pict_type;
182 #if FF_API_AVFRAME_LAVC
184 uint8_t *base[AV_NUM_DATA_POINTERS];
188 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
190 AVRational sample_aspect_ratio;
193 * Presentation timestamp in time_base units (time when frame should be shown to user).
198 * PTS copied from the AVPacket that was decoded to produce this frame.
203 * DTS copied from the AVPacket that triggered returning this frame.
208 * picture number in bitstream order
210 int coded_picture_number;
212 * picture number in display order
214 int display_picture_number;
217 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
221 #if FF_API_AVFRAME_LAVC
229 int8_t *qscale_table;
240 * mbskip_table[mb]>=1 if MB didn't change
241 * stride= mb_width = (width+15)>>4
244 uint8_t *mbskip_table;
247 * motion vector table
250 * int mv_sample_log2= 4 - motion_subsample_log2;
251 * int mb_width= (width+15)>>4;
252 * int mv_stride= (mb_width << mv_sample_log2) + 1;
253 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
257 int16_t (*motion_val[2])[2];
260 * macroblock type table
261 * mb_type_base + mb_width + 2
273 * motion reference frame index
274 * the order in which these are stored can depend on the codec.
277 int8_t *ref_index[2];
281 * for some private data of the user
288 uint64_t error[AV_NUM_DATA_POINTERS];
290 #if FF_API_AVFRAME_LAVC
296 * When decoding, this signals how much the picture must be delayed.
297 * extra_delay = repeat_pict / (2*fps)
302 * The content of the picture is interlaced.
304 int interlaced_frame;
307 * If the content is interlaced, is top field displayed first.
312 * Tell user application that palette has changed from previous frame.
314 int palette_has_changed;
316 #if FF_API_AVFRAME_LAVC
324 struct AVPanScan *pan_scan;
328 * reordered opaque 64bit (generally an integer or a double precision float
329 * PTS but can be anything).
330 * The user sets AVCodecContext.reordered_opaque to represent the input at
332 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
333 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
334 * @deprecated in favor of pkt_pts
336 int64_t reordered_opaque;
338 #if FF_API_AVFRAME_LAVC
340 * @deprecated this field is unused
342 attribute_deprecated void *hwaccel_picture_private;
345 struct AVCodecContext *owner;
350 * log2 of the size of the block which a single vector in motion_val represents:
351 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
354 uint8_t motion_subsample_log2;
358 * Sample rate of the audio data.
363 * Channel layout of the audio data.
365 uint64_t channel_layout;
368 * AVBuffer references backing the data for this frame. If all elements of
369 * this array are NULL, then this frame is not reference counted.
371 * There may be at most one AVBuffer per data plane, so for video this array
372 * always contains all the references. For planar audio with more than
373 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
374 * this array. Then the extra AVBufferRef pointers are stored in the
375 * extended_buf array.
377 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
380 * For planar audio which requires more than AV_NUM_DATA_POINTERS
381 * AVBufferRef pointers, this array will hold all the references which
382 * cannot fit into AVFrame.buf.
384 * Note that this is different from AVFrame.extended_data, which always
385 * contains all the pointers. This array only contains the extra pointers,
386 * which cannot fit into AVFrame.buf.
388 * This array is always allocated using av_malloc() by whoever constructs
389 * the frame. It is freed in av_frame_unref().
391 AVBufferRef **extended_buf;
393 * Number of elements in extended_buf.
397 AVFrameSideData **side_data;
401 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
402 * Flags describing additional frame properties.
408 * The frame data may be corrupted, e.g. due to decoding errors.
410 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
416 * Frame flags, a combination of @ref lavu_frame_flags
422 * Allocate an AVFrame and set its fields to default values. The resulting
423 * struct must be freed using av_frame_free().
425 * @return An AVFrame filled with default values or NULL on failure.
427 * @note this only allocates the AVFrame itself, not the data buffers. Those
428 * must be allocated through other means, e.g. with av_frame_get_buffer() or
431 AVFrame *av_frame_alloc(void);
434 * Free the frame and any dynamically allocated objects in it,
435 * e.g. extended_data. If the frame is reference counted, it will be
436 * unreferenced first.
438 * @param frame frame to be freed. The pointer will be set to NULL.
440 void av_frame_free(AVFrame **frame);
443 * Set up a new reference to the data described by the source frame.
445 * Copy frame properties from src to dst and create a new reference for each
446 * AVBufferRef from src.
448 * If src is not reference counted, new buffers are allocated and the data is
451 * @return 0 on success, a negative AVERROR on error
453 int av_frame_ref(AVFrame *dst, const AVFrame *src);
456 * Create a new frame that references the same data as src.
458 * This is a shortcut for av_frame_alloc()+av_frame_ref().
460 * @return newly created AVFrame on success, NULL on error.
462 AVFrame *av_frame_clone(const AVFrame *src);
465 * Unreference all the buffers referenced by frame and reset the frame fields.
467 void av_frame_unref(AVFrame *frame);
470 * Move everythnig contained in src to dst and reset src.
472 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
475 * Allocate new buffer(s) for audio or video data.
477 * The following fields must be set on frame before calling this function:
478 * - format (pixel format for video, sample format for audio)
479 * - width and height for video
480 * - nb_samples and channel_layout for audio
482 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
483 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
484 * For planar formats, one buffer will be allocated for each plane.
486 * @param frame frame in which to store the new buffers.
487 * @param align required buffer size alignment
489 * @return 0 on success, a negative AVERROR on error.
491 int av_frame_get_buffer(AVFrame *frame, int align);
494 * Check if the frame data is writable.
496 * @return A positive value if the frame data is writable (which is true if and
497 * only if each of the underlying buffers has only one reference, namely the one
498 * stored in this frame). Return 0 otherwise.
500 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
501 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
503 * @see av_frame_make_writable(), av_buffer_is_writable()
505 int av_frame_is_writable(AVFrame *frame);
508 * Ensure that the frame data is writable, avoiding data copy if possible.
510 * Do nothing if the frame is writable, allocate new buffers and copy the data
513 * @return 0 on success, a negative AVERROR on error.
515 * @see av_frame_is_writable(), av_buffer_is_writable(),
516 * av_buffer_make_writable()
518 int av_frame_make_writable(AVFrame *frame);
521 * Copy the frame data from src to dst.
523 * This function does not allocate anything, dst must be already initialized and
524 * allocated with the same parameters as src.
526 * This function only copies the frame data (i.e. the contents of the data /
527 * extended data arrays), not any other properties.
529 * @return >= 0 on success, a negative AVERROR on error.
531 int av_frame_copy(AVFrame *dst, const AVFrame *src);
534 * Copy only "metadata" fields from src to dst.
536 * Metadata for the purpose of this function are those fields that do not affect
537 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
538 * aspect ratio (for video), but not width/height or channel layout.
539 * Side data is also copied.
541 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
544 * Get the buffer reference a given data plane is stored in.
546 * @param plane index of the data plane of interest in frame->extended_data.
548 * @return the buffer reference that contains the plane or NULL if the input
549 * frame is not valid.
551 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
554 * Add a new side data to a frame.
556 * @param frame a frame to which the side data should be added
557 * @param type type of the added side data
558 * @param size size of the side data
560 * @return newly added side data on success, NULL on error
562 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
563 enum AVFrameSideDataType type,
567 * @return a pointer to the side data of a given type on success, NULL if there
568 * is no side data with such type in this frame.
570 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
571 enum AVFrameSideDataType type);
574 * If side data of the supplied type exists in the frame, free it and remove it
577 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
583 #endif /* AVUTIL_FRAME_H */