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 * This side data must be associated with an audio frame and corresponds to
93 * enum AVAudioServiceType defined in avcodec.h.
95 AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
98 enum AVActiveFormatDescription {
103 AV_AFD_4_3_SP_14_9 = 13,
104 AV_AFD_16_9_SP_14_9 = 14,
108 typedef struct AVFrameSideData {
109 enum AVFrameSideDataType type;
112 AVDictionary *metadata;
116 * This structure describes decoded (raw) audio or video data.
118 * AVFrame must be allocated using av_frame_alloc(). Note that this only
119 * allocates the AVFrame itself, the buffers for the data must be managed
120 * through other means (see below).
121 * AVFrame must be freed with av_frame_free().
123 * AVFrame is typically allocated once and then reused multiple times to hold
124 * different data (e.g. a single AVFrame to hold frames received from a
125 * decoder). In such a case, av_frame_unref() will free any references held by
126 * the frame and reset it to its original clean state before it
129 * The data described by an AVFrame is usually reference counted through the
130 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
131 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
132 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
133 * every single data plane must be contained in one of the buffers in
134 * AVFrame.buf or AVFrame.extended_buf.
135 * There may be a single buffer for all the data, or one separate buffer for
136 * each plane, or anything in between.
138 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
139 * to the end with a minor bump.
141 typedef struct AVFrame {
142 #define AV_NUM_DATA_POINTERS 8
144 * pointer to the picture/channel planes.
145 * This might be different from the first allocated byte
147 uint8_t *data[AV_NUM_DATA_POINTERS];
150 * For video, size in bytes of each picture line.
151 * For audio, size in bytes of each plane.
153 * For audio, only linesize[0] may be set. For planar audio, each channel
154 * plane must be the same size.
156 * @note The linesize may be larger than the size of usable data -- there
157 * may be extra padding present for performance reasons.
159 int linesize[AV_NUM_DATA_POINTERS];
162 * pointers to the data planes/channels.
164 * For video, this should simply point to data[].
166 * For planar audio, each channel has a separate data pointer, and
167 * linesize[0] contains the size of each channel buffer.
168 * For packed audio, there is just one data pointer, and linesize[0]
169 * contains the total size of the buffer for all channels.
171 * Note: Both data and extended_data should always be set in a valid frame,
172 * but for planar audio with more channels that can fit in data,
173 * extended_data must be used in order to access all channels.
175 uint8_t **extended_data;
178 * width and height of the video frame
183 * number of audio samples (per channel) described by this frame
188 * format of the frame, -1 if unknown or unset
189 * Values correspond to enum AVPixelFormat for video frames,
190 * enum AVSampleFormat for audio)
195 * 1 -> keyframe, 0-> not
200 * Picture type of the frame.
202 enum AVPictureType pict_type;
204 #if FF_API_AVFRAME_LAVC
206 uint8_t *base[AV_NUM_DATA_POINTERS];
210 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
212 AVRational sample_aspect_ratio;
215 * Presentation timestamp in time_base units (time when frame should be shown to user).
220 * PTS copied from the AVPacket that was decoded to produce this frame.
225 * DTS copied from the AVPacket that triggered returning this frame.
230 * picture number in bitstream order
232 int coded_picture_number;
234 * picture number in display order
236 int display_picture_number;
239 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
243 #if FF_API_AVFRAME_LAVC
251 int8_t *qscale_table;
262 * mbskip_table[mb]>=1 if MB didn't change
263 * stride= mb_width = (width+15)>>4
266 uint8_t *mbskip_table;
269 * motion vector table
272 * int mv_sample_log2= 4 - motion_subsample_log2;
273 * int mb_width= (width+15)>>4;
274 * int mv_stride= (mb_width << mv_sample_log2) + 1;
275 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
279 int16_t (*motion_val[2])[2];
282 * macroblock type table
283 * mb_type_base + mb_width + 2
295 * motion reference frame index
296 * the order in which these are stored can depend on the codec.
299 int8_t *ref_index[2];
303 * for some private data of the user
310 uint64_t error[AV_NUM_DATA_POINTERS];
312 #if FF_API_AVFRAME_LAVC
318 * When decoding, this signals how much the picture must be delayed.
319 * extra_delay = repeat_pict / (2*fps)
324 * The content of the picture is interlaced.
326 int interlaced_frame;
329 * If the content is interlaced, is top field displayed first.
334 * Tell user application that palette has changed from previous frame.
336 int palette_has_changed;
338 #if FF_API_AVFRAME_LAVC
346 struct AVPanScan *pan_scan;
350 * reordered opaque 64bit (generally an integer or a double precision float
351 * PTS but can be anything).
352 * The user sets AVCodecContext.reordered_opaque to represent the input at
354 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
355 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
356 * @deprecated in favor of pkt_pts
358 int64_t reordered_opaque;
360 #if FF_API_AVFRAME_LAVC
362 * @deprecated this field is unused
364 attribute_deprecated void *hwaccel_picture_private;
367 struct AVCodecContext *owner;
372 * log2 of the size of the block which a single vector in motion_val represents:
373 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
376 uint8_t motion_subsample_log2;
380 * Sample rate of the audio data.
385 * Channel layout of the audio data.
387 uint64_t channel_layout;
390 * AVBuffer references backing the data for this frame. If all elements of
391 * this array are NULL, then this frame is not reference counted.
393 * There may be at most one AVBuffer per data plane, so for video this array
394 * always contains all the references. For planar audio with more than
395 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
396 * this array. Then the extra AVBufferRef pointers are stored in the
397 * extended_buf array.
399 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
402 * For planar audio which requires more than AV_NUM_DATA_POINTERS
403 * AVBufferRef pointers, this array will hold all the references which
404 * cannot fit into AVFrame.buf.
406 * Note that this is different from AVFrame.extended_data, which always
407 * contains all the pointers. This array only contains the extra pointers,
408 * which cannot fit into AVFrame.buf.
410 * This array is always allocated using av_malloc() by whoever constructs
411 * the frame. It is freed in av_frame_unref().
413 AVBufferRef **extended_buf;
415 * Number of elements in extended_buf.
419 AVFrameSideData **side_data;
423 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
424 * Flags describing additional frame properties.
430 * The frame data may be corrupted, e.g. due to decoding errors.
432 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
438 * Frame flags, a combination of @ref lavu_frame_flags
442 enum AVColorRange color_range;
444 enum AVColorPrimaries color_primaries;
446 enum AVColorTransferCharacteristic color_trc;
448 enum AVColorSpace colorspace;
450 enum AVChromaLocation chroma_location;
454 * Allocate an AVFrame and set its fields to default values. The resulting
455 * struct must be freed using av_frame_free().
457 * @return An AVFrame filled with default values or NULL on failure.
459 * @note this only allocates the AVFrame itself, not the data buffers. Those
460 * must be allocated through other means, e.g. with av_frame_get_buffer() or
463 AVFrame *av_frame_alloc(void);
466 * Free the frame and any dynamically allocated objects in it,
467 * e.g. extended_data. If the frame is reference counted, it will be
468 * unreferenced first.
470 * @param frame frame to be freed. The pointer will be set to NULL.
472 void av_frame_free(AVFrame **frame);
475 * Set up a new reference to the data described by the source frame.
477 * Copy frame properties from src to dst and create a new reference for each
478 * AVBufferRef from src.
480 * If src is not reference counted, new buffers are allocated and the data is
483 * @return 0 on success, a negative AVERROR on error
485 int av_frame_ref(AVFrame *dst, const AVFrame *src);
488 * Create a new frame that references the same data as src.
490 * This is a shortcut for av_frame_alloc()+av_frame_ref().
492 * @return newly created AVFrame on success, NULL on error.
494 AVFrame *av_frame_clone(const AVFrame *src);
497 * Unreference all the buffers referenced by frame and reset the frame fields.
499 void av_frame_unref(AVFrame *frame);
502 * Move everythnig contained in src to dst and reset src.
504 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
507 * Allocate new buffer(s) for audio or video data.
509 * The following fields must be set on frame before calling this function:
510 * - format (pixel format for video, sample format for audio)
511 * - width and height for video
512 * - nb_samples and channel_layout for audio
514 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
515 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
516 * For planar formats, one buffer will be allocated for each plane.
518 * @param frame frame in which to store the new buffers.
519 * @param align required buffer size alignment
521 * @return 0 on success, a negative AVERROR on error.
523 int av_frame_get_buffer(AVFrame *frame, int align);
526 * Check if the frame data is writable.
528 * @return A positive value if the frame data is writable (which is true if and
529 * only if each of the underlying buffers has only one reference, namely the one
530 * stored in this frame). Return 0 otherwise.
532 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
533 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
535 * @see av_frame_make_writable(), av_buffer_is_writable()
537 int av_frame_is_writable(AVFrame *frame);
540 * Ensure that the frame data is writable, avoiding data copy if possible.
542 * Do nothing if the frame is writable, allocate new buffers and copy the data
545 * @return 0 on success, a negative AVERROR on error.
547 * @see av_frame_is_writable(), av_buffer_is_writable(),
548 * av_buffer_make_writable()
550 int av_frame_make_writable(AVFrame *frame);
553 * Copy the frame data from src to dst.
555 * This function does not allocate anything, dst must be already initialized and
556 * allocated with the same parameters as src.
558 * This function only copies the frame data (i.e. the contents of the data /
559 * extended data arrays), not any other properties.
561 * @return >= 0 on success, a negative AVERROR on error.
563 int av_frame_copy(AVFrame *dst, const AVFrame *src);
566 * Copy only "metadata" fields from src to dst.
568 * Metadata for the purpose of this function are those fields that do not affect
569 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
570 * aspect ratio (for video), but not width/height or channel layout.
571 * Side data is also copied.
573 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
576 * Get the buffer reference a given data plane is stored in.
578 * @param plane index of the data plane of interest in frame->extended_data.
580 * @return the buffer reference that contains the plane or NULL if the input
581 * frame is not valid.
583 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
586 * Add a new side data to a frame.
588 * @param frame a frame to which the side data should be added
589 * @param type type of the added side data
590 * @param size size of the side data
592 * @return newly added side data on success, NULL on error
594 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
595 enum AVFrameSideDataType type,
599 * @return a pointer to the side data of a given type on success, NULL if there
600 * is no side data with such type in this frame.
602 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
603 enum AVFrameSideDataType type);
606 * If side data of the supplied type exists in the frame, free it and remove it
609 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
615 #endif /* AVUTIL_FRAME_H */