FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
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.
 
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

const char* AVPixFmtDescriptor::name
uint8_t AVPixFmtDescriptor::nb_components
uint8_t AVPixFmtDescriptor::log2_chroma_w
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 89 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), av_get_padded_bits_per_pixel(), av_image_copy(), av_image_copy_to_buffer(), av_image_fill_pointers(), av_picture_crop(), av_picture_pad(), av_pix_fmt_get_chroma_sub_sample(), avcodec_align_dimensions2(), avcodec_get_chroma_sub_sample(), avpriv_color_frame(), config_input(), config_input_main(), config_input_overlay(), config_input_ref(), config_out_props(), config_output(), config_props(), config_props_output(), copy_picture_field(), encode_init(), ff_check_pixfmt_descriptors(), ff_choose_chroma_location(), ff_draw_horiz_band(), ff_draw_init(), ff_h264_draw_horiz_band(), ff_hevc_decode_nal_sps(), ff_hevc_output_frame(), ff_opencl_deshake_process_inout_buf(), ffprobe_show_pixel_formats(), filter(), filter_frame(), frame_end(), gen_waveform(), geq_config_props(), get_aspect_ratio(), get_buffer_internal(), get_pix_fmt_score(), get_video_buffer(), horizontal_frame_pack(), libopenjpeg_matches_pix_fmt(), mj2_create_image(), opengl_get_plane_pointer(), opengl_init_context(), output_frame(), pix_fmt_match(), query_formats(), shuffleplanes_config_input(), smv_img_pnt(), smvjpeg_decode_frame(), utvideo_encode_init(), verify_md5(), vertical_frame_pack(), video_frame_cksum(), and write_packet().

uint8_t AVPixFmtDescriptor::flags
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 100 of file pixdesc.h.

Referenced by av_get_bits_per_pixel(), av_get_padded_bits_per_pixel(), av_image_copy(), av_image_copy_to_buffer(), av_image_fill_max_pixsteps(), av_image_fill_pointers(), av_pix_fmt_count_planes(), av_read_image_line(), av_write_image_line(), avcodec_string(), avpriv_color_frame(), check_image_pointers(), config_input(), config_input_ref(), config_output(), decode_slice(), encode_frame(), encode_init(), encode_slice(), ff_check_pixfmt_descriptors(), ff_draw_init(), ff_hevc_output_frame(), ff_llviddsp_init_x86(), ff_mjpeg_decode_frame(), ff_sws_init_output_funcs(), ff_yadif_init_x86(), ffprobe_show_pixel_formats(), filter_frame(), filter_slice(), gen_waveform(), get_pix_fmt_depth(), get_pix_fmt_score(), hScale16To15_c(), hScale16To19_c(), is16BPS(), is9_OR_10BPS(), is_planar_yuv(), is_yuv_planar(), libopenjpeg_copy_to_packed16(), libopenjpeg_copyto16(), libopenjpeg_decode_frame(), libopenjpeg_ispacked(), libopenjpeg_matches_pix_fmt(), libx265_encode_frame(), libx265_encode_init(), mj2_create_image(), mxf_write_header(), opengl_get_plane_pointer(), pix_fmt_match(), planarCopyWrapper(), planarRgb16ToRgb16Wrapper(), pnm_encode_frame(), query_formats(), Rgb16ToPlanarRgb16Wrapper(), smv_img_pnt(), sws_init_context(), swscale(), verify_md5(), write_packet(), and yuv2gbrp_full_X_c().

const char* AVPixFmtDescriptor::alias

Alternative comma-separated names.

Definition at line 105 of file pixdesc.h.


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