#include <inttypes.h>
#include "attributes.h"
#include "pixfmt.h"
#include "version.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. More...

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

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

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

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

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

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

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

#define	AV_PIX_FMT_FLAG_BAYER (1 << 8)
	The pixel format is following a Bayer pattern. More...

#define	AV_PIX_FMT_FLAG_FLOAT (1 << 9)
	The pixel format contains IEEE-754 floating point values. More...

#define	FF_LOSS_RESOLUTION 0x0001
	loss due to resolution change More...

#define	FF_LOSS_DEPTH 0x0002
	loss due to color depth change More...

#define	FF_LOSS_COLORSPACE 0x0004
	loss due to color space conversion More...

#define	FF_LOSS_ALPHA 0x0008
	loss of alpha bits More...

#define	FF_LOSS_COLORQUANT 0x0010
	loss due to color quantization More...

#define	FF_LOSS_CHROMA 0x0020
	loss of chroma (e.g. More...

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

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

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

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

int	av_pix_fmt_count_planes (enum AVPixelFormat pix_fmt)

const char *	av_color_range_name (enum AVColorRange range)

int	av_color_range_from_name (const char *name)

const char *	av_color_primaries_name (enum AVColorPrimaries primaries)

int	av_color_primaries_from_name (const char *name)

const char *	av_color_transfer_name (enum AVColorTransferCharacteristic transfer)

int	av_color_transfer_from_name (const char *name)

const char *	av_color_space_name (enum AVColorSpace space)

int	av_color_space_from_name (const char *name)

const char *	av_chroma_location_name (enum AVChromaLocation location)

int	av_chroma_location_from_name (const char *name)

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

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

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

void	av_read_image_line2 (void 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, int dst_element_size)
	Read a line from an image, and write the values of the pixel format component c to dst. More...

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)

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

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)

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

int	av_get_pix_fmt_loss (enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt, int has_alpha)
	Compute what kind of losses will occur when converting from one specific pixel format to another. More...

enum AVPixelFormat	av_find_best_pix_fmt_of_2 (enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
	Compute what kind of losses will occur when converting from one specific pixel format to another. More...

Macro Definition Documentation

◆ AV_PIX_FMT_FLAG_BE

#define AV_PIX_FMT_FLAG_BE (1 << 0)

Pixel format is big-endian.

Definition at line 128 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_PAL

#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 132 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_BITSTREAM

#define AV_PIX_FMT_FLAG_BITSTREAM (1 << 2)

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

Definition at line 136 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_HWACCEL

#define AV_PIX_FMT_FLAG_HWACCEL (1 << 3)

Pixel format is an HW accelerated format.

Definition at line 140 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_PLANAR

#define AV_PIX_FMT_FLAG_PLANAR (1 << 4)

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

Definition at line 144 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_RGB

#define AV_PIX_FMT_FLAG_RGB (1 << 5)

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

Definition at line 148 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_PSEUDOPAL

#define AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6)

The pixel format is "pseudo-paletted".

This means that it contains a fixed palette in the 2nd plane but the palette is fixed/constant for each PIX_FMT. This allows interpreting the data as if it was PAL8, which can in some cases be simpler. Or the data can be interpreted purely based on the pixel format without using the palette. An example of a pseudo-paletted format is AV_PIX_FMT_GRAY8

Deprecated:: This flag is deprecated, and will be removed. When it is removed, the extra palette allocation in AVFrame.data[1] is removed as well. Only actual paletted formats (as indicated by AV_PIX_FMT_FLAG_PAL) will have a palette. Starting with FFmpeg versions which have this flag deprecated, the extra "pseudo" palette is already ignored, and API users are not required to allocate a palette for AV_PIX_FMT_FLAG_PSEUDOPAL formats (it was required before the deprecation, though).

Definition at line 166 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_ALPHA

#define AV_PIX_FMT_FLAG_ALPHA (1 << 7)

The pixel format has an alpha channel.

This is set on all formats that support alpha in some way, including AV_PIX_FMT_PAL8. The alpha is always straight, never pre-multiplied.

If a codec or a filter does not support alpha, it should set all alpha to opaque, or use the equivalent pixel formats without alpha component, e.g. AV_PIX_FMT_RGB0 (or AV_PIX_FMT_RGB24 etc.) instead of AV_PIX_FMT_RGBA.

Definition at line 177 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_BAYER

#define AV_PIX_FMT_FLAG_BAYER (1 << 8)

The pixel format is following a Bayer pattern.

Definition at line 182 of file pixdesc.h.

◆ AV_PIX_FMT_FLAG_FLOAT

#define AV_PIX_FMT_FLAG_FLOAT (1 << 9)

The pixel format contains IEEE-754 floating point values.

Precision (double, single, or half) should be determined by the pixel size (64, 32, or 16 bits).

Definition at line 188 of file pixdesc.h.

◆ FF_LOSS_RESOLUTION

#define FF_LOSS_RESOLUTION 0x0001

loss due to resolution change

Definition at line 390 of file pixdesc.h.

◆ FF_LOSS_DEPTH

#define FF_LOSS_DEPTH 0x0002

loss due to color depth change

Definition at line 391 of file pixdesc.h.

◆ FF_LOSS_COLORSPACE

#define FF_LOSS_COLORSPACE 0x0004

loss due to color space conversion

Definition at line 392 of file pixdesc.h.

◆ FF_LOSS_ALPHA

#define FF_LOSS_ALPHA 0x0008

loss of alpha bits

Definition at line 393 of file pixdesc.h.

◆ FF_LOSS_COLORQUANT

#define FF_LOSS_COLORQUANT 0x0010

loss due to color quantization

Definition at line 394 of file pixdesc.h.

◆ FF_LOSS_CHROMA

#define FF_LOSS_CHROMA 0x0020

loss of chroma (e.g.

RGB to gray conversion)

Definition at line 395 of file pixdesc.h.

Function Documentation

◆ av_get_bits_per_pixel()

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 2501 of file pixdesc.c.

Referenced by av_get_pix_fmt_string(), caca_write_header(), config_input(), config_output(), config_props(), decode_frame(), encode_frame(), ff_fill_line_with_color(), ff_guess_coded_bitrate(), ffprobe_show_pixel_formats(), flac_write_picture(), raw_decode(), raw_encode_init(), show_pix_fmts(), sws_init_context(), sws_setColorspaceDetails(), targa_encode_frame(), and xwd_encode_frame().

◆ av_get_padded_bits_per_pixel()

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 2514 of file pixdesc.c.

Referenced by av_find_best_pix_fmt_of_2(), config_input(), config_output(), lavfi_read_header(), and main().

◆ av_pix_fmt_desc_get()

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 2549 of file pixdesc.c.

Referenced by av_find_best_pix_fmt_of_2(), av_frame_apply_cropping(), av_image_alloc(), av_image_copy_to_buffer(), av_image_fill_black(), 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_align_dimensions2(), avcodec_default_get_format(), avcodec_get_chroma_sub_sample(), avcodec_open2(), avcodec_string(), caca_write_header(), check_image_pointers(), choose_pixel_fmt(), config_input(), config_input0(), config_input1(), config_input_main(), config_input_overlay(), config_input_ref(), config_inputx(), config_inputy(), config_out_props(), config_output(), config_props(), config_props_output(), copy_picture_field(), copy_uv_planes(), create_all_formats(), create_filtergraph(), create_frame(), cuvid_decode_init(), cuvid_output_frame(), decode(), decode_frame(), decode_slice(), deshake_opencl_init(), doTest(), draw_horiz_band(), encode_frame(), encode_init(), encode_slice(), ff_boxblur_eval_filter_params(), ff_choose_chroma_location(), ff_color_frame(), ff_draw_horiz_band(), ff_draw_init(), ff_draw_supported_pixel_formats(), ff_fill_line_with_color(), ff_formats_pixdesc_filter(), ff_frame_pool_get(), ff_frame_pool_video_init(), ff_get_format(), ff_get_unscaled_swscale(), ff_guess_coded_bitrate(), ff_h264_draw_horiz_band(), ff_huffyuvdsp_init_x86(), ff_huffyuvencdsp_init_x86(), ff_merge_formats(), ff_mjpeg_decode_frame(), ff_mjpeg_decode_sof(), ff_nvdec_decode_init(), ff_nvdec_frame_params(), ff_parse_pixel_format(), ff_pnm_decode_header(), ff_scale_eval_dimensions(), ff_sws_alphablendaway(), ff_sws_init_output_funcs(), ff_vk_shader_rep_fmt(), ff_vmafmotion_init(), fill_frameinfo_by_link(), fill_picture_parameters(), filter_frame(), flac_write_picture(), frame_end(), geq_config_props(), get_aspect_ratio(), get_bit_depth(), get_deinterleaved_format(), get_format(), get_pix_fmt_depth(), get_pix_fmt_score(), get_video_buffer(), have_alpha_planar(), hScale16To15_c(), hScale16To19_c(), hwmap_config_output(), image_copy(), image_copy_16_to_8(), init(), init_filter(), init_image(), init_output_stream_encode(), init_video_param(), init_video_param_jpeg(), is16BPS(), is32BPS(), is_native_endian(), isALPHA(), isAnyRGB(), isBayer(), isBE(), isFloat(), isGray(), isNBPS(), isPacked(), isPackedRGB(), isPlanar(), isPlanarRGB(), isPlanarYUV(), isRGB(), isSemiPlanarYUV(), isYUV(), lavfi_read_header(), libopenjpeg_copy_to_packed16(), libopenjpeg_copyto16(), libopenjpeg_decode_frame(), libopenjpeg_ispacked(), libopenjpeg_matches_pix_fmt(), librav1e_encode_init(), librav1e_send_frame(), libx265_encode_frame(), libx265_encode_init(), lut2_config_output(), main(), map_pixel_format(), mj2_create_image(), mxf_write_header(), nlmeans_opencl_filter_frame(), nvdec_vp9_start_frame(), opencl_get_plane_format(), opengl_draw(), opengl_fill_color_map(), opengl_init_context(), overlay_opencl_load(), pad_opencl_init(), pick_format(), pix_fmt_match(), planarCopyWrapper(), planarRgb16ToRgb16Wrapper(), planarToP01xWrapper(), pnm_encode_frame(), prepare_sws_context(), print_digraph(), qsv_init_surface(), qsv_map_from(), query_formats(), raw_decode(), raw_encode_init(), raw_init_decoder(), read_packet_vs(), Rgb16ToPlanarRgb16Wrapper(), rgb48Toxyz12(), rgbToRgbWrapper(), scale_eval_dimensions(), scale_frame(), selfTest(), smv_img_pnt(), smvjpeg_decode_frame(), sws_init_context(), sws_setColorspaceDetails(), swscale(), targa_encode_frame(), tiff_unpack_strip(), transfer_image_buf(), transpose_opencl_config_output(), unsharp_opencl_make_filter_params(), utvideo_encode_init(), v4l2_buffer_swframe_to_buf(), v4l2_encode_init(), vaapi_encode_h265_init_sequence_params(), vaapi_encode_mjpeg_init_picture_params(), vaapi_encode_profile_entrypoint(), vaapi_vp9_start_frame(), vaapi_vpp_frame_is_rgb(), validate_avframe_allocation(), vc2_encode_init(), vdpau_vp9_start_frame(), verify_md5(), video_frame_cksum(), video_get_buffer(), write_header(), write_packet(), X264_init(), xfade_opencl_load(), xwd_encode_frame(), xyz12Torgb48(), yuv2gbrp16_full_X_c(), yuv2gbrp_full_X_c(), and yuv2gbrpf32_full_X_c().

◆ av_pix_fmt_desc_next()

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 2556 of file pixdesc.c.

Referenced by ff_all_formats(), ffprobe_show_pixel_formats(), init(), main(), match_pixfmt(), query_formats(), and show_pix_fmts().

◆ av_pix_fmt_desc_get_id()

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 2568 of file pixdesc.c.

Referenced by ff_all_formats(), init(), main(), match_pixfmt(), query_formats(), and show_pix_fmts().

◆ av_pix_fmt_get_chroma_sub_sample()

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.

Parameters

[in]	pix_fmt	the pixel format
[out]	h_shift	store log2_chroma_w (horizontal/width shift)
[out]	v_shift	store log2_chroma_h (vertical/height shift)

Returns: 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format

Definition at line 2577 of file pixdesc.c.

Referenced by alloc_buffers(), alloc_picture(), cuda_frames_init(), decode_frame(), decode_init(), dirac_decode_data_unit(), encode_frame(), encode_init(), ff_mjpeg_decode_frame(), ff_mjpeg_init_hvsample(), ff_mpv_common_frame_size_change(), ff_mpv_common_init(), ff_mpv_frame_start(), ff_print_debug_info2(), get_buffer_with_edge(), get_vpx_chroma_subsampling(), gray_frame(), h264_slice_header_init(), init_stage(), j2kenc_init(), load_input_picture(), map_chroma_format(), mjpeg_decode_scan(), nvdec_retrieve_data(), sws_init_context(), vc2_encode_init(), vp3_decode_init(), and yuv4_write_packet().

◆ av_pix_fmt_count_planes()

int av_pix_fmt_count_planes ( enum AVPixelFormat pix_fmt )

Returns: number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a valid pixel format.

Definition at line 2589 of file pixdesc.c.

Referenced by alloc_bind_mem(), alloc_buffers(), alloc_frame_buffer(), av_image_fill_black(), cfhd_decode(), config_input(), config_input0(), config_input1(), config_inputx(), config_inputy(), config_output(), config_props(), config_props_output(), create_frame(), dxva2_map_frame(), ff_mjpeg_decode_frame(), ff_vk_add_exec_dep(), frame_copy_video(), get_deinterleaved_format(), init(), init_filter(), lut2_config_output(), magy_decode_frame(), magy_encode_init(), match_pixfmt(), oscilloscope_config_input(), pixfmt_is_supported(), pixscope_config_input(), prepare_frame(), process_frames(), query_formats(), shuffleplanes_config_input(), transfer_image_buf(), validate_avframe_allocation(), vulkan_frame_free(), vulkan_free_internal(), vulkan_map_frame_to_mem(), vulkan_pool_alloc(), and vulkan_unmap_frame().

◆ av_color_range_name()

const char* av_color_range_name ( enum AVColorRange range )

Returns: the name for provided color range or NULL if unknown.

Definition at line 2875 of file pixdesc.c.

Referenced by avcodec_string(), create_filtergraph(), dump_color_property(), get_cv_pixel_info(), print_color_range(), tonemap_opencl_init(), and vaapi_vpp_fill_colour_properties().

◆ av_color_range_from_name()

int av_color_range_from_name ( const char * name )

Returns: the AVColorRange value for name or an AVError if not found.

Definition at line 2881 of file pixdesc.c.

◆ av_color_primaries_name()

const char* av_color_primaries_name ( enum AVColorPrimaries primaries )

Returns: the name for provided color primaries or NULL if unknown.

Definition at line 2894 of file pixdesc.c.

Referenced by avcodec_string(), create_filtergraph(), decode_vui(), decode_vui_parameters(), dump_color_property(), get_cv_color_primaries(), mov_read_colr(), mov_read_vpcc(), print_primaries(), tonemap_opencl_init(), and vaapi_vpp_fill_colour_properties().

◆ av_color_primaries_from_name()

int av_color_primaries_from_name ( const char * name )

Returns: the AVColorPrimaries value for name or an AVError if not found.

Definition at line 2900 of file pixdesc.c.

◆ av_color_transfer_name()

const char* av_color_transfer_name ( enum AVColorTransferCharacteristic transfer )

Returns: the name for provided color transfer or NULL if unknown.

Definition at line 2918 of file pixdesc.c.

Referenced by avcodec_string(), create_filtergraph(), decode_vui(), decode_vui_parameters(), dump_color_property(), export_stream_params(), get_cv_transfer_function(), h264_init_ps(), mov_read_colr(), mov_read_vpcc(), print_color_trc(), tonemap_opencl_init(), and vaapi_vpp_fill_colour_properties().

◆ av_color_transfer_from_name()

int av_color_transfer_from_name ( const char * name )

Returns: the AVColorTransferCharacteristic value for name or an AVError if not found.

Definition at line 2924 of file pixdesc.c.

◆ av_color_space_name()

const char* av_color_space_name ( enum AVColorSpace space )

Returns: the name for provided color space or NULL if unknown.

Definition at line 2942 of file pixdesc.c.

Referenced by avcodec_string(), create_filtergraph(), decode_vui(), decode_vui_parameters(), dump_color_property(), filter_frame(), get_cv_ycbcr_matrix(), mov_read_colr(), mov_read_vpcc(), print_color_space(), tonemap_opencl_init(), and vaapi_vpp_fill_colour_properties().

◆ av_color_space_from_name()

int av_color_space_from_name ( const char * name )

Returns: the AVColorSpace value for name or an AVError if not found.

Definition at line 2948 of file pixdesc.c.

◆ av_chroma_location_name()

const char* av_chroma_location_name ( enum AVChromaLocation location )

Returns: the name for provided chroma location or NULL if unknown.

Definition at line 2966 of file pixdesc.c.

Referenced by avcodec_string(), print_chroma_location(), and vaapi_vpp_fill_colour_properties().

◆ av_chroma_location_from_name()

int av_chroma_location_from_name ( const char * name )

Returns: the AVChromaLocation value for name or an AVError if not found.

Definition at line 2972 of file pixdesc.c.

◆ av_get_pix_fmt()

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 2477 of file pixdesc.c.

Referenced by add_input_streams(), dc1394_read_common(), ff_check_pixfmt_descriptors(), ff_img_read_header(), ff_parse_pixel_format(), fileTest(), main(), new_video_stream(), nppscale_init(), qsvscale_init(), rawvideo_read_header(), scale_vaapi_init(), scale_vulkan_config_output(), set_string_pixel_fmt(), tonemap_vaapi_init(), v4l2_read_header(), and vpp_init().

◆ av_get_pix_fmt_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.

See also: av_get_pix_fmt(), av_get_pix_fmt_string()

Definition at line 2465 of file pixdesc.c.

Referenced by add_video_device(), amf_init_context(), amf_init_encoder(), av_hwframe_ctx_init(), av_opt_get(), avcodec_open2(), avcodec_string(), avgblur_opencl_filter_frame(), avi_write_header(), caca_write_header(), check_modelinput_inlink(), choose_pix_fmts(), choose_pixel_fmt(), config_input_overlay(), config_main_input(), config_output(), config_overlay_input(), config_props(), convolution_opencl_filter_frame(), create_filtergraph(), cuda_frames_init(), d3d11va_frames_init(), dc1394_read_common(), decode_frame_header(), deint_vaapi_filter_frame(), device_try_init(), dnxhd_decode_frame(), draw_items(), dshow_cycle_formats(), dvvideo_encode_init(), dxva2_init_pool(), fbdev_read_header(), fbdev_write_packet(), ff_attributes_dump(), ff_hevc_decode_nal_sps(), ff_opencl_filter_work_size_from_image(), ff_scale_image(), ff_tlog_link(), ff_vaapi_vpp_config_output(), ff_yuv2rgb_get_func_ptr(), get_cv_pixel_info(), h264_init_ps(), handle_p_frame_apng(), hw_device_setup_for_encode(), hwaccel_init(), hwdownload_config_output(), hwmap_config_output(), hwmap_filter_frame(), hwupload_config_output(), init_processing_chain(), init_video(), kmsgrab_read_header(), libkvazaar_encode(), libopenjpeg_encode_frame(), list_formats(), main(), misc_vaapi_filter_frame(), mj2_create_image(), mov_get_rawvideo_codec_tag(), movie_push_frame(), neighbor_opencl_filter_frame(), nlmeans_opencl_filter_frame(), nvenc_alloc_surface(), nvenc_register_frame(), opencl_frames_get_constraints(), opengl_compile_shaders(), opt_list(), output_video_frame(), overlay_cuda_config_output(), overlay_opencl_blend(), palToRgbWrapper(), pick_format(), planarRgbaToRgbWrapper(), planarRgbToRgbWrapper(), print_link_prop(), procamp_vaapi_filter_frame(), program_opencl_run(), read_header_vs(), reget_buffer_internal(), rgbToPlanarRgbWrapper(), rgbToRgbWrapper(), scale_vaapi_filter_frame(), sdl2_write_header(), show_frame(), show_stream(), sws_init_context(), targa_encode_frame(), tonemap_opencl_filter_frame(), tonemap_vaapi_filter_frame(), transpose_opencl_filter_frame(), transpose_vaapi_filter_frame(), unsharp_opencl_filter_frame(), vaapi_decode_find_best_format(), vaapi_device_init(), vaapi_encode_create_recon_frames(), vaapi_frames_init(), vdpau_frames_init(), vdpau_transfer_data_from(), vdpau_transfer_data_to(), video_get_buffer(), video_thread(), vulkan_map_frame_to_mem(), write_header(), xv_write_header(), yuv4_write_header(), and yuv4_write_packet().

◆ av_get_pix_fmt_string()

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 2534 of file pixdesc.c.

◆ av_read_image_line2()

void av_read_image_line2	(	void *	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,
		int	dst_element_size
	)

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.
dst_element_size	size of elements in dst array (2 or 4 byte)

Definition at line 34 of file pixdesc.c.

Referenced by av_read_image_line(), and filter_frame().

◆ av_read_image_line()

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
	)

Definition at line 90 of file pixdesc.c.

Referenced by ff_check_pixfmt_descriptors().

◆ av_write_image_line2()

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

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
src_element_size	size of elements in src array (2 or 4 byte)

Definition at line 101 of file pixdesc.c.

Referenced by av_write_image_line(), and filter_frame().

◆ av_write_image_line()

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
	)

Definition at line 162 of file pixdesc.c.

Referenced by av_image_fill_black(), and ff_check_pixfmt_descriptors().

◆ av_pix_fmt_swap_endianness()

enum AVPixelFormat av_pix_fmt_swap_endianness ( enum AVPixelFormat pix_fmt )

Utility function to swap the endianness of a pixel format.

Parameters

[in] pix_fmt the pixel format

Returns: pixel format with swapped endianness if it exists, otherwise AV_PIX_FMT_NONE

Definition at line 2645 of file pixdesc.c.

Referenced by is_native_endian(), and sws_init_context().

◆ av_get_pix_fmt_loss()

int av_get_pix_fmt_loss	(	enum AVPixelFormat	dst_pix_fmt,
		enum AVPixelFormat	src_pix_fmt,
		int	has_alpha
	)

Compute what kind of losses will occur when converting from one specific pixel format to another.

When converting from one pixel format to another, information loss may occur. For example, when converting from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when converting from some formats to other formats. These losses can involve loss of chroma, but also loss of resolution, loss of color depth, loss due to the color space conversion, loss of the alpha bits or loss due to color quantization. av_get_fix_fmt_loss() informs you about the various types of losses which will occur when converting from one pixel format to another.

Parameters

[in]	dst_pix_fmt	destination pixel format
[in]	src_pix_fmt	source pixel format
[in]	has_alpha	Whether the source pixel format alpha channel is used.

Returns: Combination of flags informing you what kind of losses will occur (maximum loss for an invalid dst_pix_fmt).

Definition at line 2827 of file pixdesc.c.

Referenced by av_find_best_pix_fmt_of_2(), and avcodec_get_pix_fmt_loss().

◆ av_find_best_pix_fmt_of_2()

enum AVPixelFormat av_find_best_pix_fmt_of_2	(	enum AVPixelFormat	dst_pix_fmt1,
		enum AVPixelFormat	dst_pix_fmt2,
		enum AVPixelFormat	src_pix_fmt,
		int	has_alpha,
		int *	loss_ptr
	)

Compute what kind of losses will occur when converting from one specific pixel format to another.

When converting from one pixel format to another, information loss may occur. For example, when converting from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when converting from some formats to other formats. These losses can involve loss of chroma, but also loss of resolution, loss of color depth, loss due to the color space conversion, loss of the alpha bits or loss due to color quantization. av_get_fix_fmt_loss() informs you about the various types of losses which will occur when converting from one pixel format to another.

Parameters

[in]	dst_pix_fmt	destination pixel format
[in]	src_pix_fmt	source pixel format
[in]	has_alpha	Whether the source pixel format alpha channel is used.

Returns: Combination of flags informing you what kind of losses will occur (maximum loss for an invalid dst_pix_fmt).

Definition at line 2838 of file pixdesc.c.

Referenced by avcodec_find_best_pix_fmt_of_2(), find_best(), pick_format(), and vaapi_decode_find_best_format().

Data Structures

Macros

Functions

Macro Definition Documentation

◆ AV_PIX_FMT_FLAG_BE

◆ AV_PIX_FMT_FLAG_PAL

◆ AV_PIX_FMT_FLAG_BITSTREAM

◆ AV_PIX_FMT_FLAG_HWACCEL

◆ AV_PIX_FMT_FLAG_PLANAR

◆ AV_PIX_FMT_FLAG_RGB

◆ AV_PIX_FMT_FLAG_PSEUDOPAL

◆ AV_PIX_FMT_FLAG_ALPHA

◆ AV_PIX_FMT_FLAG_BAYER

◆ AV_PIX_FMT_FLAG_FLOAT

◆ FF_LOSS_RESOLUTION

◆ FF_LOSS_DEPTH

◆ FF_LOSS_COLORSPACE

◆ FF_LOSS_ALPHA

◆ FF_LOSS_COLORQUANT

◆ FF_LOSS_CHROMA

Function Documentation

◆ av_get_bits_per_pixel()

◆ av_get_padded_bits_per_pixel()

◆ av_pix_fmt_desc_get()

◆ av_pix_fmt_desc_next()

◆ av_pix_fmt_desc_get_id()

◆ av_pix_fmt_get_chroma_sub_sample()

◆ av_pix_fmt_count_planes()

◆ av_color_range_name()

◆ av_color_range_from_name()

◆ av_color_primaries_name()

◆ av_color_primaries_from_name()

◆ av_color_transfer_name()

◆ av_color_transfer_from_name()

◆ av_color_space_name()

◆ av_color_space_from_name()

◆ av_chroma_location_name()

◆ av_chroma_location_from_name()

◆ av_get_pix_fmt()

◆ av_get_pix_fmt_name()

◆ av_get_pix_fmt_string()

◆ av_read_image_line2()

◆ av_read_image_line()

◆ av_write_image_line2()

◆ av_write_image_line()

◆ av_pix_fmt_swap_endianness()

◆ av_get_pix_fmt_loss()

◆ av_find_best_pix_fmt_of_2()