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

---

Field Documentation

AVComponentDescriptor AVPixFmtDescriptor::comp[4]

Parameters that describe how pixels are packed.

If the format has chroma components, they must be stored in comp[1] and comp[2].

Definition at line 82 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), ff_fill_linesize(), read_line(), and write_line().

uint8_t AVPixFmtDescriptor::flags

Definition at line 75 of file pixdesc.h.

Referenced by config_props(), ff_fill_linesize(), ff_is_hwaccel_pix_fmt(), read_line(), show_pix_fmts(), start_frame(), and write_line().

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

Referenced by av_get_bits_per_pixel(), av_picture_copy(), av_picture_crop(), av_picture_pad(), avcodec_get_chroma_sub_sample(), avcodec_get_pix_fmt_loss(), avfilter_draw_slice(), avg_bits_per_pixel(), avpicture_layout(), config_input(), config_props(), ff_fill_pointer(), getSubSampleFactors(), 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 65 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(), avg_bits_per_pixel(), avpicture_layout(), ff_fill_linesize(), ff_get_plane_bytewidth(), getSubSampleFactors(), and start_frame().

const char* AVPixFmtDescriptor::name

Definition at line 55 of file pixdesc.h.

Referenced by avcodec_get_pix_fmt_name(), config_props(), dprintf_link(), print_digraph(), show_pix_fmts(), show_stream(), and sws_format_name().

uint8_t AVPixFmtDescriptor::nb_components

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

Definition at line 56 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), and show_pix_fmts().

---

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

• libavutil/pixdesc.h