2 * This file is part of Libav.
4 * Libav is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * Libav is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with Libav; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 * reference-counted frame API
25 #ifndef AVUTIL_FRAME_H
26 #define AVUTIL_FRAME_H
34 #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,
85 * Active Format Description data consisting of a single byte as specified
86 * in ETSI TS 101 154 using enum AVActiveFormatDescription.
91 * This side data must be associated with an audio frame and corresponds to
92 * enum AVAudioServiceType defined in avcodec.h.
94 AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
97 enum AVActiveFormatDescription {
102 AV_AFD_4_3_SP_14_9 = 13,
103 AV_AFD_16_9_SP_14_9 = 14,
107 typedef struct AVFrameSideData {
108 enum AVFrameSideDataType type;
111 AVDictionary *metadata;
115 * This structure describes decoded (raw) audio or video data.
117 * AVFrame must be allocated using av_frame_alloc(). Note that this only
118 * allocates the AVFrame itself, the buffers for the data must be managed
119 * through other means (see below).
120 * AVFrame must be freed with av_frame_free().
122 * AVFrame is typically allocated once and then reused multiple times to hold
123 * different data (e.g. a single AVFrame to hold frames received from a
124 * decoder). In such a case, av_frame_unref() will free any references held by
125 * the frame and reset it to its original clean state before it
128 * The data described by an AVFrame is usually reference counted through the
129 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
130 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
131 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
132 * every single data plane must be contained in one of the buffers in
133 * AVFrame.buf or AVFrame.extended_buf.
134 * There may be a single buffer for all the data, or one separate buffer for
135 * each plane, or anything in between.
137 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
138 * to the end with a minor bump.
140 typedef struct AVFrame {
141 #define AV_NUM_DATA_POINTERS 8
143 * pointer to the picture/channel planes.
144 * This might be different from the first allocated byte
146 uint8_t *data[AV_NUM_DATA_POINTERS];
149 * For video, size in bytes of each picture line.
150 * For audio, size in bytes of each plane.
152 * For audio, only linesize[0] may be set. For planar audio, each channel
153 * plane must be the same size.
155 * @note The linesize may be larger than the size of usable data -- there
156 * may be extra padding present for performance reasons.
158 int linesize[AV_NUM_DATA_POINTERS];
161 * pointers to the data planes/channels.
163 * For video, this should simply point to data[].
165 * For planar audio, each channel has a separate data pointer, and
166 * linesize[0] contains the size of each channel buffer.
167 * For packed audio, there is just one data pointer, and linesize[0]
168 * contains the total size of the buffer for all channels.
170 * Note: Both data and extended_data should always be set in a valid frame,
171 * but for planar audio with more channels that can fit in data,
172 * extended_data must be used in order to access all channels.
174 uint8_t **extended_data;
177 * width and height of the video frame
182 * number of audio samples (per channel) described by this frame
187 * format of the frame, -1 if unknown or unset
188 * Values correspond to enum AVPixelFormat for video frames,
189 * enum AVSampleFormat for audio)
194 * 1 -> keyframe, 0-> not
199 * Picture type of the frame.
201 enum AVPictureType pict_type;
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))
238 * for some private data of the user
242 #if FF_API_ERROR_FRAME
247 uint64_t error[AV_NUM_DATA_POINTERS];
251 * When decoding, this signals how much the picture must be delayed.
252 * extra_delay = repeat_pict / (2*fps)
257 * The content of the picture is interlaced.
259 int interlaced_frame;
262 * If the content is interlaced, is top field displayed first.
267 * Tell user application that palette has changed from previous frame.
269 int palette_has_changed;
272 * reordered opaque 64bit (generally an integer or a double precision float
273 * PTS but can be anything).
274 * The user sets AVCodecContext.reordered_opaque to represent the input at
276 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
277 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
278 * @deprecated in favor of pkt_pts
280 int64_t reordered_opaque;
283 * Sample rate of the audio data.
288 * Channel layout of the audio data.
290 uint64_t channel_layout;
293 * AVBuffer references backing the data for this frame. If all elements of
294 * this array are NULL, then this frame is not reference counted. This array
295 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
296 * also be non-NULL for all j < i.
298 * There may be at most one AVBuffer per data plane, so for video this array
299 * always contains all the references. For planar audio with more than
300 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
301 * this array. Then the extra AVBufferRef pointers are stored in the
302 * extended_buf array.
304 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
307 * For planar audio which requires more than AV_NUM_DATA_POINTERS
308 * AVBufferRef pointers, this array will hold all the references which
309 * cannot fit into AVFrame.buf.
311 * Note that this is different from AVFrame.extended_data, which always
312 * contains all the pointers. This array only contains the extra pointers,
313 * which cannot fit into AVFrame.buf.
315 * This array is always allocated using av_malloc() by whoever constructs
316 * the frame. It is freed in av_frame_unref().
318 AVBufferRef **extended_buf;
320 * Number of elements in extended_buf.
324 AVFrameSideData **side_data;
328 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
329 * Flags describing additional frame properties.
335 * The frame data may be corrupted, e.g. due to decoding errors.
337 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
343 * Frame flags, a combination of @ref lavu_frame_flags
347 enum AVColorRange color_range;
349 enum AVColorPrimaries color_primaries;
351 enum AVColorTransferCharacteristic color_trc;
353 enum AVColorSpace colorspace;
355 enum AVChromaLocation chroma_location;
358 * For hwaccel-format frames, this should be a reference to the
359 * AVHWFramesContext describing the frame.
361 AVBufferRef *hw_frames_ctx;
365 * Allocate an AVFrame and set its fields to default values. The resulting
366 * struct must be freed using av_frame_free().
368 * @return An AVFrame filled with default values or NULL on failure.
370 * @note this only allocates the AVFrame itself, not the data buffers. Those
371 * must be allocated through other means, e.g. with av_frame_get_buffer() or
374 AVFrame *av_frame_alloc(void);
377 * Free the frame and any dynamically allocated objects in it,
378 * e.g. extended_data. If the frame is reference counted, it will be
379 * unreferenced first.
381 * @param frame frame to be freed. The pointer will be set to NULL.
383 void av_frame_free(AVFrame **frame);
386 * Set up a new reference to the data described by the source frame.
388 * Copy frame properties from src to dst and create a new reference for each
389 * AVBufferRef from src.
391 * If src is not reference counted, new buffers are allocated and the data is
394 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
395 * or newly allocated with av_frame_alloc() before calling this
396 * function, or undefined behavior will occur.
398 * @return 0 on success, a negative AVERROR on error
400 int av_frame_ref(AVFrame *dst, const AVFrame *src);
403 * Create a new frame that references the same data as src.
405 * This is a shortcut for av_frame_alloc()+av_frame_ref().
407 * @return newly created AVFrame on success, NULL on error.
409 AVFrame *av_frame_clone(const AVFrame *src);
412 * Unreference all the buffers referenced by frame and reset the frame fields.
414 void av_frame_unref(AVFrame *frame);
417 * Move everything contained in src to dst and reset src.
419 * @warning: dst is not unreferenced, but directly overwritten without reading
420 * or deallocating its contents. Call av_frame_unref(dst) manually
421 * before calling this function to ensure that no memory is leaked.
423 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
426 * Allocate new buffer(s) for audio or video data.
428 * The following fields must be set on frame before calling this function:
429 * - format (pixel format for video, sample format for audio)
430 * - width and height for video
431 * - nb_samples and channel_layout for audio
433 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
434 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
435 * For planar formats, one buffer will be allocated for each plane.
437 * @warning: if frame already has been allocated, calling this function will
438 * leak memory. In addition, undefined behavior can occur in certain
441 * @param frame frame in which to store the new buffers.
442 * @param align required buffer size alignment
444 * @return 0 on success, a negative AVERROR on error.
446 int av_frame_get_buffer(AVFrame *frame, int align);
449 * Check if the frame data is writable.
451 * @return A positive value if the frame data is writable (which is true if and
452 * only if each of the underlying buffers has only one reference, namely the one
453 * stored in this frame). Return 0 otherwise.
455 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
456 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
458 * @see av_frame_make_writable(), av_buffer_is_writable()
460 int av_frame_is_writable(AVFrame *frame);
463 * Ensure that the frame data is writable, avoiding data copy if possible.
465 * Do nothing if the frame is writable, allocate new buffers and copy the data
468 * @return 0 on success, a negative AVERROR on error.
470 * @see av_frame_is_writable(), av_buffer_is_writable(),
471 * av_buffer_make_writable()
473 int av_frame_make_writable(AVFrame *frame);
476 * Copy the frame data from src to dst.
478 * This function does not allocate anything, dst must be already initialized and
479 * allocated with the same parameters as src.
481 * This function only copies the frame data (i.e. the contents of the data /
482 * extended data arrays), not any other properties.
484 * @return >= 0 on success, a negative AVERROR on error.
486 int av_frame_copy(AVFrame *dst, const AVFrame *src);
489 * Copy only "metadata" fields from src to dst.
491 * Metadata for the purpose of this function are those fields that do not affect
492 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
493 * aspect ratio (for video), but not width/height or channel layout.
494 * Side data is also copied.
496 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
499 * Get the buffer reference a given data plane is stored in.
501 * @param plane index of the data plane of interest in frame->extended_data.
503 * @return the buffer reference that contains the plane or NULL if the input
504 * frame is not valid.
506 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
509 * Add a new side data to a frame.
511 * @param frame a frame to which the side data should be added
512 * @param type type of the added side data
513 * @param size size of the side data
515 * @return newly added side data on success, NULL on error
517 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
518 enum AVFrameSideDataType type,
522 * @return a pointer to the side data of a given type on success, NULL if there
523 * is no side data with such type in this frame.
525 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
526 enum AVFrameSideDataType type);
529 * If side data of the supplied type exists in the frame, free it and remove it
532 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
538 #endif /* AVUTIL_FRAME_H */