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
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 AVActiveFormatDescription enum.
91 * Motion vectors exported by some codecs (on demand through the export_mvs
92 * flag set in the libavcodec AVCodecContext flags2 option).
93 * The data is the AVMotionVector struct defined in
94 * libavutil/motion_vector.h.
96 AV_FRAME_DATA_MOTION_VECTORS,
98 * Recommmends skipping the specified number of samples. This is exported
99 * only if the "skip_manual" AVOption is set in libavcodec.
100 * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
102 * u32le number of samples to skip from start of this packet
103 * u32le number of samples to skip from end of this packet
104 * u8 reason for start skip
105 * u8 reason for end skip (0=padding silence, 1=convergence)
108 AV_FRAME_DATA_SKIP_SAMPLES,
110 * This side data must be associated with an audio frame and corresponds to
111 * enum AVAudioServiceType defined in avcodec.h.
113 AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
115 * Mastering display metadata associated with a video frame. The payload is
116 * an AVMasteringDisplayMetadata type and contains information about the
117 * mastering display color volume.
119 AV_FRAME_DATA_MASTERING_DISPLAY_METADATA,
121 * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
122 * This is set on the first frame of a GOP that has a temporal reference of 0.
124 AV_FRAME_DATA_GOP_TIMECODE
127 enum AVActiveFormatDescription {
132 AV_AFD_4_3_SP_14_9 = 13,
133 AV_AFD_16_9_SP_14_9 = 14,
139 * Structure to hold side data for an AVFrame.
141 * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
142 * to the end with a minor bump.
144 typedef struct AVFrameSideData {
145 enum AVFrameSideDataType type;
148 AVDictionary *metadata;
153 * This structure describes decoded (raw) audio or video data.
155 * AVFrame must be allocated using av_frame_alloc(). Note that this only
156 * allocates the AVFrame itself, the buffers for the data must be managed
157 * through other means (see below).
158 * AVFrame must be freed with av_frame_free().
160 * AVFrame is typically allocated once and then reused multiple times to hold
161 * different data (e.g. a single AVFrame to hold frames received from a
162 * decoder). In such a case, av_frame_unref() will free any references held by
163 * the frame and reset it to its original clean state before it
166 * The data described by an AVFrame is usually reference counted through the
167 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
168 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
169 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
170 * every single data plane must be contained in one of the buffers in
171 * AVFrame.buf or AVFrame.extended_buf.
172 * There may be a single buffer for all the data, or one separate buffer for
173 * each plane, or anything in between.
175 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
176 * to the end with a minor bump.
177 * Similarly fields that are marked as to be only accessed by
178 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
179 * without breaking compatibility with each other.
181 typedef struct AVFrame {
182 #define AV_NUM_DATA_POINTERS 8
184 * pointer to the picture/channel planes.
185 * This might be different from the first allocated byte
187 * Some decoders access areas outside 0,0 - width,height, please
188 * see avcodec_align_dimensions2(). Some filters and swscale can read
189 * up to 16 bytes beyond the planes, if these filters are to be used,
190 * then 16 extra bytes must be allocated.
192 uint8_t *data[AV_NUM_DATA_POINTERS];
195 * For video, size in bytes of each picture line.
196 * For audio, size in bytes of each plane.
198 * For audio, only linesize[0] may be set. For planar audio, each channel
199 * plane must be the same size.
201 * For video the linesizes should be multiples of the CPUs alignment
202 * preference, this is 16 or 32 for modern desktop CPUs.
203 * Some code requires such alignment other code can be slower without
204 * correct alignment, for yet other it makes no difference.
206 * @note The linesize may be larger than the size of usable data -- there
207 * may be extra padding present for performance reasons.
209 int linesize[AV_NUM_DATA_POINTERS];
212 * pointers to the data planes/channels.
214 * For video, this should simply point to data[].
216 * For planar audio, each channel has a separate data pointer, and
217 * linesize[0] contains the size of each channel buffer.
218 * For packed audio, there is just one data pointer, and linesize[0]
219 * contains the total size of the buffer for all channels.
221 * Note: Both data and extended_data should always be set in a valid frame,
222 * but for planar audio with more channels that can fit in data,
223 * extended_data must be used in order to access all channels.
225 uint8_t **extended_data;
228 * width and height of the video frame
233 * number of audio samples (per channel) described by this frame
238 * format of the frame, -1 if unknown or unset
239 * Values correspond to enum AVPixelFormat for video frames,
240 * enum AVSampleFormat for audio)
245 * 1 -> keyframe, 0-> not
250 * Picture type of the frame.
252 enum AVPictureType pict_type;
255 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
257 AVRational sample_aspect_ratio;
260 * Presentation timestamp in time_base units (time when frame should be shown to user).
265 * PTS copied from the AVPacket that was decoded to produce this frame.
270 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
271 * This is also the Presentation time of this AVFrame calculated from
272 * only AVPacket.dts values without pts values.
277 * picture number in bitstream order
279 int coded_picture_number;
281 * picture number in display order
283 int display_picture_number;
286 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
291 * for some private data of the user
295 #if FF_API_ERROR_FRAME
300 uint64_t error[AV_NUM_DATA_POINTERS];
304 * When decoding, this signals how much the picture must be delayed.
305 * extra_delay = repeat_pict / (2*fps)
310 * The content of the picture is interlaced.
312 int interlaced_frame;
315 * If the content is interlaced, is top field displayed first.
320 * Tell user application that palette has changed from previous frame.
322 int palette_has_changed;
325 * reordered opaque 64bit (generally an integer or a double precision float
326 * PTS but can be anything).
327 * The user sets AVCodecContext.reordered_opaque to represent the input at
329 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
330 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
331 * @deprecated in favor of pkt_pts
333 int64_t reordered_opaque;
336 * Sample rate of the audio data.
341 * Channel layout of the audio data.
343 uint64_t channel_layout;
346 * AVBuffer references backing the data for this frame. If all elements of
347 * this array are NULL, then this frame is not reference counted. This array
348 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
349 * also be non-NULL for all j < i.
351 * There may be at most one AVBuffer per data plane, so for video this array
352 * always contains all the references. For planar audio with more than
353 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
354 * this array. Then the extra AVBufferRef pointers are stored in the
355 * extended_buf array.
357 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
360 * For planar audio which requires more than AV_NUM_DATA_POINTERS
361 * AVBufferRef pointers, this array will hold all the references which
362 * cannot fit into AVFrame.buf.
364 * Note that this is different from AVFrame.extended_data, which always
365 * contains all the pointers. This array only contains the extra pointers,
366 * which cannot fit into AVFrame.buf.
368 * This array is always allocated using av_malloc() by whoever constructs
369 * the frame. It is freed in av_frame_unref().
371 AVBufferRef **extended_buf;
373 * Number of elements in extended_buf.
377 AVFrameSideData **side_data;
381 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
382 * Flags describing additional frame properties.
388 * The frame data may be corrupted, e.g. due to decoding errors.
390 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
396 * Frame flags, a combination of @ref lavu_frame_flags
401 * MPEG vs JPEG YUV range.
402 * It must be accessed using av_frame_get_color_range() and
403 * av_frame_set_color_range().
404 * - encoding: Set by user
405 * - decoding: Set by libavcodec
407 enum AVColorRange color_range;
409 enum AVColorPrimaries color_primaries;
411 enum AVColorTransferCharacteristic color_trc;
414 * YUV colorspace type.
415 * It must be accessed using av_frame_get_colorspace() and
416 * av_frame_set_colorspace().
417 * - encoding: Set by user
418 * - decoding: Set by libavcodec
420 enum AVColorSpace colorspace;
422 enum AVChromaLocation chroma_location;
425 * For hwaccel-format frames, this should be a reference to the
426 * AVHWFramesContext describing the frame.
428 AVBufferRef *hw_frames_ctx;
431 * frame timestamp estimated using various heuristics, in stream time base
432 * Code outside libavutil should access this field using:
433 * av_frame_get_best_effort_timestamp(frame)
435 * - decoding: set by libavcodec, read by user.
437 int64_t best_effort_timestamp;
440 * reordered pos from the last AVPacket that has been input into the decoder
441 * Code outside libavutil should access this field using:
442 * av_frame_get_pkt_pos(frame)
444 * - decoding: Read by user.
449 * duration of the corresponding packet, expressed in
450 * AVStream->time_base units, 0 if unknown.
451 * Code outside libavutil should access this field using:
452 * av_frame_get_pkt_duration(frame)
454 * - decoding: Read by user.
456 int64_t pkt_duration;
460 * Code outside libavutil should access this field using:
461 * av_frame_get_metadata(frame)
462 * - encoding: Set by user.
463 * - decoding: Set by libavcodec.
465 AVDictionary *metadata;
468 * decode error flags of the frame, set to a combination of
469 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
470 * were errors during the decoding.
471 * Code outside libavutil should access this field using:
472 * av_frame_get_decode_error_flags(frame)
474 * - decoding: set by libavcodec, read by user.
476 int decode_error_flags;
477 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
478 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
481 * number of audio channels, only used for audio.
482 * Code outside libavutil should access this field using:
483 * av_frame_get_channels(frame)
485 * - decoding: Read by user.
490 * size of the corresponding packet containing the compressed
491 * frame. It must be accessed using av_frame_get_pkt_size() and
492 * av_frame_set_pkt_size().
493 * It is set to a negative value if unknown.
495 * - decoding: set by libavcodec, read by user.
502 * Not to be accessed directly from outside libavutil
505 int8_t *qscale_table;
508 * Not to be accessed directly from outside libavutil
517 * Not to be accessed directly from outside libavutil
519 AVBufferRef *qp_table_buf;
524 * Accessors for some AVFrame fields.
525 * The position of these field in the structure is not part of the ABI,
526 * they should not be accessed directly outside libavutil.
528 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
529 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
530 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
531 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
532 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
533 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
534 int64_t av_frame_get_channel_layout (const AVFrame *frame);
535 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
536 int av_frame_get_channels (const AVFrame *frame);
537 void av_frame_set_channels (AVFrame *frame, int val);
538 int av_frame_get_sample_rate (const AVFrame *frame);
539 void av_frame_set_sample_rate (AVFrame *frame, int val);
540 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
541 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
542 int av_frame_get_decode_error_flags (const AVFrame *frame);
543 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
544 int av_frame_get_pkt_size(const AVFrame *frame);
545 void av_frame_set_pkt_size(AVFrame *frame, int val);
546 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
548 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
549 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
551 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
552 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
553 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
554 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
557 * Get the name of a colorspace.
558 * @return a static string identifying the colorspace; can be NULL.
560 const char *av_get_colorspace_name(enum AVColorSpace val);
563 * Allocate an AVFrame and set its fields to default values. The resulting
564 * struct must be freed using av_frame_free().
566 * @return An AVFrame filled with default values or NULL on failure.
568 * @note this only allocates the AVFrame itself, not the data buffers. Those
569 * must be allocated through other means, e.g. with av_frame_get_buffer() or
572 AVFrame *av_frame_alloc(void);
575 * Free the frame and any dynamically allocated objects in it,
576 * e.g. extended_data. If the frame is reference counted, it will be
577 * unreferenced first.
579 * @param frame frame to be freed. The pointer will be set to NULL.
581 void av_frame_free(AVFrame **frame);
584 * Set up a new reference to the data described by the source frame.
586 * Copy frame properties from src to dst and create a new reference for each
587 * AVBufferRef from src.
589 * If src is not reference counted, new buffers are allocated and the data is
592 * @return 0 on success, a negative AVERROR on error
594 int av_frame_ref(AVFrame *dst, const AVFrame *src);
597 * Create a new frame that references the same data as src.
599 * This is a shortcut for av_frame_alloc()+av_frame_ref().
601 * @return newly created AVFrame on success, NULL on error.
603 AVFrame *av_frame_clone(const AVFrame *src);
606 * Unreference all the buffers referenced by frame and reset the frame fields.
608 void av_frame_unref(AVFrame *frame);
611 * Move everything contained in src to dst and reset src.
613 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
616 * Allocate new buffer(s) for audio or video data.
618 * The following fields must be set on frame before calling this function:
619 * - format (pixel format for video, sample format for audio)
620 * - width and height for video
621 * - nb_samples and channel_layout for audio
623 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
624 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
625 * For planar formats, one buffer will be allocated for each plane.
627 * @param frame frame in which to store the new buffers.
628 * @param align required buffer size alignment
630 * @return 0 on success, a negative AVERROR on error.
632 int av_frame_get_buffer(AVFrame *frame, int align);
635 * Check if the frame data is writable.
637 * @return A positive value if the frame data is writable (which is true if and
638 * only if each of the underlying buffers has only one reference, namely the one
639 * stored in this frame). Return 0 otherwise.
641 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
642 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
644 * @see av_frame_make_writable(), av_buffer_is_writable()
646 int av_frame_is_writable(AVFrame *frame);
649 * Ensure that the frame data is writable, avoiding data copy if possible.
651 * Do nothing if the frame is writable, allocate new buffers and copy the data
654 * @return 0 on success, a negative AVERROR on error.
656 * @see av_frame_is_writable(), av_buffer_is_writable(),
657 * av_buffer_make_writable()
659 int av_frame_make_writable(AVFrame *frame);
662 * Copy the frame data from src to dst.
664 * This function does not allocate anything, dst must be already initialized and
665 * allocated with the same parameters as src.
667 * This function only copies the frame data (i.e. the contents of the data /
668 * extended data arrays), not any other properties.
670 * @return >= 0 on success, a negative AVERROR on error.
672 int av_frame_copy(AVFrame *dst, const AVFrame *src);
675 * Copy only "metadata" fields from src to dst.
677 * Metadata for the purpose of this function are those fields that do not affect
678 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
679 * aspect ratio (for video), but not width/height or channel layout.
680 * Side data is also copied.
682 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
685 * Get the buffer reference a given data plane is stored in.
687 * @param plane index of the data plane of interest in frame->extended_data.
689 * @return the buffer reference that contains the plane or NULL if the input
690 * frame is not valid.
692 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
695 * Add a new side data to a frame.
697 * @param frame a frame to which the side data should be added
698 * @param type type of the added side data
699 * @param size size of the side data
701 * @return newly added side data on success, NULL on error
703 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
704 enum AVFrameSideDataType type,
708 * @return a pointer to the side data of a given type on success, NULL if there
709 * is no side data with such type in this frame.
711 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
712 enum AVFrameSideDataType type);
715 * If side data of the supplied type exists in the frame, free it and remove it
718 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
721 * @return a string identifying the side data type
723 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
729 #endif /* AVUTIL_FRAME_H */