FFmpeg
Macros | Functions | Variables
pixdesc.c File Reference
#include <stdio.h>
#include <string.h>
#include "avassert.h"
#include "avstring.h"
#include "common.h"
#include "pixfmt.h"
#include "pixdesc.h"
#include "internal.h"
#include "intreadwrite.h"
#include "version.h"

Go to the source code of this file.

Macros

#define BAYER8_DESC_COMMON
 
#define BAYER16_DESC_COMMON
 
#define X_NE(be, le)   le
 
#define FF_COLOR_NA   -1
 
#define FF_COLOR_RGB   0
 RGB color space. More...
 
#define FF_COLOR_GRAY   1
 gray color space More...
 
#define FF_COLOR_YUV   2
 YUV color space. More...
 
#define FF_COLOR_YUV_JPEG   3
 YUV color space. More...
 
#define FF_COLOR_XYZ   4
 
#define pixdesc_has_alpha(pixdesc)   ((pixdesc)->flags & AV_PIX_FMT_FLAG_ALPHA)
 

Functions

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)
 
static enum AVPixelFormat get_pix_fmt_internal (const char *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. More...
 
enum AVPixelFormat av_get_pix_fmt (const char *name)
 Return the pixel format corresponding to name. More...
 
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...
 
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...
 
const AVPixFmtDescriptorav_pix_fmt_desc_get (enum AVPixelFormat pix_fmt)
 
const AVPixFmtDescriptorav_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)
 
void ff_check_pixfmt_descriptors (void)
 
enum AVPixelFormat av_pix_fmt_swap_endianness (enum AVPixelFormat pix_fmt)
 Utility function to swap the endianness of a pixel format. More...
 
static int get_color_type (const AVPixFmtDescriptor *desc)
 
static int get_pix_fmt_depth (int *min, int *max, enum AVPixelFormat pix_fmt)
 
static int get_pix_fmt_score (enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt, unsigned *lossp, unsigned consider)
 
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...
 
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)
 

Variables

static const FF_DISABLE_DEPRECATION_WARNINGS AVPixFmtDescriptor av_pix_fmt_descriptors [AV_PIX_FMT_NB]
 
static const FF_ENABLE_DEPRECATION_WARNINGS char *const color_range_names []
 
static const char *const color_primaries_names [AVCOL_PRI_NB]
 
static const char *const color_transfer_names []
 
static const char *const color_space_names []
 
static const char *const chroma_location_names []
 

Macro Definition Documentation

◆ BAYER8_DESC_COMMON

#define BAYER8_DESC_COMMON
Value:
.nb_components= 3, \
.log2_chroma_w= 0, \
.log2_chroma_h= 0, \
.comp = { \
{0,1,0,0,2,0,1,1},\
{0,1,0,0,4,0,3,1},\
{0,1,0,0,2,0,1,1},\
}, \

◆ BAYER16_DESC_COMMON

#define BAYER16_DESC_COMMON
Value:
.nb_components= 3, \
.log2_chroma_w= 0, \
.log2_chroma_h= 0, \
.comp = { \
{0,2,0,0,4,1,3,1},\
{0,2,0,0,8,1,7,1},\
{0,2,0,0,4,1,3,1},\
}, \

◆ X_NE

#define X_NE (   be,
  le 
)    le

Definition at line 2447 of file pixdesc.c.

◆ FF_COLOR_NA

#define FF_COLOR_NA   -1

Definition at line 2636 of file pixdesc.c.

◆ FF_COLOR_RGB

#define FF_COLOR_RGB   0

RGB color space.

Definition at line 2637 of file pixdesc.c.

◆ FF_COLOR_GRAY

#define FF_COLOR_GRAY   1

gray color space

Definition at line 2638 of file pixdesc.c.

◆ FF_COLOR_YUV

#define FF_COLOR_YUV   2

YUV color space.

16 <= Y <= 235, 16 <= U, V <= 240

Definition at line 2639 of file pixdesc.c.

◆ FF_COLOR_YUV_JPEG

#define FF_COLOR_YUV_JPEG   3

YUV color space.

0 <= Y <= 255, 0 <= U, V <= 255

Definition at line 2640 of file pixdesc.c.

◆ FF_COLOR_XYZ

#define FF_COLOR_XYZ   4

Definition at line 2641 of file pixdesc.c.

◆ pixdesc_has_alpha

#define pixdesc_has_alpha (   pixdesc)    ((pixdesc)->flags & AV_PIX_FMT_FLAG_ALPHA)

Definition at line 2643 of file pixdesc.c.

Function Documentation

◆ 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
datathe array containing the pointers to the planes of the image
linesizethe array containing the linesizes of the image
descthe pixel format descriptor for the image
xthe horizontal coordinate of the first pixel to read
ythe vertical coordinate of the first pixel to read
wthe width of the line to read, that is the number of values to write to dst
read_pal_componentif 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_sizesize 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
srcarray containing the values to write
datathe array containing the pointers to the planes of the image to write into. It is supposed to be zeroed.
linesizethe array containing the linesizes of the image
descthe pixel format descriptor for the image
xthe horizontal coordinate of the first pixel to write
ythe vertical coordinate of the first pixel to write
wthe width of the line to write, that is the number of values to write to the image line
src_element_sizesize 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().

◆ get_pix_fmt_internal()

static enum AVPixelFormat get_pix_fmt_internal ( const char *  name)
static

Definition at line 2425 of file pixdesc.c.

Referenced by av_get_pix_fmt(), and av_pix_fmt_swap_endianness().

◆ 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()
Examples
demuxing_decoding.c, and scaling_video.c.

Definition at line 2438 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(), 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(), cuvid_init(), d3d11va_frames_init(), dc1394_read_common(), decode_frame_header(), decode_packet(), 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_hevc_decode_nal_sps(), ff_opencl_filter_work_size_from_image(), ff_qsv_process_data(), 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(), 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(), 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(), 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(), write_header(), xv_write_header(), yuv4_write_header(), and yuv4_write_packet().

◆ 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 2450 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(), set_string_pixel_fmt(), v4l2_read_header(), and vpp_init().

◆ 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 2474 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 2487 of file pixdesc.c.

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

◆ 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
bufthe buffer where to write the string
buf_sizethe size of buf
pix_fmtthe number of the pixel format to print the corresponding info string, or a negative value to print the corresponding header.

Definition at line 2507 of file pixdesc.c.

◆ 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 2522 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(), create_all_formats(), create_filtergraph(), cuvid_decode_init(), cuvid_output_frame(), decode(), decode_frame(), decode_slice(), 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_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_qsv_process_data(), ff_scale_eval_dimensions(), ff_sws_alphablendaway(), ff_sws_init_output_funcs(), 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_image(), init_output_stream_encode(), init_video_param(), init_video_param_jpeg(), is16BPS(), 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(), 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(), pick_format(), pix_fmt_match(), planarCopyWrapper(), planarRgb16ToRgb16Wrapper(), planarToP01xWrapper(), pnm_encode_frame(), print_digraph(), qsv_decode_init(), qsv_init_surface(), qsv_map_from(), query_formats(), raw_decode(), raw_encode_init(), raw_init_decoder(), read_packet_vs(), Rgb16ToPlanarRgb16Wrapper(), rgb48Toxyz12(), rgbToRgbWrapper(), selfTest(), shuffleplanes_config_input(), smv_img_pnt(), smvjpeg_decode_frame(), sws_init_context(), sws_setColorspaceDetails(), swscale(), targa_encode_frame(), tiff_unpack_strip(), transpose_opencl_config_output(), unsharp_opencl_make_filter_params(), utvideo_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(), verify_md5(), video_frame_cksum(), video_get_buffer(), write_header(), write_packet(), X264_init(), xwd_encode_frame(), xyz12Torgb48(), yuv2gbrp16_full_X_c(), and yuv2gbrp_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
prevprevious descriptor. NULL to get the first descriptor.
Returns
next descriptor or NULL after the last descriptor

Definition at line 2529 of file pixdesc.c.

Referenced by ff_all_formats(), ffprobe_show_pixel_formats(), hwdownload_query_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 2541 of file pixdesc.c.

Referenced by ff_all_formats(), hwdownload_query_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_fmtthe pixel format
[out]h_shiftstore log2_chroma_w (horizontal/width shift)
[out]v_shiftstore log2_chroma_h (vertical/height shift)
Returns
0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format

Definition at line 2550 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)

◆ ff_check_pixfmt_descriptors()

void ff_check_pixfmt_descriptors ( void  )

Definition at line 2577 of file pixdesc.c.

Referenced by main().

◆ 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_fmtthe pixel format
Returns
pixel format with swapped endianness if it exists, otherwise AV_PIX_FMT_NONE

Definition at line 2618 of file pixdesc.c.

Referenced by is_native_endian(), and sws_init_context().

◆ get_color_type()

static int get_color_type ( const AVPixFmtDescriptor desc)
static

Definition at line 2647 of file pixdesc.c.

Referenced by get_pix_fmt_score(), and main().

◆ get_pix_fmt_depth()

static int get_pix_fmt_depth ( int min,
int max,
enum AVPixelFormat  pix_fmt 
)
static

Definition at line 2669 of file pixdesc.c.

Referenced by get_pix_fmt_score().

◆ get_pix_fmt_score()

static int get_pix_fmt_score ( enum AVPixelFormat  dst_pix_fmt,
enum AVPixelFormat  src_pix_fmt,
unsigned *  lossp,
unsigned  consider 
)
static

Definition at line 2687 of file pixdesc.c.

Referenced by av_find_best_pix_fmt_of_2(), and av_get_pix_fmt_loss().

◆ 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_fmtdestination pixel format
[in]src_pix_fmtsource pixel format
[in]has_alphaWhether 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 2800 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_fmtdestination pixel format
[in]src_pix_fmtsource pixel format
[in]has_alphaWhether 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 2811 of file pixdesc.c.

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

◆ 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 2848 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 2854 of file pixdesc.c.

◆ av_color_primaries_name()

const char* av_color_primaries_name ( enum AVColorPrimaries  primaries)

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

◆ av_color_transfer_name()

const char* av_color_transfer_name ( enum AVColorTransferCharacteristic  transfer)

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

◆ av_color_space_name()

const char* av_color_space_name ( enum AVColorSpace  space)

◆ 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 2921 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 2939 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 2945 of file pixdesc.c.

Variable Documentation

◆ av_pix_fmt_descriptors

◆ color_range_names

const FF_ENABLE_DEPRECATION_WARNINGS char* const color_range_names[]
static
Initial value:
= {
[AVCOL_RANGE_UNSPECIFIED] = "unknown",
[AVCOL_RANGE_MPEG] = "tv",
[AVCOL_RANGE_JPEG] = "pc",
}

Definition at line 2352 of file pixdesc.c.

Referenced by av_color_range_from_name(), and av_color_range_name().

◆ color_primaries_names

const char* const color_primaries_names[AVCOL_PRI_NB]
static
Initial value:
= {
[AVCOL_PRI_RESERVED0] = "reserved",
[AVCOL_PRI_BT709] = "bt709",
[AVCOL_PRI_UNSPECIFIED] = "unknown",
[AVCOL_PRI_RESERVED] = "reserved",
[AVCOL_PRI_BT470M] = "bt470m",
[AVCOL_PRI_BT470BG] = "bt470bg",
[AVCOL_PRI_SMPTE170M] = "smpte170m",
[AVCOL_PRI_SMPTE240M] = "smpte240m",
[AVCOL_PRI_FILM] = "film",
[AVCOL_PRI_BT2020] = "bt2020",
[AVCOL_PRI_SMPTE428] = "smpte428",
[AVCOL_PRI_SMPTE431] = "smpte431",
[AVCOL_PRI_SMPTE432] = "smpte432",
[AVCOL_PRI_JEDEC_P22] = "jedec-p22",
}

Definition at line 2358 of file pixdesc.c.

Referenced by av_color_primaries_from_name(), and av_color_primaries_name().

◆ color_transfer_names

const char* const color_transfer_names[]
static
Initial value:
= {
[AVCOL_TRC_RESERVED0] = "reserved",
[AVCOL_TRC_BT709] = "bt709",
[AVCOL_TRC_UNSPECIFIED] = "unknown",
[AVCOL_TRC_RESERVED] = "reserved",
[AVCOL_TRC_GAMMA22] = "bt470m",
[AVCOL_TRC_GAMMA28] = "bt470bg",
[AVCOL_TRC_SMPTE170M] = "smpte170m",
[AVCOL_TRC_SMPTE240M] = "smpte240m",
[AVCOL_TRC_LINEAR] = "linear",
[AVCOL_TRC_LOG] = "log100",
[AVCOL_TRC_LOG_SQRT] = "log316",
[AVCOL_TRC_IEC61966_2_4] = "iec61966-2-4",
[AVCOL_TRC_BT1361_ECG] = "bt1361e",
[AVCOL_TRC_IEC61966_2_1] = "iec61966-2-1",
[AVCOL_TRC_BT2020_10] = "bt2020-10",
[AVCOL_TRC_BT2020_12] = "bt2020-12",
[AVCOL_TRC_SMPTE2084] = "smpte2084",
[AVCOL_TRC_SMPTE428] = "smpte428",
[AVCOL_TRC_ARIB_STD_B67] = "arib-std-b67",
}

Definition at line 2375 of file pixdesc.c.

Referenced by av_color_transfer_from_name(), and av_color_transfer_name().

◆ color_space_names

const char* const color_space_names[]
static
Initial value:
= {
[AVCOL_SPC_RGB] = "gbr",
[AVCOL_SPC_BT709] = "bt709",
[AVCOL_SPC_UNSPECIFIED] = "unknown",
[AVCOL_SPC_RESERVED] = "reserved",
[AVCOL_SPC_FCC] = "fcc",
[AVCOL_SPC_BT470BG] = "bt470bg",
[AVCOL_SPC_SMPTE170M] = "smpte170m",
[AVCOL_SPC_SMPTE240M] = "smpte240m",
[AVCOL_SPC_YCGCO] = "ycgco",
[AVCOL_SPC_BT2020_NCL] = "bt2020nc",
[AVCOL_SPC_BT2020_CL] = "bt2020c",
[AVCOL_SPC_SMPTE2085] = "smpte2085",
[AVCOL_SPC_CHROMA_DERIVED_NCL] = "chroma-derived-nc",
[AVCOL_SPC_CHROMA_DERIVED_CL] = "chroma-derived-c",
[AVCOL_SPC_ICTCP] = "ictcp",
}

Definition at line 2397 of file pixdesc.c.

Referenced by av_color_space_from_name(), and av_color_space_name().

◆ chroma_location_names

const char* const chroma_location_names[]
static
Initial value:
= {
[AVCHROMA_LOC_UNSPECIFIED] = "unspecified",
[AVCHROMA_LOC_LEFT] = "left",
[AVCHROMA_LOC_CENTER] = "center",
[AVCHROMA_LOC_TOPLEFT] = "topleft",
[AVCHROMA_LOC_TOP] = "top",
[AVCHROMA_LOC_BOTTOMLEFT] = "bottomleft",
[AVCHROMA_LOC_BOTTOM] = "bottom",
}

Definition at line 2415 of file pixdesc.c.

Referenced by av_chroma_location_from_name(), and av_chroma_location_name().

AVCOL_PRI_RESERVED
@ AVCOL_PRI_RESERVED
Definition: pixfmt.h:447
AVCOL_TRC_LINEAR
@ AVCOL_TRC_LINEAR
"Linear transfer characteristics"
Definition: pixfmt.h:476
AVCHROMA_LOC_BOTTOM
@ AVCHROMA_LOC_BOTTOM
Definition: pixfmt.h:548
AVCOL_RANGE_JPEG
@ AVCOL_RANGE_JPEG
the normal 2^n-1 "JPEG" YUV ranges
Definition: pixfmt.h:522
AVCOL_TRC_UNSPECIFIED
@ AVCOL_TRC_UNSPECIFIED
Definition: pixfmt.h:470
AVCOL_PRI_JEDEC_P22
@ AVCOL_PRI_JEDEC_P22
JEDEC P22 phosphors.
Definition: pixfmt.h:459
AVCOL_SPC_RGB
@ AVCOL_SPC_RGB
order of coefficients is actually GBR, also IEC 61966-2-1 (sRGB)
Definition: pixfmt.h:497
AVCOL_TRC_BT2020_12
@ AVCOL_TRC_BT2020_12
ITU-R BT2020 for 12-bit system.
Definition: pixfmt.h:483
AVCOL_SPC_BT2020_CL
@ AVCOL_SPC_BT2020_CL
ITU-R BT2020 constant luminance system.
Definition: pixfmt.h:508
AVCOL_SPC_BT470BG
@ AVCOL_SPC_BT470BG
also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
Definition: pixfmt.h:502
AVCOL_SPC_RESERVED
@ AVCOL_SPC_RESERVED
Definition: pixfmt.h:500
AVCOL_TRC_IEC61966_2_1
@ AVCOL_TRC_IEC61966_2_1
IEC 61966-2-1 (sRGB or sYCC)
Definition: pixfmt.h:481
AVCOL_TRC_GAMMA28
@ AVCOL_TRC_GAMMA28
also ITU-R BT470BG
Definition: pixfmt.h:473
AVCOL_TRC_LOG_SQRT
@ AVCOL_TRC_LOG_SQRT
"Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range)"
Definition: pixfmt.h:478
AVCOL_TRC_GAMMA22
@ AVCOL_TRC_GAMMA22
also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
Definition: pixfmt.h:472
AVCOL_PRI_RESERVED0
@ AVCOL_PRI_RESERVED0
Definition: pixfmt.h:444
AVCHROMA_LOC_TOP
@ AVCHROMA_LOC_TOP
Definition: pixfmt.h:546
AVCOL_TRC_BT1361_ECG
@ AVCOL_TRC_BT1361_ECG
ITU-R BT1361 Extended Colour Gamut.
Definition: pixfmt.h:480
AVCOL_SPC_SMPTE170M
@ AVCOL_SPC_SMPTE170M
also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
Definition: pixfmt.h:503
AVCOL_PRI_SMPTE428
@ AVCOL_PRI_SMPTE428
SMPTE ST 428-1 (CIE 1931 XYZ)
Definition: pixfmt.h:455
AVCOL_PRI_SMPTE240M
@ AVCOL_PRI_SMPTE240M
functionally identical to above
Definition: pixfmt.h:452
AVCOL_PRI_UNSPECIFIED
@ AVCOL_PRI_UNSPECIFIED
Definition: pixfmt.h:446
AVCOL_SPC_CHROMA_DERIVED_CL
@ AVCOL_SPC_CHROMA_DERIVED_CL
Chromaticity-derived constant luminance system.
Definition: pixfmt.h:511
AVCOL_PRI_BT470BG
@ AVCOL_PRI_BT470BG
also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
Definition: pixfmt.h:450
AVCOL_PRI_SMPTE170M
@ AVCOL_PRI_SMPTE170M
also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
Definition: pixfmt.h:451
AVCOL_TRC_RESERVED0
@ AVCOL_TRC_RESERVED0
Definition: pixfmt.h:468
AVCHROMA_LOC_LEFT
@ AVCHROMA_LOC_LEFT
MPEG-2/4 4:2:0, H.264 default for 4:2:0.
Definition: pixfmt.h:543
AVCHROMA_LOC_TOPLEFT
@ AVCHROMA_LOC_TOPLEFT
ITU-R 601, SMPTE 274M 296M S314M(DV 4:1:1), mpeg2 4:2:2.
Definition: pixfmt.h:545
AVCOL_TRC_IEC61966_2_4
@ AVCOL_TRC_IEC61966_2_4
IEC 61966-2-4.
Definition: pixfmt.h:479
AVCOL_PRI_BT709
@ AVCOL_PRI_BT709
also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
Definition: pixfmt.h:445
AVCOL_TRC_BT2020_10
@ AVCOL_TRC_BT2020_10
ITU-R BT2020 for 10-bit system.
Definition: pixfmt.h:482
AVCOL_SPC_YCGCO
@ AVCOL_SPC_YCGCO
Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16.
Definition: pixfmt.h:505
AVCOL_RANGE_UNSPECIFIED
@ AVCOL_RANGE_UNSPECIFIED
Definition: pixfmt.h:520
AVCOL_PRI_BT2020
@ AVCOL_PRI_BT2020
ITU-R BT2020.
Definition: pixfmt.h:454
AVCOL_TRC_SMPTE2084
@ AVCOL_TRC_SMPTE2084
SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems.
Definition: pixfmt.h:484
AVCOL_PRI_SMPTE431
@ AVCOL_PRI_SMPTE431
SMPTE ST 431-2 (2011) / DCI P3.
Definition: pixfmt.h:457
AVCOL_TRC_SMPTE240M
@ AVCOL_TRC_SMPTE240M
Definition: pixfmt.h:475
AVCOL_PRI_FILM
@ AVCOL_PRI_FILM
colour filters using Illuminant C
Definition: pixfmt.h:453
AVCOL_TRC_LOG
@ AVCOL_TRC_LOG
"Logarithmic transfer characteristic (100:1 range)"
Definition: pixfmt.h:477
AVCHROMA_LOC_UNSPECIFIED
@ AVCHROMA_LOC_UNSPECIFIED
Definition: pixfmt.h:542
AVCOL_SPC_CHROMA_DERIVED_NCL
@ AVCOL_SPC_CHROMA_DERIVED_NCL
Chromaticity-derived non-constant luminance system.
Definition: pixfmt.h:510
AVCOL_TRC_BT709
@ AVCOL_TRC_BT709
also ITU-R BT1361
Definition: pixfmt.h:469
AVCOL_SPC_SMPTE240M
@ AVCOL_SPC_SMPTE240M
functionally identical to above
Definition: pixfmt.h:504
AVCOL_SPC_BT2020_NCL
@ AVCOL_SPC_BT2020_NCL
ITU-R BT2020 non-constant luminance system.
Definition: pixfmt.h:507
AVCOL_SPC_UNSPECIFIED
@ AVCOL_SPC_UNSPECIFIED
Definition: pixfmt.h:499
AVCOL_RANGE_MPEG
@ AVCOL_RANGE_MPEG
the normal 219*2^(n-8) "MPEG" YUV ranges
Definition: pixfmt.h:521
AVCOL_PRI_BT470M
@ AVCOL_PRI_BT470M
also FCC Title 47 Code of Federal Regulations 73.682 (a)(20)
Definition: pixfmt.h:448
AVCOL_TRC_ARIB_STD_B67
@ AVCOL_TRC_ARIB_STD_B67
ARIB STD-B67, known as "Hybrid log-gamma".
Definition: pixfmt.h:488
AVCHROMA_LOC_CENTER
@ AVCHROMA_LOC_CENTER
MPEG-1 4:2:0, JPEG 4:2:0, H.263 4:2:0.
Definition: pixfmt.h:544
AVCOL_SPC_FCC
@ AVCOL_SPC_FCC
FCC Title 47 Code of Federal Regulations 73.682 (a)(20)
Definition: pixfmt.h:501
AVCOL_TRC_SMPTE170M
@ AVCOL_TRC_SMPTE170M
also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
Definition: pixfmt.h:474
AVCOL_TRC_RESERVED
@ AVCOL_TRC_RESERVED
Definition: pixfmt.h:471
AVCOL_PRI_SMPTE432
@ AVCOL_PRI_SMPTE432
SMPTE ST 432-1 (2010) / P3 D65 / Display P3.
Definition: pixfmt.h:458
AVCOL_SPC_SMPTE2085
@ AVCOL_SPC_SMPTE2085
SMPTE 2085, Y'D'zD'x.
Definition: pixfmt.h:509
AVCOL_TRC_SMPTE428
@ AVCOL_TRC_SMPTE428
SMPTE ST 428-1.
Definition: pixfmt.h:486
AVCOL_SPC_BT709
@ AVCOL_SPC_BT709
also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
Definition: pixfmt.h:498
AVCOL_SPC_ICTCP
@ AVCOL_SPC_ICTCP
ITU-R BT.2100-0, ICtCp.
Definition: pixfmt.h:512
AVCHROMA_LOC_BOTTOMLEFT
@ AVCHROMA_LOC_BOTTOMLEFT
Definition: pixfmt.h:547