AVFrame is an abstraction for reference-counted raw multimedia data. More...

Modules
	AV_FRAME_FLAGS
	Flags describing additional frame properties.

Files
file	frame.h
	reference-counted frame API

Data Structures
struct	AVFrameSideData
	Structure to hold side data for an AVFrame. More...

struct	AVRegionOfInterest
	Structure describing a single Region Of Interest. More...

struct	AVFrame
	This structure describes decoded (raw) audio or video data. More...

Enumerations
enum	AVFrameSideDataType { AV_FRAME_DATA_PANSCAN , AV_FRAME_DATA_A53_CC , AV_FRAME_DATA_STEREO3D , AV_FRAME_DATA_MATRIXENCODING , AV_FRAME_DATA_DOWNMIX_INFO , AV_FRAME_DATA_REPLAYGAIN , AV_FRAME_DATA_DISPLAYMATRIX , AV_FRAME_DATA_AFD , AV_FRAME_DATA_MOTION_VECTORS , AV_FRAME_DATA_SKIP_SAMPLES , AV_FRAME_DATA_AUDIO_SERVICE_TYPE , AV_FRAME_DATA_MASTERING_DISPLAY_METADATA , AV_FRAME_DATA_GOP_TIMECODE , AV_FRAME_DATA_SPHERICAL , AV_FRAME_DATA_CONTENT_LIGHT_LEVEL , AV_FRAME_DATA_ICC_PROFILE , AV_FRAME_DATA_S12M_TIMECODE , AV_FRAME_DATA_DYNAMIC_HDR_PLUS , AV_FRAME_DATA_REGIONS_OF_INTEREST , AV_FRAME_DATA_VIDEO_ENC_PARAMS , AV_FRAME_DATA_SEI_UNREGISTERED , AV_FRAME_DATA_FILM_GRAIN_PARAMS , AV_FRAME_DATA_DETECTION_BBOXES , AV_FRAME_DATA_DOVI_RPU_BUFFER , AV_FRAME_DATA_DOVI_METADATA , AV_FRAME_DATA_DYNAMIC_HDR_VIVID }

enum	AVActiveFormatDescription { AV_AFD_SAME = 8 , AV_AFD_4_3 = 9 , AV_AFD_16_9 = 10 , AV_AFD_14_9 = 11 , AV_AFD_4_3_SP_14_9 = 13 , AV_AFD_16_9_SP_14_9 = 14 , AV_AFD_SP_4_3 = 15 }

enum	{ AV_FRAME_CROP_UNALIGNED = 1 << 0 }
	Flags for frame cropping. More...

Functions
attribute_deprecated const char *	av_get_colorspace_name (enum AVColorSpace val)
	Get the name of a colorspace. More...

AVFrame *	av_frame_alloc (void)
	Allocate an AVFrame and set its fields to default values. More...

void	av_frame_free (AVFrame **frame)
	Free the frame and any dynamically allocated objects in it, e.g. More...

int	av_frame_ref (AVFrame dst, const AVFrame src)
	Set up a new reference to the data described by the source frame. More...

AVFrame *	av_frame_clone (const AVFrame *src)
	Create a new frame that references the same data as src. More...

void	av_frame_unref (AVFrame *frame)
	Unreference all the buffers referenced by frame and reset the frame fields. More...

void	av_frame_move_ref (AVFrame dst, AVFrame src)
	Move everything contained in src to dst and reset src. More...

int	av_frame_get_buffer (AVFrame *frame, int align)
	Allocate new buffer(s) for audio or video data. More...

int	av_frame_is_writable (AVFrame *frame)
	Check if the frame data is writable. More...

int	av_frame_make_writable (AVFrame *frame)
	Ensure that the frame data is writable, avoiding data copy if possible. More...

int	av_frame_copy (AVFrame dst, const AVFrame src)
	Copy the frame data from src to dst. More...

int	av_frame_copy_props (AVFrame dst, const AVFrame src)
	Copy only "metadata" fields from src to dst. More...

AVBufferRef *	av_frame_get_plane_buffer (AVFrame *frame, int plane)
	Get the buffer reference a given data plane is stored in. More...

AVFrameSideData *	av_frame_new_side_data (AVFrame *frame, enum AVFrameSideDataType type, size_t size)
	Add a new side data to a frame. More...

AVFrameSideData *	av_frame_new_side_data_from_buf (AVFrame frame, enum AVFrameSideDataType type, AVBufferRef buf)
	Add a new side data to a frame from an existing AVBufferRef. More...

AVFrameSideData *	av_frame_get_side_data (const AVFrame *frame, enum AVFrameSideDataType type)

void	av_frame_remove_side_data (AVFrame *frame, enum AVFrameSideDataType type)
	Remove and free all side data instances of the given type. More...

int	av_frame_apply_cropping (AVFrame *frame, int flags)
	Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields. More...

const char *	av_frame_side_data_name (enum AVFrameSideDataType type)

Detailed Description

AVFrame is an abstraction for reference-counted raw multimedia data.

Enumeration Type Documentation

◆ AVFrameSideDataType

enum AVFrameSideDataType

Enumerator
AV_FRAME_DATA_PANSCAN	The data is the AVPanScan struct defined in libavcodec.
AV_FRAME_DATA_A53_CC	ATSC A53 Part 4 Closed Captions. A53 CC bitstream is stored as uint8_t in AVFrameSideData.data. The number of bytes of CC data is AVFrameSideData.size.
AV_FRAME_DATA_STEREO3D	Stereoscopic 3d metadata. The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
AV_FRAME_DATA_MATRIXENCODING	The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
AV_FRAME_DATA_DOWNMIX_INFO	Metadata relevant to a downmix procedure. The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
AV_FRAME_DATA_REPLAYGAIN	ReplayGain information in the form of the AVReplayGain struct.
AV_FRAME_DATA_DISPLAYMATRIX	This side data contains a 3x3 transformation matrix describing an affine transformation that needs to be applied to the frame for correct presentation. See libavutil/display.h for a detailed description of the data.
AV_FRAME_DATA_AFD	Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVActiveFormatDescription enum.
AV_FRAME_DATA_MOTION_VECTORS	Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec AVCodecContext flags2 option). The data is the AVMotionVector struct defined in libavutil/motion_vector.h.
AV_FRAME_DATA_SKIP_SAMPLES	Recommmends skipping the specified number of samples. This is exported only if the "skip_manual" AVOption is set in libavcodec. This has the same format as AV_PKT_DATA_SKIP_SAMPLES. u32le number of samples to skip from start of this packet u32le number of samples to skip from end of this packet u8 reason for start skip u8 reason for end skip (0=padding silence, 1=convergence)
AV_FRAME_DATA_AUDIO_SERVICE_TYPE	This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defined in avcodec.h.
AV_FRAME_DATA_MASTERING_DISPLAY_METADATA	Mastering display metadata associated with a video frame. The payload is an AVMasteringDisplayMetadata type and contains information about the mastering display color volume.
AV_FRAME_DATA_GOP_TIMECODE	The GOP timecode in 25 bit timecode format. Data format is 64-bit integer. This is set on the first frame of a GOP that has a temporal reference of 0.
AV_FRAME_DATA_SPHERICAL	The data represents the AVSphericalMapping structure defined in libavutil/spherical.h.
AV_FRAME_DATA_CONTENT_LIGHT_LEVEL	Content light level (based on CTA-861.3). This payload contains data in the form of the AVContentLightMetadata struct.
AV_FRAME_DATA_ICC_PROFILE	The data contains an ICC profile as an opaque octet buffer following the format described by ISO 15076-1 with an optional name defined in the metadata key entry "name".
AV_FRAME_DATA_S12M_TIMECODE	Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t where the first uint32_t describes how many (1-3) of the other timecodes are used. The timecode format is described in the documentation of av_timecode_get_smpte_from_framenum() function in libavutil/timecode.h.
AV_FRAME_DATA_DYNAMIC_HDR_PLUS	HDR dynamic metadata associated with a video frame. The payload is an AVDynamicHDRPlus type and contains information for color volume transform - application 4 of SMPTE 2094-40:2016 standard.
AV_FRAME_DATA_REGIONS_OF_INTEREST	Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.
AV_FRAME_DATA_VIDEO_ENC_PARAMS	Encoding parameters for a video frame, as described by AVVideoEncParams.
AV_FRAME_DATA_SEI_UNREGISTERED	User data unregistered metadata associated with a video frame. This is the H.26[45] UDU SEI message, and shouldn't be used for any other purpose The data is stored as uint8_t in AVFrameSideData.data which is 16 bytes of uuid_iso_iec_11578 followed by AVFrameSideData.size - 16 bytes of user_data_payload_byte.
AV_FRAME_DATA_FILM_GRAIN_PARAMS	Film grain parameters for a frame, described by AVFilmGrainParams. Must be present for every frame which should have film grain applied.
AV_FRAME_DATA_DETECTION_BBOXES	Bounding boxes for object detection and classification, as described by AVDetectionBBoxHeader.
AV_FRAME_DATA_DOVI_RPU_BUFFER	Dolby Vision RPU raw data, suitable for passing to x265 or other libraries. Array of uint8_t, with NAL emulation bytes intact.
AV_FRAME_DATA_DOVI_METADATA	Parsed Dolby Vision metadata, suitable for passing to a software implementation. The payload is the AVDOVIMetadata struct defined in libavutil/dovi_meta.h.
AV_FRAME_DATA_DYNAMIC_HDR_VIVID	HDR Vivid dynamic metadata associated with a video frame. The payload is an AVDynamicHDRVivid type and contains information for color volume transform - CUVA 005.1-2021.

Definition at line 49 of file frame.h.

◆ AVActiveFormatDescription

enum AVActiveFormatDescription

Enumerator
AV_AFD_SAME
AV_AFD_4_3
AV_AFD_16_9
AV_AFD_14_9
AV_AFD_4_3_SP_14_9
AV_AFD_16_9_SP_14_9
AV_AFD_SP_4_3

Definition at line 214 of file frame.h.

◆ anonymous enum

anonymous enum

Flags for frame cropping.

Enumerator

AV_FRAME_CROP_UNALIGNED

Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unaligned pointers.

Passing unaligned data to FFmpeg API is generally not allowed, and causes undefined behavior (such as crashes). You can pass unaligned data only to FFmpeg APIs that are explicitly documented to accept it. Use this flag only if you absolutely know what you are doing.

Definition at line 908 of file frame.h.

Function Documentation

◆ av_get_colorspace_name()

attribute_deprecated const char * av_get_colorspace_name ( enum AVColorSpace val )

Get the name of a colorspace.

Returns: a static string identifying the colorspace; can be NULL.

Deprecated:: use av_color_space_name()

◆ av_frame_alloc()

AVFrame * av_frame_alloc ( void )

Allocate an AVFrame and set its fields to default values.

The resulting struct must be freed using av_frame_free().

Returns: An AVFrame filled with default values or NULL on failure.

Note: this only allocates the AVFrame itself, not the data buffers. Those must be allocated through other means, e.g. with av_frame_get_buffer() or manually.

Examples: decode_audio.c, decode_video.c, demuxing_decoding.c, encode_audio.c, encode_video.c, filter_audio.c, filtering_audio.c, filtering_video.c, hw_decode.c, muxing.c, qsvdec.c, transcode_aac.c, transcoding.c, vaapi_encode.c, and vaapi_transcode.c.

Referenced by alloc_audio_frame(), alloc_picture(), dec_enc(), decode_write(), init_filters(), init_input_frame(), init_output_frame(), main(), and open_input_file().

◆ av_frame_free()

void av_frame_free ( AVFrame ** frame )

Free the frame and any dynamically allocated objects in it, e.g.

extended_data. If the frame is reference counted, it will be unreferenced first.

Parameters

frame frame to be freed. The pointer will be set to NULL.

Examples: decode_audio.c, decode_video.c, demuxing_decoding.c, encode_audio.c, encode_video.c, filter_audio.c, filtering_audio.c, filtering_video.c, hw_decode.c, muxing.c, qsvdec.c, transcode_aac.c, transcoding.c, vaapi_encode.c, and vaapi_transcode.c.

Referenced by close_stream(), dec_enc(), decode_write(), init_output_frame(), load_encode_and_write(), main(), and read_decode_convert_and_store().

◆ av_frame_ref()

int av_frame_ref	(	AVFrame *	dst,
		const AVFrame *	src
	)

Set up a new reference to the data described by the source frame.

Copy frame properties from src to dst and create a new reference for each AVBufferRef from src.

If src is not reference counted, new buffers are allocated and the data is copied.

Warning: : dst MUST have been either unreferenced with av_frame_unref(dst), or newly allocated with av_frame_alloc() before calling this function, or undefined behavior will occur.

Returns: 0 on success, a negative AVERROR on error

◆ av_frame_clone()

AVFrame * av_frame_clone ( const AVFrame * src )

Create a new frame that references the same data as src.

This is a shortcut for av_frame_alloc()+av_frame_ref().

Returns: newly created AVFrame on success, NULL on error.

◆ av_frame_unref()

void av_frame_unref ( AVFrame * frame )

Unreference all the buffers referenced by frame and reset the frame fields.

Examples: demuxing_decoding.c, filter_audio.c, filtering_audio.c, filtering_video.c, qsvdec.c, and transcoding.c.

Referenced by decode_packet(), filter_encode_write_frame(), and main().

◆ av_frame_move_ref()

void av_frame_move_ref	(	AVFrame *	dst,
		AVFrame *	src
	)

Move everything contained in src to dst and reset src.

Warning: : dst is not unreferenced, but directly overwritten without reading or deallocating its contents. Call av_frame_unref(dst) manually before calling this function to ensure that no memory is leaked.

◆ av_frame_get_buffer()

int av_frame_get_buffer	(	AVFrame *	frame,
		int	align
	)

Allocate new buffer(s) for audio or video data.

The following fields must be set on frame before calling this function:

format (pixel format for video, sample format for audio)
width and height for video
nb_samples and ch_layout for audio

This function will fill AVFrame.data and AVFrame.buf arrays and, if necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf. For planar formats, one buffer will be allocated for each plane.

Warning: : if frame already has been allocated, calling this function will leak memory. In addition, undefined behavior can occur in certain cases.

Parameters

frame	frame in which to store the new buffers.
align	Required buffer size alignment. If equal to 0, alignment will be chosen automatically for the current CPU. It is highly recommended to pass 0 here unless you know what you are doing.

Returns: 0 on success, a negative AVERROR on error.

Examples: encode_audio.c, encode_video.c, filter_audio.c, muxing.c, transcode_aac.c, and vaapi_encode.c.

Referenced by alloc_audio_frame(), alloc_picture(), get_input(), init_output_frame(), and main().

◆ av_frame_is_writable()

int av_frame_is_writable ( AVFrame * frame )

Check if the frame data is writable.

Returns: A positive value if the frame data is writable (which is true if and only if each of the underlying buffers has only one reference, namely the one stored in this frame). Return 0 otherwise.

If 1 is returned the answer is valid until av_buffer_ref() is called on any of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).

See also: av_frame_make_writable(), av_buffer_is_writable()

◆ av_frame_make_writable()

int av_frame_make_writable ( AVFrame * frame )

Ensure that the frame data is writable, avoiding data copy if possible.

Do nothing if the frame is writable, allocate new buffers and copy the data if it is not.

Returns: 0 on success, a negative AVERROR on error.

See also: av_frame_is_writable(), av_buffer_is_writable(), av_buffer_make_writable()

Examples: encode_audio.c, encode_video.c, and muxing.c.

Referenced by get_video_frame(), main(), and write_audio_frame().

◆ av_frame_copy()

int av_frame_copy	(	AVFrame *	dst,
		const AVFrame *	src
	)

Copy the frame data from src to dst.

This function does not allocate anything, dst must be already initialized and allocated with the same parameters as src.

This function only copies the frame data (i.e. the contents of the data / extended data arrays), not any other properties.

Returns: >= 0 on success, a negative AVERROR on error.

◆ av_frame_copy_props()

int av_frame_copy_props	(	AVFrame *	dst,
		const AVFrame *	src
	)

Copy only "metadata" fields from src to dst.

Metadata for the purpose of this function are those fields that do not affect the data layout in the buffers. E.g. pts, sample rate (for audio) or sample aspect ratio (for video), but not width/height or channel layout. Side data is also copied.

◆ av_frame_get_plane_buffer()

AVBufferRef * av_frame_get_plane_buffer	(	AVFrame *	frame,
		int	plane
	)

Get the buffer reference a given data plane is stored in.

Parameters

plane index of the data plane of interest in frame->extended_data.

Returns: the buffer reference that contains the plane or NULL if the input frame is not valid.

◆ av_frame_new_side_data()

AVFrameSideData * av_frame_new_side_data	(	AVFrame *	frame,
		enum AVFrameSideDataType	type,
		size_t	size
	)

Add a new side data to a frame.

Parameters

frame	a frame to which the side data should be added
type	type of the added side data
size	size of the side data

Returns: newly added side data on success, NULL on error

◆ av_frame_new_side_data_from_buf()

AVFrameSideData * av_frame_new_side_data_from_buf	(	AVFrame *	frame,
		enum AVFrameSideDataType	type,
		AVBufferRef *	buf
	)

Add a new side data to a frame from an existing AVBufferRef.

Parameters

frame	a frame to which the side data should be added
type	the type of the added side data
buf	an AVBufferRef to add as side data. The ownership of the reference is transferred to the frame.

Returns: newly added side data on success, NULL on error. On failure the frame is unchanged and the AVBufferRef remains owned by the caller.

◆ av_frame_get_side_data()

AVFrameSideData * av_frame_get_side_data	(	const AVFrame *	frame,
		enum AVFrameSideDataType	type
	)

Returns: a pointer to the side data of a given type on success, NULL if there is no side data with such type in this frame.

Referenced by decode_packet().

◆ av_frame_remove_side_data()

void av_frame_remove_side_data	(	AVFrame *	frame,
		enum AVFrameSideDataType	type
	)

Remove and free all side data instances of the given type.

◆ av_frame_apply_cropping()

int av_frame_apply_cropping	(	AVFrame *	frame,
		int	flags
	)

Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields.

If cropping is successful, the function will adjust the data pointers and the width/height fields, and set the crop fields to 0.

In all cases, the cropping boundaries will be rounded to the inherent alignment of the pixel format. In some cases, such as for opaque hwaccel formats, the left/top cropping is ignored. The crop fields are set to 0 even if the cropping was rounded or ignored.

Parameters

frame	the frame which should be cropped
flags	Some combination of AV_FRAME_CROP_* flags, or 0.

Returns: >= 0 on success, a negative AVERROR on error. If the cropping fields were invalid, AVERROR(ERANGE) is returned, and nothing is changed.

◆ av_frame_side_data_name()

const char * av_frame_side_data_name ( enum AVFrameSideDataType type )

Returns: a string identifying the side data type

Modules

Files

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ AVFrameSideDataType

◆ AVActiveFormatDescription

◆ anonymous enum

Function Documentation

◆ av_get_colorspace_name()

◆ av_frame_alloc()

◆ av_frame_free()

◆ av_frame_ref()

◆ av_frame_clone()

◆ av_frame_unref()

◆ av_frame_move_ref()

◆ av_frame_get_buffer()

◆ av_frame_is_writable()

◆ av_frame_make_writable()

◆ av_frame_copy()

◆ av_frame_copy_props()

◆ av_frame_get_plane_buffer()

◆ av_frame_new_side_data()

◆ av_frame_new_side_data_from_buf()

◆ av_frame_get_side_data()

◆ av_frame_remove_side_data()

◆ av_frame_apply_cropping()

◆ av_frame_side_data_name()