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"
41 * @defgroup lavu_frame AVFrame
45 * AVFrame is an abstraction for reference-counted raw multimedia data.
48 enum AVFrameSideDataType {
50 * The data is the AVPanScan struct defined in libavcodec.
52 AV_FRAME_DATA_PANSCAN,
54 * ATSC A53 Part 4 Closed Captions.
55 * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
56 * The number of bytes of CC data is AVFrameSideData.size.
60 * Stereoscopic 3d metadata.
61 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
63 AV_FRAME_DATA_STEREO3D,
65 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
67 AV_FRAME_DATA_MATRIXENCODING,
69 * Metadata relevant to a downmix procedure.
70 * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
72 AV_FRAME_DATA_DOWNMIX_INFO,
74 * ReplayGain information in the form of the AVReplayGain struct.
76 AV_FRAME_DATA_REPLAYGAIN,
78 * This side data contains a 3x3 transformation matrix describing an affine
79 * transformation that needs to be applied to the frame for correct
82 * See libavutil/display.h for a detailed description of the data.
84 AV_FRAME_DATA_DISPLAYMATRIX,
86 * Active Format Description data consisting of a single byte as specified
87 * in ETSI TS 101 154 using enum AVActiveFormatDescription.
92 enum AVActiveFormatDescription {
97 AV_AFD_4_3_SP_14_9 = 13,
98 AV_AFD_16_9_SP_14_9 = 14,
102 typedef struct AVFrameSideData {
103 enum AVFrameSideDataType type;
106 AVDictionary *metadata;
110 * This structure describes decoded (raw) audio or video data.
112 * AVFrame must be allocated using av_frame_alloc(). Note that this only
113 * allocates the AVFrame itself, the buffers for the data must be managed
114 * through other means (see below).
115 * AVFrame must be freed with av_frame_free().
117 * AVFrame is typically allocated once and then reused multiple times to hold
118 * different data (e.g. a single AVFrame to hold frames received from a
119 * decoder). In such a case, av_frame_unref() will free any references held by
120 * the frame and reset it to its original clean state before it
123 * The data described by an AVFrame is usually reference counted through the
124 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
125 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
126 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
127 * every single data plane must be contained in one of the buffers in
128 * AVFrame.buf or AVFrame.extended_buf.
129 * There may be a single buffer for all the data, or one separate buffer for
130 * each plane, or anything in between.
132 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
133 * to the end with a minor bump.
135 typedef struct AVFrame {
136 #define AV_NUM_DATA_POINTERS 8
138 * pointer to the picture/channel planes.
139 * This might be different from the first allocated byte
141 uint8_t *data[AV_NUM_DATA_POINTERS];
144 * For video, size in bytes of each picture line.
145 * For audio, size in bytes of each plane.
147 * For audio, only linesize[0] may be set. For planar audio, each channel
148 * plane must be the same size.
150 * @note The linesize may be larger than the size of usable data -- there
151 * may be extra padding present for performance reasons.
153 int linesize[AV_NUM_DATA_POINTERS];
156 * pointers to the data planes/channels.
158 * For video, this should simply point to data[].
160 * For planar audio, each channel has a separate data pointer, and
161 * linesize[0] contains the size of each channel buffer.
162 * For packed audio, there is just one data pointer, and linesize[0]
163 * contains the total size of the buffer for all channels.
165 * Note: Both data and extended_data should always be set in a valid frame,
166 * but for planar audio with more channels that can fit in data,
167 * extended_data must be used in order to access all channels.
169 uint8_t **extended_data;
172 * width and height of the video frame
177 * number of audio samples (per channel) described by this frame
182 * format of the frame, -1 if unknown or unset
183 * Values correspond to enum AVPixelFormat for video frames,
184 * enum AVSampleFormat for audio)
189 * 1 -> keyframe, 0-> not
194 * Picture type of the frame.
196 enum AVPictureType pict_type;
198 #if FF_API_AVFRAME_LAVC
200 uint8_t *base[AV_NUM_DATA_POINTERS];
204 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
206 AVRational sample_aspect_ratio;
209 * Presentation timestamp in time_base units (time when frame should be shown to user).
214 * PTS copied from the AVPacket that was decoded to produce this frame.
219 * DTS copied from the AVPacket that triggered returning this frame.
224 * picture number in bitstream order
226 int coded_picture_number;
228 * picture number in display order
230 int display_picture_number;
233 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
237 #if FF_API_AVFRAME_LAVC
245 int8_t *qscale_table;
256 * mbskip_table[mb]>=1 if MB didn't change
257 * stride= mb_width = (width+15)>>4
260 uint8_t *mbskip_table;
263 * motion vector table
266 * int mv_sample_log2= 4 - motion_subsample_log2;
267 * int mb_width= (width+15)>>4;
268 * int mv_stride= (mb_width << mv_sample_log2) + 1;
269 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
273 int16_t (*motion_val[2])[2];
276 * macroblock type table
277 * mb_type_base + mb_width + 2
289 * motion reference frame index
290 * the order in which these are stored can depend on the codec.
293 int8_t *ref_index[2];
297 * for some private data of the user
304 uint64_t error[AV_NUM_DATA_POINTERS];
306 #if FF_API_AVFRAME_LAVC
312 * When decoding, this signals how much the picture must be delayed.
313 * extra_delay = repeat_pict / (2*fps)
318 * The content of the picture is interlaced.
320 int interlaced_frame;
323 * If the content is interlaced, is top field displayed first.
328 * Tell user application that palette has changed from previous frame.
330 int palette_has_changed;
332 #if FF_API_AVFRAME_LAVC
340 struct AVPanScan *pan_scan;
344 * reordered opaque 64bit (generally an integer or a double precision float
345 * PTS but can be anything).
346 * The user sets AVCodecContext.reordered_opaque to represent the input at
348 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
349 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
350 * @deprecated in favor of pkt_pts
352 int64_t reordered_opaque;
354 #if FF_API_AVFRAME_LAVC
356 * @deprecated this field is unused
358 attribute_deprecated void *hwaccel_picture_private;
361 struct AVCodecContext *owner;
366 * log2 of the size of the block which a single vector in motion_val represents:
367 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
370 uint8_t motion_subsample_log2;
374 * Sample rate of the audio data.
379 * Channel layout of the audio data.
381 uint64_t channel_layout;
384 * AVBuffer references backing the data for this frame. If all elements of
385 * this array are NULL, then this frame is not reference counted.
387 * There may be at most one AVBuffer per data plane, so for video this array
388 * always contains all the references. For planar audio with more than
389 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
390 * this array. Then the extra AVBufferRef pointers are stored in the
391 * extended_buf array.
393 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
396 * For planar audio which requires more than AV_NUM_DATA_POINTERS
397 * AVBufferRef pointers, this array will hold all the references which
398 * cannot fit into AVFrame.buf.
400 * Note that this is different from AVFrame.extended_data, which always
401 * contains all the pointers. This array only contains the extra pointers,
402 * which cannot fit into AVFrame.buf.
404 * This array is always allocated using av_malloc() by whoever constructs
405 * the frame. It is freed in av_frame_unref().
407 AVBufferRef **extended_buf;
409 * Number of elements in extended_buf.
413 AVFrameSideData **side_data;
417 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
418 * Flags describing additional frame properties.
424 * The frame data may be corrupted, e.g. due to decoding errors.
426 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
432 * Frame flags, a combination of @ref lavu_frame_flags
436 #if FF_API_AVFRAME_COLORSPACE
437 enum AVColorRange color_range;
439 enum AVColorPrimaries color_primaries;
441 enum AVColorTransferCharacteristic color_trc;
443 enum AVColorSpace colorspace;
445 enum AVChromaLocation chroma_location;
450 * Allocate an AVFrame and set its fields to default values. The resulting
451 * struct must be freed using av_frame_free().
453 * @return An AVFrame filled with default values or NULL on failure.
455 * @note this only allocates the AVFrame itself, not the data buffers. Those
456 * must be allocated through other means, e.g. with av_frame_get_buffer() or
459 AVFrame *av_frame_alloc(void);
462 * Free the frame and any dynamically allocated objects in it,
463 * e.g. extended_data. If the frame is reference counted, it will be
464 * unreferenced first.
466 * @param frame frame to be freed. The pointer will be set to NULL.
468 void av_frame_free(AVFrame **frame);
471 * Set up a new reference to the data described by the source frame.
473 * Copy frame properties from src to dst and create a new reference for each
474 * AVBufferRef from src.
476 * If src is not reference counted, new buffers are allocated and the data is
479 * @return 0 on success, a negative AVERROR on error
481 int av_frame_ref(AVFrame *dst, const AVFrame *src);
484 * Create a new frame that references the same data as src.
486 * This is a shortcut for av_frame_alloc()+av_frame_ref().
488 * @return newly created AVFrame on success, NULL on error.
490 AVFrame *av_frame_clone(const AVFrame *src);
493 * Unreference all the buffers referenced by frame and reset the frame fields.
495 void av_frame_unref(AVFrame *frame);
498 * Move everythnig contained in src to dst and reset src.
500 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
503 * Allocate new buffer(s) for audio or video data.
505 * The following fields must be set on frame before calling this function:
506 * - format (pixel format for video, sample format for audio)
507 * - width and height for video
508 * - nb_samples and channel_layout for audio
510 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
511 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
512 * For planar formats, one buffer will be allocated for each plane.
514 * @param frame frame in which to store the new buffers.
515 * @param align required buffer size alignment
517 * @return 0 on success, a negative AVERROR on error.
519 int av_frame_get_buffer(AVFrame *frame, int align);
522 * Check if the frame data is writable.
524 * @return A positive value if the frame data is writable (which is true if and
525 * only if each of the underlying buffers has only one reference, namely the one
526 * stored in this frame). Return 0 otherwise.
528 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
529 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
531 * @see av_frame_make_writable(), av_buffer_is_writable()
533 int av_frame_is_writable(AVFrame *frame);
536 * Ensure that the frame data is writable, avoiding data copy if possible.
538 * Do nothing if the frame is writable, allocate new buffers and copy the data
541 * @return 0 on success, a negative AVERROR on error.
543 * @see av_frame_is_writable(), av_buffer_is_writable(),
544 * av_buffer_make_writable()
546 int av_frame_make_writable(AVFrame *frame);
549 * Copy the frame data from src to dst.
551 * This function does not allocate anything, dst must be already initialized and
552 * allocated with the same parameters as src.
554 * This function only copies the frame data (i.e. the contents of the data /
555 * extended data arrays), not any other properties.
557 * @return >= 0 on success, a negative AVERROR on error.
559 int av_frame_copy(AVFrame *dst, const AVFrame *src);
562 * Copy only "metadata" fields from src to dst.
564 * Metadata for the purpose of this function are those fields that do not affect
565 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
566 * aspect ratio (for video), but not width/height or channel layout.
567 * Side data is also copied.
569 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
572 * Get the buffer reference a given data plane is stored in.
574 * @param plane index of the data plane of interest in frame->extended_data.
576 * @return the buffer reference that contains the plane or NULL if the input
577 * frame is not valid.
579 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
582 * Add a new side data to a frame.
584 * @param frame a frame to which the side data should be added
585 * @param type type of the added side data
586 * @param size size of the side data
588 * @return newly added side data on success, NULL on error
590 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
591 enum AVFrameSideDataType type,
595 * @return a pointer to the side data of a given type on success, NULL if there
596 * is no side data with such type in this frame.
598 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
599 enum AVFrameSideDataType type);
602 * If side data of the supplied type exists in the frame, free it and remove it
605 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
611 #endif /* AVUTIL_FRAME_H */