#include <stdint.h>
#include "libavcodec/version.h"
#include "avutil.h"
#include "buffer.h"
#include "dict.h"
#include "rational.h"
#include "samplefmt.h"

Data Structures
struct	AVFrameSideData

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

Macros
#define	AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG

#define	AV_NUM_DATA_POINTERS 8

#define	FF_DECODE_ERROR_INVALID_BITSTREAM 1

#define	FF_DECODE_ERROR_MISSING_REFERENCE 2

Enumerations
enum	AVColorSpace { AVCOL_SPC_RGB = 0, AVCOL_SPC_BT709 = 1, AVCOL_SPC_UNSPECIFIED = 2, AVCOL_SPC_FCC = 4, AVCOL_SPC_BT470BG = 5, AVCOL_SPC_SMPTE170M = 6, AVCOL_SPC_SMPTE240M = 7, AVCOL_SPC_YCOCG = 8, AVCOL_SPC_NB, AVCOL_SPC_RGB = 0, AVCOL_SPC_BT709 = 1, AVCOL_SPC_UNSPECIFIED = 2, AVCOL_SPC_FCC = 4, AVCOL_SPC_BT470BG = 5, AVCOL_SPC_SMPTE170M = 6, AVCOL_SPC_SMPTE240M = 7, AVCOL_SPC_YCOCG = 8, AVCOL_SPC_NB, AVCOL_SPC_RGB = 0, AVCOL_SPC_BT709 = 1, AVCOL_SPC_UNSPECIFIED = 2, AVCOL_SPC_FCC = 4, AVCOL_SPC_BT470BG = 5, AVCOL_SPC_SMPTE170M = 6, AVCOL_SPC_SMPTE240M = 7, AVCOL_SPC_YCOCG = 8, AVCOL_SPC_NB }

enum	AVColorRange { AVCOL_RANGE_UNSPECIFIED = 0, AVCOL_RANGE_MPEG = 1, AVCOL_RANGE_JPEG = 2, AVCOL_RANGE_NB, AVCOL_RANGE_UNSPECIFIED = 0, AVCOL_RANGE_MPEG = 1, AVCOL_RANGE_JPEG = 2, AVCOL_RANGE_NB, AVCOL_RANGE_UNSPECIFIED = 0, AVCOL_RANGE_MPEG = 1, AVCOL_RANGE_JPEG = 2, AVCOL_RANGE_NB }

enum	AVFrameSideDataType { AV_FRAME_DATA_PANSCAN, AV_FRAME_DATA_PANSCAN, AV_FRAME_DATA_PANSCAN }

Functions
int64_t	av_frame_get_best_effort_timestamp (const AVFrame *frame)
	Accessors for some AVFrame fields. More...

void	av_frame_set_best_effort_timestamp (AVFrame *frame, int64_t val)

int64_t	av_frame_get_pkt_duration (const AVFrame *frame)

void	av_frame_set_pkt_duration (AVFrame *frame, int64_t val)

int64_t	av_frame_get_pkt_pos (const AVFrame *frame)

void	av_frame_set_pkt_pos (AVFrame *frame, int64_t val)

int64_t	av_frame_get_channel_layout (const AVFrame *frame)

void	av_frame_set_channel_layout (AVFrame *frame, int64_t val)

int	av_frame_get_channels (const AVFrame *frame)

void	av_frame_set_channels (AVFrame *frame, int val)

int	av_frame_get_sample_rate (const AVFrame *frame)

void	av_frame_set_sample_rate (AVFrame *frame, int val)

AVDictionary *	av_frame_get_metadata (const AVFrame *frame)

void	av_frame_set_metadata (AVFrame frame, AVDictionary val)

int	av_frame_get_decode_error_flags (const AVFrame *frame)

void	av_frame_set_decode_error_flags (AVFrame *frame, int val)

int	av_frame_get_pkt_size (const AVFrame *frame)

void	av_frame_set_pkt_size (AVFrame *frame, int val)

AVDictionary **	avpriv_frame_get_metadatap (AVFrame *frame)

int8_t *	av_frame_get_qp_table (AVFrame f, int stride, int *type)

int	av_frame_set_qp_table (AVFrame f, AVBufferRef buf, int stride, int type)

enum AVColorSpace	av_frame_get_colorspace (const AVFrame *frame)

void	av_frame_set_colorspace (AVFrame *frame, enum AVColorSpace val)

enum AVColorRange	av_frame_get_color_range (const AVFrame *frame)

void	av_frame_set_color_range (AVFrame *frame, enum AVColorRange val)

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, AVFrame src)
	Setup a new reference to the data described by a given frame. More...

AVFrame *	av_frame_clone (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 everythnig 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_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, int size)
	Add a new side data to a frame. More...

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

Macro Definition Documentation

#define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG

Definition at line 44 of file frame.h.

#define AV_NUM_DATA_POINTERS 8

Definition at line 97 of file frame.h.

#define FF_DECODE_ERROR_INVALID_BITSTREAM 1

Definition at line 436 of file frame.h.

#define FF_DECODE_ERROR_MISSING_REFERENCE 2

Definition at line 437 of file frame.h.

Enumeration Type Documentation

enum AVColorSpace

Enumerator
AVCOL_SPC_RGB
AVCOL_SPC_BT709	also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
AVCOL_SPC_UNSPECIFIED
AVCOL_SPC_FCC
AVCOL_SPC_BT470BG	also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
AVCOL_SPC_SMPTE170M	also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
AVCOL_SPC_SMPTE240M
AVCOL_SPC_YCOCG	Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16.
AVCOL_SPC_NB	Not part of ABI.
AVCOL_SPC_RGB
AVCOL_SPC_BT709	also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
AVCOL_SPC_UNSPECIFIED
AVCOL_SPC_FCC
AVCOL_SPC_BT470BG	also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
AVCOL_SPC_SMPTE170M	also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
AVCOL_SPC_SMPTE240M
AVCOL_SPC_YCOCG	Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16.
AVCOL_SPC_NB	Not part of ABI.
AVCOL_SPC_RGB
AVCOL_SPC_BT709	also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
AVCOL_SPC_UNSPECIFIED
AVCOL_SPC_FCC
AVCOL_SPC_BT470BG	also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
AVCOL_SPC_SMPTE170M	also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
AVCOL_SPC_SMPTE240M
AVCOL_SPC_YCOCG	Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16.
AVCOL_SPC_NB	Not part of ABI.

Definition at line 33 of file frame.h.

enum AVColorRange

Enumerator
AVCOL_RANGE_UNSPECIFIED
AVCOL_RANGE_MPEG	the normal 219*2^(n-8) "MPEG" YUV ranges
AVCOL_RANGE_JPEG	the normal 2^n-1 "JPEG" YUV ranges
AVCOL_RANGE_NB	Not part of ABI.
AVCOL_RANGE_UNSPECIFIED
AVCOL_RANGE_MPEG	the normal 219*2^(n-8) "MPEG" YUV ranges
AVCOL_RANGE_JPEG	the normal 2^n-1 "JPEG" YUV ranges
AVCOL_RANGE_NB	Not part of ABI.
AVCOL_RANGE_UNSPECIFIED
AVCOL_RANGE_MPEG	the normal 219*2^(n-8) "MPEG" YUV ranges
AVCOL_RANGE_JPEG	the normal 2^n-1 "JPEG" YUV ranges
AVCOL_RANGE_NB	Not part of ABI.

Definition at line 46 of file frame.h.

enum AVFrameSideDataType

Enumerator
AV_FRAME_DATA_PANSCAN	The data is the AVPanScan struct defined in libavcodec.
AV_FRAME_DATA_PANSCAN	The data is the AVPanScan struct defined in libavcodec.
AV_FRAME_DATA_PANSCAN	The data is the AVPanScan struct defined in libavcodec.

Definition at line 53 of file frame.h.

Function Documentation

int64_t av_frame_get_best_effort_timestamp ( const AVFrame * frame )

Accessors for some AVFrame fields.

The position of these field in the structure is not part of the ABI, they should not be accessed directly outside libavcodec.

void av_frame_set_best_effort_timestamp	(	AVFrame *	frame,
		int64_t	val
	)

int64_t av_frame_get_pkt_duration ( const AVFrame * frame )

void av_frame_set_pkt_duration	(	AVFrame *	frame,
		int64_t	val
	)

int64_t av_frame_get_pkt_pos ( const AVFrame * frame )

void av_frame_set_pkt_pos	(	AVFrame *	frame,
		int64_t	val
	)

int64_t av_frame_get_channel_layout ( const AVFrame * frame )

void av_frame_set_channel_layout	(	AVFrame *	frame,
		int64_t	val
	)

int av_frame_get_channels ( const AVFrame * frame )

void av_frame_set_channels	(	AVFrame *	frame,
		int	val
	)

int av_frame_get_sample_rate ( const AVFrame * frame )

void av_frame_set_sample_rate	(	AVFrame *	frame,
		int	val
	)

AVDictionary* av_frame_get_metadata ( const AVFrame * frame )

void av_frame_set_metadata	(	AVFrame *	frame,
		AVDictionary *	val
	)

int av_frame_get_decode_error_flags ( const AVFrame * frame )

void av_frame_set_decode_error_flags	(	AVFrame *	frame,
		int	val
	)

int av_frame_get_pkt_size ( const AVFrame * frame )

void av_frame_set_pkt_size	(	AVFrame *	frame,
		int	val
	)

AVDictionary** avpriv_frame_get_metadatap ( AVFrame * frame )

Definition at line 47 of file frame.c.

int8_t* av_frame_get_qp_table	(	AVFrame *	f,
		int *	stride,
		int *	type
	)

Definition at line 62 of file frame.c.

int av_frame_set_qp_table	(	AVFrame *	f,
		AVBufferRef *	buf,
		int	stride,
		int	type
	)

Definition at line 49 of file frame.c.

enum AVColorSpace av_frame_get_colorspace ( const AVFrame * frame )

void av_frame_set_colorspace	(	AVFrame *	frame,
		enum AVColorSpace	val
	)

enum AVColorRange av_frame_get_color_range ( const AVFrame * frame )

void av_frame_set_color_range	(	AVFrame *	frame,
		enum AVColorRange	val
	)

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.

Definition at line 73 of file frame.c.

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.

Definition at line 110 of file frame.c.

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.

Definition at line 123 of file frame.c.

int av_frame_ref	(	AVFrame *	dst,
		AVFrame *	src
	)

Setup a new reference to the data described by a given 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.

Returns: 0 on success, a negative AVERROR on error

Definition at line 247 of file frame.c.

AVFrame* av_frame_clone ( 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.

Definition at line 338 of file frame.c.

void av_frame_unref ( AVFrame * frame )

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

Definition at line 351 of file frame.c.

void av_frame_move_ref	(	AVFrame *	dst,
		AVFrame *	src
	)

Move everythnig contained in src to dst and reset src.

Definition at line 373 of file frame.c.

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 channel_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.

Parameters

frame	frame in which to store the new buffers.
align	required buffer size alignment

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

Definition at line 234 of file frame.c.

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()

Definition at line 382 of file frame.c.

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()

Definition at line 399 of file frame.c.

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.

Definition at line 446 of file frame.c.

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.

Definition at line 513 of file frame.c.

AVFrameSideData* av_frame_new_side_data	(	AVFrame *	frame,
		enum AVFrameSideDataType	type,
		int	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

Definition at line 544 of file frame.c.

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.

Definition at line 577 of file frame.c.

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation