FFmpeg
Data Fields
AVRawColorParams Struct Reference

Per-frame color information for a RAW camera codec. More...

#include <raw_color_params.h>

Data Fields

enum AVRawColorParamsType type
 Selects which member of codec is valid. More...
 
AVRational black_level
 Lowest valid raw sample code (sensor black point) More...
 
AVRational white_level
 Highest valid raw sample code (sensor white point) More...
 
uint32_t wb_cct
 Color temperature in Kelvin from with the camera's white balance. More...
 
union {
   AVProResRawColorParams   prores_raw
 
codec
 Additional codec-specific fields. More...
 

Detailed Description

Per-frame color information for a RAW camera codec.

Carried as side data of type AV_FRAME_DATA_RAW_COLOR_PARAMS.

The outer struct carries the fields every RAW codec exposes: the sensor's valid sample range and the white-balance correlated color temperature. The codec union holds the codec-specific transform parameters; type selects which member of the union is valid.

The codec-specific transform (color_matrix or equivalent) always lands in linear-light CIE 1931 XYZ relative to the D65 illuminant, cameras don't have standard primaries, so XYZ is the only common target.

Note
The struct must be allocated using av_raw_color_params_alloc() or av_raw_color_params_create_side_data(). Its size is not a part of the public ABI.

Definition at line 100 of file raw_color_params.h.

Field Documentation

◆ type

enum AVRawColorParamsType AVRawColorParams::type

Selects which member of codec is valid.

Definition at line 104 of file raw_color_params.h.

Referenced by decode_frame().

◆ black_level

AVRational AVRawColorParams::black_level

Lowest valid raw sample code (sensor black point)

Definition at line 109 of file raw_color_params.h.

Referenced by decode_frame().

◆ white_level

AVRational AVRawColorParams::white_level

Highest valid raw sample code (sensor white point)

Definition at line 114 of file raw_color_params.h.

Referenced by decode_frame().

◆ wb_cct

uint32_t AVRawColorParams::wb_cct

Color temperature in Kelvin from with the camera's white balance.

Informational; the math uses the codec-specific white-balance fields. 0 if not signaled.

Definition at line 121 of file raw_color_params.h.

Referenced by decode_frame().

◆ prores_raw

AVProResRawColorParams AVRawColorParams::prores_raw

Definition at line 127 of file raw_color_params.h.

Referenced by decode_frame().

◆ codec

union { ... } AVRawColorParams::codec

Additional codec-specific fields.

Referenced by decode_frame().


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