AVPixFmtDescriptor Struct Reference

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.

uint8_t flags

AVComponentDescriptor comp [4]

Parameters that describe how pixels are packed.

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

Field Documentation

AVComponentDescriptor AVPixFmtDescriptor::comp[4]

Parameters that describe how pixels are packed.

If the format has 2 or 4 components, then alpha is last. 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.

Definition at line 86 of file pixdesc.h.

Referenced by alloc_buffer(), av_get_bits_per_pixel(), av_image_copy(), av_image_copy_to_buffer(), av_image_fill_max_pixsteps(), av_image_fill_pointers(), av_read_image_line(), av_write_image_line(), check_image_pointers(), config_input(), encode_frame(), end_frame(), ff_draw_init(), filter(), get_pix_fmt_depth(), hScale16To15_c(), hScale16To19_c(), is_yuv_planar(), libopenjpeg_decode_frame(), libopenjpeg_ispacked(), libopenjpeg_matches_pix_fmt(), mj2_create_image(), planarCopyWrapper(), return_frame(), sws_init_context(), and video_get_buffer().

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= -((-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 75 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), av_image_copy(), av_image_copy_to_buffer(), av_image_fill_pointers(), av_picture_crop(), av_picture_pad(), avcodec_get_chroma_sub_sample(), avcodec_get_pix_fmt_loss(), config_input(), config_input_main(), config_out_props(), config_props(), config_props_output(), copy_picture_field(), draw_slice(), end_frame(), ff_draw_horiz_band(), ff_draw_init(), ff_draw_slice(), ff_MPV_frame_end(), filter(), getSubSampleFactors(), libopenjpeg_matches_pix_fmt(), mj2_create_image(), and start_frame().

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 = -((-luma_width) >> log2_chroma_w) The note above is needed to ensure rounding up. This value only refers to the chroma components. chroma_width = -((-luma_width )>>log2_chroma_w)

Definition at line 66 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), av_picture_crop(), av_picture_pad(), avcodec_align_dimensions(), avcodec_get_chroma_sub_sample(), avcodec_get_pix_fmt_loss(), config_input(), config_input_main(), config_props(), config_props_output(), draw_slice(), end_frame(), ff_draw_horiz_band(), ff_draw_init(), ff_fill_line_with_color(), ff_MPV_frame_end(), filter(), getSubSampleFactors(), image_get_linesize(), libopenjpeg_matches_pix_fmt(), mj2_create_image(), and start_frame().

const char* AVPixFmtDescriptor::name

Definition at line 56 of file pixdesc.h.

Referenced by av_get_pix_fmt_name(), av_get_pix_fmt_string(), choose_pixel_fmt(), config_input_overlay(), config_props(), end_frame(), fbdev_read_header(), ff_draw_color(), ff_draw_init(), ff_tlog_link(), init_video(), main(), print_digraph(), and show_pix_fmts().

uint8_t AVPixFmtDescriptor::nb_components

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

Definition at line 57 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), av_get_pix_fmt_string(), av_image_copy(), av_image_copy_to_buffer(), choose_pixel_fmt(), config_props(), copy_picture_field(), decode_frame(), draw_slice(), encode_frame(), ff_draw_init(), filter(), get_pix_fmt_depth(), is_yuv_planar(), libopenjpeg_ispacked(), libopenjpeg_matches_pix_fmt(), mj2_create_image(), pick_format(), and show_pix_fmts().

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

libavutil/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.
uint8_t	flags
AVComponentDescriptor	comp [4]
	Parameters that describe how pixels are packed.