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

#include <pixdesc.h>

Data Fields
const char *	name

uint8_t	nb_components
	The number of components each pixel has, (1-4)

uint8_t	log2_chroma_w
	Amount to shift the luma width right to find the chroma width.

uint8_t	log2_chroma_h
	Amount to shift the luma height right to find the chroma height.

uint64_t	flags
	Combination of AV_PIX_FMT_FLAG_... flags.

AVComponentDescriptor	comp [4]
	Parameters that describe how pixels are packed.

const char *	alias
	Alternative comma-separated names.

Detailed Description

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

It also stores the subsampling factors and number of components.

Note: This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV and all the YUV variants) AVPixFmtDescriptor just stores how values are stored not what these values represent.

Definition at line 69 of file pixdesc.h.

Field Documentation

◆ name

const char* AVPixFmtDescriptor::name

Definition at line 70 of file pixdesc.h.

Referenced by av_get_pix_fmt_string(), av_pix_fmt_desc_next(), check_pixfmt_descriptors(), check_semiplanar(), check_xyz12Torgb48le(), check_yuv2rgb(), ffprobe_show_pixel_formats(), filter(), filter(), main(), main(), planarRgb16ToRgb16Wrapper(), print_hwframescontext(), print_link(), Rgb16ToPlanarRgb16Wrapper(), show_pix_fmts(), and transpose_opencl_config_output().

◆ nb_components

uint8_t AVPixFmtDescriptor::nb_components

The number of components each pixel has, (1-4)

Definition at line 71 of file pixdesc.h.

Referenced by apv_decode_tile_component(), av_find_best_pix_fmt_of_2(), av_get_bits_per_pixel(), av_get_padded_bits_per_pixel(), av_get_pix_fmt_string(), check_pixfmt_descriptors(), checkstride(), config_props_output(), cuda_pad_pad(), cuvid_decode_init(), cuvid_output_frame(), ff_ffv1_vk_set_common_sl(), ffprobe_show_pixel_formats(), filter(), filter(), filter(), filter(), filter(), filter_frame(), get_pix_fmt_score(), libjxl_preprocess_stream(), match_pixfmt(), merge_formats_internal(), mov_init(), mov_write_pixi_tag(), mxf_parse_jpeg2000_frame(), mxf_write_jpeg2000_subdesc(), overlay_opencl_load(), pick_format(), planarCopyWrapper(), query_formats(), remap_opencl_load(), show_pix_fmts(), vk_decode_apv_init(), vk_ffv1_end_frame(), X264_frame(), and xfade_opencl_load().

◆ log2_chroma_w

uint8_t AVPixFmtDescriptor::log2_chroma_w

Amount to shift the luma width right to find the chroma width.

For YV12 this is 1 for example. chroma_width = AV_CEIL_RSHIFT(luma_width, log2_chroma_w) The note above is needed to ensure rounding up. This value only refers to the chroma components.

Definition at line 80 of file pixdesc.h.

Referenced by apv_decode_tile_component(), av_get_bits_per_pixel(), av_get_padded_bits_per_pixel(), blockdetect_config_input(), blurdetect_config_input(), bwdif_vulkan_config_output(), check_pixfmt_descriptors(), check_semiplanar(), choose_chroma_location(), compile_single(), config_input(), config_input(), config_input(), config_input(), config_input(), config_input(), config_input_main(), config_input_overlay(), config_output(), config_output(), config_output(), config_output(), config_props(), config_props(), config_props(), config_props(), config_props(), config_props_output(), create_filtergraph(), cuda_pad_pad(), cuvid_decode_init(), draw_horiz_band(), export_film_grain(), ff_dxva2_vp9_fill_picture_parameters(), ff_scale_eval_dimensions(), ff_sws_chroma_pos(), ff_vk_frame_params(), ffprobe_show_pixel_formats(), filter(), filter(), filter(), filter(), filter(), filter_frame(), filter_frame(), fmt_is_subsampled(), get_pix_fmt_score(), init_filter(), libdav1d_receive_frame(), libplacebo_config_output(), match_pixfmt(), mov_write_ftyp_tag(), mxf_write_generic_picture_desc(), nvdec_vp9_start_frame(), overlay_opencl_load(), scale_eval_dimensions(), transpose_opencl_config_output(), vaapi_vp9_start_frame(), vc2_encode_init(), vdpau_vp9_start_frame(), vk_decode_apv_init(), vk_prores_end_frame(), vk_vp9_start_frame(), and X264_frame().

◆ log2_chroma_h

uint8_t AVPixFmtDescriptor::log2_chroma_h

Amount to shift the luma height right to find the chroma height.

For YV12 this is 1 for example. chroma_height= AV_CEIL_RSHIFT(luma_height, log2_chroma_h) The note above is needed to ensure rounding up. This value only refers to the chroma components.

Definition at line 89 of file pixdesc.h.

Referenced by apv_decode_tile_component(), av_get_bits_per_pixel(), av_get_padded_bits_per_pixel(), blockdetect_config_input(), blurdetect_config_input(), bwdif_vulkan_config_output(), check_pixfmt_descriptors(), choose_chroma_location(), compile_single(), config_input(), config_input(), config_input(), config_input(), config_input(), config_input(), config_input(), config_input(), config_input_main(), config_input_overlay(), config_output(), config_output(), config_output(), config_output(), config_props(), config_props(), config_props(), config_props(), config_props(), config_props_output(), create_filtergraph(), cuda_pad_pad(), cuvid_decode_init(), cuvid_output_frame(), draw_horiz_band(), export_film_grain(), ff_dxva2_vp9_fill_picture_parameters(), ff_scale_eval_dimensions(), ff_sws_chroma_pos(), ff_vk_frame_params(), ffprobe_show_pixel_formats(), filter(), filter(), filter(), filter(), filter(), filter_frame(), filter_frame(), filter_frame(), filter_slice(), fmt_is_subsampled(), get_pix_fmt_score(), init_filter(), libdav1d_receive_frame(), libplacebo_config_output(), match_pixfmt(), mov_write_ftyp_tag(), mxf_write_generic_picture_desc(), nvdec_vp9_start_frame(), overlay_opencl_load(), scale_eval_dimensions(), transpose_opencl_config_output(), utvideo_encode_init(), vaapi_vp9_start_frame(), vc2_encode_init(), vdpau_vp9_start_frame(), vk_decode_apv_init(), vk_vp9_start_frame(), and X264_frame().

◆ flags

uint64_t AVPixFmtDescriptor::flags

Combination of AV_PIX_FMT_FLAG_... flags.

Definition at line 94 of file pixdesc.h.

Referenced by amf_encode_init_av1(), amf_encode_init_hevc(), av_get_padded_bits_per_pixel(), check_pixfmt_descriptors(), config_input(), config_input(), config_output(), config_output(), config_props(), config_props(), encode_preinit_video(), ff_filter_frame(), ff_pnm_decode_header(), ffprobe_show_pixel_formats(), filter_frame(), filter_frame(), filter_frame(), filter_frame(), get_pix_fmt_score(), init_decode_shader(), init_filter(), init_filter(), init_filter(), init_video(), is_native_endian(), libjxl_populate_colorspace(), libjxl_preprocess_stream(), main(), match_pixfmt(), merge_formats_internal(), mxf_parse_ffv1_frame(), nvenc_setup_h264_config(), nvenc_setup_hevc_config(), op_pass_setup(), output_frame(), planarRgb16ToRgb16Wrapper(), Rgb16ToPlanarRgb16Wrapper(), show_pix_fmts(), and vtenc_create_encoder().

◆ comp

AVComponentDescriptor AVPixFmtDescriptor::comp[4]

Parameters that describe how pixels are packed.

If the format has 1 or 2 components, then luma is 0. If the format has 3 or 4 components: if the RGB flag is set then 0 is red, 1 is green and 2 is blue; otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V.

If present, the Alpha channel is always the last component.

Definition at line 105 of file pixdesc.h.

Referenced by amf_encode_init_av1(), amf_encode_init_h264(), amf_encode_init_hevc(), av_get_bits_per_pixel(), av_get_padded_bits_per_pixel(), av_image_fill_max_pixsteps(), check_pixfmt_descriptors(), config_input(), config_input(), config_input(), config_out_props(), config_output(), config_output(), config_output(), config_output(), config_props(), config_props(), copy_picture_field(), create_filtergraph(), cuda_pad_pad(), cuvid_decode_init(), decode_slice(), encode_preinit_video(), encode_slice(), ff_attach_decode_data(), ff_dxva2_vp9_fill_picture_parameters(), ff_mjpeg_decode_frame_from_buf(), ff_nvdec_decode_init(), ff_nvdec_frame_params(), ff_sws_init_single_context(), ff_yadif_init_x86(), ffprobe_show_pixel_formats(), filter(), filter(), filter_frame(), filter_frame(), filter_frame(), filter_frame(), filter_slice(), filter_slice(), flip_bayer(), get_pix_fmt_score(), libx265_encode_frame(), match_pixfmt(), mov_write_ftyp_tag(), mov_write_pixi_tag(), mxf_write_generic_picture_desc(), nvdec_vp9_start_frame(), overlay_opencl_load(), planarCopyWrapper(), planarRgb16ToRgb16Wrapper(), planarRgbToplanarRgbWrapper(), planarToP01xWrapper(), pnm_encode_frame(), print_results(), query_formats(), remap_opencl_load(), Rgb16ToPlanarRgb16Wrapper(), rgbToRgbWrapper(), show_pix_fmts(), vc2_encode_init(), vdpau_vp9_start_frame(), X264_frame(), X264_init(), and xfade_opencl_load().

◆ alias

const char* AVPixFmtDescriptor::alias

Alternative comma-separated names.

Definition at line 110 of file pixdesc.h.

Referenced by print_hwframescontext().

The documentation for this struct was generated from the following file:

libavutil/pixdesc.h

Data Fields