#include <inttypes.h>
#include "attributes.h"
#include "pixfmt.h"

Data Structures
struct	AVComponentDescriptor

struct	AVPixFmtDescriptor
	Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes of an image. More...

Macros
#define	AV_PIX_FMT_FLAG_BE (1 << 0)
	Pixel format is big-endian.

#define	AV_PIX_FMT_FLAG_PAL (1 << 1)
	Pixel format has a palette in data[1], values are indexes in this palette.

#define	AV_PIX_FMT_FLAG_BITSTREAM (1 << 2)
	All values of a component are bit-wise packed end to end.

#define	AV_PIX_FMT_FLAG_HWACCEL (1 << 3)
	Pixel format is an HW accelerated format.

#define	AV_PIX_FMT_FLAG_PLANAR (1 << 4)
	At least one pixel component is not in the first data plane.

#define	AV_PIX_FMT_FLAG_RGB (1 << 5)
	The pixel format contains RGB-like data (as opposed to YUV/grayscale).

#define	AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6)
	The pixel format is "pseudo-paletted".

#define	AV_PIX_FMT_FLAG_ALPHA (1 << 7)
	The pixel format has an alpha channel.

#define	PIX_FMT_BE AV_PIX_FMT_FLAG_BE

#define	PIX_FMT_PAL AV_PIX_FMT_FLAG_PAL

#define	PIX_FMT_BITSTREAM AV_PIX_FMT_FLAG_BITSTREAM

#define	PIX_FMT_HWACCEL AV_PIX_FMT_FLAG_HWACCEL

#define	PIX_FMT_PLANAR AV_PIX_FMT_FLAG_PLANAR

#define	PIX_FMT_RGB AV_PIX_FMT_FLAG_RGB

#define	PIX_FMT_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL

#define	PIX_FMT_ALPHA AV_PIX_FMT_FLAG_ALPHA

Functions
void	av_read_image_line (uint16_t dst, const uint8_t data[4], const int linesize[4], const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component)
	Read a line from an image, and write the values of the pixel format component c to dst.

void	av_write_image_line (const uint16_t src, uint8_t data[4], const int linesize[4], const AVPixFmtDescriptor *desc, int x, int y, int c, int w)
	Write the values from src to the pixel format component c of an image line.

enum AVPixelFormat	av_get_pix_fmt (const char *name)
	Return the pixel format corresponding to name.

const char *	av_get_pix_fmt_name (enum AVPixelFormat pix_fmt)
	Return the short name for a pixel format, NULL in case pix_fmt is unknown.

char *	av_get_pix_fmt_string (char *buf, int buf_size, enum AVPixelFormat pix_fmt)
	Print in buf the string corresponding to the pixel format with number pix_fmt, or a header if pix_fmt is negative.

int	av_get_bits_per_pixel (const AVPixFmtDescriptor *pixdesc)
	Return the number of bits per pixel used by the pixel format described by pixdesc.

int	av_get_padded_bits_per_pixel (const AVPixFmtDescriptor *pixdesc)
	Return the number of bits per pixel for the pixel format described by pixdesc, including any padding or unused bits.

const AVPixFmtDescriptor *	av_pix_fmt_desc_get (enum AVPixelFormat pix_fmt)

const AVPixFmtDescriptor *	av_pix_fmt_desc_next (const AVPixFmtDescriptor *prev)
	Iterate over all pixel format descriptors known to libavutil.

enum AVPixelFormat	av_pix_fmt_desc_get_id (const AVPixFmtDescriptor *desc)

int	av_pix_fmt_get_chroma_sub_sample (enum AVPixelFormat pix_fmt, int h_shift, int v_shift)
	Utility function to access log2_chroma_w log2_chroma_h from the pixel format AVPixFmtDescriptor.

int	av_pix_fmt_count_planes (enum AVPixelFormat pix_fmt)

void	ff_check_pixfmt_descriptors (void)

enum AVPixelFormat	av_pix_fmt_swap_endianness (enum AVPixelFormat pix_fmt)
	Utility function to swap the endianness of a pixel format.

Variables
attribute_deprecated const AVPixFmtDescriptor	av_pix_fmt_descriptors []
	The array of all the pixel format descriptors.

Macro Definition Documentation

#define AV_PIX_FMT_FLAG_BE (1 << 0)

Pixel format is big-endian.

Definition at line 94 of file pixdesc.h.

Referenced by av_read_image_line(), av_write_image_line(), encode_init(), is_planar_yuv(), isBE(), planarRgb16ToRgb16Wrapper(), query_formats(), raw_decode(), Rgb16ToPlanarRgb16Wrapper(), rgb48Toxyz12(), xwd_encode_frame(), and xyz12Torgb48().

#define AV_PIX_FMT_FLAG_PAL (1 << 1)

Pixel format has a palette in data[1], values are indexes in this palette.

Definition at line 98 of file pixdesc.h.

Referenced by av_image_alloc(), av_image_copy(), av_image_copy_to_buffer(), av_image_fill_pointers(), config_props(), filter_frame(), get_color_type(), get_video_buffer(), pix_fmt_match(), query_formats(), raw_init_decoder(), show_pix_fmts(), smv_img_pnt(), and usePal().

#define AV_PIX_FMT_FLAG_BITSTREAM (1 << 2)

All values of a component are bit-wise packed end to end.

Definition at line 102 of file pixdesc.h.

Referenced by av_get_padded_bits_per_pixel(), av_read_image_line(), av_write_image_line(), ff_check_pixfmt_descriptors(), image_get_linesize(), query_formats(), and show_pix_fmts().

#define AV_PIX_FMT_FLAG_HWACCEL (1 << 3)

Pixel format is an HW accelerated format.

Definition at line 106 of file pixdesc.h.

Referenced by av_image_copy(), av_image_fill_linesizes(), av_image_fill_pointers(), av_image_get_linesize(), create_all_formats(), ff_all_formats(), get_buffer_internal(), get_format(), is_hwaccel_pix_fmt(), main(), query_formats(), show_pix_fmts(), and smv_img_pnt().

#define AV_PIX_FMT_FLAG_PLANAR (1 << 4)

At least one pixel component is not in the first data plane.

Definition at line 110 of file pixdesc.h.

Referenced by avpriv_color_frame(), config_input(), encode_init(), ff_draw_init(), ff_pnm_decode_header(), init(), is_planar_yuv(), is_yuv_planar(), isPackedRGB(), isPlanar(), isPlanarRGB(), isPlanarYUV(), jpeg2000_decode_tile(), opengl_draw(), planarRgb16ToRgb16Wrapper(), query_formats(), Rgb16ToPlanarRgb16Wrapper(), and write_header().

#define AV_PIX_FMT_FLAG_RGB (1 << 5)

The pixel format contains RGB-like data (as opposed to YUV/grayscale).

Definition at line 114 of file pixdesc.h.

Referenced by config_input(), config_props(), encode_init(), ff_draw_color(), ff_draw_init(), filter_frame(), get_color_type(), is_yuv_planar(), isPackedRGB(), isPlanarRGB(), isRGB(), isYUV(), opengl_fill_color_map(), planarRgb16ToRgb16Wrapper(), and Rgb16ToPlanarRgb16Wrapper().

#define AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6)

The pixel format is "pseudo-paletted".

This means that FFmpeg treats it as paletted internally, but the palette is generated by the decoder and is not stored in the file.

Definition at line 120 of file pixdesc.h.

Referenced by av_image_alloc(), av_image_copy(), av_image_fill_pointers(), av_image_get_buffer_size(), config_props(), ff_draw_init(), filter_frame(), get_video_buffer(), raw_decode(), raw_init_decoder(), smv_img_pnt(), and usePal().

#define AV_PIX_FMT_FLAG_ALPHA (1 << 7)

The pixel format has an alpha channel.

Definition at line 124 of file pixdesc.h.

Referenced by config_input(), config_props(), encode_init(), ff_check_pixfmt_descriptors(), ff_draw_init(), ff_merge_formats(), is_planar_yuv(), isALPHA(), opengl_draw(), opengl_fill_color_map(), opengl_init_context(), Rgb16ToPlanarRgb16Wrapper(), and yuv2gbrp_full_X_c().

#define PIX_FMT_BE AV_PIX_FMT_FLAG_BE

Deprecated:: use the AV_PIX_FMT_FLAG_* flags

Definition at line 130 of file pixdesc.h.

#define PIX_FMT_PAL AV_PIX_FMT_FLAG_PAL

Definition at line 131 of file pixdesc.h.

#define PIX_FMT_BITSTREAM AV_PIX_FMT_FLAG_BITSTREAM

Definition at line 132 of file pixdesc.h.

#define PIX_FMT_HWACCEL AV_PIX_FMT_FLAG_HWACCEL

Definition at line 133 of file pixdesc.h.

#define PIX_FMT_PLANAR AV_PIX_FMT_FLAG_PLANAR

Definition at line 134 of file pixdesc.h.

#define PIX_FMT_RGB AV_PIX_FMT_FLAG_RGB

Definition at line 135 of file pixdesc.h.

#define PIX_FMT_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL

Definition at line 136 of file pixdesc.h.

#define PIX_FMT_ALPHA AV_PIX_FMT_FLAG_ALPHA

Definition at line 137 of file pixdesc.h.

Function Documentation

void av_read_image_line	(	uint16_t *	dst,
		const uint8_t *	data[4],
		const int	linesize[4],
		const AVPixFmtDescriptor *	desc,
		int	x,
		int	y,
		int	c,
		int	w,
		int	read_pal_component
	)

Read a line from an image, and write the values of the pixel format component c to dst.

Parameters

data	the array containing the pointers to the planes of the image
linesize	the array containing the linesizes of the image
desc	the pixel format descriptor for the image
x	the horizontal coordinate of the first pixel to read
y	the vertical coordinate of the first pixel to read
w	the width of the line to read, that is the number of values to write to dst
read_pal_component	if not zero and the format is a paletted format writes the values corresponding to the palette component c in data[1] to dst, rather than the palette indexes in data[0]. The behavior is undefined if the format is not paletted.

Definition at line 34 of file pixdesc.c.

Referenced by ff_check_pixfmt_descriptors(), and filter_frame().

void av_write_image_line	(	const uint16_t *	src,
		uint8_t *	data[4],
		const int	linesize[4],
		const AVPixFmtDescriptor *	desc,
		int	x,
		int	y,
		int	c,
		int	w
	)

Write the values from src to the pixel format component c of an image line.

Parameters

src	array containing the values to write
data	the array containing the pointers to the planes of the image to write into. It is supposed to be zeroed.
linesize	the array containing the linesizes of the image
desc	the pixel format descriptor for the image
x	the horizontal coordinate of the first pixel to write
y	the vertical coordinate of the first pixel to write
w	the width of the line to write, that is the number of values to write to the image line

Definition at line 82 of file pixdesc.c.

Referenced by ff_check_pixfmt_descriptors(), and filter_frame().

enum AVPixelFormat av_get_pix_fmt ( const char * name )

Return the pixel format corresponding to name.

If there is no pixel format with name name, then looks for a pixel format with the name corresponding to the native endian format of name. For example in a little-endian system, first looks for "gray16", then for "gray16le".

Finally if no pixel format has been found, returns AV_PIX_FMT_NONE.

Definition at line 1893 of file pixdesc.c.

Referenced by dc1394_read_common(), ff_check_pixfmt_descriptors(), ff_parse_pixel_format(), fileTest(), img_read_header(), main(), new_video_stream(), parse_ffconfig(), rawvideo_read_header(), set_string_pixel_fmt(), and v4l2_read_header().

const char* av_get_pix_fmt_name ( enum AVPixelFormat pix_fmt )

Return the short name for a pixel format, NULL in case pix_fmt is unknown.

See Also: av_get_pix_fmt(), av_get_pix_fmt_string()

Definition at line 1881 of file pixdesc.c.

Referenced by av_opt_get(), avcodec_open2(), avcodec_string(), caca_write_header(), choose_pix_fmts(), choose_pixel_fmt(), config_input_overlay(), config_output(), config_props(), dc1394_read_common(), decode_slice_header(), decode_video(), device_try_init(), dshow_cycle_formats(), dvvideo_encode_init(), event_thread(), fbdev_read_header(), fbdev_write_packet(), ff_dv_print_profiles(), ff_hevc_decode_nal_sps(), ff_scale_image(), ff_tlog_link(), ff_yuv2rgb_get_func_ptr(), ff_yuv2rgb_init_bfin(), init_video(), libopenjpeg_encode_frame(), list_formats(), main(), mj2_create_image(), opengl_compile_shaders(), opt_list(), palToRgbWrapper(), pick_format(), planarRgbToRgbWrapper(), print_link_prop(), reget_buffer_internal(), rgbToPlanarRgbWrapper(), rgbToRgbWrapper(), sdl_write_header(), show_frame(), show_stream(), sws_init_context(), targa_encode_frame(), transcode_init(), video_thread(), write_header(), and xv_write_header().

char* av_get_pix_fmt_string	(	char *	buf,
		int	buf_size,
		enum AVPixelFormat	pix_fmt
	)

Print in buf the string corresponding to the pixel format with number pix_fmt, or a header if pix_fmt is negative.

Parameters

buf	the buffer where to write the string
buf_size	the size of buf
pix_fmt	the number of the pixel format to print the corresponding info string, or a negative value to print the corresponding header.

Definition at line 1945 of file pixdesc.c.

int av_get_bits_per_pixel ( const AVPixFmtDescriptor * pixdesc )

Return the number of bits per pixel used by the pixel format described by pixdesc.

Note that this is not the same as the number of bits per sample.

The returned number of bits refers to the number of bits actually used for storing the pixel information, that is padding bits are not counted.

Definition at line 1912 of file pixdesc.c.

Referenced by av_get_pix_fmt_string(), caca_write_header(), config_input(), config_props(), decode_frame(), encode_frame(), ff_fill_line_with_color(), raw_encode_init(), raw_init_decoder(), show_pix_fmts(), sws_init_context(), sws_setColorspaceDetails(), targa_encode_frame(), and xwd_encode_frame().

int av_get_padded_bits_per_pixel ( const AVPixFmtDescriptor * pixdesc )

Return the number of bits per pixel for the pixel format described by pixdesc, including any padding or unused bits.

Definition at line 1925 of file pixdesc.c.

Referenced by avcodec_find_best_pix_fmt_of_2(), config_input(), config_output(), and lavfi_read_header().

const AVPixFmtDescriptor* av_pix_fmt_desc_get ( enum AVPixelFormat pix_fmt )

Returns: a pixel format descriptor for provided pixel format or NULL if this pixel format is unknown.

Definition at line 1959 of file pixdesc.c.

Referenced by av_image_alloc(), av_image_copy(), av_image_copy_to_buffer(), av_image_fill_linesizes(), av_image_fill_pointers(), av_image_get_buffer_size(), av_image_get_linesize(), av_picture_crop(), av_picture_pad(), av_pix_fmt_count_planes(), av_pix_fmt_get_chroma_sub_sample(), av_pix_fmt_swap_endianness(), avcodec_align_dimensions(), avcodec_find_best_pix_fmt_of_2(), avcodec_get_chroma_sub_sample(), avcodec_string(), avpriv_color_frame(), caca_write_header(), check_image_pointers(), choose_pixel_fmt(), config_input(), config_input_main(), config_input_overlay(), config_input_ref(), config_out_props(), config_output(), config_props(), config_props_output(), copy_picture_field(), create_all_formats(), decode_frame(), decode_slice(), decode_thread(), doTest(), encode_frame(), encode_init(), encode_slice(), ff_all_formats(), ff_draw_horiz_band(), ff_draw_init(), ff_fill_line_with_color(), ff_get_unscaled_swscale(), ff_h264_draw_horiz_band(), ff_hevc_decode_nal_sps(), ff_hevc_output_frame(), ff_llviddsp_init_x86(), ff_merge_formats(), ff_mjpeg_decode_sof(), ff_opencl_deshake_process_inout_buf(), ff_pnm_decode_header(), ff_sws_init_output_funcs(), filter_frame(), frame_end(), geq_config_props(), get_aspect_ratio(), get_buffer_internal(), get_format(), get_pix_fmt_depth(), get_pix_fmt_score(), get_video_buffer(), hScale16To15_c(), hScale16To19_c(), init(), is16BPS(), is9_OR_10BPS(), is_hwaccel_pix_fmt(), isALPHA(), isBE(), isPackedRGB(), isPlanar(), isPlanarRGB(), isPlanarYUV(), isRGB(), isYUV(), jpeg2000_decode_tile(), lavfi_read_header(), libopenjpeg_copy_to_packed16(), libopenjpeg_copyto16(), libopenjpeg_decode_frame(), libopenjpeg_ispacked(), libopenjpeg_matches_pix_fmt(), libx265_encode_frame(), libx265_encode_init(), main(), mj2_create_image(), opengl_draw(), opengl_fill_color_map(), opengl_init_context(), output_frame(), pick_format(), pix_fmt_match(), planarCopyWrapper(), planarRgb16ToRgb16Wrapper(), pnm_encode_frame(), print_digraph(), query_formats(), raw_decode(), raw_encode_init(), raw_init_decoder(), Rgb16ToPlanarRgb16Wrapper(), rgb48Toxyz12(), rgbToRgbWrapper(), selfTest(), smv_img_pnt(), smvjpeg_decode_frame(), sws_format_name(), sws_init_context(), sws_setColorspaceDetails(), swscale(), targa_encode_frame(), usePal(), utvideo_encode_init(), verify_md5(), video_frame_cksum(), video_get_buffer(), write_header(), write_packet(), xwd_encode_frame(), xyz12Torgb48(), and yuv2gbrp_full_X_c().

const AVPixFmtDescriptor* av_pix_fmt_desc_next ( const AVPixFmtDescriptor * prev )

Iterate over all pixel format descriptors known to libavutil.

Parameters

prev	previous descriptor. NULL to get the first descriptor.

Returns: next descriptor or NULL after the last descriptor

Definition at line 1966 of file pixdesc.c.

Referenced by show_pix_fmts().

enum AVPixelFormat av_pix_fmt_desc_get_id ( const AVPixFmtDescriptor * desc )

Returns: an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc is not a valid pointer to a pixel format descriptor.

Definition at line 1978 of file pixdesc.c.

Referenced by show_pix_fmts().

int av_pix_fmt_get_chroma_sub_sample	(	enum AVPixelFormat	pix_fmt,
		int *	h_shift,
		int *	v_shift
	)

Utility function to access log2_chroma_w log2_chroma_h from the pixel format AVPixFmtDescriptor.

See avcodec_get_chroma_sub_sample() for a function that asserts a valid pixel format instead of returning an error code. Its recommanded that you use avcodec_get_chroma_sub_sample unless you do check the return code!

Parameters