2 * This file is part of FFmpeg.
4 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 AVActiveFormatDescription enum.
90 * Motion vectors exported by some codecs (on demand through the export_mvs
91 * flag set in the libavcodec AVCodecContext flags2 option).
92 * The data is the AVMotionVector struct defined in
93 * libavutil/motion_vector.h.
95 AV_FRAME_DATA_MOTION_VECTORS,
97 * Recommmends skipping the specified number of samples. This is exported
98 * only if the "skip_manual" AVOption is set in libavcodec.
99 * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
101 * u32le number of samples to skip from start of this packet
102 * u32le number of samples to skip from end of this packet
103 * u8 reason for start skip
104 * u8 reason for end skip (0=padding silence, 1=convergence)
107 AV_FRAME_DATA_SKIP_SAMPLES,
109 * This side data must be associated with an audio frame and corresponds to
110 * enum AVAudioServiceType defined in avcodec.h.
112 AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
114 * Mastering display metadata associated with a video frame. The payload is
115 * an AVMasteringDisplayMetadata type and contains information about the
116 * mastering display color volume.
118 AV_FRAME_DATA_MASTERING_DISPLAY_METADATA,
120 * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
121 * This is set on the first frame of a GOP that has a temporal reference of 0.
123 AV_FRAME_DATA_GOP_TIMECODE,
126 * The data represents the AVSphericalMapping structure defined in
127 * libavutil/spherical.h.
129 AV_FRAME_DATA_SPHERICAL,
132 * Content light level (based on CTA-861.3). This payload contains data in
133 * the form of the AVContentLightMetadata struct.
135 AV_FRAME_DATA_CONTENT_LIGHT_LEVEL,
138 enum AVActiveFormatDescription {
143 AV_AFD_4_3_SP_14_9 = 13,
144 AV_AFD_16_9_SP_14_9 = 14,
150 * Structure to hold side data for an AVFrame.
152 * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
153 * to the end with a minor bump.
155 typedef struct AVFrameSideData {
156 enum AVFrameSideDataType type;
159 AVDictionary *metadata;
164 * This structure describes decoded (raw) audio or video data.
166 * AVFrame must be allocated using av_frame_alloc(). Note that this only
167 * allocates the AVFrame itself, the buffers for the data must be managed
168 * through other means (see below).
169 * AVFrame must be freed with av_frame_free().
171 * AVFrame is typically allocated once and then reused multiple times to hold
172 * different data (e.g. a single AVFrame to hold frames received from a
173 * decoder). In such a case, av_frame_unref() will free any references held by
174 * the frame and reset it to its original clean state before it
177 * The data described by an AVFrame is usually reference counted through the
178 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
179 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
180 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
181 * every single data plane must be contained in one of the buffers in
182 * AVFrame.buf or AVFrame.extended_buf.
183 * There may be a single buffer for all the data, or one separate buffer for
184 * each plane, or anything in between.
186 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
187 * to the end with a minor bump.
189 * Fields can be accessed through AVOptions, the name string used, matches the
190 * C structure field name for fields accessible through AVOptions. The AVClass
191 * for AVFrame can be obtained from avcodec_get_frame_class()
193 typedef struct AVFrame {
194 #define AV_NUM_DATA_POINTERS 8
196 * pointer to the picture/channel planes.
197 * This might be different from the first allocated byte
199 * Some decoders access areas outside 0,0 - width,height, please
200 * see avcodec_align_dimensions2(). Some filters and swscale can read
201 * up to 16 bytes beyond the planes, if these filters are to be used,
202 * then 16 extra bytes must be allocated.
204 * NOTE: Except for hwaccel formats, pointers not needed by the format
205 * MUST be set to NULL.
207 uint8_t *data[AV_NUM_DATA_POINTERS];
210 * For video, size in bytes of each picture line.
211 * For audio, size in bytes of each plane.
213 * For audio, only linesize[0] may be set. For planar audio, each channel
214 * plane must be the same size.
216 * For video the linesizes should be multiples of the CPUs alignment
217 * preference, this is 16 or 32 for modern desktop CPUs.
218 * Some code requires such alignment other code can be slower without
219 * correct alignment, for yet other it makes no difference.
221 * @note The linesize may be larger than the size of usable data -- there
222 * may be extra padding present for performance reasons.
224 int linesize[AV_NUM_DATA_POINTERS];
227 * pointers to the data planes/channels.
229 * For video, this should simply point to data[].
231 * For planar audio, each channel has a separate data pointer, and
232 * linesize[0] contains the size of each channel buffer.
233 * For packed audio, there is just one data pointer, and linesize[0]
234 * contains the total size of the buffer for all channels.
236 * Note: Both data and extended_data should always be set in a valid frame,
237 * but for planar audio with more channels that can fit in data,
238 * extended_data must be used in order to access all channels.
240 uint8_t **extended_data;
243 * width and height of the video frame
248 * number of audio samples (per channel) described by this frame
253 * format of the frame, -1 if unknown or unset
254 * Values correspond to enum AVPixelFormat for video frames,
255 * enum AVSampleFormat for audio)
260 * 1 -> keyframe, 0-> not
265 * Picture type of the frame.
267 enum AVPictureType pict_type;
270 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
272 AVRational sample_aspect_ratio;
275 * Presentation timestamp in time_base units (time when frame should be shown to user).
281 * PTS copied from the AVPacket that was decoded to produce this frame.
282 * @deprecated use the pts field instead
289 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
290 * This is also the Presentation time of this AVFrame calculated from
291 * only AVPacket.dts values without pts values.
296 * picture number in bitstream order
298 int coded_picture_number;
300 * picture number in display order
302 int display_picture_number;
305 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
310 * for some private data of the user
314 #if FF_API_ERROR_FRAME
319 uint64_t error[AV_NUM_DATA_POINTERS];
323 * When decoding, this signals how much the picture must be delayed.
324 * extra_delay = repeat_pict / (2*fps)
329 * The content of the picture is interlaced.
331 int interlaced_frame;
334 * If the content is interlaced, is top field displayed first.
339 * Tell user application that palette has changed from previous frame.
341 int palette_has_changed;
344 * reordered opaque 64 bits (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;
355 * Sample rate of the audio data.
360 * Channel layout of the audio data.
362 uint64_t channel_layout;
365 * AVBuffer references backing the data for this frame. If all elements of
366 * this array are NULL, then this frame is not reference counted. This array
367 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
368 * also be non-NULL for all j < i.
370 * There may be at most one AVBuffer per data plane, so for video this array
371 * always contains all the references. For planar audio with more than
372 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
373 * this array. Then the extra AVBufferRef pointers are stored in the
374 * extended_buf array.
376 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
379 * For planar audio which requires more than AV_NUM_DATA_POINTERS
380 * AVBufferRef pointers, this array will hold all the references which
381 * cannot fit into AVFrame.buf.
383 * Note that this is different from AVFrame.extended_data, which always
384 * contains all the pointers. This array only contains the extra pointers,
385 * which cannot fit into AVFrame.buf.
387 * This array is always allocated using av_malloc() by whoever constructs
388 * the frame. It is freed in av_frame_unref().
390 AVBufferRef **extended_buf;
392 * Number of elements in extended_buf.
396 AVFrameSideData **side_data;
400 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
401 * @ingroup lavu_frame
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)
412 * A flag to mark the frames which need to be decoded, but shouldn't be output.
414 #define AV_FRAME_FLAG_DISCARD (1 << 2)
420 * Frame flags, a combination of @ref lavu_frame_flags
425 * MPEG vs JPEG YUV range.
426 * - encoding: Set by user
427 * - decoding: Set by libavcodec
429 enum AVColorRange color_range;
431 enum AVColorPrimaries color_primaries;
433 enum AVColorTransferCharacteristic color_trc;
436 * YUV colorspace type.
437 * - encoding: Set by user
438 * - decoding: Set by libavcodec
440 enum AVColorSpace colorspace;
442 enum AVChromaLocation chroma_location;
445 * frame timestamp estimated using various heuristics, in stream time base
447 * - decoding: set by libavcodec, read by user.
449 int64_t best_effort_timestamp;
452 * reordered pos from the last AVPacket that has been input into the decoder
454 * - decoding: Read by user.
459 * duration of the corresponding packet, expressed in
460 * AVStream->time_base units, 0 if unknown.
462 * - decoding: Read by user.
464 int64_t pkt_duration;
468 * - encoding: Set by user.
469 * - decoding: Set by libavcodec.
471 AVDictionary *metadata;
474 * decode error flags of the frame, set to a combination of
475 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
476 * were errors during the decoding.
478 * - decoding: set by libavcodec, read by user.
480 int decode_error_flags;
481 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
482 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
485 * number of audio channels, only used for audio.
487 * - decoding: Read by user.
492 * size of the corresponding packet containing the compressed
494 * It is set to a negative value if unknown.
496 * - decoding: set by libavcodec, read by user.
505 int8_t *qscale_table;
515 AVBufferRef *qp_table_buf;
518 * For hwaccel-format frames, this should be a reference to the
519 * AVHWFramesContext describing the frame.
521 AVBufferRef *hw_frames_ctx;
524 * AVBufferRef for free use by the API user. FFmpeg will never check the
525 * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
526 * the frame is unreferenced. av_frame_copy_props() calls create a new
527 * reference with av_buffer_ref() for the target frame's opaque_ref field.
529 * This is unrelated to the opaque field, although it serves a similar
532 AVBufferRef *opaque_ref;
536 * Accessors for some AVFrame fields. These used to be provided for ABI
537 * compatibility, and do not need to be used anymore.
539 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
540 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
541 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
542 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
543 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
544 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
545 int64_t av_frame_get_channel_layout (const AVFrame *frame);
546 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
547 int av_frame_get_channels (const AVFrame *frame);
548 void av_frame_set_channels (AVFrame *frame, int val);
549 int av_frame_get_sample_rate (const AVFrame *frame);
550 void av_frame_set_sample_rate (AVFrame *frame, int val);
551 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
552 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
553 int av_frame_get_decode_error_flags (const AVFrame *frame);
554 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
555 int av_frame_get_pkt_size(const AVFrame *frame);
556 void av_frame_set_pkt_size(AVFrame *frame, int val);
557 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
559 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
560 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
562 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
563 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
564 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
565 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
568 * Get the name of a colorspace.
569 * @return a static string identifying the colorspace; can be NULL.
571 const char *av_get_colorspace_name(enum AVColorSpace val);
574 * Allocate an AVFrame and set its fields to default values. The resulting
575 * struct must be freed using av_frame_free().
577 * @return An AVFrame filled with default values or NULL on failure.
579 * @note this only allocates the AVFrame itself, not the data buffers. Those
580 * must be allocated through other means, e.g. with av_frame_get_buffer() or
583 AVFrame *av_frame_alloc(void);
586 * Free the frame and any dynamically allocated objects in it,
587 * e.g. extended_data. If the frame is reference counted, it will be
588 * unreferenced first.
590 * @param frame frame to be freed. The pointer will be set to NULL.
592 void av_frame_free(AVFrame **frame);
595 * Set up a new reference to the data described by the source frame.
597 * Copy frame properties from src to dst and create a new reference for each
598 * AVBufferRef from src.
600 * If src is not reference counted, new buffers are allocated and the data is
603 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
604 * or newly allocated with av_frame_alloc() before calling this
605 * function, or undefined behavior will occur.
607 * @return 0 on success, a negative AVERROR on error
609 int av_frame_ref(AVFrame *dst, const AVFrame *src);
612 * Create a new frame that references the same data as src.
614 * This is a shortcut for av_frame_alloc()+av_frame_ref().
616 * @return newly created AVFrame on success, NULL on error.
618 AVFrame *av_frame_clone(const AVFrame *src);
621 * Unreference all the buffers referenced by frame and reset the frame fields.
623 void av_frame_unref(AVFrame *frame);
626 * Move everything contained in src to dst and reset src.
628 * @warning: dst is not unreferenced, but directly overwritten without reading
629 * or deallocating its contents. Call av_frame_unref(dst) manually
630 * before calling this function to ensure that no memory is leaked.
632 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
635 * Allocate new buffer(s) for audio or video data.
637 * The following fields must be set on frame before calling this function:
638 * - format (pixel format for video, sample format for audio)
639 * - width and height for video
640 * - nb_samples and channel_layout for audio
642 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
643 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
644 * For planar formats, one buffer will be allocated for each plane.
646 * @warning: if frame already has been allocated, calling this function will
647 * leak memory. In addition, undefined behavior can occur in certain
650 * @param frame frame in which to store the new buffers.
651 * @param align required buffer size alignment
653 * @return 0 on success, a negative AVERROR on error.
655 int av_frame_get_buffer(AVFrame *frame, int align);
658 * Check if the frame data is writable.
660 * @return A positive value if the frame data is writable (which is true if and
661 * only if each of the underlying buffers has only one reference, namely the one
662 * stored in this frame). Return 0 otherwise.
664 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
665 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
667 * @see av_frame_make_writable(), av_buffer_is_writable()
669 int av_frame_is_writable(AVFrame *frame);
672 * Ensure that the frame data is writable, avoiding data copy if possible.
674 * Do nothing if the frame is writable, allocate new buffers and copy the data
677 * @return 0 on success, a negative AVERROR on error.
679 * @see av_frame_is_writable(), av_buffer_is_writable(),
680 * av_buffer_make_writable()
682 int av_frame_make_writable(AVFrame *frame);
685 * Copy the frame data from src to dst.
687 * This function does not allocate anything, dst must be already initialized and
688 * allocated with the same parameters as src.
690 * This function only copies the frame data (i.e. the contents of the data /
691 * extended data arrays), not any other properties.
693 * @return >= 0 on success, a negative AVERROR on error.
695 int av_frame_copy(AVFrame *dst, const AVFrame *src);
698 * Copy only "metadata" fields from src to dst.
700 * Metadata for the purpose of this function are those fields that do not affect
701 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
702 * aspect ratio (for video), but not width/height or channel layout.
703 * Side data is also copied.
705 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
708 * Get the buffer reference a given data plane is stored in.
710 * @param plane index of the data plane of interest in frame->extended_data.
712 * @return the buffer reference that contains the plane or NULL if the input
713 * frame is not valid.
715 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
718 * Add a new side data to a frame.
720 * @param frame a frame to which the side data should be added
721 * @param type type of the added side data
722 * @param size size of the side data
724 * @return newly added side data on success, NULL on error
726 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
727 enum AVFrameSideDataType type,
731 * @return a pointer to the side data of a given type on success, NULL if there
732 * is no side data with such type in this frame.
734 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
735 enum AVFrameSideDataType type);
738 * If side data of the supplied type exists in the frame, free it and remove it
741 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
744 * @return a string identifying the side data type
746 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
752 #endif /* AVUTIL_FRAME_H */